@hydranium/core 1.0.0-next.14 → 1.0.0-next.140
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 +187 -27
- package/lib/documents/ast-document-manager.d.ts.map +1 -1
- package/lib/documents/ast-document-manager.js +235 -38
- 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 +386 -57
- package/lib/documents/hydranium-text-documents.d.ts.map +1 -1
- package/lib/documents/hydranium-text-documents.js +697 -113
- 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-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/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/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/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 +220 -11
- package/lib/langium/document-builder/document-builder.d.ts.map +1 -1
- package/lib/langium/document-builder/document-builder.js +409 -27
- 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/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 +50 -6
- package/lib/langium/integrity/integrity-service.d.ts.map +1 -1
- package/lib/langium/integrity/integrity-service.js +193 -17
- 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/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 +240 -174
- package/lib/langium/model-service/model-service.d.ts.map +1 -1
- package/lib/langium/model-service/model-service.js +207 -314
- package/lib/langium/model-service/model-service.js.map +1 -1
- package/lib/langium/module.d.ts +102 -18
- package/lib/langium/module.d.ts.map +1 -1
- package/lib/langium/module.js +30 -12
- 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/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/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/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/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/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/workspace/document-uri-policy.d.ts +3 -4
- package/lib/langium/workspace/document-uri-policy.d.ts.map +1 -1
- package/lib/langium/workspace/document-uri-policy.js +3 -4
- package/lib/langium/workspace/document-uri-policy.js.map +1 -1
- package/lib/langium/workspace/file-system-provider.d.ts +9 -1
- package/lib/langium/workspace/file-system-provider.d.ts.map +1 -1
- package/lib/langium/workspace/file-system-provider.js +40 -7
- 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-manager.d.ts +21 -1
- package/lib/langium/workspace/hydranium-workspace-manager.d.ts.map +1 -1
- package/lib/langium/workspace/hydranium-workspace-manager.js +28 -0
- package/lib/langium/workspace/hydranium-workspace-manager.js.map +1 -1
- package/lib/langium/workspace/in-memory-file-system-provider.d.ts +23 -0
- package/lib/langium/workspace/in-memory-file-system-provider.d.ts.map +1 -1
- package/lib/langium/workspace/in-memory-file-system-provider.js +55 -9
- package/lib/langium/workspace/in-memory-file-system-provider.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 +83 -28
- package/lib/langium/workspace/langium-documents.js.map +1 -1
- package/lib/langium/workspace/virtual-document.d.ts +18 -3
- package/lib/langium/workspace/virtual-document.d.ts.map +1 -1
- package/lib/langium/workspace/virtual-document.js +19 -2
- package/lib/langium/workspace/virtual-document.js.map +1 -1
- package/lib/langium/workspace/write-lock-scope.d.ts +4 -3
- package/lib/langium/workspace/write-lock-scope.d.ts.map +1 -1
- package/lib/langium/workspace/write-lock-scope.js +4 -3
- 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 +70 -62
- package/lib/lsp/hydranium-document-update-handler.d.ts.map +1 -1
- package/lib/lsp/hydranium-document-update-handler.js +129 -75
- 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/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/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/node-file-system-provider.d.ts +35 -1
- package/lib/node/node-file-system-provider.d.ts.map +1 -1
- package/lib/node/node-file-system-provider.js +140 -45
- package/lib/node/node-file-system-provider.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/profiling-run.d.ts +2 -2
- 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/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/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 +25 -5
- package/lib/testing/make-test-services.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/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 +15 -6
- package/lib/testing/stub-document-builder.d.ts.map +1 -1
- package/lib/testing/stub-document-builder.js +48 -3
- 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-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/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/package.json +17 -8
- package/src/documents/ast-document-manager.ts +345 -62
- 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 +853 -142
- 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 +460 -26
- 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 +202 -17
- 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 +363 -312
- package/src/langium/module.ts +132 -24
- package/src/langium/naming/name-provider.ts +27 -5
- package/src/langium/naming/name-separator-validation.ts +34 -5
- 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 +3 -4
- package/src/langium/workspace/file-system-provider.ts +48 -8
- package/src/langium/workspace/hydranium-langium-document-factory.ts +34 -0
- package/src/langium/workspace/hydranium-workspace-manager.ts +30 -1
- package/src/langium/workspace/in-memory-file-system-provider.ts +62 -10
- package/src/langium/workspace/initialize-workspace.ts +43 -5
- package/src/langium/workspace/langium-documents.ts +106 -33
- package/src/langium/workspace/virtual-document.ts +21 -3
- package/src/langium/workspace/write-lock-scope.ts +4 -3
- 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 +158 -79
- 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 +154 -47
- 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/make-noop-shared-services.ts +50 -2
- package/src/testing/make-test-services.ts +101 -26
- 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 +68 -12
- 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/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,20 +9,16 @@
|
|
|
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
23
|
import { ReentrantWriteLockError, isInsideWriteLock } from '../workspace/write-lock-scope.js';
|
|
28
24
|
import { type CancellationToken, type Disposable } from 'vscode-languageserver';
|
|
@@ -32,48 +28,35 @@ 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,
|
|
51
57
|
* and the defaults are the behaviour described on each one.
|
|
52
58
|
*/
|
|
53
59
|
export interface ModelServiceOptions extends LogNameOptions {
|
|
54
|
-
/**
|
|
55
|
-
* When set, {@link ModelService.update} logs a `warn` line if its
|
|
56
|
-
* end-to-end wait (serialise + content-change apply + rebuild +
|
|
57
|
-
* settled-phase wait) exceeds this many milliseconds. Default
|
|
58
|
-
* `undefined` (no warn line ever emitted; the underlying
|
|
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
60
|
/**
|
|
78
61
|
* Serialise the facade's own build under the workspace WRITE lock, the way
|
|
79
62
|
* Langium's `DefaultDocumentUpdateHandler` dispatches its build. Default
|
|
@@ -96,17 +79,19 @@ export interface ModelServiceOptions extends LogNameOptions {
|
|
|
96
79
|
* option removes is the wasted pass, not just its visible symptom.
|
|
97
80
|
*
|
|
98
81
|
* **What `false` buys.** `WorkspaceLock` is not reentrant. A caller that
|
|
99
|
-
* reaches `update` / `save`
|
|
100
|
-
* an integrity rule or build-phase pass that writes
|
|
101
|
-
* deadlocks: acquiring the lock cancels the running holder, and the new
|
|
82
|
+
* reaches a session's `update` / `save` or `rebuild` while already holding
|
|
83
|
+
* the write lock — an integrity rule or build-phase pass that writes
|
|
84
|
+
* back — deadlocks: acquiring the lock cancels the running holder, and the new
|
|
102
85
|
* acquisition then waits for that holder to release while the holder waits
|
|
103
86
|
* for this call. On `true` that shape is DETECTED and rejected with
|
|
104
87
|
* {@link ReentrantWriteLockError} rather than hanging, wherever a host
|
|
105
88
|
* installs a write-lock scope tracker (`@hydranium/core/node` does at entry
|
|
106
89
|
* load; see {@link isInsideWriteLock}). Setting `false` is the escape hatch
|
|
107
|
-
* for an adopter whose reentrant shape is unavoidable
|
|
108
|
-
*
|
|
109
|
-
*
|
|
90
|
+
* for an adopter whose reentrant shape is unavoidable: the facade's own
|
|
91
|
+
* build then takes no lock, so it cannot cancel the holder it runs inside.
|
|
92
|
+
* The wait after it can still hang there, because a document no build will
|
|
93
|
+
* carry is re-queued through the lock, and that re-queue waits for the
|
|
94
|
+
* holder to end. Prefer `false` over serialised builds only in that case.
|
|
110
95
|
*
|
|
111
96
|
* Accepts a {@link MaybeObservableValue} so it can be bound to a setting and
|
|
112
97
|
* flipped without a restart.
|
|
@@ -115,12 +100,17 @@ export interface ModelServiceOptions extends LogNameOptions {
|
|
|
115
100
|
}
|
|
116
101
|
|
|
117
102
|
/**
|
|
103
|
+
* The seam every non-LSP head talks to: the data server, the GLSP head and an
|
|
104
|
+
* adopter's own services reach documents through this slot rather than through
|
|
105
|
+
* the workspace stores.
|
|
106
|
+
*
|
|
118
107
|
* In-process facade over the framework's document plumbing
|
|
119
108
|
* (`HydraniumTextDocuments`, `LangiumDocuments`,
|
|
120
|
-
* `DocumentBuilder`, `WritableFileSystemProvider`). Owns the
|
|
121
|
-
*
|
|
122
|
-
*
|
|
123
|
-
* doesn't have to be re-implemented per
|
|
109
|
+
* `DocumentBuilder`, `WritableFileSystemProvider`). Owns the document
|
|
110
|
+
* lifecycle the data-server and GLSP heads delegate to — client sessions that
|
|
111
|
+
* open, update, save and close documents, the phase reads, and `ready` — so
|
|
112
|
+
* coordinating those primitives doesn't have to be re-implemented per head.
|
|
113
|
+
* Every open and write goes through a session from {@link createSession}.
|
|
124
114
|
*
|
|
125
115
|
* "Model" here means the parsed AST — distinct from the wire-shape
|
|
126
116
|
* `TransferDocument` in `@hydranium/protocol`.
|
|
@@ -130,9 +120,9 @@ export interface ModelServiceOptions extends LogNameOptions {
|
|
|
130
120
|
* Multiple in-process consumers want the same workspace-level
|
|
131
121
|
* operations:
|
|
132
122
|
* - The data-server head turns these into typed RPC methods.
|
|
133
|
-
* - The GLSP head uses the same lifecycle for diagram-driven edits
|
|
134
|
-
*
|
|
135
|
-
*
|
|
123
|
+
* - The GLSP head uses the same lifecycle for diagram-driven edits: GModel
|
|
124
|
+
* operation handlers write through the diagram's session and wait on phases
|
|
125
|
+
* before reading.
|
|
136
126
|
* - Server-internal callers (integrity service, ad-hoc bridges, tests)
|
|
137
127
|
* want the same operations without the wire serialisation step.
|
|
138
128
|
*
|
|
@@ -145,15 +135,16 @@ export interface ModelServiceOptions extends LogNameOptions {
|
|
|
145
135
|
*
|
|
146
136
|
* **Read-latest supersession**
|
|
147
137
|
*
|
|
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
|
-
*
|
|
138
|
+
* A session's default `update` and `save` use Langium's per-URI
|
|
139
|
+
* `DocumentBuilder.waitUntil` to wait for `Validated` (the integrity-settled
|
|
140
|
+
* landmark {@link IntegrityService.SettledState} when rebuilds do not
|
|
141
|
+
* validate), then read the post-build state. Concurrent in-process callers
|
|
142
|
+
* on the same URI all see the latest post-build snapshot — none deadlock
|
|
143
|
+
* waiting for a specific version's settled event. Adopters wanting strict
|
|
144
|
+
* version-matched semantics (resolve with vN's snapshot specifically, log
|
|
145
|
+
* "vN superseded by vM at vN+1") override
|
|
146
|
+
* `DefaultClientSession.updateDocument` to attach a phase-listener with
|
|
147
|
+
* explicit version checks; the framework default doesn't need it for safety.
|
|
157
148
|
*
|
|
158
149
|
* **Returns AST snapshots, not wire envelopes**
|
|
159
150
|
*
|
|
@@ -173,20 +164,112 @@ export interface ModelServiceOptions extends LogNameOptions {
|
|
|
173
164
|
* by URI happens here so consumers can subscribe per-document without
|
|
174
165
|
* implementing the URI gate at each callsite.
|
|
175
166
|
*
|
|
167
|
+
* **Two families, and the distinction matters more than the names suggest.**
|
|
168
|
+
* `waitFor*` is a pure wait — it never triggers a build, so a caller waiting on
|
|
169
|
+
* a document no build has touched waits until something else builds it.
|
|
170
|
+
* `ensureDocumentState` and the phase shorthands over it *dispatch*: warm
|
|
171
|
+
* documents are awaited, cold ones are built.
|
|
172
|
+
*
|
|
173
|
+
* **Diagnostics are typed `never` below `Validated`.** Validation is the last
|
|
174
|
+
* phase, so at any earlier landmark the array either is not yet computed or
|
|
175
|
+
* still holds the previous build's, and reading it would take stale results
|
|
176
|
+
* for fresh ones. A caller that needs diagnostics asks for {@link validated}.
|
|
177
|
+
*
|
|
178
|
+
* What the `never` buys, exactly: reading a field off an element is a compile
|
|
179
|
+
* error, and nothing can be appended. It does NOT stop a caller assigning an
|
|
180
|
+
* element to a typed variable, because `never` is assignable to everything — so
|
|
181
|
+
* this is a guard against reaching for diagnostics by accident, not a seal
|
|
182
|
+
* against doing it deliberately.
|
|
183
|
+
*
|
|
184
|
+
* The waits resolve at or ABOVE their target, so an already-validated document
|
|
185
|
+
* does carry usable diagnostics and the `never` over-forbids there. That
|
|
186
|
+
* direction is the safe one: the alternative permits stale reads silently. A
|
|
187
|
+
* member taking a phase as a PARAMETER cannot judge statically and so returns
|
|
188
|
+
* `TDiagnostic`, leaving the choice to the caller.
|
|
189
|
+
*
|
|
176
190
|
* **Generic parameters.**
|
|
177
191
|
* - `TAst` — the AST root type each consumer expects on the returned
|
|
178
192
|
* {@link AstDocument}. Constrained to {@link AstNode}.
|
|
179
|
-
* - `TDiagnostic` —
|
|
180
|
-
* `
|
|
181
|
-
*
|
|
193
|
+
* - `TDiagnostic` — the AST-layer diagnostic: whatever the build left on
|
|
194
|
+
* `LangiumDocument.diagnostics`, carried through on the returned
|
|
195
|
+
* {@link AstDocument}. Defaults to {@link AstDiagnostic}.
|
|
196
|
+
* **Not the `TransferEncoder`'s parameter of the same name**, which is
|
|
197
|
+
* that encoder's OUTPUT and so names the wire shape. This one names its
|
|
198
|
+
* input, and an adopter binds the two to different types.
|
|
199
|
+
* - `TTransfer` — transfer-model root a session's `update` / `save` accept
|
|
182
200
|
* args. Constrained to {@link TransferElement}. Defaults to the
|
|
183
201
|
* structural base.
|
|
184
202
|
*/
|
|
185
|
-
export
|
|
203
|
+
export interface ModelService<
|
|
204
|
+
TAst extends AstNode,
|
|
205
|
+
TDiagnostic extends AstDiagnostic = AstDiagnostic,
|
|
206
|
+
TTransfer extends TransferElement = TransferElement
|
|
207
|
+
> {
|
|
208
|
+
/**
|
|
209
|
+
* Resolves once the workspace has been initialised and its first build has
|
|
210
|
+
* completed — the gate every read should wait behind, since a document
|
|
211
|
+
* queried before it may be unbuilt and reach no phase.
|
|
212
|
+
*
|
|
213
|
+
* A property rather than a method, matching `ProjectManager.ready` and
|
|
214
|
+
* Langium's `WorkspaceManager.ready`. An implementation needing a stricter
|
|
215
|
+
* gate supplies a Promise that awaits its own concern as well.
|
|
216
|
+
*/
|
|
217
|
+
readonly ready: Promise<void>;
|
|
218
|
+
|
|
219
|
+
// Pure waits — never trigger a build.
|
|
220
|
+
waitForDocumentState(uri: string, state: DocumentState, cancelToken?: CancellationToken): Promise<AstDocument<TAst, TDiagnostic>>;
|
|
221
|
+
waitForDocumentSettled(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>>;
|
|
222
|
+
waitForBuilderState(state: DocumentState, cancelToken?: CancellationToken): Promise<void>;
|
|
223
|
+
|
|
224
|
+
// Wait if warm, build if cold.
|
|
225
|
+
ensureDocumentState(uri: string, state?: DocumentState, cancelToken?: CancellationToken): Promise<AstDocument<TAst, TDiagnostic>>;
|
|
226
|
+
rebuild(uri: string, state?: DocumentState, cancelToken?: CancellationToken): Promise<AstDocument<TAst, TDiagnostic>>;
|
|
227
|
+
parsed(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>>;
|
|
228
|
+
linked(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>>;
|
|
229
|
+
settled(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>>;
|
|
230
|
+
indexed(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>>;
|
|
231
|
+
validated(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, TDiagnostic>>;
|
|
232
|
+
|
|
233
|
+
isOpen(uri: string): boolean;
|
|
234
|
+
snapshot(uri: string): AstDocument<TAst, TDiagnostic> | undefined;
|
|
235
|
+
/**
|
|
236
|
+
* The text a session's write of `model` to `uri` applies: a textual model
|
|
237
|
+
* as given, a structured one rewritten and serialised.
|
|
238
|
+
*/
|
|
239
|
+
modelToText(uri: string, model: TTransfer | string, cancelToken?: CancellationToken): Promise<string>;
|
|
240
|
+
getDocument(uri: string): LangiumDocument | undefined;
|
|
241
|
+
|
|
242
|
+
onModelUpdated(uri: string, listener: (event: AstDocumentUpdatedEvent<TAst, TDiagnostic>) => void): Disposable;
|
|
243
|
+
onModelSaved(uri: string, listener: (event: AstDocumentSavedEvent<TAst, TDiagnostic>) => void): Disposable;
|
|
244
|
+
onClientClosed(uri: string, clientId: string, listener: () => void): Disposable;
|
|
245
|
+
|
|
246
|
+
/**
|
|
247
|
+
* Start a client session, the only way to open and write documents through
|
|
248
|
+
* this service. Pass a `label` naming the participant; without one it is
|
|
249
|
+
* `session`. The id defaults to `label#` plus a random UUID; a fixed
|
|
250
|
+
* `clientId` is taken as given. Throws `ReservedClientIdError` when the id
|
|
251
|
+
* is reserved by the framework, and `DuplicateClientIdError` when it is
|
|
252
|
+
* held by another live session or has documents open under it as a client
|
|
253
|
+
* that is not a session.
|
|
254
|
+
*
|
|
255
|
+
* `TOpenOptions` types the options the session's `open` takes and its
|
|
256
|
+
* `openOptions` returns. The narrowing is an unchecked cast, and it holds
|
|
257
|
+
* only for the caller that started the session: a holder reached through
|
|
258
|
+
* {@link getSession} sees plain `OpenOptions`.
|
|
259
|
+
*/
|
|
260
|
+
createSession<TOpenOptions extends OpenOptions = OpenOptions>(
|
|
261
|
+
label?: string,
|
|
262
|
+
clientId?: string
|
|
263
|
+
): ClientSession<TAst, TDiagnostic, TTransfer, TOpenOptions>;
|
|
264
|
+
/** The live session started under `clientId`, or `undefined` once it has ended or was never started. */
|
|
265
|
+
getSession(clientId: string): ClientSession<TAst, TDiagnostic, TTransfer> | undefined;
|
|
266
|
+
}
|
|
267
|
+
|
|
268
|
+
export class DefaultModelService<
|
|
186
269
|
TAst extends AstNode,
|
|
187
|
-
TDiagnostic =
|
|
270
|
+
TDiagnostic extends AstDiagnostic = AstDiagnostic,
|
|
188
271
|
/**
|
|
189
|
-
* Structured payload
|
|
272
|
+
* Structured payload a session's `update` / `save` accept. Constrained to
|
|
190
273
|
* {@link TransferElement} — the minimal `{ readonly $type: string }`
|
|
191
274
|
* shape. Both transfer-model overlay roots (which extend
|
|
192
275
|
* `TransferElement` explicitly) and AST root types (which have
|
|
@@ -195,7 +278,7 @@ export class ModelService<
|
|
|
195
278
|
* integrity service) that pass AST roots remain compatible.
|
|
196
279
|
*/
|
|
197
280
|
TTransfer extends TransferElement = TransferElement
|
|
198
|
-
> {
|
|
281
|
+
> implements ModelService<TAst, TDiagnostic, TTransfer> {
|
|
199
282
|
protected readonly tracer: Tracer;
|
|
200
283
|
/**
|
|
201
284
|
* The single document-identity seam (`services.workspace.DocumentUriPolicy`),
|
|
@@ -206,12 +289,6 @@ export class ModelService<
|
|
|
206
289
|
* (see {@link DocumentUriPolicy}).
|
|
207
290
|
*/
|
|
208
291
|
protected readonly uriPolicy: DocumentUriPolicy;
|
|
209
|
-
/**
|
|
210
|
-
* Live slow-update-warn threshold cell, or `undefined` when the option
|
|
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
292
|
/** See {@link ModelServiceOptions.serializeBuilds}. Defaults to `true`. */
|
|
216
293
|
protected readonly serializeBuilds: ObservableValue<boolean>;
|
|
217
294
|
|
|
@@ -224,6 +301,16 @@ export class ModelService<
|
|
|
224
301
|
protected readonly syncChains = new Map<string, Promise<void>>();
|
|
225
302
|
protected readonly pendingSync = new Map<string, string>();
|
|
226
303
|
|
|
304
|
+
/** The live sessions this service started, by client id, for {@link getSession}. */
|
|
305
|
+
protected readonly sessions = new Map<string, ClientSession<TAst, TDiagnostic, TTransfer>>();
|
|
306
|
+
/**
|
|
307
|
+
* Drops an ended session from {@link sessions}. Subscribed by the first
|
|
308
|
+
* {@link createSession} rather than at construction, so a services tree with
|
|
309
|
+
* no text store, or one that knows nothing of sessions, still constructs
|
|
310
|
+
* this service.
|
|
311
|
+
*/
|
|
312
|
+
protected sessionCloseListener?: Disposable;
|
|
313
|
+
|
|
227
314
|
/**
|
|
228
315
|
* Workspace-level readiness gate. Resolves when the framework has
|
|
229
316
|
* finished its first workspace build cycle and the `ModelService`
|
|
@@ -264,7 +351,6 @@ export class ModelService<
|
|
|
264
351
|
) {
|
|
265
352
|
this.tracer = services.Tracer.for(options.logName ?? 'ModelService').trace('instantiated');
|
|
266
353
|
this.uriPolicy = services.workspace.DocumentUriPolicy;
|
|
267
|
-
this.slowUpdateWarn = options.slowUpdateWarnMs !== undefined ? ObservableValue.from(options.slowUpdateWarnMs) : undefined;
|
|
268
354
|
this.serializeBuilds = ObservableValue.from(options.serializeBuilds ?? true);
|
|
269
355
|
// Optional-chain so a harness that binds no WorkspaceManager awaits
|
|
270
356
|
// `undefined` and resolves immediately; production hosts always have it
|
|
@@ -329,8 +415,12 @@ export class ModelService<
|
|
|
329
415
|
* {@link waitForDocumentState} for the common "wait until content is stable"
|
|
330
416
|
* case (e.g. settling a save). Pure wait — does not trigger a build.
|
|
331
417
|
*/
|
|
332
|
-
async waitForDocumentSettled(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst,
|
|
333
|
-
return this.waitForDocumentStateCanonical(
|
|
418
|
+
async waitForDocumentSettled(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>> {
|
|
419
|
+
return (await this.waitForDocumentStateCanonical(
|
|
420
|
+
this.uriPolicy.canonicalUri(uri),
|
|
421
|
+
IntegrityService.SettledState,
|
|
422
|
+
cancelToken
|
|
423
|
+
)) as AstDocument<TAst, never>;
|
|
334
424
|
}
|
|
335
425
|
|
|
336
426
|
/**
|
|
@@ -402,6 +492,12 @@ export class ModelService<
|
|
|
402
492
|
* {@link ModelServiceOptions.serializeBuilds} — see there for the
|
|
403
493
|
* non-reentrancy hazard that is the reason the opt-out exists.
|
|
404
494
|
*
|
|
495
|
+
* An override calls the base before it awaits. Under an LSP connection the
|
|
496
|
+
* store's change event has already asked the update handler to build a
|
|
497
|
+
* session's write; an override whose await outlasts that build makes the
|
|
498
|
+
* base's request start a build of its own, so the write is built and
|
|
499
|
+
* delivered twice.
|
|
500
|
+
*
|
|
405
501
|
* Returns an empty `{ root, diagnostics }` envelope when the document
|
|
406
502
|
* cannot be loaded; adopters that want to throw override this method
|
|
407
503
|
* on their subclass.
|
|
@@ -452,8 +548,8 @@ export class ModelService<
|
|
|
452
548
|
// writing back through this facade — would cancel its own enclosing
|
|
453
549
|
// build and then likely stall in the phase wait below. The check is
|
|
454
550
|
// gated on `serializeBuilds` deliberately, because acquiring the lock IS
|
|
455
|
-
// the hazard: with serialisation off
|
|
456
|
-
//
|
|
551
|
+
// the hazard: with serialisation off the build takes no lock, which
|
|
552
|
+
// makes the existing opt-out the guard's opt-out too.
|
|
457
553
|
// Detection needs async-context propagation, so it is inert until a host
|
|
458
554
|
// installs a tracker (`@hydranium/core/node` does) — see
|
|
459
555
|
// `isInsideWriteLock`.
|
|
@@ -484,11 +580,19 @@ export class ModelService<
|
|
|
484
580
|
*
|
|
485
581
|
* Phase invariants encoded in the return type:
|
|
486
582
|
* - `parsed` / `linked` / `settled` / `indexed` return
|
|
487
|
-
* `AstDocument<TAst, never>` — diagnostics
|
|
488
|
-
*
|
|
583
|
+
* `AstDocument<TAst, never>` — no diagnostics have been computed at
|
|
584
|
+
* those phases.
|
|
489
585
|
* - `validated` returns `AstDocument<TAst, TDiagnostic>` — diagnostics
|
|
490
586
|
* are populated.
|
|
491
587
|
*
|
|
588
|
+
* **The `never` is enforced, not merely declared.** The wait underneath
|
|
589
|
+
* resolves at or ABOVE the requested state, so a document something else
|
|
590
|
+
* already carried past `Validated` would otherwise come back from
|
|
591
|
+
* `settled()` carrying a full diagnostics array typed `never`; these four
|
|
592
|
+
* strip it. An empty array here therefore means "this read does not report
|
|
593
|
+
* diagnostics", never "this document is clean" — call {@link validated}
|
|
594
|
+
* when the answer has to mean the second.
|
|
595
|
+
*
|
|
492
596
|
* `settled` is the integrity-overlay name for "all integrity rules
|
|
493
597
|
* have fired"; it maps to {@link IntegrityService.SettledState} (which
|
|
494
598
|
* equals `DocumentState.IndexedReferences`), but the dedicated method
|
|
@@ -496,19 +600,19 @@ export class ModelService<
|
|
|
496
600
|
* ever moves.
|
|
497
601
|
*/
|
|
498
602
|
async parsed(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>> {
|
|
499
|
-
return this.ensureDocumentState(uri, DocumentState.Parsed, cancelToken)
|
|
603
|
+
return this.withoutDiagnostics(await this.ensureDocumentState(uri, DocumentState.Parsed, cancelToken));
|
|
500
604
|
}
|
|
501
605
|
|
|
502
606
|
async linked(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>> {
|
|
503
|
-
return this.ensureDocumentState(uri, DocumentState.Linked, cancelToken)
|
|
607
|
+
return this.withoutDiagnostics(await this.ensureDocumentState(uri, DocumentState.Linked, cancelToken));
|
|
504
608
|
}
|
|
505
609
|
|
|
506
610
|
async settled(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>> {
|
|
507
|
-
return this.ensureDocumentState(uri, IntegrityService.SettledState, cancelToken)
|
|
611
|
+
return this.withoutDiagnostics(await this.ensureDocumentState(uri, IntegrityService.SettledState, cancelToken));
|
|
508
612
|
}
|
|
509
613
|
|
|
510
614
|
async indexed(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>> {
|
|
511
|
-
return this.ensureDocumentState(uri, DocumentState.IndexedReferences, cancelToken)
|
|
615
|
+
return this.withoutDiagnostics(await this.ensureDocumentState(uri, DocumentState.IndexedReferences, cancelToken));
|
|
512
616
|
}
|
|
513
617
|
|
|
514
618
|
async validated(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, TDiagnostic>> {
|
|
@@ -557,115 +661,14 @@ export class ModelService<
|
|
|
557
661
|
return this.rebuild(uri, target, cancelToken);
|
|
558
662
|
}
|
|
559
663
|
|
|
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
664
|
/**
|
|
662
665
|
* Wait for the document at `uri` to reach the integrity-settled landmark and
|
|
663
666
|
* drain any in-flight write-path applyEdit sync chain (see {@link syncChains})
|
|
664
667
|
* so every language client reflects the latest content before a save returns.
|
|
665
668
|
* No-op tail for headless adopters — `syncChains` is empty without an LSP
|
|
666
669
|
* 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.
|
|
670
|
+
* applyEdit reverse-RPC deadlock, can't freeze the caller; on timeout or a
|
|
671
|
+
* failed wait it logs a warning and returns rather than throwing.
|
|
669
672
|
*
|
|
670
673
|
* Adopters with a save flow that must converge editor + disk before returning
|
|
671
674
|
* (e.g. a dual form/code editor that would otherwise show a content-conflict
|
|
@@ -674,57 +677,24 @@ export class ModelService<
|
|
|
674
677
|
protected async settleSave(uri: string, cancelToken?: CancellationToken): Promise<void> {
|
|
675
678
|
const canonical = this.uriPolicy.canonicalUri(uri);
|
|
676
679
|
const key = UriUtils.toUri(canonical).toString();
|
|
677
|
-
|
|
678
|
-
|
|
679
|
-
)
|
|
680
|
+
// One race over both waits, so the bound is one deadline for the pair;
|
|
681
|
+
// a race per wait would let the save take twice the bound.
|
|
682
|
+
const settled = (async (): Promise<void> => {
|
|
683
|
+
await this.waitForDocumentStateCanonical(canonical, IntegrityService.SettledState, cancelToken);
|
|
684
|
+
await this.syncChains.get(key);
|
|
685
|
+
})();
|
|
680
686
|
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) {
|
|
687
|
+
if ((await this.services.Clock.raceTimer(settled, SAVE_SETTLE_TIMEOUT_MS)) === TIMED_OUT) {
|
|
688
688
|
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
689
|
}
|
|
690
|
+
} catch (err: unknown) {
|
|
691
|
+
// A failed wait, such as a cancelled token or a document the builder
|
|
692
|
+
// does not hold, gets its own line so it is not blamed on the bound.
|
|
693
|
+
const detail = err instanceof Error ? (err.stack ?? err.message) : String(err);
|
|
694
|
+
this.tracer.withUri(key).warn(`Save settle failed before the timeout — returning anyway. ${detail}`);
|
|
693
695
|
}
|
|
694
696
|
}
|
|
695
697
|
|
|
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
698
|
/**
|
|
729
699
|
* True when the document at `uri` is currently open for at least one
|
|
730
700
|
* client. Pure read; no side effects.
|
|
@@ -733,6 +703,31 @@ export class ModelService<
|
|
|
733
703
|
return this.services.workspace.AstDocumentManager.isOpen(uri);
|
|
734
704
|
}
|
|
735
705
|
|
|
706
|
+
/**
|
|
707
|
+
* Snapshot of `uri` as it stands RIGHT NOW — the synchronous sibling of the
|
|
708
|
+
* phase reads, which all wait. `undefined` when no document is registered.
|
|
709
|
+
*
|
|
710
|
+
* **This is what a writer wants, and {@link getDocument} is not.** The
|
|
711
|
+
* envelope's `version` is copied by value at projection time, so it cannot
|
|
712
|
+
* move afterwards; a version read off the live document at write time is
|
|
713
|
+
* whatever the server is at *now*, which is the number an optimistic gate is
|
|
714
|
+
* about to compare it against.
|
|
715
|
+
*
|
|
716
|
+
* Diagnostics only from a document that has reached `Validated`, and an
|
|
717
|
+
* empty array otherwise. Unlike the phase reads this one names no phase, so
|
|
718
|
+
* the state it finds is the only thing that can say whether the array
|
|
719
|
+
* describes the content being handed back or whatever an earlier build left.
|
|
720
|
+
* A caller that needs them unconditionally waits, via {@link validated}.
|
|
721
|
+
*/
|
|
722
|
+
snapshot(uri: string): AstDocument<TAst, TDiagnostic> | undefined {
|
|
723
|
+
const document = this.getDocument(uri);
|
|
724
|
+
if (!document) {
|
|
725
|
+
return undefined;
|
|
726
|
+
}
|
|
727
|
+
const envelope = AstDocument.from<TAst, TDiagnostic>(document);
|
|
728
|
+
return document.state >= DocumentState.Validated ? envelope : this.withoutDiagnostics(envelope);
|
|
729
|
+
}
|
|
730
|
+
|
|
736
731
|
/**
|
|
737
732
|
* The built {@link LangiumDocument} for `uri`, looked up by canonical identity —
|
|
738
733
|
* the synchronous, phase-agnostic sibling of {@link ensureDocumentState} /
|
|
@@ -741,11 +736,92 @@ export class ModelService<
|
|
|
741
736
|
* into `LangiumDocuments` directly: a symlinked / `..` / case-divergent URI
|
|
742
737
|
* still resolves to the one document the build keys by its real path. Returns
|
|
743
738
|
* `undefined` if no document is registered for `uri`.
|
|
739
|
+
*
|
|
740
|
+
* **Live, so do not take a based-on version off it.** `textDocument` is the
|
|
741
|
+
* store's own object rather than a copy, so `.version` read here answers for
|
|
742
|
+
* the moment of the READ, not the moment of the earlier content — pass it to
|
|
743
|
+
* a write and the server compares its current version against itself, the
|
|
744
|
+
* gate passes unconditionally, and a concurrent edit is overwritten with
|
|
745
|
+
* nothing logged. Use {@link snapshot} for that, or a phase read.
|
|
744
746
|
*/
|
|
745
747
|
getDocument(uri: string): LangiumDocument | undefined {
|
|
746
748
|
return this.services.workspace.AstDocumentManager.getDocument(uri);
|
|
747
749
|
}
|
|
748
750
|
|
|
751
|
+
// ============================================================
|
|
752
|
+
// Client sessions
|
|
753
|
+
// ============================================================
|
|
754
|
+
|
|
755
|
+
createSession<TOpenOptions extends OpenOptions = OpenOptions>(
|
|
756
|
+
label?: string,
|
|
757
|
+
clientId?: string
|
|
758
|
+
): ClientSession<TAst, TDiagnostic, TTransfer, TOpenOptions> {
|
|
759
|
+
const sessionLabel = label ?? 'session';
|
|
760
|
+
const id = clientId ?? `${sessionLabel}#${globalThis.crypto.randomUUID()}`;
|
|
761
|
+
const textDocuments = this.services.workspace.TextDocuments;
|
|
762
|
+
textDocuments.registerSession(id);
|
|
763
|
+
this.sessionCloseListener ??= textDocuments.onDidCloseSession(event => {
|
|
764
|
+
// Also reached when the store ends a session directly; disposing the
|
|
765
|
+
// handle makes its later calls fail rather than write under an id
|
|
766
|
+
// this service no longer treats as a session.
|
|
767
|
+
this.sessions.get(event.clientId)?.dispose();
|
|
768
|
+
this.sessions.delete(event.clientId);
|
|
769
|
+
});
|
|
770
|
+
let session: ClientSession<TAst, TDiagnostic, TTransfer, TOpenOptions>;
|
|
771
|
+
try {
|
|
772
|
+
// Unchecked: the session keeps whatever options its `open` is handed,
|
|
773
|
+
// and the factory types it for every grammar, so the narrowed type
|
|
774
|
+
// holds only for the caller that started it.
|
|
775
|
+
session = this.services.model.ClientSessionFactory.create(id, sessionLabel) as ClientSession<
|
|
776
|
+
TAst,
|
|
777
|
+
TDiagnostic,
|
|
778
|
+
TTransfer,
|
|
779
|
+
TOpenOptions
|
|
780
|
+
>;
|
|
781
|
+
} catch (err: unknown) {
|
|
782
|
+
textDocuments.closeSession(id);
|
|
783
|
+
throw err;
|
|
784
|
+
}
|
|
785
|
+
this.sessions.set(id, session);
|
|
786
|
+
return session;
|
|
787
|
+
}
|
|
788
|
+
|
|
789
|
+
getSession(clientId: string): ClientSession<TAst, TDiagnostic, TTransfer> | undefined {
|
|
790
|
+
return this.sessions.get(clientId);
|
|
791
|
+
}
|
|
792
|
+
|
|
793
|
+
/**
|
|
794
|
+
* Convert a structured-or-textual `model` payload to its textual form.
|
|
795
|
+
*
|
|
796
|
+
* Textual payloads (LSP / pre-serialised callers) pass through untouched.
|
|
797
|
+
* Structured payloads run the per-language `UpdateRewriteService` chain
|
|
798
|
+
* (transfer-model transforms; diff-aware rewrites see the previous AST root),
|
|
799
|
+
* then serialise. The chain is the single transfer-model-transform seam — a
|
|
800
|
+
* unary normalisation is just a rewrite that ignores `previous`, as
|
|
801
|
+
* `NormalizeEmptyStringsContribution` does. The chain is empty by
|
|
802
|
+
* default, so this is a no-op for adopters that register none.
|
|
803
|
+
*/
|
|
804
|
+
async modelToText(uri: string, model: TTransfer | string, cancelToken?: CancellationToken): Promise<string> {
|
|
805
|
+
if (typeof model === 'string') {
|
|
806
|
+
return model;
|
|
807
|
+
}
|
|
808
|
+
const rewritten = await this.rewriteModel(uri, model, cancelToken);
|
|
809
|
+
const target = UriUtils.toUri(uri);
|
|
810
|
+
const trivia = this.services.ServiceRegistry?.getServices(target)?.trivia?.TriviaService;
|
|
811
|
+
// Extracted BEFORE serializing, so it reads the document the write is
|
|
812
|
+
// about to replace rather than whatever a concurrent build left behind.
|
|
813
|
+
let document = this.services.workspace.LangiumDocuments.getDocument(target);
|
|
814
|
+
if (trivia !== undefined && document === undefined) {
|
|
815
|
+
const source = await this.textToTakeTriviaFrom(uri, target);
|
|
816
|
+
if (source !== undefined) {
|
|
817
|
+
document = this.services.workspace.LangiumDocumentFactory.fromString(source, target);
|
|
818
|
+
}
|
|
819
|
+
}
|
|
820
|
+
const extracted = trivia !== undefined && document !== undefined ? trivia.extract(document) : undefined;
|
|
821
|
+
const serialized = await this.serialize(uri, rewritten);
|
|
822
|
+
return extracted === undefined ? serialized : trivia!.apply(serialized, extracted, target);
|
|
823
|
+
}
|
|
824
|
+
|
|
749
825
|
// ============================================================
|
|
750
826
|
// LSP-client sync (mirror non-LSP-client changes back to Monaco)
|
|
751
827
|
// ============================================================
|
|
@@ -754,18 +830,14 @@ export class ModelService<
|
|
|
754
830
|
* Mirror a server-side change of `document` back to the LSP textual language
|
|
755
831
|
* client, run per document as it reaches the post-integrity settled phase.
|
|
756
832
|
* 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:
|
|
833
|
+
* `HydraniumTextDocuments.applyEditToLanguageClient`.
|
|
762
834
|
*
|
|
763
|
-
*
|
|
764
|
-
*
|
|
765
|
-
*
|
|
766
|
-
*
|
|
767
|
-
*
|
|
768
|
-
*
|
|
835
|
+
* Only a document open in the language client is mirrored, through
|
|
836
|
+
* {@link syncOpenDocument}, routed purely by **content**. A document open
|
|
837
|
+
* only in another client needs nothing: a language client opening it joins
|
|
838
|
+
* the existing entry and is refreshed from the store. A session writes only
|
|
839
|
+
* what it has open, so no session edit of a closed document waits here for
|
|
840
|
+
* the language client's next open.
|
|
769
841
|
*
|
|
770
842
|
* The decision is **re-derived from the current settled state every time** (it
|
|
771
843
|
* is not a one-shot enrolment), which is what makes it self-healing: a doc
|
|
@@ -775,9 +847,9 @@ export class ModelService<
|
|
|
775
847
|
*/
|
|
776
848
|
protected syncToLanguageClient(document: LangiumDocument): void {
|
|
777
849
|
// `document.textDocument.uri` is the server-identity (canonical) URI off the
|
|
778
|
-
// build. Route by
|
|
779
|
-
//
|
|
780
|
-
//
|
|
850
|
+
// build. Route by client registration (presence questions — both
|
|
851
|
+
// predicates canonicalize internally, so a divergent open path still
|
|
852
|
+
// resolves to the same record), but key the outbound sync by this
|
|
781
853
|
// CANONICAL URI — the same key `settleSave` looks the chain up under —
|
|
782
854
|
// so a save-settle can drain the in-flight applyEdit. The canonical→client-URI
|
|
783
855
|
// translation (a symlinked path the client opened, or a dual-open fan-out)
|
|
@@ -787,8 +859,6 @@ export class ModelService<
|
|
|
787
859
|
// the drain would miss for a divergent open path.
|
|
788
860
|
if (this.services.workspace.TextDocuments.isOpenInLanguageClient(document.textDocument.uri)) {
|
|
789
861
|
this.syncOpenDocument(document.textDocument.uri, document.textDocument.getText());
|
|
790
|
-
} else {
|
|
791
|
-
this.stageClosedDocument(document);
|
|
792
862
|
}
|
|
793
863
|
}
|
|
794
864
|
|
|
@@ -807,46 +877,6 @@ export class ModelService<
|
|
|
807
877
|
this.queueSync(uri, text);
|
|
808
878
|
}
|
|
809
879
|
|
|
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
880
|
/**
|
|
851
881
|
* Enqueue a sync to the language client. The pending slot per URI holds only
|
|
852
882
|
* the latest text: if a newer settle fires while the current RPC is in
|
|
@@ -878,13 +908,26 @@ export class ModelService<
|
|
|
878
908
|
this.syncChains.set(uri, chain);
|
|
879
909
|
}
|
|
880
910
|
|
|
911
|
+
/**
|
|
912
|
+
* The undo-stack label for a server-authored write, in the locale the server
|
|
913
|
+
* was handed at init.
|
|
914
|
+
*
|
|
915
|
+
* One method rather than the literal at each `applyEdit`, because the two
|
|
916
|
+
* call sites are the same edit — a push and its full-replace retry — and an
|
|
917
|
+
* undo menu showing two different words for one operation would read as two
|
|
918
|
+
* operations.
|
|
919
|
+
*/
|
|
920
|
+
protected editLabel(): string {
|
|
921
|
+
return this.services.MessageRenderer.renderMessage(MODEL_UPDATE_EDIT);
|
|
922
|
+
}
|
|
923
|
+
|
|
881
924
|
protected async drainSyncQueue(uri: string): Promise<void> {
|
|
882
925
|
const uriLogger = this.tracer.withUri(uri);
|
|
883
926
|
while (this.pendingSync.has(uri)) {
|
|
884
927
|
const text = this.pendingSync.get(uri)!;
|
|
885
928
|
this.pendingSync.delete(uri);
|
|
886
929
|
try {
|
|
887
|
-
let result = await this.services.workspace.TextDocuments.applyEditToLanguageClient(uri, text, { label:
|
|
930
|
+
let result = await this.services.workspace.TextDocuments.applyEditToLanguageClient(uri, text, { label: this.editLabel() });
|
|
888
931
|
if (result?.applied === false && !this.pendingSync.has(uri)) {
|
|
889
932
|
// The push is addressed at the client's LAST DECLARED VERSION, so a
|
|
890
933
|
// rejection normally means the client's buffer moved while the
|
|
@@ -905,7 +948,7 @@ export class ModelService<
|
|
|
905
948
|
// queued — best-effort, since a settle arriving later simply pushes
|
|
906
949
|
// after this and still wins.
|
|
907
950
|
uriLogger.warn(`Language client rejected applyEdit at its declared version — re-pushing a full replace`);
|
|
908
|
-
result = await this.services.workspace.TextDocuments.applyEditToLanguageClient(uri, text, { label:
|
|
951
|
+
result = await this.services.workspace.TextDocuments.applyEditToLanguageClient(uri, text, { label: this.editLabel() });
|
|
909
952
|
if (result?.applied === false) {
|
|
910
953
|
uriLogger.warn(`Language client rejected the full-replace retry too — client content is stale`);
|
|
911
954
|
}
|
|
@@ -935,9 +978,8 @@ export class ModelService<
|
|
|
935
978
|
* `HydraniumTextDocuments` — single listener registration shared with
|
|
936
979
|
* any direct `HydraniumTextDocuments.onUpdate` subscriber, so the same
|
|
937
980
|
* underlying `DocumentBuilder.onDocumentPhase` listener serves both
|
|
938
|
-
* call paths.
|
|
939
|
-
*
|
|
940
|
-
* `lastUpdate` snapshot (see `AstDocumentManager.onUpdate`).
|
|
981
|
+
* call paths. The event's reason, source and cause are
|
|
982
|
+
* {@link AstDocumentManager.attributeUpdate}'s.
|
|
941
983
|
*/
|
|
942
984
|
onModelUpdated(uri: string, listener: (event: AstDocumentUpdatedEvent<TAst, TDiagnostic>) => void): Disposable {
|
|
943
985
|
return this.services.workspace.AstDocumentManager.onUpdate(uri, listener as never);
|
|
@@ -979,13 +1021,13 @@ export class ModelService<
|
|
|
979
1021
|
* Adopters whose serializer call shape differs (custom service
|
|
980
1022
|
* names, generator-driven YAML pretty printers, etc.) override this
|
|
981
1023
|
* method. Routes through `Serializer.serializeTransfer` because
|
|
982
|
-
* `
|
|
1024
|
+
* a session's `update` / `save` always receive a
|
|
983
1025
|
* transfer-model shape (cross-references as plain strings) from
|
|
984
1026
|
* adopter callers — the AST-shape entry point is `serializeAst`.
|
|
985
1027
|
*
|
|
986
1028
|
* Returns {@link MaybePromise} so adopter `Serializer` overrides can be
|
|
987
1029
|
* async (remote schema lookup, external canonical-value resolution); the
|
|
988
|
-
* single caller ({@link modelToText}
|
|
1030
|
+
* single caller ({@link modelToText}) is already `async`,
|
|
989
1031
|
* so a naive `await` covers both branches without extra ceremony.
|
|
990
1032
|
*/
|
|
991
1033
|
protected serialize(uri: string, root: TTransfer): MaybePromise<string> {
|
|
@@ -998,22 +1040,12 @@ export class ModelService<
|
|
|
998
1040
|
// ============================================================
|
|
999
1041
|
|
|
1000
1042
|
/**
|
|
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.
|
|
1043
|
+
* The text a write into a document not yet built should take its trivia
|
|
1044
|
+
* from: the store's, which a write always has, since it writes only a
|
|
1045
|
+
* document its client has open.
|
|
1010
1046
|
*/
|
|
1011
|
-
protected async
|
|
1012
|
-
|
|
1013
|
-
return model;
|
|
1014
|
-
}
|
|
1015
|
-
const rewritten = await this.rewriteModel(uri, model, cancelToken);
|
|
1016
|
-
return this.serialize(uri, rewritten);
|
|
1047
|
+
protected async textToTakeTriviaFrom(uri: string, _target: URI): Promise<string | undefined> {
|
|
1048
|
+
return this.services.workspace.TextDocuments.get(uri)?.getText();
|
|
1017
1049
|
}
|
|
1018
1050
|
|
|
1019
1051
|
/**
|
|
@@ -1048,4 +1080,23 @@ export class ModelService<
|
|
|
1048
1080
|
? AstDocument.from<TAst, TDiagnostic>(document)
|
|
1049
1081
|
: AstDocument.create<TAst, TDiagnostic>(uri.toString(), 0, undefined as unknown as TAst, []);
|
|
1050
1082
|
}
|
|
1083
|
+
|
|
1084
|
+
/**
|
|
1085
|
+
* The same envelope with no diagnostics, for a read that names a phase below
|
|
1086
|
+
* `Validated`.
|
|
1087
|
+
*
|
|
1088
|
+
* Langium fills `LangiumDocument.diagnostics` from inside `validateDocument`
|
|
1089
|
+
* and from nowhere else, so below that phase the array holds whatever an
|
|
1090
|
+
* EARLIER build left — a verdict about text the document may no longer have.
|
|
1091
|
+
* The wait underneath resolves at or above the phase asked for, so a document
|
|
1092
|
+
* something else carried past `Validated` would otherwise hand a full array
|
|
1093
|
+
* back from `parsed()`.
|
|
1094
|
+
*
|
|
1095
|
+
* A copy rather than a clear: the envelope is freshly built here, but
|
|
1096
|
+
* {@link toAstDocument} is overridable and an adopter's version may return
|
|
1097
|
+
* one it also keeps.
|
|
1098
|
+
*/
|
|
1099
|
+
protected withoutDiagnostics(document: AstDocument<TAst, TDiagnostic>): AstDocument<TAst, never> {
|
|
1100
|
+
return { ...document, diagnostics: [] };
|
|
1101
|
+
}
|
|
1051
1102
|
}
|