Display detailed error message when user uploads json not conforming to the schema

Author: akos326

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

@@ -59,8 +59,9 @@ public Response addProvJson(@Context ContainerRequestContext crc, String body, @
                 return error(FORBIDDEN, BundleUtil.getStringFromBundle("api.prov.error.jsonUpdateNotAllowed"));
             }
 
-            if(!provUtil.isProvValid(body)) {
-                return error(BAD_REQUEST, BundleUtil.getStringFromBundle("file.editProvenanceDialog.invalidSchemaError"));
+            var schemaErrorMessages = provUtil.isProvValid(body);
+            if(!schemaErrorMessages.isEmpty()) {
+                return error(BAD_REQUEST, BundleUtil.getStringFromBundle("file.editProvenanceDialog.invalidSchemaError") + schemaErrorMessages.get());
             }
 
             /*Add when we actually integrate provCpl*/

src/main/java/edu/harvard/iq/dataverse/provenance/ProvInvestigator.java

@@ -11,6 +11,7 @@
 import java.util.Set;
 import java.util.logging.Logger;
 import jakarta.json.JsonObject;
+import java.util.Optional;
 import org.everit.json.schema.Schema;
 import org.everit.json.schema.ValidationException;
 import org.everit.json.schema.loader.SchemaLoader;
@@ -114,18 +115,18 @@ public String getPrettyJsonString(JsonObject jsonObject) {
         return gson.toJson(je);
     }
 
-    public boolean isProvValid(String jsonInput) {
+    public Optional<String> isProvValid(String jsonInput) {
         try { 
             schema.validate(new JSONObject(jsonInput)); // throws a ValidationException if this object is invalid
         } catch (ValidationException vx) {
             logger.info("Prov schema error : " + vx); //without classLoader is blows up in actual deployment
-            return false;
+            return Optional.of(vx.getAllMessages().toString());
         } catch (Exception ex) {
             logger.info("Prov file error : " + ex);
-            return false;
+            return Optional.of(ex.getMessage());
         } 
 
-        return true;
+        return Optional.empty();
     }
 
     //Pulled from https://www.w3.org/Submission/2013/SUBM-prov-json-20130424/schema

src/main/java/edu/harvard/iq/dataverse/provenance/ProvPopupFragmentBean.java

@@ -95,15 +95,13 @@ public void handleFileUpload(FileUploadEvent event) throws IOException {
         provJsonState = IOUtils.toString(jsonUploadedTempFile.getInputStream());
 
 
-        if(!provUtil.isProvValid(provJsonState)) { //if uploaded prov-json does not comply with schema
+        provUtil.isProvValid(provJsonState).ifPresentOrElse(message -> { //if uploaded prov-json does not comply with schema
             Logger.getLogger(ProvPopupFragmentBean.class.getName())
                     .log(Level.INFO, BundleUtil.getStringFromBundle("file.editProvenanceDialog.invalidSchemaError")); 
             provJsonState = null;
             removeJsonAndRelatedData();
-            JH.addMessage(FacesMessage.SEVERITY_ERROR, BundleUtil.getStringFromBundle("file.editProvenanceDialog.invalidSchemaError"));
-        }
-        
-        else {
+            JH.addMessage(FacesMessage.SEVERITY_ERROR, BundleUtil.getStringFromBundle("file.editProvenanceDialog.invalidSchemaError"), message);
+        }, () -> {
             try {
                 generateProvJsonParsedEntities();
 
@@ -117,7 +115,7 @@ public void handleFileUpload(FileUploadEvent event) throws IOException {
                 removeJsonAndRelatedData();
                 JH.addMessage(FacesMessage.SEVERITY_ERROR, BundleUtil.getStringFromBundle("file.editProvenanceDialog.noEntitiesError"));
             }
-        }
+        });
 
     }
 

src/test/java/edu/harvard/iq/dataverse/provenance/ProvInvestigatorTest.java

@@ -68,7 +68,7 @@ public void testProvValidator() {
             "    }\n" +
             "}";
 
-        assertTrue(provUtilBean.isProvValid(validJsonString)); 
+        assertTrue(provUtilBean.isProvValid(validJsonString).isEmpty()); 
 
         //This string has the "entity" section misnamed to "entitddd"
         String invalidJsonString = "{\n" +
@@ -102,7 +102,7 @@ public void testProvValidator() {
             "    }\n" +
             "}";
 
-        assertFalse(provUtilBean.isProvValid(invalidJsonString)); 
+        assertFalse(provUtilBean.isProvValid(invalidJsonString).isEmpty()); 
 
     }