Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 | 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 4x 4x 4x 2x 61x 22x 21x 21x 1x 21x 4x 61x 61x 61x 61x 61x 2x 2x 2x 2x 2x 2x 1x 1x 1x 2x 1x 1x 1x 1x 1x 1x 1x 1x 7x 7x 81x 40x 40x 40x 63x 53x 53x 2x 2x 1x 53x 53x 1x 52x 45x 96x 62x 37x 2x 14x 14x 3x 1x 2x 2x 2x 3x 3x 3x 2x 1x 12x 12x 12x 12x 12x 12x 12x 4x 4x 1x 3x 3x 3x 3x 6x 17x 17x 31x 31x 2x 2x 1x 1x 1x 2x 2x 1x 1x 12x 12x 12x 12x 12x 35x 35x 35x 1x 34x 34x 34x 34x 34x 34x 34x 34x 34x 34x 34x 34x 34x 1x 1x 34x 34x 34x 34x 34x 34x 34x 12x 34x 2x 3x 3x 3x 1x 2x 2x 1x 1x 1x 34x 34x 4x | import * as vscode from 'vscode';
import { Store } from '@faubulous/mentor-rdf';
import { QuadContext } from '@faubulous/mentor-rdf-parsers';
import { TurtleDocument } from '@src/languages/turtle/turtle-document';
import { IDocumentContextService, IDocumentFactory } from '@src/services/document';
import { IDocumentContext } from '@src/services/document/document-context.interface';
import { getConfig } from '@src/utilities/vscode/config';
import { toUniqueStringArray } from '@src/utilities/array';
import { Debouncer, KeyedDebouncer } from '@src/utilities/debounce';
import { WorkspaceUri } from '@src/providers/workspace-uri';
import { ShaclDiagnosticsMapper } from './shacl-diagnostics-mapper';
import {
getAutoValidationProfiles,
getDocumentValidationState,
matchesProfilePaths,
profilePathEntries,
resolveAutoValidationShapeGraphs,
resolveEffectiveShapeGraphs,
ShaclBrokenReferences,
ShaclDocumentLocation,
ShaclDocumentValidationState,
ShaclValidationSettings,
} from './shacl-validation-configuration';
import { ShaclProfileSettingsService } from './shacl-profile-settings-service';
import { ShaclSettingsSyncService } from './shacl-settings-sync-service';
import { ShapeGraphService } from './shape-graph-service';
import { ShaclValidationResult, ShaclValidatorEngine } from './shacl-validator-engine';
import { formatReportAsText, serializeReportAsTurtle } from './shacl-report-exporter';
import { ShaclValidationPresenter } from './shacl-validation-presenter';
import { BatchValidationOptions, ProfileValidationSummary, ShaclBatchRunner, ValidationRunStatistics } from './shacl-batch-runner';
export type { ShaclValidationResult, ShaclValidationResultEntry } from './shacl-validator-engine';
export type { BatchValidationOptions, ProfileValidationSummary, ValidationRunStatistics } from './shacl-batch-runner';
/**
* The facade for SHACL validation of RDF documents: resolves the profiles that
* apply to a document, runs single-document and batch validations through the
* {@link ShaclValidatorEngine} and {@link ShaclBatchRunner}, publishes the
* resulting diagnostics and notifies consumers via {@link onDidValidate}.
*/
export class ShaclValidationService implements vscode.Disposable {
private readonly _diagnosticCollection: vscode.DiagnosticCollection;
private readonly _diagnosticsMapper: ShaclDiagnosticsMapper;
private readonly _disposables: vscode.Disposable[] = [];
/**
* Stores the last validation result per document URI for report export.
*/
private readonly _lastResults = new Map<string, ShaclValidationResult>();
/**
* Documents whose automatic validation was skipped because their data graph
* exceeds `mentor.shacl.maxGraphSize`, keyed by document URI. Surfaced by the
* validation code lens; cleared when the document is validated, edited or closed.
*/
private readonly _lastSkips = new Map<string, { triples: number; maxGraphSize: number }>();
/**
* The inputs of the last validation per document URI: the data and shape graphs with
* their versions in the store (see {@link _getValidationSignature}). Lets the automatic
* validation skip a document whose result is still fresh, e.g. on a switch between tabs.
*/
private readonly _validationSignatures = new Map<string, string>();
/**
* Tracks in-flight validation runs per document and shape graph combination so
* that concurrent triggers share a single run. Guards `_validateAndPublish`,
* the choke point every path funnels through — explicit commands, the
* auto-validation path (`_autoValidateOnChange`) and batch runs — so e.g. a
* shape-graph change reaction firing while an indexing document-context change
* validates the same file coalesces into one run.
*/
private readonly _inflightValidations = new Map<string, Promise<ShaclValidationResult>>();
/**
* Debounce/serialization state for {@link scheduleShapeGraphReaction}, which
* coalesces bursts of shape-graph changes (startup lazy loads, Settings Sync
* churn) into a single revalidate + profile-check pass. The 200ms trailing
* delay is long enough to collapse a startup storm of lazy-load fires.
*/
private readonly _shapeGraphReactionDebouncer = new Debouncer(200);
private _shapeGraphReactionRunning = false;
private _shapeGraphReactionPending = false;
/**
* Debounces on-change auto-validation per document: context changes are
* fired on every debounced reload tick while typing, and each
* auto-validation is a blocking `shacl-engine` run on the extension host.
*/
private readonly _autoValidateDebouncer = new KeyedDebouncer<string>(500);
private readonly _onDidValidate = new vscode.EventEmitter<vscode.Uri>();
private readonly _onDidFinishValidation = new vscode.EventEmitter<void>();
/**
* Log channel for validation activity, mirroring the "Mentor Indexer" channel.
* Records per-file validation timings and batch summaries.
*/
private readonly _log: vscode.LogOutputChannel = vscode.window.createOutputChannel('Mentor Validation', { log: true });
/**
* Drives the validation status bar item shown while a run is in flight.
*/
private readonly _presenter = new ShaclValidationPresenter();
/**
* The vscode-free validation core (validator cache + result mapping).
*/
private readonly _engine: ShaclValidatorEngine;
/**
* Runs batch validations (progress, cancellation, event coalescing).
*/
private readonly _batchRunner: ShaclBatchRunner;
/**
* Keeps the validation settings in sync with the workspace (renames,
* deletions) and runs the startup health checks.
*/
readonly settingsSync: ShaclSettingsSyncService;
/**
* Fired when a validation completes (or results are cleared) for a document.
*/
readonly onDidValidate: vscode.Event<vscode.Uri> = this._onDidValidate.event;
/**
* Fired when a batch validation run finishes, after {@link lastRunStatistics}
* has been updated. Used by the validation dashboard to refresh its metrics.
*/
readonly onDidFinishValidation: vscode.Event<void> = this._onDidFinishValidation.event;
constructor(
context: vscode.ExtensionContext,
private readonly _store: Store,
private readonly _contextService: IDocumentContextService,
private readonly _documentFactory: IDocumentFactory,
private readonly _profileSettings: ShaclProfileSettingsService = new ShaclProfileSettingsService(),
private readonly _shapeGraphs?: ShapeGraphService
) {
this._diagnosticCollection = vscode.languages.createDiagnosticCollection('mentor-shacl');
this._diagnosticsMapper = new ShaclDiagnosticsMapper();
this._engine = new ShaclValidatorEngine(_store, message => this._log.info(message));
this.settingsSync = new ShaclSettingsSyncService(_store, this._profileSettings, broken => {
// Surface broken profile references on the status bar item; a passing
// check clears the error again.
const brokenProfiles = Object.keys(broken.profiles);
this._presenter.setConfigurationError(brokenProfiles.length > 0
? 'Some SHACL validation profiles reference missing shape graphs. '
+ `Affected profiles: ${brokenProfiles.join(', ')}.`
+ '\nClick to manage the validation profiles.'
: undefined);
}, uris => this._shapeGraphs?.ensureLoaded(uris) ?? Promise.resolve(),
uri => this._shapeGraphs?.hasShapeSource(uri) ?? false);
this._batchRunner = new ShaclBatchRunner({
contextService: _contextService,
store: _store,
log: this._log,
presenter: this._presenter,
validateAndPublish: (uri, documentContext, shapes) => this._validateAndPublish(uri, documentContext, shapes),
onBatchEnd: () => {
// Coalesced refresh: fire once for the active document so the tree, decorations
// and code lenses rebuild a single time for the whole batch instead of per file.
const activeUri = this._contextService.activeContext?.uri;
if (activeUri) {
this._onDidValidate.fire(activeUri);
}
this._onDidFinishValidation.fire();
},
onFileSkipped: (uri, triples, maxGraphSize) => {
this._lastSkips.set(uri.toString(), { triples, maxGraphSize });
},
});
context.subscriptions.push(this);
this._log.clear();
this._disposables.push(this._log, this._presenter);
// Clear diagnostics when a document is closed.
this._disposables.push(
vscode.workspace.onDidCloseTextDocument(doc => {
this._diagnosticCollection.delete(doc.uri);
this._lastResults.delete(doc.uri.toString());
this._lastSkips.delete(doc.uri.toString());
this._onDidValidate.fire(doc.uri);
}),
// Editing a document invalidates its last validation result and skip
// state: drop them so the status CodeLens no longer reports a stale state.
vscode.workspace.onDidChangeTextDocument(e => {
const key = e.document.uri.toString();
if (e.contentChanges.length === 0) {
return;
}
const droppedResult = this._lastResults.delete(key);
const droppedSkip = this._lastSkips.delete(key);
if (droppedResult || droppedSkip) {
this._onDidValidate.fire(e.document.uri);
}
}),
// Keep the status bar item's baseline "0 files" indicator in sync with
// whether SHACL validation is enabled.
vscode.workspace.onDidChangeConfiguration(e => {
if (e.affectsConfiguration('mentor.shacl.enabled')) {
this._presenter.setEnabled(getConfig('shacl').get<boolean>('enabled', false));
}
}),
// Auto-validate on change: a fresh document context is delivered after
// the debounced re-parse (on open and on edit). Debounced per document
// and re-resolved at fire time so a context replaced in the meantime
// is not validated stale.
this._contextService.onDidChangeDocumentContext(context => {
if (!context) {
return;
}
const key = context.uri.toString();
this._autoValidateDebouncer.schedule(key, () => {
void this._autoValidateOnChange(this._contextService.contexts[key]);
});
})
);
// Show the baseline "0 files" indicator immediately when SHACL is enabled.
this._presenter.setEnabled(getConfig('shacl').get<boolean>('enabled', false));
}
/**
* Validates a document against the matching profiles that have
* `validateOnChange` enabled, when `mentor.shacl.enabled` is on. Skips
* documents that no opted-in profile covers or that currently have syntax
* errors, and never shows a notification (diagnostics are published quietly).
*/
private async _autoValidateOnChange(context: IDocumentContext | undefined): Promise<void> {
Iif (!context) {
return;
}
const shaclConfig = getConfig('shacl');
Iif (!shaclConfig.get<boolean>('enabled', false)) {
return;
}
const shapeGraphUris = this.getOnChangeShapeGraphs(context.uri);
Iif (shapeGraphUris.length === 0 || this._hasSyntaxErrors(context.uri)) {
return;
}
// The context event also fires when an unchanged document becomes active again,
// e.g. on a switch between tabs. Its last result is still valid when neither the
// document nor the shapes changed since: edits drop the result, and every change
// of a data or shape graph changes its version in the store.
if (this._isLastResultFresh(context, shapeGraphUris)) {
return;
}
// Never auto-validate a pathologically large data graph on change: it would block
// the extension host on every edit. Explicit validation commands bypass this guard.
const maxGraphSize = this._batchRunner.getMaxGraphSize();
const triples = maxGraphSize > 0 ? this._batchRunner.getDataGraphSize(context) : 0;
Iif (maxGraphSize > 0 && triples > maxGraphSize) {
this._log.info(`Skipped on-change validation for ${context.uri.toString()}: data graph exceeds mentor.shacl.maxGraphSize.`);
this._lastSkips.set(context.uri.toString(), { triples, maxGraphSize });
this._onDidValidate.fire(context.uri);
return;
}
// Reflect the run on the status bar item unless a batch already owns it.
const ownsStatusBar = !this._batchRunner.isValidating;
Eif (ownsStatusBar) {
const fileName = context.uri.path.split('/').pop() ?? context.uri.toString();
this._presenter.showRunning(`$(sync~spin) Validating ${fileName}...`);
}
try {
await this._validateAndPublish(context.uri, context, shapeGraphUris);
} catch (error) {
this._log.error(`SHACL auto-validation failed for ${context.uri.toString()}: ${error}`);
} finally {
Eif (ownsStatusBar) {
this._presenter.clearRunning();
}
}
}
/**
* Whether the document currently has blocking syntax errors: any error-severity
* diagnostic that is not a SHACL result (SHACL diagnostics carry `source: 'SHACL'`).
*/
/**
* Indicates whether the last validation result of a document still reflects its data
* and shape graphs, so that validating it again would produce the same result.
* @param context The document context.
* @param shapeGraphUris The shape graphs the document would be validated against.
*/
private _isLastResultFresh(context: IDocumentContext, shapeGraphUris: string[]): boolean {
const key = context.uri.toString();
return this._lastResults.has(key)
&& this._validationSignatures.get(key) === this._getValidationSignature(context, shapeGraphUris);
}
/**
* Describes the inputs of a validation: the data graphs of the document and the shape
* graphs, each with its version in the store, which changes with every mutation.
* @param context The document context.
* @param shapeGraphUris The shape graphs of the validation.
*/
private _getValidationSignature(context: IDocumentContext, shapeGraphUris: string[]): string {
const describe = (graphUri: string) => `${graphUri}@${this._store.getGraphVersion(graphUri)}`;
const dataGraphs = [...context.graphs].sort().map(describe);
const shapeGraphs = [...shapeGraphUris].sort().map(describe);
return `${dataGraphs.join(' ')}|${shapeGraphs.join(' ')}`;
}
private _hasSyntaxErrors(uri: vscode.Uri): boolean {
return vscode.languages.getDiagnostics(uri).some(diagnostic =>
diagnostic.severity === vscode.DiagnosticSeverity.Error && diagnostic.source !== 'SHACL');
}
/**
* Get the current SHACL validation settings, merging profiles across the
* user and workspace scopes (workspace overrides user on an id conflict).
* See {@link ShaclProfileSettingsService.getMergedSettings}.
*/
getValidationSettings(): ShaclValidationSettings {
return this._profileSettings.getMergedSettings();
}
/**
* Get the workspace-relative location of a document, as matched against the
* profiles's include/exclude entries. Documents outside the workspace get
* an inert location (their full URI as the path) that nothing matches.
*/
getDocumentLocation(documentUri: vscode.Uri): ShaclDocumentLocation {
let uri = documentUri;
// Notebook cells must match by their human-readable slug fragment
// (e.g. notebook.mnb#cell-3) — the same identity used for the cell's graph
// IRI — not the opaque VS Code cell handle carried by the raw cell URI.
if (documentUri.scheme === 'vscode-notebook-cell') {
const context = this._contextService.contexts[documentUri.toString()];
if (context) {
uri = context.graphIri;
}
}
const wsUri = WorkspaceUri.toWorkspaceUri(uri);
if (!wsUri) {
return { path: documentUri.toString() };
}
return {
path: wsUri.relativePath,
fragment: wsUri.fragment || undefined,
};
}
/**
* Get the currently-recognized RDF file extensions (e.g. `.ttl`), used to
* narrow extension-less include/exclude patterns to RDF files.
*/
getRdfExtensions(): string[] {
return Object.entries(this._documentFactory.supportedExtensions)
.filter(([, info]) => info.isTripleSource)
.map(([extension]) => extension);
}
/**
* Get the effective shape graph URIs for a given document.
*/
getEffectiveShapeGraphs(documentUri: vscode.Uri): string[] {
return resolveEffectiveShapeGraphs(this.getValidationSettings(), this.getDocumentLocation(documentUri), this.getRdfExtensions());
}
/**
* Get the shape graph URIs applied to a document by automatic on-change
* validation: the union of the shapes of the matching profiles that have
* `validateOnChange` enabled.
*/
getOnChangeShapeGraphs(documentUri: vscode.Uri): string[] {
return resolveAutoValidationShapeGraphs(this.getValidationSettings(), this.getDocumentLocation(documentUri), this.getRdfExtensions(), 'validateOnChange');
}
/**
* Reacts to a shape-graph change (a shape file was loaded, reloaded or removed)
* by revalidating open documents and re-checking profile health — debounced and
* serialized. Shape loading itself fires the change event, and loading is lazy,
* so a single startup or Settings-Sync tick can fan out into many rapid fires;
* coalescing them into one trailing pass (with at most one follow-up when fires
* arrive mid-pass) prevents the O(fires × open-docs) revalidation storm and the
* repeated validator-cache invalidation it caused.
*/
scheduleShapeGraphReaction(): void {
this._shapeGraphReactionPending = true;
this._shapeGraphReactionDebouncer.schedule(() => void this._flushShapeGraphReaction());
}
private async _flushShapeGraphReaction(): Promise<void> {
// A pass is already running; it will pick up the pending flag and run again.
if (this._shapeGraphReactionRunning) {
return;
}
this._shapeGraphReactionRunning = true;
try {
while (this._shapeGraphReactionPending) {
this._shapeGraphReactionPending = false;
await this.revalidateOpenDocuments();
await this.checkShaclProfiles();
}
} finally {
this._shapeGraphReactionRunning = false;
}
}
/**
* Re-runs on-change validation for all currently open documents, e.g. after
* shape graphs were reloaded from changed user shape files. Respects the
* `mentor.shacl.enabled` setting, the per-profile `validateOnChange` flags
* and all other auto-validation guards.
*/
async revalidateOpenDocuments(): Promise<void> {
const seen = new Set<string>();
for (const editor of vscode.window.visibleTextEditors) {
const key = editor.document.uri.toString();
if (seen.has(key)) {
continue;
}
seen.add(key);
await this._autoValidateOnChange(this._contextService.contexts[key]);
}
}
/**
* Get the fully-resolved validation state of a document, including the
* applied profile ids, for UI purposes such as code lenses.
*/
getDocumentValidationState(documentUri: vscode.Uri): ShaclDocumentValidationState {
return getDocumentValidationState(this.getValidationSettings(), this.getDocumentLocation(documentUri), this.getRdfExtensions());
}
/**
* Validate a document against the specified shape files.
* @param documentUri The URI of the document to validate.
* @param shapeFileUris Workspace-relative paths to SHACL shape files. If empty, effective shapes are used.
* @returns The validation result or undefined if no shapes are available.
*/
async validateDocument(documentUri: vscode.Uri, shapeFileUris?: string[]): Promise<ShaclValidationResult | undefined> {
const context = this._contextService.contexts[documentUri.toString()];
Iif (!context) {
vscode.window.showInformationMessage('No document context available. Please open the document first.');
return undefined;
}
const shapeGraphUris = shapeFileUris?.length ? shapeFileUris : this.getEffectiveShapeGraphs(documentUri);
Iif (shapeGraphUris.length === 0) {
vscode.window.showInformationMessage('No SHACL shape files configured for this document.');
return undefined;
}
const missingShapeGraphs = shapeGraphUris.filter(graphUri => !this._store.hasGraph(graphUri));
Iif (missingShapeGraphs.length > 0) {
vscode.window.showWarningMessage(
`${missingShapeGraphs.length} of ${shapeGraphUris.length} configured shape graphs do not exist — the result may be incomplete: `
+ missingShapeGraphs.join(', ')
);
}
// Concurrent triggers for the same document and shape graph combination
// share a single run through the in-flight guard in _validateAndPublish.
return this._runValidation(documentUri, context, shapeGraphUris);
}
/**
* Validates every workspace file matched by the given profile against that
* profile's shape graphs, publishing diagnostics for each. Files without a
* loaded context (e.g. not yet indexed) are skipped.
* @param profileId The id of the profile to validate.
* @param files The workspace files to consider.
*/
async validateProfile(profileId: string, files: ReadonlyArray<vscode.Uri>, options?: BatchValidationOptions): Promise<ProfileValidationSummary> {
const profile = this.getValidationSettings().profiles?.[profileId];
if (!profile) {
return { matched: 0, validated: 0, issues: 0, errors: 0, warnings: 0, issueFiles: [], hasShapes: false, skipped: 0 };
}
const shapes = toUniqueStringArray(profile.shapes);
const entries = profilePathEntries(profile);
const rdfExtensions = this.getRdfExtensions();
return this._batchRunner.run(`profile "${profileId}"`, files, shapes.length > 0, uri =>
matchesProfilePaths(entries, this.getDocumentLocation(uri), rdfExtensions) ? shapes : undefined,
options
);
}
/**
* Shows running progress text on the shared validation status bar item. Used
* by the Diagnose Workspace command to surface the syntax-diagnostics phase on
* the same item before SHACL validation takes over it.
* @param text The status bar text (may include a `$(sync~spin)` codicon).
*/
showRunningProgress(text: string): void {
this._presenter.showRunning(text);
}
/**
* Validates every workspace file matched by any profile against its effective
* shape graphs (the union of all matching profiles), publishing diagnostics
* for each. Files without a loaded context are skipped.
* @param files The workspace files to consider.
*/
async validateAllProfiles(files: ReadonlyArray<vscode.Uri>, options?: BatchValidationOptions): Promise<ProfileValidationSummary> {
const hasProfiles = Object.keys(this.getValidationSettings().profiles ?? {}).length > 0;
return this._batchRunner.run('workspace', files, hasProfiles, uri => {
const shapes = this.getEffectiveShapeGraphs(uri);
return shapes.length > 0 ? shapes : undefined;
}, options);
}
/**
* Validates every workspace file matched by a profile that has
* `validateOnStartup` enabled against the union of those profiles' shape
* graphs, publishing diagnostics for each. Returns `undefined` without
* running a batch when no profile opts in, so the status bar and the last
* run statistics are untouched.
* @param files The workspace files to consider.
*/
async validateStartupProfiles(files: ReadonlyArray<vscode.Uri>, options?: BatchValidationOptions): Promise<ProfileValidationSummary | undefined> {
const settings = this.getValidationSettings();
if (getAutoValidationProfiles(settings, 'validateOnStartup').length === 0) {
return undefined;
}
const rdfExtensions = this.getRdfExtensions();
return this._batchRunner.run('startup profiles', files, true, uri => {
const shapes = resolveAutoValidationShapeGraphs(settings, this.getDocumentLocation(uri), rdfExtensions, 'validateOnStartup');
return shapes.length > 0 ? shapes : undefined;
}, options);
}
/**
* Whether a batch validation run is currently in flight (and therefore cancellable).
*/
get isValidating(): boolean {
return this._batchRunner.isValidating;
}
/**
* Summary statistics of the most recent batch validation run, or `undefined`
* when no batch has run yet in this session.
*/
get lastRunStatistics(): ValidationRunStatistics | undefined {
return this._batchRunner.statistics;
}
/**
* Reveals the "Mentor Validation" log output channel.
*/
showLog(): void {
this._log.show();
}
/**
* Cancels the batch validation run currently in flight, if any. Invoked (after an
* explicit confirmation) by the `mentor.command.cancelValidation` command that the
* status bar item triggers.
*/
cancelActiveValidation(): void {
this._batchRunner.cancel();
}
/**
* Runs a single-document validation while reflecting it on the status bar item
* and reporting failures with an error notification.
*/
private async _runValidation(documentUri: vscode.Uri, context: IDocumentContext, shapeGraphUris: string[]): Promise<ShaclValidationResult | undefined> {
const fileName = documentUri.path.split('/').pop() ?? documentUri.toString();
// Reflect the single-file run on the dedicated status bar item (no snackbar); it is
// hidden again afterwards. Batch runs manage their own status text. The run is
// started synchronously so a concurrent trigger in the same tick joins it
// through the in-flight guard; the run itself yields before the heavy work,
// which lets VS Code paint the spinner.
this._presenter.showRunning(`$(sync~spin) Validating ${fileName}...`);
try {
return await this._validateAndPublish(documentUri, context, shapeGraphUris);
} catch (error) {
this._log.error(`SHACL validation failed for ${documentUri.toString()}: ${error}`);
vscode.window.showErrorMessage(`SHACL validation failed: ${error}`);
return undefined;
} finally {
this._presenter.clearRunning();
}
}
/**
* Validates a document's data against the given shape graphs and publishes the
* resulting diagnostics. Unlike {@link _runValidation} this shows no status bar
* message, so it is suitable for batch validation of many files.
*/
private _validateAndPublish(documentUri: vscode.Uri, context: IDocumentContext, shapeGraphUris: string[]): Promise<ShaclValidationResult> {
// Coalesce concurrent identical runs (e.g. a shape-graph reaction and a
// document-context change validating the same file) into one.
const key = documentUri.toString() + '\n' + [...shapeGraphUris].sort().join('\n');
const inflight = this._inflightValidations.get(key);
if (inflight) {
return inflight;
}
const run = this._doValidateAndPublish(documentUri, context, shapeGraphUris);
this._inflightValidations.set(key, run);
return run.finally(() => this._inflightValidations.delete(key));
}
private async _doValidateAndPublish(documentUri: vscode.Uri, context: IDocumentContext, shapeGraphUris: string[]): Promise<ShaclValidationResult> {
// Yield once so VS Code can paint status bar updates (the single-run spinner,
// batch progress) before the CPU-bound validation work starts.
await new Promise(resolve => setTimeout(resolve, 0));
// Self-healing shape resolution (ADR-0003): load any referenced workspace shape
// graph that resolves on disk but is not in the store yet, so validation never
// depends on startup ordering or the indexer having walked over the shape file.
await this._shapeGraphs?.ensureLoaded(shapeGraphUris);
// A read-only view over the store — no triple copying needed.
const dataDataset = this._store.getDataset(context.graphs, false);
// Taken before the validation reads the graphs, so a change during the run makes
// the result stale rather than fresh.
const signature = this._getValidationSignature(context, shapeGraphUris);
// Shape graphs that are not in the store contribute no shapes, so the run
// silently validates against less than what the profile promises. Record
// them on the result so consumers (status code lens, report export) can
// present it as incomplete rather than a clean pass. An existing-but-empty
// user shape file is a valid (no-op) reference, not a missing one — the
// same semantics the profile health check applies via hasShapeSource.
const missingShapeGraphs = shapeGraphUris.filter(uri =>
!this._store.hasGraph(uri) && !(this._shapeGraphs?.hasShapeSource(uri) ?? false));
// Time only the data-graph validation here; shape compilation is timed separately
// by the engine. Logging both makes it easy to tell whether a slow "small" file is
// paying for its own validation or for a one-off validator build.
const startTime = performance.now();
const result = await this._engine.validate(shapeGraphUris, dataDataset);
const duration = Math.round(performance.now() - startTime);
if (missingShapeGraphs.length > 0) {
result.missingShapeGraphs = missingShapeGraphs;
this._log.warn(`Validated ${documentUri.toString()} with missing shape graphs: ${missingShapeGraphs.join(', ')}`);
}
this._log.info(`Validated ${documentUri.toString()}: ${duration}ms, ${dataDataset.size} triples, ${result.results.length} issues`);
this._lastResults.set(documentUri.toString(), result);
this._validationSignatures.set(documentUri.toString(), signature);
this._lastSkips.delete(documentUri.toString());
// The quad contexts only refine the positions of results; a clean document needs none.
const quadContexts = result.results.length > 0 ? await this._getQuadContexts(documentUri, context) : undefined;
this._publishDiagnostics(documentUri, context, result, quadContexts);
// During a batch the event is coalesced into a single fire when the batch ends
// (see ShaclBatchRunner); firing per file would refresh the tree/decorations 48× over.
if (!this._batchRunner.isBatchActive) {
this._onDidValidate.fire(documentUri);
}
return result;
}
/**
* Get the last validation result for a document.
*/
getLastResult(documentUri: vscode.Uri): ShaclValidationResult | undefined {
return this._lastResults.get(documentUri.toString());
}
/**
* Get the recorded skip of the last automatic validation run for a document:
* present when the document's data graph exceeded `mentor.shacl.maxGraphSize`
* and no validation has run since. Surfaced by the validation code lens.
*/
getLastSkip(documentUri: vscode.Uri): { triples: number; maxGraphSize: number } | undefined {
return this._lastSkips.get(documentUri.toString());
}
/**
* Clear validation diagnostics for a document.
*/
clearDiagnostics(documentUri: vscode.Uri): void {
this._diagnosticCollection.delete(documentUri);
this._lastResults.delete(documentUri.toString());
this._lastSkips.delete(documentUri.toString());
this._onDidValidate.fire(documentUri);
}
/**
* Get the validation report as plain text.
*/
getReportAsText(documentUri: vscode.Uri): string | undefined {
const result = this._lastResults.get(documentUri.toString());
return result ? formatReportAsText(result) : undefined;
}
/**
* Get the validation report as a Turtle string.
*/
async getReportAsTurtle(documentUri: vscode.Uri): Promise<string | undefined> {
const result = this._lastResults.get(documentUri.toString());
if (!result || !result.reportDataset) {
return undefined;
}
return serializeReportAsTurtle(result);
}
/**
* The quad contexts that map validation results to source positions. Indexed
* files that are not open in an editor have released their tokens; their text
* is read again for the mapping.
* @param documentUri The URI of the validated document.
* @param context The document context.
*/
private async _getQuadContexts(documentUri: vscode.Uri, context: IDocumentContext): Promise<QuadContext[] | undefined> {
Iif (!(context instanceof TurtleDocument)) {
return undefined;
}
if (context.isParsed) {
return context.getQuadContexts();
}
try {
const bytes = await vscode.workspace.fs.readFile(documentUri);
return context.getQuadContextsForText(new TextDecoder().decode(bytes));
} catch (error) {
this._log.warn(`Cannot read ${documentUri.toString()} to map the validation results: ${error}`);
return undefined;
}
}
private _publishDiagnostics(documentUri: vscode.Uri, context: IDocumentContext, result: ShaclValidationResult, quadContexts?: QuadContext[]): void {
const diagnostics = this._diagnosticsMapper.mapToDiagnostics(result, context, quadContexts);
this._diagnosticCollection.set(documentUri, diagnostics);
}
/**
* Checks all validation profiles for broken references. See
* {@link ShaclSettingsSyncService.checkShaclProfiles}.
*/
checkShaclProfiles(): Promise<ShaclBrokenReferences> {
return this.settingsSync.checkShaclProfiles();
}
dispose(): void {
this._shapeGraphReactionDebouncer.dispose();
this._autoValidateDebouncer.dispose();
this._diagnosticCollection.dispose();
for (const d of this._disposables) {
d.dispose();
}
}
}
|