@hydranium/core 1.0.0-next.18 → 1.0.0-next.181
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 +5 -1
- package/lib/documents/ast-document-manager.d.ts +190 -30
- package/lib/documents/ast-document-manager.d.ts.map +1 -1
- package/lib/documents/ast-document-manager.js +236 -40
- 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 +138 -0
- package/lib/documents/client-session-registry.d.ts.map +1 -0
- package/lib/documents/client-session-registry.js +187 -0
- package/lib/documents/client-session-registry.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 +447 -82
- package/lib/documents/hydranium-text-documents.d.ts.map +1 -1
- package/lib/documents/hydranium-text-documents.js +780 -160
- package/lib/documents/hydranium-text-documents.js.map +1 -1
- package/lib/documents/index.d.ts +3 -0
- package/lib/documents/index.d.ts.map +1 -1
- package/lib/documents/index.js +3 -0
- package/lib/documents/index.js.map +1 -1
- package/lib/documents/language-client-text-shadow.d.ts +41 -9
- package/lib/documents/language-client-text-shadow.d.ts.map +1 -1
- package/lib/documents/language-client-text-shadow.js +56 -11
- package/lib/documents/language-client-text-shadow.js.map +1 -1
- package/lib/documents/self-save-registry.d.ts +37 -6
- package/lib/documents/self-save-registry.d.ts.map +1 -1
- package/lib/documents/self-save-registry.js +28 -15
- package/lib/documents/self-save-registry.js.map +1 -1
- package/lib/index.d.ts +3 -0
- package/lib/index.d.ts.map +1 -1
- package/lib/index.js +6 -0
- package/lib/index.js.map +1 -1
- 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.map +1 -1
- package/lib/langium/bootstrap.js +16 -9
- package/lib/langium/bootstrap.js.map +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/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.map +1 -1
- package/lib/langium/diagnostics/hydranium-langium-profiler.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 +40 -6
- 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 +93 -0
- package/lib/langium/document-builder/build-session.d.ts.map +1 -0
- package/lib/langium/document-builder/build-session.js +72 -0
- package/lib/langium/document-builder/build-session.js.map +1 -0
- package/lib/langium/document-builder/document-builder.d.ts +368 -21
- package/lib/langium/document-builder/document-builder.d.ts.map +1 -1
- package/lib/langium/document-builder/document-builder.js +641 -47
- package/lib/langium/document-builder/document-builder.js.map +1 -1
- package/lib/langium/document-builder/index.d.ts +1 -0
- package/lib/langium/document-builder/index.d.ts.map +1 -1
- package/lib/langium/document-builder/index.js +1 -0
- package/lib/langium/document-builder/index.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 +45 -1
- package/lib/langium/integration-services.d.ts.map +1 -1
- package/lib/langium/integration-services.js +10 -5
- package/lib/langium/integration-services.js.map +1 -1
- package/lib/langium/integrity/integrity-rule.d.ts +13 -5
- 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 +58 -13
- package/lib/langium/integrity/integrity-service.d.ts.map +1 -1
- package/lib/langium/integrity/integrity-service.js +213 -29
- 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 +27 -2
- package/lib/langium/language-module.d.ts.map +1 -1
- package/lib/langium/language-module.js +16 -2
- package/lib/langium/language-module.js.map +1 -1
- package/lib/langium/model-service/client-session.d.ts +307 -0
- package/lib/langium/model-service/client-session.d.ts.map +1 -0
- package/lib/langium/model-service/client-session.js +395 -0
- package/lib/langium/model-service/client-session.js.map +1 -0
- package/lib/langium/model-service/index.d.ts +1 -0
- package/lib/langium/model-service/index.d.ts.map +1 -1
- package/lib/langium/model-service/index.js +1 -0
- package/lib/langium/model-service/index.js.map +1 -1
- package/lib/langium/model-service/model-service.d.ts +276 -226
- package/lib/langium/model-service/model-service.d.ts.map +1 -1
- package/lib/langium/model-service/model-service.js +251 -375
- package/lib/langium/model-service/model-service.js.map +1 -1
- package/lib/langium/module.d.ts +144 -35
- package/lib/langium/module.d.ts.map +1 -1
- package/lib/langium/module.js +46 -35
- package/lib/langium/module.js.map +1 -1
- package/lib/langium/naming/name-provider.d.ts +25 -4
- package/lib/langium/naming/name-provider.d.ts.map +1 -1
- package/lib/langium/naming/name-provider.js +2 -1
- package/lib/langium/naming/name-provider.js.map +1 -1
- package/lib/langium/naming/name-separator-validation.d.ts +23 -0
- package/lib/langium/naming/name-separator-validation.d.ts.map +1 -1
- package/lib/langium/naming/name-separator-validation.js +30 -1
- 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 +9 -2
- 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 +31 -11
- package/lib/langium/residency/cst-residency-service.d.ts.map +1 -1
- package/lib/langium/residency/cst-residency-service.js +13 -56
- 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/hydranium-scope-computation.d.ts.map +1 -1
- package/lib/langium/scope/hydranium-scope-computation.js.map +1 -1
- package/lib/langium/scope/hydranium-scope-provider.d.ts +48 -13
- package/lib/langium/scope/hydranium-scope-provider.d.ts.map +1 -1
- package/lib/langium/scope/hydranium-scope-provider.js +56 -20
- package/lib/langium/scope/hydranium-scope-provider.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.map +1 -1
- package/lib/langium/scope/reference-candidate-provider.js.map +1 -1
- package/lib/langium/scope/scope-extension-service.d.ts.map +1 -1
- package/lib/langium/scope/scope-extension-service.js.map +1 -1
- package/lib/langium/serialization/abstract-serializer.d.ts +11 -20
- package/lib/langium/serialization/abstract-serializer.d.ts.map +1 -1
- package/lib/langium/serialization/abstract-serializer.js +12 -21
- package/lib/langium/serialization/abstract-serializer.js.map +1 -1
- package/lib/langium/serialization/json-serializer.d.ts +1 -1
- package/lib/langium/serialization/json-serializer.d.ts.map +1 -1
- package/lib/langium/serialization/json-serializer.js.map +1 -1
- package/lib/langium/serialization/yaml-serializer.d.ts.map +1 -1
- package/lib/langium/serialization/yaml-serializer.js.map +1 -1
- package/lib/langium/service-registry.d.ts +15 -1
- package/lib/langium/service-registry.d.ts.map +1 -1
- package/lib/langium/service-registry.js +16 -0
- package/lib/langium/service-registry.js.map +1 -1
- package/lib/langium/shared-services.d.ts +15 -2
- package/lib/langium/shared-services.d.ts.map +1 -1
- package/lib/langium/shared-services.js.map +1 -1
- package/lib/langium/transfer/transfer-encoder.d.ts +60 -17
- package/lib/langium/transfer/transfer-encoder.d.ts.map +1 -1
- package/lib/langium/transfer/transfer-encoder.js +38 -16
- 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.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 +294 -10
- package/lib/langium/validation/document-validator.d.ts.map +1 -1
- package/lib/langium/validation/document-validator.js +448 -5
- package/lib/langium/validation/document-validator.js.map +1 -1
- package/lib/langium/validation/validation-contribution-collector.d.ts.map +1 -1
- package/lib/langium/validation/validation-contribution-collector.js.map +1 -1
- package/lib/langium/workspace/document-uri-policy.d.ts +17 -12
- package/lib/langium/workspace/document-uri-policy.d.ts.map +1 -1
- package/lib/langium/workspace/document-uri-policy.js +10 -9
- package/lib/langium/workspace/document-uri-policy.js.map +1 -1
- package/lib/langium/workspace/file-not-found.d.ts +17 -0
- package/lib/langium/workspace/file-not-found.d.ts.map +1 -0
- package/lib/langium/workspace/file-not-found.js +20 -0
- package/lib/langium/workspace/file-not-found.js.map +1 -0
- package/lib/langium/workspace/file-system-provider.d.ts +84 -8
- package/lib/langium/workspace/file-system-provider.d.ts.map +1 -1
- package/lib/langium/workspace/file-system-provider.js +93 -14
- package/lib/langium/workspace/file-system-provider.js.map +1 -1
- package/lib/langium/workspace/hydranium-langium-document-factory.d.ts +25 -0
- package/lib/langium/workspace/hydranium-langium-document-factory.d.ts.map +1 -1
- package/lib/langium/workspace/hydranium-langium-document-factory.js +25 -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 +81 -8
- package/lib/langium/workspace/hydranium-workspace-manager.d.ts.map +1 -1
- package/lib/langium/workspace/hydranium-workspace-manager.js +128 -10
- package/lib/langium/workspace/hydranium-workspace-manager.js.map +1 -1
- package/lib/langium/workspace/in-memory-file-system-provider.d.ts +25 -2
- package/lib/langium/workspace/in-memory-file-system-provider.d.ts.map +1 -1
- package/lib/langium/workspace/in-memory-file-system-provider.js +41 -15
- 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/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 +79 -17
- package/lib/langium/workspace/langium-documents.d.ts.map +1 -1
- package/lib/langium/workspace/langium-documents.js +91 -29
- package/lib/langium/workspace/langium-documents.js.map +1 -1
- package/lib/langium/workspace/persistent-file-system-provider.d.ts +0 -7
- package/lib/langium/workspace/persistent-file-system-provider.d.ts.map +1 -1
- package/lib/langium/workspace/persistent-file-system-provider.js +0 -7
- package/lib/langium/workspace/persistent-file-system-provider.js.map +1 -1
- package/lib/langium/workspace/virtual-document.d.ts +48 -15
- package/lib/langium/workspace/virtual-document.d.ts.map +1 -1
- package/lib/langium/workspace/virtual-document.js +78 -18
- package/lib/langium/workspace/virtual-document.js.map +1 -1
- package/lib/langium/workspace/write-lock-scope.d.ts +20 -10
- package/lib/langium/workspace/write-lock-scope.d.ts.map +1 -1
- package/lib/langium/workspace/write-lock-scope.js +12 -4
- package/lib/langium/workspace/write-lock-scope.js.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 +90 -79
- package/lib/lsp/hydranium-document-update-handler.d.ts.map +1 -1
- package/lib/lsp/hydranium-document-update-handler.js +152 -99
- 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 +54 -0
- package/lib/messages/carriers.d.ts.map +1 -0
- package/lib/messages/carriers.js +62 -0
- package/lib/messages/carriers.js.map +1 -0
- package/lib/messages/index.d.ts +25 -0
- package/lib/messages/index.d.ts.map +1 -0
- package/lib/messages/index.js +25 -0
- package/lib/messages/index.js.map +1 -0
- 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.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 -0
- package/lib/node/index.d.ts.map +1 -1
- package/lib/node/index.js +1 -0
- 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/measure-memory.d.ts.map +1 -1
- package/lib/node/measure-memory.js +1 -0
- package/lib/node/measure-memory.js.map +1 -1
- package/lib/node/memory-monitor.js.map +1 -1
- package/lib/node/node-file-system-provider.d.ts +39 -4
- package/lib/node/node-file-system-provider.d.ts.map +1 -1
- package/lib/node/node-file-system-provider.js +109 -49
- package/lib/node/node-file-system-provider.js.map +1 -1
- package/lib/node/process-memory.js.map +1 -1
- package/lib/node/profile-capture.d.ts +8 -2
- package/lib/node/profile-capture.d.ts.map +1 -1
- 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 +2 -2
- package/lib/node/profiling-run.d.ts.map +1 -1
- package/lib/node/profiling-run.js +1 -1
- package/lib/node/profiling-run.js.map +1 -1
- package/lib/node/rename-over-open-readers.d.ts +52 -0
- package/lib/node/rename-over-open-readers.d.ts.map +1 -0
- package/lib/node/rename-over-open-readers.js +66 -0
- package/lib/node/rename-over-open-readers.js.map +1 -0
- package/lib/node/socket-launcher.d.ts +16 -1
- package/lib/node/socket-launcher.d.ts.map +1 -1
- package/lib/node/socket-launcher.js +4 -3
- package/lib/node/socket-launcher.js.map +1 -1
- package/lib/node/stdio-launcher.d.ts +1 -1
- package/lib/node/stdio-launcher.d.ts.map +1 -1
- package/lib/node/stdio-launcher.js +1 -1
- package/lib/node/stdio-launcher.js.map +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.map +1 -1
- package/lib/testing/index.js +1 -0
- 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 +62 -14
- package/lib/testing/make-test-services.d.ts.map +1 -1
- package/lib/testing/make-test-services.js +30 -9
- package/lib/testing/make-test-services.js.map +1 -1
- package/lib/testing/make-test-tracer.js.map +1 -1
- 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 +11 -3
- package/lib/testing/node/lsp-server-connection.d.ts.map +1 -1
- package/lib/testing/node/lsp-server-connection.js +42 -9
- 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 +14 -0
- package/lib/testing/node/spawned-server.d.ts.map +1 -1
- package/lib/testing/node/spawned-server.js +33 -1
- 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 +14 -4
- package/lib/testing/playwright/server-log-capture.d.ts.map +1 -1
- package/lib/testing/playwright/server-log-capture.js +21 -4
- package/lib/testing/playwright/server-log-capture.js.map +1 -1
- 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 +4 -4
- package/lib/testing/run-update-pipeline.d.ts.map +1 -1
- package/lib/testing/stub-ast-document-manager.d.ts +10 -9
- package/lib/testing/stub-ast-document-manager.d.ts.map +1 -1
- package/lib/testing/stub-ast-document-manager.js +17 -9
- package/lib/testing/stub-ast-document-manager.js.map +1 -1
- package/lib/testing/stub-document-builder.d.ts +26 -11
- package/lib/testing/stub-document-builder.d.ts.map +1 -1
- package/lib/testing/stub-document-builder.js +57 -4
- package/lib/testing/stub-document-builder.js.map +1 -1
- package/lib/testing/stub-hydranium-text-documents.d.ts +22 -7
- package/lib/testing/stub-hydranium-text-documents.d.ts.map +1 -1
- package/lib/testing/stub-hydranium-text-documents.js +92 -15
- 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 +7 -6
- package/lib/testing/stub-model-service.d.ts.map +1 -1
- package/lib/testing/stub-model-service.js +4 -4
- package/lib/testing/stub-model-service.js.map +1 -1
- package/lib/testing/stub-project-manager.js.map +1 -1
- package/lib/testing/stub-service-registry.js.map +1 -1
- package/lib/util/connection-liveness.d.ts +7 -6
- package/lib/util/connection-liveness.d.ts.map +1 -1
- package/lib/util/connection-liveness.js +35 -14
- 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 +35 -26
- package/src/documents/ast-document-manager.ts +349 -65
- package/src/documents/client-ids.ts +5 -22
- package/src/documents/client-session-errors.ts +24 -0
- package/src/documents/client-session-registry.ts +240 -0
- package/src/documents/file-system-task-queue.ts +68 -0
- package/src/documents/hydranium-text-documents.ts +973 -202
- package/src/documents/index.ts +3 -0
- package/src/documents/language-client-text-shadow.ts +59 -11
- package/src/documents/self-save-registry.ts +52 -13
- package/src/index.ts +6 -0
- package/src/langium/ast-extension/ast-node-builder.ts +66 -22
- package/src/langium/bootstrap.ts +16 -9
- package/src/langium/config/configuration-provider.ts +119 -0
- package/src/langium/config/index.ts +1 -0
- package/src/langium/diagnostics/lsp-logger.ts +41 -6
- package/src/langium/document-builder/build-pipeline-integration.ts +50 -5
- package/src/langium/document-builder/build-session.ts +87 -0
- package/src/langium/document-builder/document-builder.ts +724 -46
- package/src/langium/document-builder/index.ts +1 -0
- package/src/langium/integration-services.ts +67 -6
- package/src/langium/integrity/integrity-rule.ts +13 -5
- package/src/langium/integrity/integrity-service.ts +229 -30
- 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 +42 -4
- package/src/langium/model-service/client-session.ts +606 -0
- package/src/langium/model-service/index.ts +1 -0
- package/src/langium/model-service/model-service.ts +418 -399
- package/src/langium/module.ts +193 -64
- package/src/langium/naming/name-provider.ts +27 -5
- package/src/langium/naming/name-separator-validation.ts +34 -5
- package/src/langium/project/abstract-project-manager.ts +9 -1
- package/src/langium/project/project-change-event.ts +2 -2
- package/src/langium/residency/cst-residency-service.ts +36 -14
- package/src/langium/scope/hydranium-scope-provider.ts +60 -22
- package/src/langium/serialization/abstract-serializer.ts +13 -32
- package/src/langium/service-registry.ts +19 -2
- package/src/langium/shared-services.ts +19 -2
- package/src/langium/transfer/transfer-encoder.ts +85 -24
- 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.ts +1 -1
- package/src/langium/validation/document-validator.ts +537 -11
- package/src/langium/workspace/document-uri-policy.ts +17 -12
- package/src/langium/workspace/file-not-found.ts +23 -0
- package/src/langium/workspace/file-system-provider.ts +153 -16
- package/src/langium/workspace/hydranium-langium-document-factory.ts +34 -0
- package/src/langium/workspace/hydranium-workspace-lock.ts +86 -2
- package/src/langium/workspace/hydranium-workspace-manager.ts +153 -13
- package/src/langium/workspace/in-memory-file-system-provider.ts +47 -16
- package/src/langium/workspace/initialize-workspace.ts +43 -5
- package/src/langium/workspace/langium-documents.ts +113 -33
- package/src/langium/workspace/persistent-file-system-provider.ts +0 -7
- package/src/langium/workspace/virtual-document.ts +96 -19
- package/src/langium/workspace/write-lock-scope.ts +24 -11
- 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 +182 -106
- 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 +78 -0
- package/src/messages/index.ts +36 -0
- package/src/messages/renderer.ts +212 -0
- package/src/node/heap-ceiling.ts +108 -0
- package/src/node/index.ts +1 -0
- package/src/node/latency-from-env.ts +1 -1
- package/src/node/measure-memory.ts +1 -0
- package/src/node/node-file-system-provider.ts +122 -51
- package/src/node/profile-capture.ts +8 -2
- package/src/node/profiling-run.ts +3 -3
- package/src/node/rename-over-open-readers.ts +78 -0
- package/src/node/socket-launcher.ts +19 -4
- package/src/node/stdio-launcher.ts +1 -2
- package/src/testing/fake-document.ts +24 -5
- package/src/testing/index.ts +1 -0
- 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 +106 -30
- 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 +61 -11
- package/src/testing/node/scratch-workspace.ts +10 -5
- package/src/testing/node/spawned-server.ts +35 -1
- package/src/testing/node/unhandled-rejections.ts +31 -0
- 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 +24 -5
- package/src/testing/playwright/server-log-rename-reporter.ts +12 -1
- package/src/testing/run-update-pipeline.ts +4 -4
- package/src/testing/stub-ast-document-manager.ts +28 -21
- package/src/testing/stub-document-builder.ts +83 -17
- package/src/testing/stub-hydranium-text-documents.ts +127 -22
- package/src/testing/stub-langium-documents.ts +3 -2
- package/src/testing/stub-model-service.ts +9 -8
- package/src/util/connection-liveness.ts +37 -14
- package/src/util/environment.ts +9 -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/src/lsp/instrument-connection.ts +0 -66
|
@@ -9,22 +9,18 @@
|
|
|
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
|
+
TIMED_OUT,
|
|
19
17
|
type TransferElement,
|
|
20
|
-
type
|
|
21
|
-
type Tracer,
|
|
22
|
-
type TransferSaveArgs,
|
|
23
|
-
type TransferUpdateArgs
|
|
18
|
+
type Tracer
|
|
24
19
|
} from '@hydranium/protocol';
|
|
25
20
|
import { type AstNode, DocumentState, type LangiumDocument, UriUtils, type URI } from '@hydranium/langium';
|
|
21
|
+
import { type AstDiagnostic } from '../validation/document-validator.js';
|
|
26
22
|
import { type DocumentUriPolicy } from '../workspace/document-uri-policy.js';
|
|
27
|
-
import { ReentrantWriteLockError, isInsideWriteLock } from '../workspace/write-lock-scope.js';
|
|
23
|
+
import { ReentrantWriteLockError, isInsideWriteLock, isWriteLockScopeInstalled } from '../workspace/write-lock-scope.js';
|
|
28
24
|
import { type CancellationToken, type Disposable } from 'vscode-languageserver';
|
|
29
25
|
import { AstDocument, type AstDocumentSavedEvent, type AstDocumentUpdatedEvent } from '../../documents/ast-document-manager.js';
|
|
30
26
|
import { isConnectionGoneError } from '../../util/connection-liveness.js';
|
|
@@ -32,19 +28,29 @@ import { type LogNameOptions } from '../diagnostics/logger.js';
|
|
|
32
28
|
import { IntegrityService } from '../integrity/integrity-service.js';
|
|
33
29
|
import { labelPhaseListener } from '../document-builder/labeled-phase-listener.js';
|
|
34
30
|
import { LANGUAGE_CLIENT_ID } from '../../documents/client-ids.js';
|
|
31
|
+
import { type OpenOptions } from '../../documents/client-session-registry.js';
|
|
35
32
|
import { type ServerSharedServices } from '../module.js';
|
|
36
|
-
|
|
37
|
-
/** Max time {@link ModelService.settleSave} waits for the build to settle and the sync chain to drain. */
|
|
38
|
-
const SAVE_SETTLE_TIMEOUT_MS = 10_000;
|
|
33
|
+
import { type ClientSession } from './client-session.js';
|
|
39
34
|
|
|
40
35
|
/**
|
|
41
|
-
*
|
|
42
|
-
*
|
|
43
|
-
*
|
|
44
|
-
*
|
|
45
|
-
*
|
|
36
|
+
* The undo-stack entry for a server-authored write pushed to the editor.
|
|
37
|
+
*
|
|
38
|
+
* **A user-facing LABEL, not a log string**, which is easy to miss because it
|
|
39
|
+
* travels as an options field rather than as a message: LSP specifies
|
|
40
|
+
* `ApplyWorkspaceEditParams.label` as "presented in the user interface for
|
|
41
|
+
* example on an undo stack to undo the workspace edit". So a user who edits
|
|
42
|
+
* through a form or drags a diagram node reads this in their editor's undo menu
|
|
43
|
+
* — which is why it is rendered like any other message the server sends rather
|
|
44
|
+
* than left as the English literal it was.
|
|
45
|
+
*
|
|
46
|
+
* Parameterless deliberately. The obvious improvement is to name the document,
|
|
47
|
+
* and it is the wrong one: an undo menu is already grouped under the file, so
|
|
48
|
+
* the URI would be noise in the one place it is redundant.
|
|
46
49
|
*/
|
|
47
|
-
|
|
50
|
+
export const MODEL_UPDATE_EDIT = defineMessage('hydranium/core/model-update-edit', 'Update Model');
|
|
51
|
+
|
|
52
|
+
/** Max time {@link DefaultModelService.settleSave} waits for the build to settle and the sync chain to drain. */
|
|
53
|
+
const SAVE_SETTLE_TIMEOUT_MS = 10_000;
|
|
48
54
|
|
|
49
55
|
/**
|
|
50
56
|
* Constructor options for {@link ModelService}. All fields are optional,
|
|
@@ -52,75 +58,46 @@ class SaveSettleTimeoutError extends Error {}
|
|
|
52
58
|
*/
|
|
53
59
|
export interface ModelServiceOptions extends LogNameOptions {
|
|
54
60
|
/**
|
|
55
|
-
*
|
|
56
|
-
*
|
|
57
|
-
*
|
|
58
|
-
* `
|
|
59
|
-
* `Logger.time` debug timing log is unchanged either way).
|
|
60
|
-
*
|
|
61
|
-
* Pure observability — does NOT abort the update, does NOT change
|
|
62
|
-
* resolution semantics. Adopters wanting a hard timeout that throws
|
|
63
|
-
* instead override {@link ModelService.update} on their subclass and
|
|
64
|
-
* race the parent call against their own deadline.
|
|
65
|
-
*
|
|
66
|
-
* Recommended starting threshold: 2-5 seconds for interactive paths
|
|
67
|
-
* (form save, diagram edit). Workspaces with very large documents
|
|
68
|
-
* or slow validation may legitimately exceed 5s on the cold path —
|
|
69
|
-
* tune per workspace.
|
|
70
|
-
*
|
|
71
|
-
* Accepts a {@link MaybeObservableValue} so the threshold can be a
|
|
72
|
-
* fixed constant or bound to a user setting via `Settings.number`
|
|
73
|
-
* and retuned live. Leaving it unset disables the warn line entirely
|
|
74
|
-
* (and skips the per-update stopwatch).
|
|
75
|
-
*/
|
|
76
|
-
readonly slowUpdateWarnMs?: MaybeObservableValue<number>;
|
|
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.
|
|
61
|
+
* Let the facade's build run without the workspace write lock when its
|
|
62
|
+
* caller already holds it: an integrity rule or build-phase pass that
|
|
63
|
+
* writes back through a session's `update` / `save`, or calls `rebuild`.
|
|
64
|
+
* Default `false`.
|
|
89
65
|
*
|
|
90
|
-
*
|
|
91
|
-
*
|
|
92
|
-
*
|
|
93
|
-
*
|
|
94
|
-
* `
|
|
95
|
-
*
|
|
96
|
-
*
|
|
66
|
+
* `WorkspaceLock` is not reentrant. Taking it from inside a holder cancels
|
|
67
|
+
* that holder and then waits for it to end, while the holder waits for this
|
|
68
|
+
* call, so neither completes. On `false` that call fails with
|
|
69
|
+
* {@link ReentrantWriteLockError} instead, wherever a host installs a
|
|
70
|
+
* write-lock scope tracker (`@hydranium/core/node` does at entry load); on
|
|
71
|
+
* `true` its build takes no lock. The wait after that build can still hang,
|
|
72
|
+
* because a document no build will carry is re-queued through the lock, and
|
|
73
|
+
* the re-queue waits for the holder to end.
|
|
97
74
|
*
|
|
98
|
-
*
|
|
99
|
-
*
|
|
100
|
-
*
|
|
101
|
-
*
|
|
102
|
-
*
|
|
103
|
-
*
|
|
104
|
-
*
|
|
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.
|
|
75
|
+
* Every other facade build takes the lock on either value. Unlocked, it can
|
|
76
|
+
* overlap another build of the same document: both run a full validation
|
|
77
|
+
* pass that Langium appends, and a caller can be handed a version that an
|
|
78
|
+
* integrity repair still running in the other build then moves past. Without
|
|
79
|
+
* a tracker the two cases cannot be told apart (see
|
|
80
|
+
* {@link isWriteLockScopeInstalled}), so `true` builds without the lock every
|
|
81
|
+
* time and accepts both.
|
|
110
82
|
*
|
|
111
83
|
* Accepts a {@link MaybeObservableValue} so it can be bound to a setting and
|
|
112
84
|
* flipped without a restart.
|
|
113
85
|
*/
|
|
114
|
-
readonly
|
|
86
|
+
readonly allowReentrantBuilds?: MaybeObservableValue<boolean>;
|
|
115
87
|
}
|
|
116
88
|
|
|
117
89
|
/**
|
|
90
|
+
* The seam every non-LSP head talks to: the data server, the GLSP head and an
|
|
91
|
+
* adopter's own services reach documents through this slot rather than through
|
|
92
|
+
* the workspace stores.
|
|
93
|
+
*
|
|
118
94
|
* In-process facade over the framework's document plumbing
|
|
119
95
|
* (`HydraniumTextDocuments`, `LangiumDocuments`,
|
|
120
|
-
* `DocumentBuilder`, `WritableFileSystemProvider`). Owns the
|
|
121
|
-
*
|
|
122
|
-
*
|
|
123
|
-
* doesn't have to be re-implemented per
|
|
96
|
+
* `DocumentBuilder`, `WritableFileSystemProvider`). Owns the document
|
|
97
|
+
* lifecycle the data-server and GLSP heads delegate to — client sessions that
|
|
98
|
+
* open, update, save and close documents, the phase reads, and `ready` — so
|
|
99
|
+
* coordinating those primitives doesn't have to be re-implemented per head.
|
|
100
|
+
* Every open and write goes through a session from {@link createSession}.
|
|
124
101
|
*
|
|
125
102
|
* "Model" here means the parsed AST — distinct from the wire-shape
|
|
126
103
|
* `TransferDocument` in `@hydranium/protocol`.
|
|
@@ -130,9 +107,9 @@ export interface ModelServiceOptions extends LogNameOptions {
|
|
|
130
107
|
* Multiple in-process consumers want the same workspace-level
|
|
131
108
|
* operations:
|
|
132
109
|
* - The data-server head turns these into typed RPC methods.
|
|
133
|
-
* - The GLSP head uses the same lifecycle for diagram-driven edits
|
|
134
|
-
*
|
|
135
|
-
*
|
|
110
|
+
* - The GLSP head uses the same lifecycle for diagram-driven edits: GModel
|
|
111
|
+
* operation handlers write through the diagram's session and wait on phases
|
|
112
|
+
* before reading.
|
|
136
113
|
* - Server-internal callers (integrity service, ad-hoc bridges, tests)
|
|
137
114
|
* want the same operations without the wire serialisation step.
|
|
138
115
|
*
|
|
@@ -145,15 +122,16 @@ export interface ModelServiceOptions extends LogNameOptions {
|
|
|
145
122
|
*
|
|
146
123
|
* **Read-latest supersession**
|
|
147
124
|
*
|
|
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
|
-
*
|
|
125
|
+
* A session's default `update` and `save` use Langium's per-URI
|
|
126
|
+
* `DocumentBuilder.waitUntil` to wait for `Validated` (the integrity-settled
|
|
127
|
+
* landmark {@link IntegrityService.SettledState} when rebuilds do not
|
|
128
|
+
* validate), then read the post-build state. Concurrent in-process callers
|
|
129
|
+
* on the same URI all see the latest post-build snapshot — none deadlock
|
|
130
|
+
* waiting for a specific version's settled event. Adopters wanting strict
|
|
131
|
+
* version-matched semantics (resolve with vN's snapshot specifically, log
|
|
132
|
+
* "vN superseded by vM at vN+1") override
|
|
133
|
+
* `DefaultClientSession.updateDocument` to attach a phase-listener with
|
|
134
|
+
* explicit version checks; the framework default doesn't need it for safety.
|
|
157
135
|
*
|
|
158
136
|
* **Returns AST snapshots, not wire envelopes**
|
|
159
137
|
*
|
|
@@ -173,20 +151,112 @@ export interface ModelServiceOptions extends LogNameOptions {
|
|
|
173
151
|
* by URI happens here so consumers can subscribe per-document without
|
|
174
152
|
* implementing the URI gate at each callsite.
|
|
175
153
|
*
|
|
154
|
+
* **Two families, and the distinction matters more than the names suggest.**
|
|
155
|
+
* `waitFor*` requests no build of its own: a wait on a URI with no document
|
|
156
|
+
* rejects, and one on a document no build will carry is re-queued by the
|
|
157
|
+
* builder's wait. `ensureDocumentState` and the phase shorthands over it
|
|
158
|
+
* *dispatch*: warm documents are awaited, cold ones are built.
|
|
159
|
+
*
|
|
160
|
+
* **Diagnostics are typed `never` below `Validated`.** Validation is the last
|
|
161
|
+
* phase, so at any earlier landmark the array either is not yet computed or
|
|
162
|
+
* still holds the previous build's, and reading it would take stale results
|
|
163
|
+
* for fresh ones. A caller that needs diagnostics asks for {@link validated}.
|
|
164
|
+
*
|
|
165
|
+
* What the `never` buys, exactly: reading a field off an element is a compile
|
|
166
|
+
* error, and nothing can be appended. It does NOT stop a caller assigning an
|
|
167
|
+
* element to a typed variable, because `never` is assignable to everything — so
|
|
168
|
+
* this is a guard against reaching for diagnostics by accident, not a seal
|
|
169
|
+
* against doing it deliberately.
|
|
170
|
+
*
|
|
171
|
+
* The waits resolve at or ABOVE their target, so an already-validated document
|
|
172
|
+
* does carry usable diagnostics and the `never` over-forbids there. That
|
|
173
|
+
* direction is the safe one: the alternative permits stale reads silently. A
|
|
174
|
+
* member taking a phase as a PARAMETER cannot judge statically and so returns
|
|
175
|
+
* `TDiagnostic`, leaving the choice to the caller.
|
|
176
|
+
*
|
|
176
177
|
* **Generic parameters.**
|
|
177
178
|
* - `TAst` — the AST root type each consumer expects on the returned
|
|
178
179
|
* {@link AstDocument}. Constrained to {@link AstNode}.
|
|
179
|
-
* - `TDiagnostic` —
|
|
180
|
-
* `
|
|
181
|
-
*
|
|
180
|
+
* - `TDiagnostic` — the AST-layer diagnostic: whatever the build left on
|
|
181
|
+
* `LangiumDocument.diagnostics`, carried through on the returned
|
|
182
|
+
* {@link AstDocument}. Defaults to {@link AstDiagnostic}.
|
|
183
|
+
* **Not the `TransferEncoder`'s parameter of the same name**, which is
|
|
184
|
+
* that encoder's OUTPUT and so names the wire shape. This one names its
|
|
185
|
+
* input, and an adopter binds the two to different types.
|
|
186
|
+
* - `TTransfer` — transfer-model root a session's `update` / `save` accept
|
|
182
187
|
* args. Constrained to {@link TransferElement}. Defaults to the
|
|
183
188
|
* structural base.
|
|
184
189
|
*/
|
|
185
|
-
export
|
|
190
|
+
export interface ModelService<
|
|
186
191
|
TAst extends AstNode,
|
|
187
|
-
TDiagnostic =
|
|
192
|
+
TDiagnostic extends AstDiagnostic = AstDiagnostic,
|
|
193
|
+
TTransfer extends TransferElement = TransferElement
|
|
194
|
+
> {
|
|
188
195
|
/**
|
|
189
|
-
*
|
|
196
|
+
* Resolves once the workspace has been initialised and its first build has
|
|
197
|
+
* completed — the gate every read should wait behind, since a document
|
|
198
|
+
* queried before it may be unbuilt and reach no phase.
|
|
199
|
+
*
|
|
200
|
+
* A property rather than a method, matching `ProjectManager.ready` and
|
|
201
|
+
* Langium's `WorkspaceManager.ready`. An implementation needing a stricter
|
|
202
|
+
* gate supplies a Promise that awaits its own concern as well.
|
|
203
|
+
*/
|
|
204
|
+
readonly ready: Promise<void>;
|
|
205
|
+
|
|
206
|
+
// Pure waits — never trigger a build.
|
|
207
|
+
waitForDocumentState(uri: string, state: DocumentState, cancelToken?: CancellationToken): Promise<AstDocument<TAst, TDiagnostic>>;
|
|
208
|
+
waitForDocumentSettled(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>>;
|
|
209
|
+
waitForBuilderState(state: DocumentState, cancelToken?: CancellationToken): Promise<void>;
|
|
210
|
+
|
|
211
|
+
// Wait if warm, build if cold.
|
|
212
|
+
ensureDocumentState(uri: string, state?: DocumentState, cancelToken?: CancellationToken): Promise<AstDocument<TAst, TDiagnostic>>;
|
|
213
|
+
rebuild(uri: string, state?: DocumentState, cancelToken?: CancellationToken): Promise<AstDocument<TAst, TDiagnostic>>;
|
|
214
|
+
parsed(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>>;
|
|
215
|
+
linked(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>>;
|
|
216
|
+
settled(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>>;
|
|
217
|
+
indexed(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>>;
|
|
218
|
+
validated(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, TDiagnostic>>;
|
|
219
|
+
|
|
220
|
+
isOpen(uri: string): boolean;
|
|
221
|
+
snapshot(uri: string): AstDocument<TAst, TDiagnostic> | undefined;
|
|
222
|
+
/**
|
|
223
|
+
* The text a session's write of `model` to `uri` applies: a textual model
|
|
224
|
+
* as given, a structured one rewritten and serialised.
|
|
225
|
+
*/
|
|
226
|
+
modelToText(uri: string, model: TTransfer | string, cancelToken?: CancellationToken): Promise<string>;
|
|
227
|
+
getDocument(uri: string): LangiumDocument | undefined;
|
|
228
|
+
|
|
229
|
+
onModelUpdated(uri: string, listener: (event: AstDocumentUpdatedEvent<TAst, TDiagnostic>) => void): Disposable;
|
|
230
|
+
onModelSaved(uri: string, listener: (event: AstDocumentSavedEvent<TAst, TDiagnostic>) => void): Disposable;
|
|
231
|
+
onClientClosed(uri: string, clientId: string, listener: () => void): Disposable;
|
|
232
|
+
|
|
233
|
+
/**
|
|
234
|
+
* Start a client session, the only way to open and write documents through
|
|
235
|
+
* this service. Pass a `label` naming the participant; without one it is
|
|
236
|
+
* `session`. The id defaults to `label#` plus a random UUID; a fixed
|
|
237
|
+
* `clientId` is taken as given. Throws `ReservedClientIdError` when the id
|
|
238
|
+
* is reserved by the framework, and `DuplicateClientIdError` when it is
|
|
239
|
+
* held by another live session or has documents open under it as a client
|
|
240
|
+
* that is not a session.
|
|
241
|
+
*
|
|
242
|
+
* `TOpenOptions` types the options the session's `open` takes and its
|
|
243
|
+
* `openOptions` returns. The narrowing is an unchecked cast, and it holds
|
|
244
|
+
* only for the caller that started the session: a holder reached through
|
|
245
|
+
* {@link getSession} sees plain `OpenOptions`.
|
|
246
|
+
*/
|
|
247
|
+
createSession<TOpenOptions extends OpenOptions = OpenOptions>(
|
|
248
|
+
label?: string,
|
|
249
|
+
clientId?: string
|
|
250
|
+
): ClientSession<TAst, TDiagnostic, TTransfer, TOpenOptions>;
|
|
251
|
+
/** The live session started under `clientId`, or `undefined` once it has ended or was never started. */
|
|
252
|
+
getSession(clientId: string): ClientSession<TAst, TDiagnostic, TTransfer> | undefined;
|
|
253
|
+
}
|
|
254
|
+
|
|
255
|
+
export class DefaultModelService<
|
|
256
|
+
TAst extends AstNode,
|
|
257
|
+
TDiagnostic extends AstDiagnostic = AstDiagnostic,
|
|
258
|
+
/**
|
|
259
|
+
* Structured payload a session's `update` / `save` accept. Constrained to
|
|
190
260
|
* {@link TransferElement} — the minimal `{ readonly $type: string }`
|
|
191
261
|
* shape. Both transfer-model overlay roots (which extend
|
|
192
262
|
* `TransferElement` explicitly) and AST root types (which have
|
|
@@ -195,7 +265,7 @@ export class ModelService<
|
|
|
195
265
|
* integrity service) that pass AST roots remain compatible.
|
|
196
266
|
*/
|
|
197
267
|
TTransfer extends TransferElement = TransferElement
|
|
198
|
-
> {
|
|
268
|
+
> implements ModelService<TAst, TDiagnostic, TTransfer> {
|
|
199
269
|
protected readonly tracer: Tracer;
|
|
200
270
|
/**
|
|
201
271
|
* The single document-identity seam (`services.workspace.DocumentUriPolicy`),
|
|
@@ -206,14 +276,8 @@ export class ModelService<
|
|
|
206
276
|
* (see {@link DocumentUriPolicy}).
|
|
207
277
|
*/
|
|
208
278
|
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>;
|
|
279
|
+
/** See {@link ModelServiceOptions.allowReentrantBuilds}. Defaults to `false`. */
|
|
280
|
+
protected readonly allowReentrantBuilds: ObservableValue<boolean>;
|
|
217
281
|
|
|
218
282
|
/**
|
|
219
283
|
* Per-URI applyEdit coalescing: at most one in-flight `applyEditToLanguageClient`
|
|
@@ -224,6 +288,16 @@ export class ModelService<
|
|
|
224
288
|
protected readonly syncChains = new Map<string, Promise<void>>();
|
|
225
289
|
protected readonly pendingSync = new Map<string, string>();
|
|
226
290
|
|
|
291
|
+
/** The live sessions this service started, by client id, for {@link getSession}. */
|
|
292
|
+
protected readonly sessions = new Map<string, ClientSession<TAst, TDiagnostic, TTransfer>>();
|
|
293
|
+
/**
|
|
294
|
+
* Drops an ended session from {@link sessions}. Subscribed by the first
|
|
295
|
+
* {@link createSession} rather than at construction, so a services tree with
|
|
296
|
+
* no text store, or one that knows nothing of sessions, still constructs
|
|
297
|
+
* this service.
|
|
298
|
+
*/
|
|
299
|
+
protected sessionCloseListener?: Disposable;
|
|
300
|
+
|
|
227
301
|
/**
|
|
228
302
|
* Workspace-level readiness gate. Resolves when the framework has
|
|
229
303
|
* finished its first workspace build cycle and the `ModelService`
|
|
@@ -264,21 +338,17 @@ export class ModelService<
|
|
|
264
338
|
) {
|
|
265
339
|
this.tracer = services.Tracer.for(options.logName ?? 'ModelService').trace('instantiated');
|
|
266
340
|
this.uriPolicy = services.workspace.DocumentUriPolicy;
|
|
267
|
-
this.
|
|
268
|
-
this.serializeBuilds = ObservableValue.from(options.serializeBuilds ?? true);
|
|
341
|
+
this.allowReentrantBuilds = ObservableValue.from(options.allowReentrantBuilds ?? false);
|
|
269
342
|
// Optional-chain so a harness that binds no WorkspaceManager awaits
|
|
270
343
|
// `undefined` and resolves immediately; production hosts always have it
|
|
271
344
|
// bound.
|
|
272
345
|
// Deliberately NO fallback to Langium's `ready`: it resolves pre-build,
|
|
273
346
|
// so falling back to it would silently reinstate the very gap this gate
|
|
274
347
|
// 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
348
|
this.ready = (async () => {
|
|
279
349
|
try {
|
|
280
350
|
await services.workspace.WorkspaceManager?.workspaceInitialized;
|
|
281
|
-
} catch
|
|
351
|
+
} catch {
|
|
282
352
|
// NEVER rejects, deliberately. This gate is about TIMING — "the
|
|
283
353
|
// initial build has finished" — not about whether it succeeded, and
|
|
284
354
|
// Langium's `ready` (what it replaced) could not reject at all.
|
|
@@ -286,8 +356,8 @@ export class ModelService<
|
|
|
286
356
|
// build (routine — any write preempts one) and on a failed one
|
|
287
357
|
// (e.g. a disposed connection at teardown). Propagating either would
|
|
288
358
|
// fail every `waitForReady` for the rest of the process lifetime,
|
|
289
|
-
// a far worse failure than the late gate this exists to fix.
|
|
290
|
-
|
|
359
|
+
// a far worse failure than the late gate this exists to fix. The
|
|
360
|
+
// workspace manager logs the outcome.
|
|
291
361
|
}
|
|
292
362
|
})();
|
|
293
363
|
// One persistent listener mirroring non-LSP-client changes back to the LSP
|
|
@@ -311,8 +381,7 @@ export class ModelService<
|
|
|
311
381
|
/**
|
|
312
382
|
* Wait for the document at `uri` to reach `state`. Pure wait — does
|
|
313
383
|
* not trigger a build. If `uri` is not yet in the document registry
|
|
314
|
-
* the call
|
|
315
|
-
* pipeline; for the cold-start case use {@link rebuild} instead.
|
|
384
|
+
* the call rejects; for the cold-start case use {@link rebuild} instead.
|
|
316
385
|
*
|
|
317
386
|
* Wrapped in a debug-level timing log via {@link Tracer.time} so
|
|
318
387
|
* slow per-URI waits surface in build telemetry; the URI is
|
|
@@ -329,8 +398,12 @@ export class ModelService<
|
|
|
329
398
|
* {@link waitForDocumentState} for the common "wait until content is stable"
|
|
330
399
|
* case (e.g. settling a save). Pure wait — does not trigger a build.
|
|
331
400
|
*/
|
|
332
|
-
async waitForDocumentSettled(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst,
|
|
333
|
-
return this.waitForDocumentStateCanonical(
|
|
401
|
+
async waitForDocumentSettled(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>> {
|
|
402
|
+
return (await this.waitForDocumentStateCanonical(
|
|
403
|
+
this.uriPolicy.canonicalUri(uri),
|
|
404
|
+
IntegrityService.SettledState,
|
|
405
|
+
cancelToken
|
|
406
|
+
)) as AstDocument<TAst, never>;
|
|
334
407
|
}
|
|
335
408
|
|
|
336
409
|
/**
|
|
@@ -380,31 +453,35 @@ export class ModelService<
|
|
|
380
453
|
* Force a fresh build of the document at `uri` and wait for it to
|
|
381
454
|
* reach `state` (or the integrity-settled landmark
|
|
382
455
|
* {@link IntegrityService.SettledState} if omitted).
|
|
383
|
-
* Always
|
|
384
|
-
*
|
|
385
|
-
* you want to re-process from scratch.
|
|
456
|
+
* Always builds the document, whether or not it is already in the
|
|
457
|
+
* registry, in a build of its own or in one already scheduled that carries
|
|
458
|
+
* it — call this when you want to re-process from scratch.
|
|
386
459
|
*
|
|
387
|
-
* The facade is responsible for
|
|
388
|
-
* directly because Langium's `DefaultDocumentUpdateHandler.didChangeContent`
|
|
460
|
+
* The facade is responsible for requesting the build itself because Langium's `DefaultDocumentUpdateHandler.didChangeContent`
|
|
389
461
|
* (the standard text-document → builder bridge) only runs under an
|
|
390
462
|
* LSP `Connection`. Running headless the bridge never fires; the
|
|
391
463
|
* facade stands in for it on its own update path.
|
|
392
464
|
*
|
|
393
465
|
* 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
|
|
466
|
+
* fine: the LSP head builds from the LSP-driven event and the facade from
|
|
467
|
+
* its own RPC-driven event — both legitimate — and both go through
|
|
468
|
+
* `HydraniumDocumentBuilder.scheduleUpdate`, which serialises them under
|
|
469
|
+
* the workspace WRITE lock and lets the second share the first's build
|
|
470
|
+
* where that build carries it. Langium alone does not coalesce concurrent
|
|
471
|
+
* builds of one URI: two unserialised builds each run a full validation
|
|
472
|
+
* pass and Langium appends the second set onto the first, duplicating every
|
|
473
|
+
* diagnostic. A caller that already holds the lock builds without it only
|
|
474
|
+
* under {@link ModelServiceOptions.allowReentrantBuilds} — see there for the
|
|
475
|
+
* non-reentrancy hazard.
|
|
476
|
+
*
|
|
477
|
+
* An override calls the base before it awaits. Under an LSP connection the
|
|
478
|
+
* store's change event has already asked the update handler to build a
|
|
479
|
+
* session's write; an override whose await outlasts that build makes the
|
|
480
|
+
* base's request start a build of its own, so the write is built and
|
|
481
|
+
* delivered twice.
|
|
404
482
|
*
|
|
405
|
-
*
|
|
406
|
-
*
|
|
407
|
-
* on their subclass.
|
|
483
|
+
* Rejects when the build leaves no document for `uri`, as for a URI with
|
|
484
|
+
* neither a file nor text: the wait after it has nothing to wait on.
|
|
408
485
|
*
|
|
409
486
|
* Consumers wanting "give me this doc at state X, building only if
|
|
410
487
|
* needed" — use the per-state methods ({@link parsed} / {@link linked}
|
|
@@ -416,8 +493,8 @@ export class ModelService<
|
|
|
416
493
|
|
|
417
494
|
/**
|
|
418
495
|
* Internal build core operating on an already-{@link CanonicalUri canonical}
|
|
419
|
-
* URI — the build counterpart to {@link waitForDocumentStateCanonical}.
|
|
420
|
-
*
|
|
496
|
+
* URI — the build counterpart to {@link waitForDocumentStateCanonical}.
|
|
497
|
+
* Requests the build, then waits via the canonical wait core, so the
|
|
421
498
|
* identity is resolved once at the public door and neither sink re-runs the
|
|
422
499
|
* `realpath`. (`DocumentBuilder.update` still resolves each URI internally for
|
|
423
500
|
* directory flattening — that is the build's own existence-aware resolution,
|
|
@@ -429,46 +506,33 @@ export class ModelService<
|
|
|
429
506
|
cancelToken?: CancellationToken
|
|
430
507
|
): Promise<AstDocument<TAst, TDiagnostic>> {
|
|
431
508
|
const documentUri = UriUtils.toUri(uri);
|
|
432
|
-
// Runs under the workspace WRITE lock,
|
|
433
|
-
// `
|
|
434
|
-
//
|
|
509
|
+
// Runs under the workspace WRITE lock, through the builder's
|
|
510
|
+
// `scheduleUpdate` like the LSP update handler's build, so the build the
|
|
511
|
+
// store's change event already scheduled for this write carries this
|
|
512
|
+
// request too rather than being cancelled by it.
|
|
435
513
|
//
|
|
436
514
|
// Unlocked, this build races the LSP bridge's build of the same URI: both
|
|
437
515
|
// 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
|
|
516
|
+
// facade stands in for it headless), and nothing serialises the two, so
|
|
517
|
+
// both reach `Validated`, and because each computes its missing
|
|
441
518
|
// validation categories before the other has recorded its own, both run a
|
|
442
519
|
// FULL pass and Langium appends the second onto the first (its append is
|
|
443
520
|
// meant for category-partitioned passes). The user-visible result is every
|
|
444
521
|
// diagnostic duplicated, plus double the validation work per write.
|
|
445
522
|
//
|
|
446
|
-
//
|
|
447
|
-
// the
|
|
448
|
-
|
|
449
|
-
|
|
450
|
-
|
|
451
|
-
|
|
452
|
-
|
|
453
|
-
|
|
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()) {
|
|
523
|
+
// A caller already inside the lock would cancel its own build and stall in
|
|
524
|
+
// the wait below; `allowReentrantBuilds` builds it unlocked, and without a
|
|
525
|
+
// tracker it cannot be told apart from any other caller.
|
|
526
|
+
const inside = isInsideWriteLock();
|
|
527
|
+
if (this.allowReentrantBuilds.value && (inside || !isWriteLockScopeInstalled())) {
|
|
528
|
+
await this.services.workspace.DocumentBuilder.update([documentUri], [], cancelToken);
|
|
529
|
+
} else {
|
|
530
|
+
if (inside) {
|
|
461
531
|
throw new ReentrantWriteLockError(uri);
|
|
462
532
|
}
|
|
463
|
-
// The lock's
|
|
464
|
-
//
|
|
465
|
-
|
|
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 {
|
|
471
|
-
await this.services.workspace.DocumentBuilder.update([documentUri], [], cancelToken);
|
|
533
|
+
// The build runs on the lock's own token, which a later write cancels;
|
|
534
|
+
// the caller's token governs only the phase wait below.
|
|
535
|
+
await this.services.workspace.DocumentBuilder.scheduleUpdate([documentUri], []);
|
|
472
536
|
}
|
|
473
537
|
return this.waitForDocumentStateCanonical(uri, state ?? IntegrityService.SettledState, cancelToken);
|
|
474
538
|
}
|
|
@@ -484,11 +548,19 @@ export class ModelService<
|
|
|
484
548
|
*
|
|
485
549
|
* Phase invariants encoded in the return type:
|
|
486
550
|
* - `parsed` / `linked` / `settled` / `indexed` return
|
|
487
|
-
* `AstDocument<TAst, never>` — diagnostics
|
|
488
|
-
*
|
|
551
|
+
* `AstDocument<TAst, never>` — no diagnostics have been computed at
|
|
552
|
+
* those phases.
|
|
489
553
|
* - `validated` returns `AstDocument<TAst, TDiagnostic>` — diagnostics
|
|
490
554
|
* are populated.
|
|
491
555
|
*
|
|
556
|
+
* **The `never` is enforced, not merely declared.** The wait underneath
|
|
557
|
+
* resolves at or ABOVE the requested state, so a document something else
|
|
558
|
+
* already carried past `Validated` would otherwise come back from
|
|
559
|
+
* `settled()` carrying a full diagnostics array typed `never`; these four
|
|
560
|
+
* strip it. An empty array here therefore means "this read does not report
|
|
561
|
+
* diagnostics", never "this document is clean" — call {@link validated}
|
|
562
|
+
* when the answer has to mean the second.
|
|
563
|
+
*
|
|
492
564
|
* `settled` is the integrity-overlay name for "all integrity rules
|
|
493
565
|
* have fired"; it maps to {@link IntegrityService.SettledState} (which
|
|
494
566
|
* equals `DocumentState.IndexedReferences`), but the dedicated method
|
|
@@ -496,19 +568,19 @@ export class ModelService<
|
|
|
496
568
|
* ever moves.
|
|
497
569
|
*/
|
|
498
570
|
async parsed(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>> {
|
|
499
|
-
return this.ensureDocumentState(uri, DocumentState.Parsed, cancelToken)
|
|
571
|
+
return this.withoutDiagnostics(await this.ensureDocumentState(uri, DocumentState.Parsed, cancelToken));
|
|
500
572
|
}
|
|
501
573
|
|
|
502
574
|
async linked(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>> {
|
|
503
|
-
return this.ensureDocumentState(uri, DocumentState.Linked, cancelToken)
|
|
575
|
+
return this.withoutDiagnostics(await this.ensureDocumentState(uri, DocumentState.Linked, cancelToken));
|
|
504
576
|
}
|
|
505
577
|
|
|
506
578
|
async settled(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>> {
|
|
507
|
-
return this.ensureDocumentState(uri, IntegrityService.SettledState, cancelToken)
|
|
579
|
+
return this.withoutDiagnostics(await this.ensureDocumentState(uri, IntegrityService.SettledState, cancelToken));
|
|
508
580
|
}
|
|
509
581
|
|
|
510
582
|
async indexed(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>> {
|
|
511
|
-
return this.ensureDocumentState(uri, DocumentState.IndexedReferences, cancelToken)
|
|
583
|
+
return this.withoutDiagnostics(await this.ensureDocumentState(uri, DocumentState.IndexedReferences, cancelToken));
|
|
512
584
|
}
|
|
513
585
|
|
|
514
586
|
async validated(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, TDiagnostic>> {
|
|
@@ -557,115 +629,14 @@ export class ModelService<
|
|
|
557
629
|
return this.rebuild(uri, target, cancelToken);
|
|
558
630
|
}
|
|
559
631
|
|
|
560
|
-
/**
|
|
561
|
-
* Apply an update for `uri`. The structured-or-textual `model` payload
|
|
562
|
-
* is serialised (via {@link serialize} after {@link rewriteModel} when
|
|
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
632
|
/**
|
|
662
633
|
* Wait for the document at `uri` to reach the integrity-settled landmark and
|
|
663
634
|
* drain any in-flight write-path applyEdit sync chain (see {@link syncChains})
|
|
664
635
|
* so every language client reflects the latest content before a save returns.
|
|
665
636
|
* No-op tail for headless adopters — `syncChains` is empty without an LSP
|
|
666
637
|
* client. Bounded by {@link SAVE_SETTLE_TIMEOUT_MS} so a hung build, or an
|
|
667
|
-
* applyEdit reverse-RPC deadlock, can't freeze the caller; on timeout
|
|
668
|
-
* a warning and returns rather than throwing.
|
|
638
|
+
* applyEdit reverse-RPC deadlock, can't freeze the caller; on timeout or a
|
|
639
|
+
* failed wait it logs a warning and returns rather than throwing.
|
|
669
640
|
*
|
|
670
641
|
* Adopters with a save flow that must converge editor + disk before returning
|
|
671
642
|
* (e.g. a dual form/code editor that would otherwise show a content-conflict
|
|
@@ -674,57 +645,24 @@ export class ModelService<
|
|
|
674
645
|
protected async settleSave(uri: string, cancelToken?: CancellationToken): Promise<void> {
|
|
675
646
|
const canonical = this.uriPolicy.canonicalUri(uri);
|
|
676
647
|
const key = UriUtils.toUri(canonical).toString();
|
|
677
|
-
|
|
678
|
-
|
|
679
|
-
)
|
|
648
|
+
// One race over both waits, so the bound is one deadline for the pair;
|
|
649
|
+
// a race per wait would let the save take twice the bound.
|
|
650
|
+
const settled = (async (): Promise<void> => {
|
|
651
|
+
await this.waitForDocumentStateCanonical(canonical, IntegrityService.SettledState, cancelToken);
|
|
652
|
+
await this.syncChains.get(key);
|
|
653
|
+
})();
|
|
680
654
|
try {
|
|
681
|
-
await
|
|
682
|
-
const pending = this.syncChains.get(key);
|
|
683
|
-
if (pending) {
|
|
684
|
-
await Promise.race([pending, timeout]);
|
|
685
|
-
}
|
|
686
|
-
} catch (err: unknown) {
|
|
687
|
-
if (err instanceof SaveSettleTimeoutError) {
|
|
655
|
+
if ((await this.services.Clock.raceTimer(settled, SAVE_SETTLE_TIMEOUT_MS)) === TIMED_OUT) {
|
|
688
656
|
this.tracer.withUri(key).warn(`Save settle exceeded ${SAVE_SETTLE_TIMEOUT_MS}ms — returning anyway`);
|
|
689
|
-
} else {
|
|
690
|
-
const detail = err instanceof Error ? (err.stack ?? err.message) : String(err);
|
|
691
|
-
this.tracer.withUri(key).warn(`Save settle failed before the timeout — returning anyway. ${detail}`);
|
|
692
657
|
}
|
|
658
|
+
} catch (err: unknown) {
|
|
659
|
+
// A failed wait, such as a cancelled token or a document the builder
|
|
660
|
+
// does not hold, gets its own line so it is not blamed on the bound.
|
|
661
|
+
const detail = err instanceof Error ? (err.stack ?? err.message) : String(err);
|
|
662
|
+
this.tracer.withUri(key).warn(`Save settle failed before the timeout — returning anyway. ${detail}`);
|
|
693
663
|
}
|
|
694
664
|
}
|
|
695
665
|
|
|
696
|
-
/**
|
|
697
|
-
* Open the document at `args.uri` on behalf of `args.clientId`.
|
|
698
|
-
* Multi-client: each (uri, clientId) pair is tracked as one
|
|
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.
|
|
714
|
-
*/
|
|
715
|
-
async open(args: OpenModelArgs): Promise<Disposable> {
|
|
716
|
-
return this.services.workspace.AstDocumentManager.open(args);
|
|
717
|
-
}
|
|
718
|
-
|
|
719
|
-
/**
|
|
720
|
-
* Close the document at `args.uri` for `args.clientId`. Counterpart
|
|
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);
|
|
726
|
-
}
|
|
727
|
-
|
|
728
666
|
/**
|
|
729
667
|
* True when the document at `uri` is currently open for at least one
|
|
730
668
|
* client. Pure read; no side effects.
|
|
@@ -733,6 +671,31 @@ export class ModelService<
|
|
|
733
671
|
return this.services.workspace.AstDocumentManager.isOpen(uri);
|
|
734
672
|
}
|
|
735
673
|
|
|
674
|
+
/**
|
|
675
|
+
* Snapshot of `uri` as it stands RIGHT NOW — the synchronous sibling of the
|
|
676
|
+
* phase reads, which all wait. `undefined` when no document is registered.
|
|
677
|
+
*
|
|
678
|
+
* **This is what a writer wants, and {@link getDocument} is not.** The
|
|
679
|
+
* envelope's `version` is copied by value at projection time, so it cannot
|
|
680
|
+
* move afterwards; a version read off the live document at write time is
|
|
681
|
+
* whatever the server is at *now*, which is the number an optimistic gate is
|
|
682
|
+
* about to compare it against.
|
|
683
|
+
*
|
|
684
|
+
* Diagnostics only from a document that has reached `Validated`, and an
|
|
685
|
+
* empty array otherwise. Unlike the phase reads this one names no phase, so
|
|
686
|
+
* the state it finds is the only thing that can say whether the array
|
|
687
|
+
* describes the content being handed back or whatever an earlier build left.
|
|
688
|
+
* A caller that needs them unconditionally waits, via {@link validated}.
|
|
689
|
+
*/
|
|
690
|
+
snapshot(uri: string): AstDocument<TAst, TDiagnostic> | undefined {
|
|
691
|
+
const document = this.getDocument(uri);
|
|
692
|
+
if (!document) {
|
|
693
|
+
return undefined;
|
|
694
|
+
}
|
|
695
|
+
const envelope = AstDocument.from<TAst, TDiagnostic>(document);
|
|
696
|
+
return document.state >= DocumentState.Validated ? envelope : this.withoutDiagnostics(envelope);
|
|
697
|
+
}
|
|
698
|
+
|
|
736
699
|
/**
|
|
737
700
|
* The built {@link LangiumDocument} for `uri`, looked up by canonical identity —
|
|
738
701
|
* the synchronous, phase-agnostic sibling of {@link ensureDocumentState} /
|
|
@@ -741,11 +704,92 @@ export class ModelService<
|
|
|
741
704
|
* into `LangiumDocuments` directly: a symlinked / `..` / case-divergent URI
|
|
742
705
|
* still resolves to the one document the build keys by its real path. Returns
|
|
743
706
|
* `undefined` if no document is registered for `uri`.
|
|
707
|
+
*
|
|
708
|
+
* **Live, so do not take a based-on version off it.** `textDocument` is the
|
|
709
|
+
* store's own object rather than a copy, so `.version` read here answers for
|
|
710
|
+
* the moment of the READ, not the moment of the earlier content — pass it to
|
|
711
|
+
* a write and the server compares its current version against itself, the
|
|
712
|
+
* gate passes unconditionally, and a concurrent edit is overwritten with
|
|
713
|
+
* nothing logged. Use {@link snapshot} for that, or a phase read.
|
|
744
714
|
*/
|
|
745
715
|
getDocument(uri: string): LangiumDocument | undefined {
|
|
746
716
|
return this.services.workspace.AstDocumentManager.getDocument(uri);
|
|
747
717
|
}
|
|
748
718
|
|
|
719
|
+
// ============================================================
|
|
720
|
+
// Client sessions
|
|
721
|
+
// ============================================================
|
|
722
|
+
|
|
723
|
+
createSession<TOpenOptions extends OpenOptions = OpenOptions>(
|
|
724
|
+
label?: string,
|
|
725
|
+
clientId?: string
|
|
726
|
+
): ClientSession<TAst, TDiagnostic, TTransfer, TOpenOptions> {
|
|
727
|
+
const sessionLabel = label ?? 'session';
|
|
728
|
+
const id = clientId ?? `${sessionLabel}#${globalThis.crypto.randomUUID()}`;
|
|
729
|
+
const textDocuments = this.services.workspace.TextDocuments;
|
|
730
|
+
textDocuments.registerSession(id);
|
|
731
|
+
this.sessionCloseListener ??= textDocuments.onDidCloseSession(event => {
|
|
732
|
+
// Also reached when the store ends a session directly; disposing the
|
|
733
|
+
// handle makes its later calls fail rather than write under an id
|
|
734
|
+
// this service no longer treats as a session.
|
|
735
|
+
this.sessions.get(event.clientId)?.dispose();
|
|
736
|
+
this.sessions.delete(event.clientId);
|
|
737
|
+
});
|
|
738
|
+
let session: ClientSession<TAst, TDiagnostic, TTransfer, TOpenOptions>;
|
|
739
|
+
try {
|
|
740
|
+
// Unchecked: the session keeps whatever options its `open` is handed,
|
|
741
|
+
// and the factory types it for every grammar, so the narrowed type
|
|
742
|
+
// holds only for the caller that started it.
|
|
743
|
+
session = this.services.model.ClientSessionFactory.create(id, sessionLabel) as ClientSession<
|
|
744
|
+
TAst,
|
|
745
|
+
TDiagnostic,
|
|
746
|
+
TTransfer,
|
|
747
|
+
TOpenOptions
|
|
748
|
+
>;
|
|
749
|
+
} catch (err: unknown) {
|
|
750
|
+
textDocuments.closeSession(id);
|
|
751
|
+
throw err;
|
|
752
|
+
}
|
|
753
|
+
this.sessions.set(id, session);
|
|
754
|
+
return session;
|
|
755
|
+
}
|
|
756
|
+
|
|
757
|
+
getSession(clientId: string): ClientSession<TAst, TDiagnostic, TTransfer> | undefined {
|
|
758
|
+
return this.sessions.get(clientId);
|
|
759
|
+
}
|
|
760
|
+
|
|
761
|
+
/**
|
|
762
|
+
* Convert a structured-or-textual `model` payload to its textual form.
|
|
763
|
+
*
|
|
764
|
+
* Textual payloads (LSP / pre-serialised callers) pass through untouched.
|
|
765
|
+
* Structured payloads run the per-language `UpdateRewriteService` chain
|
|
766
|
+
* (transfer-model transforms; diff-aware rewrites see the previous AST root),
|
|
767
|
+
* then serialise. The chain is the single transfer-model-transform seam — a
|
|
768
|
+
* unary normalisation is just a rewrite that ignores `previous`, as
|
|
769
|
+
* `NormalizeEmptyStringsContribution` does. The chain is empty by
|
|
770
|
+
* default, so this is a no-op for adopters that register none.
|
|
771
|
+
*/
|
|
772
|
+
async modelToText(uri: string, model: TTransfer | string, cancelToken?: CancellationToken): Promise<string> {
|
|
773
|
+
if (typeof model === 'string') {
|
|
774
|
+
return model;
|
|
775
|
+
}
|
|
776
|
+
const rewritten = await this.rewriteModel(uri, model, cancelToken);
|
|
777
|
+
const target = UriUtils.toUri(uri);
|
|
778
|
+
const trivia = this.services.ServiceRegistry?.getServices(target)?.trivia?.TriviaService;
|
|
779
|
+
// Extracted BEFORE serializing, so it reads the document the write is
|
|
780
|
+
// about to replace rather than whatever a concurrent build left behind.
|
|
781
|
+
let document = this.services.workspace.LangiumDocuments.getDocument(target);
|
|
782
|
+
if (trivia !== undefined && document === undefined) {
|
|
783
|
+
const source = await this.textToTakeTriviaFrom(uri, target);
|
|
784
|
+
if (source !== undefined) {
|
|
785
|
+
document = this.services.workspace.LangiumDocumentFactory.fromString(source, target);
|
|
786
|
+
}
|
|
787
|
+
}
|
|
788
|
+
const extracted = trivia !== undefined && document !== undefined ? trivia.extract(document) : undefined;
|
|
789
|
+
const serialized = await this.serialize(uri, rewritten);
|
|
790
|
+
return extracted === undefined ? serialized : trivia!.apply(serialized, extracted, target);
|
|
791
|
+
}
|
|
792
|
+
|
|
749
793
|
// ============================================================
|
|
750
794
|
// LSP-client sync (mirror non-LSP-client changes back to Monaco)
|
|
751
795
|
// ============================================================
|
|
@@ -754,18 +798,14 @@ export class ModelService<
|
|
|
754
798
|
* Mirror a server-side change of `document` back to the LSP textual language
|
|
755
799
|
* client, run per document as it reaches the post-integrity settled phase.
|
|
756
800
|
* The single framework caller of
|
|
757
|
-
* `HydraniumTextDocuments.applyEditToLanguageClient
|
|
758
|
-
* `HydraniumTextDocuments.stagePendingContent`.
|
|
759
|
-
*
|
|
760
|
-
* Routes to one of two mechanisms by language-client registration, because
|
|
761
|
-
* an open and a closed document answer different questions:
|
|
801
|
+
* `HydraniumTextDocuments.applyEditToLanguageClient`.
|
|
762
802
|
*
|
|
763
|
-
*
|
|
764
|
-
*
|
|
765
|
-
*
|
|
766
|
-
*
|
|
767
|
-
*
|
|
768
|
-
*
|
|
803
|
+
* Only a document open in the language client is mirrored, through
|
|
804
|
+
* {@link syncOpenDocument}, routed purely by **content**. A document open
|
|
805
|
+
* only in another client needs nothing: a language client opening it joins
|
|
806
|
+
* the existing entry and is refreshed from the store. A session writes only
|
|
807
|
+
* what it has open, so no session edit of a closed document waits here for
|
|
808
|
+
* the language client's next open.
|
|
769
809
|
*
|
|
770
810
|
* The decision is **re-derived from the current settled state every time** (it
|
|
771
811
|
* is not a one-shot enrolment), which is what makes it self-healing: a doc
|
|
@@ -775,9 +815,9 @@ export class ModelService<
|
|
|
775
815
|
*/
|
|
776
816
|
protected syncToLanguageClient(document: LangiumDocument): void {
|
|
777
817
|
// `document.textDocument.uri` is the server-identity (canonical) URI off the
|
|
778
|
-
// build. Route by
|
|
779
|
-
//
|
|
780
|
-
//
|
|
818
|
+
// build. Route by client registration (presence questions — both
|
|
819
|
+
// predicates canonicalize internally, so a divergent open path still
|
|
820
|
+
// resolves to the same record), but key the outbound sync by this
|
|
781
821
|
// CANONICAL URI — the same key `settleSave` looks the chain up under —
|
|
782
822
|
// so a save-settle can drain the in-flight applyEdit. The canonical→client-URI
|
|
783
823
|
// translation (a symlinked path the client opened, or a dual-open fan-out)
|
|
@@ -787,8 +827,6 @@ export class ModelService<
|
|
|
787
827
|
// the drain would miss for a divergent open path.
|
|
788
828
|
if (this.services.workspace.TextDocuments.isOpenInLanguageClient(document.textDocument.uri)) {
|
|
789
829
|
this.syncOpenDocument(document.textDocument.uri, document.textDocument.getText());
|
|
790
|
-
} else {
|
|
791
|
-
this.stageClosedDocument(document);
|
|
792
830
|
}
|
|
793
831
|
}
|
|
794
832
|
|
|
@@ -807,46 +845,6 @@ export class ModelService<
|
|
|
807
845
|
this.queueSync(uri, text);
|
|
808
846
|
}
|
|
809
847
|
|
|
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
848
|
/**
|
|
851
849
|
* Enqueue a sync to the language client. The pending slot per URI holds only
|
|
852
850
|
* the latest text: if a newer settle fires while the current RPC is in
|
|
@@ -878,15 +876,28 @@ export class ModelService<
|
|
|
878
876
|
this.syncChains.set(uri, chain);
|
|
879
877
|
}
|
|
880
878
|
|
|
879
|
+
/**
|
|
880
|
+
* The undo-stack label for a server-authored write, in the locale the server
|
|
881
|
+
* was handed at init.
|
|
882
|
+
*
|
|
883
|
+
* One method rather than the literal at each `applyEdit`, because the two
|
|
884
|
+
* call sites are the same edit — a push and its full-replace retry — and an
|
|
885
|
+
* undo menu showing two different words for one operation would read as two
|
|
886
|
+
* operations.
|
|
887
|
+
*/
|
|
888
|
+
protected editLabel(): string {
|
|
889
|
+
return this.services.MessageRenderer.renderMessage(MODEL_UPDATE_EDIT);
|
|
890
|
+
}
|
|
891
|
+
|
|
881
892
|
protected async drainSyncQueue(uri: string): Promise<void> {
|
|
882
893
|
const uriLogger = this.tracer.withUri(uri);
|
|
883
894
|
while (this.pendingSync.has(uri)) {
|
|
884
895
|
const text = this.pendingSync.get(uri)!;
|
|
885
896
|
this.pendingSync.delete(uri);
|
|
886
897
|
try {
|
|
887
|
-
let result = await this.services.workspace.TextDocuments.applyEditToLanguageClient(uri, text, { label:
|
|
898
|
+
let result = await this.services.workspace.TextDocuments.applyEditToLanguageClient(uri, text, { label: this.editLabel() });
|
|
888
899
|
if (result?.applied === false && !this.pendingSync.has(uri)) {
|
|
889
|
-
// The push is addressed at the client's
|
|
900
|
+
// The push is addressed at the client's last known version, so a
|
|
890
901
|
// rejection normally means the client's buffer moved while the
|
|
891
902
|
// line-keyed diff was in flight — exactly the case where applying it
|
|
892
903
|
// would splice the file. Dropping the push there would leave the
|
|
@@ -904,8 +915,8 @@ export class ModelService<
|
|
|
904
915
|
// `pendingSync` check skips the retry when a newer settle has already
|
|
905
916
|
// queued — best-effort, since a settle arriving later simply pushes
|
|
906
917
|
// after this and still wins.
|
|
907
|
-
uriLogger.
|
|
908
|
-
result = await this.services.workspace.TextDocuments.applyEditToLanguageClient(uri, text, { label:
|
|
918
|
+
uriLogger.debug(`Re-pushing a full replace after the language client refused applyEdit`);
|
|
919
|
+
result = await this.services.workspace.TextDocuments.applyEditToLanguageClient(uri, text, { label: this.editLabel() });
|
|
909
920
|
if (result?.applied === false) {
|
|
910
921
|
uriLogger.warn(`Language client rejected the full-replace retry too — client content is stale`);
|
|
911
922
|
}
|
|
@@ -935,9 +946,8 @@ export class ModelService<
|
|
|
935
946
|
* `HydraniumTextDocuments` — single listener registration shared with
|
|
936
947
|
* any direct `HydraniumTextDocuments.onUpdate` subscriber, so the same
|
|
937
948
|
* underlying `DocumentBuilder.onDocumentPhase` listener serves both
|
|
938
|
-
* call paths.
|
|
939
|
-
*
|
|
940
|
-
* `lastUpdate` snapshot (see `AstDocumentManager.onUpdate`).
|
|
949
|
+
* call paths. The event's reason, source and cause are
|
|
950
|
+
* {@link AstDocumentManager.attributeUpdate}'s.
|
|
941
951
|
*/
|
|
942
952
|
onModelUpdated(uri: string, listener: (event: AstDocumentUpdatedEvent<TAst, TDiagnostic>) => void): Disposable {
|
|
943
953
|
return this.services.workspace.AstDocumentManager.onUpdate(uri, listener as never);
|
|
@@ -979,13 +989,13 @@ export class ModelService<
|
|
|
979
989
|
* Adopters whose serializer call shape differs (custom service
|
|
980
990
|
* names, generator-driven YAML pretty printers, etc.) override this
|
|
981
991
|
* method. Routes through `Serializer.serializeTransfer` because
|
|
982
|
-
* `
|
|
992
|
+
* a session's `update` / `save` always receive a
|
|
983
993
|
* transfer-model shape (cross-references as plain strings) from
|
|
984
994
|
* adopter callers — the AST-shape entry point is `serializeAst`.
|
|
985
995
|
*
|
|
986
996
|
* Returns {@link MaybePromise} so adopter `Serializer` overrides can be
|
|
987
997
|
* async (remote schema lookup, external canonical-value resolution); the
|
|
988
|
-
* single caller ({@link modelToText}
|
|
998
|
+
* single caller ({@link modelToText}) is already `async`,
|
|
989
999
|
* so a naive `await` covers both branches without extra ceremony.
|
|
990
1000
|
*/
|
|
991
1001
|
protected serialize(uri: string, root: TTransfer): MaybePromise<string> {
|
|
@@ -998,22 +1008,12 @@ export class ModelService<
|
|
|
998
1008
|
// ============================================================
|
|
999
1009
|
|
|
1000
1010
|
/**
|
|
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.
|
|
1011
|
+
* The text a write into a document not yet built should take its trivia
|
|
1012
|
+
* from: the store's, which a write always has, since it writes only a
|
|
1013
|
+
* document its client has open.
|
|
1010
1014
|
*/
|
|
1011
|
-
protected async
|
|
1012
|
-
|
|
1013
|
-
return model;
|
|
1014
|
-
}
|
|
1015
|
-
const rewritten = await this.rewriteModel(uri, model, cancelToken);
|
|
1016
|
-
return this.serialize(uri, rewritten);
|
|
1015
|
+
protected async textToTakeTriviaFrom(uri: string, _target: URI): Promise<string | undefined> {
|
|
1016
|
+
return this.services.workspace.TextDocuments.get(uri)?.getText();
|
|
1017
1017
|
}
|
|
1018
1018
|
|
|
1019
1019
|
/**
|
|
@@ -1048,4 +1048,23 @@ export class ModelService<
|
|
|
1048
1048
|
? AstDocument.from<TAst, TDiagnostic>(document)
|
|
1049
1049
|
: AstDocument.create<TAst, TDiagnostic>(uri.toString(), 0, undefined as unknown as TAst, []);
|
|
1050
1050
|
}
|
|
1051
|
+
|
|
1052
|
+
/**
|
|
1053
|
+
* The same envelope with no diagnostics, for a read that names a phase below
|
|
1054
|
+
* `Validated`.
|
|
1055
|
+
*
|
|
1056
|
+
* Langium fills `LangiumDocument.diagnostics` from inside `validateDocument`
|
|
1057
|
+
* and from nowhere else, so below that phase the array holds whatever an
|
|
1058
|
+
* EARLIER build left — a verdict about text the document may no longer have.
|
|
1059
|
+
* The wait underneath resolves at or above the phase asked for, so a document
|
|
1060
|
+
* something else carried past `Validated` would otherwise hand a full array
|
|
1061
|
+
* back from `parsed()`.
|
|
1062
|
+
*
|
|
1063
|
+
* A copy rather than a clear: the envelope is freshly built here, but
|
|
1064
|
+
* {@link toAstDocument} is overridable and an adopter's version may return
|
|
1065
|
+
* one it also keeps.
|
|
1066
|
+
*/
|
|
1067
|
+
protected withoutDiagnostics(document: AstDocument<TAst, TDiagnostic>): AstDocument<TAst, never> {
|
|
1068
|
+
return { ...document, diagnostics: [] };
|
|
1069
|
+
}
|
|
1051
1070
|
}
|