@hydranium/core 1.0.0-next.14 → 1.0.0-next.148
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 +700 -126
- 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 +352 -16
- package/lib/langium/document-builder/document-builder.d.ts.map +1 -1
- package/lib/langium/document-builder/document-builder.js +616 -40
- 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 +261 -198
- package/lib/langium/model-service/model-service.d.ts.map +1 -1
- package/lib/langium/model-service/model-service.js +232 -344
- package/lib/langium/model-service/model-service.js.map +1 -1
- package/lib/langium/module.d.ts +107 -24
- 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-lock.d.ts +13 -0
- package/lib/langium/workspace/hydranium-workspace-lock.d.ts.map +1 -1
- package/lib/langium/workspace/hydranium-workspace-lock.js +18 -0
- package/lib/langium/workspace/hydranium-workspace-lock.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 +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/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 +27 -6
- 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 +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-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 +856 -154
- 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 +698 -39
- 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 +393 -349
- package/src/langium/module.ts +137 -30
- 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-lock.ts +21 -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 +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 +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 +103 -27
- 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/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,23 +9,32 @@
|
|
|
9
9
|
|
|
10
10
|
import { type Clock, type LogThreshold, type MaybeObservableValue, ObservableValue, type Tracer } from '@hydranium/protocol';
|
|
11
11
|
import {
|
|
12
|
+
type AstNode,
|
|
12
13
|
type BuildOptions,
|
|
13
14
|
DefaultDocumentBuilder,
|
|
14
15
|
type DocumentPhaseListener,
|
|
15
16
|
DocumentState,
|
|
16
17
|
type LangiumDocument,
|
|
18
|
+
MultiMap,
|
|
17
19
|
OperationCancelled,
|
|
18
20
|
type URI,
|
|
19
21
|
UriUtils,
|
|
22
|
+
type WorkspaceLock,
|
|
20
23
|
interruptAndCheck,
|
|
21
24
|
isOperationCancelled
|
|
22
25
|
} from '@hydranium/langium';
|
|
23
|
-
|
|
26
|
+
// `Diagnostic` as a VALUE: `renderDiagnostics` needs its `getMessageString`
|
|
27
|
+
// namespace helper to read the `string | MarkupContent` union without
|
|
28
|
+
// restating it.
|
|
29
|
+
import { CancellationToken, Diagnostic, Disposable } from 'vscode-languageserver-protocol';
|
|
24
30
|
import { type LogNameOptions } from '../diagnostics/logger.js';
|
|
31
|
+
import type { MessageRenderer } from '../../messages/renderer.js';
|
|
25
32
|
import { CST_REHYDRATION_RESET_STATE, isCstShed } from '../residency/cst-residency-service.js';
|
|
26
33
|
import { type ExtendedServiceRegistry } from '../service-registry.js';
|
|
27
34
|
import { type ServerSharedServicesMinimal } from '../shared-services.js';
|
|
28
35
|
import { type DocumentUriPolicy } from '../workspace/document-uri-policy.js';
|
|
36
|
+
import { HydraniumWorkspaceLock } from '../workspace/hydranium-workspace-lock.js';
|
|
37
|
+
import { BuildSession, type BuildSessionContext } from './build-session.js';
|
|
29
38
|
import { type LabeledPhaseListener, labelPhaseListener } from './labeled-phase-listener.js';
|
|
30
39
|
|
|
31
40
|
/** Document states a phase-reached line is emitted for by default — every built phase. */
|
|
@@ -38,6 +47,20 @@ export const DEFAULT_LOGGED_PHASES: DocumentState[] = [
|
|
|
38
47
|
DocumentState.Validated
|
|
39
48
|
];
|
|
40
49
|
|
|
50
|
+
/**
|
|
51
|
+
* The build reasons the framework stages through
|
|
52
|
+
* {@link HydraniumDocumentBuilder.markNextReason}: the LSP events the update
|
|
53
|
+
* handler dispatches on, and `didClose` for the revert the text store runs
|
|
54
|
+
* after a last close. Exposed so a subclass layering reasons of its own keeps
|
|
55
|
+
* the names the framework emits.
|
|
56
|
+
*/
|
|
57
|
+
export const HYDRANIUM_BUILD_REASONS = Object.freeze({
|
|
58
|
+
didOpen: 'didOpen',
|
|
59
|
+
didChangeContent: 'didChangeContent',
|
|
60
|
+
didChangeWatchedFiles: 'didChangeWatchedFiles',
|
|
61
|
+
didClose: 'didClose'
|
|
62
|
+
} as const);
|
|
63
|
+
|
|
41
64
|
/**
|
|
42
65
|
* Consecutive re-queued builds that leave a waited-on document at the same state
|
|
43
66
|
* before {@link HydraniumDocumentBuilder.awaitDocumentState} stops re-queuing it.
|
|
@@ -78,6 +101,18 @@ export interface DocumentBuilderOptions extends LogNameOptions {
|
|
|
78
101
|
* logged. Default: `25`. Read per phase; accepts a {@link MaybeObservableValue}.
|
|
79
102
|
*/
|
|
80
103
|
readonly slowBuildMs?: MaybeObservableValue<number>;
|
|
104
|
+
/**
|
|
105
|
+
* Build duration at or above which a build's phase-reached and slow-listener
|
|
106
|
+
* lines are emitted; they are held for the duration of the build and dropped
|
|
107
|
+
* when it finishes faster. Default `0` — no buffering, every line emitted as
|
|
108
|
+
* it is produced, which is the only setting that keeps lines interleaved with
|
|
109
|
+
* the rest of the log in real time.
|
|
110
|
+
*
|
|
111
|
+
* Set it to make a fast rebuild log nothing but its one build line. The
|
|
112
|
+
* decision needs the build's TOTAL duration, so it cannot be made by any
|
|
113
|
+
* per-line hook. Read once per build; accepts a {@link MaybeObservableValue}.
|
|
114
|
+
*/
|
|
115
|
+
readonly phaseDetailMs?: MaybeObservableValue<number>;
|
|
81
116
|
/**
|
|
82
117
|
* Refresh cross-document `ComputedScopes` derivations when a referencing
|
|
83
118
|
* document is cascade-rebuilt (see
|
|
@@ -91,29 +126,63 @@ export interface DocumentBuilderOptions extends LogNameOptions {
|
|
|
91
126
|
readonly refreshCrossDocumentComputedScopes?: boolean;
|
|
92
127
|
}
|
|
93
128
|
|
|
129
|
+
/**
|
|
130
|
+
* One locked build {@link HydraniumDocumentBuilder.scheduleUpdate} queued,
|
|
131
|
+
* which later requests merge into while it waits and join while it runs.
|
|
132
|
+
*/
|
|
133
|
+
export interface ScheduledUpdate {
|
|
134
|
+
/** URIs to build, by URI string. Merged requests change it while the write is queued; fixed once it runs. */
|
|
135
|
+
readonly changed: Map<string, URI>;
|
|
136
|
+
/** URIs to delete, by URI string, under the same rule as {@link changed}. */
|
|
137
|
+
readonly deleted: Map<string, URI>;
|
|
138
|
+
/** The latest build reason any merged request gave; staged through {@link HydraniumDocumentBuilder.markNextReason} when the write runs. */
|
|
139
|
+
reason?: string;
|
|
140
|
+
/** The lock's {@link HydraniumWorkspaceLock.writeCancellations} right after this write was queued. */
|
|
141
|
+
readonly cancellations: number;
|
|
142
|
+
/**
|
|
143
|
+
* Set when the write starts to run, so its presence marks a running build:
|
|
144
|
+
* the text version of each changed URI the text store holds at that point.
|
|
145
|
+
*/
|
|
146
|
+
takenVersions?: Map<string, number>;
|
|
147
|
+
/** The lock's promise for this write: settles when the build completes or is cancelled. */
|
|
148
|
+
readonly promise: Promise<void>;
|
|
149
|
+
}
|
|
150
|
+
|
|
94
151
|
/**
|
|
95
152
|
* Extends Langium's {@link DefaultDocumentBuilder} with:
|
|
96
153
|
*
|
|
97
154
|
* - **Bug-fixes** (always on): an {@link awaitDocumentState} that waits where
|
|
98
|
-
* the default rejects,
|
|
155
|
+
* the default rejects (re-queuing, under the workspace lock, a document no
|
|
156
|
+
* build will carry), a {@link prepareBuild} that keeps a cancelled
|
|
99
157
|
* non-validating build from suppressing validation, and a
|
|
100
158
|
* {@link shouldRelink} that never judges a document unaffected on an index
|
|
101
159
|
* that does not describe it.
|
|
160
|
+
* - **Shared locked builds** ({@link scheduleUpdate}): build requests that
|
|
161
|
+
* coincide share one locked build instead of cancelling each other.
|
|
102
162
|
* - **URI handling** (always on): directory-aware flattening and cascade
|
|
103
163
|
* deletes in {@link update}, plus the CST-rehydration and cross-document
|
|
104
164
|
* refresh resets in {@link resetToState}.
|
|
105
165
|
* - **In-place rebuild helpers** — {@link reparse} and
|
|
106
166
|
* {@link reparseAndRelink} — for a build-phase listener that mutated a
|
|
107
167
|
* document's AST and must reconcile it within the same build.
|
|
108
|
-
* - **Diagnostic dedupe** at `Validated` ({@link dedupeDiagnostics})
|
|
168
|
+
* - **Diagnostic dedupe** at `Validated` ({@link dedupeDiagnostics}), followed
|
|
169
|
+
* by the **one server-side message render** every head inherits
|
|
170
|
+
* ({@link renderDiagnostics}).
|
|
171
|
+
* - **Build sessions** ({@link BuildSession}): each `update` / `build` call is
|
|
172
|
+
* one correlated unit carrying an id, a trigger label, a start time and
|
|
173
|
+
* cancellation lineage, so every line of a rebuild reads as belonging to it
|
|
174
|
+
* and a preempted build is distinguishable from the winner.
|
|
109
175
|
* - **Logging instrumentation** (default on, opt-out via `logLevel: 'off'`):
|
|
110
|
-
* phase-reached lines, slow-listener breakdowns on
|
|
111
|
-
* and slow-build-phase totals on `notifyBuildPhase`.
|
|
176
|
+
* a per-build line, phase-reached lines, slow-listener breakdowns on
|
|
177
|
+
* `notifyDocumentPhase`, and slow-build-phase totals on `notifyBuildPhase`.
|
|
112
178
|
*
|
|
113
179
|
* Adopters extend this class — the configuration knobs cover what most
|
|
114
180
|
* adopters need; the `format*Line` methods, `formatUri`, and
|
|
115
181
|
* `collectDeletedURIs` are protected so subclasses can customise wording or
|
|
116
|
-
* domain-aware cascades without re-implementing surrounding logic.
|
|
182
|
+
* domain-aware cascades without re-implementing surrounding logic. An adopter
|
|
183
|
+
* with build-scoped state of its own subclasses {@link BuildSession} and
|
|
184
|
+
* overrides {@link createBuildSession}, which puts that state under the same
|
|
185
|
+
* preemption-correct teardown rather than a reimplementation of it.
|
|
117
186
|
*/
|
|
118
187
|
export class HydraniumDocumentBuilder extends DefaultDocumentBuilder {
|
|
119
188
|
protected readonly tracer: Tracer;
|
|
@@ -127,8 +196,15 @@ export class HydraniumDocumentBuilder extends DefaultDocumentBuilder {
|
|
|
127
196
|
protected readonly slowListenerMs: ObservableValue<number>;
|
|
128
197
|
/** Live slow-build-phase-total threshold; read `.value` per phase. */
|
|
129
198
|
protected readonly slowBuildMs: ObservableValue<number>;
|
|
199
|
+
/** Live phase-detail buffering threshold; read `.value` once per build, onto the session. */
|
|
200
|
+
protected readonly phaseDetailMs: ObservableValue<number>;
|
|
130
201
|
protected readonly uriPolicy: DocumentUriPolicy;
|
|
131
202
|
protected readonly clock: Clock;
|
|
203
|
+
protected readonly messageRenderer: MessageRenderer;
|
|
204
|
+
/** The lock {@link scheduleUpdate} builds under. */
|
|
205
|
+
protected readonly workspaceLock: WorkspaceLock;
|
|
206
|
+
/** The latest write {@link scheduleUpdate} queued, until it ends; see {@link ScheduledUpdate}. */
|
|
207
|
+
protected scheduledUpdate?: ScheduledUpdate;
|
|
132
208
|
/** Narrower handle on the same registry as the inherited `serviceRegistry`, for {@link ExtendedServiceRegistry.registrations}. */
|
|
133
209
|
protected readonly languageRegistry: ExtendedServiceRegistry;
|
|
134
210
|
protected languageFileExtensions: string[] = [];
|
|
@@ -139,18 +215,50 @@ export class HydraniumDocumentBuilder extends DefaultDocumentBuilder {
|
|
|
139
215
|
protected readonly refreshCrossDocumentComputedScopes: boolean;
|
|
140
216
|
/** LSP event name (e.g. `'didChangeWatchedFiles'`) staged for the next `update()` call. */
|
|
141
217
|
protected pendingUpdateReason?: string;
|
|
218
|
+
/**
|
|
219
|
+
* The build currently in progress, or `undefined` between builds.
|
|
220
|
+
*
|
|
221
|
+
* A subclass carrying its own build-scoped state returns a {@link BuildSession}
|
|
222
|
+
* subclass from {@link createBuildSession} and narrows this with a typeguard
|
|
223
|
+
* where it reads that state — rather than redeclaring the field, whose
|
|
224
|
+
* initialiser would run after `super()` and clear a session opened during
|
|
225
|
+
* construction.
|
|
226
|
+
*/
|
|
227
|
+
protected activeSession?: BuildSession;
|
|
228
|
+
/**
|
|
229
|
+
* `traceId` of the last build that ended in cancellation, for the successor's
|
|
230
|
+
* "cancels #N" tag. Held here rather than on a session because the session
|
|
231
|
+
* that carries it is already gone by the time its successor is opened.
|
|
232
|
+
*/
|
|
233
|
+
protected lastCancelledTraceId?: number;
|
|
234
|
+
/** Registered through {@link onDocumentPhaseDelivered}, by phase. */
|
|
235
|
+
protected readonly documentPhaseDeliveredListeners = new MultiMap<DocumentState, (document: LangiumDocument, version: number) => void>();
|
|
236
|
+
/**
|
|
237
|
+
* Called with `false` by {@link buildDocuments} once a build has run every
|
|
238
|
+
* phase, and with `true` by {@link checkWaitsOnceDrained} after a build that
|
|
239
|
+
* threw; see {@link awaitDocumentState}. A listener runs synchronously,
|
|
240
|
+
* inside the build or inside that check's lock read. A throw fails the
|
|
241
|
+
* finished build; in the read it skips the listeners after it and surfaces
|
|
242
|
+
* only as an unhandled rejection.
|
|
243
|
+
*/
|
|
244
|
+
protected readonly buildEndedListeners = new Set<(drained: boolean) => void>();
|
|
245
|
+
/** Set while the lock read {@link checkWaitsOnceDrained} queued has not run. */
|
|
246
|
+
protected drainCheckQueued = false;
|
|
142
247
|
|
|
143
248
|
constructor(services: ServerSharedServicesMinimal, options: DocumentBuilderOptions = {}) {
|
|
144
249
|
super(services);
|
|
145
250
|
this.languageRegistry = services.ServiceRegistry;
|
|
146
251
|
this.uriPolicy = services.workspace.DocumentUriPolicy;
|
|
147
252
|
this.clock = services.Clock;
|
|
253
|
+
this.messageRenderer = services.MessageRenderer;
|
|
254
|
+
this.workspaceLock = services.workspace.WorkspaceLock;
|
|
148
255
|
this.tracer = services.Tracer.for(options.logName ?? 'DocumentBuilder').trace('instantiated');
|
|
149
256
|
this.logLevel = options.logLevel ?? 'debug';
|
|
150
257
|
this.loggedPhases = options.loggedPhases ?? DEFAULT_LOGGED_PHASES;
|
|
151
258
|
this.slowPhaseMs = ObservableValue.from(options.slowPhaseMs ?? 25);
|
|
152
259
|
this.slowListenerMs = ObservableValue.from(options.slowListenerMs ?? 5);
|
|
153
260
|
this.slowBuildMs = ObservableValue.from(options.slowBuildMs ?? 25);
|
|
261
|
+
this.phaseDetailMs = ObservableValue.from(options.phaseDetailMs ?? 0);
|
|
154
262
|
this.refreshCrossDocumentComputedScopes = options.refreshCrossDocumentComputedScopes ?? false;
|
|
155
263
|
if (this.logLevel !== 'off') {
|
|
156
264
|
this.registerPhaseListeners();
|
|
@@ -163,8 +271,8 @@ export class HydraniumDocumentBuilder extends DefaultDocumentBuilder {
|
|
|
163
271
|
|
|
164
272
|
/**
|
|
165
273
|
* Stage an LSP event name for the next `update()` call. Adopters call before
|
|
166
|
-
* the update fires; `HydraniumDocumentUpdateHandler` does it for the
|
|
167
|
-
*
|
|
274
|
+
* the update fires; `HydraniumDocumentUpdateHandler` does it for the LSP
|
|
275
|
+
* events, and the text store for the revert that follows a last close.
|
|
168
276
|
*
|
|
169
277
|
* The framework stages the value and never reads it back. The consumer is a
|
|
170
278
|
* subclass overriding the build logging, which takes
|
|
@@ -176,6 +284,24 @@ export class HydraniumDocumentBuilder extends DefaultDocumentBuilder {
|
|
|
176
284
|
this.pendingUpdateReason = reason;
|
|
177
285
|
}
|
|
178
286
|
|
|
287
|
+
/**
|
|
288
|
+
* Call `listener` with a document once every {@link onDocumentPhase}
|
|
289
|
+
* listener of `state` ran for it and none was skipped by cancellation, and
|
|
290
|
+
* with the text version the phase listeners were called at. A write during
|
|
291
|
+
* them moves the document's own version on, past what they saw.
|
|
292
|
+
*
|
|
293
|
+
* Only here is it known what the phase listeners delivered. Langium sets the
|
|
294
|
+
* document's state before it notifies, and a cancel between two listeners
|
|
295
|
+
* skips the rest, leaving the document at the phase with those listeners
|
|
296
|
+
* never run and nothing to run them later. A build-phase listener comes too
|
|
297
|
+
* late: a cancel after this document but before the batch ends skips it,
|
|
298
|
+
* although every listener of this document ran.
|
|
299
|
+
*/
|
|
300
|
+
onDocumentPhaseDelivered(state: DocumentState, listener: (document: LangiumDocument, version: number) => void): Disposable {
|
|
301
|
+
this.documentPhaseDeliveredListeners.add(state, listener);
|
|
302
|
+
return Disposable.create(() => this.documentPhaseDeliveredListeners.delete(state, listener));
|
|
303
|
+
}
|
|
304
|
+
|
|
179
305
|
/**
|
|
180
306
|
* Diagnostic snapshot for use in timeout/error messages around document
|
|
181
307
|
* state.
|
|
@@ -193,7 +319,16 @@ export class HydraniumDocumentBuilder extends DefaultDocumentBuilder {
|
|
|
193
319
|
const doc = this.langiumDocuments.getDocument(UriUtils.toUri(this.uriPolicy.canonicalUri(uri)));
|
|
194
320
|
const docState = doc ? DocumentState[doc.state] : 'unknown (document not loaded)';
|
|
195
321
|
const lastPhase = this.lastPhaseMs > 0 ? `${Math.round(performance.now() - this.lastPhaseMs)}ms ago` : 'no phase observed';
|
|
196
|
-
return `current state: '${docState}', last phase: ${lastPhase}`;
|
|
322
|
+
return `current state: '${docState}', last phase: ${lastPhase}, active build: ${this.formatSession(this.activeSession)}`;
|
|
323
|
+
}
|
|
324
|
+
|
|
325
|
+
/** Render a session for a status line. `undefined` — no build in progress — reads as `none`. */
|
|
326
|
+
protected formatSession(session: BuildSession | undefined): string {
|
|
327
|
+
if (!session) {
|
|
328
|
+
return 'none';
|
|
329
|
+
}
|
|
330
|
+
const id = session.traceId !== undefined ? `#${session.traceId}` : 'untimed';
|
|
331
|
+
return `${id} (${session.trigger}, ${Math.round(performance.now() - session.startMs)}ms in)`;
|
|
197
332
|
}
|
|
198
333
|
|
|
199
334
|
// ============================================================
|
|
@@ -214,20 +349,36 @@ export class HydraniumDocumentBuilder extends DefaultDocumentBuilder {
|
|
|
214
349
|
*
|
|
215
350
|
* Replacing Langium's rejection with a wait makes the wait's liveness this
|
|
216
351
|
* class's responsibility: a listener can only fire if some build is still
|
|
217
|
-
* going to reach `state`.
|
|
218
|
-
*
|
|
219
|
-
*
|
|
220
|
-
* the
|
|
352
|
+
* going to reach `state`. So the wait re-queues the document whenever
|
|
353
|
+
* {@link isOrphaned} holds: once when it is armed, and again after every
|
|
354
|
+
* build that completes (see {@link buildDocuments}). The second check is
|
|
355
|
+
* the one a wait armed during a build needs, since only the build's end
|
|
356
|
+
* shows whether it left the document behind; Langium's `onBuildPhase` for
|
|
357
|
+
* `Validated` cannot serve, as it stays silent for a build that validates
|
|
358
|
+
* nothing, such as the workspace's initial one. A build that throws is
|
|
359
|
+
* checked once the lock drains instead (see {@link checkWaitsOnceDrained}):
|
|
360
|
+
* whatever cancelled it may build nothing. Re-queuing stops after
|
|
221
361
|
* {@link MAX_STALLED_REQUEUES} builds that fail to advance the document, so a
|
|
222
362
|
* document the builder will never carry to `state` degrades to a pending wait
|
|
223
363
|
* plus a warning rather than an endless build loop.
|
|
364
|
+
*
|
|
365
|
+
* A wait for `Validated` on a document that a validating build skips
|
|
366
|
+
* resolves once that build has indexed its references, without diagnostics:
|
|
367
|
+
* see {@link skipsValidation}. Waiting on would never end, and re-queuing
|
|
368
|
+
* would skip it again.
|
|
369
|
+
*
|
|
370
|
+
* A re-queued build takes the {@link WorkspaceLock} (see
|
|
371
|
+
* {@link requeueOrphaned}), so a caller that awaits this wait while it holds
|
|
372
|
+
* the lock, inside a read or write action, deadlocks on a document that needs
|
|
373
|
+
* a re-queue: the build waits for that action to end. Await it outside the
|
|
374
|
+
* lock.
|
|
224
375
|
*/
|
|
225
376
|
protected override awaitDocumentState(state: DocumentState, uri: URI, cancelToken: CancellationToken): Promise<URI> {
|
|
226
377
|
const document = this.langiumDocuments.getDocument(uri);
|
|
227
378
|
if (!document) {
|
|
228
379
|
return super.awaitDocumentState(state, uri, cancelToken);
|
|
229
380
|
}
|
|
230
|
-
if (document.state >= state) {
|
|
381
|
+
if (document.state >= state || (state === DocumentState.Validated && this.skipsValidation(document))) {
|
|
231
382
|
return Promise.resolve(uri);
|
|
232
383
|
}
|
|
233
384
|
return new Promise<URI>((resolve, reject) => {
|
|
@@ -267,34 +418,70 @@ export class HydraniumDocumentBuilder extends DefaultDocumentBuilder {
|
|
|
267
418
|
}
|
|
268
419
|
}, 'awaitDocumentState')
|
|
269
420
|
);
|
|
270
|
-
|
|
271
|
-
|
|
421
|
+
// The phase after which a validating build either validates the
|
|
422
|
+
// document or has skipped it.
|
|
423
|
+
const skipDisposable =
|
|
424
|
+
state === DocumentState.Validated
|
|
425
|
+
? this.onDocumentPhase(
|
|
426
|
+
DocumentState.IndexedReferences,
|
|
427
|
+
labelPhaseListener((doc: LangiumDocument): void => {
|
|
428
|
+
if (UriUtils.equals(doc.uri, uri) && this.skipsValidation(doc)) {
|
|
429
|
+
cleanup();
|
|
430
|
+
resolve(doc.uri);
|
|
431
|
+
}
|
|
432
|
+
}, 'awaitDocumentState.skipsValidation')
|
|
433
|
+
)
|
|
434
|
+
: Disposable.create(() => undefined);
|
|
435
|
+
const buildEnded = (drained: boolean): void => {
|
|
436
|
+
if (document.state >= state || (state === DocumentState.Validated && this.skipsValidation(document))) {
|
|
272
437
|
cleanup();
|
|
273
438
|
resolve(uri);
|
|
274
|
-
} else {
|
|
275
|
-
//
|
|
276
|
-
|
|
439
|
+
} else if (drained ? this.activeSession === undefined : this.isOrphaned(document, state)) {
|
|
440
|
+
// No build is left to carry the document to `state`. Either
|
|
441
|
+
// check fails only while an unlocked build still runs; that
|
|
442
|
+
// build carries the document or ends here too.
|
|
443
|
+
requeue(drained ? 'build ended early' : 'build ended short of the target');
|
|
277
444
|
}
|
|
278
|
-
}
|
|
445
|
+
};
|
|
446
|
+
this.buildEndedListeners.add(buildEnded);
|
|
447
|
+
const buildDisposable = Disposable.create(() => this.buildEndedListeners.delete(buildEnded));
|
|
279
448
|
const cancelDisposable = cancelToken.onCancellationRequested(() => {
|
|
280
449
|
cleanup();
|
|
281
450
|
reject(OperationCancelled);
|
|
282
451
|
});
|
|
283
452
|
const cleanup = (): void => {
|
|
284
453
|
phaseDisposable.dispose();
|
|
454
|
+
skipDisposable.dispose();
|
|
285
455
|
buildDisposable.dispose();
|
|
286
456
|
cancelDisposable.dispose();
|
|
287
457
|
};
|
|
288
458
|
// Orphaned BEFORE the wait was armed: the build that would have
|
|
289
|
-
// advanced this document has already finished, so
|
|
290
|
-
//
|
|
291
|
-
// the resulting build resolves this wait.
|
|
459
|
+
// advanced this document has already finished, so none of these
|
|
460
|
+
// listeners fires until some other build runs. Re-queue now — the listeners are
|
|
461
|
+
// registered, so the resulting build resolves this wait.
|
|
292
462
|
if (this.isOrphaned(document, state)) {
|
|
293
463
|
requeue('quiescent builder');
|
|
294
464
|
}
|
|
295
465
|
});
|
|
296
466
|
}
|
|
297
467
|
|
|
468
|
+
/**
|
|
469
|
+
* Whether the build that carries or last carried `document` has indexed its
|
|
470
|
+
* references, asks for validation, and still skips it, which is an override
|
|
471
|
+
* of `shouldValidate` excluding it. A build that does not ask for
|
|
472
|
+
* validation, such as the workspace's initial one, is not a skip: the next
|
|
473
|
+
* validating build validates the document. Nor is a document below
|
|
474
|
+
* `IndexedReferences`: the build writes its options before the first phase,
|
|
475
|
+
* so the document would pass for skipped before it is even parsed.
|
|
476
|
+
*/
|
|
477
|
+
protected skipsValidation(document: LangiumDocument): boolean {
|
|
478
|
+
return (
|
|
479
|
+
document.state >= DocumentState.IndexedReferences &&
|
|
480
|
+
Boolean(this.getBuildOptions(document).validation) &&
|
|
481
|
+
!this.shouldValidate(document)
|
|
482
|
+
);
|
|
483
|
+
}
|
|
484
|
+
|
|
298
485
|
/**
|
|
299
486
|
* Whether no build will advance `document` to `state`, so a wait on it can
|
|
300
487
|
* only be resolved by starting one.
|
|
@@ -312,7 +499,9 @@ export class HydraniumDocumentBuilder extends DefaultDocumentBuilder {
|
|
|
312
499
|
* `currentState` still advances to `Validated` (the validation phase runs
|
|
313
500
|
* over an empty document list). Any first read that wants diagnostics — a
|
|
314
501
|
* one-shot data-head read, a CLI query, `ModelService.validated` — lands
|
|
315
|
-
* here.
|
|
502
|
+
* here. A read that arrives while that build still runs finds `currentState`
|
|
503
|
+
* below `state`, so this holds for it only once the build has ended, which
|
|
504
|
+
* is why {@link awaitDocumentState} asks again then.
|
|
316
505
|
*/
|
|
317
506
|
protected isOrphaned(document: LangiumDocument, state: DocumentState): boolean {
|
|
318
507
|
return document.state < state && this.currentState >= state;
|
|
@@ -324,13 +513,207 @@ export class HydraniumDocumentBuilder extends DefaultDocumentBuilder {
|
|
|
324
513
|
* notification, so awaiting here would invert the dependency. A rejection is
|
|
325
514
|
* logged rather than swallowed — it leaves the waiter pending until its own
|
|
326
515
|
* cancellation token fires, which is worth a line in the log.
|
|
516
|
+
*
|
|
517
|
+
* The build is a {@link scheduleUpdate}, entered from a {@link WorkspaceLock}
|
|
518
|
+
* read. The read waits until no write runs or is queued, so the build neither
|
|
519
|
+
* runs beside a locked one nor cancels the build a re-queue is fired from.
|
|
520
|
+
* Unlocked, it runs beside a locked build that cannot cancel it: both
|
|
521
|
+
* validate the same version and deliver it twice. Taking the write directly,
|
|
522
|
+
* without the read, cancels the running build and skips the rest of its
|
|
523
|
+
* build-phase listeners. The read must not await the write, which queues
|
|
524
|
+
* behind that read. A build scheduled in the gap between the read batch
|
|
525
|
+
* starting and this action running is still queued, so the re-queue merges
|
|
526
|
+
* into it rather than cancelling it.
|
|
527
|
+
*
|
|
528
|
+
* A write that ran while the read waited may have carried the document to
|
|
529
|
+
* `state` already, and a second build would deliver that version again; the
|
|
530
|
+
* read skips the write then.
|
|
327
531
|
*/
|
|
328
532
|
protected requeueOrphaned(document: LangiumDocument, state: DocumentState, reason: string): void {
|
|
329
533
|
const tracer = this.tracer.withUri(document.uri.toString());
|
|
330
534
|
tracer.info(`Re-queuing orphaned document (at '${DocumentState[document.state]}', needs '${DocumentState[state]}'): ${reason}`);
|
|
331
|
-
this.
|
|
332
|
-
if (
|
|
333
|
-
|
|
535
|
+
void this.workspaceLock.read(() => {
|
|
536
|
+
if (document.state >= state) {
|
|
537
|
+
return;
|
|
538
|
+
}
|
|
539
|
+
this.scheduleUpdate([document.uri], []).catch((err: unknown) => {
|
|
540
|
+
if (!isOperationCancelled(err)) {
|
|
541
|
+
tracer.error(`Re-queue build failed: ${err instanceof Error ? err.message : String(err)}`);
|
|
542
|
+
}
|
|
543
|
+
});
|
|
544
|
+
});
|
|
545
|
+
}
|
|
546
|
+
|
|
547
|
+
// ============================================================
|
|
548
|
+
// Scheduled updates — one locked build for requests that coincide
|
|
549
|
+
// ============================================================
|
|
550
|
+
|
|
551
|
+
/**
|
|
552
|
+
* Build `changed` and `deleted` under the {@link WorkspaceLock}, as
|
|
553
|
+
* `workspaceLock.write(token => update(changed, deleted, token))` would,
|
|
554
|
+
* except where the build this method queued last already carries the
|
|
555
|
+
* request. The promise settles when the build that carries the request
|
|
556
|
+
* ends, completed or cancelled, as the lock's own promise does.
|
|
557
|
+
*
|
|
558
|
+
* Without it, requests that coincide cancel each other: each lock write
|
|
559
|
+
* cancels the one before it, after Langium's `update` has already reset the
|
|
560
|
+
* documents, scanned the workspace for relinking and called every
|
|
561
|
+
* `onUpdate` listener.
|
|
562
|
+
*
|
|
563
|
+
* - **Queued, not yet running:** the request merges into it, so nothing is
|
|
564
|
+
* cancelled. The later of a change and a deletion of one URI wins, so
|
|
565
|
+
* each URI reaches `update` in one list only: a file deleted and written
|
|
566
|
+
* again before the build starts is a change.
|
|
567
|
+
* - **Running:** the request joins it only when {@link canJoinRunningUpdate}
|
|
568
|
+
* holds, which keeps an edit made while it runs cancelling it.
|
|
569
|
+
* - **Otherwise,** or when anything else has cancelled that write since it
|
|
570
|
+
* was queued, a new write, which cancels the running build as any lock
|
|
571
|
+
* write does.
|
|
572
|
+
*
|
|
573
|
+
* `reason` is staged through {@link markNextReason} when the write runs. The
|
|
574
|
+
* latest reason of a merged request wins, as it does in the update
|
|
575
|
+
* handler's own debounced burst; a joining request's reason is dropped, since
|
|
576
|
+
* the build it joins has already started. A request without one leaves a
|
|
577
|
+
* reason staged by the caller in place.
|
|
578
|
+
*
|
|
579
|
+
* A caller that must run code of its own inside the write action takes the
|
|
580
|
+
* lock itself, and forgoes the sharing. A lock that is not a
|
|
581
|
+
* {@link HydraniumWorkspaceLock} cannot report a cancelled queued write, so
|
|
582
|
+
* every request then takes its own write.
|
|
583
|
+
*/
|
|
584
|
+
scheduleUpdate(changed: URI[], deleted: URI[], reason?: string): Promise<void> {
|
|
585
|
+
const lock = this.workspaceLock;
|
|
586
|
+
if (!(lock instanceof HydraniumWorkspaceLock)) {
|
|
587
|
+
return lock.write(token => {
|
|
588
|
+
if (reason !== undefined) {
|
|
589
|
+
this.markNextReason(reason);
|
|
590
|
+
}
|
|
591
|
+
return this.update(changed, deleted, token);
|
|
592
|
+
});
|
|
593
|
+
}
|
|
594
|
+
const scheduled = this.scheduledUpdate;
|
|
595
|
+
if (scheduled && scheduled.cancellations === lock.writeCancellations) {
|
|
596
|
+
if (!scheduled.takenVersions) {
|
|
597
|
+
for (const uri of changed) {
|
|
598
|
+
scheduled.changed.set(uri.toString(), uri);
|
|
599
|
+
scheduled.deleted.delete(uri.toString());
|
|
600
|
+
}
|
|
601
|
+
for (const uri of deleted) {
|
|
602
|
+
scheduled.deleted.set(uri.toString(), uri);
|
|
603
|
+
scheduled.changed.delete(uri.toString());
|
|
604
|
+
}
|
|
605
|
+
scheduled.reason = reason ?? scheduled.reason;
|
|
606
|
+
return scheduled.promise;
|
|
607
|
+
}
|
|
608
|
+
if (this.canJoinRunningUpdate(scheduled, changed, deleted)) {
|
|
609
|
+
return scheduled.promise;
|
|
610
|
+
}
|
|
611
|
+
}
|
|
612
|
+
// The action runs on a later tick, by which time `request` is assigned.
|
|
613
|
+
const promise = lock.write(token => this.runScheduledUpdate(request, token));
|
|
614
|
+
const request: ScheduledUpdate = {
|
|
615
|
+
changed: new Map(changed.map(uri => [uri.toString(), uri])),
|
|
616
|
+
deleted: new Map(deleted.map(uri => [uri.toString(), uri])),
|
|
617
|
+
reason,
|
|
618
|
+
cancellations: lock.writeCancellations,
|
|
619
|
+
promise
|
|
620
|
+
};
|
|
621
|
+
this.scheduledUpdate = request;
|
|
622
|
+
return promise;
|
|
623
|
+
}
|
|
624
|
+
|
|
625
|
+
/**
|
|
626
|
+
* Whether a request for `changed` and `deleted` is carried by the running
|
|
627
|
+
* `scheduled` build, whose write nothing has cancelled: the request deletes
|
|
628
|
+
* nothing, and each changed URI is one the build took, held by the text
|
|
629
|
+
* store at the version it had when the build started.
|
|
630
|
+
*
|
|
631
|
+
* Each condition keeps a request from joining a build that would miss its
|
|
632
|
+
* change. Text that moved since the start may be newer than what the build
|
|
633
|
+
* parsed; a URI the text store does not hold is read from its file, which
|
|
634
|
+
* may have changed after the build read it; and a deletion may concern a
|
|
635
|
+
* document the build has already built. A joined request is also absent
|
|
636
|
+
* from the running `update`'s `onUpdate` call, which reported the store as
|
|
637
|
+
* it was when the build started; at an unchanged version that is the store
|
|
638
|
+
* the request sees.
|
|
639
|
+
*/
|
|
640
|
+
protected canJoinRunningUpdate(scheduled: ScheduledUpdate, changed: URI[], deleted: URI[]): boolean {
|
|
641
|
+
const taken = scheduled.takenVersions;
|
|
642
|
+
if (!taken || deleted.length > 0) {
|
|
643
|
+
return false;
|
|
644
|
+
}
|
|
645
|
+
return changed.every(uri => taken.has(uri.toString()) && taken.get(uri.toString()) === this.textDocuments?.get(uri)?.version);
|
|
646
|
+
}
|
|
647
|
+
|
|
648
|
+
/**
|
|
649
|
+
* The write action of a {@link scheduleUpdate}: freeze the request, record
|
|
650
|
+
* what it takes, stage its reason and run `update`. Releases
|
|
651
|
+
* {@link scheduledUpdate} inside the lock, whatever throws, so a request
|
|
652
|
+
* arriving after the build ends starts a write of its own rather than
|
|
653
|
+
* joining a build that is over.
|
|
654
|
+
*/
|
|
655
|
+
protected async runScheduledUpdate(request: ScheduledUpdate, token: CancellationToken): Promise<void> {
|
|
656
|
+
try {
|
|
657
|
+
const taken = new Map<string, number>();
|
|
658
|
+
for (const [key, uri] of request.changed) {
|
|
659
|
+
const version = this.textDocuments?.get(uri)?.version;
|
|
660
|
+
if (version !== undefined) {
|
|
661
|
+
taken.set(key, version);
|
|
662
|
+
}
|
|
663
|
+
}
|
|
664
|
+
request.takenVersions = taken;
|
|
665
|
+
if (request.reason !== undefined) {
|
|
666
|
+
this.markNextReason(request.reason);
|
|
667
|
+
}
|
|
668
|
+
await this.update([...request.changed.values()], [...request.deleted.values()], token);
|
|
669
|
+
} finally {
|
|
670
|
+
if (this.scheduledUpdate === request) {
|
|
671
|
+
this.scheduledUpdate = undefined;
|
|
672
|
+
}
|
|
673
|
+
}
|
|
674
|
+
}
|
|
675
|
+
|
|
676
|
+
/**
|
|
677
|
+
* Tell the {@link buildEndedListeners} once every phase has run, which is
|
|
678
|
+
* the one point where a build that skipped a waited-on document can be seen
|
|
679
|
+
* to have ended. Langium's `onBuildPhase` for `Validated` is not: it stays
|
|
680
|
+
* silent when no document reached that phase, which is every build that
|
|
681
|
+
* validates nothing, the workspace's initial one among them.
|
|
682
|
+
*
|
|
683
|
+
* A build that throws, whether cancelled or failed, tells none of them
|
|
684
|
+
* here: `currentState` is then below `Validated`, so {@link isOrphaned}
|
|
685
|
+
* could hold for no wait. {@link checkWaitsOnceDrained} tells them instead.
|
|
686
|
+
*/
|
|
687
|
+
protected override async buildDocuments(
|
|
688
|
+
documents: LangiumDocument[],
|
|
689
|
+
options: BuildOptions,
|
|
690
|
+
cancelToken: CancellationToken
|
|
691
|
+
): Promise<void> {
|
|
692
|
+
await super.buildDocuments(documents, options, cancelToken);
|
|
693
|
+
for (const listener of [...this.buildEndedListeners]) {
|
|
694
|
+
listener(false);
|
|
695
|
+
}
|
|
696
|
+
}
|
|
697
|
+
|
|
698
|
+
/**
|
|
699
|
+
* After a build that threw, tell the {@link buildEndedListeners}, with
|
|
700
|
+
* `drained` set, from a {@link WorkspaceLock} read: it runs once no write
|
|
701
|
+
* runs or is queued, so no locked build is left that could still carry a
|
|
702
|
+
* waited-on document. A cancelled build is usually followed by its
|
|
703
|
+
* canceller's, but a write that builds nothing, such as a last-close revert
|
|
704
|
+
* that finds its document reopened, leaves a wait armed during the build
|
|
705
|
+
* with nothing to resolve it, and so does a build that fails. One read
|
|
706
|
+
* serves every build that throws before it runs.
|
|
707
|
+
*/
|
|
708
|
+
protected checkWaitsOnceDrained(): void {
|
|
709
|
+
if (this.drainCheckQueued) {
|
|
710
|
+
return;
|
|
711
|
+
}
|
|
712
|
+
this.drainCheckQueued = true;
|
|
713
|
+
void this.workspaceLock.read(() => {
|
|
714
|
+
this.drainCheckQueued = false;
|
|
715
|
+
for (const listener of [...this.buildEndedListeners]) {
|
|
716
|
+
listener(true);
|
|
334
717
|
}
|
|
335
718
|
});
|
|
336
719
|
}
|
|
@@ -409,7 +792,35 @@ export class HydraniumDocumentBuilder extends DefaultDocumentBuilder {
|
|
|
409
792
|
this.ensureLanguageFileExtensions();
|
|
410
793
|
const changedURIs = changed.flatMap(uri => this.flattenAndAdaptURI(uri));
|
|
411
794
|
const deletedURIs = deleted.flatMap(uri => this.collectDeletedURIs(uri));
|
|
412
|
-
return
|
|
795
|
+
return this.runInSession(
|
|
796
|
+
{
|
|
797
|
+
kind: 'update',
|
|
798
|
+
trigger: this.buildTriggerLabel(changedURIs, deletedURIs),
|
|
799
|
+
triggerCountsDocs: changedURIs.length + deletedURIs.length !== 1,
|
|
800
|
+
changed: changedURIs,
|
|
801
|
+
deleted: deletedURIs
|
|
802
|
+
},
|
|
803
|
+
this.rebuildLabel(changedURIs, deletedURIs),
|
|
804
|
+
() => super.update(changedURIs, deletedURIs, cancelToken)
|
|
805
|
+
);
|
|
806
|
+
}
|
|
807
|
+
|
|
808
|
+
/**
|
|
809
|
+
* The workspace-initialization entry point, bracketed by a session like
|
|
810
|
+
* {@link update}. Langium's `update` reaches `buildDocuments` directly rather
|
|
811
|
+
* than through here, so the two never nest.
|
|
812
|
+
*/
|
|
813
|
+
override build<T extends AstNode>(
|
|
814
|
+
documents: Array<LangiumDocument<T>>,
|
|
815
|
+
options?: BuildOptions,
|
|
816
|
+
cancelToken?: CancellationToken
|
|
817
|
+
): Promise<void> {
|
|
818
|
+
const uris = documents.map(document => document.uri);
|
|
819
|
+
return this.runInSession(
|
|
820
|
+
{ kind: 'build', trigger: `${documents.length} docs`, triggerCountsDocs: true, changed: uris, deleted: [] },
|
|
821
|
+
`Build documents (${documents.length} docs)`,
|
|
822
|
+
() => super.build(documents, options, cancelToken)
|
|
823
|
+
);
|
|
413
824
|
}
|
|
414
825
|
|
|
415
826
|
/**
|
|
@@ -615,6 +1026,151 @@ export class HydraniumDocumentBuilder extends DefaultDocumentBuilder {
|
|
|
615
1026
|
];
|
|
616
1027
|
}
|
|
617
1028
|
|
|
1029
|
+
// ============================================================
|
|
1030
|
+
// Build sessions — one rebuild as a correlated unit
|
|
1031
|
+
// ============================================================
|
|
1032
|
+
|
|
1033
|
+
/**
|
|
1034
|
+
* Open a session, run `body` inside it, and close it — the bracket every
|
|
1035
|
+
* line of a rebuild is emitted within.
|
|
1036
|
+
*
|
|
1037
|
+
* The session is installed **synchronously**, before the timed body runs, so
|
|
1038
|
+
* that state a subclass computed in {@link createBuildSession} is already
|
|
1039
|
+
* readable by the time Langium's `update` consults `shouldRelink`.
|
|
1040
|
+
*
|
|
1041
|
+
* Teardown is preemption-correct, which is the reason this is framework code
|
|
1042
|
+
* rather than a recipe. A build outside the workspace lock overlaps another:
|
|
1043
|
+
* the later one installs itself as {@link activeSession} while the earlier
|
|
1044
|
+
* one is still running, and the earlier one's `finally` runs LAST. Clearing
|
|
1045
|
+
* unconditionally there would discard the later build's state mid-build.
|
|
1046
|
+
* Only the session that is still current clears — and the check is
|
|
1047
|
+
* reference equality on the session object,
|
|
1048
|
+
* not on {@link BuildSession.traceId}, which is `undefined` for every build
|
|
1049
|
+
* whenever the timing level is suppressed and would compare equal to itself
|
|
1050
|
+
* across two different builds.
|
|
1051
|
+
*
|
|
1052
|
+
* Builds outside the lock are not hypothetical even without an adopter: the
|
|
1053
|
+
* model service with `serializeBuilds` off starts one. Two locked builds
|
|
1054
|
+
* never overlap, since the lock starts a write only once the write it
|
|
1055
|
+
* cancelled has unwound.
|
|
1056
|
+
*/
|
|
1057
|
+
protected runInSession(context: BuildSessionContext, label: string, body: () => Promise<void>): Promise<void> {
|
|
1058
|
+
// Read before installing the new session: the id being superseded belongs
|
|
1059
|
+
// to the OUTGOING build, or — when the previous one already finished
|
|
1060
|
+
// cancelled — to the id it parked for its successor.
|
|
1061
|
+
const supersededId = this.activeSession?.traceId ?? this.lastCancelledTraceId;
|
|
1062
|
+
this.lastCancelledTraceId = undefined;
|
|
1063
|
+
const reason = this.pendingUpdateReason;
|
|
1064
|
+
this.pendingUpdateReason = undefined;
|
|
1065
|
+
const tags: string[] = [];
|
|
1066
|
+
if (reason) {
|
|
1067
|
+
tags.push(`event: ${reason}`);
|
|
1068
|
+
}
|
|
1069
|
+
if (supersededId !== undefined) {
|
|
1070
|
+
tags.push(`cancels #${supersededId}`);
|
|
1071
|
+
}
|
|
1072
|
+
|
|
1073
|
+
const session = this.createBuildSession(context);
|
|
1074
|
+
this.activeSession = session;
|
|
1075
|
+
// A phase's "since previous phase" must measure from the build's start,
|
|
1076
|
+
// not from whenever the last build's final phase happened to land.
|
|
1077
|
+
this.lastPhaseMs = session.startMs;
|
|
1078
|
+
return this.tracer.time(
|
|
1079
|
+
label,
|
|
1080
|
+
async () => {
|
|
1081
|
+
try {
|
|
1082
|
+
await body();
|
|
1083
|
+
} catch (err: unknown) {
|
|
1084
|
+
if (isOperationCancelled(err)) {
|
|
1085
|
+
session.cancelled = true;
|
|
1086
|
+
}
|
|
1087
|
+
this.checkWaitsOnceDrained();
|
|
1088
|
+
throw err;
|
|
1089
|
+
} finally {
|
|
1090
|
+
this.endSession(session);
|
|
1091
|
+
}
|
|
1092
|
+
},
|
|
1093
|
+
this.logLevel,
|
|
1094
|
+
{
|
|
1095
|
+
logAfterMs: 0,
|
|
1096
|
+
forceMemoryAboveMs: session.buffers ? session.detailThresholdMs : undefined,
|
|
1097
|
+
captureId: id => {
|
|
1098
|
+
session.traceId = id;
|
|
1099
|
+
},
|
|
1100
|
+
tags
|
|
1101
|
+
}
|
|
1102
|
+
);
|
|
1103
|
+
}
|
|
1104
|
+
|
|
1105
|
+
/**
|
|
1106
|
+
* Construct the session for one build. Override to return a
|
|
1107
|
+
* {@link BuildSession} subclass carrying adopter build-scoped state — it is
|
|
1108
|
+
* called before the build body, so anything derived here is readable
|
|
1109
|
+
* throughout it.
|
|
1110
|
+
*/
|
|
1111
|
+
protected createBuildSession(context: BuildSessionContext): BuildSession {
|
|
1112
|
+
return new BuildSession(performance.now(), context.trigger, context.triggerCountsDocs, this.phaseDetailMs.value);
|
|
1113
|
+
}
|
|
1114
|
+
|
|
1115
|
+
/**
|
|
1116
|
+
* Close `session`: flush what it buffered, then release it if it is still the
|
|
1117
|
+
* current one (see {@link runInSession} on why that check is conditional).
|
|
1118
|
+
* The flush is unconditional — a preempted build's lines still describe work
|
|
1119
|
+
* that happened.
|
|
1120
|
+
*/
|
|
1121
|
+
protected endSession(session: BuildSession): void {
|
|
1122
|
+
this.flushSession(session);
|
|
1123
|
+
if (this.activeSession === session) {
|
|
1124
|
+
this.activeSession = undefined;
|
|
1125
|
+
if (session.cancelled) {
|
|
1126
|
+
this.lastCancelledTraceId = session.traceId;
|
|
1127
|
+
}
|
|
1128
|
+
}
|
|
1129
|
+
}
|
|
1130
|
+
|
|
1131
|
+
/**
|
|
1132
|
+
* Emit the lines `session` held back, if it ran long enough to be worth the
|
|
1133
|
+
* detail; drop them otherwise. Emits through {@link emit} rather than
|
|
1134
|
+
* {@link log}, which would route them straight back into the buffer.
|
|
1135
|
+
*/
|
|
1136
|
+
protected flushSession(session: BuildSession): void {
|
|
1137
|
+
const elapsedMs = performance.now() - session.startMs;
|
|
1138
|
+
if (elapsedMs >= session.detailThresholdMs) {
|
|
1139
|
+
for (const line of session.bufferedLines) {
|
|
1140
|
+
this.emit(line);
|
|
1141
|
+
}
|
|
1142
|
+
}
|
|
1143
|
+
session.bufferedLines.length = 0;
|
|
1144
|
+
}
|
|
1145
|
+
|
|
1146
|
+
/** Label for the build's own log line. Override to customise wording. */
|
|
1147
|
+
protected rebuildLabel(changed: URI[], deleted: URI[]): string {
|
|
1148
|
+
if (changed.length === 0 && deleted.length === 0) {
|
|
1149
|
+
return 'Rebuild documents (nothing to do)';
|
|
1150
|
+
}
|
|
1151
|
+
if (changed.length === 1 && deleted.length === 0) {
|
|
1152
|
+
return `Rebuild document: ${this.formatUri(changed[0])}`;
|
|
1153
|
+
}
|
|
1154
|
+
if (changed.length === 0 && deleted.length === 1) {
|
|
1155
|
+
return `Rebuild after delete: ${this.formatUri(deleted[0])}`;
|
|
1156
|
+
}
|
|
1157
|
+
return `Rebuild documents (${changed.length} changed, ${deleted.length} deleted)`;
|
|
1158
|
+
}
|
|
1159
|
+
|
|
1160
|
+
/** Short description of what triggered the build, repeated on every phase line. Override to customise wording. */
|
|
1161
|
+
protected buildTriggerLabel(changed: URI[], deleted: URI[]): string {
|
|
1162
|
+
if (changed.length === 0 && deleted.length === 0) {
|
|
1163
|
+
return 'nothing';
|
|
1164
|
+
}
|
|
1165
|
+
if (changed.length === 1 && deleted.length === 0) {
|
|
1166
|
+
return this.formatUri(changed[0]);
|
|
1167
|
+
}
|
|
1168
|
+
if (changed.length === 0 && deleted.length === 1) {
|
|
1169
|
+
return `deleted ${this.formatUri(deleted[0])}`;
|
|
1170
|
+
}
|
|
1171
|
+
return `${changed.length} changed, ${deleted.length} deleted`;
|
|
1172
|
+
}
|
|
1173
|
+
|
|
618
1174
|
// ============================================================
|
|
619
1175
|
// Logging — phase-reached listeners
|
|
620
1176
|
// ============================================================
|
|
@@ -630,17 +1186,39 @@ export class HydraniumDocumentBuilder extends DefaultDocumentBuilder {
|
|
|
630
1186
|
const now = performance.now();
|
|
631
1187
|
const elapsedMs = Math.round(now - this.lastPhaseMs);
|
|
632
1188
|
this.lastPhaseMs = now;
|
|
1189
|
+
// Counted before the line is formatted, so the formatter stays a pure
|
|
1190
|
+
// function of state a caller can also set up in a test.
|
|
1191
|
+
if (this.activeSession) {
|
|
1192
|
+
this.activeSession.phasesLogged++;
|
|
1193
|
+
}
|
|
633
1194
|
this.log(this.phaseReachedLine(state, documents, elapsedMs));
|
|
634
1195
|
}
|
|
635
1196
|
|
|
636
|
-
/**
|
|
1197
|
+
/**
|
|
1198
|
+
* Format the phase-reached log line. Override to customise wording.
|
|
1199
|
+
*
|
|
1200
|
+
* Within a session the line names what triggered the build, so a phase read
|
|
1201
|
+
* in isolation still says which rebuild it belongs to. `elapsedMs` is ignored
|
|
1202
|
+
* for the FIRST phase of a session: it measures from the previous build's
|
|
1203
|
+
* last phase, an idle gap that says nothing about this build.
|
|
1204
|
+
*/
|
|
637
1205
|
protected phaseReachedLine(state: DocumentState, documents: LangiumDocument[], elapsedMs: number): string {
|
|
638
|
-
const
|
|
639
|
-
|
|
1206
|
+
const session = this.activeSession;
|
|
1207
|
+
let docInfo: string;
|
|
1208
|
+
if (session) {
|
|
1209
|
+
docInfo = session.triggerCountsDocs ? `building ${session.trigger}` : `building ${session.trigger}, ${documents.length} docs`;
|
|
1210
|
+
} else {
|
|
1211
|
+
docInfo = documents.length === 1 ? this.formatUri(documents[0].uri) : `${documents.length} docs`;
|
|
1212
|
+
}
|
|
1213
|
+
const elapsedInfo =
|
|
1214
|
+
session && session.phasesLogged <= 1
|
|
1215
|
+
? `${Math.round(performance.now() - session.startMs)}ms since build start`
|
|
1216
|
+
: `${elapsedMs}ms since previous phase`;
|
|
1217
|
+
return `Reached phase '${DocumentState[state]}' [${docInfo}, ${elapsedInfo}]`;
|
|
640
1218
|
}
|
|
641
1219
|
|
|
642
1220
|
// ============================================================
|
|
643
|
-
//
|
|
1221
|
+
// notifyDocumentPhase — the delivery hook and the slow-listener breakdown
|
|
644
1222
|
// ============================================================
|
|
645
1223
|
|
|
646
1224
|
override async notifyDocumentPhase(document: LangiumDocument, state: DocumentState, cancelToken: CancellationToken): Promise<void> {
|
|
@@ -651,16 +1229,15 @@ export class HydraniumDocumentBuilder extends DefaultDocumentBuilder {
|
|
|
651
1229
|
// build settling inside that window therefore appends after this call has
|
|
652
1230
|
// already deduped, and the appended duplicate is published by the listener
|
|
653
1231
|
// of the build that deduped. Only `serializeBuilds` closes the window.
|
|
1232
|
+
//
|
|
1233
|
+
// Dedupe before rendering: rendering is deterministic, so it cannot
|
|
1234
|
+
// change which entries are structurally equal, and fewer survive to render.
|
|
654
1235
|
if (state === DocumentState.Validated) {
|
|
655
1236
|
this.dedupeDiagnostics(document);
|
|
656
|
-
|
|
657
|
-
if (this.logLevel === 'off') {
|
|
658
|
-
return super.notifyDocumentPhase(document, state, cancelToken);
|
|
1237
|
+
this.renderDiagnostics(document);
|
|
659
1238
|
}
|
|
660
1239
|
const listeners = this.documentPhaseListeners.get(state).slice();
|
|
661
|
-
|
|
662
|
-
return;
|
|
663
|
-
}
|
|
1240
|
+
const version = document.textDocument.version;
|
|
664
1241
|
const perListenerMs: number[] = [];
|
|
665
1242
|
let cancelledListeners = 0;
|
|
666
1243
|
const { elapsedMs: totalMs } = await this.clock.measure(async () => {
|
|
@@ -679,6 +1256,14 @@ export class HydraniumDocumentBuilder extends DefaultDocumentBuilder {
|
|
|
679
1256
|
perListenerMs.push(elapsedMs);
|
|
680
1257
|
}
|
|
681
1258
|
});
|
|
1259
|
+
if (cancelledListeners === 0) {
|
|
1260
|
+
for (const delivered of this.documentPhaseDeliveredListeners.get(state).slice()) {
|
|
1261
|
+
delivered(document, version);
|
|
1262
|
+
}
|
|
1263
|
+
}
|
|
1264
|
+
if (this.logLevel === 'off' || listeners.length === 0) {
|
|
1265
|
+
return;
|
|
1266
|
+
}
|
|
682
1267
|
if (cancelledListeners > 0) {
|
|
683
1268
|
this.tracer
|
|
684
1269
|
.withUri(document.uri.toString())
|
|
@@ -828,12 +1413,86 @@ export class HydraniumDocumentBuilder extends DefaultDocumentBuilder {
|
|
|
828
1413
|
}
|
|
829
1414
|
}
|
|
830
1415
|
|
|
1416
|
+
/**
|
|
1417
|
+
* Render every diagnostic on `document` through the bound message renderer,
|
|
1418
|
+
* in ONE pass over the finished list.
|
|
1419
|
+
*
|
|
1420
|
+
* All three heads read `document.diagnostics` — the LSP publish,
|
|
1421
|
+
* `TransferEncoder.toTransferDiagnostic` and the GLSP validation path — so
|
|
1422
|
+
* one pass here is what keeps the render from happening per head. It is also
|
|
1423
|
+
* the only placement that covers lexer and parser errors, which Langium
|
|
1424
|
+
* pushes onto the document without routing them through `toDiagnostic`.
|
|
1425
|
+
*
|
|
1426
|
+
* Running here rather than from a `Validated` phase listener needs no
|
|
1427
|
+
* ordering assumption: Langium publishes from `addDiagnosticsHandler`, a free
|
|
1428
|
+
* function it registers as such a listener, which can only be outrun.
|
|
1429
|
+
*
|
|
1430
|
+
* **It inherits {@link dedupeDiagnostics}'s window, and therefore the same
|
|
1431
|
+
* precondition.** A build settling inside the listener window appends
|
|
1432
|
+
* diagnostics this pass never saw, and the publisher of the build that
|
|
1433
|
+
* rendered sends them — unrendered. `ModelServiceOptions.serializeBuilds`
|
|
1434
|
+
* closes it and defaults to `true`, so "every diagnostic is rendered" holds
|
|
1435
|
+
* by default and is an opt-out rather than a guarantee. Opting out accepts
|
|
1436
|
+
* unrendered diagnostics on exactly the terms it already accepts duplicates.
|
|
1437
|
+
*
|
|
1438
|
+
* Entries are REPLACED rather than mutated: `sendDiagnostics` passes the
|
|
1439
|
+
* array by reference and serialises later, so an in-place message mutation
|
|
1440
|
+
* reaches the wire even when it runs after the publisher — which would make
|
|
1441
|
+
* a test for the ordering pass in either state.
|
|
1442
|
+
*/
|
|
1443
|
+
protected renderDiagnostics(document: LangiumDocument): void {
|
|
1444
|
+
const diagnostics = document.diagnostics;
|
|
1445
|
+
if (!diagnostics || diagnostics.length === 0) {
|
|
1446
|
+
return;
|
|
1447
|
+
}
|
|
1448
|
+
let changed = false;
|
|
1449
|
+
// No try/catch: `renderDiagnostic` carries a no-throw contract, because an
|
|
1450
|
+
// error escaping this phase strands the document at `Validated` with
|
|
1451
|
+
// Langium's publisher never invoked.
|
|
1452
|
+
const rendered = diagnostics.map(diagnostic => {
|
|
1453
|
+
const text = this.messageRenderer.renderDiagnostic(diagnostic);
|
|
1454
|
+
// Against the message's STRING FORM, not the field. `renderDiagnostic`
|
|
1455
|
+
// answers a `string` by contract, while `Diagnostic.message` is
|
|
1456
|
+
// `string | MarkupContent` since LSP 3.17 — so comparing the answer
|
|
1457
|
+
// against the field never matches for a markup message, and a pass
|
|
1458
|
+
// that replaced on mismatch flattened every un-identified markup
|
|
1459
|
+
// diagnostic to its own plain text. That is silent data loss on the
|
|
1460
|
+
// path whose whole job is to leave such entries alone.
|
|
1461
|
+
if (text === Diagnostic.getMessageString(diagnostic)) {
|
|
1462
|
+
return diagnostic;
|
|
1463
|
+
}
|
|
1464
|
+
changed = true;
|
|
1465
|
+
return { ...diagnostic, message: text };
|
|
1466
|
+
});
|
|
1467
|
+
if (changed) {
|
|
1468
|
+
document.diagnostics = rendered;
|
|
1469
|
+
}
|
|
1470
|
+
}
|
|
1471
|
+
|
|
831
1472
|
// ============================================================
|
|
832
1473
|
// Internal helpers
|
|
833
1474
|
// ============================================================
|
|
834
1475
|
|
|
835
|
-
/**
|
|
1476
|
+
/**
|
|
1477
|
+
* Dispatch a log line at the configured log level; a no-op when `logLevel ===
|
|
1478
|
+
* 'off'`.
|
|
1479
|
+
*
|
|
1480
|
+
* Held on the active session when it buffers, so the "was this build worth a
|
|
1481
|
+
* per-phase breakdown" decision — which needs the build's total duration, and
|
|
1482
|
+
* so cannot be taken by anything that runs while the lines are produced — is
|
|
1483
|
+
* deferred to {@link flushSession}.
|
|
1484
|
+
*/
|
|
836
1485
|
protected log(message: string): void {
|
|
1486
|
+
const session = this.activeSession;
|
|
1487
|
+
if (session?.buffers) {
|
|
1488
|
+
session.bufferedLines.push(message);
|
|
1489
|
+
return;
|
|
1490
|
+
}
|
|
1491
|
+
this.emit(message);
|
|
1492
|
+
}
|
|
1493
|
+
|
|
1494
|
+
/** Write a line out, bypassing session buffering. The single sink every framework log line reaches. */
|
|
1495
|
+
protected emit(message: string): void {
|
|
837
1496
|
this.tracer.logAt(this.logLevel, message);
|
|
838
1497
|
}
|
|
839
1498
|
}
|