Merge pull request #196 from IQSS/feature/172-integration-add-filecri…

…teria-to-the-getfilescountinfo-use-case

172 - Integration add FileCriteria to the getFilesCountInfo use case

package.json

@@ -13,7 +13,7 @@
   },
   "dependencies": {
     "@faker-js/faker": "7.6.0",
-    "@iqss/dataverse-client-javascript": "2.0.0-pr92.3fbf381",
+    "@iqss/dataverse-client-javascript": "2.0.0-pr93.8996380",
     "@iqss/dataverse-design-system": "*",
     "@istanbuljs/nyc-config-typescript": "1.0.2",
     "@tanstack/react-table": "8.9.2",

src/files/domain/repositories/FileRepository.ts

@@ -14,7 +14,8 @@ export interface FileRepository {
   ) => Promise<File[]>
   getFilesCountInfoByDatasetPersistentId: (
     datasetPersistentId: string,
-    datasetVersion: DatasetVersion
+    datasetVersion: DatasetVersion,
+    criteria: FileCriteria
   ) => Promise<FilesCountInfo>
   getFilesTotalDownloadSizeByDatasetPersistentId: (
     datasetPersistentId: string,

src/files/domain/useCases/getFilesCountInfoByDatasetPersistentId.ts

@@ -1,14 +1,16 @@
 import { FileRepository } from '../repositories/FileRepository'
 import { FilesCountInfo } from '../models/FilesCountInfo'
 import { DatasetVersion } from '../../../dataset/domain/models/Dataset'
+import { FileCriteria } from '../models/FileCriteria'
 
 export async function getFilesCountInfoByDatasetPersistentId(
   fileRepository: FileRepository,
   datasetPersistentId: string,
-  datasetVersion: DatasetVersion
+  datasetVersion: DatasetVersion,
+  criteria: FileCriteria = new FileCriteria()
 ): Promise<FilesCountInfo> {
   return fileRepository
-    .getFilesCountInfoByDatasetPersistentId(datasetPersistentId, datasetVersion)
+    .getFilesCountInfoByDatasetPersistentId(datasetPersistentId, datasetVersion, criteria)
     .catch((error: Error) => {
       throw new Error(error.message)
     })

src/files/infrastructure/FileJSDataverseRepository.ts

@@ -38,7 +38,8 @@ export class FileJSDataverseRepository implements FileRepository {
         includeDeaccessioned,
         jsPagination.limit,
         jsPagination.offset,
-        DomainFileMapper.toJSFileCriteria(criteria)
+        DomainFileMapper.toJSFileSearchCriteria(criteria),
+        DomainFileMapper.toJSFileOrderCriteria(criteria.sortBy)
       )
       .then((jsFiles) => jsFiles.map((jsFile) => JSFileMapper.toFile(jsFile, datasetVersion)))
       .then((files) => FileJSDataverseRepository.getAllWithDownloadCount(files))
@@ -100,11 +101,16 @@ export class FileJSDataverseRepository implements FileRepository {
 
   getFilesCountInfoByDatasetPersistentId(
     datasetPersistentId: string,
-    datasetVersion: DatasetVersion
+    datasetVersion: DatasetVersion,
+    criteria: FileCriteria
   ): Promise<FilesCountInfo> {
-    // TODO - Take into account the FileCriteria https://github.com/IQSS/dataverse-frontend/issues/172
     return getDatasetFileCounts
-      .execute(datasetPersistentId, datasetVersion.toString(), includeDeaccessioned)
+      .execute(
+        datasetPersistentId,
+        datasetVersion.toString(),
+        includeDeaccessioned,
+        DomainFileMapper.toJSFileSearchCriteria(criteria)
+      )
       .then((jsFilesCountInfo) => {
         return JSFileMapper.toFilesCountInfo(jsFilesCountInfo)
       })

src/files/infrastructure/mappers/DomainFileMapper.ts

@@ -7,7 +7,7 @@ import {
 } from '../../domain/models/FileCriteria'
 import {
   FileAccessStatus as JSFileAccessStatus,
-  FileCriteria as JSFileCriteria,
+  FileSearchCriteria as JSFileSearchCriteria,
   FileOrderCriteria as JSFileOrderCriteria
 } from '@iqss/dataverse-client-javascript'
 import { FileType } from '../../domain/models/File'
@@ -20,17 +20,17 @@ export class DomainFileMapper {
     }
   }
 
-  static toJSFileCriteria(criteria: FileCriteria): JSFileCriteria {
-    return new JSFileCriteria(
-      this.toJSOrderCriteria(criteria.sortBy),
+  static toJSFileSearchCriteria(criteria: FileCriteria): JSFileSearchCriteria {
+    return new JSFileSearchCriteria(
       this.toJSContentType(criteria.filterByType),
       this.toJSAccessStatus(criteria.filterByAccess),
       this.toJSCategoryName(criteria.filterByTag),
+      undefined, // This filter is not used in the UI
       this.toJSSearchText(criteria.searchText)
     )
   }
 
-  static toJSOrderCriteria(sortBy: FileSortByOption): JSFileOrderCriteria {
+  static toJSFileOrderCriteria(sortBy: FileSortByOption): JSFileOrderCriteria {
     switch (sortBy) {
       case FileSortByOption.NAME_AZ:
         return JSFileOrderCriteria.NAME_AZ

src/sections/dataset/dataset-files/useFiles.tsx

@@ -24,48 +24,68 @@ export function useFiles(
   const [isLoading, setIsLoading] = useState<boolean>(true)
   const [filesCountInfo, setFilesCountInfo] = useState<FilesCountInfo>()
   const [filesTotalDownloadSize, setFilesTotalDownloadSize] = useState<number>(0)
-
-  useEffect(() => {
-    getFilesCountInfoByDatasetPersistentId(filesRepository, datasetPersistentId, datasetVersion)
+  const getFilesCountInfo = () => {
+    return getFilesCountInfoByDatasetPersistentId(
+      filesRepository,
+      datasetPersistentId,
+      datasetVersion,
+      criteria
+    )
       .then((filesCountInfo: FilesCountInfo) => {
         setFilesCountInfo(filesCountInfo)
-        onPaginationInfoChange(paginationInfo.withTotal(filesCountInfo.total))
+        if (filesCountInfo.total !== paginationInfo.totalFiles) {
+          onPaginationInfoChange(paginationInfo.withTotal(filesCountInfo.total))
+        }
+        return filesCountInfo
       })
-      .catch((error) => {
-        console.error('There was an error getting the files count info', error)
+      .catch(() => {
+        throw new Error('There was an error getting the files count info')
       })
-  }, [filesRepository, datasetPersistentId, datasetVersion])
+  }
+
+  const getFiles = (filesCount: FilesCountInfo) => {
+    if (filesCount) {
+      if (filesCount.total === 0) {
+        setIsLoading(false)
+        return
+      }
+      return getFilesByDatasetPersistentId(
+        filesRepository,
+        datasetPersistentId,
+        datasetVersion,
+        paginationInfo.withTotal(filesCount.total),
+        criteria
+      )
+        .then((files: File[]) => {
+          setFiles(files)
+          return files
+        })
+        .then((files: File[]) =>
+          fetchFilesPermission(FilePermission.DOWNLOAD_FILE, files).then(() => setIsLoading(false))
+        )
+        .catch(() => {
+          throw new Error('There was an error getting the files')
+        })
+    }
+  }
 
   useEffect(() => {
     setIsLoading(true)
 
-    if (filesCountInfo) {
-      if (filesCountInfo.total === 0) {
+    getFilesCountInfo()
+      .then((filesCount) => getFiles(filesCount))
+      .catch(() => {
+        console.error('There was an error getting the files')
         setIsLoading(false)
-      } else {
-        getFilesByDatasetPersistentId(
-          filesRepository,
-          datasetPersistentId,
-          datasetVersion,
-          paginationInfo,
-          criteria
-        )
-          .then((files: File[]) => {
-            setFiles(files)
-            return files
-          })
-          .then((files: File[]) =>
-            fetchFilesPermission(FilePermission.DOWNLOAD_FILE, files).then(() =>
-              setIsLoading(false)
-            )
-          )
-          .catch((error) => {
-            console.error('There was an error getting the files', error)
-            setIsLoading(false)
-          })
-      }
-    }
-  }, [filesRepository, datasetPersistentId, datasetVersion, paginationInfo, criteria])
+      })
+  }, [
+    filesRepository,
+    datasetPersistentId,
+    datasetVersion,
+    paginationInfo.page,
+    paginationInfo.pageSize,
+    criteria
+  ])
 
   useEffect(() => {
     getFilesTotalDownloadSize(filesRepository, datasetPersistentId, datasetVersion)

src/stories/files/FileMockLoadingRepository.ts

@@ -4,6 +4,7 @@ import { FilesCountInfo } from '../../files/domain/models/FilesCountInfo'
 import { FileUserPermissions } from '../../files/domain/models/FileUserPermissions'
 import { FileUserPermissionsMother } from '../../../tests/component/files/domain/models/FileUserPermissionsMother'
 import { DatasetVersion } from '../../dataset/domain/models/Dataset'
+import { FileCriteria } from '../../files/domain/models/FileCriteria'
 
 export class FileMockLoadingRepository implements FileRepository {
   getAllByDatasetPersistentId(
@@ -23,7 +24,9 @@ export class FileMockLoadingRepository implements FileRepository {
     // eslint-disable-next-line unused-imports/no-unused-vars
     datasetPersistentId: string,
     // eslint-disable-next-line unused-imports/no-unused-vars
-    datasetVersion: DatasetVersion
+    datasetVersion: DatasetVersion,
+    // eslint-disable-next-line unused-imports/no-unused-vars
+    criteria: FileCriteria
   ): Promise<FilesCountInfo> {
     return new Promise(() => {
       setTimeout(() => {

src/stories/files/FileMockNoFiltersRepository.ts

@@ -6,6 +6,7 @@ import { FilesMockData } from './FileMockData'
 import { FileUserPermissions } from '../../files/domain/models/FileUserPermissions'
 import { FileUserPermissionsMother } from '../../../tests/component/files/domain/models/FileUserPermissionsMother'
 import { DatasetVersion } from '../../dataset/domain/models/Dataset'
+import { FileCriteria } from '../../files/domain/models/FileCriteria'
 
 export class FileMockNoFiltersRepository implements FileRepository {
   getAllByDatasetPersistentId(
@@ -25,7 +26,9 @@ export class FileMockNoFiltersRepository implements FileRepository {
     // eslint-disable-next-line unused-imports/no-unused-vars
     datasetPersistentId: string,
     // eslint-disable-next-line unused-imports/no-unused-vars
-    datasetVersion: DatasetVersion
+    datasetVersion: DatasetVersion,
+    // eslint-disable-next-line unused-imports/no-unused-vars
+    criteria: FileCriteria
   ): Promise<FilesCountInfo> {
     return new Promise((resolve) => {
       setTimeout(() => {