[Files] Adds bulk get method

src/plugins/files/server/file_client/file_metadata_client/adapters/es_index.ts

@@ -12,20 +12,24 @@ import { Logger } from '@kbn/core/server';
 import { toElasticsearchQuery } from '@kbn/es-query';
 import { ElasticsearchClient } from '@kbn/core-elasticsearch-server';
 import { MappingProperty, SearchTotalHits } from '@elastic/elasticsearch/lib/api/types';
+import pLimit from 'p-limit';
+
 import type { FilesMetrics, FileMetadata, Pagination } from '../../../../common';
 import type { FindFileArgs } from '../../../file_service';
 import type {
   DeleteArg,
   FileDescriptor,
   FileMetadataClient,
   GetArg,
+  BulkGetArg,
   GetUsageMetricsArgs,
   UpdateArgs,
 } from '../file_metadata_client';
 import { filterArgsToKuery } from './query_filters';
 import { fileObjectType } from '../../../saved_objects/file';
 
 const filterArgsToESQuery = pipe(filterArgsToKuery, toElasticsearchQuery);
+const bulkGetConcurrency = pLimit(10);
 
 const fileMappings: MappingProperty = {
   dynamic: false,
@@ -120,6 +124,12 @@ export class EsIndexFilesMetadataClient<M = unknown> implements FileMetadataClie
     };
   }
 
+  async bulkGet({ ids }: BulkGetArg): Promise<FileDescriptor[]> {
+    const promises = ids.map((id) => bulkGetConcurrency(() => this.get({ id })));
+    const result = await Promise.all(promises);
+    return result;
+  }
+
   async delete({ id }: DeleteArg): Promise<void> {
     await this.esClient.delete({ index: this.index, id });
   }

src/plugins/files/server/file_client/file_metadata_client/adapters/saved_objects.ts

@@ -21,6 +21,8 @@ import type { FileMetadata, FilesMetrics, FileStatus } from '../../../../common/
 import type {
   FileMetadataClient,
   UpdateArgs,
+  GetArg,
+  BulkGetArg,
   FileDescriptor,
   GetUsageMetricsArgs,
 } from '../file_metadata_client';
@@ -54,14 +56,23 @@ export class SavedObjectsFileMetadataClient implements FileMetadataClient {
       metadata: result.attributes as FileDescriptor['metadata'],
     };
   }
-  async get({ id }: { id: string }): Promise<FileDescriptor> {
+
+  async get({ id }: GetArg): Promise<FileDescriptor> {
     const result = await this.soClient.get(this.soType, id);
     return {
       id: result.id,
       metadata: result.attributes as FileDescriptor['metadata'],
     };
   }
 
+  async bulkGet({ ids }: BulkGetArg): Promise<FileDescriptor[]> {
+    const result = await this.soClient.bulkGet(ids.map((id) => ({ id, type: this.soType })));
+    return result.saved_objects.map((so) => ({
+      id: so.id,
+      metadata: so.attributes as FileDescriptor['metadata'],
+    }));
+  }
+
   async find({ page, perPage, ...filterArgs }: FindFileArgs = {}): Promise<{
     total: number;
     files: Array<FileDescriptor<unknown>>;

src/plugins/files/server/file_client/file_metadata_client/file_metadata_client.ts

@@ -63,6 +63,16 @@ export interface GetArg {
   id: string;
 }
 
+/**
+ * Bulk get files
+ */
+export interface BulkGetArg {
+  /**
+   * Unique IDs of file metadata
+   */
+  ids: string[];
+}
+
 export interface DeleteArg {
   /**
    * Unique ID of file metadata to delete
@@ -98,6 +108,13 @@ export interface FileMetadataClient {
    */
   get(arg: GetArg): Promise<FileDescriptor>;
 
+  /**
+   * Bulk get file metadata
+   *
+   * @param arg - Arguments to bulk retrieve file metadata
+   */
+  bulkGet(arg: BulkGetArg): Promise<FileDescriptor[]>;
+
   /**
    * The file metadata to update
    *

src/plugins/files/server/file_service/file_action_types.ts

@@ -72,6 +72,16 @@ export interface GetByIdArgs {
   id: string;
 }
 
+/**
+ * Arguments to bulk get multiple files by their IDs.
+ */
+export interface BulkGetByIdArgs {
+  /**
+   * File IDs.
+   */
+  ids: string[];
+}
+
 /**
  * Arguments to filter for files.
  *

src/plugins/files/server/file_service/file_service.ts

@@ -13,6 +13,7 @@ import type {
   UpdateFileArgs,
   DeleteFileArgs,
   GetByIdArgs,
+  BulkGetByIdArgs,
   FindFileArgs,
 } from './file_action_types';
 
@@ -50,6 +51,13 @@ export interface FileServiceStart {
    */
   getById<M>(args: GetByIdArgs): Promise<File<M>>;
 
+  /**
+   * Bulk get files by IDs. Will throw if any of the files fail to load.
+   *
+   * @param args - bulk get files by IDs args
+   */
+  bulkGetById<M>(args: BulkGetByIdArgs): Promise<Array<File<M>>>;
+
   /**
    * Find files given a set of parameters.
    *

src/plugins/files/server/file_service/file_service_factory.ts

@@ -20,7 +20,13 @@ import { fileObjectType, fileShareObjectType, hiddenTypes } from '../saved_objec
 import { BlobStorageService } from '../blob_storage_service';
 import { FileClientImpl } from '../file_client/file_client';
 import { InternalFileShareService } from '../file_share_service';
-import { CreateFileArgs, FindFileArgs, GetByIdArgs, UpdateFileArgs } from './file_action_types';
+import {
+  CreateFileArgs,
+  FindFileArgs,
+  GetByIdArgs,
+  BulkGetByIdArgs,
+  UpdateFileArgs,
+} from './file_action_types';
 import { InternalFileService } from './internal_file_service';
 import { FileServiceStart } from './file_service';
 import { FileKindsRegistry } from '../../common/file_kinds_registry';
@@ -99,6 +105,9 @@ export class FileServiceFactoryImpl implements FileServiceFactory {
       async getById<M>(args: GetByIdArgs) {
         return internalFileService.getById(args) as Promise<File<M>>;
       },
+      async bulkGetById<M>(args: BulkGetByIdArgs) {
+        return internalFileService.bulkGetById(args) as Promise<Array<File<M>>>;
+      },
       async find<M>(args: FindFileArgs) {
         return internalFileService.findFilesJSON(args) as Promise<{
           files: Array<FileJSON<M>>;

src/plugins/files/server/file_service/internal_file_service.ts

@@ -22,6 +22,7 @@ import type {
   DeleteFileArgs,
   FindFileArgs,
   GetByIdArgs,
+  BulkGetByIdArgs,
 } from './file_action_types';
 import { createFileClient, FileClientImpl } from '../file_client/file_client';
 /**
@@ -80,10 +81,33 @@ export class InternalFileService {
     }
   }
 
+  private async bulkGet(ids: string[]): Promise<IFile[]> {
+    try {
+      const metadatas = await this.metadataClient.bulkGet({ ids });
+      const result = metadatas.map(({ id, metadata }) => {
+        if (metadata.Status === 'DELETED') {
+          throw new FileNotFoundError('File has been deleted');
+        }
+        return this.toFile(id, metadata, metadata.FileKind);
+      });
+      return result;
+    } catch (e) {
+      if (SavedObjectsErrorHelpers.isNotFoundError(e)) {
+        throw new FileNotFoundError('Files not found');
+      }
+      this.logger.error(`Could not retrieve files: ${e}`);
+      throw e;
+    }
+  }
+
   public async getById({ id }: GetByIdArgs): Promise<IFile> {
     return await this.get(id);
   }
 
+  public async bulkGetById({ ids }: BulkGetByIdArgs): Promise<IFile[]> {
+    return await this.bulkGet(ids);
+  }
+
   public getFileKind(id: string): FileKind {
     return this.fileKindRegistry.get(id);
   }

src/plugins/files/server/integration_tests/file_service.test.ts

@@ -140,6 +140,20 @@ describe('FileService', () => {
     expect(myFile?.id).toMatch(id);
   });
 
+  it('retrieves a file using the bulk method', async () => {
+    const { id } = await createDisposableFile({ fileKind, name: 'test' });
+    const [myFile] = await fileService.bulkGetById({ ids: [id] });
+    expect(myFile?.id).toMatch(id);
+  });
+
+  it('retrieves multiple files using the bulk method', async () => {
+    const file1 = await createDisposableFile({ fileKind, name: 'test' });
+    const file2 = await createDisposableFile({ fileKind, name: 'test' });
+    const [myFile1, myFile2] = await fileService.bulkGetById({ ids: [file1.id, file2.id] });
+    expect(myFile1?.id).toMatch(file1.id);
+    expect(myFile2?.id).toMatch(file2.id);
+  });
+
   it('lists files', async () => {
     await Promise.all([
       createDisposableFile({ fileKind, name: 'test-1' }),

src/plugins/files/server/mocks.ts

@@ -18,6 +18,7 @@ export const createFileServiceMock = (): DeeplyMockedKeys<FileServiceStart> => (
   deleteShareObject: jest.fn(),
   find: jest.fn(),
   getById: jest.fn(),
+  bulkGetById: jest.fn(),
   getByToken: jest.fn(),
   getShareObject: jest.fn(),
   getUsageMetrics: jest.fn(),