[KOGITO-9501] Changing Everit to json-schema-validator (#3107)

* [KOGITO-9501] Changing JsonSchema validator library * [KOGITO-9501] Different validation message * [KOGITO-9501] Changing to networknt library
apache · Jul 6, 2023 · fca0ce0 · fca0ce0
1 parent a944c0a
commit fca0ce0
Show file tree

Hide file tree

Showing 7 changed files with 36 additions and 53 deletions.
diff --git a/kogito-build/kogito-dependencies-bom/pom.xml b/kogito-build/kogito-dependencies-bom/pom.xml
@@ -22,6 +22,7 @@
     <version.org.apache.kafka>3.4.0</version.org.apache.kafka>
 
     <!-- dependencies versions -->
+    <version.com.networknt>1.0.86</version.com.networknt>
     <version.com.fasterxml.jackson>2.14.2</version.com.fasterxml.jackson>
     <version.com.fasterxml.jackson.databind>2.14.2</version.com.fasterxml.jackson.databind>
     <version.com.jayway.jsonpath>2.8.0</version.com.jayway.jsonpath>
@@ -34,9 +35,7 @@
     <version.io.quarkiverse.embedded.postgresql>0.0.8</version.io.quarkiverse.embedded.postgresql>
     <version.com.github.haifengl.smile>1.5.2</version.com.github.haifengl.smile>
     <version.com.github.javaparser>3.24.2</version.com.github.javaparser>
-    <version.com.github.java-json-tools>2.2.14</version.com.github.java-json-tools>
     <version.com.fasterxml.jackson.datatype>2.14.2</version.com.fasterxml.jackson.datatype>
-    <version.com.github.erosb>1.14.2</version.com.github.erosb>
     <version.com.github.victools>4.18.0</version.com.github.victools>
     <version.com.github.tomakehurst.wiremock>2.33.2</version.com.github.tomakehurst.wiremock>
     <version.com.google.protobuf>3.22.0</version.com.google.protobuf>
@@ -704,22 +703,21 @@
         <version>${version.com.github.victools}</version>
       </dependency>
       <dependency>
-        <groupId>com.github.java-json-tools</groupId>
+        <groupId>com.networknt</groupId>
         <artifactId>json-schema-validator</artifactId>
-        <version>${version.com.github.java-json-tools}</version>
-        <scope>test</scope>
+        <version>${version.com.networknt}</version>
+        <exclusions>
+          <exclusion>
+            <groupId>org.apache.commons</groupId>
+            <artifactId>commons-lang3</artifactId>
+          </exclusion>
+         </exclusions>
       </dependency>
       <dependency>
         <groupId>com.fasterxml.jackson.datatype</groupId>
         <artifactId>jackson-datatype-json-org</artifactId>
         <version>${version.com.fasterxml.jackson.datatype}</version>
       </dependency>
-      <dependency>
-        <groupId>com.github.erosb</groupId>
-        <artifactId>everit-json-schema</artifactId>
-        <version>${version.com.github.erosb}</version>
-      </dependency>
-
       <!-- Serverless Workflow -->
       <dependency>
         <groupId>io.serverlessworkflow</groupId>

diff --git a/kogito-serverless-workflow/kogito-serverless-workflow-builder/pom.xml b/kogito-serverless-workflow/kogito-serverless-workflow-builder/pom.xml
@@ -22,10 +22,6 @@
       <groupId>org.kie.kogito</groupId>
       <artifactId>kogito-serverless-workflow-runtime</artifactId>
     </dependency>
-    <dependency>
-      <groupId>com.github.erosb</groupId>
-      <artifactId>everit-json-schema</artifactId>
-    </dependency>
     <dependency>
       <groupId>org.kie.kogito</groupId>
       <artifactId>kogito-codegen-api</artifactId>

diff --git a/kogito-serverless-workflow/kogito-serverless-workflow-runtime/pom.xml b/kogito-serverless-workflow/kogito-serverless-workflow-runtime/pom.xml
@@ -26,10 +26,10 @@
       <groupId>org.kie.kogito</groupId>
       <artifactId>kogito-rest-utils</artifactId>
     </dependency>
-    <dependency>
-      <groupId>com.github.erosb</groupId>
-      <artifactId>everit-json-schema</artifactId>
-    </dependency>
+   <dependency>
+     <groupId>com.networknt</groupId>
+     <artifactId>json-schema-validator</artifactId>
+   </dependency>
     <dependency>
       <groupId>com.fasterxml.jackson.datatype</groupId>
       <artifactId>jackson-datatype-json-org</artifactId>

diff --git a/...runtime/src/main/java/org/kie/kogito/serverless/workflow/actions/JsonSchemaValidator.java b/...runtime/src/main/java/org/kie/kogito/serverless/workflow/actions/JsonSchemaValidator.java
@@ -17,20 +17,20 @@
 
 import java.io.IOException;
 import java.util.Map;
+import java.util.Set;
 import java.util.concurrent.atomic.AtomicReference;
 
-import org.everit.json.schema.Schema;
-import org.everit.json.schema.ValidationException;
-import org.everit.json.schema.loader.SchemaClient;
-import org.everit.json.schema.loader.SchemaLoader;
 import org.jbpm.workflow.core.WorkflowModelValidator;
-import org.json.JSONObject;
 import org.kie.kogito.jackson.utils.ObjectMapperFactory;
 import org.kie.kogito.serverless.workflow.SWFConstants;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.node.NullNode;
+import com.networknt.schema.JsonSchemaFactory;
+import com.networknt.schema.SpecVersion.VersionFlag;
+import com.networknt.schema.ValidationMessage;
 
 import static org.kie.kogito.serverless.workflow.io.URIContentLoaderFactory.readAllBytes;
 import static org.kie.kogito.serverless.workflow.io.URIContentLoaderFactory.runtimeLoader;
@@ -43,8 +43,7 @@ public class JsonSchemaValidator implements WorkflowModelValidator {
 
     protected final String schemaRef;
     protected final boolean failOnValidationErrors;
-
-    private final AtomicReference<Schema> schemaObject = new AtomicReference<>();
+    private final AtomicReference<JsonNode> schemaObject = new AtomicReference<>();
 
     public JsonSchemaValidator(String schema, boolean failOnValidationErrors) {
         this.schemaRef = schema;
@@ -54,32 +53,28 @@ public JsonSchemaValidator(String schema, boolean failOnValidationErrors) {
     @Override
     public void validate(Map<String, Object> model) {
         try {
-            load().validate(ObjectMapperFactory.get().convertValue(model.getOrDefault(SWFConstants.DEFAULT_WORKFLOW_VAR, NullNode.instance), JSONObject.class));
-        } catch (ValidationException ex) {
-            handleException(ex, ex.getCausingExceptions().isEmpty() ? ex : ex.getCausingExceptions());
+            Set<ValidationMessage> report =
+                    JsonSchemaFactory.getInstance(VersionFlag.V4).getSchema(schemaData()).validate((JsonNode) model.getOrDefault(SWFConstants.DEFAULT_WORKFLOW_VAR, NullNode.instance));
+            if (!report.isEmpty()) {
+                StringBuilder sb = new StringBuilder("There are JsonSchema validation errors:");
+                report.forEach(m -> sb.append(System.lineSeparator()).append(m.getMessage()));
+                final String validationMessage = sb.toString();
+                logger.warn(validationMessage);
+                if (failOnValidationErrors) {
+                    throw new IllegalArgumentException(validationMessage);
+                }
+            }
         } catch (IOException ex) {
-            handleException(ex, ex);
+            throw new IllegalStateException("Unexpected error validating schema", ex);
         }
     }
 
-    public Schema load() throws IOException {
-        Schema result = schemaObject.get();
+    public JsonNode schemaData() throws IOException {
+        JsonNode result = schemaObject.get();
         if (result == null) {
-            result = SchemaLoader.builder()
-                    .schemaJson(ObjectMapperFactory.get().readValue(readAllBytes(runtimeLoader(schemaRef)), JSONObject.class))
-                    .resolutionScope(schemaRef)
-                    .schemaClient(SchemaClient.classPathAwareClient())
-                    .build().load().build();
+            result = ObjectMapperFactory.get().readTree(readAllBytes(runtimeLoader(schemaRef)));
             schemaObject.set(result);
         }
         return result;
     }
-
-    private void handleException(Throwable ex, Object toAppend) {
-        String validationError = String.format("Error validating schema: %s", toAppend);
-        logger.warn(validationError, ex);
-        if (failOnValidationErrors) {
-            throw new IllegalArgumentException(validationError);
-        }
-    }
 }
diff --git a/...in/java/org/kie/kogito/serverless/workflow/parser/schema/OpenApiModelSchemaGenerator.java b/...in/java/org/kie/kogito/serverless/workflow/parser/schema/OpenApiModelSchemaGenerator.java
@@ -115,7 +115,7 @@ private static Optional<Schema> getSchema(Optional<WorkflowModelValidator> valid
 
     private static Schema getSchema(JsonSchemaValidator validator) {
         try {
-            return ObjectMapperFactory.get().readValue(validator.load().toString(), JsonSchemaImpl.class);
+            return ObjectMapperFactory.get().convertValue(validator.schemaData(), JsonSchemaImpl.class);
         } catch (IOException e) {
             throw new UncheckedIOException(e);
         }

diff --git a/...low-integration-test/src/test/java/org/kie/kogito/quarkus/workflows/ExpressionRestIT.java b/...low-integration-test/src/test/java/org/kie/kogito/quarkus/workflows/ExpressionRestIT.java
@@ -67,7 +67,7 @@ void testExpressionOutputValidation() {
                 .post("/invalidOutputExpression")
                 .then()
                 .statusCode(is(400))
-                .body("message", containsString("required key [message] not found"))
+                .body("message", containsString("message"))
                 .body("id", notNullValue());
     }
 }
diff --git a/quarkus/integration-tests/integration-tests-quarkus-processes/pom.xml b/quarkus/integration-tests/integration-tests-quarkus-processes/pom.xml
@@ -83,12 +83,6 @@
       <artifactId>rest-assured</artifactId>
       <scope>test</scope>
     </dependency>
-
-    <dependency>
-      <groupId>com.github.java-json-tools</groupId>
-      <artifactId>json-schema-validator</artifactId>
-      <scope>test</scope>
-    </dependency>
     <dependency>
       <groupId>io.rest-assured</groupId>
       <artifactId>json-schema-validator</artifactId>