Merge pull request #462 from IQSS/fix/454-dataset-page-actions-for-draft

Fix/454 dataset page actions for draft

src/dataset/domain/models/Dataset.ts

@@ -217,10 +217,6 @@ export enum DatasetNonNumericVersion {
 export enum DatasetNonNumericVersionSearchParam {
  DRAFT = 'DRAFT'
 }
-// TODO: Maybe add this to some routing related folder or file
-export enum QueryParamsKeys {
- VERSION = 'version'
-}
 
 export class DatasetVersionNumber {
  constructor(public readonly majorNumber?: number, public readonly minorNumber?: number) {}

src/dataset/infrastructure/repositories/DatasetJSDataverseRepository.ts

@@ -131,15 +131,11 @@ export class DatasetJSDataverseRepository implements DatasetRepository {
  .execute(persistentId, version, includeDeaccessioned)
  .then((jsDataset) => this.fetchDatasetDetails(jsDataset, version))
  .then((datasetDetails) => {
- if (datasetDetails.jsDatasetPermissions.canEditDataset) {
- return this.fetchDownloadSizes(persistentId, version).then((downloadSizes) => {
- datasetDetails.jsDatasetFilesTotalOriginalDownloadSize = downloadSizes[0]
- datasetDetails.jsDatasetFilesTotalArchivalDownloadSize = downloadSizes[1]
- return datasetDetails
- })
- } else {
+ return this.fetchDownloadSizes(persistentId, version).then((downloadSizes) => {
+ datasetDetails.jsDatasetFilesTotalOriginalDownloadSize = downloadSizes[0]
+ datasetDetails.jsDatasetFilesTotalArchivalDownloadSize = downloadSizes[1]
  return datasetDetails
- }
+ })
  })
  .then((datasetDetails) => {
  return JSDatasetMapper.toDataset(

src/sections/Route.enum.ts

@@ -17,3 +17,8 @@ export const RouteWithParams = {
  CREATE_COLLECTION: (ownerCollectionId?: string) =>
  `/collections/${ownerCollectionId ?? 'root'}/create`
 }
+
+export enum QueryParamKey {
+ VERSION = 'version',
+ PERSISTENT_ID = 'persistentId'
+}

src/sections/collection/datasets-list/DatasetsList.tsx

@@ -56,7 +56,7 @@ export function DatasetsList({ datasetRepository, page, collectionId }: Datasets
  <PaginationResultsInfo paginationInfo={paginationInfo} />
  </div>
  {datasets.map((dataset) => (
- <DatasetCard dataset={dataset} key={dataset.persistentId} />
+ <DatasetCard dataset={dataset} key={`${dataset.persistentId}-${dataset.version.id}`} />
  ))}
  <PaginationControls
  onPaginationInfoChange={setPaginationInfo}

src/sections/collection/datasets-list/DatasetsListWithInfiniteScroll.tsx

@@ -91,7 +91,7 @@ export function DatasetsListWithInfiniteScroll({
  <PaginationResultsInfo paginationInfo={paginationInfo} accumulated={accumulatedCount} />
  </div>
  {accumulatedDatasets.map((dataset) => (
- <DatasetCard dataset={dataset} key={dataset.persistentId} />
+ <DatasetCard dataset={dataset} key={`${dataset.persistentId}-${dataset.version.id}`} />
  ))}
  </>
  )}

src/sections/dataset/Dataset.tsx

@@ -23,7 +23,7 @@ import { DatasetAlerts } from './dataset-alerts/DatasetAlerts'
 import { DatasetFilesScrollable } from './dataset-files/DatasetFilesScrollable'
 import useCheckPublishCompleted from './useCheckPublishCompleted'
 import useUpdateDatasetAlerts from './useUpdateDatasetAlerts'
-import { Route } from '../Route.enum'
+import { QueryParamKey, Route } from '../Route.enum'
 import { MetadataBlockInfoRepository } from '../../metadata-block-info/domain/repositories/MetadataBlockInfoRepository'
 
 interface DatasetProps {
@@ -60,7 +60,7 @@ export function Dataset({
 
  useEffect(() => {
  if (publishInProgress && publishCompleted && dataset) {
- navigate(`${Route.DATASETS}?persistentId=${dataset.persistentId}`, {
+ navigate(`${Route.DATASETS}?${QueryParamKey.PERSISTENT_ID}=${dataset.persistentId}`, {
  state: {},
  replace: true
  })

src/sections/dataset/dataset-action-buttons/access-dataset-menu/AccessDatasetMenu.tsx

@@ -26,7 +26,11 @@ export function AccessDatasetMenu({
 }: AccessDatasetMenuProps) {
  const { t } = useTranslation('dataset')
 
+ const flesToDownloadSizeIsZero =
+ fileDownloadSizes.map(({ value }) => value).reduce((acc, curr) => acc + curr, 0) === 0
+
  if (
+ flesToDownloadSizeIsZero ||
  !permissions.canDownloadFiles ||
  (version.publishingStatus === DatasetPublishingStatus.DEACCESSIONED &&
  !permissions.canUpdateDataset)

src/sections/dataset/dataset-action-buttons/edit-dataset-menu/EditDatasetMenu.tsx

@@ -1,13 +1,17 @@
 import { useTranslation } from 'react-i18next'
 import { useNavigate } from 'react-router-dom'
-import { Dataset } from '../../../../dataset/domain/models/Dataset'
+import {
+ Dataset,
+ DatasetNonNumericVersionSearchParam,
+ DatasetPublishingStatus
+} from '../../../../dataset/domain/models/Dataset'
 import { DropdownButton, DropdownButtonItem } from '@iqss/dataverse-design-system'
 import { EditDatasetPermissionsMenu } from './EditDatasetPermissionsMenu'
 import { DeleteDatasetButton } from './DeleteDatasetButton'
 import { DeaccessionDatasetButton } from './DeaccessionDatasetButton'
 import { useNotImplementedModal } from '../../../not-implemented/NotImplementedModalContext'
 import { useSession } from '../../../session/SessionContext'
-import { Route } from '../../../Route.enum'
+import { QueryParamKey, Route } from '../../../Route.enum'
 
 interface EditDatasetMenuProps {
  dataset: Dataset
@@ -29,12 +33,19 @@ export function EditDatasetMenu({ dataset }: EditDatasetMenuProps) {
  const navigate = useNavigate()
 
  const handleOnSelect = (eventKey: EditDatasetMenuItems | string | null) => {
+ const searchParams = new URLSearchParams()
+ searchParams.set(QueryParamKey.PERSISTENT_ID, dataset.persistentId)
+
+ if (dataset.version.publishingStatus === DatasetPublishingStatus.DRAFT) {
+ searchParams.set(QueryParamKey.VERSION, DatasetNonNumericVersionSearchParam.DRAFT)
+ }
+
  if (eventKey === EditDatasetMenuItems.FILES_UPLOAD) {
- navigate(`${Route.UPLOAD_DATASET_FILES}?persistentId=${dataset.persistentId}`)
+ navigate(`${Route.UPLOAD_DATASET_FILES}?${searchParams.toString()}`)
  return
  }
  if (eventKey === EditDatasetMenuItems.METADATA) {
- navigate(`${Route.EDIT_DATASET_METADATA}?persistentId=${dataset.persistentId}`)
+ navigate(`${Route.EDIT_DATASET_METADATA}?${searchParams.toString()}`)
  return
  }
  showModal()

src/sections/dataset/dataset-files/dataset-upload-files-button/DatasetUploadFilesButton.tsx

@@ -4,7 +4,11 @@ import { PlusLg } from 'react-bootstrap-icons'
 import { Button } from '@iqss/dataverse-design-system'
 import { useSession } from '../../../session/SessionContext'
 import { useDataset } from '../../DatasetContext'
-import { Route } from '../../../Route.enum'
+import { QueryParamKey, Route } from '../../../Route.enum'
+import {
+ DatasetNonNumericVersionSearchParam,
+ DatasetPublishingStatus
+} from '../../../../dataset/domain/models/Dataset'
 import styles from './DatasetUploadFilesButton.module.scss'
 
 export function DatasetUploadFilesButton() {
@@ -18,7 +22,14 @@ export function DatasetUploadFilesButton() {
  }
 
  const handleClick = () => {
- navigate(`${Route.UPLOAD_DATASET_FILES}?persistentId=${dataset.persistentId}`)
+ const searchParams = new URLSearchParams()
+ searchParams.set(QueryParamKey.PERSISTENT_ID, dataset.persistentId)
+
+ if (dataset.version.publishingStatus === DatasetPublishingStatus.DRAFT) {
+ searchParams.set(QueryParamKey.VERSION, DatasetNonNumericVersionSearchParam.DRAFT)
+ }
+
+ navigate(`${Route.UPLOAD_DATASET_FILES}?${searchParams.toString()}`)
  }
 
  return (

src/sections/dataset/publish-dataset/PublishDatasetModal.tsx

@@ -8,15 +8,14 @@ import { useSession } from '../../session/SessionContext'
 import { License } from '../dataset-summary/License'
 import {
  DatasetNonNumericVersionSearchParam,
- defaultLicense,
- QueryParamsKeys
+ defaultLicense
 } from '../../../dataset/domain/models/Dataset'
 import { SubmissionStatus } from '../../shared/form/DatasetMetadataForm/useSubmitDataset'
 import { usePublishDataset } from './usePublishDataset'
 import { PublishDatasetHelpText } from './PublishDatasetHelpText'
 import styles from './PublishDatasetModal.module.scss'
 import { useNavigate } from 'react-router-dom'
-import { Route } from '../../Route.enum'
+import { QueryParamKey, Route } from '../../Route.enum'
 
 interface PublishDatasetModalProps {
  show: boolean
@@ -52,7 +51,7 @@ export function PublishDatasetModal({
 
  function onPublishSucceed() {
  navigate(
- `${Route.DATASETS}?persistentId=${persistentId}&${QueryParamsKeys.VERSION}=${DatasetNonNumericVersionSearchParam.DRAFT}`,
+ `${Route.DATASETS}?${QueryParamKey.PERSISTENT_ID}=${persistentId}&${QueryParamKey.VERSION}=${DatasetNonNumericVersionSearchParam.DRAFT}`,
  {
  state: { publishInProgress: true },
  replace: true

src/sections/edit-dataset-metadata/EditDatasetMetadataFactory.tsx

@@ -4,6 +4,7 @@ import { EditDatasetMetadata } from './EditDatasetMetadata'
 import { DatasetProvider } from '../dataset/DatasetProvider'
 import { DatasetJSDataverseRepository } from '../../dataset/infrastructure/repositories/DatasetJSDataverseRepository'
 import { MetadataBlockInfoJSDataverseRepository } from '../../metadata-block-info/infrastructure/repositories/MetadataBlockInfoJSDataverseRepository'
+import { searchParamVersionToDomainVersion } from '../../Router'
 
 const datasetRepository = new DatasetJSDataverseRepository()
 const metadataBlockInfoRepository = new MetadataBlockInfoJSDataverseRepository()
@@ -17,9 +18,13 @@ export class EditDatasetMetadataFactory {
 function EditDatasetMetadataWithParams() {
  const [searchParams] = useSearchParams()
  const persistentId = searchParams.get('persistentId') ?? undefined
+ const searchParamVersion = searchParams.get('version') ?? undefined
+ const version = searchParamVersionToDomainVersion(searchParamVersion)
 
  return (
- <DatasetProvider repository={datasetRepository} searchParams={{ persistentId: persistentId }}>
+ <DatasetProvider
+ repository={datasetRepository}
+ searchParams={{ persistentId: persistentId, version: version }}>
  <EditDatasetMetadata
  datasetRepository={datasetRepository}
  metadataBlockInfoRepository={metadataBlockInfoRepository}

src/sections/shared/form/DatasetMetadataForm/useSubmitDataset.ts

@@ -7,11 +7,8 @@ import { updateDatasetMetadata } from '../../../../dataset/domain/useCases/updat
 import { MetadataFieldsHelper, type DatasetMetadataFormValues } from './MetadataFieldsHelper'
 import { getValidationFailedFieldError } from '../../../../metadata-block-info/domain/models/fieldValidations'
 import { type DatasetMetadataFormMode } from '.'
-import { Route } from '../../../Route.enum'
-import {
- DatasetNonNumericVersionSearchParam,
- QueryParamsKeys
-} from '../../../../dataset/domain/models/Dataset'
+import { QueryParamKey, Route } from '../../../Route.enum'
+import { DatasetNonNumericVersionSearchParam } from '../../../../dataset/domain/models/Dataset'
 
 export enum SubmissionStatus {
  NotSubmitted = 'NotSubmitted',
@@ -65,7 +62,7 @@ export function useSubmitDataset(
  setSubmitError(null)
  setSubmissionStatus(SubmissionStatus.SubmitComplete)
  navigate(
- `${Route.DATASETS}?persistentId=${persistentId}&${QueryParamsKeys.VERSION}=${DatasetNonNumericVersionSearchParam.DRAFT}`,
+ `${Route.DATASETS}?${QueryParamKey.PERSISTENT_ID}=${persistentId}&${QueryParamKey.VERSION}=${DatasetNonNumericVersionSearchParam.DRAFT}`,
  {
  state: { created: true }
  }
@@ -95,7 +92,7 @@ export function useSubmitDataset(
  setSubmitError(null)
  setSubmissionStatus(SubmissionStatus.SubmitComplete)
  navigate(
- `${Route.DATASETS}?persistentId=${currentEditedDatasetPersistentID}&${QueryParamsKeys.VERSION}=${DatasetNonNumericVersionSearchParam.DRAFT}`,
+ `${Route.DATASETS}?${QueryParamKey.PERSISTENT_ID}=${currentEditedDatasetPersistentID}&${QueryParamKey.VERSION}=${DatasetNonNumericVersionSearchParam.DRAFT}`,
  {
  state: { metadataUpdated: true }
  }

src/sections/upload-dataset-files/UploadDatasetFilesFactory.tsx

@@ -4,6 +4,7 @@ import { DatasetJSDataverseRepository } from '../../dataset/infrastructure/repos
 import { FileJSDataverseRepository } from '../../files/infrastructure/FileJSDataverseRepository'
 import { DatasetProvider } from '../dataset/DatasetProvider'
 import { UploadDatasetFiles } from './UploadDatasetFiles'
+import { searchParamVersionToDomainVersion } from '../../Router'
 
 const datasetRepository = new DatasetJSDataverseRepository()
 const fileRepository = new FileJSDataverseRepository()
@@ -17,9 +18,13 @@ export class UploadDatasetFilesFactory {
 function UploadDatasetFilesWithSearchParams() {
  const [searchParams] = useSearchParams()
  const persistentId = searchParams.get('persistentId') ?? undefined
+ const searchParamVersion = searchParams.get('version') ?? undefined
+ const version = searchParamVersionToDomainVersion(searchParamVersion)
 
  return (
- <DatasetProvider repository={datasetRepository} searchParams={{ persistentId: persistentId }}>
+ <DatasetProvider
+ repository={datasetRepository}
+ searchParams={{ persistentId: persistentId, version: version }}>
  <UploadDatasetFiles fileRepository={fileRepository} />
  </DatasetProvider>
  )

tests/component/sections/dataset/dataset-action-buttons/DatasetActionButtons.spec.tsx

@@ -1,18 +1,28 @@
+import { DatasetRepository } from '../../../../../src/dataset/domain/repositories/DatasetRepository'
+import { FileSizeUnit } from '../../../../../src/files/domain/models/FileMetadata'
 import { DatasetActionButtons } from '../../../../../src/sections/dataset/dataset-action-buttons/DatasetActionButtons'
 import {
+ DatasetFileDownloadSizeMother,
  DatasetMother,
  DatasetPermissionsMother,
  DatasetVersionMother
 } from '../../../dataset/domain/models/DatasetMother'
 
+const datasetRepository: DatasetRepository = {} as DatasetRepository
+
 describe('DatasetActionButtons', () => {
  it('renders the DatasetActionButtons with the Publish button', () => {
  const dataset = DatasetMother.create({
  version: DatasetVersionMother.createDraftAsLatestVersionWithSomeVersionHasBeenReleased(),
- permissions: DatasetPermissionsMother.createWithAllAllowed()
+ permissions: DatasetPermissionsMother.createWithAllAllowed(),
+ fileDownloadSizes: [
+ DatasetFileDownloadSizeMother.createOriginal({ value: 2000, unit: FileSizeUnit.BYTES })
+ ]
  })
 
- cy.mountAuthenticated(<DatasetActionButtons dataset={dataset} />)
+ cy.mountAuthenticated(
+ <DatasetActionButtons dataset={dataset} datasetRepository={datasetRepository} />
+ )
 
  cy.findByRole('group', { name: 'Dataset Action Buttons' }).should('exist')
  cy.findByRole('button', { name: 'Access Dataset' }).should('exist')
@@ -28,10 +38,15 @@ describe('DatasetActionButtons', () => {
  canDownloadFiles: true,
  canUpdateDataset: true,
  canPublishDataset: false
- })
+ }),
+ fileDownloadSizes: [
+ DatasetFileDownloadSizeMother.createOriginal({ value: 2000, unit: FileSizeUnit.BYTES })
+ ]
  })
 
- cy.mountAuthenticated(<DatasetActionButtons dataset={dataset} />)
+ cy.mountAuthenticated(
+ <DatasetActionButtons dataset={dataset} datasetRepository={datasetRepository} />
+ )
 
  cy.findByRole('group', { name: 'Dataset Action Buttons' }).should('exist')
  cy.findByRole('button', { name: 'Access Dataset' }).should('exist')

tests/component/sections/dataset/dataset-action-buttons/access-dataset-menu/AccessDatasetMenu.spec.tsx

@@ -139,4 +139,26 @@ describe('AccessDatasetMenu', () => {
  .should('exist')
  .should('have.attr', 'href', downloadUrls.archival)
  })
+
+ it('does not render the AccessDatasetMenu if the file download sizes are zero', () => {
+ const version = DatasetVersionMother.createReleased()
+ const permissions = DatasetPermissionsMother.createWithFilesDownloadAllowed()
+ const fileDownloadSizes = [
+ DatasetFileDownloadSizeMother.createOriginal({ value: 0, unit: FileSizeUnit.BYTES }),
+ DatasetFileDownloadSizeMother.createArchival({
+ value: 0,
+ unit: FileSizeUnit.BYTES
+ })
+ ]
+ cy.customMount(
+ <AccessDatasetMenu
+ fileDownloadSizes={fileDownloadSizes}
+ hasOneTabularFileAtLeast={true}
+ version={version}
+ permissions={permissions}
+ downloadUrls={downloadUrls}
+ />
+ )
+ cy.findByRole('button', { name: 'Access Dataset' }).should('not.exist')
+ })
 })