add: a test case for replacing file & fix name convention

Author: ChengShi-1

docs/useCases.md

@@ -1578,20 +1578,20 @@ Check if the file has been deleted, return a boolean.
 ##### Example call:
 
 ```typescript
-import { fileHasBeenDeleted } from '@iqss/dataverse-client-javascript'
+import { getFileHasBeenDeleted } from '@iqss/dataverse-client-javascript'
 
 /* ... */
 
 const fileId = 12345
 
-await fileHasBeenDeleted.execute(fileId).then((hasBeenDeleted: boolean) => {
+await getFileHasBeenDeleted.execute(fileId).then((hasBeenDeleted: boolean) => {
   /* ... */
 })
 
 /* ... */
 ```
 
-_See [use case](../src/files/domain/useCases/FileHasBeenDeleted.ts) implementation_.
+_See [use case](../src/files/domain/useCases/GetFileHasBeenDeleted.ts) implementation_.
 
 The `fileId` parameter can be a string, for persistent identifiers, or a number, for numeric identifiers.
 

src/files/domain/repositories/IFilesRepository.ts

@@ -85,5 +85,5 @@ export interface IFilesRepository {
     replace?: boolean
   ): Promise<void>
 
-  fileHasBeenDeleted(fileId: number | string): Promise<boolean>
+  getFileHasBeenDeleted(fileId: number | string): Promise<boolean>
 }

…es/domain/useCases/FileHasBeenDeleted.ts …domain/useCases/GetFileHasBeenDeleted.tssrc/files/domain/useCases/FileHasBeenDeleted.ts renamed to src/files/domain/useCases/GetFileHasBeenDeleted.ts src/files/domain/useCases/FileHasBeenDeleted.ts renamed to src/files/domain/useCases/GetFileHasBeenDeleted.ts

@@ -1,7 +1,7 @@
 import { IFilesRepository } from '../repositories/IFilesRepository'
 import { UseCase } from '../../../core/domain/useCases/UseCase'
 
-export class FileHasBeenDeleted implements UseCase<boolean> {
+export class GetFileHasBeenDeleted implements UseCase<boolean> {
   constructor(private readonly filesRepository: IFilesRepository) {}
 
   /**
@@ -11,6 +11,6 @@ export class FileHasBeenDeleted implements UseCase<boolean> {
    * @returns {Promise<boolean>} - A boolean indicating whether the file has been deleted or not.
    */
   async execute(fileId: number | string): Promise<boolean> {
-    return await this.filesRepository.fileHasBeenDeleted(fileId)
+    return await this.filesRepository.getFileHasBeenDeleted(fileId)
   }
 }

src/files/index.ts

@@ -17,7 +17,7 @@ import { RestrictFile } from './domain/useCases/RestrictFile'
 import { UpdateFileMetadata } from './domain/useCases/UpdateFileMetadata'
 import { UpdateFileTabularTags } from './domain/useCases/UpdateFileTabularTags'
 import { UpdateFileCategories } from './domain/useCases/UpdateFileCategories'
-import { FileHasBeenDeleted } from './domain/useCases/FileHasBeenDeleted'
+import { GetFileHasBeenDeleted } from './domain/useCases/GetFileHasBeenDeleted'
 
 const filesRepository = new FilesRepository()
 const directUploadClient = new DirectUploadClient(filesRepository)
@@ -39,7 +39,7 @@ const restrictFile = new RestrictFile(filesRepository)
 const updateFileMetadata = new UpdateFileMetadata(filesRepository)
 const updateFileTabularTags = new UpdateFileTabularTags(filesRepository)
 const updateFileCategories = new UpdateFileCategories(filesRepository)
-const fileHasBeenDeleted = new FileHasBeenDeleted(filesRepository)
+const getFileHasBeenDeleted = new GetFileHasBeenDeleted(filesRepository)
 
 export {
   getDatasetFiles,
@@ -59,7 +59,7 @@ export {
   updateFileTabularTags,
   updateFileCategories,
   replaceFile,
-  fileHasBeenDeleted
+  getFileHasBeenDeleted
 }
 
 export { FileModel as File, FileEmbargo, FileChecksum } from './domain/models/FileModel'

src/files/infra/repositories/FilesRepository.ts

@@ -416,7 +416,7 @@ export class FilesRepository extends ApiRepository implements IFilesRepository {
       })
   }
 
-  public async fileHasBeenDeleted(fileId: number | string): Promise<boolean> {
+  public async getFileHasBeenDeleted(fileId: number | string): Promise<boolean> {
     return this.doGet(this.buildApiEndpoint(this.filesResourceName, 'hasBeenDeleted', fileId), true)
       .then((response) => response.data.data)
       .catch((error) => {

test/integration/files/FilesRepository.test.ts

@@ -1,3 +1,4 @@
+import * as crypto from 'crypto'
 import { FilesRepository } from '../../../src/files/infra/repositories/FilesRepository'
 import {
   ApiConfig,
@@ -43,6 +44,7 @@ import {
 } from '../../testHelpers/collections/collectionHelper'
 import { RestrictFileDTO } from '../../../src/files/domain/dtos/RestrictFileDTO'
 import { DatasetsRepository } from '../../../src/datasets/infra/repositories/DatasetsRepository'
+import { DirectUploadClient } from '../../../src/files/infra/clients/DirectUploadClient'
 
 describe('FilesRepository', () => {
   const sut: FilesRepository = new FilesRepository()
@@ -840,9 +842,10 @@ describe('FilesRepository', () => {
     })
   })
 
-  describe('fileHasBeenDeleted', () => {
+  describe('getFileHasBeenDeleted', () => {
     let deleFileTestDatasetIds: CreatedDatasetIdentifiers
     const testTextFile1Name = 'test-file-1.txt'
+    const testTextFile2Name = 'test-file-2.txt'
     let fileId: number
 
     beforeAll(async () => {
@@ -870,15 +873,15 @@ describe('FilesRepository', () => {
     })
 
     test('should return False if a file has not been deleted', async () => {
-      const hasBeenDeleted = await sut.fileHasBeenDeleted(fileId)
+      const hasBeenDeleted = await sut.getFileHasBeenDeleted(fileId)
       expect(hasBeenDeleted).toBe(false)
     })
 
     test('should return error if the dataset is unpublished and the file has been deleted', async () => {
       await sut.deleteFile(fileId)
 
       const expectedError = new ReadError(`[404] File with ID ${nonExistentFiledId} not found.`)
-      await expect(sut.fileHasBeenDeleted(nonExistentFiledId)).rejects.toThrow(expectedError)
+      await expect(sut.getFileHasBeenDeleted(nonExistentFiledId)).rejects.toThrow(expectedError)
     })
 
     test('should return True when the dataset is published and the file has not been deleted', async () => {
@@ -899,22 +902,93 @@ describe('FilesRepository', () => {
       )
       fileId = datasetFiles.files[0].id
 
-      const notDeleted = await sut.fileHasBeenDeleted(fileId)
+      const notDeleted = await sut.getFileHasBeenDeleted(fileId)
       expect(notDeleted).toBe(false)
 
       await sut.deleteFile(fileId)
 
-      const hasBeenDeleted = await sut.fileHasBeenDeleted(fileId)
+      const hasBeenDeleted = await sut.getFileHasBeenDeleted(fileId)
       expect(hasBeenDeleted).toBe(true)
     })
 
-    test('should return error when file does not exist', async () => {
-      const expectedError = new ReadError(`[404] File with ID ${nonExistentFiledId} not found.`)
+    test('should return True when file has been replaced', async () => {
+      const directUploadSut: DirectUploadClient = new DirectUploadClient(sut)
+
+      // Upload original file
+      await uploadFileViaApi(deleFileTestDatasetIds.numericId, testTextFile1Name).catch(() => {
+        throw new Error(`Error while uploading file ${testTextFile1Name}`)
+      })
+
+      const datasetFiles = await sut.getDatasetFiles(
+        deleFileTestDatasetIds.numericId,
+        latestDatasetVersionId,
+        false,
+        FileOrderCriteria.NAME_AZ
+      )
+      const originalFileId = datasetFiles.files[0].id
+
+      const createTestFileUploadDestination = async (file: File, testDatasetId: number) => {
+        const filesRepository = new FilesRepository()
+        const destination = await filesRepository.getFileUploadDestination(testDatasetId, file)
+        destination.urls.forEach((destinationUrl, index) => {
+          destination.urls[index] = destinationUrl.replace('localstack', 'localhost')
+        })
+        return destination
+      }
+
+      // Create a new file and replace the original file
+      const newFileBlob = await createSinglepartFileBlob(testTextFile2Name, 2000)
+      const newDestination = await createTestFileUploadDestination(
+        newFileBlob,
+        deleFileTestDatasetIds.numericId
+      )
+
+      const progressMock = jest.fn()
+      const abortController = new AbortController()
+
+      const newStorageId = await directUploadSut.uploadFile(
+        deleFileTestDatasetIds.numericId,
+        newFileBlob,
+        progressMock,
+        abortController,
+        newDestination
+      )
 
-      await expect(sut.fileHasBeenDeleted(nonExistentFiledId)).rejects.toThrow(expectedError)
+      const fileArrayBuffer = await newFileBlob.arrayBuffer()
+      const fileBuffer = Buffer.from(fileArrayBuffer)
+
+      const calculateBlobChecksum = (blob: Buffer): string => {
+        const hash = crypto.createHash('md5')
+        hash.update(blob)
+        return hash.digest('hex')
+      }
+
+      const newUploadedFileDTO = {
+        fileName: newFileBlob.name,
+        storageId: newStorageId,
+        checksumType: 'md5',
+        checksumValue: calculateBlobChecksum(fileBuffer),
+        mimeType: newFileBlob.type
+      }
+
+      //Publish the dataset and check if the original file has been deleted
+      await publishDatasetViaApi(deleFileTestDatasetIds.numericId)
+
+      await waitForNoLocks(deleFileTestDatasetIds.numericId, 10)
+
+      await sut.replaceFile(originalFileId, newUploadedFileDTO)
+
+      const isDeleted = await sut.getFileHasBeenDeleted(originalFileId)
+      expect(isDeleted).toBe(true)
     })
   })
 
+  test('should return error when file does not exist', async () => {
+    const expectedError = new ReadError(`[404] File with ID ${nonExistentFiledId} not found.`)
+
+    await expect(sut.getFileHasBeenDeleted(nonExistentFiledId)).rejects.toThrow(expectedError)
+  })
+
   describe('restrictFile', () => {
     let restrictFileDatasetIds: CreatedDatasetIdentifiers
     const testTextFile1Name = 'test-file-1.txt'

…st/unit/files/FileHasBeenDeleted.test.ts …unit/files/GetFileHasBeenDeleted.test.tstest/unit/files/FileHasBeenDeleted.test.ts renamed to test/unit/files/GetFileHasBeenDeleted.test.ts test/unit/files/FileHasBeenDeleted.test.ts renamed to test/unit/files/GetFileHasBeenDeleted.test.ts

@@ -1,12 +1,12 @@
 import { IFilesRepository } from '../../../src/files/domain/repositories/IFilesRepository'
-import { FileHasBeenDeleted } from '../../../src/files/domain/useCases/FileHasBeenDeleted'
+import { GetFileHasBeenDeleted } from '../../../src/files/domain/useCases/GetFileHasBeenDeleted'
 import { ReadError } from '../../../src'
 
 describe('execute', () => {
   test('should return true when file has been deleted', async () => {
     const filesRepositoryStub: IFilesRepository = {} as IFilesRepository
-    filesRepositoryStub.fileHasBeenDeleted = jest.fn().mockResolvedValue(true)
-    const sut = new FileHasBeenDeleted(filesRepositoryStub)
+    filesRepositoryStub.getFileHasBeenDeleted = jest.fn().mockResolvedValue(true)
+    const sut = new GetFileHasBeenDeleted(filesRepositoryStub)
 
     const result = await sut.execute(1)
 
@@ -15,8 +15,8 @@ describe('execute', () => {
 
   test('should return false when file has not been deleted', async () => {
     const filesRepositoryStub: IFilesRepository = {} as IFilesRepository
-    filesRepositoryStub.fileHasBeenDeleted = jest.fn().mockResolvedValue(false)
-    const sut = new FileHasBeenDeleted(filesRepositoryStub)
+    filesRepositoryStub.getFileHasBeenDeleted = jest.fn().mockResolvedValue(false)
+    const sut = new GetFileHasBeenDeleted(filesRepositoryStub)
 
     const result = await sut.execute(1)
 
@@ -25,8 +25,8 @@ describe('execute', () => {
 
   test('should return error result on repository error', async () => {
     const filesRepositoryStub: IFilesRepository = {} as IFilesRepository
-    filesRepositoryStub.fileHasBeenDeleted = jest.fn().mockRejectedValue(new ReadError())
-    const sut = new FileHasBeenDeleted(filesRepositoryStub)
+    filesRepositoryStub.getFileHasBeenDeleted = jest.fn().mockRejectedValue(new ReadError())
+    const sut = new GetFileHasBeenDeleted(filesRepositoryStub)
 
     await expect(sut.execute(1)).rejects.toThrow(ReadError)
   })