@hydranium/core 1.0.0-next.34 → 1.0.0-next.340
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +78 -82
- package/lib/browser/host-heads-in-worker.d.ts +77 -0
- package/lib/browser/host-heads-in-worker.d.ts.map +1 -0
- package/lib/browser/host-heads-in-worker.js +169 -0
- package/lib/browser/host-heads-in-worker.js.map +1 -0
- package/lib/browser/index.d.ts +12 -0
- package/lib/browser/index.d.ts.map +1 -0
- package/lib/browser/index.js +17 -0
- package/lib/browser/index.js.map +1 -0
- package/lib/browser/indexeddb-file-system-store.d.ts +82 -0
- package/lib/browser/indexeddb-file-system-store.d.ts.map +1 -0
- package/lib/browser/indexeddb-file-system-store.js +181 -0
- package/lib/browser/indexeddb-file-system-store.js.map +1 -0
- package/lib/browser/start-language-server-in-worker.d.ts +32 -0
- package/lib/browser/start-language-server-in-worker.d.ts.map +1 -0
- package/lib/browser/start-language-server-in-worker.js +40 -0
- package/lib/browser/start-language-server-in-worker.js.map +1 -0
- package/lib/documents/ast-document-manager.d.ts +256 -124
- package/lib/documents/ast-document-manager.d.ts.map +1 -1
- package/lib/documents/ast-document-manager.js +293 -132
- package/lib/documents/ast-document-manager.js.map +1 -1
- package/lib/documents/client-ids.d.ts +5 -19
- package/lib/documents/client-ids.d.ts.map +1 -1
- package/lib/documents/client-ids.js +5 -19
- package/lib/documents/client-ids.js.map +1 -1
- package/lib/documents/client-session-errors.d.ts +15 -0
- package/lib/documents/client-session-errors.d.ts.map +1 -0
- package/lib/documents/client-session-errors.js +15 -0
- package/lib/documents/client-session-errors.js.map +1 -0
- package/lib/documents/client-session-registry.d.ts +146 -0
- package/lib/documents/client-session-registry.d.ts.map +1 -0
- package/lib/documents/client-session-registry.js +207 -0
- package/lib/documents/client-session-registry.js.map +1 -0
- package/lib/documents/dirty-state-tracker.d.ts +101 -0
- package/lib/documents/dirty-state-tracker.d.ts.map +1 -0
- package/lib/documents/dirty-state-tracker.js +85 -0
- package/lib/documents/dirty-state-tracker.js.map +1 -0
- package/lib/documents/document-release-handler.d.ts +204 -0
- package/lib/documents/document-release-handler.d.ts.map +1 -0
- package/lib/documents/document-release-handler.js +317 -0
- package/lib/documents/document-release-handler.js.map +1 -0
- package/lib/documents/document-release-scheduler.d.ts +67 -0
- package/lib/documents/document-release-scheduler.d.ts.map +1 -0
- package/lib/documents/document-release-scheduler.js +80 -0
- package/lib/documents/document-release-scheduler.js.map +1 -0
- package/lib/documents/file-system-task-queue.d.ts +52 -0
- package/lib/documents/file-system-task-queue.d.ts.map +1 -0
- package/lib/documents/file-system-task-queue.js +37 -0
- package/lib/documents/file-system-task-queue.js.map +1 -0
- package/lib/documents/hydranium-text-documents.d.ts +445 -282
- package/lib/documents/hydranium-text-documents.d.ts.map +1 -1
- package/lib/documents/hydranium-text-documents.js +903 -483
- package/lib/documents/hydranium-text-documents.js.map +1 -1
- package/lib/documents/index.d.ts +10 -2
- package/lib/documents/index.d.ts.map +1 -1
- package/lib/documents/index.js +10 -2
- package/lib/documents/index.js.map +1 -1
- package/lib/documents/language-client-shadow.d.ts +234 -0
- package/lib/documents/language-client-shadow.d.ts.map +1 -0
- package/lib/documents/language-client-shadow.js +306 -0
- package/lib/documents/language-client-shadow.js.map +1 -0
- package/lib/documents/model-ledger.d.ts +47 -0
- package/lib/documents/model-ledger.d.ts.map +1 -0
- package/lib/documents/model-ledger.js +30 -0
- package/lib/documents/model-ledger.js.map +1 -0
- package/lib/documents/text-ledger.d.ts +64 -0
- package/lib/documents/text-ledger.d.ts.map +1 -0
- package/lib/documents/text-ledger.js +63 -0
- package/lib/documents/text-ledger.js.map +1 -0
- package/lib/documents/version-sync-service.d.ts +138 -0
- package/lib/documents/version-sync-service.d.ts.map +1 -0
- package/lib/documents/version-sync-service.js +173 -0
- package/lib/documents/version-sync-service.js.map +1 -0
- package/lib/index.d.ts +4 -0
- package/lib/index.d.ts.map +1 -1
- package/lib/index.js +7 -0
- package/lib/index.js.map +1 -1
- package/lib/langium/ast-extension/ast-extension-service.d.ts +42 -31
- package/lib/langium/ast-extension/ast-extension-service.d.ts.map +1 -1
- package/lib/langium/ast-extension/ast-extension-service.js +45 -19
- package/lib/langium/ast-extension/ast-extension-service.js.map +1 -1
- package/lib/langium/ast-extension/ast-node-builder.d.ts +12 -7
- package/lib/langium/ast-extension/ast-node-builder.d.ts.map +1 -1
- package/lib/langium/ast-extension/ast-node-builder.js +25 -9
- package/lib/langium/ast-extension/ast-node-builder.js.map +1 -1
- package/lib/langium/bootstrap.d.ts +49 -36
- package/lib/langium/bootstrap.d.ts.map +1 -1
- package/lib/langium/bootstrap.js +83 -44
- package/lib/langium/bootstrap.js.map +1 -1
- package/lib/langium/build-phase-pass/build-phase-pass-service.d.ts +9 -9
- package/lib/langium/build-phase-pass/build-phase-pass-service.d.ts.map +1 -1
- package/lib/langium/build-phase-pass/build-phase-pass-service.js +25 -16
- package/lib/langium/build-phase-pass/build-phase-pass-service.js.map +1 -1
- package/lib/langium/build-phase-pass/build-phase-pass.d.ts +20 -8
- package/lib/langium/build-phase-pass/build-phase-pass.d.ts.map +1 -1
- package/lib/langium/build-phase-pass/build-phase-pass.js +20 -0
- package/lib/langium/build-phase-pass/build-phase-pass.js.map +1 -1
- package/lib/langium/composite-ast-reflection.d.ts +46 -0
- package/lib/langium/composite-ast-reflection.d.ts.map +1 -0
- package/lib/langium/composite-ast-reflection.js +97 -0
- package/lib/langium/composite-ast-reflection.js.map +1 -0
- package/lib/langium/config/configuration-provider.d.ts +81 -0
- package/lib/langium/config/configuration-provider.d.ts.map +1 -0
- package/lib/langium/config/configuration-provider.js +112 -0
- package/lib/langium/config/configuration-provider.js.map +1 -0
- package/lib/langium/config/index.d.ts +1 -0
- package/lib/langium/config/index.d.ts.map +1 -1
- package/lib/langium/config/index.js +1 -0
- package/lib/langium/config/index.js.map +1 -1
- package/lib/langium/config/settings.js.map +1 -1
- package/lib/langium/diagnostics/console-tee.d.ts +27 -0
- package/lib/langium/diagnostics/console-tee.d.ts.map +1 -0
- package/lib/langium/diagnostics/console-tee.js +142 -0
- package/lib/langium/diagnostics/console-tee.js.map +1 -0
- package/lib/langium/diagnostics/format-log-arg.d.ts +18 -0
- package/lib/langium/diagnostics/format-log-arg.d.ts.map +1 -0
- package/lib/langium/diagnostics/format-log-arg.js +36 -0
- package/lib/langium/diagnostics/format-log-arg.js.map +1 -0
- package/lib/langium/diagnostics/hydranium-langium-profiler.d.ts +9 -20
- package/lib/langium/diagnostics/hydranium-langium-profiler.d.ts.map +1 -1
- package/lib/langium/diagnostics/hydranium-langium-profiler.js +15 -24
- package/lib/langium/diagnostics/hydranium-langium-profiler.js.map +1 -1
- package/lib/langium/diagnostics/log-preamble.js +1 -1
- package/lib/langium/diagnostics/log-preamble.js.map +1 -1
- package/lib/langium/diagnostics/logger.d.ts +25 -6
- package/lib/langium/diagnostics/logger.d.ts.map +1 -1
- package/lib/langium/diagnostics/logger.js +49 -17
- package/lib/langium/diagnostics/logger.js.map +1 -1
- package/lib/langium/diagnostics/lsp-logger.d.ts +25 -0
- package/lib/langium/diagnostics/lsp-logger.d.ts.map +1 -1
- package/lib/langium/diagnostics/lsp-logger.js +81 -45
- package/lib/langium/diagnostics/lsp-logger.js.map +1 -1
- package/lib/langium/diagnostics/server-tracer.d.ts.map +1 -1
- package/lib/langium/diagnostics/server-tracer.js.map +1 -1
- package/lib/langium/document-builder/build-pipeline-integration.d.ts +21 -1
- package/lib/langium/document-builder/build-pipeline-integration.d.ts.map +1 -1
- package/lib/langium/document-builder/build-pipeline-integration.js +28 -30
- package/lib/langium/document-builder/build-pipeline-integration.js.map +1 -1
- package/lib/langium/document-builder/build-session.d.ts +6 -5
- package/lib/langium/document-builder/build-session.d.ts.map +1 -1
- package/lib/langium/document-builder/build-session.js +5 -5
- package/lib/langium/document-builder/build-session.js.map +1 -1
- package/lib/langium/document-builder/document-builder.d.ts +283 -41
- package/lib/langium/document-builder/document-builder.d.ts.map +1 -1
- package/lib/langium/document-builder/document-builder.js +449 -79
- package/lib/langium/document-builder/document-builder.js.map +1 -1
- package/lib/langium/documentation/comment-provider.d.ts.map +1 -1
- package/lib/langium/documentation/comment-provider.js.map +1 -1
- package/lib/langium/integration-services.d.ts +40 -24
- package/lib/langium/integration-services.d.ts.map +1 -1
- package/lib/langium/integration-services.js +7 -4
- package/lib/langium/integration-services.js.map +1 -1
- package/lib/langium/integrity/integrity-rule.d.ts +17 -8
- package/lib/langium/integrity/integrity-rule.d.ts.map +1 -1
- package/lib/langium/integrity/integrity-rule.js.map +1 -1
- package/lib/langium/integrity/integrity-service.d.ts +95 -27
- package/lib/langium/integrity/integrity-service.d.ts.map +1 -1
- package/lib/langium/integrity/integrity-service.js +303 -63
- package/lib/langium/integrity/integrity-service.js.map +1 -1
- package/lib/langium/keys/name-based-key-provider.d.ts.map +1 -1
- package/lib/langium/keys/name-based-key-provider.js.map +1 -1
- package/lib/langium/keys/positional-key-provider.d.ts.map +1 -1
- package/lib/langium/keys/positional-key-provider.js.map +1 -1
- package/lib/langium/labeling/label-provider.d.ts.map +1 -1
- package/lib/langium/labeling/label-provider.js.map +1 -1
- package/lib/langium/language-module.d.ts +30 -5
- package/lib/langium/language-module.d.ts.map +1 -1
- package/lib/langium/language-module.js +18 -4
- package/lib/langium/language-module.js.map +1 -1
- package/lib/langium/model-service/client-session.d.ts +383 -0
- package/lib/langium/model-service/client-session.d.ts.map +1 -0
- package/lib/langium/model-service/client-session.js +455 -0
- package/lib/langium/model-service/client-session.js.map +1 -0
- package/lib/langium/model-service/index.d.ts +2 -0
- package/lib/langium/model-service/index.d.ts.map +1 -1
- package/lib/langium/model-service/index.js +2 -0
- package/lib/langium/model-service/index.js.map +1 -1
- package/lib/langium/model-service/model-events.d.ts +66 -0
- package/lib/langium/model-service/model-events.d.ts.map +1 -0
- package/lib/langium/model-service/model-events.js +10 -0
- package/lib/langium/model-service/model-events.js.map +1 -0
- package/lib/langium/model-service/model-service.d.ts +456 -300
- package/lib/langium/model-service/model-service.d.ts.map +1 -1
- package/lib/langium/model-service/model-service.js +571 -466
- package/lib/langium/model-service/model-service.js.map +1 -1
- package/lib/langium/module.d.ts +141 -40
- package/lib/langium/module.d.ts.map +1 -1
- package/lib/langium/module.js +52 -40
- package/lib/langium/module.js.map +1 -1
- package/lib/langium/naming/name-provider.d.ts +32 -7
- package/lib/langium/naming/name-provider.d.ts.map +1 -1
- package/lib/langium/naming/name-provider.js +10 -4
- package/lib/langium/naming/name-provider.js.map +1 -1
- package/lib/langium/naming/name-separator-validation.d.ts.map +1 -1
- package/lib/langium/project/abstract-project-manager.d.ts.map +1 -1
- package/lib/langium/project/abstract-project-manager.js +13 -6
- package/lib/langium/project/abstract-project-manager.js.map +1 -1
- package/lib/langium/project/project-change-event.d.ts +2 -2
- package/lib/langium/project/single-project-manager.d.ts.map +1 -1
- package/lib/langium/project/single-project-manager.js.map +1 -1
- package/lib/langium/residency/cst-residency-service.d.ts +38 -14
- package/lib/langium/residency/cst-residency-service.d.ts.map +1 -1
- package/lib/langium/residency/cst-residency-service.js +24 -58
- package/lib/langium/residency/cst-residency-service.js.map +1 -1
- package/lib/langium/scope/ast-node-description-provider.d.ts.map +1 -1
- package/lib/langium/scope/ast-node-description-provider.js.map +1 -1
- package/lib/langium/scope/fallback-scope.d.ts +27 -0
- package/lib/langium/scope/fallback-scope.d.ts.map +1 -0
- package/lib/langium/scope/fallback-scope.js +35 -0
- package/lib/langium/scope/fallback-scope.js.map +1 -0
- package/lib/langium/scope/hydranium-scope-computation.d.ts +21 -18
- package/lib/langium/scope/hydranium-scope-computation.d.ts.map +1 -1
- package/lib/langium/scope/hydranium-scope-computation.js +38 -39
- package/lib/langium/scope/hydranium-scope-computation.js.map +1 -1
- package/lib/langium/scope/hydranium-scope-provider.d.ts +66 -26
- package/lib/langium/scope/hydranium-scope-provider.d.ts.map +1 -1
- package/lib/langium/scope/hydranium-scope-provider.js +114 -33
- package/lib/langium/scope/hydranium-scope-provider.js.map +1 -1
- package/lib/langium/scope/index.d.ts +1 -0
- package/lib/langium/scope/index.d.ts.map +1 -1
- package/lib/langium/scope/index.js +1 -0
- package/lib/langium/scope/index.js.map +1 -1
- package/lib/langium/scope/reference-builder.d.ts.map +1 -1
- package/lib/langium/scope/reference-builder.js.map +1 -1
- package/lib/langium/scope/reference-candidate-provider.d.ts +6 -5
- package/lib/langium/scope/reference-candidate-provider.d.ts.map +1 -1
- package/lib/langium/scope/reference-candidate-provider.js +3 -2
- package/lib/langium/scope/reference-candidate-provider.js.map +1 -1
- package/lib/langium/scope/scope-extension-service.d.ts +41 -37
- package/lib/langium/scope/scope-extension-service.d.ts.map +1 -1
- package/lib/langium/scope/scope-extension-service.js +57 -29
- package/lib/langium/scope/scope-extension-service.js.map +1 -1
- package/lib/langium/scope/scoped-ast-node-description.d.ts +1 -3
- package/lib/langium/scope/scoped-ast-node-description.d.ts.map +1 -1
- package/lib/langium/scope/scoped-ast-node-description.js +1 -3
- package/lib/langium/scope/scoped-ast-node-description.js.map +1 -1
- package/lib/langium/serialization/abstract-serializer.d.ts +38 -27
- package/lib/langium/serialization/abstract-serializer.d.ts.map +1 -1
- package/lib/langium/serialization/abstract-serializer.js +54 -30
- package/lib/langium/serialization/abstract-serializer.js.map +1 -1
- package/lib/langium/serialization/json-serializer.d.ts +8 -1
- package/lib/langium/serialization/json-serializer.d.ts.map +1 -1
- package/lib/langium/serialization/json-serializer.js +13 -3
- package/lib/langium/serialization/json-serializer.js.map +1 -1
- package/lib/langium/serialization/serializer.d.ts +1 -1
- package/lib/langium/serialization/yaml-serializer.d.ts +4 -0
- package/lib/langium/serialization/yaml-serializer.d.ts.map +1 -1
- package/lib/langium/serialization/yaml-serializer.js +4 -0
- package/lib/langium/serialization/yaml-serializer.js.map +1 -1
- package/lib/langium/service-registry.d.ts +29 -1
- package/lib/langium/service-registry.d.ts.map +1 -1
- package/lib/langium/service-registry.js +37 -0
- package/lib/langium/service-registry.js.map +1 -1
- package/lib/langium/shared-services.d.ts +13 -7
- package/lib/langium/shared-services.d.ts.map +1 -1
- package/lib/langium/shared-services.js.map +1 -1
- package/lib/langium/single-langium-copy.d.ts +22 -0
- package/lib/langium/single-langium-copy.d.ts.map +1 -0
- package/lib/langium/single-langium-copy.js +36 -0
- package/lib/langium/single-langium-copy.js.map +1 -0
- package/lib/langium/transfer/transfer-encoder.d.ts +86 -37
- package/lib/langium/transfer/transfer-encoder.d.ts.map +1 -1
- package/lib/langium/transfer/transfer-encoder.js +36 -25
- package/lib/langium/transfer/transfer-encoder.js.map +1 -1
- package/lib/langium/trivia/comment-preserver.d.ts +543 -0
- package/lib/langium/trivia/comment-preserver.d.ts.map +1 -0
- package/lib/langium/trivia/comment-preserver.js +1164 -0
- package/lib/langium/trivia/comment-preserver.js.map +1 -0
- package/lib/langium/trivia/document-ending-preserver.d.ts +51 -0
- package/lib/langium/trivia/document-ending-preserver.d.ts.map +1 -0
- package/lib/langium/trivia/document-ending-preserver.js +62 -0
- package/lib/langium/trivia/document-ending-preserver.js.map +1 -0
- package/lib/langium/trivia/index.d.ts +14 -0
- package/lib/langium/trivia/index.d.ts.map +1 -0
- package/lib/langium/trivia/index.js +14 -0
- package/lib/langium/trivia/index.js.map +1 -0
- package/lib/langium/trivia/trivia-contribution.d.ts +37 -0
- package/lib/langium/trivia/trivia-contribution.d.ts.map +1 -0
- package/lib/langium/trivia/trivia-contribution.js +10 -0
- package/lib/langium/trivia/trivia-contribution.js.map +1 -0
- package/lib/langium/trivia/trivia-preserver.d.ts +52 -0
- package/lib/langium/trivia/trivia-preserver.d.ts.map +1 -0
- package/lib/langium/trivia/trivia-preserver.js +10 -0
- package/lib/langium/trivia/trivia-preserver.js.map +1 -0
- package/lib/langium/trivia/trivia-service.d.ts +70 -0
- package/lib/langium/trivia/trivia-service.d.ts.map +1 -0
- package/lib/langium/trivia/trivia-service.js +56 -0
- package/lib/langium/trivia/trivia-service.js.map +1 -0
- package/lib/langium/update-rewrite/normalize-empty-strings.d.ts.map +1 -1
- package/lib/langium/update-rewrite/update-rewrite-service.d.ts +1 -1
- package/lib/langium/update-rewrite/update-rewrite-service.d.ts.map +1 -1
- package/lib/langium/update-rewrite/update-rewrite-service.js.map +1 -1
- package/lib/langium/update-rewrite/update-rewrite.d.ts +1 -1
- package/lib/langium/validation/document-validator.d.ts +168 -23
- package/lib/langium/validation/document-validator.d.ts.map +1 -1
- package/lib/langium/validation/document-validator.js +264 -26
- package/lib/langium/validation/document-validator.js.map +1 -1
- package/lib/langium/validation/validation-contribution-collector.d.ts +9 -1
- package/lib/langium/validation/validation-contribution-collector.d.ts.map +1 -1
- package/lib/langium/validation/validation-contribution-collector.js +1 -1
- package/lib/langium/validation/validation-contribution-collector.js.map +1 -1
- package/lib/langium/workspace/document-uri-policy.d.ts +24 -15
- package/lib/langium/workspace/document-uri-policy.d.ts.map +1 -1
- package/lib/langium/workspace/document-uri-policy.js +22 -13
- package/lib/langium/workspace/document-uri-policy.js.map +1 -1
- package/lib/langium/workspace/file-not-found.d.ts +23 -0
- package/lib/langium/workspace/file-not-found.d.ts.map +1 -0
- package/lib/langium/workspace/file-not-found.js +31 -0
- package/lib/langium/workspace/file-not-found.js.map +1 -0
- package/lib/langium/workspace/file-system-provider.d.ts +167 -8
- package/lib/langium/workspace/file-system-provider.d.ts.map +1 -1
- package/lib/langium/workspace/file-system-provider.js +115 -13
- package/lib/langium/workspace/file-system-provider.js.map +1 -1
- package/lib/langium/workspace/hydranium-langium-document-factory.d.ts +31 -1
- package/lib/langium/workspace/hydranium-langium-document-factory.d.ts.map +1 -1
- package/lib/langium/workspace/hydranium-langium-document-factory.js +54 -0
- package/lib/langium/workspace/hydranium-langium-document-factory.js.map +1 -1
- package/lib/langium/workspace/hydranium-workspace-lock.d.ts +43 -1
- package/lib/langium/workspace/hydranium-workspace-lock.d.ts.map +1 -1
- package/lib/langium/workspace/hydranium-workspace-lock.js +58 -1
- package/lib/langium/workspace/hydranium-workspace-lock.js.map +1 -1
- package/lib/langium/workspace/hydranium-workspace-manager.d.ts +103 -21
- package/lib/langium/workspace/hydranium-workspace-manager.d.ts.map +1 -1
- package/lib/langium/workspace/hydranium-workspace-manager.js +184 -31
- package/lib/langium/workspace/hydranium-workspace-manager.js.map +1 -1
- package/lib/langium/workspace/in-memory-file-system-provider.d.ts +26 -9
- package/lib/langium/workspace/in-memory-file-system-provider.d.ts.map +1 -1
- package/lib/langium/workspace/in-memory-file-system-provider.js +45 -22
- package/lib/langium/workspace/in-memory-file-system-provider.js.map +1 -1
- package/lib/langium/workspace/index-manager.d.ts.map +1 -1
- package/lib/langium/workspace/index-manager.js.map +1 -1
- package/lib/langium/workspace/index.d.ts +1 -0
- package/lib/langium/workspace/index.d.ts.map +1 -1
- package/lib/langium/workspace/index.js +1 -0
- package/lib/langium/workspace/index.js.map +1 -1
- package/lib/langium/workspace/initialize-workspace.d.ts +40 -3
- package/lib/langium/workspace/initialize-workspace.d.ts.map +1 -1
- package/lib/langium/workspace/initialize-workspace.js +68 -3
- package/lib/langium/workspace/initialize-workspace.js.map +1 -1
- package/lib/langium/workspace/langium-documents.d.ts +7 -0
- package/lib/langium/workspace/langium-documents.d.ts.map +1 -1
- package/lib/langium/workspace/langium-documents.js +18 -1
- package/lib/langium/workspace/langium-documents.js.map +1 -1
- package/lib/langium/workspace/persistent-file-system-provider.d.ts +16 -10
- package/lib/langium/workspace/persistent-file-system-provider.d.ts.map +1 -1
- package/lib/langium/workspace/persistent-file-system-provider.js +25 -13
- package/lib/langium/workspace/persistent-file-system-provider.js.map +1 -1
- package/lib/langium/workspace/self-save-registry.d.ts +84 -0
- package/lib/langium/workspace/self-save-registry.d.ts.map +1 -0
- package/lib/{documents → langium/workspace}/self-save-registry.js +33 -22
- package/lib/langium/workspace/self-save-registry.js.map +1 -0
- package/lib/langium/workspace/virtual-document.d.ts +55 -21
- package/lib/langium/workspace/virtual-document.d.ts.map +1 -1
- package/lib/langium/workspace/virtual-document.js +87 -24
- package/lib/langium/workspace/virtual-document.js.map +1 -1
- package/lib/langium/workspace/write-lock-scope.d.ts +22 -10
- package/lib/langium/workspace/write-lock-scope.d.ts.map +1 -1
- package/lib/langium/workspace/write-lock-scope.js +15 -5
- package/lib/langium/workspace/write-lock-scope.js.map +1 -1
- package/lib/launcher/integrated-server.d.ts +3 -1
- package/lib/launcher/integrated-server.d.ts.map +1 -1
- package/lib/locale/server-locale.d.ts +19 -5
- package/lib/locale/server-locale.d.ts.map +1 -1
- package/lib/locale/server-locale.js +1 -1
- package/lib/locale/server-locale.js.map +1 -1
- package/lib/lsp/completion/hydranium-completion-provider.d.ts +44 -2
- package/lib/lsp/completion/hydranium-completion-provider.d.ts.map +1 -1
- package/lib/lsp/completion/hydranium-completion-provider.js +68 -0
- package/lib/lsp/completion/hydranium-completion-provider.js.map +1 -1
- package/lib/lsp/connection-features.d.ts +23 -0
- package/lib/lsp/connection-features.d.ts.map +1 -0
- package/lib/lsp/connection-features.js +60 -0
- package/lib/lsp/connection-features.js.map +1 -0
- package/lib/lsp/diagnostics-connection.d.ts +27 -0
- package/lib/lsp/diagnostics-connection.d.ts.map +1 -0
- package/lib/lsp/diagnostics-connection.js +53 -0
- package/lib/lsp/diagnostics-connection.js.map +1 -0
- package/lib/lsp/edit-requests-guard.d.ts +31 -0
- package/lib/lsp/edit-requests-guard.d.ts.map +1 -0
- package/lib/lsp/edit-requests-guard.js +125 -0
- package/lib/lsp/edit-requests-guard.js.map +1 -0
- package/lib/lsp/hydranium-document-update-handler.d.ts +126 -82
- package/lib/lsp/hydranium-document-update-handler.d.ts.map +1 -1
- package/lib/lsp/hydranium-document-update-handler.js +235 -102
- package/lib/lsp/hydranium-document-update-handler.js.map +1 -1
- package/lib/lsp/index.d.ts +6 -2
- package/lib/lsp/index.d.ts.map +1 -1
- package/lib/lsp/index.js +6 -2
- package/lib/lsp/index.js.map +1 -1
- package/lib/lsp/lsp-latency.d.ts +39 -0
- package/lib/lsp/lsp-latency.d.ts.map +1 -0
- package/lib/lsp/lsp-latency.js +58 -0
- package/lib/lsp/lsp-latency.js.map +1 -0
- package/lib/lsp/save-text-document.d.ts +31 -0
- package/lib/lsp/save-text-document.d.ts.map +1 -0
- package/lib/lsp/save-text-document.js +52 -0
- package/lib/lsp/save-text-document.js.map +1 -0
- package/lib/lsp/semantic-token-provider.d.ts +58 -2
- package/lib/lsp/semantic-token-provider.d.ts.map +1 -1
- package/lib/lsp/semantic-token-provider.js +98 -9
- package/lib/lsp/semantic-token-provider.js.map +1 -1
- package/lib/lsp/shared-module.d.ts +4 -8
- package/lib/lsp/shared-module.d.ts.map +1 -1
- package/lib/lsp/shared-module.js.map +1 -1
- package/lib/lsp/start-language-server.d.ts +12 -7
- package/lib/lsp/start-language-server.d.ts.map +1 -1
- package/lib/lsp/start-language-server.js +21 -7
- package/lib/lsp/start-language-server.js.map +1 -1
- package/lib/messages/carriers.d.ts +4 -6
- package/lib/messages/carriers.d.ts.map +1 -1
- package/lib/messages/carriers.js +4 -6
- package/lib/messages/carriers.js.map +1 -1
- package/lib/messages/index.d.ts +2 -2
- package/lib/messages/index.d.ts.map +1 -1
- package/lib/messages/index.js +2 -2
- package/lib/messages/index.js.map +1 -1
- package/lib/messages/renderer.d.ts +32 -7
- package/lib/messages/renderer.d.ts.map +1 -1
- package/lib/messages/renderer.js +7 -1
- package/lib/messages/renderer.js.map +1 -1
- package/lib/node/event-loop-monitor.d.ts.map +1 -1
- package/lib/node/event-loop-monitor.js +2 -1
- package/lib/node/event-loop-monitor.js.map +1 -1
- package/lib/node/heap-ceiling.d.ts +61 -0
- package/lib/node/heap-ceiling.d.ts.map +1 -0
- package/lib/node/heap-ceiling.js +72 -0
- package/lib/node/heap-ceiling.js.map +1 -0
- package/lib/node/index.d.ts +1 -1
- package/lib/node/index.d.ts.map +1 -1
- package/lib/node/index.js +5 -1
- package/lib/node/index.js.map +1 -1
- package/lib/node/latency-from-env.d.ts +1 -1
- package/lib/node/latency-from-env.js +1 -1
- package/lib/node/lint-grammar.js.map +1 -1
- package/lib/node/log-file-sink.d.ts +3 -2
- package/lib/node/log-file-sink.d.ts.map +1 -1
- package/lib/node/log-file-sink.js +6 -2
- package/lib/node/log-file-sink.js.map +1 -1
- package/lib/node/log-preamble-node.d.ts +5 -3
- package/lib/node/log-preamble-node.d.ts.map +1 -1
- package/lib/node/log-preamble-node.js +13 -10
- package/lib/node/log-preamble-node.js.map +1 -1
- package/lib/node/measure-memory.d.ts.map +1 -1
- package/lib/node/measure-memory.js +5 -4
- package/lib/node/measure-memory.js.map +1 -1
- package/lib/node/memory-monitor.d.ts +2 -2
- package/lib/node/memory-monitor.d.ts.map +1 -1
- package/lib/node/memory-monitor.js +9 -10
- package/lib/node/memory-monitor.js.map +1 -1
- package/lib/node/node-file-system-provider.d.ts +67 -9
- package/lib/node/node-file-system-provider.d.ts.map +1 -1
- package/lib/node/node-file-system-provider.js +198 -53
- package/lib/node/node-file-system-provider.js.map +1 -1
- package/lib/node/profile-capture.d.ts +12 -4
- package/lib/node/profile-capture.d.ts.map +1 -1
- package/lib/node/profile-capture.js +8 -6
- package/lib/node/profile-capture.js.map +1 -1
- package/lib/node/profile-digest.js.map +1 -1
- package/lib/node/profiling-run.d.ts +13 -3
- package/lib/node/profiling-run.d.ts.map +1 -1
- package/lib/node/profiling-run.js +17 -8
- package/lib/node/profiling-run.js.map +1 -1
- package/lib/node/rename-over-open-readers.d.ts +61 -0
- package/lib/node/rename-over-open-readers.d.ts.map +1 -0
- package/lib/node/rename-over-open-readers.js +80 -0
- package/lib/node/rename-over-open-readers.js.map +1 -0
- package/lib/node/server-diagnostics.js +1 -1
- package/lib/node/server-diagnostics.js.map +1 -1
- package/lib/node/server-state-snapshot.js +4 -4
- package/lib/node/server-state-snapshot.js.map +1 -1
- package/lib/node/socket-launcher.d.ts +43 -7
- package/lib/node/socket-launcher.d.ts.map +1 -1
- package/lib/node/socket-launcher.js +42 -7
- package/lib/node/socket-launcher.js.map +1 -1
- package/lib/node/startup-cpu-profile.d.ts +29 -0
- package/lib/node/startup-cpu-profile.d.ts.map +1 -0
- package/lib/node/startup-cpu-profile.js +91 -0
- package/lib/node/startup-cpu-profile.js.map +1 -0
- package/lib/node/stdio-launcher.d.ts +13 -13
- package/lib/node/stdio-launcher.d.ts.map +1 -1
- package/lib/node/stdio-launcher.js +21 -11
- package/lib/node/stdio-launcher.js.map +1 -1
- package/lib/node/validate-workspace.d.ts +1 -1
- package/lib/node/validate-workspace.d.ts.map +1 -1
- package/lib/node/validate-workspace.js +5 -1
- package/lib/node/validate-workspace.js.map +1 -1
- package/lib/testing/document-uri-policy-conformance.js +1 -1
- package/lib/testing/document-uri-policy-conformance.js.map +1 -1
- package/lib/testing/fake-description.js.map +1 -1
- package/lib/testing/fake-document.d.ts +2 -1
- package/lib/testing/fake-document.d.ts.map +1 -1
- package/lib/testing/fake-document.js.map +1 -1
- package/lib/testing/index.d.ts +1 -1
- package/lib/testing/index.d.ts.map +1 -1
- package/lib/testing/index.js +2 -1
- package/lib/testing/index.js.map +1 -1
- package/lib/testing/langium-test-helpers.d.ts.map +1 -1
- package/lib/testing/langium-test-helpers.js +1 -0
- package/lib/testing/langium-test-helpers.js.map +1 -1
- package/lib/testing/make-noop-language-services.js.map +1 -1
- package/lib/testing/make-noop-shared-services.d.ts +4 -4
- package/lib/testing/make-noop-shared-services.d.ts.map +1 -1
- package/lib/testing/make-noop-shared-services.js +4 -4
- package/lib/testing/make-noop-shared-services.js.map +1 -1
- package/lib/testing/make-test-services.d.ts +51 -20
- package/lib/testing/make-test-services.d.ts.map +1 -1
- package/lib/testing/make-test-services.js +29 -13
- package/lib/testing/make-test-services.js.map +1 -1
- package/lib/testing/make-test-tracer.d.ts +12 -0
- package/lib/testing/make-test-tracer.d.ts.map +1 -1
- package/lib/testing/make-test-tracer.js +13 -0
- package/lib/testing/make-test-tracer.js.map +1 -1
- package/lib/testing/node/applied-edit-capture.d.ts +29 -0
- package/lib/testing/node/applied-edit-capture.d.ts.map +1 -0
- package/lib/testing/node/applied-edit-capture.js +117 -0
- package/lib/testing/node/applied-edit-capture.js.map +1 -0
- package/lib/testing/node/golden-corpus.js.map +1 -1
- package/lib/testing/node/index.d.ts +1 -0
- package/lib/testing/node/index.d.ts.map +1 -1
- package/lib/testing/node/index.js +1 -0
- package/lib/testing/node/index.js.map +1 -1
- package/lib/testing/node/lsp-harness.d.ts.map +1 -1
- package/lib/testing/node/lsp-harness.js +2 -0
- package/lib/testing/node/lsp-harness.js.map +1 -1
- package/lib/testing/node/lsp-server-connection.d.ts +21 -6
- package/lib/testing/node/lsp-server-connection.d.ts.map +1 -1
- package/lib/testing/node/lsp-server-connection.js +49 -106
- package/lib/testing/node/lsp-server-connection.js.map +1 -1
- package/lib/testing/node/scratch-workspace.d.ts.map +1 -1
- package/lib/testing/node/scratch-workspace.js +10 -5
- package/lib/testing/node/scratch-workspace.js.map +1 -1
- package/lib/testing/node/spawned-server.d.ts +30 -1
- package/lib/testing/node/spawned-server.d.ts.map +1 -1
- package/lib/testing/node/spawned-server.js +39 -2
- package/lib/testing/node/spawned-server.js.map +1 -1
- package/lib/testing/node/unhandled-rejections.d.ts +20 -0
- package/lib/testing/node/unhandled-rejections.d.ts.map +1 -0
- package/lib/testing/node/unhandled-rejections.js +32 -0
- package/lib/testing/node/unhandled-rejections.js.map +1 -0
- package/lib/testing/playwright/browser-capture-bridge.js.map +1 -1
- package/lib/testing/playwright/e2e-profiling.js.map +1 -1
- package/lib/testing/playwright/flaky-network-proxy.d.ts +76 -0
- package/lib/testing/playwright/flaky-network-proxy.d.ts.map +1 -0
- package/lib/testing/playwright/flaky-network-proxy.js +164 -0
- package/lib/testing/playwright/flaky-network-proxy.js.map +1 -0
- package/lib/testing/playwright/index.d.ts +1 -0
- package/lib/testing/playwright/index.d.ts.map +1 -1
- package/lib/testing/playwright/index.js +1 -0
- package/lib/testing/playwright/index.js.map +1 -1
- package/lib/testing/playwright/server-log-capture.d.ts +46 -16
- package/lib/testing/playwright/server-log-capture.d.ts.map +1 -1
- package/lib/testing/playwright/server-log-capture.js +111 -40
- package/lib/testing/playwright/server-log-capture.js.map +1 -1
- package/lib/testing/playwright/server-log-fixture.d.ts +16 -0
- package/lib/testing/playwright/server-log-fixture.d.ts.map +1 -1
- package/lib/testing/playwright/server-log-fixture.js +25 -6
- package/lib/testing/playwright/server-log-fixture.js.map +1 -1
- package/lib/testing/playwright/server-log-region.d.ts +15 -0
- package/lib/testing/playwright/server-log-region.d.ts.map +1 -0
- package/lib/testing/playwright/server-log-region.js +30 -0
- package/lib/testing/playwright/server-log-region.js.map +1 -0
- package/lib/testing/playwright/server-log-rename-reporter.d.ts.map +1 -1
- package/lib/testing/playwright/server-log-rename-reporter.js +4 -3
- package/lib/testing/playwright/server-log-rename-reporter.js.map +1 -1
- package/lib/testing/run-update-pipeline.d.ts +8 -5
- package/lib/testing/run-update-pipeline.d.ts.map +1 -1
- package/lib/testing/run-update-pipeline.js.map +1 -1
- package/lib/testing/stub-ast-document-manager.d.ts +11 -52
- package/lib/testing/stub-ast-document-manager.d.ts.map +1 -1
- package/lib/testing/stub-ast-document-manager.js +31 -62
- package/lib/testing/stub-ast-document-manager.js.map +1 -1
- package/lib/testing/stub-document-builder.d.ts +33 -11
- package/lib/testing/stub-document-builder.d.ts.map +1 -1
- package/lib/testing/stub-document-builder.js +103 -5
- package/lib/testing/stub-document-builder.js.map +1 -1
- package/lib/testing/stub-hydranium-text-documents.d.ts +33 -10
- package/lib/testing/stub-hydranium-text-documents.d.ts.map +1 -1
- package/lib/testing/stub-hydranium-text-documents.js +132 -16
- package/lib/testing/stub-hydranium-text-documents.js.map +1 -1
- package/lib/testing/stub-index-manager.js.map +1 -1
- package/lib/testing/stub-langium-documents.d.ts +3 -2
- package/lib/testing/stub-langium-documents.d.ts.map +1 -1
- package/lib/testing/stub-langium-documents.js.map +1 -1
- package/lib/testing/stub-model-service.d.ts +9 -8
- package/lib/testing/stub-model-service.d.ts.map +1 -1
- package/lib/testing/stub-model-service.js +6 -6
- package/lib/testing/stub-model-service.js.map +1 -1
- package/lib/testing/stub-project-manager.js.map +1 -1
- package/lib/testing/stub-self-save-registry.d.ts +1 -1
- package/lib/testing/stub-self-save-registry.d.ts.map +1 -1
- package/lib/testing/stub-service-registry.d.ts +1 -1
- package/lib/testing/stub-service-registry.js.map +1 -1
- package/lib/testing/stub-writable-file-system.d.ts +1 -1
- package/lib/testing/stub-writable-file-system.d.ts.map +1 -1
- package/lib/testing/stub-writable-file-system.js +2 -1
- package/lib/testing/stub-writable-file-system.js.map +1 -1
- package/lib/util/connection-liveness.d.ts +22 -6
- package/lib/util/connection-liveness.d.ts.map +1 -1
- package/lib/util/connection-liveness.js +74 -15
- package/lib/util/connection-liveness.js.map +1 -1
- package/lib/util/environment.d.ts +7 -0
- package/lib/util/environment.d.ts.map +1 -1
- package/lib/util/environment.js +15 -1
- package/lib/util/environment.js.map +1 -1
- package/lib/util/registry.d.ts.map +1 -1
- package/package.json +41 -60
- package/src/browser/host-heads-in-worker.ts +218 -0
- package/src/browser/index.ts +17 -0
- package/src/browser/indexeddb-file-system-store.ts +192 -0
- package/src/browser/start-language-server-in-worker.ts +56 -0
- package/src/documents/ast-document-manager.ts +467 -233
- package/src/documents/client-ids.ts +5 -22
- package/src/documents/client-session-errors.ts +24 -0
- package/src/documents/client-session-registry.ts +262 -0
- package/src/documents/dirty-state-tracker.ts +167 -0
- package/src/documents/document-release-handler.ts +404 -0
- package/src/documents/document-release-scheduler.ts +121 -0
- package/src/documents/file-system-task-queue.ts +74 -0
- package/src/documents/hydranium-text-documents.ts +1029 -595
- package/src/documents/index.ts +10 -2
- package/src/documents/language-client-shadow.ts +501 -0
- package/src/documents/model-ledger.ts +66 -0
- package/src/documents/text-ledger.ts +112 -0
- package/src/documents/version-sync-service.ts +275 -0
- package/src/index.ts +7 -0
- package/src/langium/ast-extension/ast-extension-service.ts +77 -41
- package/src/langium/ast-extension/ast-node-builder.ts +35 -13
- package/src/langium/bootstrap.ts +87 -51
- package/src/langium/build-phase-pass/build-phase-pass-service.ts +29 -19
- package/src/langium/build-phase-pass/build-phase-pass.ts +37 -8
- package/src/langium/composite-ast-reflection.ts +112 -0
- package/src/langium/config/configuration-provider.ts +119 -0
- package/src/langium/config/index.ts +1 -0
- package/src/langium/diagnostics/console-tee.ts +151 -0
- package/src/langium/diagnostics/format-log-arg.ts +36 -0
- package/src/langium/diagnostics/hydranium-langium-profiler.ts +15 -39
- package/src/langium/diagnostics/log-preamble.ts +1 -1
- package/src/langium/diagnostics/logger.ts +51 -17
- package/src/langium/diagnostics/lsp-logger.ts +83 -44
- package/src/langium/document-builder/build-pipeline-integration.ts +46 -32
- package/src/langium/document-builder/build-session.ts +4 -3
- package/src/langium/document-builder/document-builder.ts +554 -79
- package/src/langium/integration-services.ts +59 -28
- package/src/langium/integrity/integrity-rule.ts +17 -8
- package/src/langium/integrity/integrity-service.ts +332 -69
- package/src/langium/language-module.ts +49 -8
- package/src/langium/model-service/client-session.ts +718 -0
- package/src/langium/model-service/index.ts +2 -0
- package/src/langium/model-service/model-events.ts +80 -0
- package/src/langium/model-service/model-service.ts +878 -494
- package/src/langium/module.ts +195 -72
- package/src/langium/naming/name-provider.ts +34 -8
- package/src/langium/project/abstract-project-manager.ts +13 -5
- package/src/langium/project/project-change-event.ts +2 -2
- package/src/langium/residency/cst-residency-service.ts +54 -19
- package/src/langium/scope/fallback-scope.ts +38 -0
- package/src/langium/scope/hydranium-scope-computation.ts +45 -44
- package/src/langium/scope/hydranium-scope-provider.ts +132 -33
- package/src/langium/scope/index.ts +1 -0
- package/src/langium/scope/reference-candidate-provider.ts +6 -5
- package/src/langium/scope/scope-extension-service.ts +74 -59
- package/src/langium/scope/scoped-ast-node-description.ts +1 -3
- package/src/langium/serialization/abstract-serializer.ts +57 -41
- package/src/langium/serialization/json-serializer.ts +14 -3
- package/src/langium/serialization/serializer.ts +1 -1
- package/src/langium/serialization/yaml-serializer.ts +4 -0
- package/src/langium/service-registry.ts +41 -2
- package/src/langium/shared-services.ts +16 -7
- package/src/langium/single-langium-copy.ts +42 -0
- package/src/langium/transfer/transfer-encoder.ts +104 -47
- package/src/langium/trivia/comment-preserver.ts +1409 -0
- package/src/langium/trivia/document-ending-preserver.ts +71 -0
- package/src/langium/trivia/index.ts +14 -0
- package/src/langium/trivia/trivia-contribution.ts +39 -0
- package/src/langium/trivia/trivia-preserver.ts +56 -0
- package/src/langium/trivia/trivia-service.ts +99 -0
- package/src/langium/update-rewrite/update-rewrite-service.ts +1 -1
- package/src/langium/update-rewrite/update-rewrite.ts +1 -1
- package/src/langium/validation/document-validator.ts +312 -31
- package/src/langium/validation/validation-contribution-collector.ts +10 -1
- package/src/langium/workspace/document-uri-policy.ts +32 -18
- package/src/langium/workspace/file-not-found.ts +35 -0
- package/src/langium/workspace/file-system-provider.ts +258 -16
- package/src/langium/workspace/hydranium-langium-document-factory.ts +83 -0
- package/src/langium/workspace/hydranium-workspace-lock.ts +86 -2
- package/src/langium/workspace/hydranium-workspace-manager.ts +212 -35
- package/src/langium/workspace/in-memory-file-system-provider.ts +54 -23
- package/src/langium/workspace/index.ts +1 -0
- package/src/langium/workspace/initialize-workspace.ts +96 -4
- package/src/langium/workspace/langium-documents.ts +19 -1
- package/src/langium/workspace/persistent-file-system-provider.ts +27 -15
- package/src/langium/workspace/self-save-registry.ts +118 -0
- package/src/langium/workspace/virtual-document.ts +106 -25
- package/src/langium/workspace/write-lock-scope.ts +27 -12
- package/src/launcher/integrated-server.ts +3 -1
- package/src/locale/server-locale.ts +20 -5
- package/src/lsp/completion/hydranium-completion-provider.ts +82 -2
- package/src/lsp/connection-features.ts +67 -0
- package/src/lsp/diagnostics-connection.ts +56 -0
- package/src/lsp/edit-requests-guard.ts +152 -0
- package/src/lsp/hydranium-document-update-handler.ts +285 -111
- package/src/lsp/index.ts +6 -2
- package/src/lsp/lsp-latency.ts +62 -0
- package/src/lsp/save-text-document.ts +63 -0
- package/src/lsp/semantic-token-provider.ts +146 -8
- package/src/lsp/shared-module.ts +4 -8
- package/src/lsp/start-language-server.ts +21 -7
- package/src/messages/carriers.ts +4 -6
- package/src/messages/index.ts +11 -2
- package/src/messages/renderer.ts +34 -6
- package/src/node/event-loop-monitor.ts +2 -1
- package/src/node/heap-ceiling.ts +108 -0
- package/src/node/index.ts +5 -1
- package/src/node/latency-from-env.ts +1 -1
- package/src/node/log-file-sink.ts +6 -2
- package/src/node/log-preamble-node.ts +20 -10
- package/src/node/measure-memory.ts +5 -4
- package/src/node/memory-monitor.ts +10 -10
- package/src/node/node-file-system-provider.ts +214 -57
- package/src/node/profile-capture.ts +16 -15
- package/src/node/profiling-run.ts +30 -8
- package/src/node/rename-over-open-readers.ts +94 -0
- package/src/node/server-diagnostics.ts +1 -1
- package/src/node/server-state-snapshot.ts +5 -5
- package/src/node/socket-launcher.ts +78 -14
- package/src/node/startup-cpu-profile.ts +94 -0
- package/src/node/stdio-launcher.ts +29 -19
- package/src/node/validate-workspace.ts +8 -2
- package/src/testing/document-uri-policy-conformance.ts +1 -1
- package/src/testing/fake-document.ts +2 -1
- package/src/testing/index.ts +2 -1
- package/src/testing/langium-test-helpers.ts +1 -0
- package/src/testing/make-noop-shared-services.ts +6 -6
- package/src/testing/make-test-services.ts +93 -41
- package/src/testing/make-test-tracer.ts +26 -0
- package/src/testing/node/applied-edit-capture.ts +141 -0
- package/src/testing/node/index.ts +1 -0
- package/src/testing/node/lsp-harness.ts +2 -0
- package/src/testing/node/lsp-server-connection.ts +83 -119
- package/src/testing/node/scratch-workspace.ts +10 -5
- package/src/testing/node/spawned-server.ts +57 -3
- package/src/testing/node/unhandled-rejections.ts +31 -0
- package/src/testing/parse-semantic-root.ts +1 -1
- package/src/testing/playwright/flaky-network-proxy.ts +240 -0
- package/src/testing/playwright/index.ts +1 -0
- package/src/testing/playwright/server-log-capture.ts +137 -47
- package/src/testing/playwright/server-log-fixture.ts +46 -6
- package/src/testing/playwright/server-log-region.ts +32 -0
- package/src/testing/playwright/server-log-rename-reporter.ts +4 -3
- package/src/testing/run-update-pipeline.ts +8 -5
- package/src/testing/stub-ast-document-manager.ts +47 -128
- package/src/testing/stub-document-builder.ts +133 -18
- package/src/testing/stub-hydranium-text-documents.ts +184 -27
- package/src/testing/stub-langium-documents.ts +3 -2
- package/src/testing/stub-model-service.ts +11 -10
- package/src/testing/stub-self-save-registry.ts +1 -1
- package/src/testing/stub-service-registry.ts +1 -1
- package/src/testing/stub-writable-file-system.ts +3 -2
- package/src/util/connection-liveness.ts +80 -15
- package/src/util/environment.ts +24 -2
- package/lib/documents/language-client-text-shadow.d.ts +0 -101
- package/lib/documents/language-client-text-shadow.d.ts.map +0 -1
- package/lib/documents/language-client-text-shadow.js +0 -156
- package/lib/documents/language-client-text-shadow.js.map +0 -1
- package/lib/documents/self-save-registry.d.ts +0 -55
- package/lib/documents/self-save-registry.d.ts.map +0 -1
- package/lib/documents/self-save-registry.js.map +0 -1
- package/lib/lsp/instrument-connection.d.ts +0 -36
- package/lib/lsp/instrument-connection.d.ts.map +0 -1
- package/lib/lsp/instrument-connection.js +0 -62
- package/lib/lsp/instrument-connection.js.map +0 -1
- package/lib/node/process-memory.d.ts +0 -66
- package/lib/node/process-memory.d.ts.map +0 -1
- package/lib/node/process-memory.js +0 -252
- package/lib/node/process-memory.js.map +0 -1
- package/src/documents/language-client-text-shadow.ts +0 -175
- package/src/documents/self-save-registry.ts +0 -81
- package/src/lsp/instrument-connection.ts +0 -66
- package/src/node/process-memory.ts +0 -299
|
@@ -9,31 +9,50 @@
|
|
|
9
9
|
|
|
10
10
|
import {
|
|
11
11
|
type CanonicalUri,
|
|
12
|
-
type CloseModelArgs,
|
|
13
|
-
ConflictError,
|
|
14
12
|
defineMessage,
|
|
15
|
-
Logger,
|
|
16
13
|
type MaybeObservableValue,
|
|
17
14
|
type MaybePromise,
|
|
18
15
|
ObservableValue,
|
|
19
|
-
|
|
16
|
+
randomUuid,
|
|
17
|
+
TIMED_OUT,
|
|
20
18
|
type TransferElement,
|
|
21
|
-
type
|
|
19
|
+
type TextVersion,
|
|
22
20
|
type Tracer,
|
|
23
|
-
|
|
24
|
-
|
|
21
|
+
UNRECORDED_VERSION,
|
|
22
|
+
describeErrorWithStack
|
|
25
23
|
} from '@hydranium/protocol';
|
|
26
|
-
import {
|
|
24
|
+
import {
|
|
25
|
+
type AstNode,
|
|
26
|
+
DocumentState,
|
|
27
|
+
type LangiumDocument,
|
|
28
|
+
OperationCancelled,
|
|
29
|
+
isOperationCancelled,
|
|
30
|
+
UriUtils,
|
|
31
|
+
type URI
|
|
32
|
+
} from '@hydranium/langium';
|
|
33
|
+
import { type AstDiagnostic } from '../validation/document-validator.js';
|
|
27
34
|
import { type DocumentUriPolicy } from '../workspace/document-uri-policy.js';
|
|
28
|
-
import { ReentrantWriteLockError, isInsideWriteLock } from '../workspace/write-lock-scope.js';
|
|
29
|
-
import { type CancellationToken,
|
|
30
|
-
import { AstDocument
|
|
31
|
-
import {
|
|
35
|
+
import { ReentrantWriteLockError, isInsideWriteLock, isWriteLockScopeInstalled } from '../workspace/write-lock-scope.js';
|
|
36
|
+
import { type ApplyWorkspaceEditResult, CancellationToken, Disposable } from 'vscode-languageserver';
|
|
37
|
+
import { AstDocument } from '../../documents/ast-document-manager.js';
|
|
38
|
+
import { isClientGoneError } from '../../util/connection-liveness.js';
|
|
32
39
|
import { type LogNameOptions } from '../diagnostics/logger.js';
|
|
33
40
|
import { IntegrityService } from '../integrity/integrity-service.js';
|
|
34
41
|
import { labelPhaseListener } from '../document-builder/labeled-phase-listener.js';
|
|
35
42
|
import { LANGUAGE_CLIENT_ID } from '../../documents/client-ids.js';
|
|
43
|
+
import { type OpenOptions } from '../../documents/client-session-registry.js';
|
|
36
44
|
import { type ServerSharedServices } from '../module.js';
|
|
45
|
+
import { type ClientSession } from './client-session.js';
|
|
46
|
+
import {
|
|
47
|
+
type ModelDeletedEvent,
|
|
48
|
+
type ModelDirtyChangedEvent,
|
|
49
|
+
type ModelEventFilter,
|
|
50
|
+
type ModelPhaseFilter,
|
|
51
|
+
type ModelReleasedEvent,
|
|
52
|
+
type ModelSavedEvent,
|
|
53
|
+
type ModelsBuiltEvent,
|
|
54
|
+
type ModelUpdatedEvent
|
|
55
|
+
} from './model-events.js';
|
|
37
56
|
|
|
38
57
|
/**
|
|
39
58
|
* The undo-stack entry for a server-authored write pushed to the editor.
|
|
@@ -52,17 +71,13 @@ import { type ServerSharedServices } from '../module.js';
|
|
|
52
71
|
*/
|
|
53
72
|
export const MODEL_UPDATE_EDIT = defineMessage('hydranium/core/model-update-edit', 'Update Model');
|
|
54
73
|
|
|
55
|
-
/** Max time {@link ModelService.settleSave} waits for the build to settle and the sync chain to drain. */
|
|
56
|
-
const SAVE_SETTLE_TIMEOUT_MS = 10_000;
|
|
57
|
-
|
|
58
74
|
/**
|
|
59
|
-
*
|
|
60
|
-
*
|
|
61
|
-
*
|
|
62
|
-
*
|
|
63
|
-
* the timeout for every one of them, which points debugging at the wrong layer.
|
|
75
|
+
* Max time {@link ModelService.settleLanguageClient} waits. A save answers up to
|
|
76
|
+
* this long after its persist, and a data-head update or a diagram's settle
|
|
77
|
+
* request after its write, so a client timing out one of those answers must
|
|
78
|
+
* allow it plus the work before.
|
|
64
79
|
*/
|
|
65
|
-
|
|
80
|
+
const LANGUAGE_CLIENT_SETTLE_TIMEOUT_MS = 10_000;
|
|
66
81
|
|
|
67
82
|
/**
|
|
68
83
|
* Constructor options for {@link ModelService}. All fields are optional,
|
|
@@ -70,75 +85,66 @@ class SaveSettleTimeoutError extends Error {}
|
|
|
70
85
|
*/
|
|
71
86
|
export interface ModelServiceOptions extends LogNameOptions {
|
|
72
87
|
/**
|
|
73
|
-
*
|
|
74
|
-
*
|
|
75
|
-
*
|
|
76
|
-
* `
|
|
77
|
-
* `Logger.time` debug timing log is unchanged either way).
|
|
78
|
-
*
|
|
79
|
-
* Pure observability — does NOT abort the update, does NOT change
|
|
80
|
-
* resolution semantics. Adopters wanting a hard timeout that throws
|
|
81
|
-
* instead override {@link ModelService.update} on their subclass and
|
|
82
|
-
* race the parent call against their own deadline.
|
|
83
|
-
*
|
|
84
|
-
* Recommended starting threshold: 2-5 seconds for interactive paths
|
|
85
|
-
* (form save, diagram edit). Workspaces with very large documents
|
|
86
|
-
* or slow validation may legitimately exceed 5s on the cold path —
|
|
87
|
-
* tune per workspace.
|
|
88
|
-
*
|
|
89
|
-
* Accepts a {@link MaybeObservableValue} so the threshold can be a
|
|
90
|
-
* fixed constant or bound to a user setting via `Settings.number`
|
|
91
|
-
* and retuned live. Leaving it unset disables the warn line entirely
|
|
92
|
-
* (and skips the per-update stopwatch).
|
|
93
|
-
*/
|
|
94
|
-
readonly slowUpdateWarnMs?: MaybeObservableValue<number>;
|
|
95
|
-
/**
|
|
96
|
-
* Serialise the facade's own build under the workspace WRITE lock, the way
|
|
97
|
-
* Langium's `DefaultDocumentUpdateHandler` dispatches its build. Default
|
|
98
|
-
* `true`.
|
|
88
|
+
* Let the facade's build run without the workspace write lock when its
|
|
89
|
+
* caller already holds it: an integrity rule or build-phase pass that
|
|
90
|
+
* writes back through a session's `update` / `save`, or calls `rebuild`.
|
|
91
|
+
* Default `false`.
|
|
99
92
|
*
|
|
100
|
-
*
|
|
101
|
-
*
|
|
102
|
-
*
|
|
103
|
-
*
|
|
104
|
-
*
|
|
105
|
-
*
|
|
106
|
-
* build
|
|
93
|
+
* `WorkspaceLock` is not reentrant. Taking it from inside a holder cancels
|
|
94
|
+
* that holder and then waits for it to end, while the holder waits for this
|
|
95
|
+
* call, so neither completes. On `false` that call fails with
|
|
96
|
+
* {@link ReentrantWriteLockError} instead, wherever a host installs a
|
|
97
|
+
* write-lock scope tracker (`@hydranium/core/node` does at entry load); on
|
|
98
|
+
* `true` its build takes no lock. The wait after that build can still hang,
|
|
99
|
+
* because a document no build will carry is re-queued through the lock, and
|
|
100
|
+
* the re-queue waits for the holder to end.
|
|
107
101
|
*
|
|
108
|
-
*
|
|
109
|
-
*
|
|
110
|
-
* documents are validated twice per write — double the validation work.
|
|
111
|
-
* Reported diagnostics stay correct even then, because
|
|
112
|
-
* `HydraniumDocumentBuilder.dedupeDiagnostics` collapses the byte-identical
|
|
113
|
-
* duplicates a repeated pass produces before any listener sees them; what this
|
|
114
|
-
* option removes is the wasted pass, not just its visible symptom.
|
|
102
|
+
* A session's delete is refused that way on either value, since its builds
|
|
103
|
+
* always take the lock.
|
|
115
104
|
*
|
|
116
|
-
*
|
|
117
|
-
*
|
|
118
|
-
*
|
|
119
|
-
*
|
|
120
|
-
*
|
|
121
|
-
*
|
|
122
|
-
*
|
|
123
|
-
* installs a write-lock scope tracker (`@hydranium/core/node` does at entry
|
|
124
|
-
* load; see {@link isInsideWriteLock}). Setting `false` is the escape hatch
|
|
125
|
-
* for an adopter whose reentrant shape is unavoidable — nothing acquires the
|
|
126
|
-
* lock then, so there is nothing to be reentrant about; prefer it over
|
|
127
|
-
* unserialised builds only in that case.
|
|
105
|
+
* Every other facade build takes the lock on either value. Unlocked, it can
|
|
106
|
+
* overlap another build of the same document: both run a full validation
|
|
107
|
+
* pass that Langium appends, and a caller can be handed a version that an
|
|
108
|
+
* integrity repair still running in the other build then moves past. Without
|
|
109
|
+
* a tracker the two cases cannot be told apart (see
|
|
110
|
+
* {@link isWriteLockScopeInstalled}), so `true` builds without the lock every
|
|
111
|
+
* time and accepts both.
|
|
128
112
|
*
|
|
129
113
|
* Accepts a {@link MaybeObservableValue} so it can be bound to a setting and
|
|
130
114
|
* flipped without a restart.
|
|
131
115
|
*/
|
|
132
|
-
readonly
|
|
116
|
+
readonly allowReentrantBuilds?: MaybeObservableValue<boolean>;
|
|
117
|
+
}
|
|
118
|
+
|
|
119
|
+
/** One {@link ModelService.onModelUpdated} subscription; `uri` is canonical, absent for every document. */
|
|
120
|
+
export interface ModelUpdateSubscriber<TAst extends AstNode, TDiagnostic extends AstDiagnostic = AstDiagnostic> {
|
|
121
|
+
readonly uri?: CanonicalUri;
|
|
122
|
+
readonly listener: (event: ModelUpdatedEvent<TAst, TDiagnostic>) => void;
|
|
123
|
+
}
|
|
124
|
+
|
|
125
|
+
/** Options for a {@link DefaultModelService} wait on one document. */
|
|
126
|
+
export interface SyncedWaitOptions {
|
|
127
|
+
/**
|
|
128
|
+
* Build a root parsed from text older than the store's at the call, and
|
|
129
|
+
* reject once that build, or one the builder re-queues, is given up. Without
|
|
130
|
+
* it, such a root is left to other builds, and a wait they never end stays
|
|
131
|
+
* pending until its token is cancelled.
|
|
132
|
+
*/
|
|
133
|
+
readonly sync?: boolean;
|
|
133
134
|
}
|
|
134
135
|
|
|
135
136
|
/**
|
|
137
|
+
* The seam every non-LSP head talks to: the data server, the GLSP head and an
|
|
138
|
+
* adopter's own services reach documents through this slot rather than through
|
|
139
|
+
* the workspace stores.
|
|
140
|
+
*
|
|
136
141
|
* In-process facade over the framework's document plumbing
|
|
137
142
|
* (`HydraniumTextDocuments`, `LangiumDocuments`,
|
|
138
|
-
* `DocumentBuilder`, `WritableFileSystemProvider`). Owns the
|
|
139
|
-
*
|
|
140
|
-
*
|
|
141
|
-
* doesn't have to be re-implemented per
|
|
143
|
+
* `DocumentBuilder`, `WritableFileSystemProvider`). Owns the document
|
|
144
|
+
* lifecycle the data-server and GLSP heads delegate to — client sessions that
|
|
145
|
+
* open, update, save and close documents, the phase reads, and `ready` — so
|
|
146
|
+
* coordinating those primitives doesn't have to be re-implemented per head.
|
|
147
|
+
* Every open and write goes through a session from {@link createSession}.
|
|
142
148
|
*
|
|
143
149
|
* "Model" here means the parsed AST — distinct from the wire-shape
|
|
144
150
|
* `TransferDocument` in `@hydranium/protocol`.
|
|
@@ -148,9 +154,9 @@ export interface ModelServiceOptions extends LogNameOptions {
|
|
|
148
154
|
* Multiple in-process consumers want the same workspace-level
|
|
149
155
|
* operations:
|
|
150
156
|
* - The data-server head turns these into typed RPC methods.
|
|
151
|
-
* - The GLSP head uses the same lifecycle for diagram-driven edits
|
|
152
|
-
*
|
|
153
|
-
*
|
|
157
|
+
* - The GLSP head uses the same lifecycle for diagram-driven edits: GModel
|
|
158
|
+
* operation handlers write through the diagram's session and wait on phases
|
|
159
|
+
* before reading.
|
|
154
160
|
* - Server-internal callers (integrity service, ad-hoc bridges, tests)
|
|
155
161
|
* want the same operations without the wire serialisation step.
|
|
156
162
|
*
|
|
@@ -163,15 +169,16 @@ export interface ModelServiceOptions extends LogNameOptions {
|
|
|
163
169
|
*
|
|
164
170
|
* **Read-latest supersession**
|
|
165
171
|
*
|
|
166
|
-
*
|
|
167
|
-
* `DocumentBuilder.waitUntil` to wait for the integrity-settled
|
|
168
|
-
*
|
|
169
|
-
*
|
|
170
|
-
*
|
|
171
|
-
* event. Adopters wanting strict
|
|
172
|
-
* with vN's snapshot specifically, log
|
|
173
|
-
*
|
|
174
|
-
*
|
|
172
|
+
* A session's default `update` and `save` use Langium's per-URI
|
|
173
|
+
* `DocumentBuilder.waitUntil` to wait for `Validated` (the integrity-settled
|
|
174
|
+
* landmark {@link IntegrityService.SettledState} when rebuilds do not
|
|
175
|
+
* validate), then read the post-build state. Concurrent in-process callers
|
|
176
|
+
* on the same URI all see the latest post-build snapshot — none deadlock
|
|
177
|
+
* waiting for a specific version's settled event. Adopters wanting strict
|
|
178
|
+
* version-matched semantics (resolve with vN's snapshot specifically, log
|
|
179
|
+
* "vN superseded by vM at vN+1") override
|
|
180
|
+
* `DefaultClientSession.updateDocument` to attach a phase-listener with
|
|
181
|
+
* explicit version checks; the framework default doesn't need it for safety.
|
|
175
182
|
*
|
|
176
183
|
* **Returns AST snapshots, not wire envelopes**
|
|
177
184
|
*
|
|
@@ -184,27 +191,194 @@ export interface ModelServiceOptions extends LogNameOptions {
|
|
|
184
191
|
* the injected `TransferEncoder` — symmetric with the
|
|
185
192
|
* `getModelDocument` envelope path.
|
|
186
193
|
*
|
|
187
|
-
* **Subscriptions** (
|
|
188
|
-
*
|
|
189
|
-
* `
|
|
190
|
-
*
|
|
191
|
-
*
|
|
192
|
-
*
|
|
194
|
+
* **Subscriptions** (`on*`) are how a head follows documents; it subscribes
|
|
195
|
+
* here rather than to the builder or the text store. Each takes a filter, and
|
|
196
|
+
* one without a `uri` hears every document.
|
|
197
|
+
*
|
|
198
|
+
* **Two families.** `waitFor*` only waits: it rejects for a URI with no
|
|
199
|
+
* document, and for a root behind the store's text it waits for whatever
|
|
200
|
+
* builds it next, so it never ends if nothing does. `ensureDocumentState` and
|
|
201
|
+
* the phase shorthands over it build a missing document, and build a root
|
|
202
|
+
* behind its text, rejecting when that build fails twice. Both re-queue a
|
|
203
|
+
* document the builder's last build left short of the state.
|
|
204
|
+
*
|
|
205
|
+
* Both resolve at the state with a root parsed from text no older than the
|
|
206
|
+
* store's version at the call; inside the write lock, at the state alone, since
|
|
207
|
+
* the build that would sync the document to that version cannot start until
|
|
208
|
+
* it is released.
|
|
209
|
+
*
|
|
210
|
+
* Do not await one inside a build phase listener: a browser host installs no
|
|
211
|
+
* write-lock scope, so the wait cannot tell it is inside a build and waits for
|
|
212
|
+
* one that cannot start. Nor inside a `WorkspaceLock.read`: the lock starts no
|
|
213
|
+
* write, the build included, while a read runs.
|
|
214
|
+
*
|
|
215
|
+
* **Diagnostics are typed `never` below `Validated`.** Validation is the last
|
|
216
|
+
* phase, so at any earlier landmark the array either is not yet computed or
|
|
217
|
+
* still holds the previous build's, and reading it would take stale results
|
|
218
|
+
* for fresh ones. A caller that needs diagnostics asks for {@link validated}.
|
|
219
|
+
*
|
|
220
|
+
* What the `never` buys, exactly: reading a field off an element is a compile
|
|
221
|
+
* error, and nothing can be appended. It does NOT stop a caller assigning an
|
|
222
|
+
* element to a typed variable, because `never` is assignable to everything — so
|
|
223
|
+
* this is a guard against reaching for diagnostics by accident, not a seal
|
|
224
|
+
* against doing it deliberately.
|
|
225
|
+
*
|
|
226
|
+
* The waits resolve at or ABOVE their target, so an already-validated document
|
|
227
|
+
* does carry usable diagnostics and the `never` over-forbids there. That
|
|
228
|
+
* direction is the safe one: the alternative permits stale reads silently. A
|
|
229
|
+
* member taking a phase as a PARAMETER returns `TDiagnostic`, and leaves them
|
|
230
|
+
* absent for a phase below `Validated`.
|
|
193
231
|
*
|
|
194
232
|
* **Generic parameters.**
|
|
195
233
|
* - `TAst` — the AST root type each consumer expects on the returned
|
|
196
234
|
* {@link AstDocument}. Constrained to {@link AstNode}.
|
|
197
|
-
* - `TDiagnostic` —
|
|
198
|
-
* `
|
|
199
|
-
*
|
|
235
|
+
* - `TDiagnostic` — the AST-layer diagnostic: whatever the build left on
|
|
236
|
+
* `LangiumDocument.diagnostics`, carried through on the returned
|
|
237
|
+
* {@link AstDocument}. Defaults to {@link AstDiagnostic}.
|
|
238
|
+
* **Not the `TransferEncoder`'s parameter of the same name**, which is
|
|
239
|
+
* that encoder's OUTPUT and so names the wire shape. This one names its
|
|
240
|
+
* input, and an adopter binds the two to different types.
|
|
241
|
+
* - `TTransfer` — transfer-model root a session's `update` / `save` accept
|
|
200
242
|
* args. Constrained to {@link TransferElement}. Defaults to the
|
|
201
243
|
* structural base.
|
|
202
244
|
*/
|
|
203
|
-
export
|
|
245
|
+
export interface ModelService<
|
|
246
|
+
TAst extends AstNode,
|
|
247
|
+
TDiagnostic extends AstDiagnostic = AstDiagnostic,
|
|
248
|
+
TTransfer extends TransferElement = TransferElement
|
|
249
|
+
> {
|
|
250
|
+
/**
|
|
251
|
+
* Resolves once the workspace has been initialised and its first build has
|
|
252
|
+
* completed — the gate every read should wait behind, since a document
|
|
253
|
+
* queried before it may be unbuilt and reach no phase.
|
|
254
|
+
*
|
|
255
|
+
* A property rather than a method, matching `ProjectManager.ready` and
|
|
256
|
+
* Langium's `WorkspaceManager.ready`. An implementation needing a stricter
|
|
257
|
+
* gate supplies a Promise that awaits its own concern as well.
|
|
258
|
+
*/
|
|
259
|
+
readonly ready: Promise<void>;
|
|
260
|
+
|
|
261
|
+
// Wait only; a root behind its text is left to another build.
|
|
262
|
+
waitForDocumentState(uri: string, state: DocumentState, cancelToken?: CancellationToken): Promise<AstDocument<TAst, TDiagnostic>>;
|
|
263
|
+
waitForDocumentSettled(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>>;
|
|
264
|
+
waitForBuilderState(state: DocumentState, cancelToken?: CancellationToken): Promise<void>;
|
|
265
|
+
|
|
266
|
+
// Build what is missing or behind its text, then wait.
|
|
267
|
+
ensureDocumentState(uri: string, state?: DocumentState, cancelToken?: CancellationToken): Promise<AstDocument<TAst, TDiagnostic>>;
|
|
268
|
+
rebuild(uri: string, state?: DocumentState, cancelToken?: CancellationToken): Promise<AstDocument<TAst, TDiagnostic>>;
|
|
269
|
+
/**
|
|
270
|
+
* Throw where {@link rebuild} would reject as reentrant. A write calls it
|
|
271
|
+
* before applying its text: a text applied and then refused stays applied
|
|
272
|
+
* with no build to follow it.
|
|
273
|
+
*/
|
|
274
|
+
assertCanBuild(uri: string): void;
|
|
275
|
+
parsed(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>>;
|
|
276
|
+
linked(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>>;
|
|
277
|
+
settled(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>>;
|
|
278
|
+
indexed(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>>;
|
|
279
|
+
validated(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, TDiagnostic>>;
|
|
280
|
+
|
|
281
|
+
isOpen(uri: string): boolean;
|
|
282
|
+
/**
|
|
283
|
+
* The version the document at `uri` was opened at, which a client's write
|
|
284
|
+
* or an integrity repair steps past; `undefined` while it is not open.
|
|
285
|
+
*/
|
|
286
|
+
openedVersion(uri: string): TextVersion | undefined;
|
|
287
|
+
snapshot(uri: string): AstDocument<TAst, TDiagnostic> | undefined;
|
|
288
|
+
/**
|
|
289
|
+
* The text a session's write of `model` to `uri` applies: a textual model
|
|
290
|
+
* as given, a structured one rewritten and serialised. Also the text to
|
|
291
|
+
* create a document with: for a `uri` with no text the trivia preservers
|
|
292
|
+
* still run, so it gets their defaults, such as
|
|
293
|
+
* `DocumentEndingPreserver.DEFAULT_ENDING`.
|
|
294
|
+
*/
|
|
295
|
+
modelToText(uri: string, model: TTransfer | string, cancelToken?: CancellationToken): Promise<string>;
|
|
296
|
+
getDocument(uri: string): LangiumDocument | undefined;
|
|
297
|
+
/**
|
|
298
|
+
* Resolve once the document's build has settled and the language client
|
|
299
|
+
* has answered the push of its text, applied or refused and logged, so a
|
|
300
|
+
* save answering after it does not race that push. Does not wait again for
|
|
301
|
+
* a push an earlier settle timed out on and the client has not answered
|
|
302
|
+
* since. Never rejects: past its bound it warns and resolves, and a failed
|
|
303
|
+
* wait is logged and resolves.
|
|
304
|
+
*/
|
|
305
|
+
settleLanguageClient(uri: string, cancelToken?: CancellationToken): Promise<void>;
|
|
306
|
+
/**
|
|
307
|
+
* Whether a push of the document's text into the language client awaits the
|
|
308
|
+
* client's answer. A push a settle already timed out on does not count: that
|
|
309
|
+
* settle has warned about it.
|
|
310
|
+
*/
|
|
311
|
+
isLanguageClientPushPending(uri: string): boolean;
|
|
312
|
+
|
|
313
|
+
/**
|
|
314
|
+
* Fires as a document reaches the filter's phase, `Validated` by default.
|
|
315
|
+
* Listeners run inside the build, so one that throws is logged and the
|
|
316
|
+
* others still run.
|
|
317
|
+
*/
|
|
318
|
+
onModelUpdated(listener: (event: ModelUpdatedEvent<TAst, TDiagnostic>) => void, filter?: ModelPhaseFilter): Disposable;
|
|
319
|
+
/**
|
|
320
|
+
* Fires once per build that reaches the phase, with every document it
|
|
321
|
+
* carried there. A listener that throws is logged, as for {@link onModelUpdated}.
|
|
322
|
+
*/
|
|
323
|
+
onModelsBuilt(listener: (event: ModelsBuiltEvent) => void, filter?: Pick<ModelPhaseFilter, 'phase'>): Disposable;
|
|
324
|
+
/**
|
|
325
|
+
* Fires for every save, whichever client made it, as the store announces
|
|
326
|
+
* it. A document saved before its first build arrives as an empty envelope
|
|
327
|
+
* at `UNRECORDED_VERSION`, whose `root` is `undefined` despite its type.
|
|
328
|
+
*/
|
|
329
|
+
onModelSaved(listener: (event: ModelSavedEvent<TAst, TDiagnostic>) => void, filter?: ModelEventFilter): Disposable;
|
|
330
|
+
/**
|
|
331
|
+
* Fires for every document a build removes, with the session whose
|
|
332
|
+
* `delete` removed it, as `AstDocumentManager.attributeDeletion` names it.
|
|
333
|
+
*/
|
|
334
|
+
onModelDeleted(listener: (event: ModelDeletedEvent) => void, filter?: ModelEventFilter): Disposable;
|
|
335
|
+
/** Fires when a document's text starts or stops differing from its file. */
|
|
336
|
+
onDirtyChanged(listener: (event: ModelDirtyChangedEvent) => void, filter?: ModelEventFilter): Disposable;
|
|
337
|
+
/**
|
|
338
|
+
* Fires when the store releases a document no client has open any more.
|
|
339
|
+
* What the build keeps for it is up to the
|
|
340
|
+
* `DocumentReleaseHandler` slot; the default reverts it to disk, and that
|
|
341
|
+
* rebuild follows as an {@link onModelUpdated} event, unless a client opens
|
|
342
|
+
* the document first or its file is deleted.
|
|
343
|
+
*/
|
|
344
|
+
onModelReleased(listener: (event: ModelReleasedEvent) => void, filter?: ModelEventFilter): Disposable;
|
|
345
|
+
/** Fires when `filter.clientId` closes `filter.uri`, its session ending included. */
|
|
346
|
+
onClientClosed(listener: () => void, filter: { readonly uri: string; readonly clientId: string }): Disposable;
|
|
347
|
+
|
|
348
|
+
/**
|
|
349
|
+
* Start a client session, the only way to open and write documents through
|
|
350
|
+
* this service. Pass a `label` naming the participant; without one it is
|
|
351
|
+
* `session`. The id defaults to `label#` plus a random UUID; a fixed
|
|
352
|
+
* `clientId` is taken as given. Throws `ReservedClientIdError` when the id
|
|
353
|
+
* is reserved by the framework, and `DuplicateClientIdError` when it is
|
|
354
|
+
* held by another live session or has documents open under it as a client
|
|
355
|
+
* that is not a session.
|
|
356
|
+
*
|
|
357
|
+
* A `resumeToken` matching the one the live session under `clientId` was
|
|
358
|
+
* started with ends that session as lost first, so the documents it was
|
|
359
|
+
* last to hold keep their unsaved text for the new one. The token guards
|
|
360
|
+
* against taking over a session by accident, not against a peer: anyone who
|
|
361
|
+
* knows it can end the session.
|
|
362
|
+
*
|
|
363
|
+
* `TOpenOptions` types the options the session's `open` takes and its
|
|
364
|
+
* `openOptions` returns. The narrowing is an unchecked cast, and it holds
|
|
365
|
+
* only for the caller that started the session: a holder reached through
|
|
366
|
+
* {@link getSession} sees plain `OpenOptions`.
|
|
367
|
+
*/
|
|
368
|
+
createSession<TOpenOptions extends OpenOptions = OpenOptions>(
|
|
369
|
+
label?: string,
|
|
370
|
+
clientId?: string,
|
|
371
|
+
options?: { readonly resumeToken?: string }
|
|
372
|
+
): ClientSession<TAst, TDiagnostic, TTransfer, TOpenOptions>;
|
|
373
|
+
/** The live session started under `clientId`, or `undefined` once it has ended or was never started. */
|
|
374
|
+
getSession(clientId: string): ClientSession<TAst, TDiagnostic, TTransfer> | undefined;
|
|
375
|
+
}
|
|
376
|
+
|
|
377
|
+
export class DefaultModelService<
|
|
204
378
|
TAst extends AstNode,
|
|
205
|
-
TDiagnostic =
|
|
379
|
+
TDiagnostic extends AstDiagnostic = AstDiagnostic,
|
|
206
380
|
/**
|
|
207
|
-
* Structured payload
|
|
381
|
+
* Structured payload a session's `update` / `save` accept. Constrained to
|
|
208
382
|
* {@link TransferElement} — the minimal `{ readonly $type: string }`
|
|
209
383
|
* shape. Both transfer-model overlay roots (which extend
|
|
210
384
|
* `TransferElement` explicitly) and AST root types (which have
|
|
@@ -213,7 +387,7 @@ export class ModelService<
|
|
|
213
387
|
* integrity service) that pass AST roots remain compatible.
|
|
214
388
|
*/
|
|
215
389
|
TTransfer extends TransferElement = TransferElement
|
|
216
|
-
> {
|
|
390
|
+
> implements ModelService<TAst, TDiagnostic, TTransfer> {
|
|
217
391
|
protected readonly tracer: Tracer;
|
|
218
392
|
/**
|
|
219
393
|
* The single document-identity seam (`services.workspace.DocumentUriPolicy`),
|
|
@@ -224,14 +398,8 @@ export class ModelService<
|
|
|
224
398
|
* (see {@link DocumentUriPolicy}).
|
|
225
399
|
*/
|
|
226
400
|
protected readonly uriPolicy: DocumentUriPolicy;
|
|
227
|
-
/**
|
|
228
|
-
|
|
229
|
-
* was not supplied (warn line + stopwatch disabled). Reads `.value` per
|
|
230
|
-
* update so a setting-bound threshold retunes without reconstruction.
|
|
231
|
-
*/
|
|
232
|
-
protected readonly slowUpdateWarn?: ObservableValue<number>;
|
|
233
|
-
/** See {@link ModelServiceOptions.serializeBuilds}. Defaults to `true`. */
|
|
234
|
-
protected readonly serializeBuilds: ObservableValue<boolean>;
|
|
401
|
+
/** See {@link ModelServiceOptions.allowReentrantBuilds}. Defaults to `false`. */
|
|
402
|
+
protected readonly allowReentrantBuilds: ObservableValue<boolean>;
|
|
235
403
|
|
|
236
404
|
/**
|
|
237
405
|
* Per-URI applyEdit coalescing: at most one in-flight `applyEditToLanguageClient`
|
|
@@ -241,6 +409,30 @@ export class ModelService<
|
|
|
241
409
|
*/
|
|
242
410
|
protected readonly syncChains = new Map<string, Promise<void>>();
|
|
243
411
|
protected readonly pendingSync = new Map<string, string>();
|
|
412
|
+
/**
|
|
413
|
+
* The sync chains a settle timed out on, until the client answers their
|
|
414
|
+
* push. A later settle does not wait on one meanwhile: GLSP runs a diagram's
|
|
415
|
+
* saves one at a time, so each would add the full bound and a queued save
|
|
416
|
+
* outlast its client's timeout.
|
|
417
|
+
*/
|
|
418
|
+
protected readonly timedOutSyncChains = new WeakSet<Promise<void>>();
|
|
419
|
+
|
|
420
|
+
/** The live sessions this service started, by client id, for {@link getSession}. */
|
|
421
|
+
protected readonly sessions = new Map<string, ClientSession<TAst, TDiagnostic, TTransfer>>();
|
|
422
|
+
/**
|
|
423
|
+
* Drops an ended session from {@link sessions}. Subscribed by the first
|
|
424
|
+
* {@link createSession} rather than at construction, so a services tree with
|
|
425
|
+
* no text store, or one that knows nothing of sessions, still constructs
|
|
426
|
+
* this service.
|
|
427
|
+
*/
|
|
428
|
+
protected sessionCloseListener?: Disposable;
|
|
429
|
+
/** The token each live session was started with, by client id, for a takeover by {@link createSession}. */
|
|
430
|
+
protected readonly resumeTokens = new Map<string, string>();
|
|
431
|
+
/**
|
|
432
|
+
* The {@link onModelUpdated} subscribers, by phase. One builder listener per
|
|
433
|
+
* phase serves them all, kept for the life of the service.
|
|
434
|
+
*/
|
|
435
|
+
protected readonly updateSubscribers = new Map<DocumentState, Set<ModelUpdateSubscriber<TAst, TDiagnostic>>>();
|
|
244
436
|
|
|
245
437
|
/**
|
|
246
438
|
* Workspace-level readiness gate. Resolves when the framework has
|
|
@@ -282,30 +474,26 @@ export class ModelService<
|
|
|
282
474
|
) {
|
|
283
475
|
this.tracer = services.Tracer.for(options.logName ?? 'ModelService').trace('instantiated');
|
|
284
476
|
this.uriPolicy = services.workspace.DocumentUriPolicy;
|
|
285
|
-
this.
|
|
286
|
-
this.serializeBuilds = ObservableValue.from(options.serializeBuilds ?? true);
|
|
477
|
+
this.allowReentrantBuilds = ObservableValue.from(options.allowReentrantBuilds ?? false);
|
|
287
478
|
// Optional-chain so a harness that binds no WorkspaceManager awaits
|
|
288
479
|
// `undefined` and resolves immediately; production hosts always have it
|
|
289
480
|
// bound.
|
|
290
481
|
// Deliberately NO fallback to Langium's `ready`: it resolves pre-build,
|
|
291
482
|
// so falling back to it would silently reinstate the very gap this gate
|
|
292
483
|
// exists to close.
|
|
293
|
-
// Captured rather than read off `this` inside the closure, which TS cannot
|
|
294
|
-
// prove runs after the field is assigned.
|
|
295
|
-
const tracer = this.tracer;
|
|
296
484
|
this.ready = (async () => {
|
|
297
485
|
try {
|
|
298
486
|
await services.workspace.WorkspaceManager?.workspaceInitialized;
|
|
299
|
-
} catch
|
|
487
|
+
} catch {
|
|
300
488
|
// NEVER rejects, deliberately. This gate is about TIMING — "the
|
|
301
489
|
// initial build has finished" — not about whether it succeeded, and
|
|
302
|
-
//
|
|
303
|
-
// `workspaceInitialized`
|
|
304
|
-
// build (routine — any write preempts one) and on
|
|
305
|
-
// (e.g. a disposed connection at teardown).
|
|
306
|
-
// fail every `waitForReady` for the rest
|
|
307
|
-
// a far worse failure than the late gate
|
|
308
|
-
|
|
490
|
+
// the workspace manager's `ready` (what it replaced) rejects only on
|
|
491
|
+
// a failed startup. `workspaceInitialized` also rejects on a
|
|
492
|
+
// cancelled initial build (routine — any write preempts one) and on
|
|
493
|
+
// a failed one (e.g. a disposed connection at teardown).
|
|
494
|
+
// Propagating either would fail every `waitForReady` for the rest
|
|
495
|
+
// of the process lifetime, a far worse failure than the late gate
|
|
496
|
+
// this exists to fix. The workspace manager logs the outcome.
|
|
309
497
|
}
|
|
310
498
|
})();
|
|
311
499
|
// One persistent listener mirroring non-LSP-client changes back to the LSP
|
|
@@ -327,10 +515,12 @@ export class ModelService<
|
|
|
327
515
|
// ============================================================
|
|
328
516
|
|
|
329
517
|
/**
|
|
330
|
-
* Wait for the document at `uri` to reach `state
|
|
331
|
-
*
|
|
332
|
-
*
|
|
333
|
-
*
|
|
518
|
+
* Wait for the document at `uri` to reach `state` with a root no older than
|
|
519
|
+
* the store's text at the call. Rejects if `uri` is not in the document
|
|
520
|
+
* registry. A root behind its text is not built: the wait lasts until
|
|
521
|
+
* something else builds it, so use {@link ensureDocumentState} where
|
|
522
|
+
* nothing may. Builds that keep failing leave the wait pending, to its
|
|
523
|
+
* cancellation token.
|
|
334
524
|
*
|
|
335
525
|
* Wrapped in a debug-level timing log via {@link Tracer.time} so
|
|
336
526
|
* slow per-URI waits surface in build telemetry; the URI is
|
|
@@ -344,11 +534,12 @@ export class ModelService<
|
|
|
344
534
|
* Wait for the document at `uri` to reach the integrity-settled landmark
|
|
345
535
|
* ({@link IntegrityService.SettledState}) — the earliest phase at which the
|
|
346
536
|
* AST + serialised text are stable post-integrity. Convenience wrapper over
|
|
347
|
-
* {@link waitForDocumentState}
|
|
348
|
-
* case (e.g. settling a save). Pure wait — does not trigger a build.
|
|
537
|
+
* {@link waitForDocumentState}, and like it builds nothing behind its text.
|
|
349
538
|
*/
|
|
350
|
-
async waitForDocumentSettled(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst,
|
|
351
|
-
return this.
|
|
539
|
+
async waitForDocumentSettled(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>> {
|
|
540
|
+
return this.withoutDiagnostics(
|
|
541
|
+
await this.waitForDocumentStateCanonical(this.uriPolicy.canonicalUri(uri), IntegrityService.SettledState, cancelToken)
|
|
542
|
+
);
|
|
352
543
|
}
|
|
353
544
|
|
|
354
545
|
/**
|
|
@@ -360,21 +551,120 @@ export class ModelService<
|
|
|
360
551
|
* the identity once instead of re-running the (filesystem-touching) `realpath`
|
|
361
552
|
* at every wait. The `CanonicalUri` parameter type enforces that — a raw
|
|
362
553
|
* `string` cannot be passed without minting through the URI policy.
|
|
554
|
+
*
|
|
555
|
+
* With `options.sync`, a root behind the store's text is built, as in
|
|
556
|
+
* {@link ensureDocumentState}; without it, the root is left to other builds,
|
|
557
|
+
* as in {@link waitForDocumentState}. Below `Validated` the envelope has no
|
|
558
|
+
* diagnostics: see {@link withoutDiagnostics}.
|
|
363
559
|
*/
|
|
364
560
|
protected async waitForDocumentStateCanonical(
|
|
365
561
|
uri: CanonicalUri,
|
|
366
562
|
state: DocumentState,
|
|
367
|
-
cancelToken?: CancellationToken
|
|
563
|
+
cancelToken?: CancellationToken,
|
|
564
|
+
options: SyncedWaitOptions = {}
|
|
368
565
|
): Promise<AstDocument<TAst, TDiagnostic>> {
|
|
369
566
|
const documentUri = UriUtils.toUri(uri);
|
|
567
|
+
// Read at call time: a later edit must not extend this wait.
|
|
568
|
+
const textVersion = isInsideWriteLock() ? undefined : this.services.workspace.TextDocuments.textState(uri)?.version;
|
|
370
569
|
await this.tracer
|
|
371
570
|
.withUri(uri)
|
|
372
571
|
.time(
|
|
373
572
|
`Wait for document state '${DocumentState[state]}'`,
|
|
374
|
-
() => this.
|
|
573
|
+
() => this.waitUntilSynced(documentUri, state, textVersion, cancelToken, options),
|
|
375
574
|
'debug'
|
|
376
575
|
);
|
|
377
|
-
|
|
576
|
+
const document = this.toAstDocument(documentUri);
|
|
577
|
+
return state >= DocumentState.Validated ? document : this.withoutDiagnostics(document);
|
|
578
|
+
}
|
|
579
|
+
|
|
580
|
+
/**
|
|
581
|
+
* Wait for `state` with a root parsed from text at `textVersion` or later. A
|
|
582
|
+
* root no factory recorded counts as synced, since no build records it.
|
|
583
|
+
* With `options.sync`, a root still behind is built through
|
|
584
|
+
* `VersionSyncService.syncTo`, and the wait rejects once that build, or one
|
|
585
|
+
* the builder re-queues to reach `state`, is given up. Without it, the wait
|
|
586
|
+
* lasts until another build parses the text, and stays pending when the
|
|
587
|
+
* builder gives up re-queuing the document.
|
|
588
|
+
*/
|
|
589
|
+
protected async waitUntilSynced(
|
|
590
|
+
uri: URI,
|
|
591
|
+
state: DocumentState,
|
|
592
|
+
textVersion: TextVersion | undefined,
|
|
593
|
+
cancelToken?: CancellationToken,
|
|
594
|
+
options: SyncedWaitOptions = {}
|
|
595
|
+
): Promise<void> {
|
|
596
|
+
const builder = this.services.workspace.DocumentBuilder;
|
|
597
|
+
const sync = this.services.workspace.VersionSyncService;
|
|
598
|
+
const waitOptions = { rejectWhenStuck: options.sync === true };
|
|
599
|
+
await builder.waitUntil(state, uri, cancelToken, waitOptions);
|
|
600
|
+
if (textVersion === undefined) {
|
|
601
|
+
return;
|
|
602
|
+
}
|
|
603
|
+
while (!sync.isSyncedTo(uri, textVersion)) {
|
|
604
|
+
const build = options.sync === true ? sync.syncTo(uri, textVersion) : undefined;
|
|
605
|
+
this.tracer
|
|
606
|
+
.withUri(uri.toString())
|
|
607
|
+
.debug(`waiting for ${uri.toString()} to reach ${DocumentState[state]} at v${textVersion} or later`);
|
|
608
|
+
await this.nextParseOrDeletion(uri, cancelToken, build);
|
|
609
|
+
await builder.waitUntil(state, uri, cancelToken, waitOptions);
|
|
610
|
+
}
|
|
611
|
+
}
|
|
612
|
+
|
|
613
|
+
/**
|
|
614
|
+
* Resolves once a parse of `uri` has been recorded or a build has deleted
|
|
615
|
+
* it, rejecting with `OperationCancelled` when `cancelToken` is cancelled
|
|
616
|
+
* first, and with an error when `build`, the build requested for it, is
|
|
617
|
+
* given up. A `Parsed` phase listener cannot serve: a cancel right after the
|
|
618
|
+
* parse skips it, and the resumed build does not parse again.
|
|
619
|
+
*/
|
|
620
|
+
protected nextParseOrDeletion(uri: URI, cancelToken: CancellationToken = CancellationToken.None, build?: Promise<void>): Promise<void> {
|
|
621
|
+
const builder = this.services.workspace.DocumentBuilder;
|
|
622
|
+
return new Promise<void>((resolve, reject) => {
|
|
623
|
+
let ended = false;
|
|
624
|
+
let cancelled = false;
|
|
625
|
+
// Handled before any return, so a build given up after the wait ended is not an unhandled rejection.
|
|
626
|
+
build?.catch((error: unknown) => {
|
|
627
|
+
const line = `The build that would sync the root to its text failed. ${describeErrorWithStack(error)}`;
|
|
628
|
+
if (cancelled) {
|
|
629
|
+
// The waiter has gone, so nothing else reports this.
|
|
630
|
+
this.tracer.withUri(uri.toString()).error(line);
|
|
631
|
+
} else if (ended) {
|
|
632
|
+
// A parse or deletion came first: the waiter goes on and reports its own outcome, and the retry warned.
|
|
633
|
+
this.tracer.withUri(uri.toString()).debug(line);
|
|
634
|
+
} else {
|
|
635
|
+
done(() => reject(new Error(`The build that would sync ${uri.toString()} to its text failed`, { cause: error })));
|
|
636
|
+
}
|
|
637
|
+
});
|
|
638
|
+
// A cancelled token's listener runs a macrotask later, after a build
|
|
639
|
+
// that started meanwhile may have parsed.
|
|
640
|
+
if (cancelToken.isCancellationRequested) {
|
|
641
|
+
ended = true;
|
|
642
|
+
cancelled = true;
|
|
643
|
+
reject(OperationCancelled);
|
|
644
|
+
return;
|
|
645
|
+
}
|
|
646
|
+
const done = (settle: () => void): void => {
|
|
647
|
+
ended = true;
|
|
648
|
+
parsed.dispose();
|
|
649
|
+
deleted.dispose();
|
|
650
|
+
cancelling.dispose();
|
|
651
|
+
settle();
|
|
652
|
+
};
|
|
653
|
+
const parsed = this.services.workspace.VersionSyncService.onDidRecordModel(document => {
|
|
654
|
+
if (UriUtils.equals(document.uri, uri)) {
|
|
655
|
+
done(resolve);
|
|
656
|
+
}
|
|
657
|
+
});
|
|
658
|
+
const deleted = builder.onUpdate((_changed, deletedUris) => {
|
|
659
|
+
if (deletedUris.some(deletedUri => UriUtils.equals(deletedUri, uri))) {
|
|
660
|
+
done(resolve);
|
|
661
|
+
}
|
|
662
|
+
});
|
|
663
|
+
const cancelling = cancelToken.onCancellationRequested(() => {
|
|
664
|
+
cancelled = true;
|
|
665
|
+
done(() => reject(OperationCancelled));
|
|
666
|
+
});
|
|
667
|
+
});
|
|
378
668
|
}
|
|
379
669
|
|
|
380
670
|
/**
|
|
@@ -398,31 +688,35 @@ export class ModelService<
|
|
|
398
688
|
* Force a fresh build of the document at `uri` and wait for it to
|
|
399
689
|
* reach `state` (or the integrity-settled landmark
|
|
400
690
|
* {@link IntegrityService.SettledState} if omitted).
|
|
401
|
-
* Always
|
|
402
|
-
*
|
|
403
|
-
* you want to re-process from scratch.
|
|
691
|
+
* Always builds the document, whether or not it is already in the
|
|
692
|
+
* registry, in a build of its own or in one already scheduled that carries
|
|
693
|
+
* it — call this when you want to re-process from scratch.
|
|
404
694
|
*
|
|
405
|
-
* The facade is responsible for
|
|
406
|
-
* directly because Langium's `DefaultDocumentUpdateHandler.didChangeContent`
|
|
695
|
+
* The facade is responsible for requesting the build itself because Langium's `DefaultDocumentUpdateHandler.didChangeContent`
|
|
407
696
|
* (the standard text-document → builder bridge) only runs under an
|
|
408
697
|
* LSP `Connection`. Running headless the bridge never fires; the
|
|
409
698
|
* facade stands in for it on its own update path.
|
|
410
699
|
*
|
|
411
700
|
* Coexistence with an LSP head running on the same `DocumentBuilder` is
|
|
412
|
-
* fine
|
|
413
|
-
*
|
|
414
|
-
*
|
|
415
|
-
*
|
|
416
|
-
*
|
|
417
|
-
*
|
|
418
|
-
* and Langium appends the second set onto the first, duplicating every
|
|
419
|
-
* diagnostic.
|
|
420
|
-
* {@link ModelServiceOptions.
|
|
421
|
-
* non-reentrancy hazard
|
|
701
|
+
* fine: the LSP head builds from the LSP-driven event and the facade from
|
|
702
|
+
* its own RPC-driven event — both legitimate — and both go through
|
|
703
|
+
* `HydraniumDocumentBuilder.scheduleUpdate`, which serialises them under
|
|
704
|
+
* the workspace WRITE lock and lets the second share the first's build
|
|
705
|
+
* where that build carries it. Langium alone does not coalesce concurrent
|
|
706
|
+
* builds of one URI: two unserialised builds each run a full validation
|
|
707
|
+
* pass and Langium appends the second set onto the first, duplicating every
|
|
708
|
+
* diagnostic. A caller that already holds the lock builds without it only
|
|
709
|
+
* under {@link ModelServiceOptions.allowReentrantBuilds} — see there for the
|
|
710
|
+
* non-reentrancy hazard.
|
|
422
711
|
*
|
|
423
|
-
*
|
|
424
|
-
*
|
|
425
|
-
*
|
|
712
|
+
* An override calls the base before it awaits. Under an LSP connection the
|
|
713
|
+
* store's change event has already asked the update handler to build a
|
|
714
|
+
* session's write; an override whose await outlasts that build makes the
|
|
715
|
+
* base's request start a build of its own, so the write is built and
|
|
716
|
+
* delivered twice.
|
|
717
|
+
*
|
|
718
|
+
* Rejects when the build leaves no document for `uri`, as for a URI with
|
|
719
|
+
* neither a file nor text: the wait after it has nothing to wait on.
|
|
426
720
|
*
|
|
427
721
|
* Consumers wanting "give me this doc at state X, building only if
|
|
428
722
|
* needed" — use the per-state methods ({@link parsed} / {@link linked}
|
|
@@ -434,8 +728,8 @@ export class ModelService<
|
|
|
434
728
|
|
|
435
729
|
/**
|
|
436
730
|
* Internal build core operating on an already-{@link CanonicalUri canonical}
|
|
437
|
-
* URI — the build counterpart to {@link waitForDocumentStateCanonical}.
|
|
438
|
-
*
|
|
731
|
+
* URI — the build counterpart to {@link waitForDocumentStateCanonical}.
|
|
732
|
+
* Requests the build, then waits via the canonical wait core, so the
|
|
439
733
|
* identity is resolved once at the public door and neither sink re-runs the
|
|
440
734
|
* `realpath`. (`DocumentBuilder.update` still resolves each URI internally for
|
|
441
735
|
* directory flattening — that is the build's own existence-aware resolution,
|
|
@@ -447,58 +741,45 @@ export class ModelService<
|
|
|
447
741
|
cancelToken?: CancellationToken
|
|
448
742
|
): Promise<AstDocument<TAst, TDiagnostic>> {
|
|
449
743
|
const documentUri = UriUtils.toUri(uri);
|
|
450
|
-
// Runs under the workspace WRITE lock,
|
|
451
|
-
// `
|
|
452
|
-
//
|
|
744
|
+
// Runs under the workspace WRITE lock, through the builder's
|
|
745
|
+
// `scheduleUpdate` like the LSP update handler's build, so the build the
|
|
746
|
+
// store's change event already scheduled for this write carries this
|
|
747
|
+
// request too rather than being cancelled by it.
|
|
453
748
|
//
|
|
454
749
|
// Unlocked, this build races the LSP bridge's build of the same URI: both
|
|
455
750
|
// are legitimate (the bridge only exists under a `Connection`, so the
|
|
456
|
-
// facade stands in for it headless), and
|
|
457
|
-
//
|
|
458
|
-
// two, so both reach `Validated`, and because each computes its missing
|
|
751
|
+
// facade stands in for it headless), and nothing serialises the two, so
|
|
752
|
+
// both reach `Validated`, and because each computes its missing
|
|
459
753
|
// validation categories before the other has recorded its own, both run a
|
|
460
754
|
// FULL pass and Langium appends the second onto the first (its append is
|
|
461
755
|
// meant for category-partitioned passes). The user-visible result is every
|
|
462
756
|
// diagnostic duplicated, plus double the validation work per write.
|
|
463
757
|
//
|
|
464
|
-
//
|
|
465
|
-
// the
|
|
466
|
-
|
|
467
|
-
|
|
468
|
-
// is not reentrant: acquiring the write lock cancels the running holder,
|
|
469
|
-
// so a caller already inside one — an integrity rule or build-phase pass
|
|
470
|
-
// writing back through this facade — would cancel its own enclosing
|
|
471
|
-
// build and then likely stall in the phase wait below. The check is
|
|
472
|
-
// gated on `serializeBuilds` deliberately, because acquiring the lock IS
|
|
473
|
-
// the hazard: with serialisation off there is nothing to be reentrant
|
|
474
|
-
// about, which makes the existing opt-out the guard's opt-out too.
|
|
475
|
-
// Detection needs async-context propagation, so it is inert until a host
|
|
476
|
-
// installs a tracker (`@hydranium/core/node` does) — see
|
|
477
|
-
// `isInsideWriteLock`.
|
|
478
|
-
if (isInsideWriteLock()) {
|
|
479
|
-
throw new ReentrantWriteLockError(uri);
|
|
480
|
-
}
|
|
481
|
-
// The lock's OWN token, not the caller's: a later `write` cancels the
|
|
482
|
-
// running one through that token, so substituting the caller's would
|
|
483
|
-
// leave this build deaf to the lock's cancellation protocol. A caller
|
|
484
|
-
// token still governs the phase wait below.
|
|
485
|
-
await this.services.workspace.WorkspaceLock.write(lockToken =>
|
|
486
|
-
this.services.workspace.DocumentBuilder.update([documentUri], [], lockToken)
|
|
487
|
-
);
|
|
488
|
-
} else {
|
|
758
|
+
// A caller already inside the lock would cancel its own build and stall in
|
|
759
|
+
// the wait below; `allowReentrantBuilds` builds it unlocked, and without a
|
|
760
|
+
// tracker it cannot be told apart from any other caller.
|
|
761
|
+
if (this.allowReentrantBuilds.value && (isInsideWriteLock() || !isWriteLockScopeInstalled())) {
|
|
489
762
|
await this.services.workspace.DocumentBuilder.update([documentUri], [], cancelToken);
|
|
763
|
+
} else {
|
|
764
|
+
this.assertCanBuild(uri);
|
|
765
|
+
// The build runs on the lock's own token, which a later write cancels;
|
|
766
|
+
// the caller's token governs only the phase wait below.
|
|
767
|
+
await this.services.workspace.DocumentBuilder.scheduleUpdate([documentUri], []);
|
|
768
|
+
}
|
|
769
|
+
return this.waitForDocumentStateCanonical(uri, state ?? IntegrityService.SettledState, cancelToken, { sync: true });
|
|
770
|
+
}
|
|
771
|
+
|
|
772
|
+
assertCanBuild(uri: string): void {
|
|
773
|
+
if (isInsideWriteLock() && !this.allowReentrantBuilds.value) {
|
|
774
|
+
throw new ReentrantWriteLockError(uri);
|
|
490
775
|
}
|
|
491
|
-
return this.waitForDocumentStateCanonical(uri, state ?? IntegrityService.SettledState, cancelToken);
|
|
492
776
|
}
|
|
493
777
|
|
|
494
778
|
/**
|
|
495
779
|
* Per-state typed convenience methods. Each ensures the document at
|
|
496
780
|
* `uri` reaches the named phase and returns the AST envelope with
|
|
497
|
-
* the narrowest accurate diagnostics type for that phase
|
|
498
|
-
*
|
|
499
|
-
* registry) just waits via {@link waitForDocumentState}; cold path
|
|
500
|
-
* triggers a build via {@link rebuild}. Consumers do not need to
|
|
501
|
-
* know which path was taken.
|
|
781
|
+
* the narrowest accurate diagnostics type for that phase, building as
|
|
782
|
+
* {@link ensureDocumentState} does.
|
|
502
783
|
*
|
|
503
784
|
* Phase invariants encoded in the return type:
|
|
504
785
|
* - `parsed` / `linked` / `settled` / `indexed` return
|
|
@@ -507,16 +788,13 @@ export class ModelService<
|
|
|
507
788
|
* - `validated` returns `AstDocument<TAst, TDiagnostic>` — diagnostics
|
|
508
789
|
* are populated.
|
|
509
790
|
*
|
|
510
|
-
* **The `never` is
|
|
511
|
-
*
|
|
512
|
-
*
|
|
513
|
-
*
|
|
514
|
-
*
|
|
515
|
-
*
|
|
516
|
-
*
|
|
517
|
-
* exactly that. So read an empty array as "none were computed, or there are
|
|
518
|
-
* none", never as "this document is clean", and call {@link validated} when
|
|
519
|
-
* the answer has to mean the second.
|
|
791
|
+
* **The `never` is enforced, not merely declared.** The wait underneath
|
|
792
|
+
* resolves at or ABOVE the requested state, so a document something else
|
|
793
|
+
* already carried past `Validated` would otherwise come back from
|
|
794
|
+
* `settled()` carrying a full diagnostics array typed `never`; these four
|
|
795
|
+
* strip it. An empty array here therefore means "this read does not report
|
|
796
|
+
* diagnostics", never "this document is clean" — call {@link validated}
|
|
797
|
+
* when the answer has to mean the second.
|
|
520
798
|
*
|
|
521
799
|
* `settled` is the integrity-overlay name for "all integrity rules
|
|
522
800
|
* have fired"; it maps to {@link IntegrityService.SettledState} (which
|
|
@@ -525,19 +803,19 @@ export class ModelService<
|
|
|
525
803
|
* ever moves.
|
|
526
804
|
*/
|
|
527
805
|
async parsed(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>> {
|
|
528
|
-
return this.ensureDocumentState(uri, DocumentState.Parsed, cancelToken)
|
|
806
|
+
return this.withoutDiagnostics(await this.ensureDocumentState(uri, DocumentState.Parsed, cancelToken));
|
|
529
807
|
}
|
|
530
808
|
|
|
531
809
|
async linked(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>> {
|
|
532
|
-
return this.ensureDocumentState(uri, DocumentState.Linked, cancelToken)
|
|
810
|
+
return this.withoutDiagnostics(await this.ensureDocumentState(uri, DocumentState.Linked, cancelToken));
|
|
533
811
|
}
|
|
534
812
|
|
|
535
813
|
async settled(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>> {
|
|
536
|
-
return this.ensureDocumentState(uri, IntegrityService.SettledState, cancelToken)
|
|
814
|
+
return this.withoutDiagnostics(await this.ensureDocumentState(uri, IntegrityService.SettledState, cancelToken));
|
|
537
815
|
}
|
|
538
816
|
|
|
539
817
|
async indexed(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>> {
|
|
540
|
-
return this.ensureDocumentState(uri, DocumentState.IndexedReferences, cancelToken)
|
|
818
|
+
return this.withoutDiagnostics(await this.ensureDocumentState(uri, DocumentState.IndexedReferences, cancelToken));
|
|
541
819
|
}
|
|
542
820
|
|
|
543
821
|
async validated(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, TDiagnostic>> {
|
|
@@ -547,18 +825,13 @@ export class ModelService<
|
|
|
547
825
|
/**
|
|
548
826
|
* Ensure the document at `uri` reaches `state` (or the integrity-settled
|
|
549
827
|
* landmark {@link IntegrityService.SettledState} if omitted) and return its
|
|
550
|
-
* AST envelope.
|
|
551
|
-
*
|
|
552
|
-
*
|
|
553
|
-
*
|
|
554
|
-
*
|
|
555
|
-
*
|
|
556
|
-
*
|
|
557
|
-
* document. Also pairs with {@link waitForDocumentState} — the verb
|
|
558
|
-
* difference (`ensure` vs `waitFor`) signals the side-effect
|
|
559
|
-
* difference. The per-state convenience methods (`parsed` / `linked`
|
|
560
|
-
* / `settled` / `indexed` / `validated`) all delegate here with an
|
|
561
|
-
* explicit phase.
|
|
828
|
+
* AST envelope, with a root no older than the store's text at the call.
|
|
829
|
+
* A document not in `LangiumDocuments` is built via {@link rebuild}; a
|
|
830
|
+
* loaded one whose root is behind its text is built through
|
|
831
|
+
* `VersionSyncService.syncTo`. Until `state` is reached, the call rejects
|
|
832
|
+
* once that build, or one the builder re-queues, has failed twice, or the
|
|
833
|
+
* builder stops re-queuing the document. A loaded, current document is only
|
|
834
|
+
* awaited.
|
|
562
835
|
*/
|
|
563
836
|
async ensureDocumentState(uri: string, state?: DocumentState, cancelToken?: CancellationToken): Promise<AstDocument<TAst, TDiagnostic>> {
|
|
564
837
|
return this.ensureDocumentStateCanonical(this.uriPolicy.canonicalUri(uri), state, cancelToken);
|
|
@@ -581,177 +854,73 @@ export class ModelService<
|
|
|
581
854
|
): Promise<AstDocument<TAst, TDiagnostic>> {
|
|
582
855
|
const target = state ?? IntegrityService.SettledState;
|
|
583
856
|
if (this.services.workspace.LangiumDocuments.hasDocument(UriUtils.toUri(uri))) {
|
|
584
|
-
return this.waitForDocumentStateCanonical(uri, target, cancelToken);
|
|
857
|
+
return this.waitForDocumentStateCanonical(uri, target, cancelToken, { sync: true });
|
|
585
858
|
}
|
|
586
859
|
return this.rebuild(uri, target, cancelToken);
|
|
587
860
|
}
|
|
588
861
|
|
|
589
862
|
/**
|
|
590
|
-
*
|
|
591
|
-
*
|
|
592
|
-
* structured), pushed into the multi-client text-document store with
|
|
593
|
-
* a fresh version, drives a build to the target phase, and returns
|
|
594
|
-
* the post-build AST snapshot.
|
|
595
|
-
*
|
|
596
|
-
* **Read-latest supersession**: concurrent callers on the same URI
|
|
597
|
-
* all see the same post-build state once `waitUntil` resolves; none
|
|
598
|
-
* deadlock waiting for a specific version's settled event. The
|
|
599
|
-
* framework emits a post-resolution `debug` log line distinguishing
|
|
600
|
-
* "vN ready" from "vN ready at vM (superseded)" so callers can
|
|
601
|
-
* observe when their write was overtaken by a newer one before
|
|
602
|
-
* settling — purely observability, doesn't change resolution
|
|
603
|
-
* semantics. Adopters wanting version-matched resolution (resolve
|
|
604
|
-
* with vN's specific settled snapshot, intermediate-phase
|
|
605
|
-
* observability, slow-warn / hard-timeout behaviour) override this
|
|
606
|
-
* method.
|
|
607
|
-
*/
|
|
608
|
-
async update(args: TransferUpdateArgs<TTransfer>, cancelToken?: CancellationToken): Promise<AstDocument<TAst, TDiagnostic>> {
|
|
609
|
-
const stopwatch = this.slowUpdateWarn !== undefined ? this.services.Clock.stopwatch() : undefined;
|
|
610
|
-
// Per-stage self-time breakdown of the update/reconcile chain (serialise →
|
|
611
|
-
// open → apply → rebuild), opt-in at debug — the default path skips the
|
|
612
|
-
// session and `run` calls the stage directly. `update` is a per-operation
|
|
613
|
-
// method (one user save / diagram edit), not a per-node hot loop, so the
|
|
614
|
-
// stage closures `run` allocates on the non-debug path are negligible.
|
|
615
|
-
// Canonicalize the write URI once at the door and thread the resulting
|
|
616
|
-
// CanonicalUri through the chain. The text store keys documents by their
|
|
617
|
-
// canonical identity, so any spelling of a file — a canonical
|
|
618
|
-
// (server-identity) URI from a GLSP cross-document save derived from
|
|
619
|
-
// `findDocument(node).uri`, or the symlink path an editor opened — collapses
|
|
620
|
-
// to the one registration; there is no second registration to fork. The
|
|
621
|
-
// build step reuses the canonical wait core (`rebuildCanonical`) so the
|
|
622
|
-
// identity is not re-resolved downstream.
|
|
623
|
-
const uri = this.uriPolicy.canonicalUri(args.uri);
|
|
624
|
-
const session = Logger.isLevelEnabled('debug') ? this.tracer.profile(`model-update ${uri}`) : undefined;
|
|
625
|
-
const run = async <T>(stage: string, fn: () => MaybePromise<T>): Promise<T> => (session ? session.scope(stage, fn) : fn());
|
|
626
|
-
// Open WITH the new text so a cold URI (no open editor, no file on disk) is
|
|
627
|
-
// created from the payload rather than read from the filesystem — `update`
|
|
628
|
-
// is an upsert. For an already-open document `open` refreshes content (the
|
|
629
|
-
// text is ignored on that branch), so existing-document behaviour is
|
|
630
|
-
// unchanged. `version` is intentionally NOT forwarded to `open`: a cold
|
|
631
|
-
// create stays at its initial version, so a based-on-`version` update of a
|
|
632
|
-
// not-yet-existing document still trips the conflict gate below.
|
|
633
|
-
const text = await run('serialize', () => this.modelToText(uri, args.model, cancelToken));
|
|
634
|
-
await run('open', () => this.open({ uri, clientId: args.clientId, text }));
|
|
635
|
-
if (args.baseVersion !== undefined) {
|
|
636
|
-
const current = this.services.workspace.TextDocuments.version(uri);
|
|
637
|
-
if (current !== args.baseVersion) {
|
|
638
|
-
// Distinct from the post-build "superseded" debug line below: this is a
|
|
639
|
-
// based-on-stale rejection (the write never applies), not two writes racing.
|
|
640
|
-
this.tracer.debug(`Conflict on ${uri}: based-on v${args.baseVersion} stale, server at v${current}`);
|
|
641
|
-
throw new ConflictError(uri, args.baseVersion, current);
|
|
642
|
-
}
|
|
643
|
-
}
|
|
644
|
-
const appliedVersion = await run('apply', () => this.services.workspace.AstDocumentManager.update(uri, text, args.clientId));
|
|
645
|
-
// Dispatch through the public `rebuild` (which re-canonicalizes the already-
|
|
646
|
-
// canonical `uri` once, idempotently) rather than `rebuildCanonical`, so an
|
|
647
|
-
// adopter `rebuild` override stays in the update path. The redundant call is
|
|
648
|
-
// a single kernel-cached `realpath`; correctness of the override contract
|
|
649
|
-
// wins over shaving it.
|
|
650
|
-
const doc = await run('rebuild', () => this.rebuild(uri, undefined, cancelToken));
|
|
651
|
-
const finalVersion = this.services.workspace.TextDocuments.version(uri);
|
|
652
|
-
if (finalVersion > appliedVersion) {
|
|
653
|
-
this.tracer.debug(`Update to v${appliedVersion} ready at v${finalVersion} (superseded)`);
|
|
654
|
-
} else {
|
|
655
|
-
this.tracer.debug(`Update to v${appliedVersion} ready`);
|
|
656
|
-
}
|
|
657
|
-
if (this.slowUpdateWarn !== undefined && stopwatch) {
|
|
658
|
-
const elapsed = Math.round(stopwatch.elapsedMs);
|
|
659
|
-
const threshold = this.slowUpdateWarn.value;
|
|
660
|
-
if (elapsed >= threshold) {
|
|
661
|
-
this.tracer.withUri(uri).warn(`Slow update: ${elapsed}ms ≥ ${threshold}ms (v${appliedVersion}, client=${args.clientId})`);
|
|
662
|
-
}
|
|
663
|
-
}
|
|
664
|
-
// One line per stage (serialise / open / apply / rebuild) + unaccounted — only when profiling.
|
|
665
|
-
session?.report('debug');
|
|
666
|
-
return doc;
|
|
667
|
-
}
|
|
668
|
-
|
|
669
|
-
/**
|
|
670
|
-
* Persist `uri` to disk. Same content-change + settled-phase flow as
|
|
671
|
-
* {@link update}, then writes via the
|
|
672
|
-
* `WritableFileSystemProvider` and notifies the multi-client
|
|
673
|
-
* text-document store of the save (so any open LSP-side editor sees
|
|
674
|
-
* the `onDidSave` event regardless of who originated the persist).
|
|
675
|
-
*
|
|
676
|
-
* Returns the post-save AST snapshot.
|
|
677
|
-
*/
|
|
678
|
-
async save(args: TransferSaveArgs<TTransfer>, cancelToken?: CancellationToken): Promise<AstDocument<TAst, TDiagnostic>> {
|
|
679
|
-
// Dispatch through `update` (not its internals) so an adopter `update`
|
|
680
|
-
// override — version-matched resolution, etc. — applies to saves too.
|
|
681
|
-
const doc = await this.update(args, cancelToken);
|
|
682
|
-
// Persist under the same canonical identity `update` operated on. Writing
|
|
683
|
-
// the canonical (real) path follows any symlink to the same file, and the
|
|
684
|
-
// `onDidSave` keys the one canonical registration.
|
|
685
|
-
const uri = this.uriPolicy.canonicalUri(args.uri);
|
|
686
|
-
await this.services.workspace.AstDocumentManager.save(uri, args.clientId);
|
|
687
|
-
return doc;
|
|
688
|
-
}
|
|
689
|
-
|
|
690
|
-
/**
|
|
691
|
-
* Wait for the document at `uri` to reach the integrity-settled landmark and
|
|
863
|
+
* Wait for the document at `uri` to reach the integrity-settled landmark,
|
|
864
|
+
* building a root behind its text as {@link ensureDocumentState} does, and
|
|
692
865
|
* drain any in-flight write-path applyEdit sync chain (see {@link syncChains})
|
|
693
|
-
* so
|
|
694
|
-
*
|
|
695
|
-
*
|
|
696
|
-
*
|
|
697
|
-
*
|
|
866
|
+
* so the language client has answered the push of the latest content before
|
|
867
|
+
* this returns; a push it refused twice is logged, not retried. No-op tail
|
|
868
|
+
* for headless adopters — `syncChains` is empty without an LSP client.
|
|
869
|
+
* Bounded at 10 s so a hung build, or an applyEdit reverse-RPC deadlock,
|
|
870
|
+
* can't freeze the caller; it returns rather than throwing, warning on
|
|
871
|
+
* timeout. A failed wait is logged at `error`, at `debug` when cancelled and
|
|
872
|
+
* at `warn` when the document is gone.
|
|
698
873
|
*
|
|
699
|
-
*
|
|
700
|
-
*
|
|
701
|
-
*
|
|
874
|
+
* The framework's save handlers call this after their persist, the data
|
|
875
|
+
* head's updates after their write and the GLSP head's settle request for
|
|
876
|
+
* each document a save writes; an adopter's own save path that answers a
|
|
877
|
+
* client calls it after its `save` too.
|
|
702
878
|
*/
|
|
703
|
-
|
|
879
|
+
async settleLanguageClient(uri: string, cancelToken?: CancellationToken): Promise<void> {
|
|
704
880
|
const canonical = this.uriPolicy.canonicalUri(uri);
|
|
705
881
|
const key = UriUtils.toUri(canonical).toString();
|
|
706
|
-
|
|
707
|
-
|
|
708
|
-
|
|
709
|
-
|
|
710
|
-
await
|
|
711
|
-
const
|
|
712
|
-
if (
|
|
713
|
-
|
|
882
|
+
// One race over both waits, so the bound is one deadline for the pair;
|
|
883
|
+
// a race per wait would let the caller wait twice the bound.
|
|
884
|
+
let awaitedChain: Promise<void> | undefined;
|
|
885
|
+
const settled = (async (): Promise<void> => {
|
|
886
|
+
await this.waitForDocumentStateCanonical(canonical, IntegrityService.SettledState, cancelToken, { sync: true });
|
|
887
|
+
const chain = this.syncChains.get(key);
|
|
888
|
+
if (chain && this.timedOutSyncChains.has(chain)) {
|
|
889
|
+
this.tracer.withUri(key).debug('Language client settle not waiting again for a push the client has not answered');
|
|
890
|
+
return;
|
|
714
891
|
}
|
|
715
|
-
|
|
716
|
-
|
|
717
|
-
|
|
892
|
+
awaitedChain = chain;
|
|
893
|
+
await chain;
|
|
894
|
+
})();
|
|
895
|
+
// The settle ends a failed wait, so it logs it, at one level whether the wait failed inside the bound or after it.
|
|
896
|
+
const reportFailedWait = (error: unknown, when: string): void => {
|
|
897
|
+
const tracer = this.tracer.withUri(key);
|
|
898
|
+
if (isOperationCancelled(error)) {
|
|
899
|
+
tracer.debug(`Language client settle cancelled ${when}`);
|
|
900
|
+
} else if (!this.services.workspace.LangiumDocuments.hasDocument(UriUtils.toUri(canonical))) {
|
|
901
|
+
tracer.warn(`Language client settle failed ${when}; the document is gone. ${describeErrorWithStack(error)}`);
|
|
718
902
|
} else {
|
|
719
|
-
|
|
720
|
-
this.tracer.withUri(key).warn(`Save settle failed before the timeout — returning anyway. ${detail}`);
|
|
903
|
+
tracer.error(`Language client settle failed ${when}. ${describeErrorWithStack(error)}`);
|
|
721
904
|
}
|
|
905
|
+
};
|
|
906
|
+
try {
|
|
907
|
+
if ((await this.services.Clock.raceTimer(settled, LANGUAGE_CLIENT_SETTLE_TIMEOUT_MS)) === TIMED_OUT) {
|
|
908
|
+
this.tracer.withUri(key).warn(`Language client settle exceeded ${LANGUAGE_CLIENT_SETTLE_TIMEOUT_MS}ms — returning anyway`);
|
|
909
|
+
if (awaitedChain) {
|
|
910
|
+
this.timedOutSyncChains.add(awaitedChain);
|
|
911
|
+
}
|
|
912
|
+
// The race has settled, so a later failure of the wait, such as a given-up sync build, reaches no one else.
|
|
913
|
+
void settled.catch((error: unknown) => reportFailedWait(error, 'after the timeout'));
|
|
914
|
+
}
|
|
915
|
+
} catch (err: unknown) {
|
|
916
|
+
// Its own line, so the failure is not blamed on the bound.
|
|
917
|
+
reportFailedWait(err, 'before the timeout — returning anyway');
|
|
722
918
|
}
|
|
723
919
|
}
|
|
724
920
|
|
|
725
|
-
|
|
726
|
-
|
|
727
|
-
|
|
728
|
-
* registration; the underlying document stays open until the last
|
|
729
|
-
* client closes it. If `args.text` is omitted the document content
|
|
730
|
-
* is read from the `FileSystemProvider`.
|
|
731
|
-
*
|
|
732
|
-
* Returns a {@link Disposable} that closes the registration when
|
|
733
|
-
* disposed — useful for `using` blocks and shutdown cleanup.
|
|
734
|
-
*
|
|
735
|
-
* Delegates to the framework-bound
|
|
736
|
-
* `services.workspace.AstDocumentManager`. Adopter subclasses with
|
|
737
|
-
* extra open-time behaviour (logging, sync-chain bootstrapping)
|
|
738
|
-
* override on their `ModelService` subclass and call `super.open`.
|
|
739
|
-
*
|
|
740
|
-
* The open path does not thread cancellation: `AstDocumentManager.open`
|
|
741
|
-
* and the filesystem read behind it take no token, so a cancelled caller
|
|
742
|
-
* still completes the open.
|
|
743
|
-
*/
|
|
744
|
-
async open(args: OpenModelArgs): Promise<Disposable> {
|
|
745
|
-
return this.services.workspace.AstDocumentManager.open(args);
|
|
746
|
-
}
|
|
747
|
-
|
|
748
|
-
/**
|
|
749
|
-
* Close the document at `args.uri` for `args.clientId`. Counterpart
|
|
750
|
-
* to {@link open}; the underlying document stays open until every
|
|
751
|
-
* registered client has closed.
|
|
752
|
-
*/
|
|
753
|
-
async close(args: CloseModelArgs): Promise<void> {
|
|
754
|
-
return this.services.workspace.AstDocumentManager.close(args);
|
|
921
|
+
isLanguageClientPushPending(uri: string): boolean {
|
|
922
|
+
const chain = this.syncChains.get(UriUtils.toUri(this.uriPolicy.canonicalUri(uri)).toString());
|
|
923
|
+
return chain !== undefined && !this.timedOutSyncChains.has(chain);
|
|
755
924
|
}
|
|
756
925
|
|
|
757
926
|
/**
|
|
@@ -762,6 +931,37 @@ export class ModelService<
|
|
|
762
931
|
return this.services.workspace.AstDocumentManager.isOpen(uri);
|
|
763
932
|
}
|
|
764
933
|
|
|
934
|
+
openedVersion(uri: string): TextVersion | undefined {
|
|
935
|
+
return this.services.workspace.TextDocuments.openedVersion(uri);
|
|
936
|
+
}
|
|
937
|
+
|
|
938
|
+
/**
|
|
939
|
+
* Snapshot of `uri` as it stands RIGHT NOW — the synchronous sibling of the
|
|
940
|
+
* phase reads, which all wait. `undefined` when no document is registered,
|
|
941
|
+
* or only the builder's placeholder for one its build has not parsed yet:
|
|
942
|
+
* that root is no parse of any text, and its version gates no write.
|
|
943
|
+
*
|
|
944
|
+
* **This is what a writer wants, and {@link getDocument} is not.** The
|
|
945
|
+
* envelope's `version` is copied by value at projection time, so it cannot
|
|
946
|
+
* move afterwards; a version read off the live document at write time is
|
|
947
|
+
* whatever the server is at *now*, which is the number an optimistic gate is
|
|
948
|
+
* about to compare it against.
|
|
949
|
+
*
|
|
950
|
+
* Diagnostics only from a document that has reached `Validated`, and absent
|
|
951
|
+
* otherwise. Unlike the phase reads this one names no phase, so
|
|
952
|
+
* the state it finds is the only thing that can say whether the array
|
|
953
|
+
* describes the content being handed back or whatever an earlier build left.
|
|
954
|
+
* A caller that needs them unconditionally waits, via {@link validated}.
|
|
955
|
+
*/
|
|
956
|
+
snapshot(uri: string): AstDocument<TAst, TDiagnostic> | undefined {
|
|
957
|
+
const document = this.getDocument(uri);
|
|
958
|
+
if (!document || this.services.workspace.ModelLedger.isPlaceholder(document.parseResult.value)) {
|
|
959
|
+
return undefined;
|
|
960
|
+
}
|
|
961
|
+
const envelope = this.services.workspace.AstDocumentManager.toAstDocument(document) as AstDocument<TAst, TDiagnostic>;
|
|
962
|
+
return document.state >= DocumentState.Validated ? envelope : this.withoutDiagnostics(envelope);
|
|
963
|
+
}
|
|
964
|
+
|
|
765
965
|
/**
|
|
766
966
|
* The built {@link LangiumDocument} for `uri`, looked up by canonical identity —
|
|
767
967
|
* the synchronous, phase-agnostic sibling of {@link ensureDocumentState} /
|
|
@@ -770,11 +970,106 @@ export class ModelService<
|
|
|
770
970
|
* into `LangiumDocuments` directly: a symlinked / `..` / case-divergent URI
|
|
771
971
|
* still resolves to the one document the build keys by its real path. Returns
|
|
772
972
|
* `undefined` if no document is registered for `uri`.
|
|
973
|
+
*
|
|
974
|
+
* **Live, so do not take a base version off it.** `textDocument` is the
|
|
975
|
+
* store's own object rather than a copy, so `.version` read here answers for
|
|
976
|
+
* the moment of the READ, not the moment of the earlier content — pass it to
|
|
977
|
+
* a write and the server compares its current version against itself, the
|
|
978
|
+
* gate passes unconditionally, and a concurrent edit is overwritten with
|
|
979
|
+
* nothing logged. Use {@link snapshot} for that, or a phase read.
|
|
773
980
|
*/
|
|
774
981
|
getDocument(uri: string): LangiumDocument | undefined {
|
|
775
982
|
return this.services.workspace.AstDocumentManager.getDocument(uri);
|
|
776
983
|
}
|
|
777
984
|
|
|
985
|
+
// ============================================================
|
|
986
|
+
// Client sessions
|
|
987
|
+
// ============================================================
|
|
988
|
+
|
|
989
|
+
createSession<TOpenOptions extends OpenOptions = OpenOptions>(
|
|
990
|
+
label?: string,
|
|
991
|
+
clientId?: string,
|
|
992
|
+
options: { readonly resumeToken?: string } = {}
|
|
993
|
+
): ClientSession<TAst, TDiagnostic, TTransfer, TOpenOptions> {
|
|
994
|
+
const sessionLabel = label ?? 'session';
|
|
995
|
+
const id = clientId ?? `${sessionLabel}#${randomUuid()}`;
|
|
996
|
+
const textDocuments = this.services.workspace.TextDocuments;
|
|
997
|
+
if (options.resumeToken !== undefined && this.resumeTokens.get(id) === options.resumeToken) {
|
|
998
|
+
this.sessions.get(id)?.dispose('lost');
|
|
999
|
+
}
|
|
1000
|
+
textDocuments.registerSession(id);
|
|
1001
|
+
this.sessionCloseListener ??= textDocuments.onDidCloseSession(event => {
|
|
1002
|
+
// Also reached when the store ends a session directly; disposing the
|
|
1003
|
+
// handle makes its later calls fail rather than write under an id
|
|
1004
|
+
// this service no longer treats as a session. Forgotten first: a
|
|
1005
|
+
// dispose listener may start a replacement under the same id.
|
|
1006
|
+
const ended = this.sessions.get(event.clientId);
|
|
1007
|
+
this.sessions.delete(event.clientId);
|
|
1008
|
+
this.resumeTokens.delete(event.clientId);
|
|
1009
|
+
ended?.dispose(event.cause);
|
|
1010
|
+
});
|
|
1011
|
+
let session: ClientSession<TAst, TDiagnostic, TTransfer, TOpenOptions>;
|
|
1012
|
+
try {
|
|
1013
|
+
// Unchecked: the session keeps whatever options its `open` is handed,
|
|
1014
|
+
// and the factory types it for every grammar, so the narrowed type
|
|
1015
|
+
// holds only for the caller that started it.
|
|
1016
|
+
session = this.services.model.ClientSessionFactory.create(id, sessionLabel) as ClientSession<
|
|
1017
|
+
TAst,
|
|
1018
|
+
TDiagnostic,
|
|
1019
|
+
TTransfer,
|
|
1020
|
+
TOpenOptions
|
|
1021
|
+
>;
|
|
1022
|
+
} catch (err: unknown) {
|
|
1023
|
+
textDocuments.closeSession(id);
|
|
1024
|
+
throw err;
|
|
1025
|
+
}
|
|
1026
|
+
this.sessions.set(id, session);
|
|
1027
|
+
if (options.resumeToken !== undefined) {
|
|
1028
|
+
this.resumeTokens.set(id, options.resumeToken);
|
|
1029
|
+
}
|
|
1030
|
+
return session;
|
|
1031
|
+
}
|
|
1032
|
+
|
|
1033
|
+
getSession(clientId: string): ClientSession<TAst, TDiagnostic, TTransfer> | undefined {
|
|
1034
|
+
return this.sessions.get(clientId);
|
|
1035
|
+
}
|
|
1036
|
+
|
|
1037
|
+
/**
|
|
1038
|
+
* Convert a structured-or-textual `model` payload to its textual form.
|
|
1039
|
+
*
|
|
1040
|
+
* Textual payloads (LSP / pre-serialised callers) pass through untouched.
|
|
1041
|
+
* Structured payloads run the per-language `UpdateRewriteService` chain
|
|
1042
|
+
* (transfer-model transforms; diff-aware rewrites see the previous AST root),
|
|
1043
|
+
* then serialise. The chain is the single transfer-model-transform seam — a
|
|
1044
|
+
* unary normalisation is just a rewrite that ignores `previous`, as
|
|
1045
|
+
* `NormalizeEmptyStringsContribution` does. The chain is empty by
|
|
1046
|
+
* default, so this is a no-op for adopters that register none.
|
|
1047
|
+
*
|
|
1048
|
+
* The serialised text then takes the trivia of the text it replaces, or of
|
|
1049
|
+
* an empty one when `uri` has none, so a created document gets the
|
|
1050
|
+
* preservers' defaults rather than the serializer's bare output.
|
|
1051
|
+
*/
|
|
1052
|
+
async modelToText(uri: string, model: TTransfer | string, cancelToken?: CancellationToken): Promise<string> {
|
|
1053
|
+
if (typeof model === 'string') {
|
|
1054
|
+
return model;
|
|
1055
|
+
}
|
|
1056
|
+
const rewritten = await this.rewriteModel(uri, model, cancelToken);
|
|
1057
|
+
const target = UriUtils.toUri(uri);
|
|
1058
|
+
const trivia = this.services.ServiceRegistry?.getServices(target)?.trivia?.TriviaService;
|
|
1059
|
+
// Extracted BEFORE serializing, so it reads the document the write is
|
|
1060
|
+
// about to replace rather than whatever a concurrent build left behind.
|
|
1061
|
+
let document = this.services.workspace.LangiumDocuments.getDocument(target);
|
|
1062
|
+
if (trivia !== undefined && document === undefined) {
|
|
1063
|
+
// With no text, an empty one: every preserver still runs, so a created
|
|
1064
|
+
// document takes the defaults a blank one gets.
|
|
1065
|
+
const source = (await this.textToTakeTriviaFrom(uri, target)) ?? '';
|
|
1066
|
+
document = this.services.workspace.LangiumDocumentFactory.fromString(source, target);
|
|
1067
|
+
}
|
|
1068
|
+
const extracted = trivia !== undefined && document !== undefined ? trivia.extract(document) : undefined;
|
|
1069
|
+
const serialized = await this.serialize(uri, rewritten);
|
|
1070
|
+
return extracted === undefined ? serialized : trivia!.apply(serialized, extracted, target);
|
|
1071
|
+
}
|
|
1072
|
+
|
|
778
1073
|
// ============================================================
|
|
779
1074
|
// LSP-client sync (mirror non-LSP-client changes back to Monaco)
|
|
780
1075
|
// ============================================================
|
|
@@ -783,18 +1078,14 @@ export class ModelService<
|
|
|
783
1078
|
* Mirror a server-side change of `document` back to the LSP textual language
|
|
784
1079
|
* client, run per document as it reaches the post-integrity settled phase.
|
|
785
1080
|
* The single framework caller of
|
|
786
|
-
* `HydraniumTextDocuments.applyEditToLanguageClient
|
|
787
|
-
* `HydraniumTextDocuments.stagePendingContent`.
|
|
788
|
-
*
|
|
789
|
-
* Routes to one of two mechanisms by language-client registration, because
|
|
790
|
-
* an open and a closed document answer different questions:
|
|
1081
|
+
* `HydraniumTextDocuments.applyEditToLanguageClient`.
|
|
791
1082
|
*
|
|
792
|
-
*
|
|
793
|
-
*
|
|
794
|
-
*
|
|
795
|
-
*
|
|
796
|
-
*
|
|
797
|
-
*
|
|
1083
|
+
* Only a document open in the language client is mirrored, through
|
|
1084
|
+
* {@link syncOpenDocument}, routed purely by **content**. A document open
|
|
1085
|
+
* only in another client needs nothing: a language client opening it joins
|
|
1086
|
+
* the existing entry and is refreshed from the store. A session writes only
|
|
1087
|
+
* what it has open, so no session edit of a closed document waits here for
|
|
1088
|
+
* the language client's next open.
|
|
798
1089
|
*
|
|
799
1090
|
* The decision is **re-derived from the current settled state every time** (it
|
|
800
1091
|
* is not a one-shot enrolment), which is what makes it self-healing: a doc
|
|
@@ -804,20 +1095,18 @@ export class ModelService<
|
|
|
804
1095
|
*/
|
|
805
1096
|
protected syncToLanguageClient(document: LangiumDocument): void {
|
|
806
1097
|
// `document.textDocument.uri` is the server-identity (canonical) URI off the
|
|
807
|
-
// build. Route by
|
|
808
|
-
//
|
|
809
|
-
//
|
|
810
|
-
// CANONICAL URI — the same key `
|
|
811
|
-
// so a
|
|
1098
|
+
// build. Route by client registration (presence questions — both
|
|
1099
|
+
// predicates canonicalize internally, so a divergent open path still
|
|
1100
|
+
// resolves to the same record), but key the outbound sync by this
|
|
1101
|
+
// CANONICAL URI — the same key `settleLanguageClient` looks the chain up
|
|
1102
|
+
// under — so a settle can drain the in-flight applyEdit. The canonical→client-URI
|
|
812
1103
|
// translation (a symlinked path the client opened, or a dual-open fan-out)
|
|
813
1104
|
// happens at the `applyEditToLanguageClient` egress, where the text store maps
|
|
814
1105
|
// the canonical key to the recorded language-client URI(s); driving the chain
|
|
815
|
-
// in client space here would key it under a URI `
|
|
816
|
-
// the drain would miss for a divergent open path.
|
|
1106
|
+
// in client space here would key it under a URI `settleLanguageClient`
|
|
1107
|
+
// never computes, so the drain would miss for a divergent open path.
|
|
817
1108
|
if (this.services.workspace.TextDocuments.isOpenInLanguageClient(document.textDocument.uri)) {
|
|
818
1109
|
this.syncOpenDocument(document.textDocument.uri, document.textDocument.getText());
|
|
819
|
-
} else {
|
|
820
|
-
this.stageClosedDocument(document);
|
|
821
1110
|
}
|
|
822
1111
|
}
|
|
823
1112
|
|
|
@@ -836,46 +1125,6 @@ export class ModelService<
|
|
|
836
1125
|
this.queueSync(uri, text);
|
|
837
1126
|
}
|
|
838
1127
|
|
|
839
|
-
/**
|
|
840
|
-
* Stage the settled text of a document closed in the language client so the
|
|
841
|
-
* eventual first `didOpen` sees this in-memory text instead of stale disk —
|
|
842
|
-
* but only for a {@link isNonLanguageClientEdit genuine non-language-client edit}.
|
|
843
|
-
* A document rebuilt by an internal build is skipped, leaving disk authoritative
|
|
844
|
-
* on the next open.
|
|
845
|
-
*/
|
|
846
|
-
protected stageClosedDocument(document: LangiumDocument): void {
|
|
847
|
-
if (this.isNonLanguageClientEdit(document)) {
|
|
848
|
-
this.services.workspace.TextDocuments.stagePendingContent(document.textDocument.uri, document.textDocument.getText());
|
|
849
|
-
}
|
|
850
|
-
}
|
|
851
|
-
|
|
852
|
-
/**
|
|
853
|
-
* Whether `document`'s settled state is a genuine edit by a client *other than
|
|
854
|
-
* the language client* — a write a form / GLSP / integrity client actually made.
|
|
855
|
-
* Excludes two non-edits: the **language client** itself (the LSP/Monaco text
|
|
856
|
-
* client — it already holds its own edits, and the staging here exists to feed
|
|
857
|
-
* it) and an **internal build** (workspace startup, a cascade relink, a
|
|
858
|
-
* `didClose`-reload). This is the gate for {@link stageClosedDocument}: staging
|
|
859
|
-
* an internal build would
|
|
860
|
-
* (a) pre-stage every file on boot and (b) re-stage discarded content after
|
|
861
|
-
* close (e.g. a disposing GLSP session's debounced submit firing after close),
|
|
862
|
-
* which then shadows clean disk on the next open.
|
|
863
|
-
*
|
|
864
|
-
* The signal is "a known client other than the language client authored this
|
|
865
|
-
* version **and** the URI was in the last build's changed set
|
|
866
|
-
* (`isDirectChange`)". A framework-internal rebuild reports no author
|
|
867
|
-
* (`getAuthor` → `undefined`), so it fails `hasKnownAuthor` without comparing
|
|
868
|
-
* against a sentinel. This is NOT redundant with content/registration — it
|
|
869
|
-
* distinguishes "client edited" from "framework rebuilt", which neither the
|
|
870
|
-
* shadow nor `isDirectChange` alone can.
|
|
871
|
-
*/
|
|
872
|
-
protected isNonLanguageClientEdit(document: LangiumDocument): boolean {
|
|
873
|
-
const documents = this.services.workspace.AstDocumentManager;
|
|
874
|
-
const author = documents.getAuthor(document);
|
|
875
|
-
const hasKnownAuthor = !!author && author !== LANGUAGE_CLIENT_ID;
|
|
876
|
-
return hasKnownAuthor && documents.isDirectChange(document.textDocument.uri);
|
|
877
|
-
}
|
|
878
|
-
|
|
879
1128
|
/**
|
|
880
1129
|
* Enqueue a sync to the language client. The pending slot per URI holds only
|
|
881
1130
|
* the latest text: if a newer settle fires while the current RPC is in
|
|
@@ -926,17 +1175,31 @@ export class ModelService<
|
|
|
926
1175
|
const text = this.pendingSync.get(uri)!;
|
|
927
1176
|
this.pendingSync.delete(uri);
|
|
928
1177
|
try {
|
|
929
|
-
|
|
930
|
-
|
|
931
|
-
|
|
1178
|
+
const textDocuments = this.services.workspace.TextDocuments;
|
|
1179
|
+
// An answer, or a failure, ends a hang a settle timed out on, so the
|
|
1180
|
+
// chain's later pushes are waited for again.
|
|
1181
|
+
const push = async (): Promise<ApplyWorkspaceEditResult | undefined> => {
|
|
1182
|
+
try {
|
|
1183
|
+
return await textDocuments.applyEditToLanguageClient(uri, text, { label: this.editLabel() });
|
|
1184
|
+
} finally {
|
|
1185
|
+
const chain = this.syncChains.get(uri);
|
|
1186
|
+
if (chain) {
|
|
1187
|
+
this.timedOutSyncChains.delete(chain);
|
|
1188
|
+
}
|
|
1189
|
+
}
|
|
1190
|
+
};
|
|
1191
|
+
let result = await push();
|
|
1192
|
+
if (result?.applied === false && !this.pendingSync.has(uri) && textDocuments.get(uri)?.getText() === text) {
|
|
1193
|
+
// The push is addressed at the client's last known version, so a
|
|
932
1194
|
// rejection normally means the client's buffer moved while the
|
|
933
1195
|
// line-keyed diff was in flight — exactly the case where applying it
|
|
934
1196
|
// would splice the file. Dropping the push there would leave the
|
|
935
1197
|
// editor showing text the server has already superseded, with no
|
|
936
1198
|
// later settle guaranteed to correct it (a content-identical echo
|
|
937
|
-
// mints no rebuild).
|
|
938
|
-
//
|
|
939
|
-
//
|
|
1199
|
+
// mints no rebuild). After a rejection the retry is a full-range
|
|
1200
|
+
// replace: position-independent, and therefore correct against
|
|
1201
|
+
// whatever the client now holds. It sends nothing when the client
|
|
1202
|
+
// was last heard to hold the text already.
|
|
940
1203
|
//
|
|
941
1204
|
// Retried INLINE rather than re-enqueued, and exactly once. Inline
|
|
942
1205
|
// because a re-enqueue would have to out-order any settle that lands
|
|
@@ -945,9 +1208,11 @@ export class ModelService<
|
|
|
945
1208
|
// the workspace) must cost one extra RPC rather than spin. The
|
|
946
1209
|
// `pendingSync` check skips the retry when a newer settle has already
|
|
947
1210
|
// queued — best-effort, since a settle arriving later simply pushes
|
|
948
|
-
// after this and still wins.
|
|
949
|
-
|
|
950
|
-
|
|
1211
|
+
// after this and still wins. It is skipped too once the store holds
|
|
1212
|
+
// other text: the keystroke that made the client refuse replaced it,
|
|
1213
|
+
// and re-pushing would overwrite that keystroke in the editor.
|
|
1214
|
+
uriLogger.debug(`Re-pushing a full replace after the language client refused applyEdit`);
|
|
1215
|
+
result = await push();
|
|
951
1216
|
if (result?.applied === false) {
|
|
952
1217
|
uriLogger.warn(`Language client rejected the full-replace retry too — client content is stale`);
|
|
953
1218
|
}
|
|
@@ -958,52 +1223,156 @@ export class ModelService<
|
|
|
958
1223
|
// ordinary shutdown. Reporting it at `error` makes routine teardown
|
|
959
1224
|
// look like it needs investigating. A genuine applyEdit failure
|
|
960
1225
|
// (client refused, request malformed) still surfaces at `error`.
|
|
961
|
-
if (
|
|
1226
|
+
if (isClientGoneError(err)) {
|
|
962
1227
|
uriLogger.debug(`applyEdit to ${LANGUAGE_CLIENT_ID} skipped: client disconnected`);
|
|
963
1228
|
} else {
|
|
964
|
-
uriLogger.error(`applyEdit to ${LANGUAGE_CLIENT_ID} failed: ${err}`);
|
|
1229
|
+
uriLogger.error(`applyEdit to ${LANGUAGE_CLIENT_ID} failed: ${describeErrorWithStack(err)}`);
|
|
965
1230
|
}
|
|
966
1231
|
}
|
|
967
1232
|
}
|
|
968
1233
|
}
|
|
969
1234
|
|
|
970
1235
|
// ============================================================
|
|
971
|
-
//
|
|
1236
|
+
// Subscriptions
|
|
972
1237
|
// ============================================================
|
|
973
1238
|
|
|
974
|
-
|
|
975
|
-
|
|
976
|
-
|
|
977
|
-
|
|
978
|
-
|
|
979
|
-
|
|
980
|
-
|
|
981
|
-
|
|
982
|
-
|
|
983
|
-
|
|
984
|
-
|
|
985
|
-
|
|
1239
|
+
onModelUpdated(listener: (event: ModelUpdatedEvent<TAst, TDiagnostic>) => void, filter: ModelPhaseFilter = {}): Disposable {
|
|
1240
|
+
const phase = filter.phase ?? DocumentState.Validated;
|
|
1241
|
+
let subscribers = this.updateSubscribers.get(phase);
|
|
1242
|
+
if (!subscribers) {
|
|
1243
|
+
const created = new Set<ModelUpdateSubscriber<TAst, TDiagnostic>>();
|
|
1244
|
+
this.updateSubscribers.set(phase, created);
|
|
1245
|
+
this.services.workspace.DocumentBuilder.onDocumentPhase(
|
|
1246
|
+
phase,
|
|
1247
|
+
labelPhaseListener(
|
|
1248
|
+
(document, cancelToken) => this.deliverUpdate(phase, created, document, cancelToken),
|
|
1249
|
+
'ModelService.onModelUpdated'
|
|
1250
|
+
)
|
|
1251
|
+
);
|
|
1252
|
+
subscribers = created;
|
|
1253
|
+
}
|
|
1254
|
+
const subscriber = { uri: this.filterUri(filter), listener };
|
|
1255
|
+
subscribers.add(subscriber);
|
|
1256
|
+
return Disposable.create(() => subscribers.delete(subscriber));
|
|
986
1257
|
}
|
|
987
1258
|
|
|
988
|
-
|
|
989
|
-
|
|
990
|
-
|
|
991
|
-
|
|
992
|
-
|
|
993
|
-
|
|
994
|
-
|
|
995
|
-
|
|
996
|
-
|
|
997
|
-
|
|
1259
|
+
onModelsBuilt(listener: (event: ModelsBuiltEvent) => void, filter: Pick<ModelPhaseFilter, 'phase'> = {}): Disposable {
|
|
1260
|
+
const phase = filter.phase ?? DocumentState.Validated;
|
|
1261
|
+
return this.services.workspace.DocumentBuilder.onBuildPhase(phase, (built, cancelToken) => {
|
|
1262
|
+
if (cancelToken.isCancellationRequested) {
|
|
1263
|
+
return;
|
|
1264
|
+
}
|
|
1265
|
+
try {
|
|
1266
|
+
listener(Object.freeze({ uris: built.map(document => this.uriPolicy.canonicalUri(document.uri.toString())), phase }));
|
|
1267
|
+
} catch (err: unknown) {
|
|
1268
|
+
this.tracer.error(`onModelsBuilt listener threw: ${describeErrorWithStack(err)}`);
|
|
1269
|
+
}
|
|
1270
|
+
});
|
|
1271
|
+
}
|
|
1272
|
+
|
|
1273
|
+
onModelSaved(listener: (event: ModelSavedEvent<TAst, TDiagnostic>) => void, filter: ModelEventFilter = {}): Disposable {
|
|
1274
|
+
const target = this.filterUri(filter);
|
|
1275
|
+
return this.services.workspace.TextDocuments.onDidSave(event => {
|
|
1276
|
+
// LangiumDocuments keys by the canonical form, the saved event by the
|
|
1277
|
+
// client-facing one.
|
|
1278
|
+
const uri = this.uriPolicy.canonicalUri(event.document.uri);
|
|
1279
|
+
if (this.matches(target, uri)) {
|
|
1280
|
+
listener({ document: this.toAstDocument(UriUtils.toUri(uri)), sourceClientId: event.clientId });
|
|
1281
|
+
}
|
|
1282
|
+
});
|
|
1283
|
+
}
|
|
1284
|
+
|
|
1285
|
+
onModelDeleted(listener: (event: ModelDeletedEvent) => void, filter: ModelEventFilter = {}): Disposable {
|
|
1286
|
+
const target = this.filterUri(filter);
|
|
1287
|
+
return this.services.workspace.DocumentBuilder.onUpdate((_changed, deleted) => {
|
|
1288
|
+
for (const deletedUri of deleted) {
|
|
1289
|
+
const uri = this.uriPolicy.canonicalUri(deletedUri.toString());
|
|
1290
|
+
if (this.matches(target, uri)) {
|
|
1291
|
+
listener(Object.freeze({ uri, sourceClientId: this.services.workspace.AstDocumentManager.attributeDeletion(uri) }));
|
|
1292
|
+
}
|
|
1293
|
+
}
|
|
1294
|
+
});
|
|
1295
|
+
}
|
|
1296
|
+
|
|
1297
|
+
onDirtyChanged(listener: (event: ModelDirtyChangedEvent) => void, filter: ModelEventFilter = {}): Disposable {
|
|
1298
|
+
const target = this.filterUri(filter);
|
|
1299
|
+
return this.services.workspace.TextDocuments.onDidChangeDirty(event => {
|
|
1300
|
+
if (this.matches(target, event.uri)) {
|
|
1301
|
+
listener(event);
|
|
1302
|
+
}
|
|
1303
|
+
});
|
|
1304
|
+
}
|
|
1305
|
+
|
|
1306
|
+
onModelReleased(listener: (event: ModelReleasedEvent) => void, filter: ModelEventFilter = {}): Disposable {
|
|
1307
|
+
const target = this.filterUri(filter);
|
|
1308
|
+
return this.services.workspace.TextDocuments.onDidReleaseDocument(event => {
|
|
1309
|
+
if (this.matches(target, event.uri)) {
|
|
1310
|
+
listener(event);
|
|
1311
|
+
}
|
|
1312
|
+
});
|
|
1313
|
+
}
|
|
1314
|
+
|
|
1315
|
+
onClientClosed(listener: () => void, filter: { readonly uri: string; readonly clientId: string }): Disposable {
|
|
1316
|
+
const target = this.uriPolicy.canonicalUri(filter.uri);
|
|
1317
|
+
return this.services.workspace.TextDocuments.onDidClose(event => {
|
|
1318
|
+
if (event.clientId === filter.clientId && this.uriPolicy.canonicalUri(event.document.uri) === target) {
|
|
1319
|
+
listener();
|
|
1320
|
+
}
|
|
1321
|
+
});
|
|
1322
|
+
}
|
|
1323
|
+
|
|
1324
|
+
protected filterUri(filter: ModelEventFilter): CanonicalUri | undefined {
|
|
1325
|
+
return filter.uri === undefined ? undefined : this.uriPolicy.canonicalUri(filter.uri);
|
|
1326
|
+
}
|
|
1327
|
+
|
|
1328
|
+
protected matches(target: CanonicalUri | undefined, uri: CanonicalUri): boolean {
|
|
1329
|
+
return target === undefined || target === uri;
|
|
998
1330
|
}
|
|
999
1331
|
|
|
1000
1332
|
/**
|
|
1001
|
-
*
|
|
1002
|
-
*
|
|
1003
|
-
*
|
|
1333
|
+
* Hand every subscriber of `phase` for `document` one event, built once, so
|
|
1334
|
+
* all of them see the same attribution. Built inside the build's listener
|
|
1335
|
+
* and handed out without an await: after one, another build can have reset
|
|
1336
|
+
* the document.
|
|
1004
1337
|
*/
|
|
1005
|
-
|
|
1006
|
-
|
|
1338
|
+
protected deliverUpdate(
|
|
1339
|
+
phase: DocumentState,
|
|
1340
|
+
subscribers: ReadonlySet<ModelUpdateSubscriber<TAst, TDiagnostic>>,
|
|
1341
|
+
document: LangiumDocument,
|
|
1342
|
+
cancelToken: CancellationToken
|
|
1343
|
+
): void {
|
|
1344
|
+
if (cancelToken.isCancellationRequested || subscribers.size === 0) {
|
|
1345
|
+
return;
|
|
1346
|
+
}
|
|
1347
|
+
const uri = this.uriPolicy.canonicalUri(document.uri.toString());
|
|
1348
|
+
const matching = [...subscribers].filter(subscriber => this.matches(subscriber.uri, uri));
|
|
1349
|
+
if (matching.length === 0) {
|
|
1350
|
+
return;
|
|
1351
|
+
}
|
|
1352
|
+
const manager = this.services.workspace.AstDocumentManager;
|
|
1353
|
+
const envelope = manager.toAstDocument(document) as AstDocument<TAst, TDiagnostic>;
|
|
1354
|
+
const event: ModelUpdatedEvent<TAst, TDiagnostic> = Object.freeze({
|
|
1355
|
+
// Copied: a validation run without a reset, of further categories,
|
|
1356
|
+
// appends to the live array.
|
|
1357
|
+
document:
|
|
1358
|
+
phase >= DocumentState.Validated
|
|
1359
|
+
? { ...envelope, ...(envelope.diagnostics && { diagnostics: [...envelope.diagnostics] }) }
|
|
1360
|
+
: (this.withoutDiagnostics(envelope) as AstDocument<TAst, TDiagnostic>),
|
|
1361
|
+
...manager.attributeUpdate(document),
|
|
1362
|
+
phase
|
|
1363
|
+
});
|
|
1364
|
+
for (const { listener } of matching) {
|
|
1365
|
+
// A write queued by an earlier listener cancels this build. Thrown,
|
|
1366
|
+
// so the builder leaves the version undelivered for those skipped.
|
|
1367
|
+
if (cancelToken.isCancellationRequested) {
|
|
1368
|
+
throw OperationCancelled;
|
|
1369
|
+
}
|
|
1370
|
+
try {
|
|
1371
|
+
listener(event);
|
|
1372
|
+
} catch (err: unknown) {
|
|
1373
|
+
this.tracer.with(uri).error(`onModelUpdated listener threw: ${describeErrorWithStack(err)}`);
|
|
1374
|
+
}
|
|
1375
|
+
}
|
|
1007
1376
|
}
|
|
1008
1377
|
|
|
1009
1378
|
// ============================================================
|
|
@@ -1021,13 +1390,13 @@ export class ModelService<
|
|
|
1021
1390
|
* Adopters whose serializer call shape differs (custom service
|
|
1022
1391
|
* names, generator-driven YAML pretty printers, etc.) override this
|
|
1023
1392
|
* method. Routes through `Serializer.serializeTransfer` because
|
|
1024
|
-
* `
|
|
1393
|
+
* a session's `update` / `save` always receive a
|
|
1025
1394
|
* transfer-model shape (cross-references as plain strings) from
|
|
1026
1395
|
* adopter callers — the AST-shape entry point is `serializeAst`.
|
|
1027
1396
|
*
|
|
1028
1397
|
* Returns {@link MaybePromise} so adopter `Serializer` overrides can be
|
|
1029
1398
|
* async (remote schema lookup, external canonical-value resolution); the
|
|
1030
|
-
* single caller ({@link modelToText}
|
|
1399
|
+
* single caller ({@link modelToText}) is already `async`,
|
|
1031
1400
|
* so a naive `await` covers both branches without extra ceremony.
|
|
1032
1401
|
*/
|
|
1033
1402
|
protected serialize(uri: string, root: TTransfer): MaybePromise<string> {
|
|
@@ -1040,22 +1409,15 @@ export class ModelService<
|
|
|
1040
1409
|
// ============================================================
|
|
1041
1410
|
|
|
1042
1411
|
/**
|
|
1043
|
-
*
|
|
1044
|
-
*
|
|
1045
|
-
*
|
|
1046
|
-
*
|
|
1047
|
-
*
|
|
1048
|
-
*
|
|
1049
|
-
* unary normalisation is just a rewrite that ignores `previous`, as
|
|
1050
|
-
* `NormalizeEmptyStringsContribution` does. The chain is empty by
|
|
1051
|
-
* default, so this is a no-op for adopters that register none.
|
|
1412
|
+
* The text a write into a document not yet built should take its trivia
|
|
1413
|
+
* from: the store's, which a write always has, since it writes only a
|
|
1414
|
+
* document its client has open. `undefined` when the store holds no text
|
|
1415
|
+
* for `uri`: a document not yet created, or a file on disk that the
|
|
1416
|
+
* workspace has not read and no client has open. The preservers then run
|
|
1417
|
+
* over empty text, as for a created document; no answer skips them.
|
|
1052
1418
|
*/
|
|
1053
|
-
protected async
|
|
1054
|
-
|
|
1055
|
-
return model;
|
|
1056
|
-
}
|
|
1057
|
-
const rewritten = await this.rewriteModel(uri, model, cancelToken);
|
|
1058
|
-
return this.serialize(uri, rewritten);
|
|
1419
|
+
protected async textToTakeTriviaFrom(uri: string, _target: URI): Promise<string | undefined> {
|
|
1420
|
+
return this.services.workspace.TextDocuments.get(uri)?.getText();
|
|
1059
1421
|
}
|
|
1060
1422
|
|
|
1061
1423
|
/**
|
|
@@ -1079,15 +1441,37 @@ export class ModelService<
|
|
|
1079
1441
|
|
|
1080
1442
|
/**
|
|
1081
1443
|
* Build an {@link AstDocument} envelope from the current
|
|
1082
|
-
* {@link LangiumDocument} state via
|
|
1083
|
-
* projection. Returns an empty envelope (built via
|
|
1444
|
+
* {@link LangiumDocument} state via `AstDocumentManager.toAstDocument`,
|
|
1445
|
+
* the projection events use too. Returns an empty envelope (built via
|
|
1084
1446
|
* {@link AstDocument.create}) when the document is absent from the
|
|
1085
|
-
* registry — adopters that prefer to throw override on their subclass.
|
|
1447
|
+
* registry — adopters that prefer to throw override on their subclass. Its
|
|
1448
|
+
* version is {@link UNRECORDED_VERSION}, so a write based on it conflicts.
|
|
1086
1449
|
*/
|
|
1087
1450
|
protected toAstDocument(uri: URI): AstDocument<TAst, TDiagnostic> {
|
|
1088
1451
|
const document = this.services.workspace.LangiumDocuments.getDocument(uri);
|
|
1089
1452
|
return document
|
|
1090
|
-
? AstDocument
|
|
1091
|
-
: AstDocument.create<TAst, TDiagnostic>(uri.toString(),
|
|
1453
|
+
? (this.services.workspace.AstDocumentManager.toAstDocument(document) as AstDocument<TAst, TDiagnostic>)
|
|
1454
|
+
: AstDocument.create<TAst, TDiagnostic>(uri.toString(), UNRECORDED_VERSION, undefined as unknown as TAst);
|
|
1455
|
+
}
|
|
1456
|
+
|
|
1457
|
+
/**
|
|
1458
|
+
* The same envelope with no diagnostics, for a read that names a phase below
|
|
1459
|
+
* `Validated`. Absent rather than `[]`, which says the document was validated
|
|
1460
|
+
* and found clean.
|
|
1461
|
+
*
|
|
1462
|
+
* Langium fills `LangiumDocument.diagnostics` from inside `validateDocument`
|
|
1463
|
+
* and from nowhere else, so below that phase the array holds whatever an
|
|
1464
|
+
* EARLIER build left — a verdict about text the document may no longer have.
|
|
1465
|
+
* The wait underneath resolves at or above the phase asked for, so a document
|
|
1466
|
+
* something else carried past `Validated` would otherwise hand a full array
|
|
1467
|
+
* back from `parsed()`.
|
|
1468
|
+
*
|
|
1469
|
+
* A copy rather than a clear: the envelope is freshly built here, but
|
|
1470
|
+
* {@link toAstDocument} is overridable and an adopter's version may return
|
|
1471
|
+
* one it also keeps.
|
|
1472
|
+
*/
|
|
1473
|
+
protected withoutDiagnostics(document: AstDocument<TAst, TDiagnostic>): AstDocument<TAst, never> {
|
|
1474
|
+
const { diagnostics: _diagnostics, ...rest } = document;
|
|
1475
|
+
return rest;
|
|
1092
1476
|
}
|
|
1093
1477
|
}
|