Add file resource wrappers (#579)

Author: shanghaikid

milvus/grpc/GrpcClient.ts

@@ -29,6 +29,11 @@ import {
   DEFAULT_POOL_MIN,
   RunAnalyzerRequest,
   RunAnalyzerResponse,
+  ResStatus,
+  AddFileResourceReq,
+  RemoveFileResourceReq,
+  ListFileResourcesReq,
+  ListFileResourcesResponse,
   fetchTopology,
   getPrimaryCluster,
   TopologyRefresher,
@@ -495,4 +500,53 @@ export class GRPCClient extends User {
       this.timeout
     );
   }
+
+  /**
+   * Adds a file resource to Milvus metadata.
+   * @param {AddFileResourceReq} data - The file resource name and server-visible path.
+   * @returns {Promise<ResStatus>} - A Promise that resolves with the operation status.
+   */
+  async addFileResource(data: AddFileResourceReq): Promise<ResStatus> {
+    return await promisify(
+      this.channelPool,
+      'AddFileResource',
+      {
+        name: data.name,
+        path: data.path,
+      },
+      data.timeout || this.timeout
+    );
+  }
+
+  /**
+   * Removes a file resource from Milvus metadata.
+   * @param {RemoveFileResourceReq} data - The file resource name.
+   * @returns {Promise<ResStatus>} - A Promise that resolves with the operation status.
+   */
+  async removeFileResource(data: RemoveFileResourceReq): Promise<ResStatus> {
+    return await promisify(
+      this.channelPool,
+      'RemoveFileResource',
+      {
+        name: data.name,
+      },
+      data.timeout || this.timeout
+    );
+  }
+
+  /**
+   * Lists file resources registered in Milvus metadata.
+   * @param {ListFileResourcesReq} [data] - Optional request parameters.
+   * @returns {Promise<ListFileResourcesResponse>} - A Promise that resolves with file resources.
+   */
+  async listFileResources(
+    data: ListFileResourcesReq = {}
+  ): Promise<ListFileResourcesResponse> {
+    return await promisify(
+      this.channelPool,
+      'ListFileResources',
+      {},
+      data.timeout || this.timeout
+    );
+  }
 }

milvus/types/Client.ts

@@ -1,7 +1,7 @@
 import { ChannelOptions } from '@grpc/grpc-js';
 import { Options as LoaderOption } from '@grpc/proto-loader';
 import { Options } from 'generic-pool';
-import { ResStatus } from './';
+import { GrpcTimeOut, ResStatus } from './Common';
 
 /**
  * Configuration options for the Milvus client.
@@ -114,3 +114,25 @@ export interface RunAnalyzerResponse {
   status: ResStatus;
   results: AnalyzerResult[];
 }
+
+export interface AddFileResourceReq extends GrpcTimeOut {
+  name: string;
+  path: string;
+}
+
+export interface RemoveFileResourceReq extends GrpcTimeOut {
+  name: string;
+}
+
+export interface ListFileResourcesReq extends GrpcTimeOut {}
+
+export interface FileResourceInfo {
+  id: string;
+  name: string;
+  path: string;
+}
+
+export interface ListFileResourcesResponse {
+  status: ResStatus;
+  resources: FileResourceInfo[];
+}

test/grpc/FileResource.spec.ts

@@ -0,0 +1,116 @@
+import { Client as MinioClient } from 'minio';
+import { execSync } from 'child_process';
+import { ErrorCode, MilvusClient } from '../../milvus';
+import { GENERATE_NAME, IP } from '../tools';
+
+const milvusClient = new MilvusClient({ address: IP, logLevel: 'info' });
+let minioClient: MinioClient;
+
+const BUCKET_NAME = 'a-bucket';
+const RESOURCE_NAME = GENERATE_NAME('file_resource');
+const MISSING_RESOURCE_NAME = GENERATE_NAME('missing_file_resource');
+const OBJECT_NAME = `node-sdk-file-resource/${RESOURCE_NAME}.txt`;
+const MISSING_OBJECT_NAME = `node-sdk-file-resource/${MISSING_RESOURCE_NAME}.txt`;
+
+const createMinioClient = (endPoint: string) =>
+  new MinioClient({
+    endPoint,
+    port: 9000,
+    useSSL: false,
+    accessKey: 'minioadmin',
+    secretKey: 'minioadmin',
+  });
+
+const getMilvusMinioContainerIP = () =>
+  execSync(
+    `docker inspect milvus-minio --format '{{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}'`,
+    { encoding: 'utf8' }
+  ).trim();
+
+const putTestObject = async () => {
+  const candidates = [
+    () => process.env.FILE_RESOURCE_MINIO_ENDPOINT || '127.0.0.1',
+    getMilvusMinioContainerIP,
+  ];
+
+  let lastError: unknown;
+  for (const getEndPoint of candidates) {
+    try {
+      const endPoint = getEndPoint();
+      minioClient = createMinioClient(endPoint);
+      await minioClient.putObject(
+        BUCKET_NAME,
+        OBJECT_NAME,
+        Buffer.from('node sdk file resource test\n')
+      );
+      return;
+    } catch (error) {
+      lastError = error;
+    }
+  }
+
+  throw lastError;
+};
+
+describe('FileResource API', () => {
+  beforeAll(async () => {
+    await putTestObject();
+  });
+
+  afterAll(async () => {
+    try {
+      await milvusClient.removeFileResource({ name: RESOURCE_NAME });
+    } catch {
+      // best-effort cleanup
+    }
+
+    try {
+      await minioClient.removeObject(BUCKET_NAME, OBJECT_NAME);
+    } catch {
+      // best-effort cleanup
+    }
+  });
+
+  it('should list file resources', async () => {
+    const res = await milvusClient.listFileResources();
+
+    expect(res.status.error_code).toEqual(ErrorCode.SUCCESS);
+    expect(Array.isArray(res.resources)).toEqual(true);
+  });
+
+  it('should reject add file resource with missing object path', async () => {
+    const res = await milvusClient.addFileResource({
+      name: MISSING_RESOURCE_NAME,
+      path: MISSING_OBJECT_NAME,
+    });
+
+    expect(res.error_code).not.toEqual(ErrorCode.SUCCESS);
+  });
+
+  it('should add, list, and remove file resource', async () => {
+    const add = await milvusClient.addFileResource({
+      name: RESOURCE_NAME,
+      path: OBJECT_NAME,
+      timeout: 10000,
+    });
+    expect(add.error_code).toEqual(ErrorCode.SUCCESS);
+
+    const list = await milvusClient.listFileResources({ timeout: 10000 });
+    expect(list.status.error_code).toEqual(ErrorCode.SUCCESS);
+
+    const resource = list.resources.find(item => item.name === RESOURCE_NAME);
+    expect(resource).toBeDefined();
+    expect(resource!.path).toEqual(OBJECT_NAME);
+
+    const remove = await milvusClient.removeFileResource({
+      name: RESOURCE_NAME,
+      timeout: 10000,
+    });
+    expect(remove.error_code).toEqual(ErrorCode.SUCCESS);
+
+    const listAfterRemove = await milvusClient.listFileResources();
+    expect(
+      listAfterRemove.resources.some(item => item.name === RESOURCE_NAME)
+    ).toEqual(false);
+  });
+});