added checkExists for createCollection

Author: toptobes

src/api/devops-api-http-client.ts

@@ -13,7 +13,7 @@
 // limitations under the License.
 
 import { HttpClient } from '@/src/api/http-client';
-import { DEFAULT_TIMEOUT, HTTP_METHODS } from '@/src/api/constants';
+import { HTTP_METHODS } from '@/src/api/constants';
 import { AxiosError, AxiosResponse } from 'axios';
 import { HTTPClientOptions } from '@/src/api/types';
 import { HTTP1AuthHeaderFactories, HTTP1Strategy } from '@/src/api/http1';
@@ -48,10 +48,6 @@ export class DevopsApiHttpClient extends HttpClient {
     this.requestStrategy = new HTTP1Strategy(HTTP1AuthHeaderFactories.DevopsApi);
   }
 
-  public multiCallTimeoutManager(timeoutMs: number | undefined) {
-    return mkTimeoutManager(MultiCallTimeoutManager, timeoutMs);
-  }
-
   public async request(info: DevopsApiRequestInfo, options: TimeoutOptions | undefined): Promise<AxiosResponse> {
     try {
       const timeoutManager = options?.timeoutManager ?? mkTimeoutManager(SingleCallTimeoutManager, options?.maxTimeMS);
@@ -73,7 +69,7 @@ export class DevopsApiHttpClient extends HttpClient {
   }
 
   public async requestLongRunning(req: DevopsApiRequestInfo, info: LongRunningRequestInfo): Promise<AxiosResponse> {
-    const timeoutManager = this.multiCallTimeoutManager(info.options?.maxTimeMS);
+    const timeoutManager = mkTimeoutManager(MultiCallTimeoutManager, info.options?.maxTimeMS);
     const resp = await this.request(req, { timeoutManager });
 
     const id = (typeof info.id === 'function')

src/client/data-api-client.ts

@@ -92,7 +92,7 @@ export class DataApiClient {
    *
    * @returns A new {@link Db} instance.
    */
-  db(endpoint: string, options?: DbSpawnOptions): Db;
+  public db(endpoint: string, options?: DbSpawnOptions): Db;
 
   /**
    * Spawns a new {@link Db} instance using a direct endpoint and given options.
@@ -126,9 +126,9 @@ export class DataApiClient {
    *
    * @returns A new {@link Db} instance.
    */
-  db(id: string, region: string, options?: DbSpawnOptions): Db;
+  public db(id: string, region: string, options?: DbSpawnOptions): Db;
 
-  db(endpointOrId: string, regionOrOptions?: string | DbSpawnOptions, maybeOptions?: DbSpawnOptions): Db {
+  public db(endpointOrId: string, regionOrOptions?: string | DbSpawnOptions, maybeOptions?: DbSpawnOptions): Db {
     return mkDb(this.#options, endpointOrId, regionOrOptions, maybeOptions);
   }
 
@@ -154,7 +154,7 @@ export class DataApiClient {
    *
    * @returns A new {@link AstraAdmin} instance.
    */
-  admin(options?: AdminSpawnOptions): AstraAdmin {
+  public admin(options?: AdminSpawnOptions): AstraAdmin {
     return mkAdmin(this.#options, options);
   }
 }

src/data-api/db.ts

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-import { Collection, extractDbIdFromUrl, SomeDoc } from '@/src/data-api';
+import { Collection, CollectionAlreadyExistsError, extractDbIdFromUrl, SomeDoc } from '@/src/data-api';
 import { DataApiHttpClient, DEFAULT_DATA_API_PATH, DEFAULT_NAMESPACE, RawDataApiResponse } from '@/src/api';
 import {
   CollectionName,
@@ -311,8 +311,18 @@ export class Db implements Disposable {
       },
     };
 
-    await this._httpClient.executeCommand(command, options);
+    const timeoutManager = this._httpClient.multiCallTimeoutManager(options?.maxTimeMS);
+    const namespace = options?.namespace ?? this.namespace;
 
+    if (options?.checkExists !== false) {
+      const collections = await this.listCollections({ namespace, maxTimeMS: timeoutManager.msRemaining });
+
+      if (collections.some(c => c.name === collectionName)) {
+        throw new CollectionAlreadyExistsError(options?.namespace ?? this.namespace, collectionName);
+      }
+    }
+
+    await this._httpClient.executeCommand(command, { namespace, timeoutManager });
     return this.collection(collectionName, options);
   }
 

src/data-api/errors.ts

@@ -188,6 +188,13 @@ export class CursorAlreadyInitializedError extends DataAPIError {
   }
 }
 
+export class CollectionAlreadyExistsError extends DataAPIError {
+  constructor(readonly namespace: string, readonly collectionName: string) {
+    super(`Collection '${namespace}.${collectionName}' already exists`);
+    this.name = 'CollectionAlreadyExistsError';
+  }
+}
+
 /**
  * An error representing the *complete* errors for an operation. This is a cohesive error that represents all the
  * errors that occurred during a single operation, and should not be thought of as *always* 1:1 with the number of

src/data-api/types/collections/create-collection.ts

@@ -32,7 +32,15 @@ export interface CreateCollectionCommand {
  * @field defaultId - The default ID for the collection.
  * @field namespace - Overrides the namespace for the collection.
  * @field maxTimeMS - The maximum time to allow the operation to run.
+ * @field checkExists - Whether to check if the collection exists before creating it.
  *
  * @see Db.createCollection
  */
-export interface CreateCollectionOptions<Schema extends SomeDoc> extends WithTimeout, CollectionOptions<Schema>, WithNamespace {}
+export interface CreateCollectionOptions<Schema extends SomeDoc> extends WithTimeout, CollectionOptions<Schema>, WithNamespace {
+  /**
+   * If `true`, runs an additional existence check before creating the collection, failing if the collection with the
+   * same name already exists, raising an error. Otherwise, the creation is always attempted, and the command's will
+   * succeed even if the collection with the given name already exists, as long as the options are the exact same.
+   */
+  checkExists?: boolean;
+}

src/devops/astra-admin.ts

@@ -93,7 +93,7 @@ export class AstraAdmin {
    *
    * @returns A new {@link Db} instance.
    */
-  db(endpoint: string, options?: DbSpawnOptions): Db;
+  public db(endpoint: string, options?: DbSpawnOptions): Db;
 
   /**
    * Spawns a new {@link Db} instance using a direct endpoint and given options.
@@ -127,9 +127,9 @@ export class AstraAdmin {
    *
    * @returns A new {@link Db} instance.
    */
-  db(id: string, region: string, options?: DbSpawnOptions): Db;
+  public db(id: string, region: string, options?: DbSpawnOptions): Db;
 
-  db(endpointOrId: string, regionOrOptions?: string | DbSpawnOptions, maybeOptions?: DbSpawnOptions): Db {
+  public db(endpointOrId: string, regionOrOptions?: string | DbSpawnOptions, maybeOptions?: DbSpawnOptions): Db {
     return mkDb(this.#defaultOpts, endpointOrId, regionOrOptions, maybeOptions);
   }
 
@@ -168,7 +168,7 @@ export class AstraAdmin {
    *
    * @returns A new {@link Db} instance.
    */
-  dbAdmin(endpoint: string, options?: DbSpawnOptions): AstraDbAdmin;
+  public dbAdmin(endpoint: string, options?: DbSpawnOptions): AstraDbAdmin;
 
   /**
    * Spawns a new {@link Db} instance using a direct endpoint and given options.
@@ -205,9 +205,9 @@ export class AstraAdmin {
    *
    * @returns A new {@link Db} instance.
    */
-  dbAdmin(id: string, region: string, options?: DbSpawnOptions): AstraDbAdmin;
+  public dbAdmin(id: string, region: string, options?: DbSpawnOptions): AstraDbAdmin;
 
-  dbAdmin(endpointOrId: string, regionOrOptions?: string | DbSpawnOptions, maybeOptions?: DbSpawnOptions): AstraDbAdmin {
+  public dbAdmin(endpointOrId: string, regionOrOptions?: string | DbSpawnOptions, maybeOptions?: DbSpawnOptions): AstraDbAdmin {
     // @ts-expect-error - calls internal representation of method
     return this.db(endpointOrId, regionOrOptions, maybeOptions).admin(this.#defaultOpts.adminOptions);
   }

tests/fixtures.ts

@@ -36,7 +36,7 @@ export const initTestObjects = async (ctx: Context, useHttp2: boolean = true): P
   const db = client.db(process.env.ASTRA_URI!);
 
   const coll = (!collCreated)
-    ? await db.createCollection(DEFAULT_COLLECTION_NAME, { vector: { dimension: 5, metric: 'cosine' } })
+    ? await db.createCollection(DEFAULT_COLLECTION_NAME, { vector: { dimension: 5, metric: 'cosine' }, checkExists: false })
     : db.collection(DEFAULT_COLLECTION_NAME);
 
   collCreated = true;

tests/integration/data-api/db.test.ts

@@ -21,7 +21,7 @@ import {
   initTestObjects,
   OTHER_NAMESPACE
 } from '@/tests/fixtures';
-import { DataAPIResponseError, Db } from '@/src/data-api';
+import { CollectionAlreadyExistsError, DataAPIResponseError, Db } from '@/src/data-api';
 import { DEFAULT_DATA_API_PATH, DEFAULT_NAMESPACE } from '@/src/api';
 import { DataApiClient } from '@/src/client';
 import process from 'process';
@@ -59,33 +59,45 @@ describe('integration.data-api.db', async () => {
       assert.strictEqual(res.namespace, OTHER_NAMESPACE);
     });
 
-    it('should create collection idempotently', async () => {
+    it('should throw CollectionAlreadyExistsError if collection already exists', async () => {
+      await db.createCollection(EPHEMERAL_COLLECTION_NAME);
+      try {
+        await db.createCollection(EPHEMERAL_COLLECTION_NAME);
+        assert.fail('Expected an error');
+      } catch (e) {
+        assert.ok(e instanceof CollectionAlreadyExistsError);
+        assert.strictEqual(e.collectionName, EPHEMERAL_COLLECTION_NAME);
+        assert.strictEqual(e.namespace, DEFAULT_NAMESPACE);
+      }
+    });
+
+    it('should create collection idempotently if checkExists is false', async () => {
       const res = await db.createCollection(EPHEMERAL_COLLECTION_NAME);
       assert.ok(res);
       assert.strictEqual(res.collectionName, EPHEMERAL_COLLECTION_NAME);
-      const res2 = await db.createCollection(EPHEMERAL_COLLECTION_NAME);
+      const res2 = await db.createCollection(EPHEMERAL_COLLECTION_NAME, { checkExists: false });
       assert.ok(res2);
       assert.strictEqual(res2.collectionName, EPHEMERAL_COLLECTION_NAME);
     });
 
-    it('should create collection with same options idempotently', async () => {
+    it('should create collection with same options idempotently if checkExists is false', async () => {
       const res = await db.createCollection(EPHEMERAL_COLLECTION_NAME, { indexing: { deny: ['*'] } });
       assert.ok(res);
       assert.strictEqual(res.collectionName, EPHEMERAL_COLLECTION_NAME);
       assert.strictEqual(res.namespace, DEFAULT_NAMESPACE);
-      const res2 = await db.createCollection(EPHEMERAL_COLLECTION_NAME, { indexing: { deny: ['*'] } });
+      const res2 = await db.createCollection(EPHEMERAL_COLLECTION_NAME, { indexing: { deny: ['*'] }, checkExists: false });
       assert.ok(res2);
       assert.strictEqual(res2.collectionName, EPHEMERAL_COLLECTION_NAME);
       assert.strictEqual(res2.namespace, DEFAULT_NAMESPACE);
     });
 
-    it('should fail creating collection with different options', async () => {
+    it('should fail creating collection with different options even if checkExists is false', async () => {
       const res = await db.createCollection(EPHEMERAL_COLLECTION_NAME, { indexing: { deny: ['*'] } });
       assert.ok(res);
       assert.strictEqual(res.collectionName, EPHEMERAL_COLLECTION_NAME);
       assert.strictEqual(res.namespace, DEFAULT_NAMESPACE);
       try {
-        await db.createCollection(EPHEMERAL_COLLECTION_NAME, { indexing: { allow: ['*'] } });
+        await db.createCollection(EPHEMERAL_COLLECTION_NAME, { indexing: { allow: ['*'] }, checkExists: false });
         assert.fail('Expected an error');
       } catch (e) {
         assert.ok(e instanceof DataAPIResponseError);

tests/integration/devops/lifecycle.test.ts

@@ -35,6 +35,18 @@ describe('integration.devops.lifecycle', async () => {
     // }
   });
 
+  it('sdfsadfsda', async () => {
+    const admin = client.admin();
+
+    const resp = await admin.createDatabase({
+      name: 'astra-test-db',
+      cloudProvider: 'GCP',
+      region: 'us-east1',
+    });
+
+    console.log(resp.id);
+  });
+
   it('[admin] works', async () => {
     try {
       const admin = client.admin();