fix: increase test coverage, and disable edit names and email in guestbook

Author: ChengShi-1

public/locales/en/dataset.json

@@ -368,7 +368,8 @@
     },
     "guestbook": {
       "title": "Guestbook",
-      "description": "Select a guestbook to have a user provide additional information when downloading a file. To learn more about guestbooks, visit the Dataset Guestbook section of the User Guide.",
+      "description": "Select a guestbook to have a user provide additional information when downloading a file. To learn more about guestbooks, visit the <anchor>Dataset Guestbook</anchor> section of the User Guide.",
+      "noGuestbooksEnabled": "There are no guestbooks enabled in {{collectionName}}. To create a guestbook, return to {{collectionName}}, click the \"Edit\" button and select the \"Dataset Guestbooks\" option.",
       "previewButton": "Preview Guestbook"
     },
     "unsavedChangesModal": {

src/access/domain/repositories/AccessRepository.ts

@@ -1,6 +1,10 @@
 export type GuestbookResponseAnswer = { id: number | string; value: string | string[] }
 
 export interface AccessRepository {
+  submitGuestbookForDatasetDownload: (
+    datasetId: number | string,
+    answers: GuestbookResponseAnswer[]
+  ) => Promise<string>
   submitGuestbookForDatafileDownload: (
     fileId: number | string,
     answers: GuestbookResponseAnswer[]

src/access/domain/useCases/submitGuestbookForDatasetDownload.ts

@@ -0,0 +1,9 @@
+import { AccessRepository, GuestbookResponseAnswer } from '../repositories/AccessRepository'
+
+export function submitGuestbookForDatasetDownload(
+  accessRepository: AccessRepository,
+  datasetId: number | string,
+  answers: GuestbookResponseAnswer[]
+): Promise<string> {
+  return accessRepository.submitGuestbookForDatasetDownload(datasetId, answers)
+}

src/access/infrastructure/repositories/AccessJSDataverseRepository.ts

@@ -1,4 +1,5 @@
 import {
+  submitGuestbookForDatasetDownload as submitGuestbookForDatasetDownloadJSDv,
   submitGuestbookForDatafileDownload as submitGuestbookForDatafileDownloadJSDv,
   submitGuestbookForDatafilesDownload as submitGuestbookForDatafilesDownloadJSDv
 } from '@iqss/dataverse-client-javascript'
@@ -8,6 +9,15 @@ import {
 } from '@/access/domain/repositories/AccessRepository'
 
 export class AccessJSDataverseRepository implements AccessRepository {
+  submitGuestbookForDatasetDownload(
+    datasetId: number | string,
+    answers: GuestbookResponseAnswer[]
+  ): Promise<string> {
+    return submitGuestbookForDatasetDownloadJSDv.execute(datasetId, {
+      guestbookResponse: { answers }
+    })
+  }
+
   submitGuestbookForDatafileDownload(
     fileId: number | string,
     answers: GuestbookResponseAnswer[]

src/dataset/domain/useCases/updateTermsOfAccess.ts

@@ -6,7 +6,5 @@ export function updateTermsOfAccess(
   datasetId: string | number,
   termsOfAccess: TermsOfAccess
 ): Promise<void> {
-  return datasetRepository.updateTermsOfAccess(datasetId, termsOfAccess).catch((error: Error) => {
-    throw new Error(error.message)
-  })
+  return datasetRepository.updateTermsOfAccess(datasetId, termsOfAccess)
 }

src/files/domain/models/File.ts

@@ -1,4 +1,4 @@
-import { DatasetVersion } from '../../../dataset/domain/models/Dataset'
+import { CustomTerms, DatasetLicense, DatasetVersion } from '../../../dataset/domain/models/Dataset'
 import { FileMetadata } from './FileMetadata'
 import { FileAccess } from './FileAccess'
 import { FilePermissions } from './FilePermissions'
@@ -10,6 +10,8 @@ export interface File {
   id: number
   datasetPersistentId: string
   guestbookId?: number
+  datasetLicense?: DatasetLicense
+  datasetCustomTerms?: CustomTerms
   name: string
   access: FileAccess
   datasetVersion: DatasetVersion

src/files/infrastructure/mappers/JSFileMapper.ts

@@ -63,6 +63,8 @@ export class JSFileMapper {
       id: this.toFileId(jsFile.id),
       datasetPersistentId: jsDataset.persistentId,
       guestbookId: jsDataset.guestbookId,
+      datasetLicense: jsDataset.license,
+      datasetCustomTerms: jsDataset.termsOfUse?.customTerms,
       name: this.toFileName(jsFile.name),
       access: JSFileAccessMapper.toFileAccess(jsFile.restricted, jsFile.fileAccessRequest || false),
       datasetVersion: datasetVersion,

src/sections/dataset/dataset-action-buttons/DatasetActionButtons.tsx

@@ -41,6 +41,9 @@ export function DatasetActionButtons({
         downloadUrls={dataset.downloadUrls}
         fileStore={dataset.fileStore}
         persistentId={dataset.persistentId}
+        guestbookId={dataset.guestbookId}
+        license={dataset.license}
+        customTerms={dataset.termsOfUse.customTerms}
       />
       <PublishDatasetMenu
         dataset={dataset}

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

@@ -1,14 +1,18 @@
+import { useState } from 'react'
 import { DropdownButton, DropdownButtonItem, DropdownHeader } from '@iqss/dataverse-design-system'
 import { Download as DownloadIcon } from 'react-bootstrap-icons'
 import { useTranslation } from 'react-i18next'
 import {
+  CustomTerms,
   DatasetDownloadUrls,
+  DatasetLicense,
   DatasetPermissions,
   DatasetPublishingStatus,
   DatasetVersion
 } from '../../../../dataset/domain/models/Dataset'
 import { FileDownloadSize, FileDownloadMode } from '../../../../files/domain/models/FileMetadata'
 import { DatasetExploreOptions } from '../DatasetToolsOptions'
+import { DownloadWithGuestbookModal } from '@/sections/dataset/dataset-files/files-table/file-actions/file-actions-cell/file-action-buttons/file-options-menu/DownloadWithGuestbookModal'
 
 // TODO: add compute feature
 
@@ -20,6 +24,9 @@ interface AccessDatasetMenuProps {
   downloadUrls: DatasetDownloadUrls
   fileStore: string | undefined
   persistentId: string
+  guestbookId?: number
+  license?: DatasetLicense
+  customTerms?: CustomTerms
 }
 
 export function AccessDatasetMenu({
@@ -29,9 +36,14 @@ export function AccessDatasetMenu({
   fileDownloadSizes,
   downloadUrls,
   fileStore,
-  persistentId
+  persistentId,
+  guestbookId,
+  license,
+  customTerms
 }: AccessDatasetMenuProps) {
   const { t } = useTranslation('dataset')
+  const [showDownloadWithGuestbookModal, setShowDownloadWithGuestbookModal] = useState(false)
+  const hasGuestbook = guestbookId !== undefined
 
   const flesToDownloadSizeIsZero =
     fileDownloadSizes.map(({ value }) => value).reduce((acc, curr) => acc + curr, 0) === 0
@@ -50,40 +62,58 @@ export function AccessDatasetMenu({
     return <></>
   }
 
-  // TODO: remove this when access datafile supports bearer tokens
-  if (version.publishingStatus === DatasetPublishingStatus.DRAFT) {
-    return <></>
+  const handleDownloadWithGuestbook = (event: React.MouseEvent<HTMLElement>) => {
+    event.preventDefault()
+    setShowDownloadWithGuestbookModal(true)
   }
 
   return (
-    <DropdownButton
-      id={`access-dataset-menu`}
-      title={t('datasetActionButtons.accessDataset.title')}
-      asButtonGroup
-      variant="primary">
-      <DropdownHeader className="d-flex align-items-center gap-1">
-        {t('datasetActionButtons.accessDataset.downloadOptions.header')} <DownloadIcon />
-      </DropdownHeader>
-      <DatasetDownloadOptions
-        hasOneTabularFileAtLeast={hasOneTabularFileAtLeast}
-        fileDownloadSizes={fileDownloadSizes}
-        downloadUrls={downloadUrls}
-      />
-      <DatasetExploreOptions persistentId={persistentId} />
-    </DropdownButton>
+    <>
+      <DropdownButton
+        id={`access-dataset-menu`}
+        title={t('datasetActionButtons.accessDataset.title')}
+        asButtonGroup
+        variant="primary">
+        <DropdownHeader className="d-flex align-items-center gap-1">
+          {t('datasetActionButtons.accessDataset.downloadOptions.header')} <DownloadIcon />
+        </DropdownHeader>
+        <DatasetDownloadOptions
+          hasOneTabularFileAtLeast={hasOneTabularFileAtLeast}
+          fileDownloadSizes={fileDownloadSizes}
+          downloadUrls={downloadUrls}
+          hasGuestbook={hasGuestbook}
+          onDownloadWithGuestbook={handleDownloadWithGuestbook}
+        />
+        <DatasetExploreOptions persistentId={persistentId} />
+      </DropdownButton>
+      {hasGuestbook && (
+        <DownloadWithGuestbookModal
+          show={showDownloadWithGuestbookModal}
+          handleClose={() => setShowDownloadWithGuestbookModal(false)}
+          guestbookId={guestbookId}
+          datasetPersistentId={persistentId}
+          datasetLicense={license}
+          datasetCustomTerms={customTerms}
+        />
+      )}
+    </>
   )
 }
 
 interface DatasetDownloadOptionsProps {
   hasOneTabularFileAtLeast: boolean
   fileDownloadSizes: FileDownloadSize[]
   downloadUrls: DatasetDownloadUrls
+  hasGuestbook: boolean
+  onDownloadWithGuestbook: (event: React.MouseEvent<HTMLElement>) => void
 }
 
 const DatasetDownloadOptions = ({
   hasOneTabularFileAtLeast,
   fileDownloadSizes,
-  downloadUrls
+  downloadUrls,
+  hasGuestbook,
+  onDownloadWithGuestbook
 }: DatasetDownloadOptionsProps) => {
   const { t } = useTranslation('dataset')
   function getFormattedFileSize(mode: FileDownloadMode): string {
@@ -93,17 +123,23 @@ const DatasetDownloadOptions = ({
 
   return hasOneTabularFileAtLeast ? (
     <>
-      <DropdownButtonItem href={downloadUrls[FileDownloadMode.ORIGINAL]}>
+      <DropdownButtonItem
+        href={hasGuestbook ? undefined : downloadUrls[FileDownloadMode.ORIGINAL]}
+        onClick={hasGuestbook ? onDownloadWithGuestbook : undefined}>
         {t('datasetActionButtons.accessDataset.downloadOptions.originalZip')} (
         {getFormattedFileSize(FileDownloadMode.ORIGINAL)})
       </DropdownButtonItem>
-      <DropdownButtonItem href={downloadUrls[FileDownloadMode.ARCHIVAL]}>
+      <DropdownButtonItem
+        href={hasGuestbook ? undefined : downloadUrls[FileDownloadMode.ARCHIVAL]}
+        onClick={hasGuestbook ? onDownloadWithGuestbook : undefined}>
         {t('datasetActionButtons.accessDataset.downloadOptions.archivalZip')} (
         {getFormattedFileSize(FileDownloadMode.ARCHIVAL)})
       </DropdownButtonItem>
     </>
   ) : (
-    <DropdownButtonItem href={downloadUrls[FileDownloadMode.ORIGINAL]}>
+    <DropdownButtonItem
+      href={hasGuestbook ? undefined : downloadUrls[FileDownloadMode.ORIGINAL]}
+      onClick={hasGuestbook ? onDownloadWithGuestbook : undefined}>
       {t('datasetActionButtons.accessDataset.downloadOptions.zip')} (
       {getFormattedFileSize(FileDownloadMode.ORIGINAL)})
     </DropdownButtonItem>

src/sections/dataset/dataset-files/files-table/file-actions/download-files/DownloadFilesButton.tsx

@@ -11,7 +11,7 @@ import { useMultipleFileDownload } from '../../../../../file/multiple-file-downl
 import { FilePreview } from '../../../../../../files/domain/models/FilePreview'
 import { useMediaQuery } from '../../../../../../shared/hooks/useMediaQuery'
 import { DatasetPublishingStatus } from '@/dataset/domain/models/Dataset'
-import { GuestbookAppliedModal } from '../file-actions-cell/file-action-buttons/file-options-menu/GuestbookAppliedModal'
+import { DownloadWithGuestbookModal } from '../file-actions-cell/file-action-buttons/file-options-menu/DownloadWithGuestbookModal'
 
 interface DownloadFilesButtonProps {
   files: FilePreview[]
@@ -25,13 +25,15 @@ export function DownloadFilesButton({ files, fileSelection }: DownloadFilesButto
   const { t } = useTranslation('files')
   const { dataset } = useDataset()
   const [showNoFilesSelectedModal, setShowNoFilesSelectedModal] = useState(false)
-  const [showGuestbookAppliedModal, setShowGuestbookAppliedModal] = useState(false)
+  const [showDownloadWithGuestbookModal, setShowDownloadWithGuestbookModal] = useState(false)
   const { getMultipleFileDownloadUrl } = useMultipleFileDownload()
   const isBelow768px = useMediaQuery('(max-width: 768px)')
 
   const fileSelectionCount = Object.keys(fileSelection).length
   const allFilesSelected = Object.values(fileSelection).some((file) => file === undefined)
   const selectedFileIds = getFileIdsFromSelection(fileSelection)
+  const allSelectedFileIds = files.map((file) => file.id)
+  const fileIdsForGuestbookSubmission = allFilesSelected ? allSelectedFileIds : selectedFileIds
   const hasGuestbook = dataset?.guestbookId !== undefined
   const onClick = (event: MouseEvent<HTMLElement>) => {
     if (fileSelectionCount === SELECTED_FILES_EMPTY) {
@@ -42,7 +44,7 @@ export function DownloadFilesButton({ files, fileSelection }: DownloadFilesButto
 
     if (hasGuestbook) {
       event.preventDefault()
-      setShowGuestbookAppliedModal(true)
+      setShowDownloadWithGuestbookModal(true)
     }
   }
 
@@ -100,11 +102,11 @@ export function DownloadFilesButton({ files, fileSelection }: DownloadFilesButto
           show={showNoFilesSelectedModal}
           handleClose={() => setShowNoFilesSelectedModal(false)}
         />
-        <GuestbookAppliedModal
-          fileIds={!allFilesSelected ? selectedFileIds : undefined}
+        <DownloadWithGuestbookModal
+          fileIds={fileIdsForGuestbookSubmission}
           guestbookId={dataset?.guestbookId}
-          show={showGuestbookAppliedModal}
-          handleClose={() => setShowGuestbookAppliedModal(false)}
+          show={showDownloadWithGuestbookModal}
+          handleClose={() => setShowDownloadWithGuestbookModal(false)}
         />
       </>
     )
@@ -126,11 +128,11 @@ export function DownloadFilesButton({ files, fileSelection }: DownloadFilesButto
           show={showNoFilesSelectedModal}
           handleClose={() => setShowNoFilesSelectedModal(false)}
         />
-        <GuestbookAppliedModal
-          fileIds={!allFilesSelected ? selectedFileIds : undefined}
+        <DownloadWithGuestbookModal
+          fileIds={fileIdsForGuestbookSubmission}
           guestbookId={dataset?.guestbookId}
-          show={showGuestbookAppliedModal}
-          handleClose={() => setShowGuestbookAppliedModal(false)}
+          show={showDownloadWithGuestbookModal}
+          handleClose={() => setShowDownloadWithGuestbookModal(false)}
         />
       </>
     )