@mastra/opensearch 0.10.3 → 0.10.4-alpha.1

package/src/vector/index.ts

@@ -9,10 +9,11 @@ import type {
   UpdateVectorParams,
   UpsertVectorParams,
 } from '@mastra/core';
+import { MastraError, ErrorDomain, ErrorCategory } from '@mastra/core/error';
 import { MastraVector } from '@mastra/core/vector';
-import type { VectorFilter } from '@mastra/core/vector/filter';
 import { Client as OpenSearchClient } from '@opensearch-project/opensearch';
 import { OpenSearchFilterTranslator } from './filter';
+import type { OpenSearchVectorFilter } from './filter';
 
 const METRIC_MAPPING = {
   cosine: 'cosinesimil',
@@ -26,7 +27,9 @@ const REVERSE_METRIC_MAPPING = {
   innerproduct: 'dotproduct',
 } as const;
 
-export class OpenSearchVector extends MastraVector {
+type OpenSearchVectorParams = QueryVectorParams<OpenSearchVectorFilter>;
+
+export class OpenSearchVector extends MastraVector<OpenSearchVectorFilter> {
   private client: OpenSearchClient;
 
   /**
@@ -49,7 +52,13 @@ export class OpenSearchVector extends MastraVector {
    */
   async createIndex({ indexName, dimension, metric = 'cosine' }: CreateIndexParams): Promise<void> {
     if (!Number.isInteger(dimension) || dimension <= 0) {
-      throw new Error('Dimension must be a positive integer');
+      throw new MastraError({
+        id: 'STORAGE_OPENSEARCH_VECTOR_CREATE_INDEX_INVALID_ARGS',
+        domain: ErrorDomain.STORAGE,
+        category: ErrorCategory.USER,
+        text: 'Dimension must be a positive integer',
+        details: { indexName, dimension },
+      });
     }
 
     try {
@@ -82,8 +91,15 @@ export class OpenSearchVector extends MastraVector {
         await this.validateExistingIndex(indexName, dimension, metric);
         return;
       }
-      console.error(`Failed to create index ${indexName}:`, error);
-      throw error;
+      throw new MastraError(
+        {
+          id: 'STORAGE_OPENSEARCH_VECTOR_CREATE_INDEX_FAILED',
+          domain: ErrorDomain.STORAGE,
+          category: ErrorCategory.THIRD_PARTY,
+          details: { indexName, dimension, metric },
+        },
+        error,
+      );
     }
   }
 
@@ -100,9 +116,15 @@ export class OpenSearchVector extends MastraVector {
         .filter((index: string | undefined) => index !== undefined);
 
       return indexes;
-    } catch (error: any) {
-      console.error('Failed to list indexes:', error);
-      throw new Error(`Failed to list indexes: ${error.message}`);
+    } catch (error) {
+      throw new MastraError(
+        {
+          id: 'STORAGE_OPENSEARCH_VECTOR_LIST_INDEXES_FAILED',
+          domain: ErrorDomain.STORAGE,
+          category: ErrorCategory.THIRD_PARTY,
+        },
+        error,
+      );
     }
   }
 
@@ -137,7 +159,17 @@ export class OpenSearchVector extends MastraVector {
     try {
       await this.client.indices.delete({ index: indexName });
     } catch (error) {
-      console.error(`Failed to delete index ${indexName}:`, error);
+      const mastraError = new MastraError(
+        {
+          id: 'STORAGE_OPENSEARCH_VECTOR_DELETE_INDEX_FAILED',
+          domain: ErrorDomain.STORAGE,
+          category: ErrorCategory.THIRD_PARTY,
+          details: { indexName },
+        },
+        error,
+      );
+      this.logger?.error(mastraError.toString());
+      this.logger?.trackException(mastraError);
     }
   }
 
@@ -154,39 +186,46 @@ export class OpenSearchVector extends MastraVector {
     const vectorIds = ids || vectors.map(() => crypto.randomUUID());
     const operations = [];
 
-    // Get index stats to check dimension
-    const indexInfo = await this.describeIndex({ indexName });
+    try {
+      // Get index stats to check dimension
+      const indexInfo = await this.describeIndex({ indexName });
 
-    // Validate vector dimensions
-    this.validateVectorDimensions(vectors, indexInfo.dimension);
+      // Validate vector dimensions
+      this.validateVectorDimensions(vectors, indexInfo.dimension);
 
-    for (let i = 0; i < vectors.length; i++) {
-      const operation = {
-        index: {
-          _index: indexName,
-          _id: vectorIds[i],
-        },
-      };
+      for (let i = 0; i < vectors.length; i++) {
+        const operation = {
+          index: {
+            _index: indexName,
+            _id: vectorIds[i],
+          },
+        };
 
-      const document = {
-        id: vectorIds[i],
-        embedding: vectors[i],
-        metadata: metadata[i] || {},
-      };
+        const document = {
+          id: vectorIds[i],
+          embedding: vectors[i],
+          metadata: metadata[i] || {},
+        };
 
-      operations.push(operation);
-      operations.push(document);
-    }
+        operations.push(operation);
+        operations.push(document);
+      }
 
-    try {
       if (operations.length > 0) {
         await this.client.bulk({ body: operations, refresh: true });
       }
 
       return vectorIds;
     } catch (error) {
-      console.error('Failed to upsert vectors:', error);
-      throw error;
+      throw new MastraError(
+        {
+          id: 'STORAGE_OPENSEARCH_VECTOR_UPSERT_FAILED',
+          domain: ErrorDomain.STORAGE,
+          category: ErrorCategory.THIRD_PARTY,
+          details: { indexName, vectorCount: vectors?.length || 0 },
+        },
+        error,
+      );
     }
   }
 
@@ -206,7 +245,7 @@ export class OpenSearchVector extends MastraVector {
     filter,
     topK = 10,
     includeVector = false,
-  }: QueryVectorParams): Promise<QueryResult[]> {
+  }: OpenSearchVectorParams): Promise<QueryResult[]> {
     try {
       const translatedFilter = this.transformFilter(filter);
 
@@ -234,9 +273,16 @@ export class OpenSearchVector extends MastraVector {
       });
 
       return results;
-    } catch (error: any) {
-      console.error('Failed to query vectors:', error);
-      throw new Error(`Failed to query vectors for index ${indexName}: ${error.message}`);
+    } catch (error) {
+      throw new MastraError(
+        {
+          id: 'STORAGE_OPENSEARCH_VECTOR_QUERY_FAILED',
+          domain: ErrorDomain.STORAGE,
+          category: ErrorCategory.THIRD_PARTY,
+          details: { indexName, topK },
+        },
+        error,
+      );
     }
   }
 
@@ -256,10 +302,10 @@ export class OpenSearchVector extends MastraVector {
   /**
    * Transforms the filter to the OpenSearch DSL.
    *
-   * @param {VectorFilter} filter - The filter to transform.
+   * @param {OpenSearchVectorFilter} filter - The filter to transform.
    * @returns {Record<string, any>} The transformed filter.
    */
-  private transformFilter(filter?: VectorFilter) {
+  private transformFilter(filter?: OpenSearchVectorFilter): any {
     const translator = new OpenSearchFilterTranslator();
     return translator.translate(filter);
   }
@@ -275,13 +321,15 @@ export class OpenSearchVector extends MastraVector {
    * @throws Will throw an error if no updates are provided or if the update operation fails.
    */
   async updateVector({ indexName, id, update }: UpdateVectorParams): Promise<void> {
-    if (!update.vector && !update.metadata) {
-      throw new Error('No updates provided');
-    }
-
+    let existingDoc;
     try {
+      if (!update.vector && !update.metadata) {
+        throw new Error('No updates provided');
+      }
+
       // First get the current document to merge with updates
-      const { body: existingDoc } = await this.client
+      const { body } = await this.client
+
         .get({
           index: indexName,
           id: id,
@@ -290,25 +338,40 @@ export class OpenSearchVector extends MastraVector {
           throw new Error(`Document with ID ${id} not found in index ${indexName}`);
         });
 
-      if (!existingDoc || !existingDoc._source) {
+      if (!body || !body._source) {
         throw new Error(`Document with ID ${id} has no source data in index ${indexName}`);
       }
+      existingDoc = body;
+    } catch (error) {
+      throw new MastraError(
+        {
+          id: 'STORAGE_OPENSEARCH_VECTOR_UPDATE_VECTOR_FAILED',
+          domain: ErrorDomain.STORAGE,
+          category: ErrorCategory.USER,
+          details: { indexName, id },
+        },
+        error,
+      );
+    }
 
-      const source = existingDoc._source;
-      const updatedDoc: Record<string, any> = {
-        id: source.id || id,
-      };
+    const source = existingDoc._source;
+    const updatedDoc: Record<string, any> = {
+      id: source?.id || id,
+    };
 
+    try {
       // Update vector if provided
       if (update.vector) {
         // Get index stats to check dimension
+        console.log(`1`);
         const indexInfo = await this.describeIndex({ indexName });
 
         // Validate vector dimensions
+        console.log(`2`);
         this.validateVectorDimensions([update.vector], indexInfo.dimension);
 
         updatedDoc.embedding = update.vector;
-      } else if (source.embedding) {
+      } else if (source?.embedding) {
         updatedDoc.embedding = source.embedding;
       }
 
@@ -316,10 +379,11 @@ export class OpenSearchVector extends MastraVector {
       if (update.metadata) {
         updatedDoc.metadata = update.metadata;
       } else {
-        updatedDoc.metadata = source.metadata || {};
+        updatedDoc.metadata = source?.metadata || {};
       }
 
       // Update the document
+      console.log(`3`);
       await this.client.index({
         index: indexName,
         id: id,
@@ -327,8 +391,15 @@ export class OpenSearchVector extends MastraVector {
         refresh: true,
       });
     } catch (error) {
-      console.error(`Failed to update document with ID ${id} in index ${indexName}:`, error);
-      throw error;
+      throw new MastraError(
+        {
+          id: 'STORAGE_OPENSEARCH_VECTOR_UPDATE_VECTOR_FAILED',
+          domain: ErrorDomain.STORAGE,
+          category: ErrorCategory.THIRD_PARTY,
+          details: { indexName, id },
+        },
+        error,
+      );
     }
   }
 
@@ -347,11 +418,19 @@ export class OpenSearchVector extends MastraVector {
         refresh: true,
       });
     } catch (error: unknown) {
-      console.error(`Failed to delete document with ID ${id} from index ${indexName}:`, error);
-      // Don't throw error if document doesn't exist, just log it
-      if (error && typeof error === 'object' && 'statusCode' in error && error.statusCode !== 404) {
-        throw error;
+      // Don't throw error if document doesn't exist (404)
+      if (error && typeof error === 'object' && 'statusCode' in error && error.statusCode === 404) {
+        return;
       }
+      throw new MastraError(
+        {
+          id: 'STORAGE_OPENSEARCH_VECTOR_DELETE_VECTOR_FAILED',
+          domain: ErrorDomain.STORAGE,
+          category: ErrorCategory.THIRD_PARTY,
+          details: { indexName, id },
+        },
+        error,
+      );
     }
   }
 }