Merge pull request #11464 from IQSS/11438-fix-file-version-summary

Fix File Version Summary API

Author: ofahimIQSS

doc/release-notes/11438-fix-file-version-summary.md

@@ -0,0 +1,3 @@
+### File Version Summary Bug fix
+
+Fixes an issue where the deaccessionedReason was missing in the fileDifferenceSummary json object returned by API GET "$SERVER_URL/api/files/{ID}/versionDifferences"

src/main/java/edu/harvard/iq/dataverse/FileMetadataVersionsHelper.java

@@ -78,27 +78,20 @@ public JsonObjectBuilder jsonDataFileVersions(FileMetadata fileMetadata) {
                 .add("versionState", fileMetadata.getDatasetVersion().getVersionState().name())
                 .add("summary", fileMetadata.getDatasetVersion().getVersionNote())
                 .add("contributors", fileMetadata.getContributorNames())
+                .add("publishedDate", fileMetadata.getDataFile().getPublicationDate() != null ? fileMetadata.getDataFile().getPublicationDate().toString() : null)
             ;
         }
         if (fileMetadata.getDataFile() != null) {
             job.add("datafileId", fileMetadata.getDataFile().getId());
             job.add("persistentId", (fileMetadata.getDataFile().getGlobalId() != null ? fileMetadata.getDataFile().getGlobalId().asString() : ""));
-            if (fileMetadata.getDataFile().getPublicationDate() != null) {
-                job.add("publishedDate", fileMetadata.getDataFile().getPublicationDate().toString());
-            }
         }
         FileVersionDifference fvd = fileMetadata.getFileVersionDifference();
         if (fvd != null) {
             List<FileVersionDifference.FileDifferenceSummaryGroup> groups = fvd.getDifferenceSummaryGroups();
-            JsonObjectBuilder fileDifferenceSummary = jsonObjectBuilder();
-
-            if (fileMetadata.getDatasetVersion().isDeaccessioned() && fileMetadata.getDatasetVersion().getVersionNote() != null) {
-                fileDifferenceSummary.add("deaccessionedReason", fileMetadata.getDatasetVersion().getVersionNote());
-            }
-            String fileAction = getFileAction(fvd.getOriginalFileMetadata(), fvd.getNewFileMetadata());
-            if (fileAction != null) {
-                fileDifferenceSummary.add("file", fileAction);
-            }
+            JsonObjectBuilder fileDifferenceSummary = jsonObjectBuilder()
+                .add("versionNote", fileMetadata.getDatasetVersion().getVersionNote())
+                .add("deaccessionedReason", fileMetadata.getDatasetVersion().getDeaccessionNote())
+                .add("file", getFileAction(fvd.getOriginalFileMetadata(), fvd.getNewFileMetadata()));
 
             if (groups != null && !groups.isEmpty()) {
                 List<FileVersionDifference.FileDifferenceSummaryGroup> sortedGroups = groups.stream()

src/test/java/edu/harvard/iq/dataverse/api/FilesIT.java

@@ -1551,6 +1551,18 @@ public void GetFileVersionDifferences() {
                 .body("data[1].fileDifferenceSummary.file", equalTo("Added"))
                 .body("data[1].datafileId", equalTo(Integer.parseInt(dataFileId)))
                 .statusCode(OK.getStatusCode());
+
+        // The following tests cover cases where the dataset version is deaccessioned
+        Response deaccessionDatasetResponse = UtilIT.deaccessionDataset(datasetId, "1.0", "Test reason", null, superUserApiToken);
+        deaccessionDatasetResponse.then().assertThat().statusCode(OK.getStatusCode());
+        getFileDataResponse = UtilIT.getFileVersionDifferences(replacedDataFileId, regularApiToken);
+        getFileDataResponse.prettyPrint();
+        getFileDataResponse.then().assertThat()
+                .body("status", equalTo("OK"))
+                .body("data[1].datasetVersion", equalTo("1.0"))
+                .body("data[1].fileDifferenceSummary.deaccessionedReason", equalTo("Test reason"))
+                .body("data[1].fileDifferenceSummary.file", equalTo("Added"))
+                .statusCode(OK.getStatusCode());
     }
     @Test
     public void testGetFileInfo() {