avoid datasetRepo props drilling

Author: ChengShi-1

CHANGELOG.md

@@ -33,6 +33,7 @@ This changelog follows the principles of [Keep a Changelog](https://keepachangel
 - Added disclaimer text and custom popup text to Publish Dataset modal for better communication of the implications of publishing a dataset. The text can be configured through the runtime configuration.
 - Dataset page Terms tab title now depends on permissions: users with dataset update permission see `Terms and Guestbook`, and read-only users see `Terms`.
 - Avoided prop-drilling for collection repository, so used context to share epository instances.
+- Avoided prop-drilling for dataset repository, so used context to share repository instances. (#963)
 
 ### Fixed
 

src/sections/account/AccountFactory.tsx

@@ -4,12 +4,14 @@ import { AccountHelper } from './AccountHelper'
 import { Account } from './Account'
 import { UserJSDataverseRepository } from '@/users/infrastructure/repositories/UserJSDataverseRepository'
 import { CollectionJSDataverseRepository } from '@/collection/infrastructure/repositories/CollectionJSDataverseRepository'
+import { DatasetJSDataverseRepository } from '@/dataset/infrastructure/repositories/DatasetJSDataverseRepository'
 import { RoleJSDataverseRepository } from '@/roles/infrastructure/repositories/RoleJSDataverseRepository'
 import { NotificationJSDataverseRepository } from '@/notifications/infrastructure/repositories/NotificationJSDataverseRepository'
 import { RepositoriesProvider } from '@/shared/contexts/repositories/RepositoriesProvider'
 
 const userRepository = new UserJSDataverseRepository()
 const collectionRepository = new CollectionJSDataverseRepository()
+const datasetRepository = new DatasetJSDataverseRepository()
 const roleRepository = new RoleJSDataverseRepository()
 const notificationRepository = new NotificationJSDataverseRepository()
 
@@ -24,7 +26,9 @@ function AccountWithSearchParams() {
   const defaultActiveTabKey = AccountHelper.defineSelectedTabKey(searchParams)
 
   return (
-    <RepositoriesProvider collectionRepository={collectionRepository}>
+    <RepositoriesProvider
+      collectionRepository={collectionRepository}
+      datasetRepository={datasetRepository}>
       <Account
         defaultActiveTabKey={defaultActiveTabKey}
         userRepository={userRepository}

src/sections/advanced-search/AdvancedSearchFactory.tsx

@@ -1,13 +1,15 @@
 import { ReactElement } from 'react'
 import { useParams, useSearchParams } from 'react-router-dom'
 import { CollectionJSDataverseRepository } from '@/collection/infrastructure/repositories/CollectionJSDataverseRepository'
+import { DatasetJSDataverseRepository } from '@/dataset/infrastructure/repositories/DatasetJSDataverseRepository'
 import { MetadataBlockInfoJSDataverseRepository } from '@/metadata-block-info/infrastructure/repositories/MetadataBlockInfoJSDataverseRepository'
 import { CollectionItemsQueryParams } from '@/collection/domain/models/CollectionItemsQueryParams'
 import { AdvancedSearch } from './AdvancedSearch'
 import { RepositoriesProvider } from '@/shared/contexts/repositories/RepositoriesProvider'
 
 const collectionRepository = new CollectionJSDataverseRepository()
 const metadataBlockInfoRepository = new MetadataBlockInfoJSDataverseRepository()
+const datasetRepository = new DatasetJSDataverseRepository()
 
 export class AdvancedSearchFactory {
   static create(): ReactElement {
@@ -24,7 +26,9 @@ function AdvancedSearchWithSearchParams() {
     searchParams.get(CollectionItemsQueryParams.FILTER_QUERIES) ?? undefined
 
   return (
-    <RepositoriesProvider collectionRepository={collectionRepository}>
+    <RepositoriesProvider
+      collectionRepository={collectionRepository}
+      datasetRepository={datasetRepository}>
       <AdvancedSearch
         collectionId={collectionId}
         metadataBlockInfoRepository={metadataBlockInfoRepository}

src/sections/collection/CollectionFactory.tsx

@@ -2,6 +2,7 @@ import { ReactElement } from 'react'
 import { useLocation, useParams } from 'react-router-dom'
 import { CollectionJSDataverseRepository } from '../../collection/infrastructure/repositories/CollectionJSDataverseRepository'
 import { ContactJSDataverseRepository } from '@/contact/infrastructure/ContactJSDataverseRepository'
+import { DatasetJSDataverseRepository } from '@/dataset/infrastructure/repositories/DatasetJSDataverseRepository'
 import { Collection } from './Collection'
 import { INFINITE_SCROLL_ENABLED } from './config'
 import { useGetCollectionQueryParams } from './useGetCollectionQueryParams'
@@ -10,6 +11,7 @@ import { RepositoriesProvider } from '@/shared/contexts/repositories/Repositorie
 
 const collectionRepository = new CollectionJSDataverseRepository()
 const contactRepository = new ContactJSDataverseRepository()
+const datasetRepository = new DatasetJSDataverseRepository()
 
 export class CollectionFactory {
   static create(): ReactElement {
@@ -32,7 +34,9 @@ function CollectionWithSearchParams() {
     Boolean(sessionStorage.getItem(ACCOUNT_CREATED_SESSION_STORAGE_KEY)) ?? false
 
   return (
-    <RepositoriesProvider collectionRepository={collectionRepository}>
+    <RepositoriesProvider
+      collectionRepository={collectionRepository}
+      datasetRepository={datasetRepository}>
       <Collection
         collectionIdFromParams={collectionId}
         created={created}

src/sections/create-collection/CreateCollectionFactory.tsx

@@ -1,12 +1,14 @@
 import { ReactElement } from 'react'
 import { useParams } from 'react-router-dom'
 import { CollectionJSDataverseRepository } from '../../collection/infrastructure/repositories/CollectionJSDataverseRepository'
+import { DatasetJSDataverseRepository } from '@/dataset/infrastructure/repositories/DatasetJSDataverseRepository'
 import { CreateCollection } from './CreateCollection'
 import { MetadataBlockInfoJSDataverseRepository } from '../../metadata-block-info/infrastructure/repositories/MetadataBlockInfoJSDataverseRepository'
 import { RepositoriesProvider } from '@/shared/contexts/repositories/RepositoriesProvider'
 
 const collectionRepository = new CollectionJSDataverseRepository()
 const metadataBlockInfoRepository = new MetadataBlockInfoJSDataverseRepository()
+const datasetRepository = new DatasetJSDataverseRepository()
 
 export class CreateCollectionFactory {
   static create(): ReactElement {
@@ -19,7 +21,9 @@ function CreateCollectionWithParams() {
     parentCollectionId: string
   }
   return (
-    <RepositoriesProvider collectionRepository={collectionRepository}>
+    <RepositoriesProvider
+      collectionRepository={collectionRepository}
+      datasetRepository={datasetRepository}>
       <CreateCollection
         parentCollectionId={parentCollectionId}
         metadataBlockInfoRepository={metadataBlockInfoRepository}

src/sections/create-dataset/CreateDataset.tsx

@@ -1,7 +1,6 @@
 import { useEffect, useState } from 'react'
 import { useTranslation } from 'react-i18next'
 import { Alert } from '@iqss/dataverse-design-system'
-import { type DatasetRepository } from '../../dataset/domain/repositories/DatasetRepository'
 import { type MetadataBlockInfoRepository } from '../../metadata-block-info/domain/repositories/MetadataBlockInfoRepository'
 import { SeparationLine } from '../shared/layout/SeparationLine/SeparationLine'
 import { HostCollectionForm } from './HostCollectionForm/HostCollectionForm'
@@ -21,14 +20,12 @@ import { TemplateRepository } from '@/templates/domain/repositories/TemplateRepo
 import { useCollectionRepositories } from '@/shared/contexts/repositories/RepositoriesProvider'
 
 interface CreateDatasetProps {
-  datasetRepository: DatasetRepository
   templateRepository: TemplateRepository
   metadataBlockInfoRepository: MetadataBlockInfoRepository
   collectionId: string
 }
 
 export function CreateDataset({
-  datasetRepository,
   templateRepository,
   metadataBlockInfoRepository,
   collectionId
@@ -123,7 +120,6 @@ export function CreateDataset({
         <DatasetMetadataForm
           mode="create"
           collectionId={collectionId}
-          datasetRepository={datasetRepository}
           metadataBlockInfoRepository={metadataBlockInfoRepository}
           datasetTemplate={selectedTemplate ?? undefined}
           key={selectedTemplate ? selectedTemplate.id : 'no-template-selected'} // We use the template id as key to force remounting the form when the template changes

src/sections/create-dataset/CreateDatasetFactory.tsx

@@ -27,9 +27,10 @@ function CreateDatasetWithSearchParams() {
   const { collectionId } = useParams<{ collectionId: string }>() as { collectionId: string }
 
   return (
-    <RepositoriesProvider collectionRepository={collectionRepository}>
+    <RepositoriesProvider
+      collectionRepository={collectionRepository}
+      datasetRepository={datasetRepository}>
       <CreateDataset
-        datasetRepository={datasetRepository}
         templateRepository={templateRepository}
         metadataBlockInfoRepository={metadataBlockInfoRepository}
         collectionId={collectionId}

src/sections/dataset/Dataset.tsx

@@ -18,7 +18,6 @@ import { useNotImplementedModal } from '../not-implemented/NotImplementedModalCo
 import { NotImplementedModal } from '../not-implemented/NotImplementedModal'
 import { SeparationLine } from '../shared/layout/SeparationLine/SeparationLine'
 import { BreadcrumbsGenerator } from '../shared/hierarchy/BreadcrumbsGenerator'
-import { DatasetRepository } from '../../dataset/domain/repositories/DatasetRepository'
 import { DatasetAlerts } from './dataset-alerts/DatasetAlerts'
 import { DatasetFilesScrollable } from './dataset-files/DatasetFilesScrollable'
 import useCheckPublishCompleted from './useCheckPublishCompleted'
@@ -32,9 +31,9 @@ import { DatasetMetrics } from './dataset-metrics/DatasetMetrics'
 import { DatasetPublishingStatus } from '@/dataset/domain/models/Dataset'
 import { DataverseInfoRepository } from '@/info/domain/repositories/DataverseInfoRepository'
 import { useAnonymized } from './anonymized/AnonymizedContext'
+import { useDatasetRepositories } from '@/shared/contexts/repositories/RepositoriesProvider'
 
 interface DatasetProps {
-  datasetRepository: DatasetRepository
   fileRepository: FileRepository
   metadataBlockInfoRepository: MetadataBlockInfoRepository
   contactRepository: ContactRepository
@@ -45,7 +44,6 @@ interface DatasetProps {
 }
 
 export function Dataset({
-  datasetRepository,
   fileRepository,
   metadataBlockInfoRepository,
   contactRepository,
@@ -54,6 +52,7 @@ export function Dataset({
   publishInProgress,
   tab = 'files'
 }: DatasetProps) {
+  const { datasetRepository } = useDatasetRepositories()
   const { setIsLoading } = useLoading()
   const { dataset, isLoading: isDatasetLoading } = useDataset()
   const { t } = useTranslation('dataset')
@@ -136,7 +135,6 @@ export function Dataset({
                 thumbnail={dataset.thumbnail}
                 version={dataset.version}
                 datasetId={dataset.persistentId}
-                datasetRepository={datasetRepository}
               />
               <DatasetSummary
                 summaryFields={dataset.summaryFields}
@@ -146,17 +144,9 @@ export function Dataset({
               />
             </Col>
             <Col lg={3}>
-              <DatasetActionButtons
-                datasetRepository={datasetRepository}
-                dataset={dataset}
-                contactRepository={contactRepository}
-              />
+              <DatasetActionButtons dataset={dataset} contactRepository={contactRepository} />
               {(!isCurrentVersionDeaccessioned || canUpdateDataset) && (
-                <DatasetMetrics
-                  data-testid="dataset-metrics"
-                  datasetRepository={datasetRepository}
-                  datasetId={dataset.persistentId}
-                />
+                <DatasetMetrics data-testid="dataset-metrics" datasetId={dataset.persistentId} />
               )}
             </Col>
           </Row>
@@ -168,7 +158,6 @@ export function Dataset({
               <Tabs.Tab eventKey="versions" title={t('Versions')}>
                 <div className={styles['tab-container']}>
                   <DatasetVersions
-                    datasetRepository={datasetRepository}
                     datasetId={dataset.persistentId}
                     currentVersionNumber={currentVersionNumber}
                     canUpdateDataset={canUpdateDataset}
@@ -190,14 +179,12 @@ export function Dataset({
                       datasetVersion={dataset.version}
                       canUpdateDataset={canUpdateDataset}
                       key={dataset.version.publishingStatus}
-                      datasetRepository={datasetRepository}
                     />
                   ) : (
                     <DatasetFiles
                       filesRepository={fileRepository}
                       datasetPersistentId={dataset.persistentId}
                       datasetVersion={dataset.version}
-                      datasetRepository={datasetRepository}
                     />
                   )}
                 </div>
@@ -230,7 +217,6 @@ export function Dataset({
               <Tabs.Tab eventKey="versions" title={t('Versions')}>
                 <div className={styles['tab-container']}>
                   <DatasetVersions
-                    datasetRepository={datasetRepository}
                     datasetId={dataset.persistentId}
                     currentVersionNumber={currentVersionNumber}
                     canUpdateDataset={canUpdateDataset}

src/sections/dataset/DatasetFactory.tsx

@@ -80,13 +80,14 @@ function DatasetWithSearchParams() {
 
   if (privateUrlToken) {
     return (
-      <RepositoriesProvider collectionRepository={collectionRepository}>
+      <RepositoriesProvider
+        collectionRepository={collectionRepository}
+        datasetRepository={datasetRepository}>
         <DatasetProvider
           repository={datasetRepository}
           searchParams={{ privateUrlToken: privateUrlToken }}
           isPublishing={publishInProgress}>
           <Dataset
-            datasetRepository={datasetRepository}
             fileRepository={fileRepository}
             metadataBlockInfoRepository={metadataBlockInfoRepository}
             contactRepository={contactRepository}
@@ -100,13 +101,14 @@ function DatasetWithSearchParams() {
   }
 
   return (
-    <RepositoriesProvider collectionRepository={collectionRepository}>
+    <RepositoriesProvider
+      collectionRepository={collectionRepository}
+      datasetRepository={datasetRepository}>
       <DatasetProvider
         repository={datasetRepository}
         searchParams={{ persistentId: persistentId, version: version }}
         isPublishing={publishInProgress}>
         <Dataset
-          datasetRepository={datasetRepository}
           fileRepository={fileRepository}
           metadataBlockInfoRepository={metadataBlockInfoRepository}
           contactRepository={contactRepository}

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

@@ -1,7 +1,6 @@
 import { useTranslation } from 'react-i18next'
 import { ButtonGroup } from '@iqss/dataverse-design-system'
 import { Dataset, DatasetPublishingStatus } from '@/dataset/domain/models/Dataset'
-import { DatasetRepository } from '@/dataset/domain/repositories/DatasetRepository'
 import { AccessDatasetMenu } from './access-dataset-menu/AccessDatasetMenu'
 import { PublishDatasetMenu } from './publish-dataset-menu/PublishDatasetMenu'
 import { SubmitForReviewButton } from './submit-for-review-button/SubmitForReviewButton'
@@ -14,15 +13,10 @@ import styles from './DatasetActionButtons.module.scss'
 
 interface DatasetActionButtonsProps {
   dataset: Dataset
-  datasetRepository: DatasetRepository
   contactRepository: ContactRepository
 }
 
-export function DatasetActionButtons({
-  dataset,
-  datasetRepository,
-  contactRepository
-}: DatasetActionButtonsProps) {
+export function DatasetActionButtons({ dataset, contactRepository }: DatasetActionButtonsProps) {
   const { t } = useTranslation('dataset')
 
   const isCurrentVersionDeaccessioned =
@@ -42,10 +36,10 @@ export function DatasetActionButtons({
         license={dataset.license}
         customTerms={dataset.termsOfUse.customTerms}
       />
-      <PublishDatasetMenu dataset={dataset} datasetRepository={datasetRepository} />
+      <PublishDatasetMenu dataset={dataset} />
       <SubmitForReviewButton dataset={dataset} />
-      <EditDatasetMenu dataset={dataset} datasetRepository={datasetRepository} />
-      <LinkAndUnlinkActions dataset={dataset} datasetRepository={datasetRepository} />
+      <EditDatasetMenu dataset={dataset} />
+      <LinkAndUnlinkActions dataset={dataset} />
       <ButtonGroup className={styles['contact-owner-and-share-group']}>
         <ContactButton
           toContactName={dataset.metadataBlocks[0].fields.title}