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