feat: update restrict extension testcases

Author: ChengShi-1

docs/useCases.md

@@ -1420,8 +1420,8 @@ import { restrictFile } from '@iqss/dataverse-client-javascript'
 const fileId = 12345
 const restrictFileDTO = {
   restrict: true,
-  enableAccessRequest: boolean,
-  termsOfAccess: string
+  enableAccessRequest: false,
+  termsOfAccess: 'terms of access'
 }
 
 restrictFile.execute(fileId, restrictFileDTO)

src/files/domain/repositories/IFilesRepository.ts

@@ -66,7 +66,7 @@ export interface IFilesRepository {
 
   replaceFile(fileId: number | string, uploadedFileDTO: UploadedFileDTO): Promise<number>
 
-  restrictFile(fileId: number | string, restrictFileDTO: RestrictFileDTO): Promise<string>
+  restrictFile(fileId: number | string, restrictFileDTO: RestrictFileDTO): Promise<void>
 
   updateFileMetadata(
     fileId: number | string,

src/files/domain/useCases/RestrictFile.ts

@@ -1,8 +1,8 @@
 import { IFilesRepository } from '../repositories/IFilesRepository'
 import { UseCase } from '../../../core/domain/useCases/UseCase'
 import { RestrictFileDTO } from '../dtos/RestrictFileDTO'
-// https://github.com/IQSS/dataverse/pull/11349/files
-export class RestrictFile implements UseCase<string> {
+
+export class RestrictFile implements UseCase<void> {
   constructor(private readonly filesRepository: IFilesRepository) {}
 
   /**
@@ -14,7 +14,7 @@ export class RestrictFile implements UseCase<string> {
    * @returns {Promise<void>} -This method does not return anything upon successful completion.
    */
 
-  async execute(fileId: number | string, restrictFileDTO: RestrictFileDTO): Promise<string> {
+  async execute(fileId: number | string, restrictFileDTO: RestrictFileDTO): Promise<void> {
     return await this.filesRepository.restrictFile(fileId, restrictFileDTO)
   }
 }

src/files/infra/repositories/FilesRepository.ts

@@ -350,13 +350,12 @@ export class FilesRepository extends ApiRepository implements IFilesRepository {
   public async restrictFile(
     fileId: number | string,
     restrictFileDTO: RestrictFileDTO
-  ): Promise<string> {
+  ): Promise<void> {
     return this.doPut(
       this.buildApiEndpoint(this.filesResourceName, 'restrict', fileId),
       restrictFileDTO
     )
       .then((response) => {
-        console.log('test', response.data.data.message)
         return response.data.data.message
       })
       .catch((error) => {

test/functional/files/RestrictFile.test.ts

@@ -4,7 +4,8 @@ import {
   CreatedDatasetIdentifiers,
   restrictFile,
   getDatasetFiles,
-  WriteError
+  WriteError,
+  getDataset
 } from '../../../src'
 import { DataverseApiAuthMechanism } from '../../../src/core/infra/repositories/ApiConfig'
 import {
@@ -69,6 +70,32 @@ describe('execute', () => {
     }
   })
 
+  test('should successfully restrict a file with terms of use', async () => {
+    try {
+      const datasetFiles = await getDatasetFiles.execute(testDatasetIds.numericId)
+
+      await restrictFile.execute(datasetFiles.files[0].id, {
+        restrict: true,
+        enableAccessRequest: false,
+        termsOfAccess: 'This file is restricted for testing purposes'
+      })
+    } catch (error) {
+      throw new Error('File should be restricted')
+    } finally {
+      const datasetFilesAfterRestriction = await getDatasetFiles.execute(testDatasetIds.numericId)
+
+      expect(datasetFilesAfterRestriction.files[0].restricted).toEqual(true)
+
+      const dataset = await getDataset.execute(testDatasetIds.numericId)
+
+      expect(dataset.termsOfUse.termsOfAccess.termsOfAccessForRestrictedFiles).toEqual(
+        'This file is restricted for testing purposes'
+      )
+
+      await restrictFile.execute(datasetFilesAfterRestriction.files[0].id, { restrict: false })
+    }
+  })
+
   test('should succesfully unrestrict a file', async () => {
     try {
       const datasetFiles = await getDatasetFiles.execute(testDatasetIds.numericId)
@@ -124,7 +151,8 @@ describe('execute', () => {
 
     expect(caughtError).toBeInstanceOf(WriteError)
     expect((caughtError as WriteError).message).toEqual(
-      'There was an error when writing the resource. Reason was: [409] Terms of Use and Access are invalid. You must enable request access or add terms of access in datasets with restricted files.'
+      new WriteError().message +
+        ' Reason was: [409] Terms of Use and Access are invalid. You must enable request access or add terms of access in datasets with restricted files.'
     )
   })
 })

test/integration/files/FilesRepository.test.ts

@@ -901,5 +901,25 @@ describe('FilesRepository', () => {
 
       await expect(setFileToRestricted(nonExistentFiledId)).rejects.toThrow(expectedError)
     })
+
+    test('should return error when the terms of use is empty while enableAccess is false', async () => {
+      const datasetFiles = await sut.getDatasetFiles(
+        restrictFileDatasetIds.numericId,
+        DatasetNotNumberedVersion.LATEST,
+        false,
+        FileOrderCriteria.NAME_AZ
+      )
+
+      const errorExpected = new WriteError(
+        `[409] Terms of Use and Access are invalid. You must enable request access or add terms of access in datasets with restricted files.`
+      )
+
+      await expect(
+        sut.restrictFile(datasetFiles.files[0].id, {
+          restrict: true,
+          enableAccessRequest: false
+        })
+      ).rejects.toThrow(errorExpected)
+    })
   })
 })