Merge pull request #11354 from IQSS/11323-includeDeaccesioned-compare-ds-versions

11323 include deaccessioned versions in summary of compare dataset versions

Author: ofahimIQSS

doc/sphinx-guides/source/api/native-api.rst

@@ -2016,6 +2016,17 @@ The fully expanded example above (without environment variables) looks like this
 
   curl "https://demo.dataverse.org/api/datasets/24/versions/:latest-published/compare/:draft"
 
+By default, deaccessioned dataset versions are not included in the search when applying the :latest or :latest-published identifiers. Additionally, when filtering by a specific version tag, you will get a "not found" error if the version is deaccessioned and you do not enable the ``includeDeaccessioned`` option described below.
+
+If you want to include deaccessioned dataset versions, you must set ``includeDeaccessioned`` query parameter to ``true``.
+
+Usage example:
+
+.. code-block:: bash
+
+   curl "https://demo.dataverse.org/api/datasets/24/versions/:latest-published/compare/:draft?includeDeaccessioned=true"
+
+
 Get Versions of a Dataset with Summary of Changes
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 

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

@@ -1781,10 +1781,12 @@ public JsonObjectBuilder compareVersionsAsJson() {
         JsonObjectBuilder job = new NullSafeJsonBuilder();
         JsonObjectBuilder jobVersion = new NullSafeJsonBuilder();
         jobVersion.add("versionNumber", originalVersion.getFriendlyVersionNumber());
+        jobVersion.add("versionState", originalVersion.getVersionState().name());
         jobVersion.add("lastUpdatedDate", new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss'Z'").format(originalVersion.getLastUpdateTime()));
         job.add("oldVersion", jobVersion);
         jobVersion = new NullSafeJsonBuilder();
         jobVersion.add("versionNumber", newVersion.getFriendlyVersionNumber());
+        jobVersion.add("versionState", newVersion.getVersionState().name());
         jobVersion.add("lastUpdatedDate", new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss'Z'").format(newVersion.getLastUpdateTime()));
         job.add("newVersion", jobVersion);
 

src/main/java/edu/harvard/iq/dataverse/api/Datasets.java

@@ -2950,11 +2950,12 @@ public Response cleanStorage(@Context ContainerRequestContext crc, @PathParam("i
     public Response getCompareVersions(@Context ContainerRequestContext crc, @PathParam("id") String id,
                                       @PathParam("versionId1") String versionId1,
                                       @PathParam("versionId2") String versionId2,
+                                      @QueryParam("includeDeaccessioned") boolean includeDeaccessioned,
                                       @Context UriInfo uriInfo, @Context HttpHeaders headers) {
         try {
             DataverseRequest req = createDataverseRequest(getRequestUser(crc));
-            DatasetVersion dsv1 = getDatasetVersionOrDie(req, versionId1, findDatasetOrDie(id), uriInfo, headers);
-            DatasetVersion dsv2 = getDatasetVersionOrDie(req, versionId2, findDatasetOrDie(id), uriInfo, headers);
+            DatasetVersion dsv1 = getDatasetVersionOrDie(req, versionId1, findDatasetOrDie(id), uriInfo, headers, includeDeaccessioned);
+            DatasetVersion dsv2 = getDatasetVersionOrDie(req, versionId2, findDatasetOrDie(id), uriInfo, headers, includeDeaccessioned);
             if (dsv1.getCreateTime().getTime() > dsv2.getCreateTime().getTime()) {
                 return error(BAD_REQUEST, BundleUtil.getStringFromBundle("dataset.version.compare.incorrect.order"));
             }
@@ -2977,7 +2978,7 @@ public Response getCompareVersionsSummary(@Context ContainerRequestContext crc,
             for (DatasetVersion dv : dataset.getVersions()) {
                 //only get summaries of draft is user may view unpublished
 
-                if (dv.isPublished() || permissionService.hasPermissionsFor(user, dv.getDataset(),
+                if (dv.isPublished() ||dv.isDeaccessioned() || permissionService.hasPermissionsFor(user, dv.getDataset(),
                         EnumSet.of(Permission.ViewUnpublishedDataset))) {
 
                     JsonObjectBuilder versionBuilder = new NullSafeJsonBuilder();
@@ -3002,7 +3003,7 @@ public Response getCompareVersionsSummary(@Context ContainerRequestContext crc,
                             }
                         }
                         if (dv.isDeaccessioned()) {
-                            versionBuilder.add("summary", "versionDeaccessioned");
+                            versionBuilder.add("summary", getDeaccessionJson(dv));
                         }
 
                     } else {
@@ -3019,6 +3020,25 @@ public Response getCompareVersionsSummary(@Context ContainerRequestContext crc,
             return wr.getResponse();
         }
     }
+    
+    private JsonObject getDeaccessionJson(DatasetVersion dv) {
+
+        JsonObjectBuilder compositionBuilder = Json.createObjectBuilder();
+
+        if (dv.getDeaccessionNote() != null && !dv.getDeaccessionNote().isEmpty()) {
+            compositionBuilder.add("reason", dv.getDeaccessionNote());
+        }
+
+        if (dv.getDeaccessionLink() != null && !dv.getDeaccessionLink().isEmpty()) {
+            compositionBuilder.add("url", dv.getDeaccessionLink());
+        }
+
+        JsonObject json = Json.createObjectBuilder()
+                .add("deaccessioned", compositionBuilder)
+                .build();
+        
+        return json;
+    }
 
     private static Set<String> getDatasetFilenames(Dataset dataset) {
         Set<String> files = new HashSet<>();

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

@@ -5734,7 +5734,9 @@ public void testCompareDatasetVersionsAPI() throws InterruptedException {
         compareResponse.prettyPrint();
         compareResponse.then().assertThat()
                 .body("data.oldVersion.versionNumber", CoreMatchers.equalTo("1.0"))
+                .body("data.oldVersion.versionState", CoreMatchers.equalTo("RELEASED"))
                 .body("data.newVersion.versionNumber", CoreMatchers.equalTo("DRAFT"))
+                .body("data.newVersion.versionState", CoreMatchers.equalTo("DRAFT"))
                 .body("data.metadataChanges[0].blockName", CoreMatchers.equalTo("Citation Metadata"))
                 .body("data.metadataChanges[0].changed[0].fieldName", CoreMatchers.equalTo("Author"))
                 .body("data.metadataChanges[0].changed[0].oldValue", CoreMatchers.containsString("Finch, Fiona; (Birds Inc.)"))
@@ -5760,6 +5762,21 @@ public void testCompareDatasetVersionsAPI() throws InterruptedException {
         compareResponse.then().assertThat()
                 .body("message", CoreMatchers.equalTo(BundleUtil.getStringFromBundle("dataset.version.compare.incorrect.order")))
                 .statusCode(BAD_REQUEST.getStatusCode());
+        
+        
+        Response deaccessionDatasetResponse = UtilIT.deaccessionDataset(datasetId, DS_VERSION_LATEST_PUBLISHED, "Test deaccession reason.", null, apiToken);
+        deaccessionDatasetResponse.then().assertThat().statusCode(OK.getStatusCode());
+        
+        compareResponse = UtilIT.compareDatasetVersions(datasetPersistentId, ":latest-published", ":draft", apiToken, false);
+        compareResponse.prettyPrint();
+        compareResponse.then().assertThat().statusCode(NOT_FOUND.getStatusCode());
+
+        compareResponse = UtilIT.compareDatasetVersions(datasetPersistentId,  ":latest-published", ":draft", apiToken, true);
+        compareResponse.prettyPrint();
+        compareResponse.then().assertThat().statusCode(OK.getStatusCode());
+
+        
+        
     }
 
     @Test
@@ -5892,6 +5909,21 @@ public void testSummaryDatasetVersionsDifferencesAPI() throws InterruptedExcepti
                 .body("data[0].versionNumber", CoreMatchers.equalTo("1.0"))
                 .body("data[0].summary", CoreMatchers.equalTo("firstPublished"))
                 .statusCode(OK.getStatusCode());
+        
+        Response deaccessionDatasetResponse = UtilIT.deaccessionDataset(datasetId, DS_VERSION_LATEST_PUBLISHED, "Test deaccession reason.", null, apiToken);
+        deaccessionDatasetResponse.then().assertThat().statusCode(OK.getStatusCode());
+        
+        compareResponse = UtilIT.summaryDatasetVersionDifferences(datasetPersistentId, apiToken);
+        compareResponse.prettyPrint(); 
+        
+        compareResponse.then().assertThat()
+                .body("data[1].versionNumber", equalTo("1.0"))
+                .body("data[1].summary.deaccessioned.reason", equalTo("Test deaccession reason."))
+                .body("data[0].versionNumber", equalTo("DRAFT"))
+                .body("data[0].summary.", equalTo("previousVersionDeaccessioned"))
+                .statusCode(OK.getStatusCode());
+        
+        
     }
 
     @Test

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

@@ -1712,6 +1712,20 @@ static Response compareDatasetVersions(String persistentId, String versionNumber
                         + "?persistentId="
                         + persistentId);
     }
+    
+    static Response compareDatasetVersions(String persistentId, String versionNumber1, String versionNumber2, String apiToken, boolean includeDeaccessioned) {
+        return given()
+                .header(API_TOKEN_HTTP_HEADER, apiToken)
+                .get("/api/datasets/:persistentId/versions/"
+                        + versionNumber1
+                        + "/compare/"
+                        + versionNumber2
+                        + "?persistentId="
+                        + persistentId
+                        + "&includeDeaccessioned="
+                        + includeDeaccessioned);
+    }
+    
     static Response summaryDatasetVersionDifferences(String persistentId,  String apiToken) {
         return given()
                 .header(API_TOKEN_HTTP_HEADER, apiToken)