Merge pull request #551 from IQSS/feature/492-publish-dataset-with-co…

…mpare-versions

Feature/492 publish dataset with compare versions

public/locales/en/dataset.json

@@ -117,10 +117,14 @@
     }
   },
   "publish": {
-    "draftQuestion": "Are you sure you want to publish this dataset? Once you do so, it must remain public.",
+    "draftQuestion": "Are you sure you want to publish this dataset? Once you do so, it must remain published.",
+    "draftSubtext": "This version of the dataset will be published with the following terms:",
     "previouslyReleasedQuestion": "Are you sure you want to republish this dataset?",
-    "releaseCollectionQuestion": "This dataset cannot be published until <a>{{parentCollectionName}}</a> is published. Would you like to publish both right now?",
-    "termsText": "To publish with custom Terms of Use, click the Cancel button and go to the Terms tab for this dataset.",
+    "previouslyReleasedSubtext": "Select if this is a minor or major version update.",
+    "releaseCollectionQuestion": "This dataset cannot be published until <a>{{parentCollectionName}}</a> is published. Would you like to publish both right now?  ",
+    "releaseCollectionSubtext": "Once you publish this dataset it must remain published.",
+    "requiresMajorReleaseSubtext": "Due to the nature of the changes to the current draft this will be a major release ({{versionNumber}})",
+    "termsText": "To change the terms for this version, click the Cancel button and go to the Terms tab for this dataset.",
     "selectVersion": "Select if this is a minor or major version update.",
     "continueButton": "Continue",
     "cancelButton": "Cancel",

src/dataset/domain/models/Dataset.ts

@@ -389,7 +389,8 @@ export class Dataset {
     public readonly requestedVersion?: string,
     public readonly publicationDate?: string,
     public readonly nextMajorVersion?: string,
-    public readonly nextMinorVersion?: string
+    public readonly nextMinorVersion?: string,
+    public readonly requiresMajorVersionUpdate?: boolean
   ) {}
 
   public checkIsLockedFromPublishing(userPersistentId: string): boolean {
@@ -480,7 +481,8 @@ export class Dataset {
 
       public readonly requestedVersion?: string,
       public readonly nextMajorVersionNumber?: string,
-      public readonly nextMinorVersionNumber?: string
+      public readonly nextMinorVersionNumber?: string,
+      public readonly requiresMajorVersionUpdate?: boolean
     ) {
       this.withAlerts()
     }
@@ -547,7 +549,8 @@ export class Dataset {
         this.requestedVersion,
         undefined,
         this.nextMajorVersionNumber,
-        this.nextMinorVersionNumber
+        this.nextMinorVersionNumber,
+        this.requiresMajorVersionUpdate
       )
     }
   }

src/dataset/domain/models/DatasetVersionDiff.ts

@@ -0,0 +1,48 @@
+export interface DatasetVersionDiff {
+  oldVersion: VersionSummary
+  newVersion: VersionSummary
+  metadataChanges?: MetadataBlockDiff[]
+  filesAdded?: FileSummary[]
+  filesRemoved?: FileSummary[]
+  fileChanges?: FileDiff[]
+  filesReplaced?: FileReplacement[]
+  termsOfAccess?: FieldDiff[]
+}
+
+export interface FileSummary {
+  fileName: string
+  MD5: string
+  type: string
+  fileId: number
+  filePath: string
+  description: string
+  isRestricted: boolean
+  tags: string[]
+  categories: string[]
+}
+
+export interface VersionSummary {
+  versionNumber: string
+  lastUpdatedDate: string
+}
+export interface MetadataBlockDiff {
+  blockName: string
+  changed: FieldDiff[]
+}
+
+export interface FileDiff {
+  fileName: string
+  md5: string
+  fileId: number
+  changed: FieldDiff[]
+}
+
+export interface FileReplacement {
+  oldFile: FileSummary
+  newFile: FileSummary
+}
+export interface FieldDiff {
+  fieldName: string
+  oldValue: string
+  newValue: string
+}

src/dataset/domain/repositories/DatasetRepository.ts

@@ -1,4 +1,5 @@
 import { Dataset, DatasetLock } from '../models/Dataset'
+import { DatasetVersionDiff } from '../models/DatasetVersionDiff'
 import { DatasetPaginationInfo } from '../models/DatasetPaginationInfo'
 import { DatasetDTO } from '../useCases/DTOs/DatasetDTO'
 import { DatasetsWithCount } from '../models/DatasetsWithCount'
@@ -8,6 +9,12 @@ export interface DatasetRepository {
   getByPersistentId: (persistentId: string, version?: string) => Promise<Dataset | undefined>
   getLocks(persistentId: string): Promise<DatasetLock[]>
   getByPrivateUrlToken: (privateUrlToken: string) => Promise<Dataset | undefined>
+  getVersionDiff: (
+    persistentId: string,
+    oldVersion: string,
+    newVersion: string
+  ) => Promise<DatasetVersionDiff>
+
   create: (dataset: DatasetDTO, collectionId: string) => Promise<{ persistentId: string }>
   updateMetadata: (datasetId: string | number, datasetDTO: DatasetDTO) => Promise<void>
   getAllWithCount: (

src/dataset/domain/useCases/getDatasetVersionDiff.ts

@@ -0,0 +1,15 @@
+import { DatasetRepository } from '../repositories/DatasetRepository'
+import { DatasetVersionDiff } from '../models/DatasetVersionDiff'
+
+export async function getDatasetVersionDiff(
+  datasetRepository: DatasetRepository,
+  persistentId: string,
+  oldVersion: string,
+  newVersion: string
+): Promise<DatasetVersionDiff | undefined> {
+  return datasetRepository
+    .getVersionDiff(persistentId, oldVersion, newVersion)
+    .catch((error: Error) => {
+      throw new Error(error.message)
+    })
+}

src/dataset/infrastructure/mappers/JSDatasetMapper.ts

@@ -5,8 +5,10 @@ import {
   DatasetMetadataBlocks as JSDatasetMetadataBlocks,
   DatasetMetadataFields as JSDatasetMetadataFields,
   DatasetUserPermissions as JSDatasetPermissions,
+  DatasetVersionDiff as JSDatasetVersionDiff,
   DvObjectOwnerNode as JSUpwardHierarchyNode
 } from '@iqss/dataverse-client-javascript'
+import { DatasetVersionDiff } from '../../domain/models/DatasetVersionDiff'
 import {
   Dataset,
   DatasetDownloadUrls,
@@ -44,7 +46,8 @@ export class JSDatasetMapper {
     requestedVersion?: string,
     privateUrl?: PrivateUrl,
     latestPublishedVersionMajorNumber?: number,
-    latestPublishedVersionMinorNumber?: number
+    latestPublishedVersionMinorNumber?: number,
+    datasetVersionDiff?: JSDatasetVersionDiff
   ): Dataset {
     const version = JSDatasetVersionMapper.toVersion(
       jsDataset.versionId,
@@ -87,7 +90,8 @@ export class JSDatasetMapper {
       JSDatasetMapper.toNextMinorVersion(
         latestPublishedVersionMajorNumber,
         latestPublishedVersionMinorNumber
-      )
+      ),
+      JSDatasetMapper.toRequiresMajorVersionUpdate(datasetVersionDiff)
     ).build()
   }
 
@@ -116,6 +120,31 @@ export class JSDatasetMapper {
     return nextMinorVersion
   }
 
+  static toRequiresMajorVersionUpdate(
+    datasetVersionDiff: JSDatasetVersionDiff | undefined
+  ): boolean {
+    if (datasetVersionDiff === undefined) {
+      return false
+    }
+    const required =
+      ((datasetVersionDiff.filesAdded && datasetVersionDiff.filesAdded.length > 0) ||
+        (datasetVersionDiff.filesRemoved && datasetVersionDiff.filesRemoved.length > 0) ||
+        (datasetVersionDiff.filesReplaced && datasetVersionDiff.filesReplaced.length > 0)) ??
+      false
+    return required
+  }
+  static toDatasetVersionDiff(jsDatasetVersionDiff: JSDatasetVersionDiff): DatasetVersionDiff {
+    return {
+      oldVersion: jsDatasetVersionDiff.oldVersion,
+      newVersion: jsDatasetVersionDiff.newVersion,
+      metadataChanges: jsDatasetVersionDiff.metadataChanges,
+      filesAdded: jsDatasetVersionDiff.filesAdded,
+      filesRemoved: jsDatasetVersionDiff.filesRemoved,
+      fileChanges: jsDatasetVersionDiff.fileChanges,
+      filesReplaced: jsDatasetVersionDiff.filesReplaced,
+      termsOfAccess: jsDatasetVersionDiff.termsOfAccess
+    }
+  }
   static toDatasetTitle(jsDatasetMetadataBlocks: JSDatasetMetadataBlocks): string {
     return jsDatasetMetadataBlocks[0].fields.title
   }

src/dataset/infrastructure/repositories/DatasetJSDataverseRepository.ts

@@ -1,5 +1,6 @@
 import { DatasetRepository } from '../../domain/repositories/DatasetRepository'
 import { Dataset, DatasetLock, DatasetNonNumericVersion } from '../../domain/models/Dataset'
+import { DatasetVersionDiff } from '../../domain/models/DatasetVersionDiff'
 import {
   createDataset,
   CreatedDatasetIdentifiers as JSDatasetIdentifiers,
@@ -10,6 +11,7 @@ import {
   DatasetUserPermissions as JSDatasetPermissions,
   DatasetVersionState,
   FileDownloadSizeMode,
+  DatasetVersionDiff as JSDatasetVersionDiff,
   getAllDatasetPreviews,
   getDataset,
   getDatasetCitation,
@@ -23,7 +25,8 @@ import {
   ReadError,
   updateDataset,
   VersionUpdateType as JSVersionUpdateType,
-  WriteError
+  WriteError,
+  getDatasetVersionDiff
 } from '@iqss/dataverse-client-javascript'
 import { JSDatasetMapper } from '../mappers/JSDatasetMapper'
 import { DatasetPaginationInfo } from '../../domain/models/DatasetPaginationInfo'
@@ -46,6 +49,7 @@ interface IDatasetDetails {
   jsDatasetFilesTotalArchivalDownloadSize: number
   latestPublishedVersionMajorNumber?: number
   latestPublishedVersionMinorNumber?: number
+  datasetVersionDiff?: JSDatasetVersionDiff
 }
 
 export class DatasetJSDataverseRepository implements DatasetRepository {
@@ -66,6 +70,18 @@ export class DatasetJSDataverseRepository implements DatasetRepository {
         }
       })
   }
+  getVersionDiff(
+    persistentId: string,
+    oldVersion: string,
+    newVersion: string
+  ): Promise<DatasetVersionDiff> {
+    return getDatasetVersionDiff
+      .execute(persistentId, oldVersion, newVersion)
+      .then((jsDatasetVersionDiff) => {
+        return JSDatasetMapper.toDatasetVersionDiff(jsDatasetVersionDiff)
+      })
+  }
+
   private async getLatestPublishedVersionNumbers(
     datasetDetails: IDatasetDetails
   ): Promise<IDatasetDetails> {
@@ -82,6 +98,19 @@ export class DatasetJSDataverseRepository implements DatasetRepository {
     return datasetDetails
   }
 
+  private async getVersionDiffDetails(datasetDetails: IDatasetDetails): Promise<IDatasetDetails> {
+    await this.getVersionDiff(
+      datasetDetails.jsDataset.persistentId,
+      DatasetNonNumericVersion.LATEST_PUBLISHED,
+      DatasetNonNumericVersion.DRAFT
+    ).then((datasetVersionDiff) => {
+      datasetDetails.datasetVersionDiff = datasetVersionDiff
+      return datasetDetails
+    })
+
+    return datasetDetails
+  }
+
   private async fetchDatasetDetails(
     jsDataset: JSDataset,
     version?: string
@@ -161,8 +190,11 @@ export class DatasetJSDataverseRepository implements DatasetRepository {
           datasetDetails.jsDataset.publicationDate !== undefined
         ) {
           // If the dataset is a draft, but has a publication date, then we need the version
-          // numbers of the latest published version to show in the "Publish" button
-          return this.getLatestPublishedVersionNumbers(datasetDetails)
+          // numbers of the latest published version and the datasetVersionDiff,
+          // for the PublishDatasetModal component.
+          return this.getLatestPublishedVersionNumbers(datasetDetails).then((updatedDetails) =>
+            this.getVersionDiffDetails(updatedDetails)
+          )
         } else {
           return datasetDetails
         }
@@ -179,7 +211,8 @@ export class DatasetJSDataverseRepository implements DatasetRepository {
           requestedVersion,
           undefined,
           datasetDetails.latestPublishedVersionMajorNumber,
-          datasetDetails.latestPublishedVersionMinorNumber
+          datasetDetails.latestPublishedVersionMinorNumber,
+          datasetDetails.datasetVersionDiff
         )
       })
       .catch((error: ReadError) => {

src/sections/dataset/dataset-action-buttons/publish-dataset-menu/PublishDatasetMenu.tsx

@@ -47,6 +47,7 @@ export function PublishDatasetMenu({
         releasedVersionExists={dataset.version.someDatasetVersionHasBeenReleased}
         nextMajorVersion={dataset.nextMajorVersion}
         nextMinorVersion={dataset.nextMinorVersion}
+        requiresMajorVersionUpdate={dataset.requiresMajorVersionUpdate}
         handleClose={() => setShowModal(false)}
       />
 

src/sections/dataset/publish-dataset/PublishDatasetHelpText.module.scss

@@ -4,3 +4,7 @@
   margin-bottom: 0;
   color: $dv-warning-color;
 }
+
+.secondaryText {
+  color: $dv-subtext-color;
+}