feat: add sourceLastUpdateTime argument to update dataset metadata use case

Author: g-saracca

src/files/domain/models/FileModel.ts

@@ -30,6 +30,7 @@ export interface FileModel {
   tabularTags?: string[]
   creationDate?: string
   publicationDate?: string
+  lastUpdateTime: string
   deleted: boolean
   tabularData: boolean
   fileAccessRequest?: boolean

src/files/domain/repositories/IFilesRepository.ts

@@ -72,7 +72,8 @@ export interface IFilesRepository {
 
   updateFileMetadata(
     fileId: number | string,
-    updateFileMetadataDTO: UpdateFileMetadataDTO
+    updateFileMetadataDTO: UpdateFileMetadataDTO,
+    sourceLastUpdateTime?: string
   ): Promise<void>
 
   updateFileTabularTags(

src/files/domain/useCases/UpdateFileMetadata.ts

@@ -15,12 +15,18 @@ export class UpdateFileMetadata 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 {UpdateFileMetadataDTO} [updateFileMetadataDTO] - The DTO containing the metadata updates.
+   * @param {string} [sourceLastUpdateTime] - The lastUpdateTime value from the file. If another user updates the file metadata before you send the update request, data inconsistencies may occur. To prevent this, you can use the optional sourceLastUpdateTime parameter. This parameter must include the lastUpdateTime value corresponding to the file being updated.
    * @returns {Promise<void>}
    */
   async execute(
     fileId: number | string,
-    updateFileMetadataDTO: UpdateFileMetadataDTO
+    updateFileMetadataDTO: UpdateFileMetadataDTO,
+    sourceLastUpdateTime?: string
   ): Promise<void> {
-    await this.filesRepository.updateFileMetadata(fileId, updateFileMetadataDTO)
+    await this.filesRepository.updateFileMetadata(
+      fileId,
+      updateFileMetadataDTO,
+      sourceLastUpdateTime
+    )
   }
 }

src/files/infra/repositories/FilesRepository.ts

@@ -369,15 +369,18 @@ export class FilesRepository extends ApiRepository implements IFilesRepository {
 
   public async updateFileMetadata(
     fileId: string | number,
-    updateFileMetadata: UpdateFileMetadataDTO
+    updateFileMetadata: UpdateFileMetadataDTO,
+    sourceLastUpdateTime?: string
   ): Promise<void> {
     const formData = new FormData()
     formData.append('jsonData', JSON.stringify(updateFileMetadata))
 
     return this.doPost(
       this.buildApiEndpoint(this.filesResourceName, `${fileId}/metadata`),
       formData,
-      {},
+      {
+        ...(sourceLastUpdateTime && { sourceLastUpdateTime })
+      },
       ApiConstants.CONTENT_TYPE_MULTIPART_FORM_DATA
     )
       .then(() => undefined)

src/files/infra/repositories/transformers/FilePayload.ts

@@ -29,6 +29,7 @@ export interface FilePayload {
     tabularTags?: string[]
     creationDate?: string
     publicationDate?: string
+    lastUpdateTime: string
     deleted: boolean
     tabularData: boolean
     fileAccessRequest?: boolean

src/files/infra/repositories/transformers/fileTransformers.ts

@@ -93,7 +93,8 @@ const transformFilePayloadToFile = (filePayload: FilePayload): FileModel => {
     }),
     ...(filePayload.dataFile.isPartOf && {
       isPartOf: transformPayloadToOwnerNode(filePayload.dataFile.isPartOf)
-    })
+    }),
+    lastUpdateTime: filePayload.dataFile.lastUpdateTime
   }
 }
 

test/integration/files/FilesRepository.test.ts

@@ -767,6 +767,61 @@ describe('FilesRepository', () => {
         errorExpected
       )
     })
+
+    test('should throw error when using outdated sourceLastUpdateTime', async () => {
+      const newDatasetIds = await createDataset.execute(TestConstants.TEST_NEW_DATASET_DTO)
+      await uploadFileViaApi(newDatasetIds.numericId, testTextFile1Name)
+      const filesSubset = await sut.getDatasetFiles(
+        newDatasetIds.numericId,
+        latestDatasetVersionId,
+        false,
+        FileOrderCriteria.NAME_AZ
+      )
+      const fileId = filesSubset.files[0].id
+
+      await registerFileViaApi(fileId)
+
+      // Fetch file to obtain initial lastUpdateTime from returned model including dataset version
+      const fileInfo: FileModel = (await sut.getFile(
+        fileId,
+        DatasetNotNumberedVersion.LATEST,
+        false,
+        false
+      )) as FileModel
+
+      const lastUpdateTimeOne = fileInfo.lastUpdateTime
+
+      // Wait for 2 seconds
+      await new Promise((resolve) => setTimeout(resolve, 2_000))
+
+      // First update using correct lastUpdateTime should succeed
+      await sut.updateFileMetadata(fileId, { description: 'First update desc.' }, lastUpdateTimeOne)
+
+      // Refetch to get new lastUpdateTime
+      const fileInfoAfterFirstUpdate: FileModel = (await sut.getFile(
+        fileId,
+        DatasetNotNumberedVersion.LATEST,
+        false,
+        false
+      )) as FileModel
+
+      const lastUpdateTimeTwo = fileInfoAfterFirstUpdate.lastUpdateTime
+
+      expect(lastUpdateTimeTwo).not.toBe(lastUpdateTimeOne)
+
+      // Wait for 2 seconds
+      await new Promise((resolve) => setTimeout(resolve, 2_000))
+
+      // Second update using stale lastUpdateTimeOne should fail
+      const expectedError = new WriteError(
+        `[400] Internal version timestamp ${lastUpdateTimeOne} is outdated`
+      )
+      await expect(
+        sut.updateFileMetadata(fileId, { description: 'Second update attempt.' }, lastUpdateTimeOne)
+      ).rejects.toThrow(expectedError)
+
+      await deletePublishedDatasetViaApi(newDatasetIds.persistentId)
+    })
   })
 
   describe('updateFileTabularTags', () => {

test/testHelpers/files/filesHelper.ts

@@ -60,7 +60,8 @@ export const createFileModel = (): FileModel => {
     originalSize: 127426,
     originalName: 'originalName',
     tabularTags: ['tag1', 'tag2'],
-    publicationDate: '2023-07-11'
+    publicationDate: '2023-07-11',
+    lastUpdateTime: '2023-07-11'
   }
 }
 
@@ -122,7 +123,8 @@ export const createFilePayload = (): FilePayload => {
       originalSize: 127426,
       originalName: 'originalName',
       tabularTags: ['tag1', 'tag2'],
-      publicationDate: '2023-07-11'
+      publicationDate: '2023-07-11',
+      lastUpdateTime: '2023-07-11'
     }
   }
 }