170 - Integration files total download size

package.json

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

src/files/domain/repositories/FileRepository.ts

@@ -16,5 +16,9 @@ export interface FileRepository {
     datasetPersistentId: string,
     datasetVersion: DatasetVersion
   ) => Promise<FilesCountInfo>
+  getFilesTotalDownloadSizeByDatasetPersistentId: (
+    datasetPersistentId: string,
+    datasetVersion: DatasetVersion
+  ) => Promise<number>
   getUserPermissionsById: (id: number) => Promise<FileUserPermissions>
 }

src/files/domain/useCases/getFilesTotalDownloadSize.ts

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

src/files/infrastructure/FileJSDataverseRepository.ts

@@ -4,8 +4,10 @@ import { FilesCountInfo } from '../domain/models/FilesCountInfo'
 import { FilePaginationInfo } from '../domain/models/FilePaginationInfo'
 import { FileUserPermissions } from '../domain/models/FileUserPermissions'
 import {
+  FileDownloadSizeMode,
   getDatasetFileCounts,
   getDatasetFiles,
+  getDatasetFilesTotalDownloadSize,
   getFileDownloadCount,
   getFileUserPermissions,
   WriteError
@@ -15,6 +17,8 @@ import { DomainFileMapper } from './mappers/DomainFileMapper'
 import { JSFileMapper } from './mappers/JSFileMapper'
 import { DatasetVersion } from '../../dataset/domain/models/Dataset'
 
+const includeDeaccessioned = true
+
 export class FileJSDataverseRepository implements FileRepository {
   getAllByDatasetPersistentId(
     datasetPersistentId: string,
@@ -28,6 +32,7 @@ export class FileJSDataverseRepository implements FileRepository {
       .execute(
         datasetPersistentId,
         datasetVersion.toString(),
+        includeDeaccessioned,
         jsPagination.limit,
         jsPagination.offset,
         DomainFileMapper.toJSFileCriteria(criteria)
@@ -68,7 +73,7 @@ export class FileJSDataverseRepository implements FileRepository {
   ): Promise<FilesCountInfo> {
     // TODO - Take into account the FileCriteria https://github.com/IQSS/dataverse-frontend/issues/172
     return getDatasetFileCounts
-      .execute(datasetPersistentId, datasetVersion.toString())
+      .execute(datasetPersistentId, datasetVersion.toString(), includeDeaccessioned)
       .then((jsFilesCountInfo) => {
         return JSFileMapper.toFilesCountInfo(jsFilesCountInfo)
       })
@@ -77,6 +82,17 @@ export class FileJSDataverseRepository implements FileRepository {
       })
   }
 
+  getFilesTotalDownloadSizeByDatasetPersistentId(
+    datasetPersistentId: string,
+    datasetVersion: DatasetVersion
+  ): Promise<number> {
+    return getDatasetFilesTotalDownloadSize
+      .execute(datasetPersistentId, datasetVersion.toString(), FileDownloadSizeMode.ARCHIVAL)
+      .catch((error: WriteError) => {
+        throw new Error(error.message)
+      })
+  }
+
   getUserPermissionsById(id: number): Promise<FileUserPermissions> {
     return getFileUserPermissions
       .execute(id)

src/files/infrastructure/mappers/JSFileMapper.ts

@@ -82,14 +82,14 @@ export class JSFileMapper {
   ): FileVersion {
     const fileVersion = { number: jsVersion, publishingStatus: FilePublishingStatus.DRAFT }
 
-    if (datasetVersion.publishingStatus === DatasetPublishingStatus.DEACCESSIONED) {
-      fileVersion.publishingStatus = FilePublishingStatus.DEACCESSIONED
-    }
-
     if (jsPublicationDate) {
       fileVersion.publishingStatus = FilePublishingStatus.RELEASED
     }
 
+    if (datasetVersion.publishingStatus === DatasetPublishingStatus.DEACCESSIONED) {
+      fileVersion.publishingStatus = FilePublishingStatus.DEACCESSIONED
+    }
+
     return fileVersion
   }
 

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

@@ -21,7 +21,7 @@ export function DatasetFiles({
 }: DatasetFilesProps) {
   const [paginationInfo, setPaginationInfo] = useState<FilePaginationInfo>(new FilePaginationInfo())
   const [criteria, setCriteria] = useState<FileCriteria>(new FileCriteria())
-  const { files, isLoading, filesCountInfo } = useFiles(
+  const { files, isLoading, filesCountInfo, filesTotalDownloadSize } = useFiles(
     filesRepository,
     datasetPersistentId,
     datasetVersion,
@@ -37,7 +37,13 @@ export function DatasetFiles({
         onCriteriaChange={setCriteria}
         filesCountInfo={filesCountInfo}
       />
-      <FilesTable files={files} isLoading={isLoading} paginationInfo={paginationInfo} />
+      <FilesTable
+        files={files}
+        isLoading={isLoading}
+        paginationInfo={paginationInfo}
+        filesTotalDownloadSize={filesTotalDownloadSize}
+        criteria={criteria}
+      />
       <FilesPagination
         page={paginationInfo.page}
         pageSize={paginationInfo.pageSize}

src/sections/dataset/dataset-files/files-table/FilesTable.tsx

@@ -7,18 +7,46 @@ import { RowSelectionMessage } from './row-selection/RowSelectionMessage'
 import { ZipDownloadLimitMessage } from './zip-download-limit-message/ZipDownloadLimitMessage'
 import { SpinnerSymbol } from './spinner-symbol/SpinnerSymbol'
 import { FilePaginationInfo } from '../../../../files/domain/models/FilePaginationInfo'
+import { useEffect, useState } from 'react'
+import { FileSelection } from './row-selection/useFileSelection'
+import { FileCriteria } from '../../../../files/domain/models/FileCriteria'
 
 interface FilesTableProps {
   files: File[]
   isLoading: boolean
   paginationInfo: FilePaginationInfo
+  filesTotalDownloadSize: number
+  criteria: FileCriteria
 }
 
-export function FilesTable({ files, isLoading, paginationInfo }: FilesTableProps) {
+export function FilesTable({
+  files,
+  isLoading,
+  paginationInfo,
+  filesTotalDownloadSize,
+  criteria
+}: FilesTableProps) {
   const { table, fileSelection, selectAllFiles, clearFileSelection } = useFilesTable(
     files,
     paginationInfo
   )
+  const [visitedPagination, setVisitedPagination] = useState<FilePaginationInfo>(paginationInfo)
+  const [visitedFiles, setVisitedFiles] = useState<FileSelection>({})
+
+  useEffect(() => {
+    if (visitedPagination.page == paginationInfo.page) {
+      setVisitedFiles((visitedFiles) => ({ ...visitedFiles, ...fileSelection }))
+    }
+    setVisitedPagination(paginationInfo)
+  }, [fileSelection])
+
+  const [previousCriteria, setPreviousCriteria] = useState<FileCriteria>(criteria)
+  useEffect(() => {
+    if (previousCriteria != criteria) {
+      clearFileSelection()
+    }
+    setPreviousCriteria(criteria)
+  })
 
   if (isLoading) {
     return <SpinnerSymbol />
@@ -31,7 +59,11 @@ export function FilesTable({ files, isLoading, paginationInfo }: FilesTableProps
         totalFilesCount={paginationInfo.totalFiles}
         clearRowSelection={clearFileSelection}
       />
-      <ZipDownloadLimitMessage fileSelection={fileSelection} />
+      <ZipDownloadLimitMessage
+        fileSelection={fileSelection}
+        visitedFiles={visitedFiles}
+        filesTotalDownloadSize={filesTotalDownloadSize}
+      />
       <Table>
         <FilesTableHeader headers={table.getHeaderGroups()} />
         <FilesTableBody rows={table.getRowModel().rows} />

src/sections/dataset/dataset-files/files-table/row-selection/useFileSelection.ts

@@ -60,7 +60,10 @@ export function useFileSelection(
   }
   const selectAllFiles = () => {
     setCurrentPageRowSelection(createRowSelection(paginationInfo.pageSize))
-    setFileSelection(createFileSelection(paginationInfo.totalFiles))
+
+    const totalFilesFileSelection = createFileSelection(paginationInfo.totalFiles)
+    const newFileSelection = { ...totalFilesFileSelection, ...fileSelection }
+    setFileSelection(newFileSelection)
   }
   const clearFileSelection = () => {
     setCurrentPageRowSelection({})
@@ -92,7 +95,7 @@ export function createRowSelection(numberOfRows: number) {
   return rowSelection
 }
 
-export function createFileSelection(numberOfRows: number) {
+export function createFileSelection(numberOfRows: number): FileSelection {
   const fileSelection: FileSelection = {}
 
   for (let i = 0; i < numberOfRows; i++) {

src/sections/dataset/dataset-files/files-table/zip-download-limit-message/ZipDownloadLimitMessage.tsx

@@ -1,6 +1,6 @@
 import { useTranslation } from 'react-i18next'
 import styles from './ZipLimitMessage.module.scss'
-import { File, FileSizeUnit } from '../../../../../files/domain/models/File'
+import { FileSizeUnit } from '../../../../../files/domain/models/File'
 import { useSettings } from '../../../../settings/SettingsContext'
 import { SettingName } from '../../../../../settings/domain/models/Setting'
 import { ZipDownloadLimit } from '../../../../../settings/domain/models/ZipDownloadLimit'
@@ -9,11 +9,17 @@ import { FileSelection } from '../row-selection/useFileSelection'
 
 interface ZipDownloadLimitMessageProps {
   fileSelection: FileSelection
+  visitedFiles: FileSelection
+  filesTotalDownloadSize: number
 }
 
 const MINIMUM_FILES_TO_SHOW_MESSAGE = 1
 
-export function ZipDownloadLimitMessage({ fileSelection }: ZipDownloadLimitMessageProps) {
+export function ZipDownloadLimitMessage({
+  fileSelection,
+  visitedFiles,
+  filesTotalDownloadSize
+}: ZipDownloadLimitMessageProps) {
   const { t } = useTranslation('files')
   const { getSettingByName } = useSettings()
   const [zipDownloadLimitInBytes, setZipDownloadLimitInBytes] = useState<number>()
@@ -27,12 +33,20 @@ export function ZipDownloadLimitMessage({ fileSelection }: ZipDownloadLimitMessa
       })
   }, [getSettingByName])
 
-  // TODO - When selecting all files, the size should come from a call to a use case that returns the total size of the dataset files. Check issue https://github.com/IQSS/dataverse-frontend/issues/170
-  const selectionTotalSizeInBytes = getFilesTotalSizeInBytes(Object.values(fileSelection))
+  const [fileSelectionTotalSizeInInBytes, setFileSelectionTotalSizeInInBytes] = useState<number>(0)
+  useEffect(() => {
+    const totalSize = computeFileSelectionTotalSizeInBytes(
+      visitedFiles,
+      fileSelection,
+      filesTotalDownloadSize
+    )
+    setFileSelectionTotalSizeInInBytes(totalSize)
+  }, [fileSelection])
+
   const showMessage =
     zipDownloadLimitInBytes &&
     Object.values(fileSelection).length > MINIMUM_FILES_TO_SHOW_MESSAGE &&
-    selectionTotalSizeInBytes > zipDownloadLimitInBytes
+    fileSelectionTotalSizeInInBytes > zipDownloadLimitInBytes
 
   if (!showMessage) {
     return <></>
@@ -41,18 +55,38 @@ export function ZipDownloadLimitMessage({ fileSelection }: ZipDownloadLimitMessa
     <div className={styles.container}>
       <span className={styles.message}>
         {t('table.zipDownloadExceedsLimit', {
-          selectionTotalSize: bytesToHumanReadable(selectionTotalSizeInBytes),
+          selectionTotalSize: bytesToHumanReadable(fileSelectionTotalSizeInInBytes),
           zipDownloadSizeLimit: bytesToHumanReadable(zipDownloadLimitInBytes)
         })}
       </span>
     </div>
   )
 }
 
-function getFilesTotalSizeInBytes(files: (File | undefined)[]) {
-  return files
-    .map((file) => file?.size)
-    .reduce((bytes, size) => bytes + (size ? size.toBytes() : 0), 0)
+function computeFileSelectionTotalSizeInBytes(
+  visitedFiles: FileSelection,
+  fileSelection: FileSelection,
+  filesTotalDownloadSize: number
+) {
+  const selectAllHasBeenClicked = Object.values(fileSelection).some((file) => file == undefined)
+  if (selectAllHasBeenClicked) {
+    const differenceBetweenPreviousAndCurrentSelection =
+      getFilesTotalSize(visitedFiles) - getFilesTotalSize(fileSelection)
+
+    if (differenceBetweenPreviousAndCurrentSelection < 0) {
+      return filesTotalDownloadSize
+    }
+
+    return filesTotalDownloadSize - differenceBetweenPreviousAndCurrentSelection
+  }
+
+  return getFilesTotalSize(fileSelection)
+}
+
+function getFilesTotalSize(fileSelection: FileSelection) {
+  return Object.values(fileSelection)
+    .filter((file) => file != undefined)
+    .reduce((totalSize, file) => totalSize + (file ? file.size.toBytes() : 0), 0)
 }
 
 function bytesToHumanReadable(bytes: number) {

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

@@ -9,6 +9,7 @@ import { FilePaginationInfo } from '../../../files/domain/models/FilePaginationI
 import { useFilePermissions } from '../../file/file-permissions/FilePermissionsContext'
 import { FilePermission } from '../../../files/domain/models/FileUserPermissions'
 import { DatasetVersion } from '../../../dataset/domain/models/Dataset'
+import { getFilesTotalDownloadSize } from '../../../files/domain/useCases/getFilesTotalDownloadSize'
 
 export function useFiles(
   filesRepository: FileRepository,
@@ -22,6 +23,7 @@ export function useFiles(
   const [files, setFiles] = useState<File[]>([])
   const [isLoading, setIsLoading] = useState<boolean>(true)
   const [filesCountInfo, setFilesCountInfo] = useState<FilesCountInfo>()
+  const [filesTotalDownloadSize, setFilesTotalDownloadSize] = useState<number>(0)
 
   useEffect(() => {
     getFilesCountInfoByDatasetPersistentId(filesRepository, datasetPersistentId, datasetVersion)
@@ -65,9 +67,20 @@ export function useFiles(
     }
   }, [filesRepository, datasetPersistentId, datasetVersion, paginationInfo, criteria])
 
+  useEffect(() => {
+    getFilesTotalDownloadSize(filesRepository, datasetPersistentId, datasetVersion)
+      .then((filesTotalDownloadSize: number) => {
+        setFilesTotalDownloadSize(filesTotalDownloadSize)
+      })
+      .catch((error) => {
+        console.error('There was an error getting the files total download size', error)
+      })
+  }, [filesRepository, datasetPersistentId, datasetVersion])
+
   return {
     files,
     isLoading,
-    filesCountInfo
+    filesCountInfo,
+    filesTotalDownloadSize
   }
 }

src/settings/infrastructure/SettingJSDataverseRepository.ts

@@ -11,7 +11,7 @@ export class SettingJSDataverseRepository implements SettingRepository {
       setTimeout(() => {
         resolve({
           name: SettingName.ZIP_DOWNLOAD_LIMIT,
-          value: new ZipDownloadLimit(500, FileSizeUnit.BYTES)
+          value: new ZipDownloadLimit(1, FileSizeUnit.BYTES)
         } as Setting<T>)
       }, 1000)
     })

src/stories/WithSettings.tsx

@@ -5,7 +5,7 @@ import { SettingMother } from '../../tests/component/settings/domain/models/Sett
 import { ZipDownloadLimit } from '../settings/domain/models/ZipDownloadLimit'
 import { FileSizeUnit } from '../files/domain/models/File'
 
-const zipDownloadLimitMock = new ZipDownloadLimit(500, FileSizeUnit.BYTES)
+const zipDownloadLimitMock = new ZipDownloadLimit(1, FileSizeUnit.BYTES)
 export const WithSettings = (Story: StoryFn) => {
   // eslint-disable-next-line unused-imports/no-unused-vars
   function getSettingByName<T>(name: SettingName): Promise<Setting<T>> {