Expose an option in createIndex to suppress the 409 conflict error (#125

)
pinecone-io · Sep 23, 2023 · 4f93203 · 4f93203
1 parent 699b5dd
commit 4f93203
Show file tree

Hide file tree

Showing 3 changed files with 40 additions and 0 deletions.
diff --git a/src/control/__tests__/createIndex.test.ts b/src/control/__tests__/createIndex.test.ts
@@ -1,6 +1,7 @@
 import { createIndex } from '../createIndex';
 import {
   PineconeBadRequestError,
+  PineconeConflictError,
   PineconeInternalServerError,
 } from '../../errors';
 import { IndexOperationsApi } from '../../pinecone-generated-ts-fetch';
@@ -166,5 +167,20 @@ describe('createIndex', () => {
       await expect(toThrow).rejects.toThrow(PineconeBadRequestError);
       await expect(toThrow).rejects.toThrow(serverError);
     });
+
+    test('when 409 occurs', async () => {
+      const IOA = setupCreateIndexResponse(
+        { status: 409, text: () => 'conflict error message' },
+        undefined,
+        false
+      );
+
+      const toThrow = async () => {
+        const createIndexFn = createIndex(IOA);
+        await createIndexFn({ name: 'index-name', dimension: 10 });
+      };
+
+      await expect(toThrow).rejects.toThrow(PineconeConflictError);
+    });
   });
 });
diff --git a/src/control/createIndex.ts b/src/control/createIndex.ts
@@ -26,6 +26,7 @@ export type CreateIndexOptions = {
   metadataConfig?: { indexed: Array<string> };
   sourceCollection?: string;
   waitUntilReady?: boolean;
+  suppressConflicts?: boolean;
 };
 
 const CreateIndexOptionsSchema = Type.Object(
@@ -39,6 +40,7 @@ const CreateIndexOptionsSchema = Type.Object(
     metadataConfig: Type.Optional(MetadataConfigSchema),
     sourceCollection: Type.Optional(CollectionNameSchema),
     waitUntilReady: Type.Optional(Type.Boolean()),
+    suppressConflicts: Type.Optional(Type.Boolean()),
   },
   { additionalProperties: false }
 );
@@ -60,6 +62,9 @@ export const createIndex = (api: IndexOperationsApi) => {
       return;
     } catch (e) {
       const err = await handleIndexRequestError(e, api, options.name);
+      if (options.suppressConflicts && err.name === 'PineconeConflictError') {
+        return;
+      }
       throw err;
     }
   };

diff --git a/src/errors/http.ts b/src/errors/http.ts
@@ -50,6 +50,23 @@ export class PineconeNotFoundError extends BasePineconeError {
   }
 }
 
+export class PineconeConflictError extends BasePineconeError {
+  constructor(failedRequest: FailedRequestInfo) {
+    const { url, message } = failedRequest;
+    if (url) {
+      super(
+        `A call to ${url} returned HTTP status 409. ${message ? message : ''}`
+      );
+    } else if (message) {
+      super(message);
+    } else {
+      super();
+    }
+
+    this.name = 'PineconeConflictError';
+  }
+}
+
 export class PineconeInternalServerError extends BasePineconeError {
   constructor(failedRequest: FailedRequestInfo) {
     const { url, body } = failedRequest;
@@ -101,6 +118,8 @@ export const mapHttpStatusError = (failedRequestInfo: FailedRequestInfo) => {
       return new PineconeAuthorizationError(failedRequestInfo);
     case 404:
       return new PineconeNotFoundError(failedRequestInfo);
+    case 409:
+      return new PineconeConflictError(failedRequestInfo);
     case 500:
       return new PineconeInternalServerError(failedRequestInfo);
     case 501: