Skip to content
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.

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

Validation issue filtering options #310

Merged
merged 3 commits into from
May 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 3 additions & 4 deletions src/main.ts
Original file line number Diff line number Diff line change
Expand Up @@ -92,12 +92,11 @@ const argv = args.argv;
async function readOptionsFile(
optionsFile: string
): Promise<ValidationOptions> {
const validationOptions: ValidationOptions = await readJsonUnchecked(
optionsFile
);
if (!validationOptions) {
const validationOptionsObject = await readJsonUnchecked(optionsFile);
if (!validationOptionsObject) {
return new ValidationOptions();
}
const validationOptions = ValidationOptions.fromJson(validationOptionsObject);
return validationOptions;
}

Expand Down
24 changes: 23 additions & 1 deletion src/validation/ContentDataValidator.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ import { Content } from "3d-tiles-tools";
import { IoValidationIssues } from "../issues/IoValidationIssue";
import { ContentValidationIssues } from "../issues/ContentValidationIssues";
import { ValidationOptionChecks } from "./ValidationOptionChecks";
import { ValidationIssueFilters } from "./ValidationIssueFilters";
import { ValidationIssueSeverity } from "./ValidationIssueSeverity";

/**
* A class for validation of the data that is pointed to by a `content.uri`.
Expand Down Expand Up @@ -183,9 +185,29 @@ export class ContentDataValidator {
context.addIssue(issue);
}
} else {
const includedSeverities: ValidationIssueSeverity[] = [];
if (
options.contentValidationIssueSeverity == ValidationIssueSeverity.ERROR
) {
includedSeverities.push(ValidationIssueSeverity.ERROR);
} else if (
options.contentValidationIssueSeverity ==
ValidationIssueSeverity.WARNING
) {
includedSeverities.push(ValidationIssueSeverity.WARNING);
includedSeverities.push(ValidationIssueSeverity.ERROR);
} else {
includedSeverities.push(ValidationIssueSeverity.INFO);
includedSeverities.push(ValidationIssueSeverity.WARNING);
includedSeverities.push(ValidationIssueSeverity.ERROR);
}
const filter = ValidationIssueFilters.byIncludedSeverities(
...includedSeverities
);
const filteredDerivedResult = derivedResult.filter(filter);
const issue = ContentValidationIssues.createForContent(
contentUri,
derivedResult
filteredDerivedResult
);
if (issue) {
context.addIssue(issue);
Expand Down
26 changes: 26 additions & 0 deletions src/validation/ValidationOptions.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
import { ValidationIssueSeverity } from "./ValidationIssueSeverity";

/**
* A class describing the options for a validator within
* a `ValidationContext`
Expand All @@ -14,6 +16,12 @@ export class ValidationOptions {
*/
private _validateContentData: boolean;

/**
* The severity of content validation issues that should be
* included in the results.
*/
private _contentValidationIssueSeverity: ValidationIssueSeverity;

/**
* The content types that are included in the validation.
*/
Expand All @@ -37,6 +45,7 @@ export class ValidationOptions {
*/
constructor() {
this._validateContentData = true;
this._contentValidationIssueSeverity = ValidationIssueSeverity.INFO;
this._includeContentTypes = undefined;
this._excludeContentTypes = undefined;
}
Expand All @@ -54,6 +63,23 @@ export class ValidationOptions {
this._validateContentData = value;
}

/**
* The severity of content validation issues that should
* be included in the result.
*
* By default, this will be `INFO`, meaning that all content
* validation issues will be included. It can be set to
* `WARNING`, to include all `ERROR` and `WARNING` issues,
* or to `ERROR` to only include `ERROR` issues.
*/
get contentValidationIssueSeverity(): ValidationIssueSeverity {
return this._contentValidationIssueSeverity;
}

set contentValidationIssueSeverity(value: ValidationIssueSeverity) {
this._contentValidationIssueSeverity = value;
}

/**
* The content types that should be included.
*
Expand Down
27 changes: 27 additions & 0 deletions src/validation/Validators.ts
Original file line number Diff line number Diff line change
Expand Up @@ -458,6 +458,33 @@ export class Validators {
);
}

// Register an empty validator for NGA_gpm
{
const emptyValidator = Validators.createEmptyValidator();
const override = false;
ExtendedObjectsValidators.register("NGA_gpm", emptyValidator, override);
}
// Register an empty validator for MAXAR_extent
{
const emptyValidator = Validators.createEmptyValidator();
const override = false;
ExtendedObjectsValidators.register(
"MAXAR_extent",
emptyValidator,
override
);
}
// Register an empty validator for MAXAR_grid
{
const emptyValidator = Validators.createEmptyValidator();
const override = false;
ExtendedObjectsValidators.register(
"MAXAR_grid",
emptyValidator,
override
);
}

Validators._registeredExtensionValidators = true;
}
}
8 changes: 7 additions & 1 deletion src/validation/gltfExtensions/GltfDataReader.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
import { JSONDocument } from "@gltf-transform/core";
import { Document } from "@gltf-transform/core";
import { JSONDocument } from "@gltf-transform/core";
import { Logger } from "@gltf-transform/core";
import { Verbosity } from "@gltf-transform/core";

import { BinaryBufferData } from "3d-tiles-tools";
import { BinaryBufferDataResolver } from "3d-tiles-tools";
Expand Down Expand Up @@ -155,6 +157,8 @@ export class GltfDataReader {
): Promise<Document | undefined> {
try {
const io = await GltfTransform.getIO();
// Avoid warning "Missing optional extension"
io.setLogger(new Logger(Verbosity.ERROR));
const gltfDocument = await io.readBinary(input);
return gltfDocument;
} catch (error) {
Expand Down Expand Up @@ -236,6 +240,8 @@ export class GltfDataReader {
const resources = {};
try {
const io = await GltfTransform.getIO();
// Avoid warning "Missing optional extension"
io.setLogger(new Logger(Verbosity.ERROR));
const json = JSON.parse(input.toString());
const jsonDoc = { json, resources } as JSONDocument;
const gltfDocument = await io.readJSON(jsonDoc);
Expand Down
Loading