Skip to content

'API inconsistency for release time between JsonParser and JsonPrinter #12320

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
stevenwinship wants to merge 1 commit into
base: develop
Choose a base branch
from
+46 −1
Open

'API inconsistency for release time between JsonParser and JsonPrinter #12320

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions doc/release-notes/11594-release-time-inconsistency-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
## Bug
API inconsistency for release time between JsonParser/JsonPrinter has been addressed. For backward compatibility new "releaseTime" and original "releaseDate" will be allowed in the Json giving preferance to the new "releaseTime" field. Also, "releaseTime" field will populate the db with date/time. The original "releaseDate" field will continue to truncated to the date only.
8 changes: 7 additions & 1 deletion src/main/java/edu/harvard/iq/dataverse/util/json/JsonParser.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -460,7 +460,13 @@ public DatasetVersion parseDatasetVersion(JsonObject obj, DatasetVersion dsv) th
if (versionStateStr != null) {
dsv.setVersionState(DatasetVersion.VersionState.valueOf(versionStateStr));
}
dsv.setReleaseTime(parseDate(obj.getString("releaseDate", null)));
// Checking "releaseTime" to be consistent with JsonPrinter which outputs this field as 'releaseTime' with full timestamp
if (obj.containsKey("releaseTime")) {
dsv.setReleaseTime(parseTime(obj.getString("releaseTime", null)));
} else {
// Accept 'releaseDate' to remain backward compatible. This truncates to date only!
dsv.setReleaseTime(parseDate(obj.getString("releaseDate", null)));
}
dsv.setLastUpdateTime(parseTime(obj.getString("lastUpdateTime", null)));
dsv.setCreateTime(parseTime(obj.getString("createTime", null)));
dsv.setArchiveTime(parseTime(obj.getString("archiveTime", null)));
Expand Down
37 changes: 37 additions & 0 deletions src/test/java/edu/harvard/iq/dataverse/util/json/JsonParserTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
import edu.harvard.iq.dataverse.engine.command.DataverseRequest;
import edu.harvard.iq.dataverse.license.LicenseServiceBean;
import edu.harvard.iq.dataverse.mocks.MockDatasetFieldSvc;
import edu.harvard.iq.dataverse.pidproviders.doi.AbstractDOIProvider;
import edu.harvard.iq.dataverse.settings.SettingsServiceBean;
import org.junit.jupiter.api.AfterAll;
import org.junit.jupiter.api.Assumptions;
Expand All @@ -43,6 +44,7 @@
import java.io.StringReader;
import java.math.BigDecimal;
import java.text.ParseException;
import java.time.Instant;
import java.util.*;

import static org.junit.jupiter.api.Assertions.assertEquals;
Expand Down Expand Up @@ -918,4 +920,39 @@ public void testGuestbookResponse() throws JsonParseException {
assertTrue(e.getMessage().contains("Guestbook Response entry is required but not present"));
}
}

// Testing that output of JsonPrinter can be used as input to JsonParser
// Additional tests can be added but this was created for Issue: API inconsistency for release time between JsonParser/JsonPrinter #11594
@Test
public void testDatasetVersionJsonPrinterJsonParser() throws JsonParseException {
// Set up to prevent NullPointerExceptions
String sut = "foobar";
DatasetType foobar = new DatasetType();
foobar.setName(sut);
TermsOfUseAndAccess termsOfUseAndAccess = new TermsOfUseAndAccess();
termsOfUseAndAccess.setTermsOfUse("TOU");
settingsSvc = new MockSettingsSvc();
DatasetType datasetType = new DatasetType();
datasetType.setName(DatasetType.DEFAULT_DATASET_TYPE);
datasetType.setId(1l);
Mockito.when(datasetTypeService.getByName(DatasetType.DEFAULT_DATASET_TYPE)).thenReturn(datasetType);
JsonParser jsonParser = new JsonParser(datasetFieldTypeSvc, null, settingsSvc, licenseService, datasetTypeService);

Dataset ds = new Dataset();
DatasetVersion dsv1 = new DatasetVersion();
DatasetVersion dsv2 = new DatasetVersion();

ds.setGlobalId(new GlobalId(AbstractDOIProvider.DOI_PROTOCOL,"10.5072","FK2/BYM3IW", "/", AbstractDOIProvider.DOI_RESOLVER_URL, null));
ds.setDatasetType(foobar);
dsv1.setDataset(ds);
dsv1.setReleaseTime(Date.from(Instant.now()));
dsv1.setVersionState(DatasetVersion.VersionState.RELEASED);
dsv1.setTermsOfUseAndAccess(termsOfUseAndAccess);

// Test output of JsonPrinter can be used as input to JsonParser
JsonObject json = JsonPrinter.json(dsv1, false).build();
jsonParser.parseDatasetVersion(json, dsv2);

assertEquals(dsv1.getReleaseTime().toString(), dsv2.getReleaseTime().toString());
}
}
Loading