refactor: mvi list indexes response to contain index info detail (#1016)

Previously a list indexes success response only contained a list of index names. We refactor this to contain a list of `VectorIndexInfo` objects, each of which can contain encapsulate many details. To start we only include the index name. We update the integration tests and indexes along with this.
momentohq · Nov 8, 2023 · 0e7533a · 0e7533a
1 parent 05915cd
commit 0e7533a
Show file tree

Hide file tree

Showing 8 changed files with 40 additions and 11 deletions.
diff --git a/packages/client-sdk-nodejs/src/index.ts b/packages/client-sdk-nodejs/src/index.ts
@@ -94,6 +94,7 @@ import {
   IMomentoCache,
   SubscribeCallOptions,
   CacheInfo,
+  VectorIndexInfo,
   CollectionTtl,
   ItemType,
   SortedSetOrder,
@@ -218,6 +219,7 @@ export {
   CacheClient,
   SimpleCacheClient,
   CacheInfo,
+  VectorIndexInfo,
   // Credentials / Auth
   CredentialProvider,
   StringMomentoTokenProvider,

diff --git a/packages/client-sdk-nodejs/src/internal/vector-index-control-client.ts b/packages/client-sdk-nodejs/src/internal/vector-index-control-client.ts
@@ -9,6 +9,7 @@ import {
   InvalidArgumentError,
   MomentoLogger,
   VectorIndexConfiguration,
+  VectorIndexInfo,
 } from '..';
 import {version} from '../../package.json';
 import {IdleGrpcClientWrapper} from './grpc/idle-grpc-client-wrapper';
@@ -148,9 +149,11 @@ export class VectorIndexControlClient implements IVectorIndexControlClient {
                 new ListVectorIndexes.Error(cacheServiceErrorMapper(err))
               );
             } else {
-              // TODO: um, what?
               // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment,@typescript-eslint/no-unsafe-call
-              const indexes = resp.index_names;
+              const indexes = resp.index_names.map((name: string) => {
+                // eslint-disable-next-line @typescript-eslint/no-unsafe-return, @typescript-eslint/no-unsafe-call
+                return new VectorIndexInfo(name);
+              });
               // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
               resolve(new ListVectorIndexes.Success(indexes));
             }

diff --git a/packages/client-sdk-web/src/index.ts b/packages/client-sdk-web/src/index.ts
@@ -79,6 +79,7 @@ import {
   IMomentoCache,
   SubscribeCallOptions,
   CacheInfo,
+  VectorIndexInfo,
   CollectionTtl,
   ItemType,
   SortedSetOrder,
@@ -172,6 +173,7 @@ export {
   VectorIndexConfiguration,
   VectorIndexConfigurations,
   CacheInfo,
+  VectorIndexInfo,
   CredentialProvider,
   StringMomentoTokenProvider,
   EnvMomentoTokenProvider,

diff --git a/packages/client-sdk-web/src/internal/vector-index-control-client.ts b/packages/client-sdk-web/src/internal/vector-index-control-client.ts
@@ -4,6 +4,7 @@ import {
   InvalidArgumentError,
   MomentoLogger,
   VectorIndexConfiguration,
+  VectorIndexInfo,
 } from '..';
 import {Request, StatusCode, UnaryResponse} from 'grpc-web';
 import {
@@ -141,7 +142,13 @@ export class VectorIndexControlClient<
           if (err) {
             resolve(new ListVectorIndexes.Error(cacheServiceErrorMapper(err)));
           } else {
-            const indexes = resp.getIndexNamesList();
+            const indexes: VectorIndexInfo[] = resp
+              .getIndexNamesList()
+              .map((name: string) => {
+                // eslint-disable-next-line @typescript-eslint/no-unsafe-return, @typescript-eslint/no-unsafe-call
+                return new VectorIndexInfo(name);
+              });
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
             resolve(new ListVectorIndexes.Success(indexes));
           }
         }

diff --git a/packages/common-integration-tests/src/vector-control-plane.ts b/packages/common-integration-tests/src/vector-control-plane.ts
@@ -87,8 +87,9 @@ export function runVectorControlPlaneTest(vectorClient: IVectorIndexClient) {
             expect(listResponse).toBeInstanceOf(ListVectorIndexes.Success);
           }, `expected SUCCESS but got ${listResponse.toString()}`);
           if (listResponse instanceof ListVectorIndexes.Success) {
-            const caches = listResponse.getIndexNames();
-            expect(caches.includes(indexName)).toBeTruthy();
+            const indexes = listResponse.getIndexes();
+            const indexNames = indexes.map(indexInfo => indexInfo.getName());
+            expect(indexNames.includes(indexName)).toBeTruthy();
           }
         }
       );

diff --git a/packages/core/src/index.ts b/packages/core/src/index.ts
@@ -75,6 +75,7 @@ export * as leaderboard from './messages/responses/leaderboard';
 export * from './messages/responses/leaderboard';
 
 import {CacheInfo} from './messages/cache-info';
+export {VectorIndexInfo} from './messages/vector-index-info';
 import {
   SubscribeCallOptions,
   CollectionTtl,

diff --git a/packages/core/src/messages/responses/vector/list-vector-indexes.ts b/packages/core/src/messages/responses/vector/list-vector-indexes.ts
@@ -1,4 +1,5 @@
 import {SdkError} from '../../../errors';
+import {VectorIndexInfo} from '../../vector-index-info';
 import {ResponseBase, ResponseError, ResponseSuccess} from '../response-base';
 
 /**
@@ -23,22 +24,23 @@ import {ResponseBase, ResponseError, ResponseSuccess} from '../response-base';
 export abstract class Response extends ResponseBase {}
 
 class _Success extends Response {
-  private readonly indexNames: string[];
-  constructor(indexNames: string[]) {
+  private readonly indexes: VectorIndexInfo[];
+  constructor(indexes: VectorIndexInfo[]) {
     super();
-    this.indexNames = indexNames;
+    this.indexes = indexes;
   }
 
   /**
    * An array of index names.
    * @returns {string[]}
    */
-  public getIndexNames() {
-    return this.indexNames;
+  public getIndexes() {
+    return this.indexes;
   }
 
   public override toString() {
-    return super.toString() + ': ' + this.indexNames.join(', ');
+    const indexes = this.indexes.map(indexInfo => indexInfo.getName());
+    return super.toString() + ': ' + indexes.join(', ');
   }
 }
 

diff --git a/packages/core/src/messages/vector-index-info.ts b/packages/core/src/messages/vector-index-info.ts
@@ -0,0 +1,11 @@
+export class VectorIndexInfo {
+  private readonly name: string;
+
+  constructor(name: string) {
+    this.name = name;
+  }
+
+  public getName() {
+    return this.name;
+  }
+}