Merge pull request #91 from IQSS/85-files-use-cases-extension

Update GetDatasetFiles and GetDatasetFileCounts use cases with the latest API changes

src/files/domain/models/File.ts

@@ -12,6 +12,7 @@ export interface File {
   datasetVersionId?: number;
   categories?: string[];
   contentType: string;
+  friendlyType: string;
   embargo?: FileEmbargo;
   storageIdentifier?: string;
   originalFormat?: string;
@@ -27,6 +28,9 @@ export interface File {
   tabularTags?: string[];
   creationDate?: Date;
   publicationDate?: Date;
+  deleted: boolean;
+  tabularData: boolean;
+  fileAccessRequest?: boolean;
 }
 
 export interface FileEmbargo {

src/files/domain/repositories/IFilesRepository.ts

@@ -8,12 +8,17 @@ export interface IFilesRepository {
   getDatasetFiles(
     datasetId: number | string,
     datasetVersionId: string,
+    includeDeaccessioned: boolean,
     limit?: number,
     offset?: number,
     fileCriteria?: FileCriteria,
   ): Promise<File[]>;
 
-  getDatasetFileCounts(datasetId: number | string, datasetVersionId: string): Promise<FileCounts>;
+  getDatasetFileCounts(
+    datasetId: number | string,
+    datasetVersionId: string,
+    includeDeaccessioned: boolean,
+  ): Promise<FileCounts>;
 
   getFileDownloadCount(fileId: number | string): Promise<number>;
 

src/files/domain/useCases/GetDatasetFileCounts.ts

@@ -13,7 +13,8 @@ export class GetDatasetFileCounts implements UseCase<FileCounts> {
   async execute(
     datasetId: number | string,
     datasetVersionId: string | DatasetNotNumberedVersion = DatasetNotNumberedVersion.LATEST,
+    includeDeaccessioned: boolean = false,
   ): Promise<FileCounts> {
-    return await this.filesRepository.getDatasetFileCounts(datasetId, datasetVersionId);
+    return await this.filesRepository.getDatasetFileCounts(datasetId, datasetVersionId, includeDeaccessioned);
   }
 }

src/files/domain/useCases/GetDatasetFiles.ts

@@ -14,10 +14,18 @@ export class GetDatasetFiles implements UseCase<File[]> {
   async execute(
     datasetId: number | string,
     datasetVersionId: string | DatasetNotNumberedVersion = DatasetNotNumberedVersion.LATEST,
+    includeDeaccessioned: boolean = false,
     limit?: number,
     offset?: number,
     fileCriteria?: FileCriteria,
   ): Promise<File[]> {
-    return await this.filesRepository.getDatasetFiles(datasetId, datasetVersionId, limit, offset, fileCriteria);
+    return await this.filesRepository.getDatasetFiles(
+      datasetId,
+      datasetVersionId,
+      includeDeaccessioned,
+      limit,
+      offset,
+      fileCriteria,
+    );
   }
 }

src/files/infra/repositories/FilesRepository.ts

@@ -11,6 +11,7 @@ import { FileCounts } from '../../domain/models/FileCounts';
 import { transformFileCountsResponseToFileCounts } from './transformers/fileCountsTransformers';
 
 export interface GetFilesQueryParams {
+  includeDeaccessioned: boolean;
   limit?: number;
   offset?: number;
   orderCriteria?: string;
@@ -28,11 +29,14 @@ export class FilesRepository extends ApiRepository implements IFilesRepository {
   public async getDatasetFiles(
     datasetId: number | string,
     datasetVersionId: string,
+    includeDeaccessioned: boolean,
     limit?: number,
     offset?: number,
     fileCriteria?: FileCriteria,
   ): Promise<File[]> {
-    const queryParams: GetFilesQueryParams = {};
+    const queryParams: GetFilesQueryParams = {
+      includeDeaccessioned: includeDeaccessioned,
+    };
     if (limit !== undefined) {
       queryParams.limit = limit;
     }
@@ -53,10 +57,17 @@ export class FilesRepository extends ApiRepository implements IFilesRepository {
       });
   }
 
-  public async getDatasetFileCounts(datasetId: string | number, datasetVersionId: string): Promise<FileCounts> {
+  public async getDatasetFileCounts(
+    datasetId: string | number,
+    datasetVersionId: string,
+    includeDeaccessioned: boolean,
+  ): Promise<FileCounts> {
     return this.doGet(
       this.buildApiEndpoint(this.datasetsResourceName, `versions/${datasetVersionId}/files/counts`, datasetId),
       true,
+      {
+        includeDeaccessioned: includeDeaccessioned,
+      },
     )
       .then((response) => transformFileCountsResponseToFileCounts(response))
       .catch((error) => {

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

@@ -27,6 +27,7 @@ const transformFilePayloadToFile = (filePayload: any): File => {
     ...(filePayload.dataFile.datasetVersionId && { datasetVersionId: filePayload.dataFile.datasetVersionId }),
     ...(filePayload.dataFile.categories && { categories: filePayload.dataFile.categories }),
     contentType: filePayload.dataFile.contentType,
+    friendlyType: filePayload.dataFile.friendlyType,
     ...(filePayload.dataFile.embargo && { embargo: transformEmbargoPayloadToEmbargo(filePayload.dataFile.embargo) }),
     ...(filePayload.dataFile.storageIdentifier && { storageIdentifier: filePayload.dataFile.storageIdentifier }),
     ...(filePayload.dataFile.originalFormat && { originalFormat: filePayload.dataFile.originalFormat }),
@@ -44,6 +45,9 @@ const transformFilePayloadToFile = (filePayload: any): File => {
     ...(filePayload.dataFile.tabularTags && { tabularTags: filePayload.dataFile.tabularTags }),
     ...(filePayload.dataFile.creationDate && { creationDate: new Date(filePayload.dataFile.creationDate) }),
     ...(filePayload.dataFile.publicationDate && { publicationDate: new Date(filePayload.dataFile.publicationDate) }),
+    deleted: filePayload.dataFile.deleted,
+    tabularData: filePayload.dataFile.tabularData,
+    ...(filePayload.dataFile.fileAccessRequest && { fileAccessRequest: filePayload.dataFile.fileAccessRequest }),
   };
 };
 

test/integration/environment/.env

@@ -2,5 +2,5 @@ POSTGRES_VERSION=13
 DATAVERSE_DB_USER=dataverse
 SOLR_VERSION=8.11.1
 DATAVERSE_IMAGE_REGISTRY=ghcr.io
-DATAVERSE_IMAGE_TAG=9834-files-api-extension-file-counts
+DATAVERSE_IMAGE_TAG=9852-files-api-deaccessioned-datasets
 DATAVERSE_BOOTSTRAP_TIMEOUT=5m

test/integration/files/FilesRepository.test.ts

@@ -62,7 +62,11 @@ describe('FilesRepository', () => {
         fail(`Tests beforeAll(): Error while uploading file ${testTabFile4Name}`);
       });
     // Categorize one of the uploaded test files
-    const currentTestFiles = await sut.getDatasetFiles(TestConstants.TEST_CREATED_DATASET_ID, latestDatasetVersionId);
+    const currentTestFiles = await sut.getDatasetFiles(
+      TestConstants.TEST_CREATED_DATASET_ID,
+      latestDatasetVersionId,
+      false,
+    );
     const testFile = currentTestFiles[0];
     setFileCategoriesViaApi(testFile.id, [testCategoryName])
       .then()
@@ -80,7 +84,7 @@ describe('FilesRepository', () => {
 
     describe('by numeric id', () => {
       test('should return all files filtering by dataset id and version id', async () => {
-        const actual = await sut.getDatasetFiles(TestConstants.TEST_CREATED_DATASET_ID, latestDatasetVersionId);
+        const actual = await sut.getDatasetFiles(TestConstants.TEST_CREATED_DATASET_ID, latestDatasetVersionId, false);
         assert.match(actual.length, 4);
         assert.match(actual[0].name, testTextFile1Name);
         assert.match(actual[1].name, testTextFile2Name);
@@ -92,6 +96,7 @@ describe('FilesRepository', () => {
         const actual = await sut.getDatasetFiles(
           TestConstants.TEST_CREATED_DATASET_ID,
           latestDatasetVersionId,
+          false,
           3,
           3,
           undefined,
@@ -104,6 +109,7 @@ describe('FilesRepository', () => {
         let actual = await sut.getDatasetFiles(
           TestConstants.TEST_CREATED_DATASET_ID,
           latestDatasetVersionId,
+          false,
           undefined,
           undefined,
           testFileCriteria,
@@ -118,7 +124,7 @@ describe('FilesRepository', () => {
         let error: ReadError = undefined;
 
         const nonExistentTestDatasetId = 100;
-        await sut.getDatasetFiles(nonExistentTestDatasetId, latestDatasetVersionId).catch((e) => (error = e));
+        await sut.getDatasetFiles(nonExistentTestDatasetId, latestDatasetVersionId, false).catch((e) => (error = e));
 
         assert.match(
           error.message,
@@ -133,7 +139,7 @@ describe('FilesRepository', () => {
           TestConstants.TEST_CREATED_DATASET_ID,
           latestDatasetVersionId,
         );
-        const actual = await sut.getDatasetFiles(testDataset.persistentId, latestDatasetVersionId);
+        const actual = await sut.getDatasetFiles(testDataset.persistentId, latestDatasetVersionId, false);
         assert.match(actual.length, 4);
         assert.match(actual[0].name, testTextFile1Name);
         assert.match(actual[1].name, testTextFile2Name);
@@ -146,7 +152,14 @@ describe('FilesRepository', () => {
           TestConstants.TEST_CREATED_DATASET_ID,
           latestDatasetVersionId,
         );
-        const actual = await sut.getDatasetFiles(testDataset.persistentId, latestDatasetVersionId, 3, 3, undefined);
+        const actual = await sut.getDatasetFiles(
+          testDataset.persistentId,
+          latestDatasetVersionId,
+          false,
+          3,
+          3,
+          undefined,
+        );
         assert.match(actual.length, 1);
         assert.match(actual[0].name, testTabFile4Name);
       });
@@ -159,6 +172,7 @@ describe('FilesRepository', () => {
         let actual = await sut.getDatasetFiles(
           testDataset.persistentId,
           latestDatasetVersionId,
+          false,
           undefined,
           undefined,
           testFileCriteria,
@@ -173,7 +187,7 @@ describe('FilesRepository', () => {
         let error: ReadError = undefined;
 
         const testWrongPersistentId = 'wrongPersistentId';
-        await sut.getDatasetFiles(testWrongPersistentId, latestDatasetVersionId).catch((e) => (error = e));
+        await sut.getDatasetFiles(testWrongPersistentId, latestDatasetVersionId, false).catch((e) => (error = e));
 
         assert.match(
           error.message,
@@ -211,7 +225,11 @@ describe('FilesRepository', () => {
     };
 
     test('should return file count filtering by numeric id', async () => {
-      const actual = await sut.getDatasetFileCounts(TestConstants.TEST_CREATED_DATASET_ID, latestDatasetVersionId);
+      const actual = await sut.getDatasetFileCounts(
+        TestConstants.TEST_CREATED_DATASET_ID,
+        latestDatasetVersionId,
+        false,
+      );
       assert.match(actual.total, expectedFileCounts.total);
       expect(actual.perContentType).to.have.deep.members(expectedFileCounts.perContentType);
       expect(actual.perAccessStatus).to.have.deep.members(expectedFileCounts.perAccessStatus);
@@ -223,7 +241,7 @@ describe('FilesRepository', () => {
         TestConstants.TEST_CREATED_DATASET_ID,
         latestDatasetVersionId,
       );
-      const actual = await sut.getDatasetFileCounts(testDataset.persistentId, latestDatasetVersionId);
+      const actual = await sut.getDatasetFileCounts(testDataset.persistentId, latestDatasetVersionId, false);
       assert.match(actual.total, expectedFileCounts.total);
       expect(actual.perContentType).to.have.deep.members(expectedFileCounts.perContentType);
       expect(actual.perAccessStatus).to.have.deep.members(expectedFileCounts.perAccessStatus);
@@ -233,7 +251,11 @@ describe('FilesRepository', () => {
 
   describe('getFileDownloadCount', () => {
     test('should return count filtering by file id and version id', async () => {
-      const currentTestFiles = await sut.getDatasetFiles(TestConstants.TEST_CREATED_DATASET_ID, latestDatasetVersionId);
+      const currentTestFiles = await sut.getDatasetFiles(
+        TestConstants.TEST_CREATED_DATASET_ID,
+        latestDatasetVersionId,
+        false,
+      );
       const testFile = currentTestFiles[0];
       const actual = await sut.getFileDownloadCount(testFile.id);
       assert.match(actual, 0);
@@ -253,7 +275,11 @@ describe('FilesRepository', () => {
 
   describe('getFileUserPermissions', () => {
     test('should return user permissions filtering by file id and version id', async () => {
-      const currentTestFiles = await sut.getDatasetFiles(TestConstants.TEST_CREATED_DATASET_ID, latestDatasetVersionId);
+      const currentTestFiles = await sut.getDatasetFiles(
+        TestConstants.TEST_CREATED_DATASET_ID,
+        latestDatasetVersionId,
+        false,
+      );
       const testFile = currentTestFiles[0];
       const actual = await sut.getFileUserPermissions(testFile.id);
       assert.match(actual.canDownloadFile, true);
@@ -274,14 +300,22 @@ describe('FilesRepository', () => {
 
   describe('getFileDataTables', () => {
     test('should return data tables filtering by tabular file id and version id', async () => {
-      const currentTestFiles = await sut.getDatasetFiles(TestConstants.TEST_CREATED_DATASET_ID, latestDatasetVersionId);
+      const currentTestFiles = await sut.getDatasetFiles(
+        TestConstants.TEST_CREATED_DATASET_ID,
+        latestDatasetVersionId,
+        false,
+      );
       const testFile = currentTestFiles[3];
       const actual = await sut.getFileDataTables(testFile.id);
       assert.match(actual[0].varQuantity, 3);
     });
 
     test('should return error when file is not tabular and version id', async () => {
-      const currentTestFiles = await sut.getDatasetFiles(TestConstants.TEST_CREATED_DATASET_ID, latestDatasetVersionId);
+      const currentTestFiles = await sut.getDatasetFiles(
+        TestConstants.TEST_CREATED_DATASET_ID,
+        latestDatasetVersionId,
+        false,
+      );
       const testFile = currentTestFiles[0];
 
       let error: ReadError = undefined;
@@ -301,7 +335,7 @@ describe('FilesRepository', () => {
 
       assert.match(
         error.message,
-        `There was an error when reading the resource. Reason was: [404] File with ID ${nonExistentFiledId} not found.`,
+        `There was an error when reading the resource. Reason was: [404] File not found for given id.`,
       );
     });
   });

test/testHelpers/files/filesHelper.ts

@@ -13,6 +13,7 @@ export const createFileModel = (): File => {
     restricted: false,
     latestRestricted: false,
     contentType: 'image/png',
+    friendlyType: 'PNG Image',
     storageIdentifier: 'local://18945a85439-9fa52783e5cb',
     rootDataFileId: 4,
     previousDataFileId: 4,
@@ -27,6 +28,9 @@ export const createFileModel = (): File => {
       type: 'MD5',
       value: '29e413e0c881e17314ce8116fed4d1a7',
     },
+    deleted: false,
+    tabularData: false,
+    fileAccessRequest: true,
   };
 };
 
@@ -41,6 +45,7 @@ export const createFilePayload = (): any => {
       persistentId: '',
       filename: 'test',
       contentType: 'image/png',
+      friendlyType: 'PNG Image',
       filesize: 127426,
       storageIdentifier: 'local://18945a85439-9fa52783e5cb',
       restricted: false,
@@ -58,6 +63,9 @@ export const createFilePayload = (): any => {
         type: 'MD5',
         value: '29e413e0c881e17314ce8116fed4d1a7',
       },
+      deleted: false,
+      tabularData: false,
+      fileAccessRequest: true,
     },
   };
 };