feat(IntegrationDatasetLocks): integrate locks userPersistentId

IQSS · Nov 6, 2023 · 892109a · 892109a
1 parent 5e9b75e
commit 892109a
Show file tree

Hide file tree

Showing 14 changed files with 155 additions and 63 deletions.
diff --git a/src/dataset/domain/models/Dataset.ts b/src/dataset/domain/models/Dataset.ts
@@ -259,7 +259,7 @@ export interface DatasetPermissions {
 }
 
 export interface DatasetLock {
-  id: number
+  userPersistentId: string
   reason: DatasetLockReason
 }
 
@@ -302,8 +302,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 {
@@ -314,12 +314,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
@@ -193,7 +193,7 @@ export class JSDatasetMapper {
   static toLocks(jsDatasetLocks: JSDatasetLock[]): DatasetLock[] {
     return jsDatasetLocks.map((jsDatasetLock) => {
       return {
-        id: 0,
+        userPersistentId: jsDatasetLock.userId,
         reason: jsDatasetLock.lockType as unknown as DatasetLockReason
       }
     })

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/...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/tests/component/dataset/domain/models/DatasetMother.ts b/tests/component/dataset/domain/models/DatasetMother.ts
@@ -166,7 +166,7 @@ export class DatasetPermissionsMother {
 export class DatasetLockMother {
   static create(props?: Partial<DatasetLock>): DatasetLock {
     return {
-      id: faker.datatype.number(),
+      userPersistentId: faker.internet.userName(),
       reason: faker.helpers.arrayElement(Object.values(DatasetLockReason)),
       ...props
     }

diff --git a/tests/component/dataset/infrastructure/mappers/JSDatasetMapper.spec.ts b/tests/component/dataset/infrastructure/mappers/JSDatasetMapper.spec.ts
@@ -1,11 +1,16 @@
 import chai from 'chai'
 import chaiAsPromised from 'chai-as-promised'
 import { JSDatasetMapper } from '../../../../../src/dataset/infrastructure/mappers/JSDatasetMapper'
-import { DatasetVersionState } from '@iqss/dataverse-client-javascript'
+import {
+  DatasetLockType,
+  DatasetVersionState,
+  DatasetLock as JSDatasetLock
+} from '@iqss/dataverse-client-javascript'
 import {
   CitationMetadataBlock,
   DatasetMetadataBlock
 } from '@iqss/dataverse-client-javascript/dist/datasets/domain/models/Dataset'
+import { DatasetLockReason } from '../../../../../src/dataset/domain/models/Dataset'
 
 chai.use(chaiAsPromised)
 const expect = chai.expect
@@ -51,6 +56,13 @@ const jsDataset = {
 const citation =
   'Finch, Fiona, 2023, "Darwin\'s Finches", <a href="https://doi.org/10.5072/FK2/B4B2MJ" target="_blank">https://doi.org/10.5072/FK2/B4B2MJ</a>, Root, DRAFT VERSION'
 const datasetSummaryFields = ['dsDescription', 'subject', 'keyword', 'publication', 'notesText']
+const jsDatasetLocks: JSDatasetLock[] = [
+  {
+    lockType: DatasetLockType.IN_REVIEW,
+    userId: 'dataverseAdmin',
+    datasetPersistentId: 'doi:10.5072/FK2/B4B2MJ'
+  }
+]
 const expectedDataset = {
   persistentId: 'doi:10.5072/FK2/B4B2MJ',
   version: {
@@ -116,7 +128,12 @@ const expectedDataset = {
     canManageFilesPermissions: true,
     canDeleteDataset: true
   },
-  locks: [],
+  locks: [
+    {
+      userPersistentId: 'dataverseAdmin',
+      reason: DatasetLockReason.IN_REVIEW
+    }
+  ],
   hasValidTermsOfAccess: true,
   isValid: true,
   isReleased: false,
@@ -176,7 +193,12 @@ const expectedDatasetAlternateVersion = {
     uri: 'http://creativecommons.org/publicdomain/zero/1.0',
     iconUri: 'https://licensebuttons.net/p/zero/1.0/88x31.png'
   },
-  locks: [],
+  locks: [
+    {
+      userPersistentId: 'dataverseAdmin',
+      reason: DatasetLockReason.IN_REVIEW
+    }
+  ],
   metadataBlocks: [
     {
       name: 'citation',
@@ -208,14 +230,20 @@ const expectedDatasetAlternateVersion = {
 }
 describe('JS Dataset Mapper', () => {
   it('maps jsDataset model to the domain Dataset model', () => {
-    const mapped = JSDatasetMapper.toDataset(jsDataset, citation, datasetSummaryFields)
+    const mapped = JSDatasetMapper.toDataset(
+      jsDataset,
+      citation,
+      datasetSummaryFields,
+      jsDatasetLocks
+    )
     expect(expectedDataset).to.deep.equal(mapped)
   })
   it('maps jsDataset model to the domain Dataset model for alternate version', () => {
     const mappedWithAlternate = JSDatasetMapper.toDataset(
       jsDataset,
       citation,
       datasetSummaryFields,
+      jsDatasetLocks,
       '4.0'
     )
 
@@ -255,7 +283,8 @@ describe('JS Dataset Mapper', () => {
       JSDatasetMapper.toDataset(
         jsDatasetWithAlternativePersistentId,
         citation,
-        datasetSummaryFields
+        datasetSummaryFields,
+        jsDatasetLocks
       )
     )
   })
@@ -290,7 +319,12 @@ describe('JS Dataset Mapper', () => {
     }
 
     expect(expectedDatasetWithCitationDate).to.deep.equal(
-      JSDatasetMapper.toDataset(jsDatasetWithCitationDate, citation, datasetSummaryFields)
+      JSDatasetMapper.toDataset(
+        jsDatasetWithCitationDate,
+        citation,
+        datasetSummaryFields,
+        jsDatasetLocks
+      )
     )
   })
 
@@ -323,7 +357,12 @@ describe('JS Dataset Mapper', () => {
       ]
     }
     expect(expectedDatasetWithPublicationDate).to.deep.equal(
-      JSDatasetMapper.toDataset(jsDatasetWithPublicationDate, citation, datasetSummaryFields)
+      JSDatasetMapper.toDataset(
+        jsDatasetWithPublicationDate,
+        citation,
+        datasetSummaryFields,
+        jsDatasetLocks
+      )
     )
   })
 })
diff --git a/...ponent/sections/dataset/dataset-action-buttons/edit-dataset-menu/EditDatasetMenu.spec.tsx b/...ponent/sections/dataset/dataset-action-buttons/edit-dataset-menu/EditDatasetMenu.spec.tsx
@@ -16,7 +16,7 @@ describe('EditDatasetMenu', () => {
       isReleased: true
     })
 
-    cy.customMount(<EditDatasetMenu dataset={dataset} />)
+    cy.mountAuthenticated(<EditDatasetMenu dataset={dataset} />)
 
     cy.findByRole('button', { name: 'Edit Dataset' }).should('exist').should('be.enabled').click()
 
@@ -30,13 +30,27 @@ describe('EditDatasetMenu', () => {
     cy.findByRole('button', { name: 'Deaccession Dataset' }).should('exist')
   })
 
+  it('does not render if the user is not authenticated', () => {
+    const dataset = DatasetMother.create({
+      permissions: DatasetPermissionsMother.createWithAllAllowed(),
+      locks: [],
+      hasValidTermsOfAccess: true,
+      version: DatasetVersionMother.createReleasedWithLatestVersionIsADraft(),
+      isReleased: true
+    })
+
+    cy.customMount(<EditDatasetMenu dataset={dataset} />)
+
+    cy.findByRole('button', { name: 'Edit Dataset' }).should('not.exist')
+  })
+
   it('does not render the EditDatasetMenu if the user does not have update dataset permissions', () => {
     const dataset = DatasetMother.create({
       permissions: DatasetPermissionsMother.createWithUpdateDatasetNotAllowed(),
       locks: []
     })
 
-    cy.customMount(<EditDatasetMenu dataset={dataset} />)
+    cy.mountAuthenticated(<EditDatasetMenu dataset={dataset} />)
 
     cy.findByRole('button', { name: 'Edit Dataset' }).should('not.exist')
   })
@@ -47,7 +61,7 @@ describe('EditDatasetMenu', () => {
       locks: [DatasetLockMother.createLockedInEditInProgress()]
     })
 
-    cy.customMount(<EditDatasetMenu dataset={dataset} />)
+    cy.mountAuthenticated(<EditDatasetMenu dataset={dataset} />)
 
     cy.findByRole('button', { name: 'Edit Dataset' }).should('exist').should('be.disabled')
   })
@@ -59,7 +73,7 @@ describe('EditDatasetMenu', () => {
       hasValidTermsOfAccess: true
     })
 
-    cy.customMount(<EditDatasetMenu dataset={dataset} />)
+    cy.mountAuthenticated(<EditDatasetMenu dataset={dataset} />)
 
     cy.findByRole('button', { name: 'Edit Dataset' }).click()
     cy.findByRole('button', { name: 'Files (Upload)' })
@@ -77,7 +91,7 @@ describe('EditDatasetMenu', () => {
       hasValidTermsOfAccess: false
     })
 
-    cy.customMount(<EditDatasetMenu dataset={dataset} />)
+    cy.mountAuthenticated(<EditDatasetMenu dataset={dataset} />)
 
     cy.findByRole('button', { name: 'Edit Dataset' }).click()
     cy.findByRole('button', { name: 'Files (Upload)' })