feat: add missing feature and hide version note

ChengShi-1 · ChengShi-1 · commit ce15802c9392 · 2025-04-03T16:50:10.000-04:00
diff --git a/public/locales/en/dataset.json b/public/locales/en/dataset.json
@@ -232,14 +232,16 @@
     "files": "Files",
     "citationMetadata": "Citation Metadata",
     "additionalCitationMetadata": "Additional Citation Metadata",
+    "termsAccess": "Terms of Use and Access",
     "fileID": "File ID",
     "MD5": "MD5",
     "name": "Name",
     "type": "Type",
     "description": "Description",
     "access": "Access",
     "needTwoVersions": "Please select two versions to view the differences.",
-    "viewDetails": "View Details"
+    "viewDetails": "View Details",
+    "replace": "File Replace"
   },
   "getDatasetVersionDiffError": "Error Fetching Dataset Version Differences",
   "datasetVersionSummary": {
@@ -263,6 +265,6 @@
       "fileMetadataChanged": "File Metadata Changed: {{count}}",
       "variableMetadataChanged": "Variable Metadata Changed: {{count}}"
     },
-    "termsAccessChanged": "Terms Access: Changed"
+    "termsAccessChanged": "Changed"
   }
 }
diff --git a/src/dataset/domain/models/DatasetVersionDiff.ts b/src/dataset/domain/models/DatasetVersionDiff.ts
@@ -6,7 +6,9 @@ export interface DatasetVersionDiff {
   filesRemoved?: FileSummary[]
   fileChanges?: FileDiff[]
   filesReplaced?: FileReplacement[]
-  termsOfAccess?: FieldDiff[]
+  termsOfAccess?: {
+    changed: FieldDiff[]
+  }
 }
 
 export interface FileSummary {
@@ -33,6 +35,7 @@ export interface MetadataBlockDiff {
 export interface FileDiff {
   fileName: string
   md5: string
+  MD5?: string
   fileId: number
   changed: FieldDiff[]
 }
diff --git a/src/sections/dataset/dataset-versions/DatasetVersions.tsx b/src/sections/dataset/dataset-versions/DatasetVersions.tsx
@@ -83,7 +83,7 @@ export function DatasetVersions({ datasetRepository, datasetId }: DatasetVersion
               )}
               <th>{t('versions.datasetVersions')}</th>
               <th>{t('versions.summary')}</th>
-              <th>{t('versions.versionNote')}</th>
+              {/* <th>{t('versions.versionNote')}</th> */}
               <th>{t('versions.contributors')}</th>
               <th>{t('versions.publishedOn')}</th>
             </tr>
@@ -126,7 +126,7 @@ export function DatasetVersions({ datasetRepository, datasetId }: DatasetVersion
                       )}
                     </p>
                   </td>
-                  <td>{/* TODO: version note API is missing */}</td>
+                  {/* <td>{ TODO: version note API is missing }</td> */}
                   <td>{dataset.contributors}</td>
                   <td>{dataset.publishedOn}</td>
                 </tr>
diff --git a/src/sections/dataset/dataset-versions/useDatasetVersionSummaryDescription.tsx b/src/sections/dataset/dataset-versions/useDatasetVersionSummaryDescription.tsx
@@ -106,7 +106,8 @@ export const useDatasetVersionSummaryDescription = (
       }
 
       case 'termsAccessChanged':
-        if (value) description[key] = t('datasetVersionSummary.termsAccessChanged')
+        if (value)
+          description['Terms of Use/Access'] = t('datasetVersionSummary.termsAccessChanged')
         break
     }
   })
diff --git a/src/sections/dataset/dataset-versions/view-difference/DatasetVersionsDifferenceTable.tsx b/src/sections/dataset/dataset-versions/view-difference/DatasetVersionsDifferenceTable.tsx
@@ -4,15 +4,24 @@ import { Table } from '@iqss/dataverse-design-system'
 import { DateHelper } from '@/shared/helpers/DateHelper'
 import styles from './DatasetVersionsDifferenceTable.module.scss'
 
-interface atasetVersionsDifferenceTableProps {
+interface datasetVersionsDifferenceTableProps {
   differences: DatasetVersionDiff
 }
 
 export const DatasetVersionsDifferenceTable = ({
   differences
-}: atasetVersionsDifferenceTableProps) => {
+}: datasetVersionsDifferenceTableProps) => {
   const { t } = useTranslation('dataset')
-  const { oldVersion, newVersion, metadataChanges, filesAdded, filesRemoved } = differences
+  const {
+    oldVersion,
+    newVersion,
+    metadataChanges,
+    filesAdded,
+    filesRemoved,
+    fileChanges,
+    termsOfAccess,
+    filesReplaced
+  } = differences
 
   const citationMetadata = metadataChanges?.find((m) => m.blockName === 'Citation Metadata')
 
@@ -57,7 +66,7 @@ export const DatasetVersionsDifferenceTable = ({
         </Table>
       )}
 
-      {(filesAdded || filesRemoved) && (
+      {(filesAdded || filesRemoved || fileChanges || filesRemoved) && (
         <Table bordered>
           <thead>
             <tr>
@@ -103,6 +112,74 @@ export const DatasetVersionsDifferenceTable = ({
                 </td>
               </tr>
             ))}
+            {fileChanges &&
+              fileChanges.map((file) => (
+                <tr key={`changed-${file.fileId}`}>
+                  <td>
+                    {t('versions.fileID')} {file.fileId}
+                    <br />
+                    {t('versions.MD5')} {file.MD5}
+                  </td>
+                  <td>
+                    {file.changed.map((change) => (
+                      <div key={change.fieldName}>
+                        {change.fieldName}: {change.oldValue || ''}
+                      </div>
+                    ))}
+                  </td>
+                  <td>
+                    {file.changed.map((change) => (
+                      <div key={change.fieldName}>
+                        {change.fieldName}: {change.newValue || ''}
+                      </div>
+                    ))}
+                  </td>
+                </tr>
+              ))}
+          </tbody>
+        </Table>
+      )}
+
+      {filesReplaced && (
+        <Table bordered>
+          <tbody>
+            {filesReplaced.map(({ oldFile, newFile }) => (
+              <tr key={`replaced-${oldFile.fileId}-${newFile.fileId}`}>
+                <td>{t('versions.replace')}</td>
+                <td>
+                  {t('versions.name')}: {oldFile.fileName}
+                  <br />
+                  {t('versions.type')}: {oldFile.type || ''}
+                  <br />
+                  {t('versions.description')}: {oldFile.description || ''}
+                  <br />
+                </td>
+                <td>
+                  {t('versions.fileID')} {newFile.fileId}
+                  <br />
+                  {t('versions.MD5')} {newFile.MD5} <br />
+                  {t('versions.name')}: {newFile.fileName}
+                </td>
+              </tr>
+            ))}
+          </tbody>
+        </Table>
+      )}
+      {termsOfAccess && (
+        <Table bordered>
+          <thead>
+            <tr>
+              <th>{t('versions.termsAccess')}</th>
+            </tr>
+          </thead>
+          <tbody>
+            {termsOfAccess.changed.map((term) => (
+              <tr key={term.fieldName}>
+                <td>{term.fieldName}</td>
+                <td>{term.oldValue || ''}</td>
+                <td>{term.newValue || ''}</td>
+              </tr>
+            ))}
           </tbody>
         </Table>
       )}
diff --git a/tests/component/dataset/domain/models/DatasetVersionDiffMother.ts b/tests/component/dataset/domain/models/DatasetVersionDiffMother.ts
@@ -61,7 +61,7 @@ export class DatasetVersionDiffMother {
       ],
       filesRemoved: [
         {
-          fileName: 'file1',
+          fileName: 'file10',
           MD5: faker.datatype.uuid(),
           type: '',
           fileId: faker.datatype.number(),
@@ -71,7 +71,56 @@ export class DatasetVersionDiffMother {
           tags: [],
           categories: []
         }
-      ]
+      ],
+      filesChanges: [
+        {
+          fileName: 'file4',
+          md5: faker.datatype.uuid(),
+          fileId: faker.datatype.number(),
+          changed: [
+            {
+              fieldName: 'isRestricted',
+              oldValue: 'old title',
+              newValue: 'new title'
+            }
+          ]
+        }
+      ],
+      fileReplaced: [
+        {
+          oldFile: {
+            fileName: 'file5',
+            MD5: faker.datatype.uuid(),
+            type: '',
+            fileId: faker.datatype.number(),
+            description: 'file5 description',
+            isRestricted: faker.datatype.boolean(),
+            filePath: '',
+            tags: [],
+            categories: []
+          },
+          newFile: {
+            fileName: 'file6',
+            MD5: faker.datatype.uuid(),
+            type: '',
+            fileId: faker.datatype.number(),
+            description: 'file6 description',
+            isRestricted: faker.datatype.boolean(),
+            filePath: '',
+            tags: [],
+            categories: []
+          }
+        }
+      ],
+      termsOfAccess: {
+        changed: [
+          {
+            fieldName: 'Terms of Access for Restricted Files',
+            oldValue: 'old value',
+            newValue: 'new value'
+          }
+        ]
+      }
     }
     return datasetVersionDiff
   }
diff --git a/tests/component/sections/dataset/Dataset.spec.tsx b/tests/component/sections/dataset/Dataset.spec.tsx
@@ -473,7 +473,7 @@ describe('Dataset', () => {
     versionsTab.should('exist').click()
     cy.findByText('Dataset Version').should('exist')
     cy.findByText('Summary').should('exist')
-    cy.findByText('Version Note').should('exist')
+    // cy.findByText('Version Note').should('exist')
     cy.findByText('Contributors').should('exist')
     cy.findByText('Published On').should('exist')
   })
diff --git a/tests/component/sections/dataset/dataset-versions/DatasetVersions.spec.tsx b/tests/component/sections/dataset/dataset-versions/DatasetVersions.spec.tsx
@@ -43,7 +43,7 @@ describe('DatasetVersions', () => {
 
     cy.contains('th', 'Dataset Version').should('exist')
     cy.contains('th', 'Summary').should('exist')
-    cy.contains('th', 'Version Note').should('exist')
+    // cy.contains('th', 'Version Note').should('exist')
     cy.contains('th', 'Contributors').should('exist')
     cy.contains('th', 'Published On').should('exist')
     cy.findByRole('button', { name: 'View Differences' }).should('not.exist')
@@ -59,12 +59,12 @@ describe('DatasetVersions', () => {
     datasetsRepository.getVersionDiff = cy.stub().resolves(datasetVersionDiff)
   })
 
-  it.only('should render the dataset versions table with view differences button and checkbox', () => {
+  it('should render the dataset versions table with view differences button and checkbox', () => {
     cy.findByTestId('dataset-versions-table').should('exist')
 
     cy.contains('th', 'Dataset Version').should('exist')
     cy.contains('th', 'Summary').should('exist')
-    cy.contains('th', 'Version Note').should('exist')
+    // cy.contains('th', 'Version Note').should('exist')
     cy.contains('th', 'Contributors').should('exist')
     cy.contains('th', 'Published On').should('exist')
     cy.findAllByTestId('select-checkbox').first().should('exist').check().should('be.checked')
@@ -98,7 +98,7 @@ describe('DatasetVersions', () => {
     cy.findByTestId('dataset-versions-table').should('exist')
     cy.contains('th', 'Dataset Version').should('exist')
     cy.contains('th', 'Summary').should('exist')
-    cy.contains('th', 'Version Note').should('exist')
+    // cy.contains('th', 'Version Note').should('exist')
     cy.contains('th', 'Contributors').should('exist')
     cy.contains('th', 'Published On').should('exist')
     cy.findAllByTestId('select-checkbox').first().should('exist').check().should('be.checked')
diff --git a/tests/component/sections/dataset/dataset-versions/DatasetVersionsViewDifferencesModal.spec.tsx b/tests/component/sections/dataset/dataset-versions/DatasetVersionsViewDifferencesModal.spec.tsx
@@ -56,7 +56,7 @@ const datasetVersionDiff: DatasetVersionDiff | undefined = {
       fileName: 'blob (5)',
       MD5: '53d3d10e00812f7c55e0c9c3935f3769',
       type: '',
-      fileId: 40,
+      fileId: 41,
       description: '',
       isRestricted: true,
       filePath: '',
@@ -98,7 +98,30 @@ const datasetVersionDiff: DatasetVersionDiff | undefined = {
       tags: [],
       categories: []
     }
-  ]
+  ],
+  fileChanges: [
+    {
+      fileName: 'blob (2)',
+      md5: '53d3d10e00812f7c55e0c9c3935f3769',
+      fileId: 40,
+      changed: [
+        {
+          fieldName: 'Restricted',
+          oldValue: 'false',
+          newValue: 'true'
+        }
+      ]
+    }
+  ],
+  termsOfAccess: {
+    changed: [
+      {
+        fieldName: 'Terms of Access',
+        oldValue: 'Public',
+        newValue: 'Restricted'
+      }
+    ]
+  }
 }
 
 describe('DatasetVersions', () => {
@@ -116,12 +139,25 @@ describe('DatasetVersions', () => {
 
     cy.get('table').should('exist')
     cy.get('table').find('tbody').first().find('tr').should('have.length', 1) // for versions info
-    const numOfTbody = (datasetVersionDiff?.metadataChanges?.length ?? 0) + 2 // add extra 2 for Versions info(header) and Files tables
+    const numOfTermsOfAccess = datasetVersionDiff?.termsOfAccess ? 1 : 0
+    const numOfTbody = (datasetVersionDiff?.metadataChanges?.length ?? 0) + numOfTermsOfAccess + 2 // add extra 2 for Versions info(header) and Files tables
     cy.get('table').find('tbody').should('have.length', numOfTbody)
+
     const numOfFilesTr =
-      (datasetVersionDiff?.filesRemoved?.length ?? 0) +
-      (datasetVersionDiff?.filesAdded?.length ?? 0)
-    cy.get('table').find('tbody').last().find('tr').should('have.length', numOfFilesTr)
+      (datasetVersionDiff.filesRemoved?.length ?? 0) +
+      (datasetVersionDiff.filesAdded?.length ?? 0) +
+      (datasetVersionDiff.fileChanges?.length ?? 0) +
+      (datasetVersionDiff.filesReplaced?.length ?? 0)
+
+    cy.get('table').find('tbody').eq(2).find('tr').should('have.length', numOfFilesTr)
+
+    if (datasetVersionDiff.termsOfAccess) {
+      cy.get('table')
+        .find('tbody')
+        .last()
+        .find('tr')
+        .should('have.length', datasetVersionDiff.termsOfAccess?.changed.length)
+    }
   })
 
   it('should render a correct file info', () => {
@@ -142,7 +178,7 @@ describe('DatasetVersions', () => {
     const text = `File ID ${FileId}MD5 ${MD5}`
     cy.get('table')
       .find('tbody')
-      .last()
+      .eq(2)
       .find('tr')
       .first()
       .find('td')
@@ -160,14 +196,15 @@ describe('DatasetVersions', () => {
         datasetVersionDifferences={{
           ...datasetVersionDiff,
           filesRemoved: [],
-          filesAdded: []
+          filesAdded: [],
+          fileChanges: [],
+          filesReplaced: []
         }}
       />
     )
 
     cy.get('table').should('exist')
-    cy.get('table').find('tbody').should('have.length', 3)
-    cy.get('table').find('tbody').last().find('tr').should('have.length', 0)
+    cy.get('table').find('tbody').eq(2).find('tr').should('have.length', 0)
   })
 
   it('should render a modal with the differences between two versions', () => {
diff --git a/tests/component/sections/dataset/dataset-versions/useDatasetVersionSummaryDescription.spec.tsx b/tests/component/sections/dataset/dataset-versions/useDatasetVersionSummaryDescription.spec.tsx

Original file line number	Diff line number	Diff line change
`@@ -106,7 +106,8 @@ export const useDatasetVersionSummaryDescription = (`
`106`	`106`	`}`
`107`	`107`
`108`	`108`	`case 'termsAccessChanged':`
`109`		`- if (value) description[key] = t('datasetVersionSummary.termsAccessChanged')`
	`109`	`+ if (value)`
	`110`	`+ description['Terms of Use/Access'] = t('datasetVersionSummary.termsAccessChanged')`
`110`	`111`	`break`
`111`	`112`	`}`
`112`	`113`	`})`