@hydranium/core 1.0.0-next.12 → 1.0.0-next.123
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 +92 -19
- package/lib/documents/ast-document-manager.d.ts.map +1 -1
- package/lib/documents/ast-document-manager.js +107 -26
- 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 +184 -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 +324 -57
- package/lib/documents/hydranium-text-documents.d.ts.map +1 -1
- package/lib/documents/hydranium-text-documents.js +590 -114
- 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 +165 -9
- package/lib/langium/document-builder/document-builder.d.ts.map +1 -1
- package/lib/langium/document-builder/document-builder.js +313 -13
- 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 +54 -6
- package/lib/langium/integrity/integrity-service.d.ts.map +1 -1
- package/lib/langium/integrity/integrity-service.js +192 -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 +299 -0
- package/lib/langium/model-service/client-session.d.ts.map +1 -0
- package/lib/langium/model-service/client-session.js +379 -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 +224 -160
- package/lib/langium/model-service/model-service.d.ts.map +1 -1
- package/lib/langium/model-service/model-service.js +191 -288
- package/lib/langium/model-service/model-service.js.map +1 -1
- package/lib/langium/module.d.ts +95 -16
- 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 +1 -1
- package/lib/langium/workspace/write-lock-scope.js +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 +123 -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 +15 -0
- package/lib/node/socket-launcher.d.ts.map +1 -1
- package/lib/node/socket-launcher.js +3 -2
- package/lib/node/socket-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 +61 -13
- 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 +8 -9
- package/lib/testing/stub-ast-document-manager.js.map +1 -1
- package/lib/testing/stub-document-builder.d.ts +8 -0
- package/lib/testing/stub-document-builder.d.ts.map +1 -1
- package/lib/testing/stub-document-builder.js +22 -3
- package/lib/testing/stub-document-builder.js.map +1 -1
- package/lib/testing/stub-hydranium-text-documents.d.ts +19 -6
- package/lib/testing/stub-hydranium-text-documents.d.ts.map +1 -1
- package/lib/testing/stub-hydranium-text-documents.js +53 -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 +188 -45
- package/src/documents/client-ids.ts +5 -22
- package/src/documents/client-session-errors.ts +22 -0
- package/src/documents/client-session-registry.ts +237 -0
- package/src/documents/file-system-task-queue.ts +68 -0
- package/src/documents/hydranium-text-documents.ts +724 -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 +355 -13
- 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 +201 -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 +581 -0
- package/src/langium/model-service/index.ts +1 -0
- package/src/langium/model-service/model-service.ts +332 -274
- package/src/langium/module.ts +119 -22
- 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 +1 -1
- package/src/locale/index.ts +10 -0
- package/src/locale/server-locale.ts +86 -0
- package/src/lsp/completion/hydranium-completion-provider.ts +82 -2
- package/src/lsp/connection-features.ts +67 -0
- package/src/lsp/diagnostics-connection.ts +56 -0
- package/src/lsp/hydranium-document-update-handler.ts +152 -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 +18 -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 +99 -24
- 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 +18 -31
- package/src/testing/stub-document-builder.ts +32 -3
- package/src/testing/stub-hydranium-text-documents.ts +78 -21
- 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
|
@@ -20,7 +20,7 @@
|
|
|
20
20
|
// on lsp-server, contradicting the peer architecture.
|
|
21
21
|
// eslint-disable-next-line @typescript-eslint/no-restricted-imports
|
|
22
22
|
import { NormalizedTextDocuments } from '@hydranium/langium/lsp';
|
|
23
|
-
import { UriUtils } from '@hydranium/langium';
|
|
23
|
+
import { URI, UriUtils } from '@hydranium/langium';
|
|
24
24
|
import { type ServerSharedServices } from '../langium/module.js';
|
|
25
25
|
import {
|
|
26
26
|
type ApplyWorkspaceEditResult,
|
|
@@ -31,12 +31,13 @@ import {
|
|
|
31
31
|
type DidOpenTextDocumentParams,
|
|
32
32
|
type DidSaveTextDocumentParams,
|
|
33
33
|
type Disposable,
|
|
34
|
-
|
|
34
|
+
Emitter,
|
|
35
35
|
type Event,
|
|
36
36
|
type HandlerResult,
|
|
37
37
|
OptionalVersionedTextDocumentIdentifier,
|
|
38
38
|
type RequestHandler,
|
|
39
39
|
type TextDocumentChangeEvent,
|
|
40
|
+
TextDocumentContentChangeEvent as ContentChange,
|
|
40
41
|
TextDocumentEdit,
|
|
41
42
|
TextDocumentSyncKind,
|
|
42
43
|
type TextDocumentWillSaveEvent,
|
|
@@ -45,9 +46,20 @@ import {
|
|
|
45
46
|
type WillSaveTextDocumentParams
|
|
46
47
|
} from 'vscode-languageserver';
|
|
47
48
|
import { type DocumentUri, TextDocument, type TextDocumentContentChangeEvent } from 'vscode-languageserver-textdocument';
|
|
48
|
-
import {
|
|
49
|
+
import {
|
|
50
|
+
type CanonicalUri,
|
|
51
|
+
type LanguageClientUri,
|
|
52
|
+
asLanguageClientUri,
|
|
53
|
+
DisposableCollection,
|
|
54
|
+
type Stopwatch,
|
|
55
|
+
type Tracer
|
|
56
|
+
} from '@hydranium/protocol';
|
|
49
57
|
import { type LogNameOptions } from '../langium/diagnostics/logger.js';
|
|
58
|
+
import { HYDRANIUM_BUILD_REASONS } from '../langium/document-builder/document-builder.js';
|
|
59
|
+
import { isConnectionGoneError } from '../util/connection-liveness.js';
|
|
50
60
|
import { LANGUAGE_CLIENT_ID } from './client-ids.js';
|
|
61
|
+
import { INTEGRITY_CLIENT_ID } from '../langium/integrity/integrity-rule.js';
|
|
62
|
+
import { type ClientSessionClosedEvent, ClientSessionRegistry, type SessionEndCause } from './client-session-registry.js';
|
|
51
63
|
import { isFullReplace, LanguageClientTextShadow } from './language-client-text-shadow.js';
|
|
52
64
|
|
|
53
65
|
/**
|
|
@@ -74,6 +86,39 @@ export interface HydraniumTextDocumentsOptions<T extends TextDocument = TextDocu
|
|
|
74
86
|
* Adopters with a custom text-document type (rare) pass their factory.
|
|
75
87
|
*/
|
|
76
88
|
readonly configuration?: TextDocumentsConfiguration<T>;
|
|
89
|
+
/**
|
|
90
|
+
* How long a document whose last open closed because its client's
|
|
91
|
+
* connection was lost keeps its text before it reverts to disk. An open by
|
|
92
|
+
* a client lost from the document, within this time of its own loss,
|
|
93
|
+
* cancels the revert, so a client that registers again under its id after
|
|
94
|
+
* a dropped connection finds its unsaved edits. Any other open releases the
|
|
95
|
+
* document first and then opens it as a first open does, from the text the
|
|
96
|
+
* opener supplies (an editor's own) or else from the file. Meanwhile the
|
|
97
|
+
* document counts as open for the integrity service, which therefore writes
|
|
98
|
+
* none of its unsaved text to disk. A close the client makes itself, or
|
|
99
|
+
* ending its session, reverts at once whatever this is.
|
|
100
|
+
*
|
|
101
|
+
* Defaults to 10 s. `0` reverts such a document at once as well, released
|
|
102
|
+
* in the close itself rather than on a timer.
|
|
103
|
+
*/
|
|
104
|
+
readonly revertGraceMs?: number;
|
|
105
|
+
}
|
|
106
|
+
|
|
107
|
+
/**
|
|
108
|
+
* The default of {@link HydraniumTextDocumentsOptions.revertGraceMs}: long
|
|
109
|
+
* enough for a client whose connection dropped to register again and reopen
|
|
110
|
+
* its documents, which a data client does as soon as it has a connection.
|
|
111
|
+
*/
|
|
112
|
+
const DEFAULT_REVERT_GRACE_MS = 10_000;
|
|
113
|
+
|
|
114
|
+
/** Delivered by {@link HydraniumTextDocuments.onDidSaveInLanguageClient}. */
|
|
115
|
+
export interface LanguageClientSavedEvent {
|
|
116
|
+
readonly uri: string;
|
|
117
|
+
}
|
|
118
|
+
|
|
119
|
+
/** Delivered by {@link HydraniumTextDocuments.onDidCloseLastOpen}. */
|
|
120
|
+
export interface LastOpenClosedEvent {
|
|
121
|
+
readonly uri: CanonicalUri;
|
|
77
122
|
}
|
|
78
123
|
|
|
79
124
|
/**
|
|
@@ -89,10 +134,13 @@ export interface HydraniumTextDocumentsOptions<T extends TextDocument = TextDocu
|
|
|
89
134
|
* separately-tested diff/apply-verify abstraction that owns its own baseline
|
|
90
135
|
* text; folding its storage here would couple a clean utility to this record
|
|
91
136
|
* for no real gain.
|
|
137
|
+
*
|
|
138
|
+
* Returned by the `protected` {@link HydraniumTextDocuments.trackingFor}, so an
|
|
139
|
+
* override has to name it. Restating the shape structurally instead compiles
|
|
140
|
+
* until a field is added here, and then fails at the adopter rather than at the
|
|
141
|
+
* change that caused it.
|
|
92
142
|
*/
|
|
93
|
-
interface
|
|
94
|
-
/** Client ids currently holding this document open (multi-client membership). */
|
|
95
|
-
readonly clients: Set<string>;
|
|
143
|
+
export interface DocumentTrackingRecord {
|
|
96
144
|
/** Author of each version, sparse-indexed by the SHARED (server-assigned) version number. */
|
|
97
145
|
readonly versionAuthors: string[];
|
|
98
146
|
/**
|
|
@@ -115,6 +163,22 @@ interface DocumentTracking {
|
|
|
115
163
|
* record on last close.
|
|
116
164
|
*/
|
|
117
165
|
languageClientUris?: Set<LanguageClientUri>;
|
|
166
|
+
/**
|
|
167
|
+
* The clients whose close of this document was caused by a lost connection
|
|
168
|
+
* and that have not opened it again, each with a stopwatch started at its
|
|
169
|
+
* loss on the store's `Clock`. While the document waits out the revert grace, only an
|
|
170
|
+
* open by one of them within its own
|
|
171
|
+
* {@link HydraniumTextDocumentsOptions.revertGraceMs} of that loss cancels
|
|
172
|
+
* the revert. Every such client counts, not only the last to close: one
|
|
173
|
+
* connection's sessions all end lost together, and any of them may reopen
|
|
174
|
+
* first. Without the time limit, a client that returns late inherits the
|
|
175
|
+
* unsaved text of a holder lost after it. A stopwatch rather than a `now()`
|
|
176
|
+
* reading, because a wall-clock step would otherwise expire a claim early or
|
|
177
|
+
* revive one past its grace, against a grace timer that the step leaves
|
|
178
|
+
* alone. An entry past its grace counts as any other client's and is pruned
|
|
179
|
+
* at the next open of the document.
|
|
180
|
+
*/
|
|
181
|
+
lostClients?: Map<string, Stopwatch>;
|
|
118
182
|
}
|
|
119
183
|
|
|
120
184
|
/**
|
|
@@ -128,13 +192,28 @@ export interface OpenDocument {
|
|
|
128
192
|
readonly clients: readonly string[];
|
|
129
193
|
}
|
|
130
194
|
|
|
195
|
+
/**
|
|
196
|
+
* What {@link HydraniumTextDocuments.commitRepair} did with an integrity repair.
|
|
197
|
+
*
|
|
198
|
+
* Three outcomes rather than a document-or-nothing, because the two ways of
|
|
199
|
+
* getting nothing call for opposite responses: `not-open` means there is no
|
|
200
|
+
* store document to correct and the caller carries on with the one it holds,
|
|
201
|
+
* while `stale` means there IS one and it has moved past the text the repair
|
|
202
|
+
* was computed against — so carrying on would persist a correction over an edit
|
|
203
|
+
* that superseded it. Collapsing them lets the second read as permission to
|
|
204
|
+
* proceed, which is the failure this shape exists to make unrepresentable.
|
|
205
|
+
*/
|
|
206
|
+
export type RepairCommit<T extends TextDocument> =
|
|
207
|
+
{ readonly status: 'committed'; readonly document: T } | { readonly status: 'stale' } | { readonly status: 'not-open' };
|
|
208
|
+
|
|
131
209
|
/**
|
|
132
210
|
* Where a URI's shared version sequence left off — written once at last-client
|
|
133
211
|
* close, consulted at the next open so the sequence CONTINUES instead of
|
|
134
212
|
* restarting at whatever version id the reopening client declares. One entry
|
|
135
|
-
* of {@link HydraniumTextDocuments.__versionSequences}
|
|
213
|
+
* of {@link HydraniumTextDocuments.__versionSequences} — a `protected` field, so
|
|
214
|
+
* a subclass reading the map has to name what it holds.
|
|
136
215
|
*/
|
|
137
|
-
interface VersionSequence {
|
|
216
|
+
export interface VersionSequence {
|
|
138
217
|
/** The shared version at last-client close. */
|
|
139
218
|
readonly version: number;
|
|
140
219
|
/** {@link contentHash} of the synced text at last-client close. */
|
|
@@ -161,19 +240,20 @@ interface ConnectionWithTextDocumentSync {
|
|
|
161
240
|
/**
|
|
162
241
|
* One text pushed to the LSP textual language client by
|
|
163
242
|
* {@link HydraniumTextDocuments.applyEditToLanguageClient} whose echo has not
|
|
164
|
-
* come back yet. One entry of {@link HydraniumTextDocuments.__pendingPushes}
|
|
243
|
+
* come back yet. One entry of {@link HydraniumTextDocuments.__pendingPushes} —
|
|
244
|
+
* a `protected` field, so a subclass reading the queue has to name what it holds.
|
|
165
245
|
*/
|
|
166
|
-
interface
|
|
246
|
+
export interface PendingLanguageClientPush {
|
|
167
247
|
/**
|
|
168
|
-
* The text the client held BEFORE this push
|
|
169
|
-
*
|
|
170
|
-
*
|
|
248
|
+
* The text the client held BEFORE this push, and therefore the text its
|
|
249
|
+
* echo addresses with its ranges. Wider than the baseline the push's edits
|
|
250
|
+
* were diffed against: a full replace is sent with no diff baseline and
|
|
251
|
+
* still lands on a buffer the echo is keyed to.
|
|
171
252
|
*
|
|
172
|
-
* `undefined` when
|
|
173
|
-
*
|
|
174
|
-
*
|
|
175
|
-
*
|
|
176
|
-
* application is position-independent.
|
|
253
|
+
* `undefined` only when that buffer is unknown — the client never declared
|
|
254
|
+
* one, or a rejection invalidated what was tracked. The echo is then
|
|
255
|
+
* reconstructed against the synced text, which is sound only for a
|
|
256
|
+
* position-independent (full-text) change.
|
|
177
257
|
*/
|
|
178
258
|
readonly before: string | undefined;
|
|
179
259
|
/** {@link contentHash} of the text this push moves the client to. */
|
|
@@ -182,18 +262,38 @@ interface PendingPush {
|
|
|
182
262
|
|
|
183
263
|
/**
|
|
184
264
|
* What an incoming language-client change turns out to be once reconstructed
|
|
185
|
-
* against the
|
|
186
|
-
* {@link HydraniumTextDocuments.classifyLanguageClientChange}.
|
|
265
|
+
* against the buffer its ranges address — the return of
|
|
266
|
+
* {@link HydraniumTextDocuments.classifyLanguageClientChange}. That method is
|
|
267
|
+
* `protected`, so an override has to name every arm it can return.
|
|
187
268
|
*/
|
|
188
|
-
type LanguageClientChangeOrigin =
|
|
269
|
+
export type LanguageClientChangeOrigin =
|
|
189
270
|
/** The client is reporting a text we pushed it. The synced document is already there. */
|
|
190
271
|
| { readonly kind: 'echo' }
|
|
191
272
|
/**
|
|
192
|
-
* The client's buffer
|
|
193
|
-
* a
|
|
194
|
-
* reconstructed text is what it now holds, and is authoritative.
|
|
273
|
+
* The client's buffer holds a text we did not push it — a keystroke that
|
|
274
|
+
* raced a push, or an edit to a buffer the store has already been written
|
|
275
|
+
* past. The reconstructed text is what it now holds, and is authoritative.
|
|
195
276
|
*/
|
|
196
|
-
| { readonly kind: 'divergent'; readonly text: string }
|
|
277
|
+
| { readonly kind: 'divergent'; readonly text: string }
|
|
278
|
+
/**
|
|
279
|
+
* The change carries ranges and no known text addresses them, so no
|
|
280
|
+
* reconstruction is offered. Adopting one anyway splices the document and
|
|
281
|
+
* stores an edit nobody made; dropping costs at most the one keystroke the
|
|
282
|
+
* client still holds and the next push contradicts.
|
|
283
|
+
*/
|
|
284
|
+
| { readonly kind: 'unreconstructable' };
|
|
285
|
+
|
|
286
|
+
/**
|
|
287
|
+
* Whether `err` reports that the file of `target` does not exist, as a Node
|
|
288
|
+
* file system and the framework's providers do: code `ENOENT`, with `target`'s
|
|
289
|
+
* path. A missing file of another document is a different failure.
|
|
290
|
+
*/
|
|
291
|
+
function isFileNotFound(err: unknown, target: URI): boolean {
|
|
292
|
+
if (typeof err !== 'object' || err === null || !('code' in err) || err.code !== 'ENOENT') {
|
|
293
|
+
return false;
|
|
294
|
+
}
|
|
295
|
+
return !('path' in err) || err.path === target.fsPath;
|
|
296
|
+
}
|
|
197
297
|
|
|
198
298
|
/**
|
|
199
299
|
* Cheap, stable, non-cryptographic content hash (cyrb53) for the version
|
|
@@ -222,15 +322,19 @@ function contentHash(text: string): string {
|
|
|
222
322
|
* Multi-client text-document tracking on top of Langium's `NormalizedTextDocuments`.
|
|
223
323
|
*
|
|
224
324
|
* Adds the framework features used by the integrity, model-server, and GLSP layers:
|
|
225
|
-
* - Per-document client membership (multiple clients can attach to the same
|
|
325
|
+
* - Per-document client membership (multiple clients can attach to the same
|
|
326
|
+
* URI) and the client-session table, both kept by {@link __sessions}.
|
|
226
327
|
* - A SERVER-OWNED shared version sequence: per-URI, monotonic across
|
|
227
328
|
* close/reopen cycles, advancing exactly when the synced content changes.
|
|
228
329
|
* Client-declared version ids (Monaco's buffer numbering) feed only a
|
|
229
330
|
* per-client staleness guard and never leak into the shared sequence —
|
|
230
331
|
* the two are different things (an editor's edit-operation counter vs the
|
|
231
332
|
* document's content-revision number), and splicing them lets versions drift
|
|
232
|
-
* silently past
|
|
333
|
+
* silently past based-on gate holders.
|
|
233
334
|
* - Version-author history so each edit is attributable to its originating client.
|
|
335
|
+
* - The revert to disk once no client has a document open, for every head
|
|
336
|
+
* ({@link revertToDisk}), deferred by
|
|
337
|
+
* {@link HydraniumTextDocumentsOptions.revertGraceMs} after a lost connection.
|
|
234
338
|
* - Pending-content staging used by the integrity service to thread corrections
|
|
235
339
|
* through `workspace/applyEdit` cycles for currently-closed documents.
|
|
236
340
|
* - `didOpen` notifications arriving over the LSP connection wait on the
|
|
@@ -240,23 +344,28 @@ function contentHash(text: string): string {
|
|
|
240
344
|
*/
|
|
241
345
|
export class HydraniumTextDocuments<T extends TextDocument = TextDocument> extends NormalizedTextDocuments<T> {
|
|
242
346
|
/**
|
|
243
|
-
* Per-URI client-facing tracking ({@link
|
|
244
|
-
*
|
|
245
|
-
*
|
|
246
|
-
*
|
|
247
|
-
* {@link __shadow} (its own abstraction); the parsed-document store stays in
|
|
248
|
-
* the inherited `__syncedDocuments`.
|
|
347
|
+
* Per-URI client-facing tracking ({@link DocumentTrackingRecord}), keyed by
|
|
348
|
+
* canonical URI. One record per URI, so dropping it clears every axis at
|
|
349
|
+
* once. Which client has the document open is kept apart, in
|
|
350
|
+
* {@link __sessions}.
|
|
249
351
|
*/
|
|
250
|
-
protected __documents = new Map<CanonicalUri,
|
|
352
|
+
protected __documents = new Map<CanonicalUri, DocumentTrackingRecord>();
|
|
353
|
+
|
|
354
|
+
/**
|
|
355
|
+
* Which client has which document open, and which client ids are registered
|
|
356
|
+
* sessions. Every open-state predicate on this class reads it, so an open
|
|
357
|
+
* recorded anywhere else is invisible to the last-close transition.
|
|
358
|
+
*/
|
|
359
|
+
protected readonly __sessions = new ClientSessionRegistry();
|
|
251
360
|
|
|
252
361
|
/**
|
|
253
362
|
* Per-URI shared-version continuity across close/reopen cycles
|
|
254
363
|
* ({@link VersionSequence}), written at last-client close and consulted by
|
|
255
|
-
* the next first-client open. DELIBERATELY outside {@link
|
|
364
|
+
* the next first-client open. DELIBERATELY outside {@link DocumentTrackingRecord}:
|
|
256
365
|
* that record is deleted on last close, while the version sequence must
|
|
257
366
|
* survive it — the shared version is a server-owned, monotonic,
|
|
258
367
|
* advances-iff-content-changes counter that never resets while the server
|
|
259
|
-
* lives. That invariant is what makes an optimistic
|
|
368
|
+
* lives. That invariant is what makes an optimistic based-on gate
|
|
260
369
|
* sound: "version unchanged ⇔ content unchanged", with no false conflicts
|
|
261
370
|
* from close/reopen version resets and no false passes from a reopened
|
|
262
371
|
* sequence coincidentally landing on a stale writer's number.
|
|
@@ -269,7 +378,7 @@ export class HydraniumTextDocuments<T extends TextDocument = TextDocument> exten
|
|
|
269
378
|
/**
|
|
270
379
|
* Texts pushed to the LSP textual language client via
|
|
271
380
|
* {@link applyEditToLanguageClient} whose echoes have not come back yet
|
|
272
|
-
* ({@link
|
|
381
|
+
* ({@link PendingLanguageClientPush}), keyed like the shadow by language-client URI.
|
|
273
382
|
* Outbound pushes and inbound echoes are uncorrelated on the wire; this
|
|
274
383
|
* FIFO is the explicit correlation, and it is what
|
|
275
384
|
* {@link classifyLanguageClientChange} reconstructs against.
|
|
@@ -291,7 +400,7 @@ export class HydraniumTextDocuments<T extends TextDocument = TextDocument> exten
|
|
|
291
400
|
* a pathological echo that never arrives; the memory cost until then is
|
|
292
401
|
* one pre-push text per in-flight push, for milliseconds.
|
|
293
402
|
*/
|
|
294
|
-
protected readonly __pendingPushes = new Map<LanguageClientUri,
|
|
403
|
+
protected readonly __pendingPushes = new Map<LanguageClientUri, PendingLanguageClientPush[]>();
|
|
295
404
|
|
|
296
405
|
/**
|
|
297
406
|
* Tracked text content per URI for the LSP textual language client (Monaco / VS Code).
|
|
@@ -316,6 +425,10 @@ export class HydraniumTextDocuments<T extends TextDocument = TextDocument> exten
|
|
|
316
425
|
|
|
317
426
|
protected readonly tracer: Tracer;
|
|
318
427
|
protected readonly configuration: TextDocumentsConfiguration<T>;
|
|
428
|
+
/** See {@link HydraniumTextDocumentsOptions.revertGraceMs}. */
|
|
429
|
+
protected readonly revertGraceMs: number;
|
|
430
|
+
protected readonly lastOpenClosedEmitter = new Emitter<LastOpenClosedEvent>();
|
|
431
|
+
protected readonly languageClientSavedEmitter = new Emitter<LanguageClientSavedEvent>();
|
|
319
432
|
|
|
320
433
|
constructor(
|
|
321
434
|
protected services: ServerSharedServices,
|
|
@@ -329,6 +442,8 @@ export class HydraniumTextDocuments<T extends TextDocument = TextDocument> exten
|
|
|
329
442
|
(uri, reason) => this.tracer.with(uri).warn(`Diff apply-verify fallback (${reason}) — using full-document replace`),
|
|
330
443
|
this
|
|
331
444
|
);
|
|
445
|
+
this.revertGraceMs = options.revertGraceMs ?? DEFAULT_REVERT_GRACE_MS;
|
|
446
|
+
this.onDidCloseLastOpen(event => void this.revertToDisk(event.uri));
|
|
332
447
|
}
|
|
333
448
|
|
|
334
449
|
// Re-exposed configuration factories — for framework-internal callers
|
|
@@ -429,7 +544,7 @@ export class HydraniumTextDocuments<T extends TextDocument = TextDocument> exten
|
|
|
429
544
|
);
|
|
430
545
|
disposables.push(
|
|
431
546
|
connection.onDidSaveTextDocument((event: DidSaveTextDocumentParams) => {
|
|
432
|
-
this.
|
|
547
|
+
void this.notifyLanguageClientSave(event);
|
|
433
548
|
})
|
|
434
549
|
);
|
|
435
550
|
return disposables;
|
|
@@ -466,20 +581,21 @@ export class HydraniumTextDocuments<T extends TextDocument = TextDocument> exten
|
|
|
466
581
|
// the update) from "incoming version older than ours" (stale race).
|
|
467
582
|
const reason =
|
|
468
583
|
lastSeen === td.version ? `already at version ${lastSeen}` : `incoming version ${td.version} older than current ${lastSeen}`;
|
|
469
|
-
this.logUri(uri, `Ignore update by ${clientId}: ${reason}`, 'debug');
|
|
584
|
+
this.logUri(uri, `Ignore update by ${this.formatClientId(clientId)}: ${reason}`, 'debug');
|
|
470
585
|
return;
|
|
471
586
|
}
|
|
472
587
|
record.clientVersions.set(clientId, td.version);
|
|
473
588
|
|
|
474
|
-
// A language-client change
|
|
475
|
-
//
|
|
476
|
-
//
|
|
589
|
+
// A language-client change is keyed to the buffer that client holds,
|
|
590
|
+
// which is the synced text only while the two agree — an authored
|
|
591
|
+
// write advances the synced text without the client knowing, and a
|
|
592
|
+
// push in flight moves the client without the store knowing.
|
|
477
593
|
// Resolve which it is, and against what, before touching anything.
|
|
478
|
-
const
|
|
594
|
+
const origin =
|
|
479
595
|
clientId === LANGUAGE_CLIENT_ID
|
|
480
596
|
? this.classifyLanguageClientChange(this.toLanguageClientUri(td.uri), document, changes)
|
|
481
597
|
: undefined;
|
|
482
|
-
if (
|
|
598
|
+
if (origin?.kind === 'echo') {
|
|
483
599
|
// The client is reporting a text we pushed it, so the synced
|
|
484
600
|
// document is ALREADY there and the changes must not be applied a
|
|
485
601
|
// second time. Nothing is minted and no rebuild fires. The
|
|
@@ -491,19 +607,23 @@ export class HydraniumTextDocuments<T extends TextDocument = TextDocument> exten
|
|
|
491
607
|
this.logUri(uri, `Skip rebuild: echo of a server-authored push (client version ${td.version})`, 'debug');
|
|
492
608
|
return;
|
|
493
609
|
}
|
|
610
|
+
if (origin?.kind === 'unreconstructable') {
|
|
611
|
+
this.tracer.with(uri).warn(`Drop change: no known client buffer for its ranges (client version ${td.version})`);
|
|
612
|
+
return;
|
|
613
|
+
}
|
|
494
614
|
|
|
495
615
|
// The SHARED version advances iff the content actually changes — the
|
|
496
|
-
// invariant optimistic
|
|
616
|
+
// invariant optimistic based-on gates rely on. The new text is
|
|
497
617
|
// only known after applying the (possibly incremental) changes, so
|
|
498
618
|
// apply at a tentative +1 and roll the version back on an identical
|
|
499
619
|
// result (an empty-changes update only re-stamps the version).
|
|
500
620
|
//
|
|
501
|
-
// A divergent
|
|
502
|
-
//
|
|
503
|
-
//
|
|
621
|
+
// A divergent change is applied as its RECONSTRUCTED text rather than
|
|
622
|
+
// as its own ranges: those ranges address the client's own buffer, so
|
|
623
|
+
// applying them here would splice the wrong lines.
|
|
504
624
|
const previousText = document.getText();
|
|
505
625
|
const sharedVersion = document.version;
|
|
506
|
-
document = this.configuration.update(document,
|
|
626
|
+
document = this.configuration.update(document, origin === undefined ? changes : [{ text: origin.text }], sharedVersion + 1);
|
|
507
627
|
const changed = document.getText() !== previousText;
|
|
508
628
|
if (!changed) {
|
|
509
629
|
document = this.configuration.update(document, [], sharedVersion);
|
|
@@ -527,7 +647,10 @@ export class HydraniumTextDocuments<T extends TextDocument = TextDocument> exten
|
|
|
527
647
|
return;
|
|
528
648
|
}
|
|
529
649
|
}
|
|
530
|
-
this.log(
|
|
650
|
+
this.log(
|
|
651
|
+
document.uri,
|
|
652
|
+
`Update to version ${document.version} by ${this.formatClientId(clientId)}${changed ? '' : ' (content unchanged)'}`
|
|
653
|
+
);
|
|
531
654
|
this.__onDidChangeContent.fire(Object.freeze({ document, clientId }));
|
|
532
655
|
}
|
|
533
656
|
}
|
|
@@ -544,7 +667,7 @@ export class HydraniumTextDocuments<T extends TextDocument = TextDocument> exten
|
|
|
544
667
|
* A content-identical write still fires the change event (rebuild): the
|
|
545
668
|
* authored write's server-side rebuild is correctness-bearing, it just
|
|
546
669
|
* mints no new version — nothing observable changed, so watchers'
|
|
547
|
-
*
|
|
670
|
+
* based-on versions stay valid.
|
|
548
671
|
*
|
|
549
672
|
* Returns the resulting shared version. Throws when the document is not
|
|
550
673
|
* open — callers (`AstDocumentManager.update`) open first.
|
|
@@ -561,53 +684,194 @@ export class HydraniumTextDocuments<T extends TextDocument = TextDocument> exten
|
|
|
561
684
|
this.__syncedDocuments.set(key, document);
|
|
562
685
|
this.setAuthor(key, document.version, clientId);
|
|
563
686
|
}
|
|
564
|
-
this.log(
|
|
687
|
+
this.log(
|
|
688
|
+
document.uri,
|
|
689
|
+
`Update to version ${document.version} by ${this.formatClientId(clientId)}${changed ? '' : ' (content unchanged)'}`
|
|
690
|
+
);
|
|
565
691
|
this.__onDidChangeContent.fire(Object.freeze({ document, clientId }));
|
|
566
692
|
return document.version;
|
|
567
693
|
}
|
|
568
694
|
|
|
569
|
-
|
|
695
|
+
/**
|
|
696
|
+
* Close `clientId`'s open of the document. When it was the last open, the
|
|
697
|
+
* document is released and reverts to disk, at once or, for a `'lost'`
|
|
698
|
+
* close, after {@link HydraniumTextDocumentsOptions.revertGraceMs}.
|
|
699
|
+
*/
|
|
700
|
+
public notifyDidCloseTextDocument(
|
|
701
|
+
event: DidCloseTextDocumentParams,
|
|
702
|
+
clientId = LANGUAGE_CLIENT_ID,
|
|
703
|
+
cause: SessionEndCause = 'closed'
|
|
704
|
+
): void {
|
|
570
705
|
const uri = this.documentKey(event.textDocument.uri);
|
|
571
|
-
if (!this.
|
|
706
|
+
if (!this.__sessions.removeOpen(uri, clientId)) {
|
|
572
707
|
return;
|
|
573
708
|
}
|
|
574
|
-
const
|
|
575
|
-
|
|
576
|
-
|
|
709
|
+
const record = this.__documents.get(uri);
|
|
710
|
+
record?.clientVersions.delete(clientId);
|
|
711
|
+
if (record && cause === 'lost') {
|
|
712
|
+
(record.lostClients ??= new Map()).set(clientId, this.services.Clock.stopwatch());
|
|
713
|
+
}
|
|
577
714
|
const syncedDocument = this.__syncedDocuments.get(uri);
|
|
578
715
|
if (syncedDocument !== undefined) {
|
|
579
|
-
this.log(syncedDocument.uri, `Closed synced document: ${syncedDocument.version} by ${clientId}`);
|
|
716
|
+
this.log(syncedDocument.uri, `Closed synced document: ${syncedDocument.version} by ${this.formatClientId(clientId)}`);
|
|
580
717
|
this.__onDidClose.fire(Object.freeze({ document: syncedDocument, clientId }));
|
|
581
718
|
|
|
582
719
|
if (clientId === LANGUAGE_CLIENT_ID) {
|
|
583
720
|
// Monaco closed the document; drop the URI it held and the shadow
|
|
584
721
|
// baselined under it. (If this was the last URI/client the whole record
|
|
585
|
-
// is deleted
|
|
722
|
+
// is deleted on release, clearing the set anyway.)
|
|
586
723
|
const droppedUri = this.toLanguageClientUri(event.textDocument.uri);
|
|
587
724
|
this.__documents.get(uri)?.languageClientUris?.delete(droppedUri);
|
|
588
725
|
this.__shadow.invalidate(droppedUri);
|
|
589
726
|
this.__pendingPushes.delete(droppedUri);
|
|
590
727
|
}
|
|
591
|
-
if (!this.
|
|
592
|
-
|
|
593
|
-
|
|
594
|
-
|
|
595
|
-
|
|
596
|
-
|
|
597
|
-
|
|
598
|
-
|
|
599
|
-
|
|
600
|
-
|
|
601
|
-
|
|
602
|
-
|
|
603
|
-
|
|
604
|
-
|
|
605
|
-
|
|
606
|
-
|
|
607
|
-
|
|
608
|
-
|
|
609
|
-
|
|
728
|
+
if (!this.__sessions.isOpen(uri)) {
|
|
729
|
+
if (cause === 'lost' && this.revertGraceMs > 0) {
|
|
730
|
+
this.deferRelease(uri);
|
|
731
|
+
} else {
|
|
732
|
+
this.releaseDocument(uri);
|
|
733
|
+
}
|
|
734
|
+
}
|
|
735
|
+
}
|
|
736
|
+
}
|
|
737
|
+
|
|
738
|
+
/**
|
|
739
|
+
* Keep the document, text and all, for the revert grace, then release it.
|
|
740
|
+
* The document stays in the store meanwhile, so a lost client that opens it
|
|
741
|
+
* again within its own grace attaches to it and finds its unsaved text
|
|
742
|
+
* rather than reading disk; see {@link resolvePendingRevert} for any other
|
|
743
|
+
* open.
|
|
744
|
+
*/
|
|
745
|
+
protected deferRelease(uri: CanonicalUri): void {
|
|
746
|
+
this.log(uri, `No client left; revert deferred for ${this.revertGraceMs} ms (connection lost)`);
|
|
747
|
+
const timer = this.services.Clock.setTimer(() => {
|
|
748
|
+
this.__sessions.cancelRevert(uri);
|
|
749
|
+
if (!this.__sessions.isOpen(uri)) {
|
|
750
|
+
this.releaseDocument(uri);
|
|
751
|
+
}
|
|
752
|
+
}, this.revertGraceMs);
|
|
753
|
+
this.__sessions.deferRevert(uri, timer);
|
|
754
|
+
}
|
|
755
|
+
|
|
756
|
+
/**
|
|
757
|
+
* Resolve the pending revert of `uri` for an open by `clientId`. An open by a
|
|
758
|
+
* client lost from the document within its grace cancels the revert, and
|
|
759
|
+
* the client finds its unsaved text. Any other open releases the document
|
|
760
|
+
* first, so it opens as a first open does: cancelling for every open hands
|
|
761
|
+
* a lost client's unsaved text to whoever opens next, a reloaded page or an
|
|
762
|
+
* editor, with nothing marking it unsaved.
|
|
763
|
+
*/
|
|
764
|
+
protected resolvePendingRevert(uri: CanonicalUri, clientId: string): void {
|
|
765
|
+
const record = this.__documents.get(uri);
|
|
766
|
+
if (record) {
|
|
767
|
+
this.pruneLostClients(record);
|
|
768
|
+
}
|
|
769
|
+
const returning = record?.lostClients?.delete(clientId) ?? false;
|
|
770
|
+
if (!this.__sessions.isRevertPending(uri)) {
|
|
771
|
+
return;
|
|
772
|
+
}
|
|
773
|
+
this.__sessions.cancelRevert(uri);
|
|
774
|
+
if (!returning) {
|
|
775
|
+
this.releaseDocument(uri);
|
|
776
|
+
}
|
|
777
|
+
}
|
|
778
|
+
|
|
779
|
+
/** Drop the entries of {@link DocumentTrackingRecord.lostClients} whose grace has run out. */
|
|
780
|
+
protected pruneLostClients(record: DocumentTrackingRecord): void {
|
|
781
|
+
for (const [clientId, sinceLoss] of record.lostClients ?? []) {
|
|
782
|
+
if (sinceLoss.elapsedMs >= this.revertGraceMs) {
|
|
783
|
+
record.lostClients?.delete(clientId);
|
|
784
|
+
}
|
|
785
|
+
}
|
|
786
|
+
}
|
|
787
|
+
|
|
788
|
+
/**
|
|
789
|
+
* Drop the document no client has open any more, then announce it on
|
|
790
|
+
* {@link onDidCloseLastOpen}, which is what reverts it to disk.
|
|
791
|
+
*/
|
|
792
|
+
protected releaseDocument(uri: CanonicalUri): void {
|
|
793
|
+
const syncedDocument = this.__syncedDocuments.get(uri);
|
|
794
|
+
if (syncedDocument === undefined) {
|
|
795
|
+
return;
|
|
796
|
+
}
|
|
797
|
+
this.log(syncedDocument.uri, `Remove synced document: ${syncedDocument.version} (no client left)`);
|
|
798
|
+
// Persist where the shared version sequence left off (version +
|
|
799
|
+
// content hash) so the next open CONTINUES the sequence instead of
|
|
800
|
+
// restarting at the reopening client's declared id. Hashed once
|
|
801
|
+
// here at release, not on every change.
|
|
802
|
+
this.__versionSequences.set(uri, {
|
|
803
|
+
version: syncedDocument.version,
|
|
804
|
+
contentHash: contentHash(syncedDocument.getText())
|
|
805
|
+
});
|
|
806
|
+
this.__syncedDocuments.delete(uri);
|
|
807
|
+
// One delete clears every per-URI axis (version history + any staged
|
|
808
|
+
// pending content) so a future open with the same URI starts fresh.
|
|
809
|
+
this.__documents.delete(uri);
|
|
810
|
+
this.lastOpenClosedEmitter.fire(Object.freeze({ uri }));
|
|
811
|
+
}
|
|
812
|
+
|
|
813
|
+
/**
|
|
814
|
+
* Rebuild a released document from disk, so the build stops carrying the
|
|
815
|
+
* unsaved text of its last client.
|
|
816
|
+
*
|
|
817
|
+
* Only a `file:` document reverts. A document of another scheme may have
|
|
818
|
+
* been loaded by the adopter into the workspace index, and a rebuild would
|
|
819
|
+
* drop it and break every reference to it.
|
|
820
|
+
*
|
|
821
|
+
* The file's existence is read in its disk queue, so the rebuild follows
|
|
822
|
+
* any save still queued rather than reverting past it. A document with no
|
|
823
|
+
* file behind it — created and never saved, or deleted meanwhile — is
|
|
824
|
+
* removed from the workspace instead: there is no disk text to revert to,
|
|
825
|
+
* and one whose file goes after that read is removed when its rebuild
|
|
826
|
+
* finds none.
|
|
827
|
+
*
|
|
828
|
+
* Whether to revert at all is decided inside the write lock, as its holder:
|
|
829
|
+
* decided before waiting for the lock, a client that opens or re-creates the
|
|
830
|
+
* document meanwhile has its text rebuilt over from disk, or removed. A
|
|
831
|
+
* document some client has open again, or that waits out a new grace, is
|
|
832
|
+
* left to that client.
|
|
833
|
+
*/
|
|
834
|
+
protected async revertToDisk(uri: CanonicalUri): Promise<void> {
|
|
835
|
+
if (URI.parse(uri).scheme !== 'file') {
|
|
836
|
+
return;
|
|
837
|
+
}
|
|
838
|
+
const workspace = this.services.workspace;
|
|
839
|
+
const target = UriUtils.toUri(uri);
|
|
840
|
+
const reopened = (): boolean => this.isOpenInAnyClient(uri) || this.__syncedDocuments.has(uri);
|
|
841
|
+
try {
|
|
842
|
+
// Read before the lock: every build and read waits while the lock is
|
|
843
|
+
// held, and this read waits on the file's save I/O.
|
|
844
|
+
const onDisk = await workspace.FileSystemTaskQueue.enqueue(uri, () => workspace.FileSystemProvider.exists(target));
|
|
845
|
+
await workspace.WorkspaceManager?.ready;
|
|
846
|
+
await workspace.WorkspaceLock.write(async token => {
|
|
847
|
+
if (reopened()) {
|
|
848
|
+
return;
|
|
849
|
+
}
|
|
850
|
+
workspace.DocumentBuilder.markNextReason(HYDRANIUM_BUILD_REASONS.didClose);
|
|
851
|
+
try {
|
|
852
|
+
await (onDisk
|
|
853
|
+
? workspace.DocumentBuilder.update([target], [], token)
|
|
854
|
+
: workspace.DocumentBuilder.update([], [target], token));
|
|
855
|
+
} catch (err: unknown) {
|
|
856
|
+
if (!onDisk || !isFileNotFound(err, target)) {
|
|
857
|
+
throw err;
|
|
858
|
+
}
|
|
859
|
+
// The file went after its existence was read.
|
|
860
|
+
this.tracer.with(uri).debug('Revert found no file; removing the document instead');
|
|
861
|
+
workspace.DocumentBuilder.markNextReason(HYDRANIUM_BUILD_REASONS.didClose);
|
|
862
|
+
await workspace.DocumentBuilder.update([], [target], token);
|
|
863
|
+
}
|
|
864
|
+
});
|
|
865
|
+
} catch (err: unknown) {
|
|
866
|
+
// A revert that finishes after the LSP peer went away fails its
|
|
867
|
+
// diagnostics publish, and one that runs after its workspace was torn
|
|
868
|
+
// down finds no file: teardown races, not failed reverts.
|
|
869
|
+
if (isConnectionGoneError(err) || isFileNotFound(err, target)) {
|
|
870
|
+
this.tracer.with(uri).debug(`Revert on last close skipped: ${err instanceof Error ? err.message : String(err)}`);
|
|
871
|
+
return;
|
|
610
872
|
}
|
|
873
|
+
const detail = err instanceof Error ? (err.stack ?? err.message) : String(err);
|
|
874
|
+
this.tracer.with(uri).error(`Revert on last close dropped. ${detail}`);
|
|
611
875
|
}
|
|
612
876
|
}
|
|
613
877
|
|
|
@@ -630,40 +894,95 @@ export class HydraniumTextDocuments<T extends TextDocument = TextDocument> exten
|
|
|
630
894
|
}
|
|
631
895
|
}
|
|
632
896
|
|
|
897
|
+
/**
|
|
898
|
+
* Handle a save the language client reports: fire
|
|
899
|
+
* {@link onDidSaveInLanguageClient}, then announce it on {@link onDidSave}
|
|
900
|
+
* only once the file read back from disk holds the store's current text.
|
|
901
|
+
*/
|
|
902
|
+
protected async notifyLanguageClientSave(event: DidSaveTextDocumentParams): Promise<void> {
|
|
903
|
+
const syncedDocument = this.__syncedDocuments.get(this.documentKey(event.textDocument.uri));
|
|
904
|
+
if (syncedDocument === undefined) {
|
|
905
|
+
return;
|
|
906
|
+
}
|
|
907
|
+
const uri = syncedDocument.uri;
|
|
908
|
+
this.languageClientSavedEmitter.fire(Object.freeze({ uri }));
|
|
909
|
+
// `onDidSave` tells its listeners that the shared document is on disk: a
|
|
910
|
+
// diagram marks its save done, the data head broadcasts a save and its
|
|
911
|
+
// clients drop their dirty state. The editor wrote its own buffer,
|
|
912
|
+
// which lags the store while another client's edit is still on its way
|
|
913
|
+
// to it, so only the file says whether that holds. Read it rather than
|
|
914
|
+
// trust the editor: `didSave` carries text only for a client that
|
|
915
|
+
// honours `includeText`, and asking for it means rewriting Langium's
|
|
916
|
+
// initialize answer, which advertises `save` as a Boolean. The read goes
|
|
917
|
+
// through the disk queue and waits on nothing but the provider, so it
|
|
918
|
+
// follows a server save queued meanwhile. A file changed again between
|
|
919
|
+
// the editor's write and this read compares unequal and takes the safe
|
|
920
|
+
// side. A save not announced leaves every other client dirty, which is
|
|
921
|
+
// true of the store's text: a diagram keeps its save pending, and data
|
|
922
|
+
// clients keep their unsaved state until the next save of the document.
|
|
923
|
+
let onDisk: string | undefined;
|
|
924
|
+
try {
|
|
925
|
+
onDisk = await this.services.workspace.FileSystemTaskQueue.enqueue(uri, () =>
|
|
926
|
+
this.services.workspace.FileSystemProvider.readFile(UriUtils.toUri(uri))
|
|
927
|
+
);
|
|
928
|
+
} catch (err: unknown) {
|
|
929
|
+
this.tracer
|
|
930
|
+
.with(uri)
|
|
931
|
+
.debug(`Editor save not announced: reading the file back failed. ${err instanceof Error ? err.message : String(err)}`);
|
|
932
|
+
return;
|
|
933
|
+
}
|
|
934
|
+
// An editor that saves and then closes releases the document while the
|
|
935
|
+
// read is under way; its save is still a save of the text it held.
|
|
936
|
+
const document = this.__syncedDocuments.get(this.documentKey(uri)) ?? syncedDocument;
|
|
937
|
+
if (onDisk !== document.getText()) {
|
|
938
|
+
this.tracer.with(uri).debug(`Editor save not announced: the file does not hold the text of version ${document.version}`);
|
|
939
|
+
return;
|
|
940
|
+
}
|
|
941
|
+
this.announceSave(document, LANGUAGE_CLIENT_ID);
|
|
942
|
+
}
|
|
943
|
+
|
|
633
944
|
public notifyDidSaveTextDocument(event: DidSaveTextDocumentParams, clientId = LANGUAGE_CLIENT_ID): void {
|
|
634
945
|
const syncedDocument = this.__syncedDocuments.get(this.documentKey(event.textDocument.uri));
|
|
635
946
|
if (syncedDocument !== undefined) {
|
|
636
|
-
this.
|
|
637
|
-
this.__onDidSave.fire(Object.freeze({ document: syncedDocument, clientId }));
|
|
947
|
+
this.announceSave(syncedDocument, clientId);
|
|
638
948
|
}
|
|
639
949
|
}
|
|
640
950
|
|
|
951
|
+
/** Fire {@link onDidSave} for `document`, which need not be synced any more. */
|
|
952
|
+
protected announceSave(document: T, clientId: string): void {
|
|
953
|
+
this.log(document.uri, `Saved synced document: ${document.version} by ${this.formatClientId(clientId)}`);
|
|
954
|
+
this.__onDidSave.fire(Object.freeze({ document, clientId }));
|
|
955
|
+
}
|
|
956
|
+
|
|
641
957
|
public notifyDidOpenTextDocument(event: DidOpenTextDocumentParams, clientId = LANGUAGE_CLIENT_ID): void {
|
|
642
958
|
const td = event.textDocument;
|
|
643
959
|
const uri = this.documentKey(td.uri);
|
|
960
|
+
this.resolvePendingRevert(uri, clientId);
|
|
644
961
|
if (this.isOpenInClient(uri, clientId)) {
|
|
645
962
|
// Already open for this client under this canonical identity. If this is a
|
|
646
963
|
// NEW client-facing URI for the same file (a second tab reached via a
|
|
647
|
-
// divergent path, e.g. a symlink and its real path), record it
|
|
648
|
-
//
|
|
649
|
-
//
|
|
964
|
+
// divergent path, e.g. a symlink and its real path), record it so outbound
|
|
965
|
+
// edits reach this tab too — but do NOT re-fire open/rebuild; the document
|
|
966
|
+
// is already live.
|
|
650
967
|
if (clientId === LANGUAGE_CLIENT_ID) {
|
|
651
968
|
const clientFacing = this.toLanguageClientUri(td.uri);
|
|
652
969
|
const record = this.__documents.get(uri);
|
|
653
970
|
if (record && !record.languageClientUris?.has(clientFacing)) {
|
|
654
971
|
(record.languageClientUris ??= new Set<LanguageClientUri>()).add(clientFacing);
|
|
655
|
-
|
|
656
|
-
|
|
657
|
-
|
|
658
|
-
|
|
972
|
+
// This tab's own buffer, NOT the synced text: a second tab is a second
|
|
973
|
+
// client model, read from disk, so a server-authored write already
|
|
974
|
+
// applied to the first tab leaves it BEHIND the synced document. Keying
|
|
975
|
+
// a diff to the synced text here addresses lines this tab does not have
|
|
976
|
+
// and drops content it does.
|
|
977
|
+
this.__shadow.setOpenedText(clientFacing, td.text);
|
|
659
978
|
}
|
|
660
979
|
}
|
|
661
980
|
return;
|
|
662
981
|
}
|
|
663
982
|
let document = this.__syncedDocuments.get(uri);
|
|
983
|
+
const existingClients = this.__sessions.clientsOf(uri);
|
|
984
|
+
this.__sessions.addOpen(uri, clientId);
|
|
664
985
|
const record = this.trackingFor(uri);
|
|
665
|
-
const existingClients = [...record.clients];
|
|
666
|
-
record.clients.add(clientId);
|
|
667
986
|
// Baseline the per-client staleness guard at the version id the client
|
|
668
987
|
// declared for its own buffer (client-owned per LSP).
|
|
669
988
|
record.clientVersions.set(clientId, td.version);
|
|
@@ -679,14 +998,14 @@ export class HydraniumTextDocuments<T extends TextDocument = TextDocument> exten
|
|
|
679
998
|
const source = pendingText ? ', source=pending' : '';
|
|
680
999
|
// The SHARED version is server-assigned: continue the persisted
|
|
681
1000
|
// sequence — same version when the content is unchanged since the
|
|
682
|
-
// last close (so watchers'
|
|
1001
|
+
// last close (so watchers' based-on versions stay valid), one
|
|
683
1002
|
// step when it changed (so no stale pointer can coincidentally pass
|
|
684
1003
|
// the optimistic gate). Only a first-ever open adopts the client's
|
|
685
1004
|
// declared id as the sequence seed.
|
|
686
1005
|
const sequence = this.__versionSequences.get(uri);
|
|
687
1006
|
const version =
|
|
688
1007
|
sequence === undefined ? td.version : sequence.contentHash === contentHash(text) ? sequence.version : sequence.version + 1;
|
|
689
|
-
this.log(uri, `Open document: Version ${version} by ${clientId} [first client${source}]`);
|
|
1008
|
+
this.log(uri, `Open document: Version ${version} by ${this.formatClientId(clientId)} [first client${source}]`);
|
|
690
1009
|
document = this.configuration.create(uri, td.languageId, version, text);
|
|
691
1010
|
this.__syncedDocuments.set(uri, document);
|
|
692
1011
|
this.setAuthor(uri, version, clientId);
|
|
@@ -694,29 +1013,90 @@ export class HydraniumTextDocuments<T extends TextDocument = TextDocument> exten
|
|
|
694
1013
|
// Baseline the shadow to what Monaco just opened so the next outbound
|
|
695
1014
|
// applyEditToLanguageClient diffs against the right starting point. Keyed by the
|
|
696
1015
|
// language-client URI (what Monaco holds), not the canonical document key.
|
|
697
|
-
|
|
1016
|
+
//
|
|
1017
|
+
// The CLIENT's declared text, never the synced document: staged content
|
|
1018
|
+
// consumed above leaves the two different, and a baseline asserting the
|
|
1019
|
+
// client already holds the staged text suppresses the one sync that would
|
|
1020
|
+
// deliver it. Skipped entirely when a push is already outstanding for this
|
|
1021
|
+
// URI — an `applyEdit` to a closed file has the client open from disk and
|
|
1022
|
+
// apply afterwards, so that shadow records what it is about to hold and
|
|
1023
|
+
// disk text would key the next diff to a buffer nobody has.
|
|
1024
|
+
const clientFacing = this.toLanguageClientUri(td.uri);
|
|
1025
|
+
if (!this.__shadow.isTracked(clientFacing)) {
|
|
1026
|
+
this.__shadow.set(clientFacing, td.text);
|
|
1027
|
+
}
|
|
698
1028
|
}
|
|
699
1029
|
const toFire = Object.freeze({ document, clientId });
|
|
700
1030
|
this.__onDidOpen.fire(toFire);
|
|
701
1031
|
this.__onDidChangeContent.fire(toFire);
|
|
702
1032
|
} else {
|
|
703
1033
|
// An additional client attaches to a document already open by another client.
|
|
704
|
-
this.
|
|
705
|
-
|
|
706
|
-
|
|
707
|
-
|
|
708
|
-
|
|
1034
|
+
this.logClientJoined(uri, clientId, document.version, existingClients);
|
|
1035
|
+
if (clientId === LANGUAGE_CLIENT_ID) {
|
|
1036
|
+
// Monaco's own buffer, which on this path is NOT the synced text — another
|
|
1037
|
+
// client opened the document and may already have changed it. Recorded as
|
|
1038
|
+
// an equality-only baseline (never a diff one, see `setOpenedText`) so the
|
|
1039
|
+
// refresh below does not push a full replace of content Monaco already
|
|
1040
|
+
// holds, which would dirty the file on open.
|
|
1041
|
+
this.__shadow.setOpenedText(this.toLanguageClientUri(td.uri), td.text);
|
|
1042
|
+
}
|
|
709
1043
|
this.refreshContent(uri, clientId);
|
|
710
1044
|
}
|
|
711
1045
|
}
|
|
712
1046
|
|
|
1047
|
+
/**
|
|
1048
|
+
* Record `clientId` as an additional holder of a document another client
|
|
1049
|
+
* already has open.
|
|
1050
|
+
*
|
|
1051
|
+
* Unlike the attach branch of {@link notifyDidOpenTextDocument} this does
|
|
1052
|
+
* not refresh. That branch re-renders an attaching TEXTUAL view; a client
|
|
1053
|
+
* reaching a document through a non-textual route has nothing to re-render,
|
|
1054
|
+
* and refreshing per attach turns each into a Langium rebuild and dependent
|
|
1055
|
+
* relink cascade.
|
|
1056
|
+
*
|
|
1057
|
+
* The staleness guard baselines at the SYNCED version, not a declared buffer
|
|
1058
|
+
* version, because a client arriving this way holds no buffer of its own.
|
|
1059
|
+
* Unifying the two routes therefore rebaselines a textual client's guard to a
|
|
1060
|
+
* version it never declared.
|
|
1061
|
+
*
|
|
1062
|
+
* Returns whether a hold was added — `false` when `uri` is not open,
|
|
1063
|
+
* `clientId` already holds it, or the document was waiting out the revert
|
|
1064
|
+
* grace for other clients and was released instead (see
|
|
1065
|
+
* {@link resolvePendingRevert}); the caller then opens it anew.
|
|
1066
|
+
*/
|
|
1067
|
+
attachClient(uri: DocumentUri, clientId: string): boolean {
|
|
1068
|
+
const key = this.documentKey(uri);
|
|
1069
|
+
if (!this.__syncedDocuments.has(key) || this.isOpenInClient(key, clientId)) {
|
|
1070
|
+
return false;
|
|
1071
|
+
}
|
|
1072
|
+
this.resolvePendingRevert(key, clientId);
|
|
1073
|
+
const document = this.__syncedDocuments.get(key);
|
|
1074
|
+
if (!document) {
|
|
1075
|
+
return false;
|
|
1076
|
+
}
|
|
1077
|
+
const existingClients = this.__sessions.clientsOf(key);
|
|
1078
|
+
this.__sessions.addOpen(key, clientId);
|
|
1079
|
+
const record = this.trackingFor(key);
|
|
1080
|
+
record.clientVersions.set(clientId, document.version);
|
|
1081
|
+
this.logClientJoined(key, clientId, document.version, existingClients);
|
|
1082
|
+
return true;
|
|
1083
|
+
}
|
|
1084
|
+
|
|
1085
|
+
protected logClientJoined(uri: DocumentUri, clientId: string, version: number, existingClients: readonly string[]): void {
|
|
1086
|
+
this.log(
|
|
1087
|
+
uri,
|
|
1088
|
+
`Attach client: ${this.formatClientId(clientId)} joined existing document (version ${version}, ` +
|
|
1089
|
+
`now open in: ${[...existingClients, clientId].map(id => this.formatClientId(id)).join(', ')})`
|
|
1090
|
+
);
|
|
1091
|
+
}
|
|
1092
|
+
|
|
713
1093
|
refreshContent(uri: DocumentUri, clientId: string): void {
|
|
714
1094
|
const syncedDocument = this.__syncedDocuments.get(this.documentKey(uri));
|
|
715
1095
|
if (syncedDocument) {
|
|
716
1096
|
// Trigger a (re-)build by firing a change event.
|
|
717
1097
|
const timer = this.startTimerForUri(
|
|
718
1098
|
syncedDocument.uri,
|
|
719
|
-
`Refresh synced document: Version ${syncedDocument.version} by ${clientId}`
|
|
1099
|
+
`Refresh synced document: Version ${syncedDocument.version} by ${this.formatClientId(clientId)}`
|
|
720
1100
|
);
|
|
721
1101
|
this.__onDidChangeContent.fire(Object.freeze({ document: syncedDocument, clientId }));
|
|
722
1102
|
timer.dispose();
|
|
@@ -730,7 +1110,7 @@ export class HydraniumTextDocuments<T extends TextDocument = TextDocument> exten
|
|
|
730
1110
|
* two URIs for one physical file (a symlink path and its real path) into a
|
|
731
1111
|
* single registration — dedup at the editor layer, not just in
|
|
732
1112
|
* `LangiumDocuments`. The URI the client opened under is preserved separately
|
|
733
|
-
* for egress addressing (see {@link
|
|
1113
|
+
* for egress addressing (see {@link DocumentTrackingRecord.languageClientUris}). The
|
|
734
1114
|
* policy is always bound (the framework defaults it to
|
|
735
1115
|
* `DefaultDocumentUriPolicy`, where canonical ≡ syntactic normalize).
|
|
736
1116
|
*/
|
|
@@ -751,10 +1131,10 @@ export class HydraniumTextDocuments<T extends TextDocument = TextDocument> exten
|
|
|
751
1131
|
}
|
|
752
1132
|
|
|
753
1133
|
/** Get-or-create the per-URI tracking record. `uri` must already be a {@link documentKey}. */
|
|
754
|
-
protected trackingFor(uri: CanonicalUri):
|
|
1134
|
+
protected trackingFor(uri: CanonicalUri): DocumentTrackingRecord {
|
|
755
1135
|
let record = this.__documents.get(uri);
|
|
756
1136
|
if (!record) {
|
|
757
|
-
record = {
|
|
1137
|
+
record = { versionAuthors: [], clientVersions: new Map() };
|
|
758
1138
|
this.__documents.set(uri, record);
|
|
759
1139
|
}
|
|
760
1140
|
return record;
|
|
@@ -790,7 +1170,7 @@ export class HydraniumTextDocuments<T extends TextDocument = TextDocument> exten
|
|
|
790
1170
|
* `0` for a URI this store has never seen. The shared sequence is
|
|
791
1171
|
* server-owned and monotonic across close/reopen cycles, and advances
|
|
792
1172
|
* exactly when the synced content changes — which is what makes it a sound
|
|
793
|
-
* optimistic-concurrency token (
|
|
1173
|
+
* optimistic-concurrency token (based-on gates): version unchanged ⇔
|
|
794
1174
|
* content unchanged.
|
|
795
1175
|
*/
|
|
796
1176
|
version(uri: DocumentUri): number {
|
|
@@ -832,6 +1212,58 @@ export class HydraniumTextDocuments<T extends TextDocument = TextDocument> exten
|
|
|
832
1212
|
return stepped.version;
|
|
833
1213
|
}
|
|
834
1214
|
|
|
1215
|
+
/**
|
|
1216
|
+
* Commit an integrity repair into the OPEN document for `uri`, returning the
|
|
1217
|
+
* document that now holds it, or `undefined` when there was nothing here to
|
|
1218
|
+
* commit into.
|
|
1219
|
+
*
|
|
1220
|
+
* The one thing this exists to do is address the store BY URI. A repair
|
|
1221
|
+
* reaches the resync as a text-document object, and that object is the
|
|
1222
|
+
* store's own only on the LSP path; a document built for an already-open URI
|
|
1223
|
+
* through `LangiumDocumentFactory.fromString` carries its own, so writing the
|
|
1224
|
+
* repair into it corrects a copy the store does not know about and the editor
|
|
1225
|
+
* never sees.
|
|
1226
|
+
*
|
|
1227
|
+
* `parsedFrom` is the text the repaired AST was parsed from, and a mismatch
|
|
1228
|
+
* against the current content REFUSES the commit: the store has moved on,
|
|
1229
|
+
* which means an editor change landed after that parse, and committing would
|
|
1230
|
+
* overwrite a newer edit with a repair computed against text the user has
|
|
1231
|
+
* already replaced. The build that change provokes recomputes the repair.
|
|
1232
|
+
*
|
|
1233
|
+
* Deliberately NOT compared by version. A separately created document seeds
|
|
1234
|
+
* its own numbering, so requiring the two to agree would refuse every commit
|
|
1235
|
+
* on the path this exists for. Content is the thing both sides can be held to.
|
|
1236
|
+
*
|
|
1237
|
+
* A changed text is a new version authored by {@link INTEGRITY_CLIENT_ID}.
|
|
1238
|
+
* Kept at the old version, the repair is invisible to every reader keyed on
|
|
1239
|
+
* versions: a write based on the unrepaired version passes the based-on gate
|
|
1240
|
+
* and replaces the repair, and an echo filter credits the repair to the
|
|
1241
|
+
* client whose edit it corrected. No change event is fired: the repair
|
|
1242
|
+
* rides the build already under way, and an event would re-enter it.
|
|
1243
|
+
*/
|
|
1244
|
+
commitRepair(uri: DocumentUri, parsedFrom: string, repaired: string): RepairCommit<T> {
|
|
1245
|
+
const key = this.documentKey(uri);
|
|
1246
|
+
const document = this.__syncedDocuments.get(key);
|
|
1247
|
+
if (document === undefined) {
|
|
1248
|
+
return { status: 'not-open' };
|
|
1249
|
+
}
|
|
1250
|
+
if (document.getText() !== parsedFrom) {
|
|
1251
|
+
this.logUri(key, 'Refuse repair commit: the open document moved on from the text the AST was parsed from', 'debug');
|
|
1252
|
+
return { status: 'stale' };
|
|
1253
|
+
}
|
|
1254
|
+
if (repaired === parsedFrom) {
|
|
1255
|
+
return { status: 'committed', document };
|
|
1256
|
+
}
|
|
1257
|
+
// Reassigned rather than mutated in place: the default configuration
|
|
1258
|
+
// updates and returns the SAME instance, but an adopter-supplied one may
|
|
1259
|
+
// return a new object, and the store must end up holding whichever it is.
|
|
1260
|
+
const updated = this.configuration.update(document, [{ text: repaired }], document.version + 1);
|
|
1261
|
+
this.__syncedDocuments.set(key, updated);
|
|
1262
|
+
this.setAuthor(key, updated.version, INTEGRITY_CLIENT_ID);
|
|
1263
|
+
this.log(updated.uri, `Update to version ${updated.version} by ${this.formatClientId(INTEGRITY_CLIENT_ID)} (repair)`);
|
|
1264
|
+
return { status: 'committed', document: updated };
|
|
1265
|
+
}
|
|
1266
|
+
|
|
835
1267
|
getAuthor(uri: DocumentUri, version?: number): string | undefined {
|
|
836
1268
|
const history = this.__documents.get(this.documentKey(uri))?.versionAuthors;
|
|
837
1269
|
// Either the requested version, or the latest. `version !== undefined` so we treat 0 correctly.
|
|
@@ -852,17 +1284,17 @@ export class HydraniumTextDocuments<T extends TextDocument = TextDocument> exten
|
|
|
852
1284
|
* True iff any client still holds `uri` open. Distinct from {@link isOpen},
|
|
853
1285
|
* which reads `__syncedDocuments` — that map is cleared only AFTER the
|
|
854
1286
|
* `onDidClose` event fires for the last client, so `isOpen` returns `true`
|
|
855
|
-
* during the close event itself. `isOpenInAnyClient` reads the
|
|
856
|
-
*
|
|
1287
|
+
* during the close event itself. `isOpenInAnyClient` reads the open table
|
|
1288
|
+
* ({@link __sessions}), which is updated BEFORE the fire, so an `onDidClose`
|
|
857
1289
|
* subscriber that finds this `false` knows the last client just closed and a
|
|
858
1290
|
* disk re-read / rebuild can proceed.
|
|
859
1291
|
*/
|
|
860
1292
|
isOpenInAnyClient(uri: DocumentUri): boolean {
|
|
861
|
-
return
|
|
1293
|
+
return this.__sessions.isOpen(this.documentKey(uri));
|
|
862
1294
|
}
|
|
863
1295
|
|
|
864
1296
|
isOpenInClient(uri: DocumentUri, client: string): boolean {
|
|
865
|
-
return
|
|
1297
|
+
return this.__sessions.isOpenIn(this.documentKey(uri), client);
|
|
866
1298
|
}
|
|
867
1299
|
|
|
868
1300
|
isOpenInLanguageClient(uri: DocumentUri): boolean {
|
|
@@ -873,14 +1305,14 @@ export class HydraniumTextDocuments<T extends TextDocument = TextDocument> exten
|
|
|
873
1305
|
}
|
|
874
1306
|
|
|
875
1307
|
isOnlyOpenInClient(uri: DocumentUri, client: string): boolean {
|
|
876
|
-
const
|
|
877
|
-
return
|
|
1308
|
+
const clients = this.__sessions.clientsOf(this.documentKey(uri));
|
|
1309
|
+
return clients.length === 1 && clients[0] === client;
|
|
878
1310
|
}
|
|
879
1311
|
|
|
880
1312
|
/**
|
|
881
1313
|
* Every document currently held open by at least one client, with the client
|
|
882
|
-
* ids holding it. Reads the same
|
|
883
|
-
*
|
|
1314
|
+
* ids holding it. Reads the same open table as {@link isOpenInAnyClient}, so
|
|
1315
|
+
* it reflects a last-client close immediately.
|
|
884
1316
|
*
|
|
885
1317
|
* Diagnostics-oriented — the server-state snapshot lists these so an operator
|
|
886
1318
|
* can see WHY a document is pinned: a document that lingers here after its
|
|
@@ -888,28 +1320,142 @@ export class HydraniumTextDocuments<T extends TextDocument = TextDocument> exten
|
|
|
888
1320
|
* under a shedding policy, explains why its CST is never shed).
|
|
889
1321
|
*/
|
|
890
1322
|
openDocuments(): OpenDocument[] {
|
|
891
|
-
|
|
892
|
-
|
|
893
|
-
|
|
894
|
-
|
|
1323
|
+
return this.__sessions.openDocuments();
|
|
1324
|
+
}
|
|
1325
|
+
|
|
1326
|
+
/** Fires once a client session has ended, after every document it had open was closed. */
|
|
1327
|
+
get onDidCloseSession(): Event<ClientSessionClosedEvent> {
|
|
1328
|
+
return this.__sessions.onDidCloseSession;
|
|
1329
|
+
}
|
|
1330
|
+
|
|
1331
|
+
/**
|
|
1332
|
+
* Fires once a document no client has open is released: at its last close,
|
|
1333
|
+
* or, for a lost client's last close, when its revert grace runs out,
|
|
1334
|
+
* another client opens it, or it is deleted. The document then reverts to
|
|
1335
|
+
* disk.
|
|
1336
|
+
*/
|
|
1337
|
+
get onDidCloseLastOpen(): Event<LastOpenClosedEvent> {
|
|
1338
|
+
return this.lastOpenClosedEmitter.event;
|
|
1339
|
+
}
|
|
1340
|
+
|
|
1341
|
+
/**
|
|
1342
|
+
* Fires for every save the language client reports of a document it has
|
|
1343
|
+
* open: the editor has written the file. {@link onDidSave} follows only
|
|
1344
|
+
* when the file holds the store's text.
|
|
1345
|
+
*/
|
|
1346
|
+
get onDidSaveInLanguageClient(): Event<LanguageClientSavedEvent> {
|
|
1347
|
+
return this.languageClientSavedEmitter.event;
|
|
1348
|
+
}
|
|
1349
|
+
|
|
1350
|
+
/**
|
|
1351
|
+
* Whether `uri` is waiting out the revert grace: its last open closed with a
|
|
1352
|
+
* lost connection, and it still holds its unsaved text. Such a document is
|
|
1353
|
+
* open for no client, yet not closed either, so a caller that would persist
|
|
1354
|
+
* a closed document's text to disk treats it as open.
|
|
1355
|
+
*/
|
|
1356
|
+
isRevertPending(uri: DocumentUri): boolean {
|
|
1357
|
+
return this.__sessions.isRevertPending(this.documentKey(uri));
|
|
1358
|
+
}
|
|
1359
|
+
|
|
1360
|
+
/**
|
|
1361
|
+
* Start a client session under `clientId`. Throws `DuplicateClientIdError`
|
|
1362
|
+
* where {@link ClientSessionRegistry.register} refuses the id.
|
|
1363
|
+
*/
|
|
1364
|
+
registerSession(clientId: string): void {
|
|
1365
|
+
this.__sessions.register(clientId);
|
|
1366
|
+
this.tracer.info(`Session started: ${this.formatClientId(clientId)}`);
|
|
1367
|
+
this.tracer.trace(`Session started: ${clientId}`);
|
|
1368
|
+
}
|
|
1369
|
+
|
|
1370
|
+
/**
|
|
1371
|
+
* End the client session `clientId`: close every document it has open, then
|
|
1372
|
+
* free the id. Immediate — each close runs the ordinary close path before
|
|
1373
|
+
* this returns, with `cause` as its cause. A no-op for an id that is not a
|
|
1374
|
+
* registered session.
|
|
1375
|
+
*/
|
|
1376
|
+
closeSession(clientId: string, cause: SessionEndCause = 'closed'): void {
|
|
1377
|
+
if (!this.__sessions.isRegistered(clientId)) {
|
|
1378
|
+
return;
|
|
1379
|
+
}
|
|
1380
|
+
try {
|
|
1381
|
+
for (const uri of this.__sessions.beginClose(clientId)) {
|
|
1382
|
+
this.notifyDidCloseTextDocument({ textDocument: { uri } }, clientId, cause);
|
|
895
1383
|
}
|
|
1384
|
+
} finally {
|
|
1385
|
+
this.__sessions.unregister(clientId);
|
|
1386
|
+
this.tracer.info(`Session closed: ${this.formatClientId(clientId)}`);
|
|
1387
|
+
this.tracer.trace(`Session closed: ${clientId}`);
|
|
896
1388
|
}
|
|
897
|
-
return result;
|
|
898
1389
|
}
|
|
899
1390
|
|
|
900
1391
|
/**
|
|
901
|
-
*
|
|
1392
|
+
* The file behind `uri` was deleted: close every open of it except the
|
|
1393
|
+
* language client's.
|
|
1394
|
+
*
|
|
1395
|
+
* The editor's open is left alone because the editor owns it: it keeps the
|
|
1396
|
+
* buffer of a deleted file and goes on sending changes for it, and a store
|
|
1397
|
+
* that had closed the document would drop every one of them until the editor
|
|
1398
|
+
* reopened.
|
|
1399
|
+
*/
|
|
1400
|
+
notifyDocumentDeleted(uri: DocumentUri): void {
|
|
1401
|
+
const key = this.documentKey(uri);
|
|
1402
|
+
for (const clientId of this.__sessions.clientsOf(key)) {
|
|
1403
|
+
if (clientId !== LANGUAGE_CLIENT_ID) {
|
|
1404
|
+
this.notifyDidCloseTextDocument({ textDocument: { uri: key } }, clientId);
|
|
1405
|
+
}
|
|
1406
|
+
}
|
|
1407
|
+
}
|
|
1408
|
+
|
|
1409
|
+
/**
|
|
1410
|
+
* Remove the document for `uri`, closing every open of it first — the
|
|
1411
|
+
* editor's included, since the document it would keep editing is gone.
|
|
1412
|
+
*
|
|
1413
|
+
* The base removes the synced document without consulting the open table,
|
|
1414
|
+
* which leaves every open recorded against a document that no longer exists:
|
|
1415
|
+
* the store then answers that the URI is open, and the next open attaches to
|
|
1416
|
+
* nothing.
|
|
1417
|
+
*/
|
|
1418
|
+
override delete(uri: string | URI | T): void {
|
|
1419
|
+
const key = this.documentKey((typeof uri === 'object' && 'uri' in uri ? uri.uri : uri).toString());
|
|
1420
|
+
for (const clientId of this.__sessions.clientsOf(key)) {
|
|
1421
|
+
this.notifyDidCloseTextDocument({ textDocument: { uri: key } }, clientId);
|
|
1422
|
+
}
|
|
1423
|
+
// A document waiting out the grace has no client left to close, and is
|
|
1424
|
+
// released now as its last close would have released it.
|
|
1425
|
+
if (this.__sessions.isRevertPending(key)) {
|
|
1426
|
+
this.__sessions.cancelRevert(key);
|
|
1427
|
+
this.releaseDocument(key);
|
|
1428
|
+
}
|
|
1429
|
+
super.delete(key);
|
|
1430
|
+
}
|
|
1431
|
+
|
|
1432
|
+
/**
|
|
1433
|
+
* A client id as log lines print it. An id containing `#` is cut eight
|
|
1434
|
+
* characters after its last `#`, which leaves a minted `label#uuid` as the
|
|
1435
|
+
* label and enough of the UUID to tell sessions apart; an id without `#`
|
|
1436
|
+
* prints whole. The full id goes out at trace level wherever a session
|
|
1437
|
+
* starts or ends.
|
|
1438
|
+
*/
|
|
1439
|
+
protected formatClientId(clientId: string): string {
|
|
1440
|
+
const separator = clientId.lastIndexOf('#');
|
|
1441
|
+
return separator < 0 ? clientId : clientId.slice(0, separator + 9);
|
|
1442
|
+
}
|
|
1443
|
+
|
|
1444
|
+
/**
|
|
1445
|
+
* Stages integrity-updated content for a document no client holds.
|
|
902
1446
|
*
|
|
903
1447
|
* When `workspace/applyEdit` targets a closed file, the client opens it from
|
|
904
1448
|
* disk (stale) and sends `didOpen` before applying the edit. This staged
|
|
905
1449
|
* content is consumed by {@link notifyDidOpenTextDocument} to replace the
|
|
906
1450
|
* stale disk text, preventing a brief revert of the integrity update.
|
|
907
1451
|
*
|
|
908
|
-
*
|
|
909
|
-
*
|
|
910
|
-
*
|
|
911
|
-
*
|
|
912
|
-
*
|
|
1452
|
+
* Only a FIRST open consumes it, so stage only for a URI no client holds
|
|
1453
|
+
* ({@link isOpenInAnyClient} is `false`). A URI held only through another
|
|
1454
|
+
* head is not closed: an editor attaching to it joins the existing entry and
|
|
1455
|
+
* never reads the stage, and the last close discards the stage with the
|
|
1456
|
+
* tracking record. An entry lingers only if `workspace/applyEdit` fails and
|
|
1457
|
+
* the file is never opened — the memory cost is one serialised string per
|
|
1458
|
+
* URI.
|
|
913
1459
|
*/
|
|
914
1460
|
stagePendingContent(uri: DocumentUri, text: string): void {
|
|
915
1461
|
this.trackingFor(this.documentKey(uri)).pendingContent = text;
|
|
@@ -967,10 +1513,11 @@ export class HydraniumTextDocuments<T extends TextDocument = TextDocument> exten
|
|
|
967
1513
|
const targets: Iterable<LanguageClientUri> = recorded && recorded.size > 0 ? recorded : [this.toLanguageClientUri(uri)];
|
|
968
1514
|
let lastResult: ApplyWorkspaceEditResult | undefined;
|
|
969
1515
|
for (const targetUri of targets) {
|
|
970
|
-
// Read BEFORE computeEdits, which overwrites
|
|
971
|
-
//
|
|
972
|
-
// echo of
|
|
973
|
-
|
|
1516
|
+
// Read BEFORE computeEdits, which overwrites the baseline and drops
|
|
1517
|
+
// the opened snapshot. This is the text the client holds, and
|
|
1518
|
+
// therefore the only text its echo of this push can be reconstructed
|
|
1519
|
+
// against — whether or not the push below is keyed to it.
|
|
1520
|
+
const before = this.__shadow.clientText(targetUri);
|
|
974
1521
|
const edits = this.__shadow.computeEdits(targetUri, newText);
|
|
975
1522
|
if (edits.length === 0) {
|
|
976
1523
|
continue;
|
|
@@ -985,9 +1532,20 @@ export class HydraniumTextDocuments<T extends TextDocument = TextDocument> exten
|
|
|
985
1532
|
// it is exactly what the caller retries with after a rejection, so
|
|
986
1533
|
// gating it there would refuse the recovery too.
|
|
987
1534
|
const version = isFullReplace(edits) ? UNKNOWN_CLIENT_VERSION : this.languageClientVersion(uri);
|
|
1535
|
+
// A full `ApplyWorkspaceEditParams`, `edit` and all — NOT a bare
|
|
1536
|
+
// `WorkspaceEdit` with a `label` beside it. `applyEdit` takes
|
|
1537
|
+
// `ApplyWorkspaceEditParams | WorkspaceEdit` and discriminates on
|
|
1538
|
+
// `!!value.edit`, so `{ label, documentChanges }` is wrapped as
|
|
1539
|
+
// `{ edit: { label, documentChanges } }` — putting the label inside
|
|
1540
|
+
// the edit, where LSP defines no such field and no client reads it.
|
|
1541
|
+
// The union is also what hides it at compile time: excess-property
|
|
1542
|
+
// checking admits a property present in EITHER member, so an object
|
|
1543
|
+
// matching neither type-checks against the union.
|
|
988
1544
|
const result = await connection.workspace.applyEdit({
|
|
989
1545
|
label: options?.label,
|
|
990
|
-
|
|
1546
|
+
edit: {
|
|
1547
|
+
documentChanges: [TextDocumentEdit.create(OptionalVersionedTextDocumentIdentifier.create(targetUri, version), edits)]
|
|
1548
|
+
}
|
|
991
1549
|
});
|
|
992
1550
|
if (result && result.applied === false) {
|
|
993
1551
|
this.__shadow.invalidate(targetUri);
|
|
@@ -1043,12 +1601,17 @@ export class HydraniumTextDocuments<T extends TextDocument = TextDocument> exten
|
|
|
1043
1601
|
|
|
1044
1602
|
/**
|
|
1045
1603
|
* Decide what an incoming language-client change actually is, by
|
|
1046
|
-
* reconstructing the client's resulting buffer against the
|
|
1047
|
-
* in flight for
|
|
1604
|
+
* reconstructing the client's resulting buffer against the text its ranges
|
|
1605
|
+
* address — the pre-push buffer of the OLDEST push still in flight for
|
|
1606
|
+
* `clientFacing`, else whatever that client is believed to hold.
|
|
1048
1607
|
*
|
|
1049
|
-
* `undefined` when
|
|
1050
|
-
*
|
|
1051
|
-
*
|
|
1608
|
+
* `undefined` when the client's ranges address the synced text itself —
|
|
1609
|
+
* nothing in flight, and no evidence the client holds anything else. That
|
|
1610
|
+
* is the ordinary path, and the caller then applies the ranges directly.
|
|
1611
|
+
* The two texts part company without a push in flight whenever a client
|
|
1612
|
+
* attaches to a document another client has already written: it opened
|
|
1613
|
+
* from disk, so applying its ranges to the synced text splices lines they
|
|
1614
|
+
* never addressed.
|
|
1052
1615
|
*
|
|
1053
1616
|
* **Why the oldest, and why reconstruct at all.** The client applies our
|
|
1054
1617
|
* pushes in order and echoes each against the buffer it held before that
|
|
@@ -1079,22 +1642,41 @@ export class HydraniumTextDocuments<T extends TextDocument = TextDocument> exten
|
|
|
1079
1642
|
document: T,
|
|
1080
1643
|
changes: TextDocumentContentChangeEvent[]
|
|
1081
1644
|
): LanguageClientChangeOrigin | undefined {
|
|
1082
|
-
const
|
|
1083
|
-
|
|
1645
|
+
const queued = this.__pendingPushes.get(clientFacing);
|
|
1646
|
+
const pending = queued?.length ? queued : undefined;
|
|
1647
|
+
// The text the client's ranges address: the buffer it held before the
|
|
1648
|
+
// oldest push still in flight, else the buffer it is believed to hold.
|
|
1649
|
+
const clientText = pending?.[0].before ?? this.__shadow.clientText(clientFacing);
|
|
1650
|
+
if (pending === undefined && (clientText === undefined || clientText === document.getText())) {
|
|
1084
1651
|
return undefined;
|
|
1085
1652
|
}
|
|
1653
|
+
if (pending !== undefined && pending[0].before === undefined && changes.some(change => ContentChange.isIncremental(change))) {
|
|
1654
|
+
// A push sent to a client whose buffer was unknown — a first sync, or
|
|
1655
|
+
// the recovery push after a rejection. The shadow now holds the text
|
|
1656
|
+
// that push MOVES the client to, which is the one text the echo's
|
|
1657
|
+
// ranges provably do not address, so the fallback above is a baseline
|
|
1658
|
+
// known to be wrong rather than merely unverified. Drop the queue and
|
|
1659
|
+
// the shadow: the next sync is then a full replace, which lands on
|
|
1660
|
+
// whatever the client holds. A full-text change is exempt because it
|
|
1661
|
+
// reconstructs identically against any baseline.
|
|
1662
|
+
pending.length = 0;
|
|
1663
|
+
this.__shadow.invalidate(clientFacing);
|
|
1664
|
+
return { kind: 'unreconstructable' };
|
|
1665
|
+
}
|
|
1086
1666
|
// Through the configured factories, not `TextDocument` directly, so an
|
|
1087
1667
|
// adopter's custom text-document type governs how the ranges are applied
|
|
1088
1668
|
// here exactly as it does on the synced document.
|
|
1089
|
-
const probe = this.create(clientFacing, document.languageId, 0,
|
|
1090
|
-
const
|
|
1091
|
-
|
|
1092
|
-
|
|
1093
|
-
|
|
1094
|
-
|
|
1669
|
+
const probe = this.create(clientFacing, document.languageId, 0, clientText ?? document.getText());
|
|
1670
|
+
const reconstructed = this.update(probe, changes, 0).getText();
|
|
1671
|
+
if (pending !== undefined) {
|
|
1672
|
+
const matchIndex = pending.findIndex(push => push.afterHash === contentHash(reconstructed));
|
|
1673
|
+
if (matchIndex >= 0) {
|
|
1674
|
+
pending.splice(0, matchIndex + 1);
|
|
1675
|
+
return { kind: 'echo' };
|
|
1676
|
+
}
|
|
1677
|
+
pending.length = 0;
|
|
1095
1678
|
}
|
|
1096
|
-
|
|
1097
|
-
return { kind: 'divergent', text: clientText };
|
|
1679
|
+
return { kind: 'divergent', text: reconstructed };
|
|
1098
1680
|
}
|
|
1099
1681
|
|
|
1100
1682
|
/**
|