Use new OFFLOAD nomenclature and updated OpenAPI schema

Author: tsmith023

src/collections/collection/index.ts

@@ -13,7 +13,7 @@ import generate, { Generate } from '../generate/index.js';
 import { Iterator } from '../iterator/index.js';
 import query, { Query } from '../query/index.js';
 import sort, { Sort } from '../sort/index.js';
-import tenants, { TenantInput, Tenants } from '../tenants/index.js';
+import tenants, { TenantBase, Tenants } from '../tenants/index.js';
 import { QueryMetadata, QueryProperty, QueryReference } from '../types/index.js';
 
 export interface Collection<T = undefined, N = string> {
@@ -78,10 +78,11 @@ export interface Collection<T = undefined, N = string> {
    *
    * This method does not send a request to Weaviate. It only returns a new collection object that is specific to the tenant you specify.
    *
-   * @param {string | TenantInput} tenant The tenant name or tenant object to use.
+   * @typedef {TenantBase} TT A type that extends TenantBase.
+   * @param {string | TT} tenant The tenant name or tenant object to use.
    * @returns {Collection<T, N>} A new collection object specific to the tenant you specified.
    */
-  withTenant: (tenant: string | TenantInput) => Collection<T, N>;
+  withTenant: <TT extends TenantBase>(tenant: string | TT) => Collection<T, N>;
 }
 
 export type IteratorOptions<T> = {
@@ -136,7 +137,7 @@ const collection = <T, N>(
       ),
     withConsistency: (consistencyLevel: ConsistencyLevel) =>
       collection<T, N>(connection, capitalizedName, dbVersionSupport, consistencyLevel, tenant),
-    withTenant: (tenant: string | TenantInput) =>
+    withTenant: <TT extends TenantBase>(tenant: string | TT) =>
       collection<T, N>(
         connection,
         capitalizedName,

src/collections/deserialize/index.ts

@@ -1,10 +1,13 @@
 import { WeaviateDeserializationError } from '../../errors.js';
+import { Tenant as TenantREST } from '../../openapi/types.js';
 import { BatchObject as BatchObjectGRPC, BatchObjectsReply } from '../../proto/v1/batch.js';
 import { BatchDeleteReply } from '../../proto/v1/batch_delete.js';
 import { ListValue, Properties as PropertiesGrpc, Value } from '../../proto/v1/properties.js';
 import { MetadataResult, PropertiesResult, SearchReply } from '../../proto/v1/search_get.js';
+import { TenantActivityStatus, TenantsGetReply } from '../../proto/v1/tenants.js';
 import { DbVersionSupport } from '../../utils/dbVersion.js';
 import { referenceFromObjects } from '../references/utils.js';
+import { Tenant } from '../tenants/index.js';
 import {
   BatchObject,
   BatchObjectsReturn,
@@ -298,4 +301,49 @@ export class Deserialize {
         : (undefined as any),
     };
   }
+
+  private static activityStatusGRPC(status: TenantActivityStatus): Tenant['activityStatus'] {
+    switch (status) {
+      case TenantActivityStatus.TENANT_ACTIVITY_STATUS_COLD:
+        return 'COLD';
+      case TenantActivityStatus.TENANT_ACTIVITY_STATUS_HOT:
+        return 'HOT';
+      case TenantActivityStatus.TENANT_ACTIVITY_STATUS_FROZEN:
+        return 'OFFLOADED';
+      case TenantActivityStatus.TENANT_ACTIVITY_STATUS_FREEZING:
+        return 'OFFLOADING';
+      case TenantActivityStatus.TENANT_ACTIVITY_STATUS_UNFREEZING:
+        return 'ONLOADING';
+      default:
+        throw new Error(`Unsupported tenant activity status: ${status}`);
+    }
+  }
+
+  public static activityStatusREST(status: TenantREST['activityStatus']): Tenant['activityStatus'] {
+    switch (status) {
+      case 'COLD':
+        return 'COLD';
+      case 'HOT':
+        return 'HOT';
+      case 'FROZEN':
+        return 'OFFLOADED';
+      case 'FREEZING':
+        return 'OFFLOADING';
+      case 'UNFREEZING':
+        return 'ONLOADING';
+      default:
+        throw new Error(`Unsupported tenant activity status: ${status}`);
+    }
+  }
+
+  public static tenantsGet(reply: TenantsGetReply) {
+    const tenants: Record<string, Tenant> = {};
+    reply.tenants.forEach((t) => {
+      tenants[t.name] = {
+        name: t.name,
+        activityStatus: Deserialize.activityStatusGRPC(t.activityStatus),
+      };
+    });
+    return tenants;
+  }
 }

src/collections/serialize/index.ts

@@ -1,5 +1,5 @@
 import { v4 as uuidv4 } from 'uuid';
-import { WhereFilter } from '../../openapi/types.js';
+import { TenantActivityStatus, WhereFilter } from '../../openapi/types.js';
 import {
   BatchObject as BatchObjectGRPC,
   BatchObject_MultiTargetRefProps,
@@ -82,6 +82,7 @@ import {
 import { ReferenceGuards } from '../references/classes.js';
 import { Beacon } from '../references/index.js';
 import { uuidToBeacon } from '../references/utils.js';
+import { Tenant, TenantCreate, TenantUpdate } from '../tenants/types.js';
 import {
   BatchObject,
   BatchObjects,
@@ -1135,4 +1136,73 @@ export class Serialize {
       return { batch: batch, mapped: objs };
     });
   };
+
+  public static tenantsCreate(tenant: Tenant | TenantCreate): {
+    name: string;
+    activityStatus?: 'HOT' | 'COLD';
+  } {
+    let activityStatus: TenantActivityStatus;
+    switch (tenant.activityStatus) {
+      case 'ACTIVE':
+        activityStatus = 'HOT';
+        break;
+      case 'INACTIVE':
+        activityStatus = 'COLD';
+        break;
+      case 'HOT':
+      case 'COLD':
+      case undefined:
+        activityStatus = tenant.activityStatus;
+        break;
+      case 'OFFLOADED':
+        throw new WeaviateInvalidInputError(
+          'Cannot create a tenant with activity status OFFLOADED. Add objects to the tenant first and then you can update it to OFFLOADED.'
+        );
+      case 'OFFLOADING':
+        throw new WeaviateInvalidInputError(
+          'Cannot create a tenant with activity status OFFLOADING. This status is a read-only value that the server sets in the processing of making a tenant OFFLOADED.'
+        );
+      case 'ONLOADING':
+        throw new WeaviateInvalidInputError(
+          'Cannot create a tenant with activity status ONLOADING. This status is a read-only value that the server sets in the processing of making a tenant HOT.'
+        );
+    }
+    return {
+      name: tenant.name,
+      activityStatus,
+    };
+  }
+
+  public static tenantUpdate = (
+    tenant: Tenant | TenantUpdate
+  ): { name: string; activityStatus: 'HOT' | 'COLD' | 'FROZEN' } => {
+    let activityStatus: TenantActivityStatus;
+    switch (tenant.activityStatus) {
+      case 'ACTIVE':
+        activityStatus = 'HOT';
+        break;
+      case 'INACTIVE':
+        activityStatus = 'COLD';
+        break;
+      case 'OFFLOADED':
+        activityStatus = 'FROZEN';
+        break;
+      case 'HOT':
+      case 'COLD':
+        activityStatus = tenant.activityStatus;
+        break;
+      case 'OFFLOADING':
+        throw new WeaviateInvalidInputError(
+          'Cannot create a tenant with activity status OFFLOADING. This status is a read-only value that the server sets in the processing of making a tenant OFFLOADED.'
+        );
+      case 'ONLOADING':
+        throw new WeaviateInvalidInputError(
+          'Cannot create a tenant with activity status ONLOADING. This status is a read-only value that the server sets in the processing of making a tenant HOT.'
+        );
+    }
+    return {
+      name: tenant.name,
+      activityStatus,
+    };
+  };
 }