feat: return new file id after replacement

Author: g-saracca

src/files/domain/repositories/IFilesRepository.ts

@@ -63,7 +63,7 @@ export interface IFilesRepository {
 
   deleteFile(fileId: number | string): Promise<undefined>
 
-  replaceFile(fileId: number | string, uploadedFileDTO: UploadedFileDTO): Promise<undefined>
+  replaceFile(fileId: number | string, uploadedFileDTO: UploadedFileDTO): Promise<number>
 
   restrictFile(fileId: number | string, restrict: boolean): Promise<undefined>
   updateFileMetadata(

src/files/domain/useCases/ReplaceFile.ts

@@ -2,7 +2,7 @@ import { UseCase } from '../../../core/domain/useCases/UseCase'
 import { UploadedFileDTO } from '../dtos/UploadedFileDTO'
 import { IFilesRepository } from '../repositories/IFilesRepository'
 
-export class ReplaceFile implements UseCase<void> {
+export class ReplaceFile implements UseCase<number> {
   private filesRepository: IFilesRepository
 
   constructor(filesRepository: IFilesRepository) {
@@ -19,10 +19,10 @@ export class ReplaceFile implements UseCase<void> {
    *
    * @param {number | string} [fileId] - The File identifier, which can be a string (for persistent identifiers), or a number (for numeric identifiers).
    * @param {UploadedFileDTO} [uploadedFileDTO] - File DTO associated with the uploaded file.
-   * @returns {Promise<void>} A promise that resolves when the file has been successfully replaced.
+   * @returns {Promise<number>} A promise that resolves when the file has been successfully replaced and returns the new file identifier.
    * @throws {WriteError} - If there are errors while writing data.
    */
-  async execute(fileId: number | string, uploadedFileDTO: UploadedFileDTO): Promise<void> {
-    await this.filesRepository.replaceFile(fileId, uploadedFileDTO)
+  async execute(fileId: number | string, uploadedFileDTO: UploadedFileDTO): Promise<number> {
+    return await this.filesRepository.replaceFile(fileId, uploadedFileDTO)
   }
 }

src/files/infra/repositories/FilesRepository.ts

@@ -20,6 +20,7 @@ import { transformUploadDestinationsResponseToUploadDestination } from './transf
 import { UploadedFileDTO } from '../../domain/dtos/UploadedFileDTO'
 import { UpdateFileMetadataDTO } from '../../domain/dtos/UpdateFileMetadataDTO'
 import { ApiConstants } from '../../../core/infra/repositories/ApiConstants'
+import { AxiosResponse } from 'axios'
 
 export interface GetFilesQueryParams {
   includeDeaccessioned: boolean
@@ -60,6 +61,10 @@ export interface ChecksumRequestBody {
   '@type': string
 }
 
+type ReplaceFileResponseMinimal = {
+  files: { dataFile: { id: number } }[]
+}
+
 export class FilesRepository extends ApiRepository implements IFilesRepository {
   private readonly datasetsResourceName: string = 'datasets'
   private readonly filesResourceName: string = 'files'
@@ -307,7 +312,7 @@ export class FilesRepository extends ApiRepository implements IFilesRepository {
   public async replaceFile(
     fileId: number | string,
     uploadedFileDTO: UploadedFileDTO
-  ): Promise<undefined> {
+  ): Promise<number> {
     const requestBody: UploadedFileRequestBody = {
       fileName: uploadedFileDTO.fileName,
       checksum: {
@@ -332,7 +337,10 @@ export class FilesRepository extends ApiRepository implements IFilesRepository {
       {},
       ApiConstants.CONTENT_TYPE_MULTIPART_FORM_DATA
     )
-      .then(() => undefined)
+      .then((response: AxiosResponse<{ data: ReplaceFileResponseMinimal }>) => {
+        const fileNumber = response.data.data.files[0].dataFile.id
+        return fileNumber
+      })
       .catch((error) => {
         throw error
       })

test/integration/files/DirectUpload.test.ts

@@ -330,7 +330,9 @@ describe('Direct Upload', () => {
       mimeType: newSinglepartFile.type
     }
 
-    await filesRepositorySut.replaceFile(currentFileId, newUploadedFileDTO)
+    const replaceResponse = await filesRepositorySut.replaceFile(currentFileId, newUploadedFileDTO)
+
+    console.log({ replaceResponse })
 
     // 4 - Verify that the new file is in the dataset and the old file is not
     datasetFiles = await filesRepositorySut.getDatasetFiles(
@@ -341,6 +343,7 @@ describe('Direct Upload', () => {
     )
 
     expect(datasetFiles.totalFilesCount).toBe(1)
+    expect(replaceResponse).toBe(currentFileId + 1)
     expect(datasetFiles.files[0].name).toBe('new-singlepart-file')
     expect(datasetFiles.files[0].sizeBytes).toBe(newSinglepartFile.size)
     expect(datasetFiles.files[0].storageIdentifier).toContain('localstack1://mybucket:')

test/unit/files/ReplaceFile.test.ts

@@ -12,15 +12,15 @@ describe('execute', () => {
     mimeType: 'test/type'
   }
 
-  test('should return undefined on client success', async () => {
+  test('should return file id on client success', async () => {
     const filesRepositoryStub: IFilesRepository = {} as IFilesRepository
-    filesRepositoryStub.replaceFile = jest.fn().mockResolvedValue(undefined)
+    filesRepositoryStub.replaceFile = jest.fn().mockResolvedValue(1)
 
     const sut = new ReplaceFile(filesRepositoryStub)
 
     const actual = await sut.execute(1, testUploadedFileDTO)
 
-    expect(actual).toEqual(undefined)
+    expect(actual).toEqual(1)
   })
 
   test('should return error on client error', async () => {