Merge pull request #219 from IQSS/feauter/206-integration-dataset-locks

206 - Integration dataset locks
IQSS · Nov 23, 2023 · 745e2e9 · 745e2e9
2 parents 89242ef + 622b8a3
commit 745e2e9
Show file tree

Hide file tree

Showing 23 changed files with 277 additions and 113 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -13,7 +13,7 @@
   },
   "dependencies": {
     "@faker-js/faker": "7.6.0",
-    "@iqss/dataverse-client-javascript": "2.0.0-pr97.418bf5e",
+    "@iqss/dataverse-client-javascript": "2.0.0-pr99.c36f1db",
     "@iqss/dataverse-design-system": "*",
     "@istanbuljs/nyc-config-typescript": "1.0.2",
     "@tanstack/react-table": "8.9.2",

diff --git a/src/dataset/domain/models/Dataset.ts b/src/dataset/domain/models/Dataset.ts
@@ -243,20 +243,19 @@ export interface DatasetPermissions {
 }
 
 export interface DatasetLock {
-  id: number
+  userPersistentId: string
   reason: DatasetLockReason
 }
 
 export enum DatasetLockReason {
-  INGEST = 'ingest',
-  WORKFLOW = 'workflow',
-  IN_REVIEW = 'inReview',
-  DCM_UPLOAD = 'dcmUpload',
-  GLOBUS_UPLOAD = 'globusUpload',
+  INGEST = 'Ingest',
+  WORKFLOW = 'Workflow',
+  IN_REVIEW = 'InReview',
+  DCM_UPLOAD = 'DcmUpload',
+  GLOBUS_UPLOAD = 'GlobusUpload',
   FINALIZE_PUBLICATION = 'finalizePublication',
-
-  EDIT_IN_PROGRESS = 'editInProgress',
-  FILE_VALIDATION_FAILED = 'fileValidationFailed'
+  EDIT_IN_PROGRESS = 'EditInProgress',
+  FILE_VALIDATION_FAILED = 'FileValidationFailed'
 }
 
 export interface PrivateUrl {
@@ -287,8 +286,8 @@ export class Dataset {
     return this.metadataBlocks[0].fields.title
   }
 
-  public get isLockedFromPublishing(): boolean {
-    return this.isLockedFromEdits
+  public checkIsLockedFromPublishing(userPersistentId: string): boolean {
+    return this.checkIsLockedFromEdits(userPersistentId)
   }
 
   public get isLocked(): boolean {
@@ -299,12 +298,19 @@ export class Dataset {
     return this.locks.some((lock) => lock.reason === DatasetLockReason.WORKFLOW)
   }
 
-  public get isLockedFromEdits(): boolean {
+  public checkIsLockedFromEdits(userPersistentId: string): boolean {
     const lockedReasonIsInReview = this.locks.some(
       (lock) => lock.reason === DatasetLockReason.IN_REVIEW
     )
-    // If the lock reason is workflow and the workflow userId is the same as the current user, then the user can edit
-    // TODO - Ask how we want to manage pending workflows
+
+    if (
+      this.locks.some(
+        (lock) =>
+          lock.reason === DatasetLockReason.WORKFLOW && lock.userPersistentId === userPersistentId
+      )
+    ) {
+      return false
+    }
 
     return this.isLocked && !(lockedReasonIsInReview && this.permissions.canPublishDataset)
   }

diff --git a/src/dataset/infrastructure/mappers/JSDatasetMapper.ts b/src/dataset/infrastructure/mappers/JSDatasetMapper.ts
@@ -3,7 +3,8 @@ import {
   DatasetMetadataBlock as JSDatasetMetadataBlock,
   DatasetMetadataBlocks as JSDatasetMetadataBlocks,
   DatasetMetadataFields as JSDatasetMetadataFields,
-  DatasetVersionInfo as JSDatasetVersionInfo
+  DatasetVersionInfo as JSDatasetVersionInfo,
+  DatasetLock as JSDatasetLock
 } from '@iqss/dataverse-client-javascript'
 import { DatasetVersionState as JSDatasetVersionState } from '@iqss/dataverse-client-javascript/dist/datasets/domain/models/Dataset'
 import {
@@ -14,14 +15,17 @@ import {
   DatasetMetadataFields,
   DatasetVersion,
   MetadataBlockName,
-  PrivateUrl
+  PrivateUrl,
+  DatasetLock,
+  DatasetLockReason
 } from '../../domain/models/Dataset'
 
 export class JSDatasetMapper {
   static toDataset(
     jsDataset: JSDataset,
     citation: string,
     summaryFieldsNames: string[],
+    jsDatasetLocks: JSDatasetLock[],
     requestedVersion?: string,
     privateUrl?: PrivateUrl
   ): Dataset {
@@ -45,7 +49,7 @@ export class JSDatasetMapper {
         canManageFilesPermissions: true,
         canDeleteDataset: true
       }, // TODO Connect with dataset permissions
-      [], // TODO Connect with dataset locks
+      JSDatasetMapper.toLocks(jsDatasetLocks),
       true, // TODO Connect with dataset hasValidTermsOfAccess
       true, // TODO Connect with dataset isValid
       jsDataset.versionInfo.releaseTime !== undefined &&
@@ -185,4 +189,13 @@ export class JSDatasetMapper {
 
     return extraFields
   }
+
+  static toLocks(jsDatasetLocks: JSDatasetLock[]): DatasetLock[] {
+    return jsDatasetLocks.map((jsDatasetLock) => {
+      return {
+        userPersistentId: jsDatasetLock.userId,
+        reason: jsDatasetLock.lockType as unknown as DatasetLockReason
+      }
+    })
+  }
 }
diff --git a/src/dataset/infrastructure/repositories/DatasetJSDataverseRepository.ts b/src/dataset/infrastructure/repositories/DatasetJSDataverseRepository.ts
@@ -7,7 +7,9 @@ import {
   Dataset as JSDataset,
   getPrivateUrlDataset,
   getPrivateUrlDatasetCitation,
-  ReadError
+  ReadError,
+  getDatasetLocks,
+  DatasetLock as JSDatasetLock
 } from '@iqss/dataverse-client-javascript'
 import { JSDatasetMapper } from '../mappers/JSDatasetMapper'
 
@@ -23,11 +25,24 @@ export class DatasetJSDataverseRepository implements DatasetRepository {
         Promise.all([
           jsDataset,
           getDatasetSummaryFieldNames.execute(),
-          getDatasetCitation.execute(jsDataset.id, this.versionToVersionId(version))
+          getDatasetCitation.execute(jsDataset.id, this.versionToVersionId(version)),
+          getDatasetLocks.execute(jsDataset.id)
         ])
       )
-      .then(([jsDataset, summaryFieldsNames, citation]: [JSDataset, string[], string]) =>
-        JSDatasetMapper.toDataset(jsDataset, citation, summaryFieldsNames, requestedVersion)
+      .then(
+        ([jsDataset, summaryFieldsNames, citation, jsDatasetLocks]: [
+          JSDataset,
+          string[],
+          string,
+          JSDatasetLock[]
+        ]) =>
+          JSDatasetMapper.toDataset(
+            jsDataset,
+            citation,
+            summaryFieldsNames,
+            jsDatasetLocks,
+            requestedVersion
+          )
       )
       .catch((error: ReadError) => {
         if (!version) {
@@ -42,9 +57,9 @@ export class DatasetJSDataverseRepository implements DatasetRepository {
       getPrivateUrlDataset.execute(privateUrlToken),
       getDatasetSummaryFieldNames.execute(),
       getPrivateUrlDatasetCitation.execute(privateUrlToken)
-    ])
+    ]) // TODO - Add getDatasetLocks.execute(privateUrlToken) when it is available in js-dataverse
       .then(([jsDataset, summaryFieldsNames, citation]: [JSDataset, string[], string]) =>
-        JSDatasetMapper.toDataset(jsDataset, citation, summaryFieldsNames, undefined)
+        JSDatasetMapper.toDataset(jsDataset, citation, summaryFieldsNames, [])
       )
       .catch((error: ReadError) => {
         throw new Error(error.message)

diff --git a/src/sections/dataset/dataset-action-buttons/edit-dataset-menu/EditDatasetMenu.tsx b/src/sections/dataset/dataset-action-buttons/edit-dataset-menu/EditDatasetMenu.tsx
@@ -4,13 +4,16 @@ import { EditDatasetPermissionsMenu } from './EditDatasetPermissionsMenu'
 import { DeleteDatasetButton } from './DeleteDatasetButton'
 import { DeaccessionDatasetButton } from './DeaccessionDatasetButton'
 import { useTranslation } from 'react-i18next'
+import { useSession } from '../../../session/SessionContext'
 
 interface EditDatasetMenuProps {
   dataset: Dataset
 }
 
 export function EditDatasetMenu({ dataset }: EditDatasetMenuProps) {
-  if (!dataset.permissions.canUpdateDataset) {
+  const { user } = useSession()
+
+  if (!user || !dataset.permissions.canUpdateDataset) {
     return <></>
   }
 
@@ -21,7 +24,7 @@ export function EditDatasetMenu({ dataset }: EditDatasetMenuProps) {
       title={t('datasetActionButtons.editDataset.title')}
       asButtonGroup
       variant="secondary"
-      disabled={dataset.isLockedFromEdits}>
+      disabled={dataset.checkIsLockedFromEdits(user.persistentId)}>
       <DropdownButtonItem disabled={!dataset.hasValidTermsOfAccess}>
         {t('datasetActionButtons.editDataset.filesUpload')}
       </DropdownButtonItem>

diff --git a/src/sections/dataset/dataset-action-buttons/publish-dataset-menu/PublishDatasetMenu.tsx b/src/sections/dataset/dataset-action-buttons/publish-dataset-menu/PublishDatasetMenu.tsx
@@ -2,15 +2,18 @@ import { Dataset, DatasetPublishingStatus } from '../../../../dataset/domain/mod
 import { DropdownButton, DropdownButtonItem } from '@iqss/dataverse-design-system'
 import { ChangeCurationStatusMenu } from './ChangeCurationStatusMenu'
 import { useTranslation } from 'react-i18next'
+import { useSession } from '../../../session/SessionContext'
 
 interface PublishDatasetMenuProps {
   dataset: Dataset
 }
 
 export function PublishDatasetMenu({ dataset }: PublishDatasetMenuProps) {
+  const { user } = useSession()
   if (
     !dataset.version.isLatest ||
     dataset.version.publishingStatus !== DatasetPublishingStatus.DRAFT ||
+    !user ||
     !dataset.permissions.canPublishDataset
   ) {
     return <></>
@@ -24,7 +27,9 @@ export function PublishDatasetMenu({ dataset }: PublishDatasetMenuProps) {
       asButtonGroup
       variant="secondary"
       disabled={
-        dataset.isLockedFromPublishing || !dataset.hasValidTermsOfAccess || !dataset.isValid
+        dataset.checkIsLockedFromPublishing(user.persistentId) ||
+        !dataset.hasValidTermsOfAccess ||
+        !dataset.isValid
       }>
       <DropdownButtonItem>{t('datasetActionButtons.publish.publish')}</DropdownButtonItem>
       {dataset.version.isInReview && (

diff --git a/...ections/dataset/dataset-action-buttons/submit-for-review-button/SubmitForReviewButton.tsx b/...ections/dataset/dataset-action-buttons/submit-for-review-button/SubmitForReviewButton.tsx
@@ -1,17 +1,20 @@
 import { Dataset, DatasetPublishingStatus } from '../../../../dataset/domain/models/Dataset'
 import { Button } from '@iqss/dataverse-design-system'
 import { useTranslation } from 'react-i18next'
+import { useSession } from '../../../session/SessionContext'
 
 interface SubmitForReviewButtonProps {
   dataset: Dataset
 }
 
 export function SubmitForReviewButton({ dataset }: SubmitForReviewButtonProps) {
+  const { user } = useSession()
   if (
     !dataset.version.isLatest ||
     dataset.version.publishingStatus !== DatasetPublishingStatus.DRAFT ||
     dataset.isLockedInWorkflow ||
     dataset.permissions.canPublishDataset ||
+    !user ||
     !dataset.permissions.canUpdateDataset
   ) {
     return <></>
@@ -22,7 +25,9 @@ export function SubmitForReviewButton({ dataset }: SubmitForReviewButtonProps) {
     <Button
       variant="secondary"
       disabled={
-        dataset.isLockedFromPublishing || !dataset.hasValidTermsOfAccess || !dataset.isValid
+        dataset.checkIsLockedFromPublishing(user.persistentId) ||
+        !dataset.hasValidTermsOfAccess ||
+        !dataset.isValid
       }>
       {dataset.version.isInReview
         ? t('datasetActionButtons.submitForReview.disabled')

diff --git a/src/sections/dataset/dataset-files/dataset-upload-files-button/DatasetUploadFilesButton.tsx b/src/sections/dataset/dataset-files/dataset-upload-files-button/DatasetUploadFilesButton.tsx
@@ -21,7 +21,7 @@ export function DatasetUploadFilesButton() {
     <Button
       onClick={handleClick}
       icon={<PlusLg className={styles.icon} />}
-      disabled={dataset.isLockedFromEdits}>
+      disabled={dataset.checkIsLockedFromEdits(user.persistentId)}>
       {t('datasetActionButtons.uploadFiles')}
     </Button>
   )

diff --git a/src/sections/dataset/dataset-files/file-criteria-form/FileCriteriaForm.tsx b/src/sections/dataset/dataset-files/file-criteria-form/FileCriteriaForm.tsx
@@ -18,31 +18,36 @@ export function FileCriteriaForm({
   onCriteriaChange,
   filesCountInfo
 }: FileCriteriaInputsProps) {
-  if (!filesCountInfo || filesCountInfo.total < MINIMUM_FILES_TO_SHOW_CRITERIA_INPUTS) {
-    return <></>
-  }
+  const showFileCriteriaInputs =
+    filesCountInfo && filesCountInfo.total >= MINIMUM_FILES_TO_SHOW_CRITERIA_INPUTS
   return (
-    <Form>
-      <Row>
-        <Col md={5}>
-          <FileCriteriaSearchText criteria={criteria} onCriteriaChange={onCriteriaChange} />
-        </Col>
-        <Col className={styles['upload-files-container']}>
-          <DatasetUploadFilesButton />
-        </Col>
-      </Row>
-      <Row className={styles['criteria-section']}>
-        <Col>
-          <FileCriteriaFilters
-            criteria={criteria}
-            onCriteriaChange={onCriteriaChange}
-            filesCountInfo={filesCountInfo}
-          />
-        </Col>
-        <Col className={styles['sort-container']}>
-          <FileCriteriaSortBy criteria={criteria} onCriteriaChange={onCriteriaChange} />
-        </Col>
-      </Row>
-    </Form>
+    <div className={styles['criteria-section']}>
+      <Form>
+        <Row>
+          {showFileCriteriaInputs && (
+            <Col md={5}>
+              <FileCriteriaSearchText criteria={criteria} onCriteriaChange={onCriteriaChange} />
+            </Col>
+          )}
+          <Col className={styles['upload-files-container']}>
+            <DatasetUploadFilesButton />
+          </Col>
+        </Row>
+        {showFileCriteriaInputs && (
+          <Row>
+            <Col>
+              <FileCriteriaFilters
+                criteria={criteria}
+                onCriteriaChange={onCriteriaChange}
+                filesCountInfo={filesCountInfo}
+              />
+            </Col>
+            <Col className={styles['sort-container']}>
+              <FileCriteriaSortBy criteria={criteria} onCriteriaChange={onCriteriaChange} />
+            </Col>
+          </Row>
+        )}
+      </Form>
+    </div>
   )
 }
diff --git a/...sections/dataset/dataset-files/files-table/file-actions/edit-files-menu/EditFilesMenu.tsx b/...sections/dataset/dataset-files/files-table/file-actions/edit-files-menu/EditFilesMenu.tsx
@@ -30,7 +30,7 @@ export function EditFilesMenu({ files, fileSelection }: EditFilesMenuProps) {
       variant="secondary"
       id="edit-files-menu"
       title={t('actions.editFilesMenu.title')}
-      disabled={dataset.isLockedFromEdits || !dataset.hasValidTermsOfAccess}
+      disabled={dataset.checkIsLockedFromEdits(user.persistentId) || !dataset.hasValidTermsOfAccess}
       icon={<PencilFill className={styles.icon} />}>
       <EditFilesOptions files={files} fileSelection={fileSelection} />
     </DropdownButton>

diff --git a/.../file-actions/file-actions-cell/file-action-buttons/file-options-menu/FileOptionsMenu.tsx b/.../file-actions/file-actions-cell/file-action-buttons/file-options-menu/FileOptionsMenu.tsx
@@ -24,7 +24,7 @@ export function FileOptionsMenu({ file }: { file: File }) {
         <Tooltip placement="top" overlay={<span>{t('actions.optionsMenu.title')}</span>}>
           <Button
             id={`file-options-file-${file.id}`}
-            disabled={dataset.isLockedFromEdits}
+            disabled={dataset.checkIsLockedFromEdits(user.persistentId)}
             variant="secondary"
             icon={
               <ThreeDotsVertical
@@ -47,7 +47,7 @@ export function FileOptionsMenu({ file }: { file: File }) {
       <DropdownButton
         id={`file-options-file-${file.id}`}
         title=""
-        disabled={dataset.isLockedFromEdits}
+        disabled={dataset.checkIsLockedFromEdits(user.persistentId)}
         asButtonGroup
         variant="secondary"
         icon={<ThreeDotsVertical aria-label={t('actions.optionsMenu.title')} />}>

diff --git a/src/users/domain/models/User.ts b/src/users/domain/models/User.ts
@@ -1,3 +1,4 @@
 export interface User {
   name: string
+  persistentId: string
 }