Generalized validation issue filtering

Author: javagl

src/issues/ValidationIssues.ts

@@ -21,4 +21,19 @@ export class ValidationIssues {
     const issue = new ValidationIssue(type, path, message, severity);
     return issue;
   }
+
+  /**
+   * An issue that just summarizes information about the validation
+   * process or result.
+   *
+   * @param path - The path for the `ValidationIssue`
+   * @param message - The message for the `ValidationIssue`
+   * @returns The `ValidationIssue`
+   */
+  static VALIDATION_INFO(path: string, message: string) {
+    const type = "VALIDATION_INFO";
+    const severity = ValidationIssueSeverity.INFO;
+    const issue = new ValidationIssue(type, path, message, severity);
+    return issue;
+  }
 }

src/tileFormats/GltfValidator.ts

@@ -6,6 +6,8 @@ import { ValidationIssue } from "../validation/ValidationIssue";
 
 import { ContentValidationIssues } from "../issues/ContentValidationIssues";
 import { GltfExtensionValidators } from "../validation/gltf/GltfExtensionValidators";
+import { ValidationIssueSeverity } from "../validation/ValidationIssueSeverity";
+import { GltfDataReader } from "../validation/gltf/GltfDataReader";
 
 // eslint-disable-next-line @typescript-eslint/no-var-requires
 const validator = require("gltf-validator");
@@ -138,16 +140,40 @@ export class GltfValidator implements Validator<Buffer> {
       allCauses.push(cause);
     }
 
-    // XXX Draft for filtering.
-    // TODO When the filtering removes the only WARNING, then
-    // the "gltfResult.issues.numWarnings > 0" does no longer
-    // make sense. The number of errors/warnings/infos have to
-    // be determined based on the filtered result!
-    const causes = GltfValidator.filterCauses(allCauses);
+    // Read the glTF data
+    const gltfData = await GltfDataReader.readGltfData(uri, input, context);
+    if (!gltfData) {
+      // Issue was already added to context
+      return false;
+    }
+
+    // Process the list of causes, possibly filtering out the ones that
+    // are known to be obsolete due to the validation that is performed
+    // by validators that are part of the 3D Tiles Validator
+    const causes = await GltfExtensionValidators.processCauses(
+      uri,
+      gltfData,
+      allCauses
+    );
+
+    // The number of errors/warnings/infos is determined based on
+    // the filtered issues.
+    const numErrors = GltfValidator.countIssueSeverities(
+      causes,
+      ValidationIssueSeverity.ERROR
+    );
+    const numWarnings = GltfValidator.countIssueSeverities(
+      causes,
+      ValidationIssueSeverity.WARNING
+    );
+    const numInfos = GltfValidator.countIssueSeverities(
+      causes,
+      ValidationIssueSeverity.INFO
+    );
 
     // If there are any errors, then summarize ALL issues from the glTF
     // validation as 'internal issues' in a CONTENT_VALIDATION_ERROR
-    if (gltfResult.issues.numErrors > 0) {
+    if (numErrors > 0) {
       const path = uri;
       const message = `Content ${uri} caused validation errors`;
       const issue = ContentValidationIssues.CONTENT_VALIDATION_ERROR(
@@ -166,7 +192,7 @@ export class GltfValidator implements Validator<Buffer> {
     // If there are any warnings, then summarize them in a
     // CONTENT_VALIDATION_WARNING, but still consider the
     // object to be valid.
-    if (gltfResult.issues.numWarnings > 0) {
+    if (numWarnings > 0) {
       const path = uri;
       const message = `Content ${uri} caused validation warnings`;
       const issue = ContentValidationIssues.CONTENT_VALIDATION_WARNING(
@@ -178,7 +204,7 @@ export class GltfValidator implements Validator<Buffer> {
         issue.addCause(cause);
       }
       context.addIssue(issue);
-    } else if (gltfResult.issues.numInfos > 0) {
+    } else if (numInfos > 0) {
       // If there are no warnings, but infos, then summarize them in a
       // CONTENT_VALIDATION_INFO, but still consider the
       // object to be valid.
@@ -197,9 +223,14 @@ export class GltfValidator implements Validator<Buffer> {
     }
 
     // When the glTF itself is considered to be valid, then perform
-    // the validation of the Cesium glTF metadata extensions
+    // the validation of the glTF extensions that are implemented
+    // as part of the 3D Tiles Validator
     const extensionsValid =
-      await GltfExtensionValidators.validateGltfExtensions(uri, input, context);
+      await GltfExtensionValidators.validateGltfExtensions(
+        uri,
+        gltfData,
+        context
+      );
     if (!extensionsValid) {
       return false;
     }
@@ -208,92 +239,23 @@ export class GltfValidator implements Validator<Buffer> {
   }
 
   /**
-   * Tries to extract an extension name from the message that is generated by
-   * the glTF Validator when it encounters an extension that is not supported.
-   *
-   * This makes assumptions about the structure of the message, and that it
-   * is (verbatim) the message as it is generated by the glTF validator.
-   *
-   * @param message - The validation message
-   * @returns The unsupported extension name, or `undefined` if the message
-   * does not indicate an unsupported extension
-   */
-  private static extractUnsupportedExtensionName(
-    message: string
-  ): string | undefined {
-    // Example:
-    // "Cannot validate an extension as it is not supported by the validator: 'EXT_mesh_features'.",
-    const prefix =
-      "Cannot validate an extension as it is not supported by the validator: '";
-    if (message.startsWith(prefix)) {
-      const extensionName = message.substring(
-        prefix.length,
-        message.length - 2
-      );
-      return extensionName;
-    }
-    return undefined;
-  }
-
-  /**
-   * Filter the given list of validation issues based on the knowledge about
-   * the the glTF extension validations that are implemented as part of the
-   * 3D Tiles validator.
-   *
-   * The given list are the `ValidationIssue` objects that have been created
-   * from the messages of the full glTF Validator output, using
-   * `createValidationIssueFromGltfMessage`.
+   * Counts and returns the number of issues in the given array that have
+   * the given severity.
    *
-   * @param causes - The causes
-   * @returns The filtered causes
+   * @param issues - The issues
+   * @param severity - The severity
+   * @returns The number of issues with the given severity
    */
-  private static filterCauses(causes: ValidationIssue[]): ValidationIssue[] {
-    console.log("Filtering causes");
-    const filteredCauses: ValidationIssue[] = causes.filter(
-      (issue) => !GltfValidator.shouldRemove(issue)
-    );
-    return filteredCauses;
-  }
-
-  // TODO DRAFT
-  private static shouldRemove(issue: ValidationIssue): boolean {
-    const message = issue.message;
-
-    // Messages about unsupported extensions should be removed
-    // if and only if they are about an extension that was
-    // registered in the GltfExtensionValidators
-    const unsupportedExtensionName =
-      GltfValidator.extractUnsupportedExtensionName(message);
-    if (unsupportedExtensionName) {
-      const isRegistered = GltfExtensionValidators.isRegistered(
-        unsupportedExtensionName
-      );
-      if (isRegistered) {
-        console.log(
-          "Filtering out message about " +
-            unsupportedExtensionName +
-            " not being supported in glTF Validator"
-        );
-        return true;
+  private static countIssueSeverities(
+    issues: ValidationIssue[],
+    severity: ValidationIssueSeverity
+  ): number {
+    let count = 0;
+    for (const issue of issues) {
+      if (issue.severity === severity) {
+        count++;
       }
     }
-
-    // TODO XXX DUMMY IMPLEMENTATION
-    if (unsupportedExtensionName === "KHR_texture_basisu") {
-      console.warn(
-        "Filtering out message about KHR_texture_basisu not being supported!"
-      );
-      return true;
-    }
-    if (message.startsWith("Invalid value 'image/ktx2'.")) {
-      console.warn("Filtering out message invalid image media type!");
-      return true;
-    }
-    if (message === "Image format not recognized.") {
-      console.warn("Filtering out unrecognized image format!");
-      return true;
-    }
-
-    return false;
+    return count;
   }
 }