@hydranium/core 1.0.0-next.36 → 1.0.0-next.360
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 +266 -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 +141 -0
- package/lib/langium/diagnostics/console-tee.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 -46
- 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 +34 -2
- package/lib/langium/document-builder/build-pipeline-integration.d.ts.map +1 -1
- package/lib/langium/document-builder/build-pipeline-integration.js +44 -31
- 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 +310 -41
- package/lib/langium/document-builder/document-builder.d.ts.map +1 -1
- package/lib/langium/document-builder/document-builder.js +490 -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/containment.d.ts +3 -2
- package/lib/langium/keys/containment.d.ts.map +1 -1
- package/lib/langium/keys/containment.js.map +1 -1
- package/lib/langium/keys/name-based-key-provider.d.ts +17 -10
- package/lib/langium/keys/name-based-key-provider.d.ts.map +1 -1
- package/lib/langium/keys/name-based-key-provider.js +24 -12
- 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 +21 -5
- 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 +476 -300
- package/lib/langium/model-service/model-service.d.ts.map +1 -1
- package/lib/langium/model-service/model-service.js +602 -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 +40 -14
- package/lib/langium/residency/cst-residency-service.d.ts.map +1 -1
- package/lib/langium/residency/cst-residency-service.js +27 -58
- package/lib/langium/residency/cst-residency-service.js.map +1 -1
- package/lib/langium/scope/ast-node-description-provider.d.ts +46 -10
- package/lib/langium/scope/ast-node-description-provider.d.ts.map +1 -1
- package/lib/langium/scope/ast-node-description-provider.js +88 -15
- package/lib/langium/scope/ast-node-description-provider.js.map +1 -1
- package/lib/langium/scope/built-local-symbols.d.ts +12 -0
- package/lib/langium/scope/built-local-symbols.d.ts.map +1 -0
- package/lib/langium/scope/built-local-symbols.js +11 -0
- package/lib/langium/scope/built-local-symbols.js.map +1 -0
- 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 +122 -32
- package/lib/langium/scope/hydranium-scope-provider.d.ts.map +1 -1
- package/lib/langium/scope/hydranium-scope-provider.js +217 -39
- 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 +69 -37
- package/lib/langium/scope/scope-extension-service.d.ts.map +1 -1
- package/lib/langium/scope/scope-extension-service.js +102 -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 +12 -0
- package/lib/langium/serialization/yaml-serializer.d.ts.map +1 -1
- package/lib/langium/serialization/yaml-serializer.js +24 -4
- 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/ast-node-locator.d.ts +24 -0
- package/lib/langium/workspace/ast-node-locator.d.ts.map +1 -0
- package/lib/langium/workspace/ast-node-locator.js +32 -0
- package/lib/langium/workspace/ast-node-locator.js.map +1 -0
- 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 +2 -0
- package/lib/langium/workspace/index.d.ts.map +1 -1
- package/lib/langium/workspace/index.js +2 -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 +479 -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 +150 -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 -45
- package/src/langium/document-builder/build-pipeline-integration.ts +71 -33
- package/src/langium/document-builder/build-session.ts +4 -3
- package/src/langium/document-builder/document-builder.ts +615 -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/keys/containment.ts +3 -2
- package/src/langium/keys/name-based-key-provider.ts +24 -12
- package/src/langium/language-module.ts +52 -9
- package/src/langium/model-service/client-session.ts +726 -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 +929 -493
- 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 +59 -19
- package/src/langium/scope/ast-node-description-provider.ts +111 -16
- package/src/langium/scope/built-local-symbols.ts +13 -0
- 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 +245 -41
- 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 +148 -56
- 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 +26 -4
- 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/ast-node-locator.ts +33 -0
- 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 +2 -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 +138 -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,80 @@ class SaveSettleTimeoutError extends Error {}
|
|
|
70
85
|
*/
|
|
71
86
|
export interface ModelServiceOptions extends LogNameOptions {
|
|
72
87
|
/**
|
|
73
|
-
*
|
|
74
|
-
*
|
|
75
|
-
*
|
|
76
|
-
* `
|
|
77
|
-
*
|
|
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`.
|
|
92
|
+
*
|
|
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.
|
|
78
101
|
*
|
|
79
|
-
*
|
|
80
|
-
*
|
|
81
|
-
* instead override {@link ModelService.update} on their subclass and
|
|
82
|
-
* race the parent call against their own deadline.
|
|
102
|
+
* A session's delete is refused that way on either value, since its builds
|
|
103
|
+
* always take the lock.
|
|
83
104
|
*
|
|
84
|
-
*
|
|
85
|
-
*
|
|
86
|
-
*
|
|
87
|
-
*
|
|
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.
|
|
88
112
|
*
|
|
89
|
-
* Accepts a {@link MaybeObservableValue} so
|
|
90
|
-
*
|
|
91
|
-
* and retuned live. Leaving it unset disables the warn line entirely
|
|
92
|
-
* (and skips the per-update stopwatch).
|
|
113
|
+
* Accepts a {@link MaybeObservableValue} so it can be bound to a setting and
|
|
114
|
+
* flipped without a restart.
|
|
93
115
|
*/
|
|
94
|
-
readonly
|
|
116
|
+
readonly allowReentrantBuilds?: MaybeObservableValue<boolean>;
|
|
95
117
|
/**
|
|
96
|
-
*
|
|
97
|
-
*
|
|
98
|
-
*
|
|
99
|
-
*
|
|
100
|
-
* **Why it defaults on.** Unlocked, the facade's build races the LSP bridge's
|
|
101
|
-
* build of the same URI — both are legitimate (the bridge exists only under a
|
|
102
|
-
* `Connection`, so the facade stands in for it headless), but nothing
|
|
103
|
-
* serialises them, so both run a full validation pass and Langium appends the
|
|
104
|
-
* second onto the first. Every diagnostic is then duplicated, and the
|
|
105
|
-
* duplication compounds per rebuild. Serialised, Langium elides the second
|
|
106
|
-
* build entirely, so the redundant work goes too.
|
|
107
|
-
*
|
|
108
|
-
* **What `false` costs.** The facade's build is then unserialised and can run
|
|
109
|
-
* concurrently with the bridge's build of the same URI, so the affected
|
|
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.
|
|
118
|
+
* Let a structured write keep the text the document's root was parsed from
|
|
119
|
+
* when that text serializes to the same text as the written model, so an
|
|
120
|
+
* update that changes nothing in the model leaves hand formatting alone.
|
|
121
|
+
* Default `false`: every structured write applies the canonical text.
|
|
115
122
|
*
|
|
116
|
-
*
|
|
117
|
-
*
|
|
118
|
-
*
|
|
119
|
-
*
|
|
120
|
-
* acquisition then waits for that holder to release while the holder waits
|
|
121
|
-
* for this call. On `true` that shape is DETECTED and rejected with
|
|
122
|
-
* {@link ReentrantWriteLockError} rather than hanging, wherever a host
|
|
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.
|
|
123
|
+
* Costs a parse, an encode and a serialization per write whose text
|
|
124
|
+
* differs; remembering the text last written instead would not cover a
|
|
125
|
+
* file formatted outside the framework. Text with lexer or parser errors is
|
|
126
|
+
* replaced as usual.
|
|
128
127
|
*
|
|
129
|
-
* Accepts a {@link MaybeObservableValue} so it can be bound to a setting
|
|
130
|
-
|
|
128
|
+
* Accepts a {@link MaybeObservableValue} so it can be bound to a setting.
|
|
129
|
+
*/
|
|
130
|
+
readonly keepUnchangedText?: MaybeObservableValue<boolean>;
|
|
131
|
+
}
|
|
132
|
+
|
|
133
|
+
/** One {@link ModelService.onModelUpdated} subscription; `uri` is canonical, absent for every document. */
|
|
134
|
+
export interface ModelUpdateSubscriber<TAst extends AstNode, TDiagnostic extends AstDiagnostic = AstDiagnostic> {
|
|
135
|
+
readonly uri?: CanonicalUri;
|
|
136
|
+
readonly listener: (event: ModelUpdatedEvent<TAst, TDiagnostic>) => void;
|
|
137
|
+
}
|
|
138
|
+
|
|
139
|
+
/** Options for a {@link DefaultModelService} wait on one document. */
|
|
140
|
+
export interface SyncedWaitOptions {
|
|
141
|
+
/**
|
|
142
|
+
* Build a root parsed from text older than the store's at the call, and
|
|
143
|
+
* reject once that build, or one the builder re-queues, is given up. Without
|
|
144
|
+
* it, such a root is left to other builds, and a wait they never end stays
|
|
145
|
+
* pending until its token is cancelled.
|
|
131
146
|
*/
|
|
132
|
-
readonly
|
|
147
|
+
readonly sync?: boolean;
|
|
133
148
|
}
|
|
134
149
|
|
|
135
150
|
/**
|
|
151
|
+
* The seam every non-LSP head talks to: the data server, the GLSP head and an
|
|
152
|
+
* adopter's own services reach documents through this slot rather than through
|
|
153
|
+
* the workspace stores.
|
|
154
|
+
*
|
|
136
155
|
* In-process facade over the framework's document plumbing
|
|
137
156
|
* (`HydraniumTextDocuments`, `LangiumDocuments`,
|
|
138
|
-
* `DocumentBuilder`, `WritableFileSystemProvider`). Owns the
|
|
139
|
-
*
|
|
140
|
-
*
|
|
141
|
-
* doesn't have to be re-implemented per
|
|
157
|
+
* `DocumentBuilder`, `WritableFileSystemProvider`). Owns the document
|
|
158
|
+
* lifecycle the data-server and GLSP heads delegate to — client sessions that
|
|
159
|
+
* open, update, save and close documents, the phase reads, and `ready` — so
|
|
160
|
+
* coordinating those primitives doesn't have to be re-implemented per head.
|
|
161
|
+
* Every open and write goes through a session from {@link createSession}.
|
|
142
162
|
*
|
|
143
163
|
* "Model" here means the parsed AST — distinct from the wire-shape
|
|
144
164
|
* `TransferDocument` in `@hydranium/protocol`.
|
|
@@ -148,9 +168,9 @@ export interface ModelServiceOptions extends LogNameOptions {
|
|
|
148
168
|
* Multiple in-process consumers want the same workspace-level
|
|
149
169
|
* operations:
|
|
150
170
|
* - The data-server head turns these into typed RPC methods.
|
|
151
|
-
* - The GLSP head uses the same lifecycle for diagram-driven edits
|
|
152
|
-
*
|
|
153
|
-
*
|
|
171
|
+
* - The GLSP head uses the same lifecycle for diagram-driven edits: GModel
|
|
172
|
+
* operation handlers write through the diagram's session and wait on phases
|
|
173
|
+
* before reading.
|
|
154
174
|
* - Server-internal callers (integrity service, ad-hoc bridges, tests)
|
|
155
175
|
* want the same operations without the wire serialisation step.
|
|
156
176
|
*
|
|
@@ -163,15 +183,16 @@ export interface ModelServiceOptions extends LogNameOptions {
|
|
|
163
183
|
*
|
|
164
184
|
* **Read-latest supersession**
|
|
165
185
|
*
|
|
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
|
-
*
|
|
186
|
+
* A session's default `update` and `save` use Langium's per-URI
|
|
187
|
+
* `DocumentBuilder.waitUntil` to wait for `Validated` (the integrity-settled
|
|
188
|
+
* landmark {@link IntegrityService.SettledState} when rebuilds do not
|
|
189
|
+
* validate), then read the post-build state. Concurrent in-process callers
|
|
190
|
+
* on the same URI all see the latest post-build snapshot — none deadlock
|
|
191
|
+
* waiting for a specific version's settled event. Adopters wanting strict
|
|
192
|
+
* version-matched semantics (resolve with vN's snapshot specifically, log
|
|
193
|
+
* "vN superseded by vM at vN+1") override
|
|
194
|
+
* `DefaultClientSession.updateDocument` to attach a phase-listener with
|
|
195
|
+
* explicit version checks; the framework default doesn't need it for safety.
|
|
175
196
|
*
|
|
176
197
|
* **Returns AST snapshots, not wire envelopes**
|
|
177
198
|
*
|
|
@@ -184,27 +205,196 @@ export interface ModelServiceOptions extends LogNameOptions {
|
|
|
184
205
|
* the injected `TransferEncoder` — symmetric with the
|
|
185
206
|
* `getModelDocument` envelope path.
|
|
186
207
|
*
|
|
187
|
-
* **Subscriptions** (
|
|
188
|
-
*
|
|
189
|
-
* `
|
|
190
|
-
*
|
|
191
|
-
*
|
|
192
|
-
*
|
|
208
|
+
* **Subscriptions** (`on*`) are how a head follows documents; it subscribes
|
|
209
|
+
* here rather than to the builder or the text store. Each takes a filter, and
|
|
210
|
+
* one without a `uri` hears every document.
|
|
211
|
+
*
|
|
212
|
+
* **Two families.** `waitFor*` only waits: it rejects for a URI with no
|
|
213
|
+
* document, and for a root behind the store's text it waits for whatever
|
|
214
|
+
* builds it next, so it never ends if nothing does. `ensureDocumentState` and
|
|
215
|
+
* the phase shorthands over it build a missing document, and build a root
|
|
216
|
+
* behind its text, rejecting when that build fails twice. Both re-queue a
|
|
217
|
+
* document the builder's last build left short of the state.
|
|
218
|
+
*
|
|
219
|
+
* Both resolve at the state with a root parsed from text no older than the
|
|
220
|
+
* store's version at the call; inside the write lock, at the state alone, since
|
|
221
|
+
* the build that would sync the document to that version cannot start until
|
|
222
|
+
* it is released.
|
|
223
|
+
*
|
|
224
|
+
* Do not await one inside a build phase listener: a browser host installs no
|
|
225
|
+
* write-lock scope, so the wait cannot tell it is inside a build and waits for
|
|
226
|
+
* one that cannot start. Nor inside a `WorkspaceLock.read`: the lock starts no
|
|
227
|
+
* write, the build included, while a read runs.
|
|
228
|
+
*
|
|
229
|
+
* **Diagnostics are typed `never` below `Validated`.** Validation is the last
|
|
230
|
+
* phase, so at any earlier landmark the array either is not yet computed or
|
|
231
|
+
* still holds the previous build's, and reading it would take stale results
|
|
232
|
+
* for fresh ones. A caller that needs diagnostics asks for {@link validated}.
|
|
233
|
+
*
|
|
234
|
+
* What the `never` buys, exactly: reading a field off an element is a compile
|
|
235
|
+
* error, and nothing can be appended. It does NOT stop a caller assigning an
|
|
236
|
+
* element to a typed variable, because `never` is assignable to everything — so
|
|
237
|
+
* this is a guard against reaching for diagnostics by accident, not a seal
|
|
238
|
+
* against doing it deliberately.
|
|
239
|
+
*
|
|
240
|
+
* The waits resolve at or ABOVE their target, so an already-validated document
|
|
241
|
+
* does carry usable diagnostics and the `never` over-forbids there. That
|
|
242
|
+
* direction is the safe one: the alternative permits stale reads silently. A
|
|
243
|
+
* member taking a phase as a PARAMETER returns `TDiagnostic`, and leaves them
|
|
244
|
+
* absent for a phase below `Validated`.
|
|
193
245
|
*
|
|
194
246
|
* **Generic parameters.**
|
|
195
247
|
* - `TAst` — the AST root type each consumer expects on the returned
|
|
196
248
|
* {@link AstDocument}. Constrained to {@link AstNode}.
|
|
197
|
-
* - `TDiagnostic` —
|
|
198
|
-
* `
|
|
199
|
-
*
|
|
249
|
+
* - `TDiagnostic` — the AST-layer diagnostic: whatever the build left on
|
|
250
|
+
* `LangiumDocument.diagnostics`, carried through on the returned
|
|
251
|
+
* {@link AstDocument}. Defaults to {@link AstDiagnostic}.
|
|
252
|
+
* **Not the `TransferEncoder`'s parameter of the same name**, which is
|
|
253
|
+
* that encoder's OUTPUT and so names the wire shape. This one names its
|
|
254
|
+
* input, and an adopter binds the two to different types.
|
|
255
|
+
* - `TTransfer` — transfer-model root a session's `update` / `save` accept
|
|
200
256
|
* args. Constrained to {@link TransferElement}. Defaults to the
|
|
201
257
|
* structural base.
|
|
202
258
|
*/
|
|
203
|
-
export
|
|
259
|
+
export interface ModelService<
|
|
204
260
|
TAst extends AstNode,
|
|
205
|
-
TDiagnostic =
|
|
261
|
+
TDiagnostic extends AstDiagnostic = AstDiagnostic,
|
|
262
|
+
TTransfer extends TransferElement = TransferElement
|
|
263
|
+
> {
|
|
264
|
+
/**
|
|
265
|
+
* Resolves once the workspace has been initialised and its first build has
|
|
266
|
+
* completed — the gate every read should wait behind, since a document
|
|
267
|
+
* queried before it may be unbuilt and reach no phase.
|
|
268
|
+
*
|
|
269
|
+
* A property rather than a method, matching `ProjectManager.ready` and
|
|
270
|
+
* Langium's `WorkspaceManager.ready`. An implementation needing a stricter
|
|
271
|
+
* gate supplies a Promise that awaits its own concern as well.
|
|
272
|
+
*/
|
|
273
|
+
readonly ready: Promise<void>;
|
|
274
|
+
|
|
275
|
+
// Wait only; a root behind its text is left to another build.
|
|
276
|
+
waitForDocumentState(uri: string, state: DocumentState, cancelToken?: CancellationToken): Promise<AstDocument<TAst, TDiagnostic>>;
|
|
277
|
+
waitForDocumentSettled(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>>;
|
|
278
|
+
waitForBuilderState(state: DocumentState, cancelToken?: CancellationToken): Promise<void>;
|
|
279
|
+
|
|
280
|
+
// Build what is missing or behind its text, then wait.
|
|
281
|
+
ensureDocumentState(uri: string, state?: DocumentState, cancelToken?: CancellationToken): Promise<AstDocument<TAst, TDiagnostic>>;
|
|
282
|
+
rebuild(uri: string, state?: DocumentState, cancelToken?: CancellationToken): Promise<AstDocument<TAst, TDiagnostic>>;
|
|
206
283
|
/**
|
|
207
|
-
*
|
|
284
|
+
* Throw where {@link rebuild} would reject as reentrant. A write calls it
|
|
285
|
+
* before applying its text: a text applied and then refused stays applied
|
|
286
|
+
* with no build to follow it.
|
|
287
|
+
*/
|
|
288
|
+
assertCanBuild(uri: string): void;
|
|
289
|
+
parsed(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>>;
|
|
290
|
+
linked(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>>;
|
|
291
|
+
settled(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>>;
|
|
292
|
+
indexed(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>>;
|
|
293
|
+
validated(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, TDiagnostic>>;
|
|
294
|
+
|
|
295
|
+
isOpen(uri: string): boolean;
|
|
296
|
+
/**
|
|
297
|
+
* The version the document at `uri` was opened at, which a client's write
|
|
298
|
+
* or an integrity repair steps past; `undefined` while it is not open.
|
|
299
|
+
*/
|
|
300
|
+
openedVersion(uri: string): TextVersion | undefined;
|
|
301
|
+
snapshot(uri: string): AstDocument<TAst, TDiagnostic> | undefined;
|
|
302
|
+
/**
|
|
303
|
+
* The text a session's write of `model` to `uri` applies: a textual model
|
|
304
|
+
* as given, a structured one rewritten and serialised. Also the text to
|
|
305
|
+
* create a document with: for a `uri` with no text the trivia preservers
|
|
306
|
+
* still run, so it gets their defaults, such as
|
|
307
|
+
* `DocumentEndingPreserver.DEFAULT_ENDING`. With
|
|
308
|
+
* {@link ModelServiceOptions.keepUnchangedText} set, a model equal to the
|
|
309
|
+
* document's gives the text its root was parsed from instead.
|
|
310
|
+
*/
|
|
311
|
+
modelToText(uri: string, model: TTransfer | string, cancelToken?: CancellationToken): Promise<string>;
|
|
312
|
+
getDocument(uri: string): LangiumDocument | undefined;
|
|
313
|
+
/**
|
|
314
|
+
* Resolve once the document's build has settled and the language client
|
|
315
|
+
* has answered the push of its text, applied or refused and logged, so a
|
|
316
|
+
* save answering after it does not race that push. Does not wait again for
|
|
317
|
+
* a push an earlier settle timed out on and the client has not answered
|
|
318
|
+
* since. Never rejects: past its bound it warns and resolves, and a failed
|
|
319
|
+
* wait is logged and resolves.
|
|
320
|
+
*/
|
|
321
|
+
settleLanguageClient(uri: string, cancelToken?: CancellationToken): Promise<void>;
|
|
322
|
+
/**
|
|
323
|
+
* Whether a push of the document's text into the language client awaits the
|
|
324
|
+
* client's answer. A push a settle already timed out on does not count: that
|
|
325
|
+
* settle has warned about it.
|
|
326
|
+
*/
|
|
327
|
+
isLanguageClientPushPending(uri: string): boolean;
|
|
328
|
+
|
|
329
|
+
/**
|
|
330
|
+
* Fires as a document reaches the filter's phase, `Validated` by default.
|
|
331
|
+
* Listeners run inside the build, so one that throws is logged and the
|
|
332
|
+
* others still run.
|
|
333
|
+
*/
|
|
334
|
+
onModelUpdated(listener: (event: ModelUpdatedEvent<TAst, TDiagnostic>) => void, filter?: ModelPhaseFilter): Disposable;
|
|
335
|
+
/**
|
|
336
|
+
* Fires once per build that reaches the phase, with every document it
|
|
337
|
+
* carried there. A listener that throws is logged, as for {@link onModelUpdated}.
|
|
338
|
+
*/
|
|
339
|
+
onModelsBuilt(listener: (event: ModelsBuiltEvent) => void, filter?: Pick<ModelPhaseFilter, 'phase'>): Disposable;
|
|
340
|
+
/**
|
|
341
|
+
* Fires for every save, whichever client made it, as the store announces
|
|
342
|
+
* it. A document saved before its first build arrives as an empty envelope
|
|
343
|
+
* at `UNRECORDED_VERSION`, whose `root` is `undefined` despite its type.
|
|
344
|
+
*/
|
|
345
|
+
onModelSaved(listener: (event: ModelSavedEvent<TAst, TDiagnostic>) => void, filter?: ModelEventFilter): Disposable;
|
|
346
|
+
/**
|
|
347
|
+
* Fires for every document a build removes, with the session whose
|
|
348
|
+
* `delete` removed it, as `AstDocumentManager.attributeDeletion` names it.
|
|
349
|
+
*/
|
|
350
|
+
onModelDeleted(listener: (event: ModelDeletedEvent) => void, filter?: ModelEventFilter): Disposable;
|
|
351
|
+
/** Fires when a document's text starts or stops differing from its file. */
|
|
352
|
+
onDirtyChanged(listener: (event: ModelDirtyChangedEvent) => void, filter?: ModelEventFilter): Disposable;
|
|
353
|
+
/**
|
|
354
|
+
* Fires when the store releases a document no client has open any more.
|
|
355
|
+
* What the build keeps for it is up to the
|
|
356
|
+
* `DocumentReleaseHandler` slot; the default reverts it to disk, and that
|
|
357
|
+
* rebuild follows as an {@link onModelUpdated} event, unless a client opens
|
|
358
|
+
* the document first or its file is deleted.
|
|
359
|
+
*/
|
|
360
|
+
onModelReleased(listener: (event: ModelReleasedEvent) => void, filter?: ModelEventFilter): Disposable;
|
|
361
|
+
/** Fires when `filter.clientId` closes `filter.uri`, its session ending included. */
|
|
362
|
+
onClientClosed(listener: () => void, filter: { readonly uri: string; readonly clientId: string }): Disposable;
|
|
363
|
+
|
|
364
|
+
/**
|
|
365
|
+
* Start a client session, the only way to open and write documents through
|
|
366
|
+
* this service. Pass a `label` naming the participant; without one it is
|
|
367
|
+
* `session`. The id defaults to `label#` plus a random UUID; a fixed
|
|
368
|
+
* `clientId` is taken as given. Throws `ReservedClientIdError` when the id
|
|
369
|
+
* is reserved by the framework, and `DuplicateClientIdError` when it is
|
|
370
|
+
* held by another live session or has documents open under it as a client
|
|
371
|
+
* that is not a session.
|
|
372
|
+
*
|
|
373
|
+
* A `resumeToken` matching the one the live session under `clientId` was
|
|
374
|
+
* started with ends that session as lost first, so the documents it was
|
|
375
|
+
* last to hold keep their unsaved text for the new one. The token guards
|
|
376
|
+
* against taking over a session by accident, not against a peer: anyone who
|
|
377
|
+
* knows it can end the session.
|
|
378
|
+
*
|
|
379
|
+
* `TOpenOptions` types the options the session's `open` takes and its
|
|
380
|
+
* `openOptions` returns. The narrowing is an unchecked cast, and it holds
|
|
381
|
+
* only for the caller that started the session: a holder reached through
|
|
382
|
+
* {@link getSession} sees plain `OpenOptions`.
|
|
383
|
+
*/
|
|
384
|
+
createSession<TOpenOptions extends OpenOptions = OpenOptions>(
|
|
385
|
+
label?: string,
|
|
386
|
+
clientId?: string,
|
|
387
|
+
options?: { readonly resumeToken?: string }
|
|
388
|
+
): ClientSession<TAst, TDiagnostic, TTransfer, TOpenOptions>;
|
|
389
|
+
/** The live session started under `clientId`, or `undefined` once it has ended or was never started. */
|
|
390
|
+
getSession(clientId: string): ClientSession<TAst, TDiagnostic, TTransfer> | undefined;
|
|
391
|
+
}
|
|
392
|
+
|
|
393
|
+
export class DefaultModelService<
|
|
394
|
+
TAst extends AstNode,
|
|
395
|
+
TDiagnostic extends AstDiagnostic = AstDiagnostic,
|
|
396
|
+
/**
|
|
397
|
+
* Structured payload a session's `update` / `save` accept. Constrained to
|
|
208
398
|
* {@link TransferElement} — the minimal `{ readonly $type: string }`
|
|
209
399
|
* shape. Both transfer-model overlay roots (which extend
|
|
210
400
|
* `TransferElement` explicitly) and AST root types (which have
|
|
@@ -213,7 +403,7 @@ export class ModelService<
|
|
|
213
403
|
* integrity service) that pass AST roots remain compatible.
|
|
214
404
|
*/
|
|
215
405
|
TTransfer extends TransferElement = TransferElement
|
|
216
|
-
> {
|
|
406
|
+
> implements ModelService<TAst, TDiagnostic, TTransfer> {
|
|
217
407
|
protected readonly tracer: Tracer;
|
|
218
408
|
/**
|
|
219
409
|
* The single document-identity seam (`services.workspace.DocumentUriPolicy`),
|
|
@@ -224,14 +414,10 @@ export class ModelService<
|
|
|
224
414
|
* (see {@link DocumentUriPolicy}).
|
|
225
415
|
*/
|
|
226
416
|
protected readonly uriPolicy: DocumentUriPolicy;
|
|
227
|
-
/**
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
*/
|
|
232
|
-
protected readonly slowUpdateWarn?: ObservableValue<number>;
|
|
233
|
-
/** See {@link ModelServiceOptions.serializeBuilds}. Defaults to `true`. */
|
|
234
|
-
protected readonly serializeBuilds: ObservableValue<boolean>;
|
|
417
|
+
/** See {@link ModelServiceOptions.allowReentrantBuilds}. Defaults to `false`. */
|
|
418
|
+
protected readonly allowReentrantBuilds: ObservableValue<boolean>;
|
|
419
|
+
/** See {@link ModelServiceOptions.keepUnchangedText}. Defaults to `false`. */
|
|
420
|
+
protected readonly keepUnchangedText: ObservableValue<boolean>;
|
|
235
421
|
|
|
236
422
|
/**
|
|
237
423
|
* Per-URI applyEdit coalescing: at most one in-flight `applyEditToLanguageClient`
|
|
@@ -241,6 +427,30 @@ export class ModelService<
|
|
|
241
427
|
*/
|
|
242
428
|
protected readonly syncChains = new Map<string, Promise<void>>();
|
|
243
429
|
protected readonly pendingSync = new Map<string, string>();
|
|
430
|
+
/**
|
|
431
|
+
* The sync chains a settle timed out on, until the client answers their
|
|
432
|
+
* push. A later settle does not wait on one meanwhile: GLSP runs a diagram's
|
|
433
|
+
* saves one at a time, so each would add the full bound and a queued save
|
|
434
|
+
* outlast its client's timeout.
|
|
435
|
+
*/
|
|
436
|
+
protected readonly timedOutSyncChains = new WeakSet<Promise<void>>();
|
|
437
|
+
|
|
438
|
+
/** The live sessions this service started, by client id, for {@link getSession}. */
|
|
439
|
+
protected readonly sessions = new Map<string, ClientSession<TAst, TDiagnostic, TTransfer>>();
|
|
440
|
+
/**
|
|
441
|
+
* Drops an ended session from {@link sessions}. Subscribed by the first
|
|
442
|
+
* {@link createSession} rather than at construction, so a services tree with
|
|
443
|
+
* no text store, or one that knows nothing of sessions, still constructs
|
|
444
|
+
* this service.
|
|
445
|
+
*/
|
|
446
|
+
protected sessionCloseListener?: Disposable;
|
|
447
|
+
/** The token each live session was started with, by client id, for a takeover by {@link createSession}. */
|
|
448
|
+
protected readonly resumeTokens = new Map<string, string>();
|
|
449
|
+
/**
|
|
450
|
+
* The {@link onModelUpdated} subscribers, by phase. One builder listener per
|
|
451
|
+
* phase serves them all, kept for the life of the service.
|
|
452
|
+
*/
|
|
453
|
+
protected readonly updateSubscribers = new Map<DocumentState, Set<ModelUpdateSubscriber<TAst, TDiagnostic>>>();
|
|
244
454
|
|
|
245
455
|
/**
|
|
246
456
|
* Workspace-level readiness gate. Resolves when the framework has
|
|
@@ -282,30 +492,27 @@ export class ModelService<
|
|
|
282
492
|
) {
|
|
283
493
|
this.tracer = services.Tracer.for(options.logName ?? 'ModelService').trace('instantiated');
|
|
284
494
|
this.uriPolicy = services.workspace.DocumentUriPolicy;
|
|
285
|
-
this.
|
|
286
|
-
this.
|
|
495
|
+
this.allowReentrantBuilds = ObservableValue.from(options.allowReentrantBuilds ?? false);
|
|
496
|
+
this.keepUnchangedText = ObservableValue.from(options.keepUnchangedText ?? false);
|
|
287
497
|
// Optional-chain so a harness that binds no WorkspaceManager awaits
|
|
288
498
|
// `undefined` and resolves immediately; production hosts always have it
|
|
289
499
|
// bound.
|
|
290
500
|
// Deliberately NO fallback to Langium's `ready`: it resolves pre-build,
|
|
291
501
|
// so falling back to it would silently reinstate the very gap this gate
|
|
292
502
|
// 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
503
|
this.ready = (async () => {
|
|
297
504
|
try {
|
|
298
505
|
await services.workspace.WorkspaceManager?.workspaceInitialized;
|
|
299
|
-
} catch
|
|
506
|
+
} catch {
|
|
300
507
|
// NEVER rejects, deliberately. This gate is about TIMING — "the
|
|
301
508
|
// 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
|
-
|
|
509
|
+
// the workspace manager's `ready` (what it replaced) rejects only on
|
|
510
|
+
// a failed startup. `workspaceInitialized` also rejects on a
|
|
511
|
+
// cancelled initial build (routine — any write preempts one) and on
|
|
512
|
+
// a failed one (e.g. a disposed connection at teardown).
|
|
513
|
+
// Propagating either would fail every `waitForReady` for the rest
|
|
514
|
+
// of the process lifetime, a far worse failure than the late gate
|
|
515
|
+
// this exists to fix. The workspace manager logs the outcome.
|
|
309
516
|
}
|
|
310
517
|
})();
|
|
311
518
|
// One persistent listener mirroring non-LSP-client changes back to the LSP
|
|
@@ -327,10 +534,12 @@ export class ModelService<
|
|
|
327
534
|
// ============================================================
|
|
328
535
|
|
|
329
536
|
/**
|
|
330
|
-
* Wait for the document at `uri` to reach `state
|
|
331
|
-
*
|
|
332
|
-
*
|
|
333
|
-
*
|
|
537
|
+
* Wait for the document at `uri` to reach `state` with a root no older than
|
|
538
|
+
* the store's text at the call. Rejects if `uri` is not in the document
|
|
539
|
+
* registry. A root behind its text is not built: the wait lasts until
|
|
540
|
+
* something else builds it, so use {@link ensureDocumentState} where
|
|
541
|
+
* nothing may. Builds that keep failing leave the wait pending, to its
|
|
542
|
+
* cancellation token.
|
|
334
543
|
*
|
|
335
544
|
* Wrapped in a debug-level timing log via {@link Tracer.time} so
|
|
336
545
|
* slow per-URI waits surface in build telemetry; the URI is
|
|
@@ -344,11 +553,12 @@ export class ModelService<
|
|
|
344
553
|
* Wait for the document at `uri` to reach the integrity-settled landmark
|
|
345
554
|
* ({@link IntegrityService.SettledState}) — the earliest phase at which the
|
|
346
555
|
* 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.
|
|
556
|
+
* {@link waitForDocumentState}, and like it builds nothing behind its text.
|
|
349
557
|
*/
|
|
350
|
-
async waitForDocumentSettled(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst,
|
|
351
|
-
return this.
|
|
558
|
+
async waitForDocumentSettled(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>> {
|
|
559
|
+
return this.withoutDiagnostics(
|
|
560
|
+
await this.waitForDocumentStateCanonical(this.uriPolicy.canonicalUri(uri), IntegrityService.SettledState, cancelToken)
|
|
561
|
+
);
|
|
352
562
|
}
|
|
353
563
|
|
|
354
564
|
/**
|
|
@@ -360,21 +570,120 @@ export class ModelService<
|
|
|
360
570
|
* the identity once instead of re-running the (filesystem-touching) `realpath`
|
|
361
571
|
* at every wait. The `CanonicalUri` parameter type enforces that — a raw
|
|
362
572
|
* `string` cannot be passed without minting through the URI policy.
|
|
573
|
+
*
|
|
574
|
+
* With `options.sync`, a root behind the store's text is built, as in
|
|
575
|
+
* {@link ensureDocumentState}; without it, the root is left to other builds,
|
|
576
|
+
* as in {@link waitForDocumentState}. Below `Validated` the envelope has no
|
|
577
|
+
* diagnostics: see {@link withoutDiagnostics}.
|
|
363
578
|
*/
|
|
364
579
|
protected async waitForDocumentStateCanonical(
|
|
365
580
|
uri: CanonicalUri,
|
|
366
581
|
state: DocumentState,
|
|
367
|
-
cancelToken?: CancellationToken
|
|
582
|
+
cancelToken?: CancellationToken,
|
|
583
|
+
options: SyncedWaitOptions = {}
|
|
368
584
|
): Promise<AstDocument<TAst, TDiagnostic>> {
|
|
369
585
|
const documentUri = UriUtils.toUri(uri);
|
|
586
|
+
// Read at call time: a later edit must not extend this wait.
|
|
587
|
+
const textVersion = isInsideWriteLock() ? undefined : this.services.workspace.TextDocuments.textState(uri)?.version;
|
|
370
588
|
await this.tracer
|
|
371
589
|
.withUri(uri)
|
|
372
590
|
.time(
|
|
373
591
|
`Wait for document state '${DocumentState[state]}'`,
|
|
374
|
-
() => this.
|
|
592
|
+
() => this.waitUntilSynced(documentUri, state, textVersion, cancelToken, options),
|
|
375
593
|
'debug'
|
|
376
594
|
);
|
|
377
|
-
|
|
595
|
+
const document = this.toAstDocument(documentUri);
|
|
596
|
+
return state >= DocumentState.Validated ? document : this.withoutDiagnostics(document);
|
|
597
|
+
}
|
|
598
|
+
|
|
599
|
+
/**
|
|
600
|
+
* Wait for `state` with a root parsed from text at `textVersion` or later. A
|
|
601
|
+
* root no factory recorded counts as synced, since no build records it.
|
|
602
|
+
* With `options.sync`, a root still behind is built through
|
|
603
|
+
* `VersionSyncService.syncTo`, and the wait rejects once that build, or one
|
|
604
|
+
* the builder re-queues to reach `state`, is given up. Without it, the wait
|
|
605
|
+
* lasts until another build parses the text, and stays pending when the
|
|
606
|
+
* builder gives up re-queuing the document.
|
|
607
|
+
*/
|
|
608
|
+
protected async waitUntilSynced(
|
|
609
|
+
uri: URI,
|
|
610
|
+
state: DocumentState,
|
|
611
|
+
textVersion: TextVersion | undefined,
|
|
612
|
+
cancelToken?: CancellationToken,
|
|
613
|
+
options: SyncedWaitOptions = {}
|
|
614
|
+
): Promise<void> {
|
|
615
|
+
const builder = this.services.workspace.DocumentBuilder;
|
|
616
|
+
const sync = this.services.workspace.VersionSyncService;
|
|
617
|
+
const waitOptions = { rejectWhenStuck: options.sync === true };
|
|
618
|
+
await builder.waitUntil(state, uri, cancelToken, waitOptions);
|
|
619
|
+
if (textVersion === undefined) {
|
|
620
|
+
return;
|
|
621
|
+
}
|
|
622
|
+
while (!sync.isSyncedTo(uri, textVersion)) {
|
|
623
|
+
const build = options.sync === true ? sync.syncTo(uri, textVersion) : undefined;
|
|
624
|
+
this.tracer
|
|
625
|
+
.withUri(uri.toString())
|
|
626
|
+
.debug(`waiting for ${uri.toString()} to reach ${DocumentState[state]} at v${textVersion} or later`);
|
|
627
|
+
await this.nextParseOrDeletion(uri, cancelToken, build);
|
|
628
|
+
await builder.waitUntil(state, uri, cancelToken, waitOptions);
|
|
629
|
+
}
|
|
630
|
+
}
|
|
631
|
+
|
|
632
|
+
/**
|
|
633
|
+
* Resolves once a parse of `uri` has been recorded or a build has deleted
|
|
634
|
+
* it, rejecting with `OperationCancelled` when `cancelToken` is cancelled
|
|
635
|
+
* first, and with an error when `build`, the build requested for it, is
|
|
636
|
+
* given up. A `Parsed` phase listener cannot serve: a cancel right after the
|
|
637
|
+
* parse skips it, and the resumed build does not parse again.
|
|
638
|
+
*/
|
|
639
|
+
protected nextParseOrDeletion(uri: URI, cancelToken: CancellationToken = CancellationToken.None, build?: Promise<void>): Promise<void> {
|
|
640
|
+
const builder = this.services.workspace.DocumentBuilder;
|
|
641
|
+
return new Promise<void>((resolve, reject) => {
|
|
642
|
+
let ended = false;
|
|
643
|
+
let cancelled = false;
|
|
644
|
+
// Handled before any return, so a build given up after the wait ended is not an unhandled rejection.
|
|
645
|
+
build?.catch((error: unknown) => {
|
|
646
|
+
const line = `The build that would sync the root to its text failed. ${describeErrorWithStack(error)}`;
|
|
647
|
+
if (cancelled) {
|
|
648
|
+
// The waiter has gone, so nothing else reports this.
|
|
649
|
+
this.tracer.withUri(uri.toString()).error(line);
|
|
650
|
+
} else if (ended) {
|
|
651
|
+
// A parse or deletion came first: the waiter goes on and reports its own outcome, and the retry warned.
|
|
652
|
+
this.tracer.withUri(uri.toString()).debug(line);
|
|
653
|
+
} else {
|
|
654
|
+
done(() => reject(new Error(`The build that would sync ${uri.toString()} to its text failed`, { cause: error })));
|
|
655
|
+
}
|
|
656
|
+
});
|
|
657
|
+
// A cancelled token's listener runs a macrotask later, after a build
|
|
658
|
+
// that started meanwhile may have parsed.
|
|
659
|
+
if (cancelToken.isCancellationRequested) {
|
|
660
|
+
ended = true;
|
|
661
|
+
cancelled = true;
|
|
662
|
+
reject(OperationCancelled);
|
|
663
|
+
return;
|
|
664
|
+
}
|
|
665
|
+
const done = (settle: () => void): void => {
|
|
666
|
+
ended = true;
|
|
667
|
+
parsed.dispose();
|
|
668
|
+
deleted.dispose();
|
|
669
|
+
cancelling.dispose();
|
|
670
|
+
settle();
|
|
671
|
+
};
|
|
672
|
+
const parsed = this.services.workspace.VersionSyncService.onDidRecordModel(document => {
|
|
673
|
+
if (UriUtils.equals(document.uri, uri)) {
|
|
674
|
+
done(resolve);
|
|
675
|
+
}
|
|
676
|
+
});
|
|
677
|
+
const deleted = builder.onUpdate((_changed, deletedUris) => {
|
|
678
|
+
if (deletedUris.some(deletedUri => UriUtils.equals(deletedUri, uri))) {
|
|
679
|
+
done(resolve);
|
|
680
|
+
}
|
|
681
|
+
});
|
|
682
|
+
const cancelling = cancelToken.onCancellationRequested(() => {
|
|
683
|
+
cancelled = true;
|
|
684
|
+
done(() => reject(OperationCancelled));
|
|
685
|
+
});
|
|
686
|
+
});
|
|
378
687
|
}
|
|
379
688
|
|
|
380
689
|
/**
|
|
@@ -398,31 +707,35 @@ export class ModelService<
|
|
|
398
707
|
* Force a fresh build of the document at `uri` and wait for it to
|
|
399
708
|
* reach `state` (or the integrity-settled landmark
|
|
400
709
|
* {@link IntegrityService.SettledState} if omitted).
|
|
401
|
-
* Always
|
|
402
|
-
*
|
|
403
|
-
* you want to re-process from scratch.
|
|
710
|
+
* Always builds the document, whether or not it is already in the
|
|
711
|
+
* registry, in a build of its own or in one already scheduled that carries
|
|
712
|
+
* it — call this when you want to re-process from scratch.
|
|
404
713
|
*
|
|
405
|
-
* The facade is responsible for
|
|
406
|
-
* directly because Langium's `DefaultDocumentUpdateHandler.didChangeContent`
|
|
714
|
+
* The facade is responsible for requesting the build itself because Langium's `DefaultDocumentUpdateHandler.didChangeContent`
|
|
407
715
|
* (the standard text-document → builder bridge) only runs under an
|
|
408
716
|
* LSP `Connection`. Running headless the bridge never fires; the
|
|
409
717
|
* facade stands in for it on its own update path.
|
|
410
718
|
*
|
|
411
719
|
* 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
|
|
720
|
+
* fine: the LSP head builds from the LSP-driven event and the facade from
|
|
721
|
+
* its own RPC-driven event — both legitimate — and both go through
|
|
722
|
+
* `HydraniumDocumentBuilder.scheduleUpdate`, which serialises them under
|
|
723
|
+
* the workspace WRITE lock and lets the second share the first's build
|
|
724
|
+
* where that build carries it. Langium alone does not coalesce concurrent
|
|
725
|
+
* builds of one URI: two unserialised builds each run a full validation
|
|
726
|
+
* pass and Langium appends the second set onto the first, duplicating every
|
|
727
|
+
* diagnostic. A caller that already holds the lock builds without it only
|
|
728
|
+
* under {@link ModelServiceOptions.allowReentrantBuilds} — see there for the
|
|
729
|
+
* non-reentrancy hazard.
|
|
422
730
|
*
|
|
423
|
-
*
|
|
424
|
-
*
|
|
425
|
-
*
|
|
731
|
+
* An override calls the base before it awaits. Under an LSP connection the
|
|
732
|
+
* store's change event has already asked the update handler to build a
|
|
733
|
+
* session's write; an override whose await outlasts that build makes the
|
|
734
|
+
* base's request start a build of its own, so the write is built and
|
|
735
|
+
* delivered twice.
|
|
736
|
+
*
|
|
737
|
+
* Rejects when the build leaves no document for `uri`, as for a URI with
|
|
738
|
+
* neither a file nor text: the wait after it has nothing to wait on.
|
|
426
739
|
*
|
|
427
740
|
* Consumers wanting "give me this doc at state X, building only if
|
|
428
741
|
* needed" — use the per-state methods ({@link parsed} / {@link linked}
|
|
@@ -434,8 +747,8 @@ export class ModelService<
|
|
|
434
747
|
|
|
435
748
|
/**
|
|
436
749
|
* Internal build core operating on an already-{@link CanonicalUri canonical}
|
|
437
|
-
* URI — the build counterpart to {@link waitForDocumentStateCanonical}.
|
|
438
|
-
*
|
|
750
|
+
* URI — the build counterpart to {@link waitForDocumentStateCanonical}.
|
|
751
|
+
* Requests the build, then waits via the canonical wait core, so the
|
|
439
752
|
* identity is resolved once at the public door and neither sink re-runs the
|
|
440
753
|
* `realpath`. (`DocumentBuilder.update` still resolves each URI internally for
|
|
441
754
|
* directory flattening — that is the build's own existence-aware resolution,
|
|
@@ -447,58 +760,45 @@ export class ModelService<
|
|
|
447
760
|
cancelToken?: CancellationToken
|
|
448
761
|
): Promise<AstDocument<TAst, TDiagnostic>> {
|
|
449
762
|
const documentUri = UriUtils.toUri(uri);
|
|
450
|
-
// Runs under the workspace WRITE lock,
|
|
451
|
-
// `
|
|
452
|
-
//
|
|
763
|
+
// Runs under the workspace WRITE lock, through the builder's
|
|
764
|
+
// `scheduleUpdate` like the LSP update handler's build, so the build the
|
|
765
|
+
// store's change event already scheduled for this write carries this
|
|
766
|
+
// request too rather than being cancelled by it.
|
|
453
767
|
//
|
|
454
768
|
// Unlocked, this build races the LSP bridge's build of the same URI: both
|
|
455
769
|
// 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
|
|
770
|
+
// facade stands in for it headless), and nothing serialises the two, so
|
|
771
|
+
// both reach `Validated`, and because each computes its missing
|
|
459
772
|
// validation categories before the other has recorded its own, both run a
|
|
460
773
|
// FULL pass and Langium appends the second onto the first (its append is
|
|
461
774
|
// meant for category-partitioned passes). The user-visible result is every
|
|
462
775
|
// diagnostic duplicated, plus double the validation work per write.
|
|
463
776
|
//
|
|
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 {
|
|
777
|
+
// A caller already inside the lock would cancel its own build and stall in
|
|
778
|
+
// the wait below; `allowReentrantBuilds` builds it unlocked, and without a
|
|
779
|
+
// tracker it cannot be told apart from any other caller.
|
|
780
|
+
if (this.allowReentrantBuilds.value && (isInsideWriteLock() || !isWriteLockScopeInstalled())) {
|
|
489
781
|
await this.services.workspace.DocumentBuilder.update([documentUri], [], cancelToken);
|
|
782
|
+
} else {
|
|
783
|
+
this.assertCanBuild(uri);
|
|
784
|
+
// The build runs on the lock's own token, which a later write cancels;
|
|
785
|
+
// the caller's token governs only the phase wait below.
|
|
786
|
+
await this.services.workspace.DocumentBuilder.scheduleUpdate([documentUri], []);
|
|
787
|
+
}
|
|
788
|
+
return this.waitForDocumentStateCanonical(uri, state ?? IntegrityService.SettledState, cancelToken, { sync: true });
|
|
789
|
+
}
|
|
790
|
+
|
|
791
|
+
assertCanBuild(uri: string): void {
|
|
792
|
+
if (isInsideWriteLock() && !this.allowReentrantBuilds.value) {
|
|
793
|
+
throw new ReentrantWriteLockError(uri);
|
|
490
794
|
}
|
|
491
|
-
return this.waitForDocumentStateCanonical(uri, state ?? IntegrityService.SettledState, cancelToken);
|
|
492
795
|
}
|
|
493
796
|
|
|
494
797
|
/**
|
|
495
798
|
* Per-state typed convenience methods. Each ensures the document at
|
|
496
799
|
* `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.
|
|
800
|
+
* the narrowest accurate diagnostics type for that phase, building as
|
|
801
|
+
* {@link ensureDocumentState} does.
|
|
502
802
|
*
|
|
503
803
|
* Phase invariants encoded in the return type:
|
|
504
804
|
* - `parsed` / `linked` / `settled` / `indexed` return
|
|
@@ -507,16 +807,13 @@ export class ModelService<
|
|
|
507
807
|
* - `validated` returns `AstDocument<TAst, TDiagnostic>` — diagnostics
|
|
508
808
|
* are populated.
|
|
509
809
|
*
|
|
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.
|
|
810
|
+
* **The `never` is enforced, not merely declared.** The wait underneath
|
|
811
|
+
* resolves at or ABOVE the requested state, so a document something else
|
|
812
|
+
* already carried past `Validated` would otherwise come back from
|
|
813
|
+
* `settled()` carrying a full diagnostics array typed `never`; these four
|
|
814
|
+
* strip it. An empty array here therefore means "this read does not report
|
|
815
|
+
* diagnostics", never "this document is clean" — call {@link validated}
|
|
816
|
+
* when the answer has to mean the second.
|
|
520
817
|
*
|
|
521
818
|
* `settled` is the integrity-overlay name for "all integrity rules
|
|
522
819
|
* have fired"; it maps to {@link IntegrityService.SettledState} (which
|
|
@@ -525,19 +822,19 @@ export class ModelService<
|
|
|
525
822
|
* ever moves.
|
|
526
823
|
*/
|
|
527
824
|
async parsed(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>> {
|
|
528
|
-
return this.ensureDocumentState(uri, DocumentState.Parsed, cancelToken)
|
|
825
|
+
return this.withoutDiagnostics(await this.ensureDocumentState(uri, DocumentState.Parsed, cancelToken));
|
|
529
826
|
}
|
|
530
827
|
|
|
531
828
|
async linked(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>> {
|
|
532
|
-
return this.ensureDocumentState(uri, DocumentState.Linked, cancelToken)
|
|
829
|
+
return this.withoutDiagnostics(await this.ensureDocumentState(uri, DocumentState.Linked, cancelToken));
|
|
533
830
|
}
|
|
534
831
|
|
|
535
832
|
async settled(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>> {
|
|
536
|
-
return this.ensureDocumentState(uri, IntegrityService.SettledState, cancelToken)
|
|
833
|
+
return this.withoutDiagnostics(await this.ensureDocumentState(uri, IntegrityService.SettledState, cancelToken));
|
|
537
834
|
}
|
|
538
835
|
|
|
539
836
|
async indexed(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>> {
|
|
540
|
-
return this.ensureDocumentState(uri, DocumentState.IndexedReferences, cancelToken)
|
|
837
|
+
return this.withoutDiagnostics(await this.ensureDocumentState(uri, DocumentState.IndexedReferences, cancelToken));
|
|
541
838
|
}
|
|
542
839
|
|
|
543
840
|
async validated(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, TDiagnostic>> {
|
|
@@ -547,18 +844,13 @@ export class ModelService<
|
|
|
547
844
|
/**
|
|
548
845
|
* Ensure the document at `uri` reaches `state` (or the integrity-settled
|
|
549
846
|
* 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.
|
|
847
|
+
* AST envelope, with a root no older than the store's text at the call.
|
|
848
|
+
* A document not in `LangiumDocuments` is built via {@link rebuild}; a
|
|
849
|
+
* loaded one whose root is behind its text is built through
|
|
850
|
+
* `VersionSyncService.syncTo`. Until `state` is reached, the call rejects
|
|
851
|
+
* once that build, or one the builder re-queues, has failed twice, or the
|
|
852
|
+
* builder stops re-queuing the document. A loaded, current document is only
|
|
853
|
+
* awaited.
|
|
562
854
|
*/
|
|
563
855
|
async ensureDocumentState(uri: string, state?: DocumentState, cancelToken?: CancellationToken): Promise<AstDocument<TAst, TDiagnostic>> {
|
|
564
856
|
return this.ensureDocumentStateCanonical(this.uriPolicy.canonicalUri(uri), state, cancelToken);
|
|
@@ -581,177 +873,73 @@ export class ModelService<
|
|
|
581
873
|
): Promise<AstDocument<TAst, TDiagnostic>> {
|
|
582
874
|
const target = state ?? IntegrityService.SettledState;
|
|
583
875
|
if (this.services.workspace.LangiumDocuments.hasDocument(UriUtils.toUri(uri))) {
|
|
584
|
-
return this.waitForDocumentStateCanonical(uri, target, cancelToken);
|
|
876
|
+
return this.waitForDocumentStateCanonical(uri, target, cancelToken, { sync: true });
|
|
585
877
|
}
|
|
586
878
|
return this.rebuild(uri, target, cancelToken);
|
|
587
879
|
}
|
|
588
880
|
|
|
589
881
|
/**
|
|
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
|
|
882
|
+
* Wait for the document at `uri` to reach the integrity-settled landmark,
|
|
883
|
+
* building a root behind its text as {@link ensureDocumentState} does, and
|
|
692
884
|
* drain any in-flight write-path applyEdit sync chain (see {@link syncChains})
|
|
693
|
-
* so
|
|
694
|
-
*
|
|
695
|
-
*
|
|
696
|
-
*
|
|
697
|
-
*
|
|
885
|
+
* so the language client has answered the push of the latest content before
|
|
886
|
+
* this returns; a push it refused twice is logged, not retried. No-op tail
|
|
887
|
+
* for headless adopters — `syncChains` is empty without an LSP client.
|
|
888
|
+
* Bounded at 10 s so a hung build, or an applyEdit reverse-RPC deadlock,
|
|
889
|
+
* can't freeze the caller; it returns rather than throwing, warning on
|
|
890
|
+
* timeout. A failed wait is logged at `error`, at `debug` when cancelled and
|
|
891
|
+
* at `warn` when the document is gone.
|
|
698
892
|
*
|
|
699
|
-
*
|
|
700
|
-
*
|
|
701
|
-
*
|
|
893
|
+
* The framework's save handlers call this after their persist, the data
|
|
894
|
+
* head's updates after their write and the GLSP head's settle request for
|
|
895
|
+
* each document a save writes; an adopter's own save path that answers a
|
|
896
|
+
* client calls it after its `save` too.
|
|
702
897
|
*/
|
|
703
|
-
|
|
898
|
+
async settleLanguageClient(uri: string, cancelToken?: CancellationToken): Promise<void> {
|
|
704
899
|
const canonical = this.uriPolicy.canonicalUri(uri);
|
|
705
900
|
const key = UriUtils.toUri(canonical).toString();
|
|
706
|
-
|
|
707
|
-
|
|
708
|
-
|
|
709
|
-
|
|
710
|
-
await
|
|
711
|
-
const
|
|
712
|
-
if (
|
|
713
|
-
|
|
901
|
+
// One race over both waits, so the bound is one deadline for the pair;
|
|
902
|
+
// a race per wait would let the caller wait twice the bound.
|
|
903
|
+
let awaitedChain: Promise<void> | undefined;
|
|
904
|
+
const settled = (async (): Promise<void> => {
|
|
905
|
+
await this.waitForDocumentStateCanonical(canonical, IntegrityService.SettledState, cancelToken, { sync: true });
|
|
906
|
+
const chain = this.syncChains.get(key);
|
|
907
|
+
if (chain && this.timedOutSyncChains.has(chain)) {
|
|
908
|
+
this.tracer.withUri(key).debug('Language client settle not waiting again for a push the client has not answered');
|
|
909
|
+
return;
|
|
714
910
|
}
|
|
715
|
-
|
|
716
|
-
|
|
717
|
-
|
|
911
|
+
awaitedChain = chain;
|
|
912
|
+
await chain;
|
|
913
|
+
})();
|
|
914
|
+
// The settle ends a failed wait, so it logs it, at one level whether the wait failed inside the bound or after it.
|
|
915
|
+
const reportFailedWait = (error: unknown, when: string): void => {
|
|
916
|
+
const tracer = this.tracer.withUri(key);
|
|
917
|
+
if (isOperationCancelled(error)) {
|
|
918
|
+
tracer.debug(`Language client settle cancelled ${when}`);
|
|
919
|
+
} else if (!this.services.workspace.LangiumDocuments.hasDocument(UriUtils.toUri(canonical))) {
|
|
920
|
+
tracer.warn(`Language client settle failed ${when}; the document is gone. ${describeErrorWithStack(error)}`);
|
|
718
921
|
} else {
|
|
719
|
-
|
|
720
|
-
|
|
922
|
+
tracer.error(`Language client settle failed ${when}. ${describeErrorWithStack(error)}`);
|
|
923
|
+
}
|
|
924
|
+
};
|
|
925
|
+
try {
|
|
926
|
+
if ((await this.services.Clock.raceTimer(settled, LANGUAGE_CLIENT_SETTLE_TIMEOUT_MS)) === TIMED_OUT) {
|
|
927
|
+
this.tracer.withUri(key).warn(`Language client settle exceeded ${LANGUAGE_CLIENT_SETTLE_TIMEOUT_MS}ms — returning anyway`);
|
|
928
|
+
if (awaitedChain) {
|
|
929
|
+
this.timedOutSyncChains.add(awaitedChain);
|
|
930
|
+
}
|
|
931
|
+
// The race has settled, so a later failure of the wait, such as a given-up sync build, reaches no one else.
|
|
932
|
+
void settled.catch((error: unknown) => reportFailedWait(error, 'after the timeout'));
|
|
721
933
|
}
|
|
934
|
+
} catch (err: unknown) {
|
|
935
|
+
// Its own line, so the failure is not blamed on the bound.
|
|
936
|
+
reportFailedWait(err, 'before the timeout — returning anyway');
|
|
722
937
|
}
|
|
723
938
|
}
|
|
724
939
|
|
|
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);
|
|
940
|
+
isLanguageClientPushPending(uri: string): boolean {
|
|
941
|
+
const chain = this.syncChains.get(UriUtils.toUri(this.uriPolicy.canonicalUri(uri)).toString());
|
|
942
|
+
return chain !== undefined && !this.timedOutSyncChains.has(chain);
|
|
755
943
|
}
|
|
756
944
|
|
|
757
945
|
/**
|
|
@@ -762,6 +950,37 @@ export class ModelService<
|
|
|
762
950
|
return this.services.workspace.AstDocumentManager.isOpen(uri);
|
|
763
951
|
}
|
|
764
952
|
|
|
953
|
+
openedVersion(uri: string): TextVersion | undefined {
|
|
954
|
+
return this.services.workspace.TextDocuments.openedVersion(uri);
|
|
955
|
+
}
|
|
956
|
+
|
|
957
|
+
/**
|
|
958
|
+
* Snapshot of `uri` as it stands RIGHT NOW — the synchronous sibling of the
|
|
959
|
+
* phase reads, which all wait. `undefined` when no document is registered,
|
|
960
|
+
* or only the builder's placeholder for one its build has not parsed yet:
|
|
961
|
+
* that root is no parse of any text, and its version gates no write.
|
|
962
|
+
*
|
|
963
|
+
* **This is what a writer wants, and {@link getDocument} is not.** The
|
|
964
|
+
* envelope's `version` is copied by value at projection time, so it cannot
|
|
965
|
+
* move afterwards; a version read off the live document at write time is
|
|
966
|
+
* whatever the server is at *now*, which is the number an optimistic gate is
|
|
967
|
+
* about to compare it against.
|
|
968
|
+
*
|
|
969
|
+
* Diagnostics only from a document that has reached `Validated`, and absent
|
|
970
|
+
* otherwise. Unlike the phase reads this one names no phase, so
|
|
971
|
+
* the state it finds is the only thing that can say whether the array
|
|
972
|
+
* describes the content being handed back or whatever an earlier build left.
|
|
973
|
+
* A caller that needs them unconditionally waits, via {@link validated}.
|
|
974
|
+
*/
|
|
975
|
+
snapshot(uri: string): AstDocument<TAst, TDiagnostic> | undefined {
|
|
976
|
+
const document = this.getDocument(uri);
|
|
977
|
+
if (!document || this.services.workspace.ModelLedger.isPlaceholder(document.parseResult.value)) {
|
|
978
|
+
return undefined;
|
|
979
|
+
}
|
|
980
|
+
const envelope = this.services.workspace.AstDocumentManager.toAstDocument(document) as AstDocument<TAst, TDiagnostic>;
|
|
981
|
+
return document.state >= DocumentState.Validated ? envelope : this.withoutDiagnostics(envelope);
|
|
982
|
+
}
|
|
983
|
+
|
|
765
984
|
/**
|
|
766
985
|
* The built {@link LangiumDocument} for `uri`, looked up by canonical identity —
|
|
767
986
|
* the synchronous, phase-agnostic sibling of {@link ensureDocumentState} /
|
|
@@ -770,11 +989,139 @@ export class ModelService<
|
|
|
770
989
|
* into `LangiumDocuments` directly: a symlinked / `..` / case-divergent URI
|
|
771
990
|
* still resolves to the one document the build keys by its real path. Returns
|
|
772
991
|
* `undefined` if no document is registered for `uri`.
|
|
992
|
+
*
|
|
993
|
+
* **Live, so do not take a base version off it.** `textDocument` is the
|
|
994
|
+
* store's own object rather than a copy, so `.version` read here answers for
|
|
995
|
+
* the moment of the READ, not the moment of the earlier content — pass it to
|
|
996
|
+
* a write and the server compares its current version against itself, the
|
|
997
|
+
* gate passes unconditionally, and a concurrent edit is overwritten with
|
|
998
|
+
* nothing logged. Use {@link snapshot} for that, or a phase read.
|
|
773
999
|
*/
|
|
774
1000
|
getDocument(uri: string): LangiumDocument | undefined {
|
|
775
1001
|
return this.services.workspace.AstDocumentManager.getDocument(uri);
|
|
776
1002
|
}
|
|
777
1003
|
|
|
1004
|
+
// ============================================================
|
|
1005
|
+
// Client sessions
|
|
1006
|
+
// ============================================================
|
|
1007
|
+
|
|
1008
|
+
createSession<TOpenOptions extends OpenOptions = OpenOptions>(
|
|
1009
|
+
label?: string,
|
|
1010
|
+
clientId?: string,
|
|
1011
|
+
options: { readonly resumeToken?: string } = {}
|
|
1012
|
+
): ClientSession<TAst, TDiagnostic, TTransfer, TOpenOptions> {
|
|
1013
|
+
const sessionLabel = label ?? 'session';
|
|
1014
|
+
const id = clientId ?? `${sessionLabel}#${randomUuid()}`;
|
|
1015
|
+
const textDocuments = this.services.workspace.TextDocuments;
|
|
1016
|
+
if (options.resumeToken !== undefined && this.resumeTokens.get(id) === options.resumeToken) {
|
|
1017
|
+
this.sessions.get(id)?.dispose('lost');
|
|
1018
|
+
}
|
|
1019
|
+
textDocuments.registerSession(id);
|
|
1020
|
+
this.sessionCloseListener ??= textDocuments.onDidCloseSession(event => {
|
|
1021
|
+
// Also reached when the store ends a session directly; disposing the
|
|
1022
|
+
// handle makes its later calls fail rather than write under an id
|
|
1023
|
+
// this service no longer treats as a session. Forgotten first: a
|
|
1024
|
+
// dispose listener may start a replacement under the same id.
|
|
1025
|
+
const ended = this.sessions.get(event.clientId);
|
|
1026
|
+
this.sessions.delete(event.clientId);
|
|
1027
|
+
this.resumeTokens.delete(event.clientId);
|
|
1028
|
+
ended?.dispose(event.cause);
|
|
1029
|
+
});
|
|
1030
|
+
let session: ClientSession<TAst, TDiagnostic, TTransfer, TOpenOptions>;
|
|
1031
|
+
try {
|
|
1032
|
+
// Unchecked: the session keeps whatever options its `open` is handed,
|
|
1033
|
+
// and the factory types it for every grammar, so the narrowed type
|
|
1034
|
+
// holds only for the caller that started it.
|
|
1035
|
+
session = this.services.model.ClientSessionFactory.create(id, sessionLabel) as ClientSession<
|
|
1036
|
+
TAst,
|
|
1037
|
+
TDiagnostic,
|
|
1038
|
+
TTransfer,
|
|
1039
|
+
TOpenOptions
|
|
1040
|
+
>;
|
|
1041
|
+
} catch (err: unknown) {
|
|
1042
|
+
textDocuments.closeSession(id);
|
|
1043
|
+
throw err;
|
|
1044
|
+
}
|
|
1045
|
+
this.sessions.set(id, session);
|
|
1046
|
+
if (options.resumeToken !== undefined) {
|
|
1047
|
+
this.resumeTokens.set(id, options.resumeToken);
|
|
1048
|
+
}
|
|
1049
|
+
return session;
|
|
1050
|
+
}
|
|
1051
|
+
|
|
1052
|
+
getSession(clientId: string): ClientSession<TAst, TDiagnostic, TTransfer> | undefined {
|
|
1053
|
+
return this.sessions.get(clientId);
|
|
1054
|
+
}
|
|
1055
|
+
|
|
1056
|
+
/**
|
|
1057
|
+
* Convert a structured-or-textual `model` payload to its textual form.
|
|
1058
|
+
*
|
|
1059
|
+
* Textual payloads (LSP / pre-serialised callers) pass through untouched.
|
|
1060
|
+
* Structured payloads run the per-language `UpdateRewriteService` chain
|
|
1061
|
+
* (transfer-model transforms; diff-aware rewrites see the previous AST root),
|
|
1062
|
+
* then serialise. The chain is the single transfer-model-transform seam — a
|
|
1063
|
+
* unary normalisation is just a rewrite that ignores `previous`, as
|
|
1064
|
+
* `NormalizeEmptyStringsContribution` does. The chain is empty by
|
|
1065
|
+
* default, so this is a no-op for adopters that register none.
|
|
1066
|
+
*
|
|
1067
|
+
* The serialised text then takes the trivia of the text it replaces, or of
|
|
1068
|
+
* an empty one when `uri` has none, so a created document gets the
|
|
1069
|
+
* preservers' defaults rather than the serializer's bare output. Under
|
|
1070
|
+
* {@link ModelServiceOptions.keepUnchangedText} the document's own text is
|
|
1071
|
+
* returned when it parses to a model that serializes to the same text.
|
|
1072
|
+
*/
|
|
1073
|
+
async modelToText(uri: string, model: TTransfer | string, cancelToken?: CancellationToken): Promise<string> {
|
|
1074
|
+
if (typeof model === 'string') {
|
|
1075
|
+
return model;
|
|
1076
|
+
}
|
|
1077
|
+
const rewritten = await this.rewriteModel(uri, model, cancelToken);
|
|
1078
|
+
const target = UriUtils.toUri(uri);
|
|
1079
|
+
const trivia = this.services.ServiceRegistry?.getServices(target)?.trivia?.TriviaService;
|
|
1080
|
+
// Extracted BEFORE serializing, so it reads the document the write is
|
|
1081
|
+
// about to replace rather than whatever a concurrent build left behind.
|
|
1082
|
+
const existing = this.services.workspace.LangiumDocuments.getDocument(target);
|
|
1083
|
+
let document = existing;
|
|
1084
|
+
if (trivia !== undefined && document === undefined) {
|
|
1085
|
+
// With no text, an empty one: every preserver still runs, so a created
|
|
1086
|
+
// document takes the defaults a blank one gets.
|
|
1087
|
+
const source = (await this.textToTakeTriviaFrom(uri, target)) ?? '';
|
|
1088
|
+
document = this.services.workspace.LangiumDocumentFactory.fromString(source, target);
|
|
1089
|
+
}
|
|
1090
|
+
const extracted = trivia !== undefined && document !== undefined ? trivia.extract(document) : undefined;
|
|
1091
|
+
const withTrivia = (serialized: string): string =>
|
|
1092
|
+
extracted === undefined ? serialized : trivia!.apply(serialized, extracted, target);
|
|
1093
|
+
const text = withTrivia(await this.serialize(uri, rewritten));
|
|
1094
|
+
if (!this.keepUnchangedText.value || existing === undefined) {
|
|
1095
|
+
return text;
|
|
1096
|
+
}
|
|
1097
|
+
// The text the root was parsed from, not the store's: the store changes
|
|
1098
|
+
// its text in place before the next build, and a root compared against
|
|
1099
|
+
// newer text would keep that text for a model it does not hold.
|
|
1100
|
+
const parsedText = existing.parseResult.value?.$cstNode?.root.fullText;
|
|
1101
|
+
if (parsedText === undefined || parsedText === text) {
|
|
1102
|
+
return text;
|
|
1103
|
+
}
|
|
1104
|
+
// Parsed afresh rather than the live root, which a writer may have
|
|
1105
|
+
// mutated in place: every write of the mutated model would then compare
|
|
1106
|
+
// equal and apply the text from before the mutation. Parsed into a
|
|
1107
|
+
// document at `target`, so the encoder's hooks see the URI the written
|
|
1108
|
+
// side was encoded with.
|
|
1109
|
+
const {
|
|
1110
|
+
value: root,
|
|
1111
|
+
lexerErrors,
|
|
1112
|
+
parserErrors
|
|
1113
|
+
} = this.services.workspace.LangiumDocumentFactory.fromString(parsedText, target).parseResult;
|
|
1114
|
+
if (lexerErrors.length > 0 || parserErrors.length > 0) {
|
|
1115
|
+
return text;
|
|
1116
|
+
}
|
|
1117
|
+
// Through `serialize`, so an override of it applies to both sides. Not
|
|
1118
|
+
// rewritten: a rewrite that changes the document's model then compares
|
|
1119
|
+
// unequal and is written, rather than hidden behind the kept text.
|
|
1120
|
+
const transfer = this.services.model.TransferEncoder.toTransfer(root, 'grammar') as TTransfer;
|
|
1121
|
+
const current = withTrivia(await this.serialize(uri, transfer));
|
|
1122
|
+
return current === text ? parsedText : text;
|
|
1123
|
+
}
|
|
1124
|
+
|
|
778
1125
|
// ============================================================
|
|
779
1126
|
// LSP-client sync (mirror non-LSP-client changes back to Monaco)
|
|
780
1127
|
// ============================================================
|
|
@@ -783,18 +1130,14 @@ export class ModelService<
|
|
|
783
1130
|
* Mirror a server-side change of `document` back to the LSP textual language
|
|
784
1131
|
* client, run per document as it reaches the post-integrity settled phase.
|
|
785
1132
|
* 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:
|
|
1133
|
+
* `HydraniumTextDocuments.applyEditToLanguageClient`.
|
|
791
1134
|
*
|
|
792
|
-
*
|
|
793
|
-
*
|
|
794
|
-
*
|
|
795
|
-
*
|
|
796
|
-
*
|
|
797
|
-
*
|
|
1135
|
+
* Only a document open in the language client is mirrored, through
|
|
1136
|
+
* {@link syncOpenDocument}, routed purely by **content**. A document open
|
|
1137
|
+
* only in another client needs nothing: a language client opening it joins
|
|
1138
|
+
* the existing entry and is refreshed from the store. A session writes only
|
|
1139
|
+
* what it has open, so no session edit of a closed document waits here for
|
|
1140
|
+
* the language client's next open.
|
|
798
1141
|
*
|
|
799
1142
|
* The decision is **re-derived from the current settled state every time** (it
|
|
800
1143
|
* is not a one-shot enrolment), which is what makes it self-healing: a doc
|
|
@@ -804,20 +1147,18 @@ export class ModelService<
|
|
|
804
1147
|
*/
|
|
805
1148
|
protected syncToLanguageClient(document: LangiumDocument): void {
|
|
806
1149
|
// `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
|
|
1150
|
+
// build. Route by client registration (presence questions — both
|
|
1151
|
+
// predicates canonicalize internally, so a divergent open path still
|
|
1152
|
+
// resolves to the same record), but key the outbound sync by this
|
|
1153
|
+
// CANONICAL URI — the same key `settleLanguageClient` looks the chain up
|
|
1154
|
+
// under — so a settle can drain the in-flight applyEdit. The canonical→client-URI
|
|
812
1155
|
// translation (a symlinked path the client opened, or a dual-open fan-out)
|
|
813
1156
|
// happens at the `applyEditToLanguageClient` egress, where the text store maps
|
|
814
1157
|
// 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.
|
|
1158
|
+
// in client space here would key it under a URI `settleLanguageClient`
|
|
1159
|
+
// never computes, so the drain would miss for a divergent open path.
|
|
817
1160
|
if (this.services.workspace.TextDocuments.isOpenInLanguageClient(document.textDocument.uri)) {
|
|
818
1161
|
this.syncOpenDocument(document.textDocument.uri, document.textDocument.getText());
|
|
819
|
-
} else {
|
|
820
|
-
this.stageClosedDocument(document);
|
|
821
1162
|
}
|
|
822
1163
|
}
|
|
823
1164
|
|
|
@@ -836,46 +1177,6 @@ export class ModelService<
|
|
|
836
1177
|
this.queueSync(uri, text);
|
|
837
1178
|
}
|
|
838
1179
|
|
|
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
1180
|
/**
|
|
880
1181
|
* Enqueue a sync to the language client. The pending slot per URI holds only
|
|
881
1182
|
* the latest text: if a newer settle fires while the current RPC is in
|
|
@@ -926,17 +1227,31 @@ export class ModelService<
|
|
|
926
1227
|
const text = this.pendingSync.get(uri)!;
|
|
927
1228
|
this.pendingSync.delete(uri);
|
|
928
1229
|
try {
|
|
929
|
-
|
|
930
|
-
|
|
931
|
-
|
|
1230
|
+
const textDocuments = this.services.workspace.TextDocuments;
|
|
1231
|
+
// An answer, or a failure, ends a hang a settle timed out on, so the
|
|
1232
|
+
// chain's later pushes are waited for again.
|
|
1233
|
+
const push = async (): Promise<ApplyWorkspaceEditResult | undefined> => {
|
|
1234
|
+
try {
|
|
1235
|
+
return await textDocuments.applyEditToLanguageClient(uri, text, { label: this.editLabel() });
|
|
1236
|
+
} finally {
|
|
1237
|
+
const chain = this.syncChains.get(uri);
|
|
1238
|
+
if (chain) {
|
|
1239
|
+
this.timedOutSyncChains.delete(chain);
|
|
1240
|
+
}
|
|
1241
|
+
}
|
|
1242
|
+
};
|
|
1243
|
+
let result = await push();
|
|
1244
|
+
if (result?.applied === false && !this.pendingSync.has(uri) && textDocuments.get(uri)?.getText() === text) {
|
|
1245
|
+
// The push is addressed at the client's last known version, so a
|
|
932
1246
|
// rejection normally means the client's buffer moved while the
|
|
933
1247
|
// line-keyed diff was in flight — exactly the case where applying it
|
|
934
1248
|
// would splice the file. Dropping the push there would leave the
|
|
935
1249
|
// editor showing text the server has already superseded, with no
|
|
936
1250
|
// later settle guaranteed to correct it (a content-identical echo
|
|
937
|
-
// mints no rebuild).
|
|
938
|
-
//
|
|
939
|
-
//
|
|
1251
|
+
// mints no rebuild). After a rejection the retry is a full-range
|
|
1252
|
+
// replace: position-independent, and therefore correct against
|
|
1253
|
+
// whatever the client now holds. It sends nothing when the client
|
|
1254
|
+
// was last heard to hold the text already.
|
|
940
1255
|
//
|
|
941
1256
|
// Retried INLINE rather than re-enqueued, and exactly once. Inline
|
|
942
1257
|
// because a re-enqueue would have to out-order any settle that lands
|
|
@@ -945,9 +1260,11 @@ export class ModelService<
|
|
|
945
1260
|
// the workspace) must cost one extra RPC rather than spin. The
|
|
946
1261
|
// `pendingSync` check skips the retry when a newer settle has already
|
|
947
1262
|
// queued — best-effort, since a settle arriving later simply pushes
|
|
948
|
-
// after this and still wins.
|
|
949
|
-
|
|
950
|
-
|
|
1263
|
+
// after this and still wins. It is skipped too once the store holds
|
|
1264
|
+
// other text: the keystroke that made the client refuse replaced it,
|
|
1265
|
+
// and re-pushing would overwrite that keystroke in the editor.
|
|
1266
|
+
uriLogger.debug(`Re-pushing a full replace after the language client refused applyEdit`);
|
|
1267
|
+
result = await push();
|
|
951
1268
|
if (result?.applied === false) {
|
|
952
1269
|
uriLogger.warn(`Language client rejected the full-replace retry too — client content is stale`);
|
|
953
1270
|
}
|
|
@@ -958,52 +1275,156 @@ export class ModelService<
|
|
|
958
1275
|
// ordinary shutdown. Reporting it at `error` makes routine teardown
|
|
959
1276
|
// look like it needs investigating. A genuine applyEdit failure
|
|
960
1277
|
// (client refused, request malformed) still surfaces at `error`.
|
|
961
|
-
if (
|
|
1278
|
+
if (isClientGoneError(err)) {
|
|
962
1279
|
uriLogger.debug(`applyEdit to ${LANGUAGE_CLIENT_ID} skipped: client disconnected`);
|
|
963
1280
|
} else {
|
|
964
|
-
uriLogger.error(`applyEdit to ${LANGUAGE_CLIENT_ID} failed: ${err}`);
|
|
1281
|
+
uriLogger.error(`applyEdit to ${LANGUAGE_CLIENT_ID} failed: ${describeErrorWithStack(err)}`);
|
|
965
1282
|
}
|
|
966
1283
|
}
|
|
967
1284
|
}
|
|
968
1285
|
}
|
|
969
1286
|
|
|
970
1287
|
// ============================================================
|
|
971
|
-
//
|
|
1288
|
+
// Subscriptions
|
|
972
1289
|
// ============================================================
|
|
973
1290
|
|
|
974
|
-
|
|
975
|
-
|
|
976
|
-
|
|
977
|
-
|
|
978
|
-
|
|
979
|
-
|
|
980
|
-
|
|
981
|
-
|
|
982
|
-
|
|
983
|
-
|
|
984
|
-
|
|
985
|
-
|
|
1291
|
+
onModelUpdated(listener: (event: ModelUpdatedEvent<TAst, TDiagnostic>) => void, filter: ModelPhaseFilter = {}): Disposable {
|
|
1292
|
+
const phase = filter.phase ?? DocumentState.Validated;
|
|
1293
|
+
let subscribers = this.updateSubscribers.get(phase);
|
|
1294
|
+
if (!subscribers) {
|
|
1295
|
+
const created = new Set<ModelUpdateSubscriber<TAst, TDiagnostic>>();
|
|
1296
|
+
this.updateSubscribers.set(phase, created);
|
|
1297
|
+
this.services.workspace.DocumentBuilder.onDocumentPhase(
|
|
1298
|
+
phase,
|
|
1299
|
+
labelPhaseListener(
|
|
1300
|
+
(document, cancelToken) => this.deliverUpdate(phase, created, document, cancelToken),
|
|
1301
|
+
'ModelService.onModelUpdated'
|
|
1302
|
+
)
|
|
1303
|
+
);
|
|
1304
|
+
subscribers = created;
|
|
1305
|
+
}
|
|
1306
|
+
const subscriber = { uri: this.filterUri(filter), listener };
|
|
1307
|
+
subscribers.add(subscriber);
|
|
1308
|
+
return Disposable.create(() => subscribers.delete(subscriber));
|
|
986
1309
|
}
|
|
987
1310
|
|
|
988
|
-
|
|
989
|
-
|
|
990
|
-
|
|
991
|
-
|
|
992
|
-
|
|
993
|
-
|
|
994
|
-
|
|
995
|
-
|
|
996
|
-
|
|
997
|
-
|
|
1311
|
+
onModelsBuilt(listener: (event: ModelsBuiltEvent) => void, filter: Pick<ModelPhaseFilter, 'phase'> = {}): Disposable {
|
|
1312
|
+
const phase = filter.phase ?? DocumentState.Validated;
|
|
1313
|
+
return this.services.workspace.DocumentBuilder.onBuildPhase(phase, (built, cancelToken) => {
|
|
1314
|
+
if (cancelToken.isCancellationRequested) {
|
|
1315
|
+
return;
|
|
1316
|
+
}
|
|
1317
|
+
try {
|
|
1318
|
+
listener(Object.freeze({ uris: built.map(document => this.uriPolicy.canonicalUri(document.uri.toString())), phase }));
|
|
1319
|
+
} catch (err: unknown) {
|
|
1320
|
+
this.tracer.error(`onModelsBuilt listener threw: ${describeErrorWithStack(err)}`);
|
|
1321
|
+
}
|
|
1322
|
+
});
|
|
1323
|
+
}
|
|
1324
|
+
|
|
1325
|
+
onModelSaved(listener: (event: ModelSavedEvent<TAst, TDiagnostic>) => void, filter: ModelEventFilter = {}): Disposable {
|
|
1326
|
+
const target = this.filterUri(filter);
|
|
1327
|
+
return this.services.workspace.TextDocuments.onDidSave(event => {
|
|
1328
|
+
// LangiumDocuments keys by the canonical form, the saved event by the
|
|
1329
|
+
// client-facing one.
|
|
1330
|
+
const uri = this.uriPolicy.canonicalUri(event.document.uri);
|
|
1331
|
+
if (this.matches(target, uri)) {
|
|
1332
|
+
listener({ document: this.toAstDocument(UriUtils.toUri(uri)), sourceClientId: event.clientId });
|
|
1333
|
+
}
|
|
1334
|
+
});
|
|
1335
|
+
}
|
|
1336
|
+
|
|
1337
|
+
onModelDeleted(listener: (event: ModelDeletedEvent) => void, filter: ModelEventFilter = {}): Disposable {
|
|
1338
|
+
const target = this.filterUri(filter);
|
|
1339
|
+
return this.services.workspace.DocumentBuilder.onUpdate((_changed, deleted) => {
|
|
1340
|
+
for (const deletedUri of deleted) {
|
|
1341
|
+
const uri = this.uriPolicy.canonicalUri(deletedUri.toString());
|
|
1342
|
+
if (this.matches(target, uri)) {
|
|
1343
|
+
listener(Object.freeze({ uri, sourceClientId: this.services.workspace.AstDocumentManager.attributeDeletion(uri) }));
|
|
1344
|
+
}
|
|
1345
|
+
}
|
|
1346
|
+
});
|
|
1347
|
+
}
|
|
1348
|
+
|
|
1349
|
+
onDirtyChanged(listener: (event: ModelDirtyChangedEvent) => void, filter: ModelEventFilter = {}): Disposable {
|
|
1350
|
+
const target = this.filterUri(filter);
|
|
1351
|
+
return this.services.workspace.TextDocuments.onDidChangeDirty(event => {
|
|
1352
|
+
if (this.matches(target, event.uri)) {
|
|
1353
|
+
listener(event);
|
|
1354
|
+
}
|
|
1355
|
+
});
|
|
1356
|
+
}
|
|
1357
|
+
|
|
1358
|
+
onModelReleased(listener: (event: ModelReleasedEvent) => void, filter: ModelEventFilter = {}): Disposable {
|
|
1359
|
+
const target = this.filterUri(filter);
|
|
1360
|
+
return this.services.workspace.TextDocuments.onDidReleaseDocument(event => {
|
|
1361
|
+
if (this.matches(target, event.uri)) {
|
|
1362
|
+
listener(event);
|
|
1363
|
+
}
|
|
1364
|
+
});
|
|
1365
|
+
}
|
|
1366
|
+
|
|
1367
|
+
onClientClosed(listener: () => void, filter: { readonly uri: string; readonly clientId: string }): Disposable {
|
|
1368
|
+
const target = this.uriPolicy.canonicalUri(filter.uri);
|
|
1369
|
+
return this.services.workspace.TextDocuments.onDidClose(event => {
|
|
1370
|
+
if (event.clientId === filter.clientId && this.uriPolicy.canonicalUri(event.document.uri) === target) {
|
|
1371
|
+
listener();
|
|
1372
|
+
}
|
|
1373
|
+
});
|
|
1374
|
+
}
|
|
1375
|
+
|
|
1376
|
+
protected filterUri(filter: ModelEventFilter): CanonicalUri | undefined {
|
|
1377
|
+
return filter.uri === undefined ? undefined : this.uriPolicy.canonicalUri(filter.uri);
|
|
1378
|
+
}
|
|
1379
|
+
|
|
1380
|
+
protected matches(target: CanonicalUri | undefined, uri: CanonicalUri): boolean {
|
|
1381
|
+
return target === undefined || target === uri;
|
|
998
1382
|
}
|
|
999
1383
|
|
|
1000
1384
|
/**
|
|
1001
|
-
*
|
|
1002
|
-
*
|
|
1003
|
-
*
|
|
1385
|
+
* Hand every subscriber of `phase` for `document` one event, built once, so
|
|
1386
|
+
* all of them see the same attribution. Built inside the build's listener
|
|
1387
|
+
* and handed out without an await: after one, another build can have reset
|
|
1388
|
+
* the document.
|
|
1004
1389
|
*/
|
|
1005
|
-
|
|
1006
|
-
|
|
1390
|
+
protected deliverUpdate(
|
|
1391
|
+
phase: DocumentState,
|
|
1392
|
+
subscribers: ReadonlySet<ModelUpdateSubscriber<TAst, TDiagnostic>>,
|
|
1393
|
+
document: LangiumDocument,
|
|
1394
|
+
cancelToken: CancellationToken
|
|
1395
|
+
): void {
|
|
1396
|
+
if (cancelToken.isCancellationRequested || subscribers.size === 0) {
|
|
1397
|
+
return;
|
|
1398
|
+
}
|
|
1399
|
+
const uri = this.uriPolicy.canonicalUri(document.uri.toString());
|
|
1400
|
+
const matching = [...subscribers].filter(subscriber => this.matches(subscriber.uri, uri));
|
|
1401
|
+
if (matching.length === 0) {
|
|
1402
|
+
return;
|
|
1403
|
+
}
|
|
1404
|
+
const manager = this.services.workspace.AstDocumentManager;
|
|
1405
|
+
const envelope = manager.toAstDocument(document) as AstDocument<TAst, TDiagnostic>;
|
|
1406
|
+
const event: ModelUpdatedEvent<TAst, TDiagnostic> = Object.freeze({
|
|
1407
|
+
// Copied: a validation run without a reset, of further categories,
|
|
1408
|
+
// appends to the live array.
|
|
1409
|
+
document:
|
|
1410
|
+
phase >= DocumentState.Validated
|
|
1411
|
+
? { ...envelope, ...(envelope.diagnostics && { diagnostics: [...envelope.diagnostics] }) }
|
|
1412
|
+
: (this.withoutDiagnostics(envelope) as AstDocument<TAst, TDiagnostic>),
|
|
1413
|
+
...manager.attributeUpdate(document),
|
|
1414
|
+
phase
|
|
1415
|
+
});
|
|
1416
|
+
for (const { listener } of matching) {
|
|
1417
|
+
// A write queued by an earlier listener cancels this build. Thrown,
|
|
1418
|
+
// so the builder leaves the version undelivered for those skipped.
|
|
1419
|
+
if (cancelToken.isCancellationRequested) {
|
|
1420
|
+
throw OperationCancelled;
|
|
1421
|
+
}
|
|
1422
|
+
try {
|
|
1423
|
+
listener(event);
|
|
1424
|
+
} catch (err: unknown) {
|
|
1425
|
+
this.tracer.with(uri).error(`onModelUpdated listener threw: ${describeErrorWithStack(err)}`);
|
|
1426
|
+
}
|
|
1427
|
+
}
|
|
1007
1428
|
}
|
|
1008
1429
|
|
|
1009
1430
|
// ============================================================
|
|
@@ -1021,13 +1442,13 @@ export class ModelService<
|
|
|
1021
1442
|
* Adopters whose serializer call shape differs (custom service
|
|
1022
1443
|
* names, generator-driven YAML pretty printers, etc.) override this
|
|
1023
1444
|
* method. Routes through `Serializer.serializeTransfer` because
|
|
1024
|
-
* `
|
|
1445
|
+
* a session's `update` / `save` always receive a
|
|
1025
1446
|
* transfer-model shape (cross-references as plain strings) from
|
|
1026
1447
|
* adopter callers — the AST-shape entry point is `serializeAst`.
|
|
1027
1448
|
*
|
|
1028
1449
|
* Returns {@link MaybePromise} so adopter `Serializer` overrides can be
|
|
1029
1450
|
* async (remote schema lookup, external canonical-value resolution); the
|
|
1030
|
-
* single caller ({@link modelToText}
|
|
1451
|
+
* single caller ({@link modelToText}) is already `async`,
|
|
1031
1452
|
* so a naive `await` covers both branches without extra ceremony.
|
|
1032
1453
|
*/
|
|
1033
1454
|
protected serialize(uri: string, root: TTransfer): MaybePromise<string> {
|
|
@@ -1040,22 +1461,15 @@ export class ModelService<
|
|
|
1040
1461
|
// ============================================================
|
|
1041
1462
|
|
|
1042
1463
|
/**
|
|
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.
|
|
1464
|
+
* The text a write into a document not yet built should take its trivia
|
|
1465
|
+
* from: the store's, which a write always has, since it writes only a
|
|
1466
|
+
* document its client has open. `undefined` when the store holds no text
|
|
1467
|
+
* for `uri`: a document not yet created, or a file on disk that the
|
|
1468
|
+
* workspace has not read and no client has open. The preservers then run
|
|
1469
|
+
* over empty text, as for a created document; no answer skips them.
|
|
1052
1470
|
*/
|
|
1053
|
-
protected async
|
|
1054
|
-
|
|
1055
|
-
return model;
|
|
1056
|
-
}
|
|
1057
|
-
const rewritten = await this.rewriteModel(uri, model, cancelToken);
|
|
1058
|
-
return this.serialize(uri, rewritten);
|
|
1471
|
+
protected async textToTakeTriviaFrom(uri: string, _target: URI): Promise<string | undefined> {
|
|
1472
|
+
return this.services.workspace.TextDocuments.get(uri)?.getText();
|
|
1059
1473
|
}
|
|
1060
1474
|
|
|
1061
1475
|
/**
|
|
@@ -1079,15 +1493,37 @@ export class ModelService<
|
|
|
1079
1493
|
|
|
1080
1494
|
/**
|
|
1081
1495
|
* Build an {@link AstDocument} envelope from the current
|
|
1082
|
-
* {@link LangiumDocument} state via
|
|
1083
|
-
* projection. Returns an empty envelope (built via
|
|
1496
|
+
* {@link LangiumDocument} state via `AstDocumentManager.toAstDocument`,
|
|
1497
|
+
* the projection events use too. Returns an empty envelope (built via
|
|
1084
1498
|
* {@link AstDocument.create}) when the document is absent from the
|
|
1085
|
-
* registry — adopters that prefer to throw override on their subclass.
|
|
1499
|
+
* registry — adopters that prefer to throw override on their subclass. Its
|
|
1500
|
+
* version is {@link UNRECORDED_VERSION}, so a write based on it conflicts.
|
|
1086
1501
|
*/
|
|
1087
1502
|
protected toAstDocument(uri: URI): AstDocument<TAst, TDiagnostic> {
|
|
1088
1503
|
const document = this.services.workspace.LangiumDocuments.getDocument(uri);
|
|
1089
1504
|
return document
|
|
1090
|
-
? AstDocument
|
|
1091
|
-
: AstDocument.create<TAst, TDiagnostic>(uri.toString(),
|
|
1505
|
+
? (this.services.workspace.AstDocumentManager.toAstDocument(document) as AstDocument<TAst, TDiagnostic>)
|
|
1506
|
+
: AstDocument.create<TAst, TDiagnostic>(uri.toString(), UNRECORDED_VERSION, undefined as unknown as TAst);
|
|
1507
|
+
}
|
|
1508
|
+
|
|
1509
|
+
/**
|
|
1510
|
+
* The same envelope with no diagnostics, for a read that names a phase below
|
|
1511
|
+
* `Validated`. Absent rather than `[]`, which says the document was validated
|
|
1512
|
+
* and found clean.
|
|
1513
|
+
*
|
|
1514
|
+
* Langium fills `LangiumDocument.diagnostics` from inside `validateDocument`
|
|
1515
|
+
* and from nowhere else, so below that phase the array holds whatever an
|
|
1516
|
+
* EARLIER build left — a verdict about text the document may no longer have.
|
|
1517
|
+
* The wait underneath resolves at or above the phase asked for, so a document
|
|
1518
|
+
* something else carried past `Validated` would otherwise hand a full array
|
|
1519
|
+
* back from `parsed()`.
|
|
1520
|
+
*
|
|
1521
|
+
* A copy rather than a clear: the envelope is freshly built here, but
|
|
1522
|
+
* {@link toAstDocument} is overridable and an adopter's version may return
|
|
1523
|
+
* one it also keeps.
|
|
1524
|
+
*/
|
|
1525
|
+
protected withoutDiagnostics(document: AstDocument<TAst, TDiagnostic>): AstDocument<TAst, never> {
|
|
1526
|
+
const { diagnostics: _diagnostics, ...rest } = document;
|
|
1527
|
+
return rest;
|
|
1092
1528
|
}
|
|
1093
1529
|
}
|