@hydranium/core 1.0.0-next.13 → 1.0.0-next.135
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 +114 -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 +187 -0
- package/lib/documents/client-session-registry.js.map +1 -0
- package/lib/documents/file-system-task-queue.d.ts +49 -0
- package/lib/documents/file-system-task-queue.d.ts.map +1 -0
- package/lib/documents/file-system-task-queue.js +34 -0
- package/lib/documents/file-system-task-queue.js.map +1 -0
- package/lib/documents/hydranium-text-documents.d.ts +386 -57
- package/lib/documents/hydranium-text-documents.d.ts.map +1 -1
- package/lib/documents/hydranium-text-documents.js +697 -113
- package/lib/documents/hydranium-text-documents.js.map +1 -1
- package/lib/documents/index.d.ts +3 -0
- package/lib/documents/index.d.ts.map +1 -1
- package/lib/documents/index.js +3 -0
- package/lib/documents/index.js.map +1 -1
- package/lib/documents/language-client-text-shadow.d.ts +41 -9
- package/lib/documents/language-client-text-shadow.d.ts.map +1 -1
- package/lib/documents/language-client-text-shadow.js +56 -11
- package/lib/documents/language-client-text-shadow.js.map +1 -1
- package/lib/documents/self-save-registry.d.ts +37 -6
- package/lib/documents/self-save-registry.d.ts.map +1 -1
- package/lib/documents/self-save-registry.js +28 -15
- package/lib/documents/self-save-registry.js.map +1 -1
- package/lib/index.d.ts +3 -0
- package/lib/index.d.ts.map +1 -1
- package/lib/index.js +6 -0
- package/lib/index.js.map +1 -1
- package/lib/langium/ast-extension/ast-node-builder.d.ts +32 -9
- package/lib/langium/ast-extension/ast-node-builder.d.ts.map +1 -1
- package/lib/langium/ast-extension/ast-node-builder.js +60 -22
- package/lib/langium/ast-extension/ast-node-builder.js.map +1 -1
- package/lib/langium/bootstrap.d.ts.map +1 -1
- package/lib/langium/bootstrap.js +16 -9
- package/lib/langium/bootstrap.js.map +1 -1
- package/lib/langium/config/configuration-provider.d.ts +81 -0
- package/lib/langium/config/configuration-provider.d.ts.map +1 -0
- package/lib/langium/config/configuration-provider.js +112 -0
- package/lib/langium/config/configuration-provider.js.map +1 -0
- package/lib/langium/config/index.d.ts +1 -0
- package/lib/langium/config/index.d.ts.map +1 -1
- package/lib/langium/config/index.js +1 -0
- package/lib/langium/config/index.js.map +1 -1
- package/lib/langium/diagnostics/lsp-logger.d.ts +17 -0
- package/lib/langium/diagnostics/lsp-logger.d.ts.map +1 -1
- package/lib/langium/diagnostics/lsp-logger.js +40 -6
- package/lib/langium/diagnostics/lsp-logger.js.map +1 -1
- package/lib/langium/document-builder/build-pipeline-integration.d.ts +21 -1
- package/lib/langium/document-builder/build-pipeline-integration.d.ts.map +1 -1
- package/lib/langium/document-builder/build-pipeline-integration.js +32 -5
- package/lib/langium/document-builder/build-pipeline-integration.js.map +1 -1
- package/lib/langium/document-builder/build-session.d.ts +93 -0
- package/lib/langium/document-builder/build-session.d.ts.map +1 -0
- package/lib/langium/document-builder/build-session.js +72 -0
- package/lib/langium/document-builder/build-session.js.map +1 -0
- package/lib/langium/document-builder/document-builder.d.ts +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 +50 -6
- package/lib/langium/integrity/integrity-service.d.ts.map +1 -1
- package/lib/langium/integrity/integrity-service.js +193 -17
- package/lib/langium/integrity/integrity-service.js.map +1 -1
- package/lib/langium/keys/containment.d.ts +64 -0
- package/lib/langium/keys/containment.d.ts.map +1 -0
- package/lib/langium/keys/containment.js +53 -0
- package/lib/langium/keys/containment.js.map +1 -0
- package/lib/langium/keys/index.d.ts +1 -0
- package/lib/langium/keys/index.d.ts.map +1 -1
- package/lib/langium/keys/index.js +1 -0
- package/lib/langium/keys/index.js.map +1 -1
- package/lib/langium/keys/name-based-key-provider.d.ts +4 -0
- package/lib/langium/keys/name-based-key-provider.d.ts.map +1 -1
- package/lib/langium/keys/name-based-key-provider.js +4 -0
- package/lib/langium/keys/name-based-key-provider.js.map +1 -1
- package/lib/langium/language-module.d.ts +27 -2
- package/lib/langium/language-module.d.ts.map +1 -1
- package/lib/langium/language-module.js +16 -2
- package/lib/langium/language-module.js.map +1 -1
- package/lib/langium/model-service/client-session.d.ts +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 +227 -162
- package/lib/langium/model-service/model-service.d.ts.map +1 -1
- package/lib/langium/model-service/model-service.js +203 -309
- package/lib/langium/model-service/model-service.js.map +1 -1
- package/lib/langium/module.d.ts +102 -18
- package/lib/langium/module.d.ts.map +1 -1
- package/lib/langium/module.js +30 -12
- package/lib/langium/module.js.map +1 -1
- package/lib/langium/naming/name-provider.d.ts +25 -4
- package/lib/langium/naming/name-provider.d.ts.map +1 -1
- package/lib/langium/naming/name-provider.js +2 -1
- package/lib/langium/naming/name-provider.js.map +1 -1
- package/lib/langium/naming/name-separator-validation.d.ts +23 -0
- package/lib/langium/naming/name-separator-validation.d.ts.map +1 -1
- package/lib/langium/naming/name-separator-validation.js +30 -1
- package/lib/langium/naming/name-separator-validation.js.map +1 -1
- package/lib/langium/residency/cst-residency-service.d.ts +31 -11
- package/lib/langium/residency/cst-residency-service.d.ts.map +1 -1
- package/lib/langium/residency/cst-residency-service.js +13 -56
- package/lib/langium/residency/cst-residency-service.js.map +1 -1
- package/lib/langium/scope/hydranium-scope-provider.d.ts +48 -13
- package/lib/langium/scope/hydranium-scope-provider.d.ts.map +1 -1
- package/lib/langium/scope/hydranium-scope-provider.js +56 -20
- package/lib/langium/scope/hydranium-scope-provider.js.map +1 -1
- package/lib/langium/serialization/abstract-serializer.d.ts +11 -20
- package/lib/langium/serialization/abstract-serializer.d.ts.map +1 -1
- package/lib/langium/serialization/abstract-serializer.js +12 -21
- package/lib/langium/serialization/abstract-serializer.js.map +1 -1
- package/lib/langium/service-registry.d.ts +15 -1
- package/lib/langium/service-registry.d.ts.map +1 -1
- package/lib/langium/service-registry.js +16 -0
- package/lib/langium/service-registry.js.map +1 -1
- package/lib/langium/shared-services.d.ts +15 -2
- package/lib/langium/shared-services.d.ts.map +1 -1
- package/lib/langium/shared-services.js.map +1 -1
- package/lib/langium/transfer/transfer-encoder.d.ts +60 -17
- package/lib/langium/transfer/transfer-encoder.d.ts.map +1 -1
- package/lib/langium/transfer/transfer-encoder.js +38 -16
- package/lib/langium/transfer/transfer-encoder.js.map +1 -1
- package/lib/langium/trivia/comment-preserver.d.ts +423 -0
- package/lib/langium/trivia/comment-preserver.d.ts.map +1 -0
- package/lib/langium/trivia/comment-preserver.js +906 -0
- package/lib/langium/trivia/comment-preserver.js.map +1 -0
- package/lib/langium/trivia/document-ending-preserver.d.ts +43 -0
- package/lib/langium/trivia/document-ending-preserver.d.ts.map +1 -0
- package/lib/langium/trivia/document-ending-preserver.js +48 -0
- package/lib/langium/trivia/document-ending-preserver.js.map +1 -0
- package/lib/langium/trivia/index.d.ts +14 -0
- package/lib/langium/trivia/index.d.ts.map +1 -0
- package/lib/langium/trivia/index.js +14 -0
- package/lib/langium/trivia/index.js.map +1 -0
- package/lib/langium/trivia/trivia-contribution.d.ts +37 -0
- package/lib/langium/trivia/trivia-contribution.d.ts.map +1 -0
- package/lib/langium/trivia/trivia-contribution.js +10 -0
- package/lib/langium/trivia/trivia-contribution.js.map +1 -0
- package/lib/langium/trivia/trivia-preserver.d.ts +50 -0
- package/lib/langium/trivia/trivia-preserver.d.ts.map +1 -0
- package/lib/langium/trivia/trivia-preserver.js +10 -0
- package/lib/langium/trivia/trivia-preserver.js.map +1 -0
- package/lib/langium/trivia/trivia-service.d.ts +70 -0
- package/lib/langium/trivia/trivia-service.d.ts.map +1 -0
- package/lib/langium/trivia/trivia-service.js +56 -0
- package/lib/langium/trivia/trivia-service.js.map +1 -0
- package/lib/langium/update-rewrite/update-rewrite.d.ts +1 -1
- package/lib/langium/validation/document-validator.d.ts +294 -10
- package/lib/langium/validation/document-validator.d.ts.map +1 -1
- package/lib/langium/validation/document-validator.js +448 -5
- package/lib/langium/validation/document-validator.js.map +1 -1
- package/lib/langium/workspace/document-uri-policy.d.ts +3 -4
- package/lib/langium/workspace/document-uri-policy.d.ts.map +1 -1
- package/lib/langium/workspace/document-uri-policy.js +3 -4
- package/lib/langium/workspace/document-uri-policy.js.map +1 -1
- package/lib/langium/workspace/file-system-provider.d.ts +9 -1
- package/lib/langium/workspace/file-system-provider.d.ts.map +1 -1
- package/lib/langium/workspace/file-system-provider.js +40 -7
- package/lib/langium/workspace/file-system-provider.js.map +1 -1
- package/lib/langium/workspace/hydranium-langium-document-factory.d.ts +25 -0
- package/lib/langium/workspace/hydranium-langium-document-factory.d.ts.map +1 -1
- package/lib/langium/workspace/hydranium-langium-document-factory.js +25 -0
- package/lib/langium/workspace/hydranium-langium-document-factory.js.map +1 -1
- package/lib/langium/workspace/hydranium-workspace-manager.d.ts +21 -1
- package/lib/langium/workspace/hydranium-workspace-manager.d.ts.map +1 -1
- package/lib/langium/workspace/hydranium-workspace-manager.js +28 -0
- package/lib/langium/workspace/hydranium-workspace-manager.js.map +1 -1
- package/lib/langium/workspace/in-memory-file-system-provider.d.ts +23 -0
- package/lib/langium/workspace/in-memory-file-system-provider.d.ts.map +1 -1
- package/lib/langium/workspace/in-memory-file-system-provider.js +55 -9
- package/lib/langium/workspace/in-memory-file-system-provider.js.map +1 -1
- package/lib/langium/workspace/initialize-workspace.d.ts +31 -2
- package/lib/langium/workspace/initialize-workspace.d.ts.map +1 -1
- package/lib/langium/workspace/initialize-workspace.js +13 -5
- package/lib/langium/workspace/initialize-workspace.js.map +1 -1
- package/lib/langium/workspace/langium-documents.d.ts +79 -17
- package/lib/langium/workspace/langium-documents.d.ts.map +1 -1
- package/lib/langium/workspace/langium-documents.js +83 -28
- package/lib/langium/workspace/langium-documents.js.map +1 -1
- package/lib/langium/workspace/virtual-document.d.ts +18 -3
- package/lib/langium/workspace/virtual-document.d.ts.map +1 -1
- package/lib/langium/workspace/virtual-document.js +19 -2
- package/lib/langium/workspace/virtual-document.js.map +1 -1
- package/lib/langium/workspace/write-lock-scope.d.ts +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 +129 -75
- package/lib/lsp/hydranium-document-update-handler.js.map +1 -1
- package/lib/lsp/index.d.ts +3 -1
- package/lib/lsp/index.d.ts.map +1 -1
- package/lib/lsp/index.js +3 -1
- package/lib/lsp/index.js.map +1 -1
- package/lib/lsp/lsp-latency.d.ts +39 -0
- package/lib/lsp/lsp-latency.d.ts.map +1 -0
- package/lib/lsp/lsp-latency.js +58 -0
- package/lib/lsp/lsp-latency.js.map +1 -0
- package/lib/lsp/semantic-token-provider.d.ts +34 -1
- package/lib/lsp/semantic-token-provider.d.ts.map +1 -1
- package/lib/lsp/semantic-token-provider.js +55 -8
- package/lib/lsp/semantic-token-provider.js.map +1 -1
- package/lib/lsp/shared-module.d.ts +4 -8
- package/lib/lsp/shared-module.d.ts.map +1 -1
- package/lib/lsp/shared-module.js.map +1 -1
- package/lib/lsp/start-language-server.d.ts +8 -7
- package/lib/lsp/start-language-server.d.ts.map +1 -1
- package/lib/lsp/start-language-server.js +13 -7
- package/lib/lsp/start-language-server.js.map +1 -1
- package/lib/messages/carriers.d.ts +54 -0
- package/lib/messages/carriers.d.ts.map +1 -0
- package/lib/messages/carriers.js +62 -0
- package/lib/messages/carriers.js.map +1 -0
- package/lib/messages/index.d.ts +25 -0
- package/lib/messages/index.d.ts.map +1 -0
- package/lib/messages/index.js +25 -0
- package/lib/messages/index.js.map +1 -0
- package/lib/messages/renderer.d.ts +142 -0
- package/lib/messages/renderer.d.ts.map +1 -0
- package/lib/messages/renderer.js +165 -0
- package/lib/messages/renderer.js.map +1 -0
- package/lib/node/heap-ceiling.d.ts +61 -0
- package/lib/node/heap-ceiling.d.ts.map +1 -0
- package/lib/node/heap-ceiling.js +72 -0
- package/lib/node/heap-ceiling.js.map +1 -0
- package/lib/node/index.d.ts +1 -0
- package/lib/node/index.d.ts.map +1 -1
- package/lib/node/index.js +1 -0
- package/lib/node/index.js.map +1 -1
- package/lib/node/latency-from-env.d.ts +1 -1
- package/lib/node/latency-from-env.js +1 -1
- package/lib/node/measure-memory.d.ts.map +1 -1
- package/lib/node/measure-memory.js +1 -0
- package/lib/node/measure-memory.js.map +1 -1
- package/lib/node/node-file-system-provider.d.ts +35 -1
- package/lib/node/node-file-system-provider.d.ts.map +1 -1
- package/lib/node/node-file-system-provider.js +140 -45
- package/lib/node/node-file-system-provider.js.map +1 -1
- package/lib/node/profile-capture.d.ts +8 -2
- package/lib/node/profile-capture.d.ts.map +1 -1
- package/lib/node/profile-capture.js.map +1 -1
- package/lib/node/profiling-run.d.ts +2 -2
- package/lib/node/profiling-run.js +1 -1
- package/lib/node/profiling-run.js.map +1 -1
- package/lib/node/rename-over-open-readers.d.ts +52 -0
- package/lib/node/rename-over-open-readers.d.ts.map +1 -0
- package/lib/node/rename-over-open-readers.js +66 -0
- package/lib/node/rename-over-open-readers.js.map +1 -0
- package/lib/node/socket-launcher.d.ts +16 -1
- package/lib/node/socket-launcher.d.ts.map +1 -1
- package/lib/node/socket-launcher.js +4 -3
- package/lib/node/socket-launcher.js.map +1 -1
- package/lib/node/stdio-launcher.d.ts +1 -1
- package/lib/node/stdio-launcher.d.ts.map +1 -1
- package/lib/node/stdio-launcher.js +1 -1
- package/lib/node/stdio-launcher.js.map +1 -1
- package/lib/testing/fake-document.d.ts +16 -4
- package/lib/testing/fake-document.d.ts.map +1 -1
- package/lib/testing/fake-document.js +18 -3
- package/lib/testing/fake-document.js.map +1 -1
- package/lib/testing/make-noop-shared-services.d.ts +14 -0
- package/lib/testing/make-noop-shared-services.d.ts.map +1 -1
- package/lib/testing/make-noop-shared-services.js +28 -2
- package/lib/testing/make-noop-shared-services.js.map +1 -1
- package/lib/testing/make-test-services.d.ts +62 -14
- package/lib/testing/make-test-services.d.ts.map +1 -1
- package/lib/testing/make-test-services.js +25 -5
- package/lib/testing/make-test-services.js.map +1 -1
- package/lib/testing/node/index.d.ts +1 -0
- package/lib/testing/node/index.d.ts.map +1 -1
- package/lib/testing/node/index.js +1 -0
- package/lib/testing/node/index.js.map +1 -1
- package/lib/testing/node/lsp-harness.d.ts.map +1 -1
- package/lib/testing/node/lsp-harness.js +2 -0
- package/lib/testing/node/lsp-harness.js.map +1 -1
- package/lib/testing/node/lsp-server-connection.d.ts +11 -3
- package/lib/testing/node/lsp-server-connection.d.ts.map +1 -1
- package/lib/testing/node/lsp-server-connection.js +42 -9
- package/lib/testing/node/lsp-server-connection.js.map +1 -1
- package/lib/testing/node/scratch-workspace.d.ts.map +1 -1
- package/lib/testing/node/scratch-workspace.js +10 -5
- package/lib/testing/node/scratch-workspace.js.map +1 -1
- package/lib/testing/node/spawned-server.d.ts +14 -0
- package/lib/testing/node/spawned-server.d.ts.map +1 -1
- package/lib/testing/node/spawned-server.js +33 -1
- package/lib/testing/node/spawned-server.js.map +1 -1
- package/lib/testing/node/unhandled-rejections.d.ts +20 -0
- package/lib/testing/node/unhandled-rejections.d.ts.map +1 -0
- package/lib/testing/node/unhandled-rejections.js +32 -0
- package/lib/testing/node/unhandled-rejections.js.map +1 -0
- package/lib/testing/playwright/flaky-network-proxy.d.ts +76 -0
- package/lib/testing/playwright/flaky-network-proxy.d.ts.map +1 -0
- package/lib/testing/playwright/flaky-network-proxy.js +164 -0
- package/lib/testing/playwright/flaky-network-proxy.js.map +1 -0
- package/lib/testing/playwright/index.d.ts +1 -0
- package/lib/testing/playwright/index.d.ts.map +1 -1
- package/lib/testing/playwright/index.js +1 -0
- package/lib/testing/playwright/index.js.map +1 -1
- package/lib/testing/playwright/server-log-capture.d.ts +14 -4
- package/lib/testing/playwright/server-log-capture.d.ts.map +1 -1
- package/lib/testing/playwright/server-log-capture.js +21 -4
- package/lib/testing/playwright/server-log-capture.js.map +1 -1
- package/lib/testing/playwright/server-log-rename-reporter.d.ts.map +1 -1
- package/lib/testing/playwright/server-log-rename-reporter.js +10 -1
- package/lib/testing/playwright/server-log-rename-reporter.js.map +1 -1
- package/lib/testing/run-update-pipeline.d.ts +4 -4
- package/lib/testing/run-update-pipeline.d.ts.map +1 -1
- package/lib/testing/stub-ast-document-manager.d.ts +10 -9
- package/lib/testing/stub-ast-document-manager.d.ts.map +1 -1
- package/lib/testing/stub-ast-document-manager.js +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 +22 -7
- package/lib/testing/stub-hydranium-text-documents.d.ts.map +1 -1
- package/lib/testing/stub-hydranium-text-documents.js +92 -15
- package/lib/testing/stub-hydranium-text-documents.js.map +1 -1
- package/lib/testing/stub-langium-documents.d.ts +3 -2
- package/lib/testing/stub-langium-documents.d.ts.map +1 -1
- package/lib/testing/stub-langium-documents.js.map +1 -1
- package/lib/testing/stub-model-service.d.ts +7 -6
- package/lib/testing/stub-model-service.d.ts.map +1 -1
- package/lib/testing/stub-model-service.js +4 -4
- package/lib/testing/stub-model-service.js.map +1 -1
- package/lib/util/connection-liveness.d.ts +7 -6
- package/lib/util/connection-liveness.d.ts.map +1 -1
- package/lib/util/connection-liveness.js +35 -14
- package/lib/util/connection-liveness.js.map +1 -1
- package/package.json +17 -8
- package/src/documents/ast-document-manager.ts +195 -45
- package/src/documents/client-ids.ts +5 -22
- package/src/documents/client-session-errors.ts +24 -0
- package/src/documents/client-session-registry.ts +240 -0
- package/src/documents/file-system-task-queue.ts +68 -0
- package/src/documents/hydranium-text-documents.ts +853 -142
- package/src/documents/index.ts +3 -0
- package/src/documents/language-client-text-shadow.ts +59 -11
- package/src/documents/self-save-registry.ts +52 -13
- package/src/index.ts +6 -0
- package/src/langium/ast-extension/ast-node-builder.ts +66 -22
- package/src/langium/bootstrap.ts +16 -9
- package/src/langium/config/configuration-provider.ts +119 -0
- package/src/langium/config/index.ts +1 -0
- package/src/langium/diagnostics/lsp-logger.ts +41 -6
- package/src/langium/document-builder/build-pipeline-integration.ts +50 -5
- package/src/langium/document-builder/build-session.ts +87 -0
- package/src/langium/document-builder/document-builder.ts +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 +202 -17
- package/src/langium/keys/containment.ts +87 -0
- package/src/langium/keys/index.ts +1 -0
- package/src/langium/keys/name-based-key-provider.ts +4 -0
- package/src/langium/language-module.ts +42 -4
- package/src/langium/model-service/client-session.ts +581 -0
- package/src/langium/model-service/index.ts +1 -0
- package/src/langium/model-service/model-service.ts +348 -298
- package/src/langium/module.ts +132 -24
- package/src/langium/naming/name-provider.ts +27 -5
- package/src/langium/naming/name-separator-validation.ts +34 -5
- package/src/langium/residency/cst-residency-service.ts +36 -14
- package/src/langium/scope/hydranium-scope-provider.ts +60 -22
- package/src/langium/serialization/abstract-serializer.ts +13 -32
- package/src/langium/service-registry.ts +19 -2
- package/src/langium/shared-services.ts +19 -2
- package/src/langium/transfer/transfer-encoder.ts +85 -24
- package/src/langium/trivia/comment-preserver.ts +1100 -0
- package/src/langium/trivia/document-ending-preserver.ts +55 -0
- package/src/langium/trivia/index.ts +14 -0
- package/src/langium/trivia/trivia-contribution.ts +39 -0
- package/src/langium/trivia/trivia-preserver.ts +54 -0
- package/src/langium/trivia/trivia-service.ts +99 -0
- package/src/langium/update-rewrite/update-rewrite.ts +1 -1
- package/src/langium/validation/document-validator.ts +537 -11
- package/src/langium/workspace/document-uri-policy.ts +3 -4
- package/src/langium/workspace/file-system-provider.ts +48 -8
- package/src/langium/workspace/hydranium-langium-document-factory.ts +34 -0
- package/src/langium/workspace/hydranium-workspace-manager.ts +30 -1
- package/src/langium/workspace/in-memory-file-system-provider.ts +62 -10
- package/src/langium/workspace/initialize-workspace.ts +43 -5
- package/src/langium/workspace/langium-documents.ts +106 -33
- package/src/langium/workspace/virtual-document.ts +21 -3
- package/src/langium/workspace/write-lock-scope.ts +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 +158 -79
- package/src/lsp/index.ts +3 -1
- package/src/lsp/lsp-latency.ts +62 -0
- package/src/lsp/semantic-token-provider.ts +74 -7
- package/src/lsp/shared-module.ts +4 -8
- package/src/lsp/start-language-server.ts +13 -7
- package/src/messages/carriers.ts +78 -0
- package/src/messages/index.ts +36 -0
- package/src/messages/renderer.ts +212 -0
- package/src/node/heap-ceiling.ts +108 -0
- package/src/node/index.ts +1 -0
- package/src/node/latency-from-env.ts +1 -1
- package/src/node/measure-memory.ts +1 -0
- package/src/node/node-file-system-provider.ts +154 -47
- package/src/node/profile-capture.ts +8 -2
- package/src/node/profiling-run.ts +3 -3
- package/src/node/rename-over-open-readers.ts +78 -0
- package/src/node/socket-launcher.ts +19 -4
- package/src/node/stdio-launcher.ts +1 -2
- package/src/testing/fake-document.ts +24 -5
- package/src/testing/make-noop-shared-services.ts +50 -2
- package/src/testing/make-test-services.ts +101 -26
- package/src/testing/node/index.ts +1 -0
- package/src/testing/node/lsp-harness.ts +2 -0
- package/src/testing/node/lsp-server-connection.ts +61 -11
- package/src/testing/node/scratch-workspace.ts +10 -5
- package/src/testing/node/spawned-server.ts +35 -1
- package/src/testing/node/unhandled-rejections.ts +31 -0
- package/src/testing/playwright/flaky-network-proxy.ts +240 -0
- package/src/testing/playwright/index.ts +1 -0
- package/src/testing/playwright/server-log-capture.ts +24 -5
- package/src/testing/playwright/server-log-rename-reporter.ts +12 -1
- package/src/testing/run-update-pipeline.ts +4 -4
- package/src/testing/stub-ast-document-manager.ts +18 -31
- package/src/testing/stub-document-builder.ts +32 -3
- package/src/testing/stub-hydranium-text-documents.ts +127 -22
- package/src/testing/stub-langium-documents.ts +3 -2
- package/src/testing/stub-model-service.ts +9 -8
- package/src/util/connection-liveness.ts +37 -14
- package/lib/lsp/instrument-connection.d.ts +0 -36
- package/lib/lsp/instrument-connection.d.ts.map +0 -1
- package/lib/lsp/instrument-connection.js +0 -62
- package/lib/lsp/instrument-connection.js.map +0 -1
- package/src/lsp/instrument-connection.ts +0 -66
|
@@ -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 { type 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,46 @@ 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;
|
|
122
|
+
}
|
|
123
|
+
|
|
124
|
+
/** Delivered by {@link HydraniumTextDocuments.onDidChangeDirty}. */
|
|
125
|
+
export interface DocumentDirtyChangedEvent {
|
|
126
|
+
readonly uri: CanonicalUri;
|
|
127
|
+
/** The new answer of {@link HydraniumTextDocuments.isDirty}. */
|
|
128
|
+
readonly dirty: boolean;
|
|
77
129
|
}
|
|
78
130
|
|
|
79
131
|
/**
|
|
@@ -89,10 +141,13 @@ export interface HydraniumTextDocumentsOptions<T extends TextDocument = TextDocu
|
|
|
89
141
|
* separately-tested diff/apply-verify abstraction that owns its own baseline
|
|
90
142
|
* text; folding its storage here would couple a clean utility to this record
|
|
91
143
|
* for no real gain.
|
|
144
|
+
*
|
|
145
|
+
* Returned by the `protected` {@link HydraniumTextDocuments.trackingFor}, so an
|
|
146
|
+
* override has to name it. Restating the shape structurally instead compiles
|
|
147
|
+
* until a field is added here, and then fails at the adopter rather than at the
|
|
148
|
+
* change that caused it.
|
|
92
149
|
*/
|
|
93
|
-
interface
|
|
94
|
-
/** Client ids currently holding this document open (multi-client membership). */
|
|
95
|
-
readonly clients: Set<string>;
|
|
150
|
+
export interface DocumentTrackingRecord {
|
|
96
151
|
/** Author of each version, sparse-indexed by the SHARED (server-assigned) version number. */
|
|
97
152
|
readonly versionAuthors: string[];
|
|
98
153
|
/**
|
|
@@ -115,6 +170,29 @@ interface DocumentTracking {
|
|
|
115
170
|
* record on last close.
|
|
116
171
|
*/
|
|
117
172
|
languageClientUris?: Set<LanguageClientUri>;
|
|
173
|
+
/**
|
|
174
|
+
* The clients whose close of this document was caused by a lost connection
|
|
175
|
+
* and that have not opened it again, each with a stopwatch started at its
|
|
176
|
+
* loss on the store's `Clock`. While the document waits out the revert grace, only an
|
|
177
|
+
* open by one of them within its own
|
|
178
|
+
* {@link HydraniumTextDocumentsOptions.revertGraceMs} of that loss cancels
|
|
179
|
+
* the revert. Every such client counts, not only the last to close: one
|
|
180
|
+
* connection's sessions all end lost together, and any of them may reopen
|
|
181
|
+
* first. Without the time limit, a client that returns late inherits the
|
|
182
|
+
* unsaved text of a holder lost after it. A stopwatch rather than a `now()`
|
|
183
|
+
* reading, because a wall-clock step would otherwise expire a claim early or
|
|
184
|
+
* revive one past its grace, against a grace timer that the step leaves
|
|
185
|
+
* alone. An entry past its grace counts as any other client's and is pruned
|
|
186
|
+
* at the next open of the document.
|
|
187
|
+
*/
|
|
188
|
+
lostClients?: Map<string, Stopwatch>;
|
|
189
|
+
/**
|
|
190
|
+
* The text the server last knew the file to hold, `undefined` for no file.
|
|
191
|
+
* Set by the first open and moved by {@link HydraniumTextDocuments.updateDiskBaseline}.
|
|
192
|
+
*/
|
|
193
|
+
diskBaseline?: string;
|
|
194
|
+
/** The last answer {@link HydraniumTextDocuments.onDidChangeDirty} announced. */
|
|
195
|
+
dirty?: boolean;
|
|
118
196
|
}
|
|
119
197
|
|
|
120
198
|
/**
|
|
@@ -128,13 +206,28 @@ export interface OpenDocument {
|
|
|
128
206
|
readonly clients: readonly string[];
|
|
129
207
|
}
|
|
130
208
|
|
|
209
|
+
/**
|
|
210
|
+
* What {@link HydraniumTextDocuments.commitRepair} did with an integrity repair.
|
|
211
|
+
*
|
|
212
|
+
* Three outcomes rather than a document-or-nothing, because the two ways of
|
|
213
|
+
* getting nothing call for opposite responses: `not-open` means there is no
|
|
214
|
+
* store document to correct and the caller carries on with the one it holds,
|
|
215
|
+
* while `stale` means there IS one and it has moved past the text the repair
|
|
216
|
+
* was computed against — so carrying on would persist a correction over an edit
|
|
217
|
+
* that superseded it. Collapsing them lets the second read as permission to
|
|
218
|
+
* proceed, which is the failure this shape exists to make unrepresentable.
|
|
219
|
+
*/
|
|
220
|
+
export type RepairCommit<T extends TextDocument> =
|
|
221
|
+
{ readonly status: 'committed'; readonly document: T } | { readonly status: 'stale' } | { readonly status: 'not-open' };
|
|
222
|
+
|
|
131
223
|
/**
|
|
132
224
|
* Where a URI's shared version sequence left off — written once at last-client
|
|
133
225
|
* close, consulted at the next open so the sequence CONTINUES instead of
|
|
134
226
|
* restarting at whatever version id the reopening client declares. One entry
|
|
135
|
-
* of {@link HydraniumTextDocuments.__versionSequences}
|
|
227
|
+
* of {@link HydraniumTextDocuments.__versionSequences} — a `protected` field, so
|
|
228
|
+
* a subclass reading the map has to name what it holds.
|
|
136
229
|
*/
|
|
137
|
-
interface VersionSequence {
|
|
230
|
+
export interface VersionSequence {
|
|
138
231
|
/** The shared version at last-client close. */
|
|
139
232
|
readonly version: number;
|
|
140
233
|
/** {@link contentHash} of the synced text at last-client close. */
|
|
@@ -161,19 +254,20 @@ interface ConnectionWithTextDocumentSync {
|
|
|
161
254
|
/**
|
|
162
255
|
* One text pushed to the LSP textual language client by
|
|
163
256
|
* {@link HydraniumTextDocuments.applyEditToLanguageClient} whose echo has not
|
|
164
|
-
* come back yet. One entry of {@link HydraniumTextDocuments.__pendingPushes}
|
|
257
|
+
* come back yet. One entry of {@link HydraniumTextDocuments.__pendingPushes} —
|
|
258
|
+
* a `protected` field, so a subclass reading the queue has to name what it holds.
|
|
165
259
|
*/
|
|
166
|
-
interface
|
|
260
|
+
export interface PendingLanguageClientPush {
|
|
167
261
|
/**
|
|
168
|
-
* The text the client held BEFORE this push
|
|
169
|
-
*
|
|
170
|
-
*
|
|
262
|
+
* The text the client held BEFORE this push, and therefore the text its
|
|
263
|
+
* echo addresses with its ranges. Wider than the baseline the push's edits
|
|
264
|
+
* were diffed against: a full replace is sent with no diff baseline and
|
|
265
|
+
* still lands on a buffer the echo is keyed to.
|
|
171
266
|
*
|
|
172
|
-
* `undefined` when
|
|
173
|
-
*
|
|
174
|
-
*
|
|
175
|
-
*
|
|
176
|
-
* application is position-independent.
|
|
267
|
+
* `undefined` only when that buffer is unknown — the client never declared
|
|
268
|
+
* one, or a rejection invalidated what was tracked. The echo is then
|
|
269
|
+
* reconstructed against the synced text, which is sound only for a
|
|
270
|
+
* position-independent (full-text) change.
|
|
177
271
|
*/
|
|
178
272
|
readonly before: string | undefined;
|
|
179
273
|
/** {@link contentHash} of the text this push moves the client to. */
|
|
@@ -182,18 +276,38 @@ interface PendingPush {
|
|
|
182
276
|
|
|
183
277
|
/**
|
|
184
278
|
* What an incoming language-client change turns out to be once reconstructed
|
|
185
|
-
* against the
|
|
186
|
-
* {@link HydraniumTextDocuments.classifyLanguageClientChange}.
|
|
279
|
+
* against the buffer its ranges address — the return of
|
|
280
|
+
* {@link HydraniumTextDocuments.classifyLanguageClientChange}. That method is
|
|
281
|
+
* `protected`, so an override has to name every arm it can return.
|
|
187
282
|
*/
|
|
188
|
-
type LanguageClientChangeOrigin =
|
|
283
|
+
export type LanguageClientChangeOrigin =
|
|
189
284
|
/** The client is reporting a text we pushed it. The synced document is already there. */
|
|
190
285
|
| { readonly kind: 'echo' }
|
|
191
286
|
/**
|
|
192
|
-
* The client's buffer
|
|
193
|
-
* a
|
|
194
|
-
* reconstructed text is what it now holds, and is authoritative.
|
|
287
|
+
* The client's buffer holds a text we did not push it — a keystroke that
|
|
288
|
+
* raced a push, or an edit to a buffer the store has already been written
|
|
289
|
+
* past. The reconstructed text is what it now holds, and is authoritative.
|
|
195
290
|
*/
|
|
196
|
-
| { readonly kind: 'divergent'; readonly text: string }
|
|
291
|
+
| { readonly kind: 'divergent'; readonly text: string }
|
|
292
|
+
/**
|
|
293
|
+
* The change carries ranges and no known text addresses them, so no
|
|
294
|
+
* reconstruction is offered. Adopting one anyway splices the document and
|
|
295
|
+
* stores an edit nobody made; dropping costs at most the one keystroke the
|
|
296
|
+
* client still holds and the next push contradicts.
|
|
297
|
+
*/
|
|
298
|
+
| { readonly kind: 'unreconstructable' };
|
|
299
|
+
|
|
300
|
+
/**
|
|
301
|
+
* Whether `err` reports that the file of `target` does not exist, as a Node
|
|
302
|
+
* file system and the framework's providers do: code `ENOENT`, with `target`'s
|
|
303
|
+
* path. A missing file of another document is a different failure.
|
|
304
|
+
*/
|
|
305
|
+
function isFileNotFound(err: unknown, target: URI): boolean {
|
|
306
|
+
if (typeof err !== 'object' || err === null || !('code' in err) || err.code !== 'ENOENT') {
|
|
307
|
+
return false;
|
|
308
|
+
}
|
|
309
|
+
return !('path' in err) || err.path === target.fsPath;
|
|
310
|
+
}
|
|
197
311
|
|
|
198
312
|
/**
|
|
199
313
|
* Cheap, stable, non-cryptographic content hash (cyrb53) for the version
|
|
@@ -222,15 +336,21 @@ function contentHash(text: string): string {
|
|
|
222
336
|
* Multi-client text-document tracking on top of Langium's `NormalizedTextDocuments`.
|
|
223
337
|
*
|
|
224
338
|
* 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
|
|
339
|
+
* - Per-document client membership (multiple clients can attach to the same
|
|
340
|
+
* URI) and the client-session table, both kept by {@link __sessions}.
|
|
226
341
|
* - A SERVER-OWNED shared version sequence: per-URI, monotonic across
|
|
227
342
|
* close/reopen cycles, advancing exactly when the synced content changes.
|
|
228
343
|
* Client-declared version ids (Monaco's buffer numbering) feed only a
|
|
229
344
|
* per-client staleness guard and never leak into the shared sequence —
|
|
230
345
|
* the two are different things (an editor's edit-operation counter vs the
|
|
231
346
|
* document's content-revision number), and splicing them lets versions drift
|
|
232
|
-
* silently past
|
|
347
|
+
* silently past based-on gate holders.
|
|
233
348
|
* - Version-author history so each edit is attributable to its originating client.
|
|
349
|
+
* - The revert to disk once no client has a document open, for every head
|
|
350
|
+
* ({@link revertToDisk}), deferred by
|
|
351
|
+
* {@link HydraniumTextDocumentsOptions.revertGraceMs} after a lost connection.
|
|
352
|
+
* - A disk baseline per open document, and whether its text differs from it
|
|
353
|
+
* ({@link isDirty}).
|
|
234
354
|
* - Pending-content staging used by the integrity service to thread corrections
|
|
235
355
|
* through `workspace/applyEdit` cycles for currently-closed documents.
|
|
236
356
|
* - `didOpen` notifications arriving over the LSP connection wait on the
|
|
@@ -240,23 +360,28 @@ function contentHash(text: string): string {
|
|
|
240
360
|
*/
|
|
241
361
|
export class HydraniumTextDocuments<T extends TextDocument = TextDocument> extends NormalizedTextDocuments<T> {
|
|
242
362
|
/**
|
|
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`.
|
|
363
|
+
* Per-URI client-facing tracking ({@link DocumentTrackingRecord}), keyed by
|
|
364
|
+
* canonical URI. One record per URI, so dropping it clears every axis at
|
|
365
|
+
* once. Which client has the document open is kept apart, in
|
|
366
|
+
* {@link __sessions}.
|
|
249
367
|
*/
|
|
250
|
-
protected __documents = new Map<CanonicalUri,
|
|
368
|
+
protected __documents = new Map<CanonicalUri, DocumentTrackingRecord>();
|
|
369
|
+
|
|
370
|
+
/**
|
|
371
|
+
* Which client has which document open, and which client ids are registered
|
|
372
|
+
* sessions. Every open-state predicate on this class reads it, so an open
|
|
373
|
+
* recorded anywhere else is invisible to the last-close transition.
|
|
374
|
+
*/
|
|
375
|
+
protected readonly __sessions = new ClientSessionRegistry();
|
|
251
376
|
|
|
252
377
|
/**
|
|
253
378
|
* Per-URI shared-version continuity across close/reopen cycles
|
|
254
379
|
* ({@link VersionSequence}), written at last-client close and consulted by
|
|
255
|
-
* the next first-client open. DELIBERATELY outside {@link
|
|
380
|
+
* the next first-client open. DELIBERATELY outside {@link DocumentTrackingRecord}:
|
|
256
381
|
* that record is deleted on last close, while the version sequence must
|
|
257
382
|
* survive it — the shared version is a server-owned, monotonic,
|
|
258
383
|
* advances-iff-content-changes counter that never resets while the server
|
|
259
|
-
* lives. That invariant is what makes an optimistic
|
|
384
|
+
* lives. That invariant is what makes an optimistic based-on gate
|
|
260
385
|
* sound: "version unchanged ⇔ content unchanged", with no false conflicts
|
|
261
386
|
* from close/reopen version resets and no false passes from a reopened
|
|
262
387
|
* sequence coincidentally landing on a stale writer's number.
|
|
@@ -269,7 +394,7 @@ export class HydraniumTextDocuments<T extends TextDocument = TextDocument> exten
|
|
|
269
394
|
/**
|
|
270
395
|
* Texts pushed to the LSP textual language client via
|
|
271
396
|
* {@link applyEditToLanguageClient} whose echoes have not come back yet
|
|
272
|
-
* ({@link
|
|
397
|
+
* ({@link PendingLanguageClientPush}), keyed like the shadow by language-client URI.
|
|
273
398
|
* Outbound pushes and inbound echoes are uncorrelated on the wire; this
|
|
274
399
|
* FIFO is the explicit correlation, and it is what
|
|
275
400
|
* {@link classifyLanguageClientChange} reconstructs against.
|
|
@@ -291,7 +416,7 @@ export class HydraniumTextDocuments<T extends TextDocument = TextDocument> exten
|
|
|
291
416
|
* a pathological echo that never arrives; the memory cost until then is
|
|
292
417
|
* one pre-push text per in-flight push, for milliseconds.
|
|
293
418
|
*/
|
|
294
|
-
protected readonly __pendingPushes = new Map<LanguageClientUri,
|
|
419
|
+
protected readonly __pendingPushes = new Map<LanguageClientUri, PendingLanguageClientPush[]>();
|
|
295
420
|
|
|
296
421
|
/**
|
|
297
422
|
* Tracked text content per URI for the LSP textual language client (Monaco / VS Code).
|
|
@@ -316,6 +441,11 @@ export class HydraniumTextDocuments<T extends TextDocument = TextDocument> exten
|
|
|
316
441
|
|
|
317
442
|
protected readonly tracer: Tracer;
|
|
318
443
|
protected readonly configuration: TextDocumentsConfiguration<T>;
|
|
444
|
+
/** See {@link HydraniumTextDocumentsOptions.revertGraceMs}. */
|
|
445
|
+
protected readonly revertGraceMs: number;
|
|
446
|
+
protected readonly lastOpenClosedEmitter = new Emitter<LastOpenClosedEvent>();
|
|
447
|
+
protected readonly languageClientSavedEmitter = new Emitter<LanguageClientSavedEvent>();
|
|
448
|
+
protected readonly dirtyChangedEmitter = new Emitter<DocumentDirtyChangedEvent>();
|
|
319
449
|
|
|
320
450
|
constructor(
|
|
321
451
|
protected services: ServerSharedServices,
|
|
@@ -329,6 +459,8 @@ export class HydraniumTextDocuments<T extends TextDocument = TextDocument> exten
|
|
|
329
459
|
(uri, reason) => this.tracer.with(uri).warn(`Diff apply-verify fallback (${reason}) — using full-document replace`),
|
|
330
460
|
this
|
|
331
461
|
);
|
|
462
|
+
this.revertGraceMs = options.revertGraceMs ?? DEFAULT_REVERT_GRACE_MS;
|
|
463
|
+
this.onDidCloseLastOpen(event => void this.revertToDisk(event.uri));
|
|
332
464
|
}
|
|
333
465
|
|
|
334
466
|
// Re-exposed configuration factories — for framework-internal callers
|
|
@@ -429,7 +561,7 @@ export class HydraniumTextDocuments<T extends TextDocument = TextDocument> exten
|
|
|
429
561
|
);
|
|
430
562
|
disposables.push(
|
|
431
563
|
connection.onDidSaveTextDocument((event: DidSaveTextDocumentParams) => {
|
|
432
|
-
this.
|
|
564
|
+
void this.notifyLanguageClientSave(event);
|
|
433
565
|
})
|
|
434
566
|
);
|
|
435
567
|
return disposables;
|
|
@@ -466,20 +598,21 @@ export class HydraniumTextDocuments<T extends TextDocument = TextDocument> exten
|
|
|
466
598
|
// the update) from "incoming version older than ours" (stale race).
|
|
467
599
|
const reason =
|
|
468
600
|
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');
|
|
601
|
+
this.logUri(uri, `Ignore update by ${this.formatClientId(clientId)}: ${reason}`, 'debug');
|
|
470
602
|
return;
|
|
471
603
|
}
|
|
472
604
|
record.clientVersions.set(clientId, td.version);
|
|
473
605
|
|
|
474
|
-
// A language-client change
|
|
475
|
-
//
|
|
476
|
-
//
|
|
606
|
+
// A language-client change is keyed to the buffer that client holds,
|
|
607
|
+
// which is the synced text only while the two agree — an authored
|
|
608
|
+
// write advances the synced text without the client knowing, and a
|
|
609
|
+
// push in flight moves the client without the store knowing.
|
|
477
610
|
// Resolve which it is, and against what, before touching anything.
|
|
478
|
-
const
|
|
611
|
+
const origin =
|
|
479
612
|
clientId === LANGUAGE_CLIENT_ID
|
|
480
613
|
? this.classifyLanguageClientChange(this.toLanguageClientUri(td.uri), document, changes)
|
|
481
614
|
: undefined;
|
|
482
|
-
if (
|
|
615
|
+
if (origin?.kind === 'echo') {
|
|
483
616
|
// The client is reporting a text we pushed it, so the synced
|
|
484
617
|
// document is ALREADY there and the changes must not be applied a
|
|
485
618
|
// second time. Nothing is minted and no rebuild fires. The
|
|
@@ -491,19 +624,23 @@ export class HydraniumTextDocuments<T extends TextDocument = TextDocument> exten
|
|
|
491
624
|
this.logUri(uri, `Skip rebuild: echo of a server-authored push (client version ${td.version})`, 'debug');
|
|
492
625
|
return;
|
|
493
626
|
}
|
|
627
|
+
if (origin?.kind === 'unreconstructable') {
|
|
628
|
+
this.tracer.with(uri).warn(`Drop change: no known client buffer for its ranges (client version ${td.version})`);
|
|
629
|
+
return;
|
|
630
|
+
}
|
|
494
631
|
|
|
495
632
|
// The SHARED version advances iff the content actually changes — the
|
|
496
|
-
// invariant optimistic
|
|
633
|
+
// invariant optimistic based-on gates rely on. The new text is
|
|
497
634
|
// only known after applying the (possibly incremental) changes, so
|
|
498
635
|
// apply at a tentative +1 and roll the version back on an identical
|
|
499
636
|
// result (an empty-changes update only re-stamps the version).
|
|
500
637
|
//
|
|
501
|
-
// A divergent
|
|
502
|
-
//
|
|
503
|
-
//
|
|
638
|
+
// A divergent change is applied as its RECONSTRUCTED text rather than
|
|
639
|
+
// as its own ranges: those ranges address the client's own buffer, so
|
|
640
|
+
// applying them here would splice the wrong lines.
|
|
504
641
|
const previousText = document.getText();
|
|
505
642
|
const sharedVersion = document.version;
|
|
506
|
-
document = this.configuration.update(document,
|
|
643
|
+
document = this.configuration.update(document, origin === undefined ? changes : [{ text: origin.text }], sharedVersion + 1);
|
|
507
644
|
const changed = document.getText() !== previousText;
|
|
508
645
|
if (!changed) {
|
|
509
646
|
document = this.configuration.update(document, [], sharedVersion);
|
|
@@ -511,6 +648,7 @@ export class HydraniumTextDocuments<T extends TextDocument = TextDocument> exten
|
|
|
511
648
|
this.__syncedDocuments.set(uri, document);
|
|
512
649
|
if (changed) {
|
|
513
650
|
this.setAuthor(uri, document.version, clientId);
|
|
651
|
+
this.refreshDirty(uri);
|
|
514
652
|
}
|
|
515
653
|
if (clientId === LANGUAGE_CLIENT_ID) {
|
|
516
654
|
// Monaco just told us about its new content; record it so the next outbound
|
|
@@ -527,7 +665,10 @@ export class HydraniumTextDocuments<T extends TextDocument = TextDocument> exten
|
|
|
527
665
|
return;
|
|
528
666
|
}
|
|
529
667
|
}
|
|
530
|
-
this.log(
|
|
668
|
+
this.log(
|
|
669
|
+
document.uri,
|
|
670
|
+
`Update to version ${document.version} by ${this.formatClientId(clientId)}${changed ? '' : ' (content unchanged)'}`
|
|
671
|
+
);
|
|
531
672
|
this.__onDidChangeContent.fire(Object.freeze({ document, clientId }));
|
|
532
673
|
}
|
|
533
674
|
}
|
|
@@ -544,7 +685,7 @@ export class HydraniumTextDocuments<T extends TextDocument = TextDocument> exten
|
|
|
544
685
|
* A content-identical write still fires the change event (rebuild): the
|
|
545
686
|
* authored write's server-side rebuild is correctness-bearing, it just
|
|
546
687
|
* mints no new version — nothing observable changed, so watchers'
|
|
547
|
-
*
|
|
688
|
+
* based-on versions stay valid.
|
|
548
689
|
*
|
|
549
690
|
* Returns the resulting shared version. Throws when the document is not
|
|
550
691
|
* open — callers (`AstDocumentManager.update`) open first.
|
|
@@ -560,57 +701,200 @@ export class HydraniumTextDocuments<T extends TextDocument = TextDocument> exten
|
|
|
560
701
|
document = this.configuration.update(document, [{ text }], document.version + 1);
|
|
561
702
|
this.__syncedDocuments.set(key, document);
|
|
562
703
|
this.setAuthor(key, document.version, clientId);
|
|
704
|
+
this.refreshDirty(key);
|
|
563
705
|
}
|
|
564
|
-
this.log(
|
|
706
|
+
this.log(
|
|
707
|
+
document.uri,
|
|
708
|
+
`Update to version ${document.version} by ${this.formatClientId(clientId)}${changed ? '' : ' (content unchanged)'}`
|
|
709
|
+
);
|
|
565
710
|
this.__onDidChangeContent.fire(Object.freeze({ document, clientId }));
|
|
566
711
|
return document.version;
|
|
567
712
|
}
|
|
568
713
|
|
|
569
|
-
|
|
714
|
+
/**
|
|
715
|
+
* Close `clientId`'s open of the document. When it was the last open, the
|
|
716
|
+
* document is released and reverts to disk, at once or, for a `'lost'`
|
|
717
|
+
* close, after {@link HydraniumTextDocumentsOptions.revertGraceMs}.
|
|
718
|
+
*/
|
|
719
|
+
public notifyDidCloseTextDocument(
|
|
720
|
+
event: DidCloseTextDocumentParams,
|
|
721
|
+
clientId = LANGUAGE_CLIENT_ID,
|
|
722
|
+
cause: SessionEndCause = 'closed'
|
|
723
|
+
): void {
|
|
570
724
|
const uri = this.documentKey(event.textDocument.uri);
|
|
571
|
-
if (!this.
|
|
725
|
+
if (!this.__sessions.removeOpen(uri, clientId)) {
|
|
572
726
|
return;
|
|
573
727
|
}
|
|
574
|
-
const
|
|
575
|
-
|
|
576
|
-
|
|
728
|
+
const record = this.__documents.get(uri);
|
|
729
|
+
record?.clientVersions.delete(clientId);
|
|
730
|
+
if (record && cause === 'lost') {
|
|
731
|
+
(record.lostClients ??= new Map()).set(clientId, this.services.Clock.stopwatch());
|
|
732
|
+
}
|
|
577
733
|
const syncedDocument = this.__syncedDocuments.get(uri);
|
|
578
734
|
if (syncedDocument !== undefined) {
|
|
579
|
-
this.log(syncedDocument.uri, `Closed synced document: ${syncedDocument.version} by ${clientId}`);
|
|
735
|
+
this.log(syncedDocument.uri, `Closed synced document: ${syncedDocument.version} by ${this.formatClientId(clientId)}`);
|
|
580
736
|
this.__onDidClose.fire(Object.freeze({ document: syncedDocument, clientId }));
|
|
581
737
|
|
|
582
738
|
if (clientId === LANGUAGE_CLIENT_ID) {
|
|
583
739
|
// Monaco closed the document; drop the URI it held and the shadow
|
|
584
740
|
// baselined under it. (If this was the last URI/client the whole record
|
|
585
|
-
// is deleted
|
|
741
|
+
// is deleted on release, clearing the set anyway.)
|
|
586
742
|
const droppedUri = this.toLanguageClientUri(event.textDocument.uri);
|
|
587
743
|
this.__documents.get(uri)?.languageClientUris?.delete(droppedUri);
|
|
588
744
|
this.__shadow.invalidate(droppedUri);
|
|
589
745
|
this.__pendingPushes.delete(droppedUri);
|
|
590
746
|
}
|
|
591
|
-
if (!this.
|
|
592
|
-
|
|
593
|
-
|
|
594
|
-
|
|
595
|
-
|
|
596
|
-
|
|
597
|
-
this.log(syncedDocument.uri, `Remove synced document: ${syncedDocument.version} (no client left)`);
|
|
598
|
-
// Persist where the shared version sequence left off (version +
|
|
599
|
-
// content hash) so the next open CONTINUES the sequence instead of
|
|
600
|
-
// restarting at the reopening client's declared id. Hashed once
|
|
601
|
-
// here at close, not on every change.
|
|
602
|
-
this.__versionSequences.set(uri, {
|
|
603
|
-
version: syncedDocument.version,
|
|
604
|
-
contentHash: contentHash(syncedDocument.getText())
|
|
605
|
-
});
|
|
606
|
-
this.__syncedDocuments.delete(uri);
|
|
607
|
-
// One delete clears every per-URI axis (version history + any staged
|
|
608
|
-
// pending content) so a future open with the same URI starts fresh.
|
|
609
|
-
this.__documents.delete(uri);
|
|
747
|
+
if (!this.__sessions.isOpen(uri)) {
|
|
748
|
+
if (cause === 'lost' && this.revertGraceMs > 0) {
|
|
749
|
+
this.deferRelease(uri);
|
|
750
|
+
} else {
|
|
751
|
+
this.releaseDocument(uri);
|
|
752
|
+
}
|
|
610
753
|
}
|
|
611
754
|
}
|
|
612
755
|
}
|
|
613
756
|
|
|
757
|
+
/**
|
|
758
|
+
* Keep the document, text and all, for the revert grace, then release it.
|
|
759
|
+
* The document stays in the store meanwhile, so a lost client that opens it
|
|
760
|
+
* again within its own grace attaches to it and finds its unsaved text
|
|
761
|
+
* rather than reading disk; see {@link resolvePendingRevert} for any other
|
|
762
|
+
* open.
|
|
763
|
+
*/
|
|
764
|
+
protected deferRelease(uri: CanonicalUri): void {
|
|
765
|
+
this.log(uri, `No client left; revert deferred for ${this.revertGraceMs} ms (connection lost)`);
|
|
766
|
+
const timer = this.services.Clock.setTimer(() => {
|
|
767
|
+
this.__sessions.cancelRevert(uri);
|
|
768
|
+
if (!this.__sessions.isOpen(uri)) {
|
|
769
|
+
this.releaseDocument(uri);
|
|
770
|
+
}
|
|
771
|
+
}, this.revertGraceMs);
|
|
772
|
+
this.__sessions.deferRevert(uri, timer);
|
|
773
|
+
}
|
|
774
|
+
|
|
775
|
+
/**
|
|
776
|
+
* Resolve the pending revert of `uri` for an open by `clientId`. An open by a
|
|
777
|
+
* client lost from the document within its grace cancels the revert, and
|
|
778
|
+
* the client finds its unsaved text. Any other open releases the document
|
|
779
|
+
* first, so it opens as a first open does: cancelling for every open hands
|
|
780
|
+
* a lost client's unsaved text to whoever opens next, a reloaded page or an
|
|
781
|
+
* editor, with nothing marking it unsaved.
|
|
782
|
+
*/
|
|
783
|
+
protected resolvePendingRevert(uri: CanonicalUri, clientId: string): void {
|
|
784
|
+
const record = this.__documents.get(uri);
|
|
785
|
+
if (record) {
|
|
786
|
+
this.pruneLostClients(record);
|
|
787
|
+
}
|
|
788
|
+
const returning = record?.lostClients?.delete(clientId) ?? false;
|
|
789
|
+
if (!this.__sessions.isRevertPending(uri)) {
|
|
790
|
+
return;
|
|
791
|
+
}
|
|
792
|
+
this.__sessions.cancelRevert(uri);
|
|
793
|
+
if (!returning) {
|
|
794
|
+
this.releaseDocument(uri);
|
|
795
|
+
}
|
|
796
|
+
}
|
|
797
|
+
|
|
798
|
+
/** Drop the entries of {@link DocumentTrackingRecord.lostClients} whose grace has run out. */
|
|
799
|
+
protected pruneLostClients(record: DocumentTrackingRecord): void {
|
|
800
|
+
for (const [clientId, sinceLoss] of record.lostClients ?? []) {
|
|
801
|
+
if (sinceLoss.elapsedMs >= this.revertGraceMs) {
|
|
802
|
+
record.lostClients?.delete(clientId);
|
|
803
|
+
}
|
|
804
|
+
}
|
|
805
|
+
}
|
|
806
|
+
|
|
807
|
+
/**
|
|
808
|
+
* Drop the document no client has open any more, then announce it on
|
|
809
|
+
* {@link onDidCloseLastOpen}, which is what reverts it to disk.
|
|
810
|
+
*/
|
|
811
|
+
protected releaseDocument(uri: CanonicalUri): void {
|
|
812
|
+
const syncedDocument = this.__syncedDocuments.get(uri);
|
|
813
|
+
if (syncedDocument === undefined) {
|
|
814
|
+
return;
|
|
815
|
+
}
|
|
816
|
+
this.log(syncedDocument.uri, `Remove synced document: ${syncedDocument.version} (no client left)`);
|
|
817
|
+
// Persist where the shared version sequence left off (version +
|
|
818
|
+
// content hash) so the next open CONTINUES the sequence instead of
|
|
819
|
+
// restarting at the reopening client's declared id. Hashed once
|
|
820
|
+
// here at release, not on every change.
|
|
821
|
+
this.__versionSequences.set(uri, {
|
|
822
|
+
version: syncedDocument.version,
|
|
823
|
+
contentHash: contentHash(syncedDocument.getText())
|
|
824
|
+
});
|
|
825
|
+
const wasDirty = this.__documents.get(uri)?.dirty === true;
|
|
826
|
+
this.__syncedDocuments.delete(uri);
|
|
827
|
+
// One delete clears every per-URI axis (version history + any staged
|
|
828
|
+
// pending content) so a future open with the same URI starts fresh.
|
|
829
|
+
this.__documents.delete(uri);
|
|
830
|
+
if (wasDirty) {
|
|
831
|
+
this.dirtyChangedEmitter.fire(Object.freeze({ uri, dirty: false }));
|
|
832
|
+
}
|
|
833
|
+
this.lastOpenClosedEmitter.fire(Object.freeze({ uri }));
|
|
834
|
+
}
|
|
835
|
+
|
|
836
|
+
/**
|
|
837
|
+
* Rebuild a released document from the file system provider, so the build
|
|
838
|
+
* stops carrying the unsaved text of its last client.
|
|
839
|
+
*
|
|
840
|
+
* The provider decides, for every scheme, by `exists`: a document it can
|
|
841
|
+
* serve is rebuilt from its text, and any other — an editor's `untitled:`
|
|
842
|
+
* buffer, a file never saved, or one deleted meanwhile — is removed
|
|
843
|
+
* from the workspace. A `virtual:` document survives, since the framework's
|
|
844
|
+
* providers serve it from the index; an edited one therefore keeps its last
|
|
845
|
+
* client's text, and keeping it read-only is the client's job.
|
|
846
|
+
*
|
|
847
|
+
* The answer is read in the document's disk queue, so the rebuild follows
|
|
848
|
+
* any save still queued rather than reverting past it; a file that goes
|
|
849
|
+
* after that read is removed when its rebuild finds none.
|
|
850
|
+
*
|
|
851
|
+
* Whether to revert at all is decided inside the write lock, as its holder:
|
|
852
|
+
* decided before waiting for the lock, a client that opens or re-creates the
|
|
853
|
+
* document meanwhile would have its text rebuilt over, or the document
|
|
854
|
+
* removed. A document some client has open again, or that waits out a new
|
|
855
|
+
* grace, is left to that client.
|
|
856
|
+
*/
|
|
857
|
+
protected async revertToDisk(uri: CanonicalUri): Promise<void> {
|
|
858
|
+
const workspace = this.services.workspace;
|
|
859
|
+
const target = UriUtils.toUri(uri);
|
|
860
|
+
const reopened = (): boolean => this.isOpenInAnyClient(uri) || this.__syncedDocuments.has(uri);
|
|
861
|
+
try {
|
|
862
|
+
// Read before the lock: every build and read waits while the lock is
|
|
863
|
+
// held, and this read waits on the file's save I/O.
|
|
864
|
+
const onDisk = await workspace.FileSystemTaskQueue.enqueue(uri, () => workspace.FileSystemProvider.exists(target));
|
|
865
|
+
await workspace.WorkspaceManager?.ready;
|
|
866
|
+
await workspace.WorkspaceLock.write(async token => {
|
|
867
|
+
if (reopened()) {
|
|
868
|
+
return;
|
|
869
|
+
}
|
|
870
|
+
workspace.DocumentBuilder.markNextReason(HYDRANIUM_BUILD_REASONS.didClose);
|
|
871
|
+
try {
|
|
872
|
+
await (onDisk
|
|
873
|
+
? workspace.DocumentBuilder.update([target], [], token)
|
|
874
|
+
: workspace.DocumentBuilder.update([], [target], token));
|
|
875
|
+
} catch (err: unknown) {
|
|
876
|
+
if (!onDisk || !isFileNotFound(err, target)) {
|
|
877
|
+
throw err;
|
|
878
|
+
}
|
|
879
|
+
// The file went after its existence was read.
|
|
880
|
+
this.tracer.with(uri).debug('Revert found no file; removing the document instead');
|
|
881
|
+
workspace.DocumentBuilder.markNextReason(HYDRANIUM_BUILD_REASONS.didClose);
|
|
882
|
+
await workspace.DocumentBuilder.update([], [target], token);
|
|
883
|
+
}
|
|
884
|
+
});
|
|
885
|
+
} catch (err: unknown) {
|
|
886
|
+
// A revert that finishes after the LSP peer went away fails its
|
|
887
|
+
// diagnostics publish, and one that runs after its workspace was torn
|
|
888
|
+
// down finds no file: teardown races, not failed reverts.
|
|
889
|
+
if (isConnectionGoneError(err) || isFileNotFound(err, target)) {
|
|
890
|
+
this.tracer.with(uri).debug(`Revert on last close skipped: ${err instanceof Error ? err.message : String(err)}`);
|
|
891
|
+
return;
|
|
892
|
+
}
|
|
893
|
+
const detail = err instanceof Error ? (err.stack ?? err.message) : String(err);
|
|
894
|
+
this.tracer.with(uri).error(`Revert on last close dropped. ${detail}`);
|
|
895
|
+
}
|
|
896
|
+
}
|
|
897
|
+
|
|
614
898
|
public notifyWillSaveTextDocument(event: WillSaveTextDocumentParams): void {
|
|
615
899
|
const syncedDocument = this.__syncedDocuments.get(this.documentKey(event.textDocument.uri));
|
|
616
900
|
if (syncedDocument !== undefined) {
|
|
@@ -630,40 +914,103 @@ export class HydraniumTextDocuments<T extends TextDocument = TextDocument> exten
|
|
|
630
914
|
}
|
|
631
915
|
}
|
|
632
916
|
|
|
917
|
+
/**
|
|
918
|
+
* Handle a save the language client reports: fire
|
|
919
|
+
* {@link onDidSaveInLanguageClient}, then announce it on {@link onDidSave}
|
|
920
|
+
* only once the file read back from disk holds the store's current text.
|
|
921
|
+
*/
|
|
922
|
+
protected async notifyLanguageClientSave(event: DidSaveTextDocumentParams): Promise<void> {
|
|
923
|
+
const syncedDocument = this.__syncedDocuments.get(this.documentKey(event.textDocument.uri));
|
|
924
|
+
if (syncedDocument === undefined) {
|
|
925
|
+
return;
|
|
926
|
+
}
|
|
927
|
+
const uri = syncedDocument.uri;
|
|
928
|
+
this.languageClientSavedEmitter.fire(Object.freeze({ uri }));
|
|
929
|
+
// `onDidSave` tells its listeners that the shared document is on disk.
|
|
930
|
+
// The editor wrote its own buffer, which lags the store while another
|
|
931
|
+
// client's edit is still on its way to it, so only the file says
|
|
932
|
+
// whether that holds. Read it rather than trust the editor: `didSave`
|
|
933
|
+
// carries text only for a client that honours `includeText`, and asking
|
|
934
|
+
// for it means rewriting Langium's initialize answer, which advertises
|
|
935
|
+
// `save` as a Boolean. The read goes through the disk queue and waits on
|
|
936
|
+
// nothing but the provider, so it follows a server save queued
|
|
937
|
+
// meanwhile. A file changed again between the editor's write and this
|
|
938
|
+
// read compares unequal, and the save goes unannounced.
|
|
939
|
+
let onDisk: string | undefined;
|
|
940
|
+
try {
|
|
941
|
+
onDisk = await this.services.workspace.FileSystemTaskQueue.enqueue(uri, () =>
|
|
942
|
+
this.services.workspace.FileSystemProvider.readFile(UriUtils.toUri(uri))
|
|
943
|
+
);
|
|
944
|
+
} catch (err: unknown) {
|
|
945
|
+
this.tracer
|
|
946
|
+
.with(uri)
|
|
947
|
+
.debug(`Editor save not announced: reading the file back failed. ${err instanceof Error ? err.message : String(err)}`);
|
|
948
|
+
return;
|
|
949
|
+
}
|
|
950
|
+
// What the file holds, not what the editor meant to write: an editor
|
|
951
|
+
// that saved older text leaves the document dirty.
|
|
952
|
+
this.updateDiskBaseline(uri, onDisk);
|
|
953
|
+
// An editor that saves and then closes releases the document while the
|
|
954
|
+
// read is under way; its save is still a save of the text it held.
|
|
955
|
+
const document = this.__syncedDocuments.get(this.documentKey(uri)) ?? syncedDocument;
|
|
956
|
+
if (onDisk !== document.getText()) {
|
|
957
|
+
this.tracer.with(uri).debug(`Editor save not announced: the file does not hold the text of version ${document.version}`);
|
|
958
|
+
return;
|
|
959
|
+
}
|
|
960
|
+
this.announceSave(document, LANGUAGE_CLIENT_ID);
|
|
961
|
+
}
|
|
962
|
+
|
|
963
|
+
/**
|
|
964
|
+
* Announce a save the server made. `event.text`, when given, is what the
|
|
965
|
+
* file now holds, written or found there, and becomes the disk baseline
|
|
966
|
+
* before the save is announced. It lags the store when an edit landed
|
|
967
|
+
* after the save took its text, and the document then stays dirty.
|
|
968
|
+
*/
|
|
633
969
|
public notifyDidSaveTextDocument(event: DidSaveTextDocumentParams, clientId = LANGUAGE_CLIENT_ID): void {
|
|
634
970
|
const syncedDocument = this.__syncedDocuments.get(this.documentKey(event.textDocument.uri));
|
|
635
971
|
if (syncedDocument !== undefined) {
|
|
636
|
-
|
|
637
|
-
|
|
972
|
+
if (event.text !== undefined) {
|
|
973
|
+
this.updateDiskBaseline(syncedDocument.uri, event.text);
|
|
974
|
+
}
|
|
975
|
+
this.announceSave(syncedDocument, clientId);
|
|
638
976
|
}
|
|
639
977
|
}
|
|
640
978
|
|
|
979
|
+
/** Fire {@link onDidSave} for `document`, which need not be synced any more. */
|
|
980
|
+
protected announceSave(document: T, clientId: string): void {
|
|
981
|
+
this.log(document.uri, `Saved synced document: ${document.version} by ${this.formatClientId(clientId)}`);
|
|
982
|
+
this.__onDidSave.fire(Object.freeze({ document, clientId }));
|
|
983
|
+
}
|
|
984
|
+
|
|
641
985
|
public notifyDidOpenTextDocument(event: DidOpenTextDocumentParams, clientId = LANGUAGE_CLIENT_ID): void {
|
|
642
986
|
const td = event.textDocument;
|
|
643
987
|
const uri = this.documentKey(td.uri);
|
|
988
|
+
this.resolvePendingRevert(uri, clientId);
|
|
644
989
|
if (this.isOpenInClient(uri, clientId)) {
|
|
645
990
|
// Already open for this client under this canonical identity. If this is a
|
|
646
991
|
// 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
|
-
//
|
|
992
|
+
// divergent path, e.g. a symlink and its real path), record it so outbound
|
|
993
|
+
// edits reach this tab too — but do NOT re-fire open/rebuild; the document
|
|
994
|
+
// is already live.
|
|
650
995
|
if (clientId === LANGUAGE_CLIENT_ID) {
|
|
651
996
|
const clientFacing = this.toLanguageClientUri(td.uri);
|
|
652
997
|
const record = this.__documents.get(uri);
|
|
653
998
|
if (record && !record.languageClientUris?.has(clientFacing)) {
|
|
654
999
|
(record.languageClientUris ??= new Set<LanguageClientUri>()).add(clientFacing);
|
|
655
|
-
|
|
656
|
-
|
|
657
|
-
|
|
658
|
-
|
|
1000
|
+
// This tab's own buffer, NOT the synced text: a second tab is a second
|
|
1001
|
+
// client model, read from disk, so a server-authored write already
|
|
1002
|
+
// applied to the first tab leaves it BEHIND the synced document. Keying
|
|
1003
|
+
// a diff to the synced text here addresses lines this tab does not have
|
|
1004
|
+
// and drops content it does.
|
|
1005
|
+
this.__shadow.setOpenedText(clientFacing, td.text);
|
|
659
1006
|
}
|
|
660
1007
|
}
|
|
661
1008
|
return;
|
|
662
1009
|
}
|
|
663
1010
|
let document = this.__syncedDocuments.get(uri);
|
|
1011
|
+
const existingClients = this.__sessions.clientsOf(uri);
|
|
1012
|
+
this.__sessions.addOpen(uri, clientId);
|
|
664
1013
|
const record = this.trackingFor(uri);
|
|
665
|
-
const existingClients = [...record.clients];
|
|
666
|
-
record.clients.add(clientId);
|
|
667
1014
|
// Baseline the per-client staleness guard at the version id the client
|
|
668
1015
|
// declared for its own buffer (client-owned per LSP).
|
|
669
1016
|
record.clientVersions.set(clientId, td.version);
|
|
@@ -679,44 +1026,110 @@ export class HydraniumTextDocuments<T extends TextDocument = TextDocument> exten
|
|
|
679
1026
|
const source = pendingText ? ', source=pending' : '';
|
|
680
1027
|
// The SHARED version is server-assigned: continue the persisted
|
|
681
1028
|
// sequence — same version when the content is unchanged since the
|
|
682
|
-
// last close (so watchers'
|
|
1029
|
+
// last close (so watchers' based-on versions stay valid), one
|
|
683
1030
|
// step when it changed (so no stale pointer can coincidentally pass
|
|
684
1031
|
// the optimistic gate). Only a first-ever open adopts the client's
|
|
685
1032
|
// declared id as the sequence seed.
|
|
686
1033
|
const sequence = this.__versionSequences.get(uri);
|
|
687
1034
|
const version =
|
|
688
1035
|
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}]`);
|
|
1036
|
+
this.log(uri, `Open document: Version ${version} by ${this.formatClientId(clientId)} [first client${source}]`);
|
|
690
1037
|
document = this.configuration.create(uri, td.languageId, version, text);
|
|
691
1038
|
this.__syncedDocuments.set(uri, document);
|
|
692
1039
|
this.setAuthor(uri, version, clientId);
|
|
1040
|
+
// The opener's text, not the staged content: a session's open read
|
|
1041
|
+
// it from the file, and an editor opened its buffer from there. An
|
|
1042
|
+
// editor that opens a buffer it never saved is taken as clean.
|
|
1043
|
+
record.diskBaseline = td.text;
|
|
1044
|
+
this.refreshDirty(uri);
|
|
693
1045
|
if (clientId === LANGUAGE_CLIENT_ID) {
|
|
694
1046
|
// Baseline the shadow to what Monaco just opened so the next outbound
|
|
695
1047
|
// applyEditToLanguageClient diffs against the right starting point. Keyed by the
|
|
696
1048
|
// language-client URI (what Monaco holds), not the canonical document key.
|
|
697
|
-
|
|
1049
|
+
//
|
|
1050
|
+
// The CLIENT's declared text, never the synced document: staged content
|
|
1051
|
+
// consumed above leaves the two different, and a baseline asserting the
|
|
1052
|
+
// client already holds the staged text suppresses the one sync that would
|
|
1053
|
+
// deliver it. Skipped entirely when a push is already outstanding for this
|
|
1054
|
+
// URI — an `applyEdit` to a closed file has the client open from disk and
|
|
1055
|
+
// apply afterwards, so that shadow records what it is about to hold and
|
|
1056
|
+
// disk text would key the next diff to a buffer nobody has.
|
|
1057
|
+
const clientFacing = this.toLanguageClientUri(td.uri);
|
|
1058
|
+
if (!this.__shadow.isTracked(clientFacing)) {
|
|
1059
|
+
this.__shadow.set(clientFacing, td.text);
|
|
1060
|
+
}
|
|
698
1061
|
}
|
|
699
1062
|
const toFire = Object.freeze({ document, clientId });
|
|
700
1063
|
this.__onDidOpen.fire(toFire);
|
|
701
1064
|
this.__onDidChangeContent.fire(toFire);
|
|
702
1065
|
} else {
|
|
703
1066
|
// An additional client attaches to a document already open by another client.
|
|
704
|
-
this.
|
|
705
|
-
|
|
706
|
-
|
|
707
|
-
|
|
708
|
-
|
|
1067
|
+
this.logClientJoined(uri, clientId, document.version, existingClients);
|
|
1068
|
+
if (clientId === LANGUAGE_CLIENT_ID) {
|
|
1069
|
+
// Monaco's own buffer, which on this path is NOT the synced text — another
|
|
1070
|
+
// client opened the document and may already have changed it. Recorded as
|
|
1071
|
+
// an equality-only baseline (never a diff one, see `setOpenedText`) so the
|
|
1072
|
+
// refresh below does not push a full replace of content Monaco already
|
|
1073
|
+
// holds, which would dirty the file on open.
|
|
1074
|
+
this.__shadow.setOpenedText(this.toLanguageClientUri(td.uri), td.text);
|
|
1075
|
+
}
|
|
709
1076
|
this.refreshContent(uri, clientId);
|
|
710
1077
|
}
|
|
711
1078
|
}
|
|
712
1079
|
|
|
1080
|
+
/**
|
|
1081
|
+
* Record `clientId` as an additional holder of a document another client
|
|
1082
|
+
* already has open.
|
|
1083
|
+
*
|
|
1084
|
+
* Unlike the attach branch of {@link notifyDidOpenTextDocument} this does
|
|
1085
|
+
* not refresh. That branch re-renders an attaching TEXTUAL view; a client
|
|
1086
|
+
* reaching a document through a non-textual route has nothing to re-render,
|
|
1087
|
+
* and refreshing per attach turns each into a Langium rebuild and dependent
|
|
1088
|
+
* relink cascade.
|
|
1089
|
+
*
|
|
1090
|
+
* The staleness guard baselines at the SYNCED version, not a declared buffer
|
|
1091
|
+
* version, because a client arriving this way holds no buffer of its own.
|
|
1092
|
+
* Unifying the two routes therefore rebaselines a textual client's guard to a
|
|
1093
|
+
* version it never declared.
|
|
1094
|
+
*
|
|
1095
|
+
* Returns whether a hold was added — `false` when `uri` is not open,
|
|
1096
|
+
* `clientId` already holds it, or the document was waiting out the revert
|
|
1097
|
+
* grace for other clients and was released instead (see
|
|
1098
|
+
* {@link resolvePendingRevert}); the caller then opens it anew.
|
|
1099
|
+
*/
|
|
1100
|
+
attachClient(uri: DocumentUri, clientId: string): boolean {
|
|
1101
|
+
const key = this.documentKey(uri);
|
|
1102
|
+
if (!this.__syncedDocuments.has(key) || this.isOpenInClient(key, clientId)) {
|
|
1103
|
+
return false;
|
|
1104
|
+
}
|
|
1105
|
+
this.resolvePendingRevert(key, clientId);
|
|
1106
|
+
const document = this.__syncedDocuments.get(key);
|
|
1107
|
+
if (!document) {
|
|
1108
|
+
return false;
|
|
1109
|
+
}
|
|
1110
|
+
const existingClients = this.__sessions.clientsOf(key);
|
|
1111
|
+
this.__sessions.addOpen(key, clientId);
|
|
1112
|
+
const record = this.trackingFor(key);
|
|
1113
|
+
record.clientVersions.set(clientId, document.version);
|
|
1114
|
+
this.logClientJoined(key, clientId, document.version, existingClients);
|
|
1115
|
+
return true;
|
|
1116
|
+
}
|
|
1117
|
+
|
|
1118
|
+
protected logClientJoined(uri: DocumentUri, clientId: string, version: number, existingClients: readonly string[]): void {
|
|
1119
|
+
this.log(
|
|
1120
|
+
uri,
|
|
1121
|
+
`Attach client: ${this.formatClientId(clientId)} joined existing document (version ${version}, ` +
|
|
1122
|
+
`now open in: ${[...existingClients, clientId].map(id => this.formatClientId(id)).join(', ')})`
|
|
1123
|
+
);
|
|
1124
|
+
}
|
|
1125
|
+
|
|
713
1126
|
refreshContent(uri: DocumentUri, clientId: string): void {
|
|
714
1127
|
const syncedDocument = this.__syncedDocuments.get(this.documentKey(uri));
|
|
715
1128
|
if (syncedDocument) {
|
|
716
1129
|
// Trigger a (re-)build by firing a change event.
|
|
717
1130
|
const timer = this.startTimerForUri(
|
|
718
1131
|
syncedDocument.uri,
|
|
719
|
-
`Refresh synced document: Version ${syncedDocument.version} by ${clientId}`
|
|
1132
|
+
`Refresh synced document: Version ${syncedDocument.version} by ${this.formatClientId(clientId)}`
|
|
720
1133
|
);
|
|
721
1134
|
this.__onDidChangeContent.fire(Object.freeze({ document: syncedDocument, clientId }));
|
|
722
1135
|
timer.dispose();
|
|
@@ -730,7 +1143,7 @@ export class HydraniumTextDocuments<T extends TextDocument = TextDocument> exten
|
|
|
730
1143
|
* two URIs for one physical file (a symlink path and its real path) into a
|
|
731
1144
|
* single registration — dedup at the editor layer, not just in
|
|
732
1145
|
* `LangiumDocuments`. The URI the client opened under is preserved separately
|
|
733
|
-
* for egress addressing (see {@link
|
|
1146
|
+
* for egress addressing (see {@link DocumentTrackingRecord.languageClientUris}). The
|
|
734
1147
|
* policy is always bound (the framework defaults it to
|
|
735
1148
|
* `DefaultDocumentUriPolicy`, where canonical ≡ syntactic normalize).
|
|
736
1149
|
*/
|
|
@@ -751,10 +1164,10 @@ export class HydraniumTextDocuments<T extends TextDocument = TextDocument> exten
|
|
|
751
1164
|
}
|
|
752
1165
|
|
|
753
1166
|
/** Get-or-create the per-URI tracking record. `uri` must already be a {@link documentKey}. */
|
|
754
|
-
protected trackingFor(uri: CanonicalUri):
|
|
1167
|
+
protected trackingFor(uri: CanonicalUri): DocumentTrackingRecord {
|
|
755
1168
|
let record = this.__documents.get(uri);
|
|
756
1169
|
if (!record) {
|
|
757
|
-
record = {
|
|
1170
|
+
record = { versionAuthors: [], clientVersions: new Map() };
|
|
758
1171
|
this.__documents.set(uri, record);
|
|
759
1172
|
}
|
|
760
1173
|
return record;
|
|
@@ -790,7 +1203,7 @@ export class HydraniumTextDocuments<T extends TextDocument = TextDocument> exten
|
|
|
790
1203
|
* `0` for a URI this store has never seen. The shared sequence is
|
|
791
1204
|
* server-owned and monotonic across close/reopen cycles, and advances
|
|
792
1205
|
* exactly when the synced content changes — which is what makes it a sound
|
|
793
|
-
* optimistic-concurrency token (
|
|
1206
|
+
* optimistic-concurrency token (based-on gates): version unchanged ⇔
|
|
794
1207
|
* content unchanged.
|
|
795
1208
|
*/
|
|
796
1209
|
version(uri: DocumentUri): number {
|
|
@@ -832,6 +1245,59 @@ export class HydraniumTextDocuments<T extends TextDocument = TextDocument> exten
|
|
|
832
1245
|
return stepped.version;
|
|
833
1246
|
}
|
|
834
1247
|
|
|
1248
|
+
/**
|
|
1249
|
+
* Commit an integrity repair into the OPEN document for `uri`, returning the
|
|
1250
|
+
* document that now holds it, or `undefined` when there was nothing here to
|
|
1251
|
+
* commit into.
|
|
1252
|
+
*
|
|
1253
|
+
* The one thing this exists to do is address the store BY URI. A repair
|
|
1254
|
+
* reaches the resync as a text-document object, and that object is the
|
|
1255
|
+
* store's own only on the LSP path; a document built for an already-open URI
|
|
1256
|
+
* through `LangiumDocumentFactory.fromString` carries its own, so writing the
|
|
1257
|
+
* repair into it corrects a copy the store does not know about and the editor
|
|
1258
|
+
* never sees.
|
|
1259
|
+
*
|
|
1260
|
+
* `parsedFrom` is the text the repaired AST was parsed from, and a mismatch
|
|
1261
|
+
* against the current content REFUSES the commit: the store has moved on,
|
|
1262
|
+
* which means an editor change landed after that parse, and committing would
|
|
1263
|
+
* overwrite a newer edit with a repair computed against text the user has
|
|
1264
|
+
* already replaced. The build that change provokes recomputes the repair.
|
|
1265
|
+
*
|
|
1266
|
+
* Deliberately NOT compared by version. A separately created document seeds
|
|
1267
|
+
* its own numbering, so requiring the two to agree would refuse every commit
|
|
1268
|
+
* on the path this exists for. Content is the thing both sides can be held to.
|
|
1269
|
+
*
|
|
1270
|
+
* A changed text is a new version authored by {@link INTEGRITY_CLIENT_ID}.
|
|
1271
|
+
* Kept at the old version, the repair is invisible to every reader keyed on
|
|
1272
|
+
* versions: a write based on the unrepaired version passes the based-on gate
|
|
1273
|
+
* and replaces the repair, and an echo filter credits the repair to the
|
|
1274
|
+
* client whose edit it corrected. No change event is fired: the repair
|
|
1275
|
+
* rides the build already under way, and an event would re-enter it.
|
|
1276
|
+
*/
|
|
1277
|
+
commitRepair(uri: DocumentUri, parsedFrom: string, repaired: string): RepairCommit<T> {
|
|
1278
|
+
const key = this.documentKey(uri);
|
|
1279
|
+
const document = this.__syncedDocuments.get(key);
|
|
1280
|
+
if (document === undefined) {
|
|
1281
|
+
return { status: 'not-open' };
|
|
1282
|
+
}
|
|
1283
|
+
if (document.getText() !== parsedFrom) {
|
|
1284
|
+
this.logUri(key, 'Refuse repair commit: the open document moved on from the text the AST was parsed from', 'debug');
|
|
1285
|
+
return { status: 'stale' };
|
|
1286
|
+
}
|
|
1287
|
+
if (repaired === parsedFrom) {
|
|
1288
|
+
return { status: 'committed', document };
|
|
1289
|
+
}
|
|
1290
|
+
// Reassigned rather than mutated in place: the default configuration
|
|
1291
|
+
// updates and returns the SAME instance, but an adopter-supplied one may
|
|
1292
|
+
// return a new object, and the store must end up holding whichever it is.
|
|
1293
|
+
const updated = this.configuration.update(document, [{ text: repaired }], document.version + 1);
|
|
1294
|
+
this.__syncedDocuments.set(key, updated);
|
|
1295
|
+
this.setAuthor(key, updated.version, INTEGRITY_CLIENT_ID);
|
|
1296
|
+
this.refreshDirty(key);
|
|
1297
|
+
this.log(updated.uri, `Update to version ${updated.version} by ${this.formatClientId(INTEGRITY_CLIENT_ID)} (repair)`);
|
|
1298
|
+
return { status: 'committed', document: updated };
|
|
1299
|
+
}
|
|
1300
|
+
|
|
835
1301
|
getAuthor(uri: DocumentUri, version?: number): string | undefined {
|
|
836
1302
|
const history = this.__documents.get(this.documentKey(uri))?.versionAuthors;
|
|
837
1303
|
// Either the requested version, or the latest. `version !== undefined` so we treat 0 correctly.
|
|
@@ -852,17 +1318,17 @@ export class HydraniumTextDocuments<T extends TextDocument = TextDocument> exten
|
|
|
852
1318
|
* True iff any client still holds `uri` open. Distinct from {@link isOpen},
|
|
853
1319
|
* which reads `__syncedDocuments` — that map is cleared only AFTER the
|
|
854
1320
|
* `onDidClose` event fires for the last client, so `isOpen` returns `true`
|
|
855
|
-
* during the close event itself. `isOpenInAnyClient` reads the
|
|
856
|
-
*
|
|
1321
|
+
* during the close event itself. `isOpenInAnyClient` reads the open table
|
|
1322
|
+
* ({@link __sessions}), which is updated BEFORE the fire, so an `onDidClose`
|
|
857
1323
|
* subscriber that finds this `false` knows the last client just closed and a
|
|
858
1324
|
* disk re-read / rebuild can proceed.
|
|
859
1325
|
*/
|
|
860
1326
|
isOpenInAnyClient(uri: DocumentUri): boolean {
|
|
861
|
-
return
|
|
1327
|
+
return this.__sessions.isOpen(this.documentKey(uri));
|
|
862
1328
|
}
|
|
863
1329
|
|
|
864
1330
|
isOpenInClient(uri: DocumentUri, client: string): boolean {
|
|
865
|
-
return
|
|
1331
|
+
return this.__sessions.isOpenIn(this.documentKey(uri), client);
|
|
866
1332
|
}
|
|
867
1333
|
|
|
868
1334
|
isOpenInLanguageClient(uri: DocumentUri): boolean {
|
|
@@ -873,14 +1339,14 @@ export class HydraniumTextDocuments<T extends TextDocument = TextDocument> exten
|
|
|
873
1339
|
}
|
|
874
1340
|
|
|
875
1341
|
isOnlyOpenInClient(uri: DocumentUri, client: string): boolean {
|
|
876
|
-
const
|
|
877
|
-
return
|
|
1342
|
+
const clients = this.__sessions.clientsOf(this.documentKey(uri));
|
|
1343
|
+
return clients.length === 1 && clients[0] === client;
|
|
878
1344
|
}
|
|
879
1345
|
|
|
880
1346
|
/**
|
|
881
1347
|
* Every document currently held open by at least one client, with the client
|
|
882
|
-
* ids holding it. Reads the same
|
|
883
|
-
*
|
|
1348
|
+
* ids holding it. Reads the same open table as {@link isOpenInAnyClient}, so
|
|
1349
|
+
* it reflects a last-client close immediately.
|
|
884
1350
|
*
|
|
885
1351
|
* Diagnostics-oriented — the server-state snapshot lists these so an operator
|
|
886
1352
|
* can see WHY a document is pinned: a document that lingers here after its
|
|
@@ -888,28 +1354,237 @@ export class HydraniumTextDocuments<T extends TextDocument = TextDocument> exten
|
|
|
888
1354
|
* under a shedding policy, explains why its CST is never shed).
|
|
889
1355
|
*/
|
|
890
1356
|
openDocuments(): OpenDocument[] {
|
|
891
|
-
|
|
892
|
-
|
|
893
|
-
|
|
894
|
-
|
|
1357
|
+
return this.__sessions.openDocuments();
|
|
1358
|
+
}
|
|
1359
|
+
|
|
1360
|
+
/** Fires once a client session has ended, after every document it had open was closed. */
|
|
1361
|
+
get onDidCloseSession(): Event<ClientSessionClosedEvent> {
|
|
1362
|
+
return this.__sessions.onDidCloseSession;
|
|
1363
|
+
}
|
|
1364
|
+
|
|
1365
|
+
/**
|
|
1366
|
+
* Fires once a document no client has open is released: at its last close,
|
|
1367
|
+
* or, for a lost client's last close, when its revert grace runs out,
|
|
1368
|
+
* another client opens it, or it is deleted. The document then reverts to
|
|
1369
|
+
* disk.
|
|
1370
|
+
*/
|
|
1371
|
+
get onDidCloseLastOpen(): Event<LastOpenClosedEvent> {
|
|
1372
|
+
return this.lastOpenClosedEmitter.event;
|
|
1373
|
+
}
|
|
1374
|
+
|
|
1375
|
+
/**
|
|
1376
|
+
* Fires for every save the language client reports of a document it has
|
|
1377
|
+
* open: the editor has written the file. {@link onDidSave} follows only
|
|
1378
|
+
* when the file holds the store's text.
|
|
1379
|
+
*/
|
|
1380
|
+
get onDidSaveInLanguageClient(): Event<LanguageClientSavedEvent> {
|
|
1381
|
+
return this.languageClientSavedEmitter.event;
|
|
1382
|
+
}
|
|
1383
|
+
|
|
1384
|
+
/**
|
|
1385
|
+
* Whether `uri` is waiting out the revert grace: its last open closed with a
|
|
1386
|
+
* lost connection, and it still holds its unsaved text. Such a document is
|
|
1387
|
+
* open for no client, yet not closed either, so a caller that would persist
|
|
1388
|
+
* a closed document's text to disk treats it as open.
|
|
1389
|
+
*/
|
|
1390
|
+
isRevertPending(uri: DocumentUri): boolean {
|
|
1391
|
+
return this.__sessions.isRevertPending(this.documentKey(uri));
|
|
1392
|
+
}
|
|
1393
|
+
|
|
1394
|
+
/**
|
|
1395
|
+
* Whether the store holds `uri` with text that differs from its disk
|
|
1396
|
+
* baseline: what the server last knew the file to hold. `false` for a URI
|
|
1397
|
+
* the store does not hold; a document waiting out the revert grace is still
|
|
1398
|
+
* held.
|
|
1399
|
+
*
|
|
1400
|
+
* The baseline is the text a first open brought, or what the server wrote,
|
|
1401
|
+
* or read back after an editor's save or a watched-file change, so it can
|
|
1402
|
+
* trail a change to the file that none of these has seen yet. A check that
|
|
1403
|
+
* must know the file reads it instead.
|
|
1404
|
+
*/
|
|
1405
|
+
isDirty(uri: DocumentUri): boolean {
|
|
1406
|
+
return this.__documents.get(this.documentKey(uri))?.dirty ?? false;
|
|
1407
|
+
}
|
|
1408
|
+
|
|
1409
|
+
/** Fires each time the answer of {@link isDirty} changes, the release of a dirty document included. */
|
|
1410
|
+
get onDidChangeDirty(): Event<DocumentDirtyChangedEvent> {
|
|
1411
|
+
return this.dirtyChangedEmitter.event;
|
|
1412
|
+
}
|
|
1413
|
+
|
|
1414
|
+
/**
|
|
1415
|
+
* Record that the file behind `uri` holds `text`, or no file at all for
|
|
1416
|
+
* `undefined`. A no-op for a URI the store does not hold: the next first
|
|
1417
|
+
* open sets the baseline from its own text.
|
|
1418
|
+
*/
|
|
1419
|
+
updateDiskBaseline(uri: DocumentUri, text: string | undefined): void {
|
|
1420
|
+
const key = this.documentKey(uri);
|
|
1421
|
+
const record = this.__documents.get(key);
|
|
1422
|
+
if (!record || !this.__syncedDocuments.has(key)) {
|
|
1423
|
+
return;
|
|
1424
|
+
}
|
|
1425
|
+
record.diskBaseline = text;
|
|
1426
|
+
this.refreshDirty(key);
|
|
1427
|
+
}
|
|
1428
|
+
|
|
1429
|
+
/**
|
|
1430
|
+
* Read the file behind `uri` through its disk queue and take it as the
|
|
1431
|
+
* baseline. A file that cannot be read counts as none, the side that
|
|
1432
|
+
* leaves the document dirty.
|
|
1433
|
+
*/
|
|
1434
|
+
async reloadDiskBaseline(uri: DocumentUri): Promise<void> {
|
|
1435
|
+
const key = this.documentKey(uri);
|
|
1436
|
+
if (!this.__syncedDocuments.has(key)) {
|
|
1437
|
+
return;
|
|
1438
|
+
}
|
|
1439
|
+
let onDisk: string | undefined;
|
|
1440
|
+
try {
|
|
1441
|
+
onDisk = await this.services.workspace.FileSystemTaskQueue.enqueue(key, () =>
|
|
1442
|
+
this.services.workspace.FileSystemProvider.readFile(UriUtils.toUri(key))
|
|
1443
|
+
);
|
|
1444
|
+
} catch (err: unknown) {
|
|
1445
|
+
this.tracer.with(key).debug(`Disk baseline: the file cannot be read. ${err instanceof Error ? err.message : String(err)}`);
|
|
1446
|
+
}
|
|
1447
|
+
this.updateDiskBaseline(key, onDisk);
|
|
1448
|
+
}
|
|
1449
|
+
|
|
1450
|
+
/** Compare the held text of `uri` with its baseline, and announce a changed answer. */
|
|
1451
|
+
protected refreshDirty(uri: CanonicalUri): void {
|
|
1452
|
+
const record = this.__documents.get(uri);
|
|
1453
|
+
const document = this.__syncedDocuments.get(uri);
|
|
1454
|
+
if (!record || !document) {
|
|
1455
|
+
return;
|
|
1456
|
+
}
|
|
1457
|
+
const dirty = document.getText() !== record.diskBaseline;
|
|
1458
|
+
if (dirty !== (record.dirty ?? false)) {
|
|
1459
|
+
record.dirty = dirty;
|
|
1460
|
+
this.dirtyChangedEmitter.fire(Object.freeze({ uri, dirty }));
|
|
1461
|
+
}
|
|
1462
|
+
}
|
|
1463
|
+
|
|
1464
|
+
/**
|
|
1465
|
+
* Start a client session under `clientId`. Throws where
|
|
1466
|
+
* {@link ClientSessionRegistry.register} refuses the id.
|
|
1467
|
+
*/
|
|
1468
|
+
registerSession(clientId: string): void {
|
|
1469
|
+
this.__sessions.register(clientId);
|
|
1470
|
+
this.tracer.info(`Session started: ${this.formatClientId(clientId)}`);
|
|
1471
|
+
this.tracer.trace(`Session started: ${clientId}`);
|
|
1472
|
+
}
|
|
1473
|
+
|
|
1474
|
+
/**
|
|
1475
|
+
* End the client session `clientId`: close every document it has open, then
|
|
1476
|
+
* free the id. Immediate — each close runs the ordinary close path before
|
|
1477
|
+
* this returns, with `cause` as its cause. A no-op for an id that is not a
|
|
1478
|
+
* registered session.
|
|
1479
|
+
*/
|
|
1480
|
+
closeSession(clientId: string, cause: SessionEndCause = 'closed'): void {
|
|
1481
|
+
if (!this.__sessions.isRegistered(clientId)) {
|
|
1482
|
+
return;
|
|
1483
|
+
}
|
|
1484
|
+
try {
|
|
1485
|
+
for (const uri of this.__sessions.beginClose(clientId)) {
|
|
1486
|
+
this.notifyDidCloseTextDocument({ textDocument: { uri } }, clientId, cause);
|
|
1487
|
+
}
|
|
1488
|
+
} finally {
|
|
1489
|
+
this.__sessions.unregister(clientId);
|
|
1490
|
+
this.tracer.info(`Session closed: ${this.formatClientId(clientId)}`);
|
|
1491
|
+
this.tracer.trace(`Session closed: ${clientId}`);
|
|
1492
|
+
}
|
|
1493
|
+
}
|
|
1494
|
+
|
|
1495
|
+
/**
|
|
1496
|
+
* Close every document the language client has open, as a `didClose` for
|
|
1497
|
+
* each would, so each last close reverts. For a host whose editor connection
|
|
1498
|
+
* can end while the process lives on, such as a worker whose port's peer
|
|
1499
|
+
* closed: the language client is no session, so nothing else closes them.
|
|
1500
|
+
*
|
|
1501
|
+
* It first waits for the workspace initialization the open handler waits
|
|
1502
|
+
* for, so an open that arrived before the close is closed too; closing at
|
|
1503
|
+
* once would leave that open to land afterwards, held by a client that is
|
|
1504
|
+
* gone.
|
|
1505
|
+
*/
|
|
1506
|
+
async closeLanguageClientDocuments(): Promise<void> {
|
|
1507
|
+
await this.services.workspace.WorkspaceManager.workspaceInitialized;
|
|
1508
|
+
for (const uri of this.__sessions.opensOf(LANGUAGE_CLIENT_ID)) {
|
|
1509
|
+
// Every spelling the client opened the file under, since the close
|
|
1510
|
+
// below drops only the canonical one's.
|
|
1511
|
+
const clientUris = this.__documents.get(uri)?.languageClientUris;
|
|
1512
|
+
for (const clientUri of clientUris ?? []) {
|
|
1513
|
+
this.invalidateLanguageClientText(clientUri);
|
|
1514
|
+
}
|
|
1515
|
+
clientUris?.clear();
|
|
1516
|
+
this.notifyDidCloseTextDocument({ textDocument: { uri } });
|
|
1517
|
+
}
|
|
1518
|
+
}
|
|
1519
|
+
|
|
1520
|
+
/**
|
|
1521
|
+
* The file behind `uri` was deleted: close every open of it except the
|
|
1522
|
+
* language client's.
|
|
1523
|
+
*
|
|
1524
|
+
* The editor's open is left alone because the editor owns it: it keeps the
|
|
1525
|
+
* buffer of a deleted file and goes on sending changes for it, and a store
|
|
1526
|
+
* that had closed the document would drop every one of them until the editor
|
|
1527
|
+
* reopened.
|
|
1528
|
+
*/
|
|
1529
|
+
notifyDocumentDeleted(uri: DocumentUri): void {
|
|
1530
|
+
const key = this.documentKey(uri);
|
|
1531
|
+
for (const clientId of this.__sessions.clientsOf(key)) {
|
|
1532
|
+
if (clientId !== LANGUAGE_CLIENT_ID) {
|
|
1533
|
+
this.notifyDidCloseTextDocument({ textDocument: { uri: key } }, clientId);
|
|
895
1534
|
}
|
|
896
1535
|
}
|
|
897
|
-
return result;
|
|
898
1536
|
}
|
|
899
1537
|
|
|
900
1538
|
/**
|
|
901
|
-
*
|
|
1539
|
+
* Remove the document for `uri`, closing every open of it first — the
|
|
1540
|
+
* editor's included, since the document it would keep editing is gone.
|
|
1541
|
+
*
|
|
1542
|
+
* The base removes the synced document without consulting the open table,
|
|
1543
|
+
* which leaves every open recorded against a document that no longer exists:
|
|
1544
|
+
* the store then answers that the URI is open, and the next open attaches to
|
|
1545
|
+
* nothing.
|
|
1546
|
+
*/
|
|
1547
|
+
override delete(uri: string | URI | T): void {
|
|
1548
|
+
const key = this.documentKey((typeof uri === 'object' && 'uri' in uri ? uri.uri : uri).toString());
|
|
1549
|
+
for (const clientId of this.__sessions.clientsOf(key)) {
|
|
1550
|
+
this.notifyDidCloseTextDocument({ textDocument: { uri: key } }, clientId);
|
|
1551
|
+
}
|
|
1552
|
+
// A document waiting out the grace has no client left to close, and is
|
|
1553
|
+
// released now as its last close would have released it.
|
|
1554
|
+
if (this.__sessions.isRevertPending(key)) {
|
|
1555
|
+
this.__sessions.cancelRevert(key);
|
|
1556
|
+
this.releaseDocument(key);
|
|
1557
|
+
}
|
|
1558
|
+
super.delete(key);
|
|
1559
|
+
}
|
|
1560
|
+
|
|
1561
|
+
/**
|
|
1562
|
+
* A client id as log lines print it. An id containing `#` is cut eight
|
|
1563
|
+
* characters after its last `#`, which leaves a minted `label#uuid` as the
|
|
1564
|
+
* label and enough of the UUID to tell sessions apart; an id without `#`
|
|
1565
|
+
* prints whole. The full id goes out at trace level wherever a session
|
|
1566
|
+
* starts or ends.
|
|
1567
|
+
*/
|
|
1568
|
+
protected formatClientId(clientId: string): string {
|
|
1569
|
+
const separator = clientId.lastIndexOf('#');
|
|
1570
|
+
return separator < 0 ? clientId : clientId.slice(0, separator + 9);
|
|
1571
|
+
}
|
|
1572
|
+
|
|
1573
|
+
/**
|
|
1574
|
+
* Stages integrity-updated content for a document no client holds.
|
|
902
1575
|
*
|
|
903
1576
|
* When `workspace/applyEdit` targets a closed file, the client opens it from
|
|
904
1577
|
* disk (stale) and sends `didOpen` before applying the edit. This staged
|
|
905
1578
|
* content is consumed by {@link notifyDidOpenTextDocument} to replace the
|
|
906
1579
|
* stale disk text, preventing a brief revert of the integrity update.
|
|
907
1580
|
*
|
|
908
|
-
*
|
|
909
|
-
*
|
|
910
|
-
*
|
|
911
|
-
*
|
|
912
|
-
*
|
|
1581
|
+
* Only a FIRST open consumes it, so stage only for a URI no client holds
|
|
1582
|
+
* ({@link isOpenInAnyClient} is `false`). A URI held only through another
|
|
1583
|
+
* head is not closed: an editor attaching to it joins the existing entry and
|
|
1584
|
+
* never reads the stage, and the last close discards the stage with the
|
|
1585
|
+
* tracking record. An entry lingers only if `workspace/applyEdit` fails and
|
|
1586
|
+
* the file is never opened — the memory cost is one serialised string per
|
|
1587
|
+
* URI.
|
|
913
1588
|
*/
|
|
914
1589
|
stagePendingContent(uri: DocumentUri, text: string): void {
|
|
915
1590
|
this.trackingFor(this.documentKey(uri)).pendingContent = text;
|
|
@@ -967,10 +1642,11 @@ export class HydraniumTextDocuments<T extends TextDocument = TextDocument> exten
|
|
|
967
1642
|
const targets: Iterable<LanguageClientUri> = recorded && recorded.size > 0 ? recorded : [this.toLanguageClientUri(uri)];
|
|
968
1643
|
let lastResult: ApplyWorkspaceEditResult | undefined;
|
|
969
1644
|
for (const targetUri of targets) {
|
|
970
|
-
// Read BEFORE computeEdits, which overwrites
|
|
971
|
-
//
|
|
972
|
-
// echo of
|
|
973
|
-
|
|
1645
|
+
// Read BEFORE computeEdits, which overwrites the baseline and drops
|
|
1646
|
+
// the opened snapshot. This is the text the client holds, and
|
|
1647
|
+
// therefore the only text its echo of this push can be reconstructed
|
|
1648
|
+
// against — whether or not the push below is keyed to it.
|
|
1649
|
+
const before = this.__shadow.clientText(targetUri);
|
|
974
1650
|
const edits = this.__shadow.computeEdits(targetUri, newText);
|
|
975
1651
|
if (edits.length === 0) {
|
|
976
1652
|
continue;
|
|
@@ -985,9 +1661,20 @@ export class HydraniumTextDocuments<T extends TextDocument = TextDocument> exten
|
|
|
985
1661
|
// it is exactly what the caller retries with after a rejection, so
|
|
986
1662
|
// gating it there would refuse the recovery too.
|
|
987
1663
|
const version = isFullReplace(edits) ? UNKNOWN_CLIENT_VERSION : this.languageClientVersion(uri);
|
|
1664
|
+
// A full `ApplyWorkspaceEditParams`, `edit` and all — NOT a bare
|
|
1665
|
+
// `WorkspaceEdit` with a `label` beside it. `applyEdit` takes
|
|
1666
|
+
// `ApplyWorkspaceEditParams | WorkspaceEdit` and discriminates on
|
|
1667
|
+
// `!!value.edit`, so `{ label, documentChanges }` is wrapped as
|
|
1668
|
+
// `{ edit: { label, documentChanges } }` — putting the label inside
|
|
1669
|
+
// the edit, where LSP defines no such field and no client reads it.
|
|
1670
|
+
// The union is also what hides it at compile time: excess-property
|
|
1671
|
+
// checking admits a property present in EITHER member, so an object
|
|
1672
|
+
// matching neither type-checks against the union.
|
|
988
1673
|
const result = await connection.workspace.applyEdit({
|
|
989
1674
|
label: options?.label,
|
|
990
|
-
|
|
1675
|
+
edit: {
|
|
1676
|
+
documentChanges: [TextDocumentEdit.create(OptionalVersionedTextDocumentIdentifier.create(targetUri, version), edits)]
|
|
1677
|
+
}
|
|
991
1678
|
});
|
|
992
1679
|
if (result && result.applied === false) {
|
|
993
1680
|
this.__shadow.invalidate(targetUri);
|
|
@@ -1043,12 +1730,17 @@ export class HydraniumTextDocuments<T extends TextDocument = TextDocument> exten
|
|
|
1043
1730
|
|
|
1044
1731
|
/**
|
|
1045
1732
|
* Decide what an incoming language-client change actually is, by
|
|
1046
|
-
* reconstructing the client's resulting buffer against the
|
|
1047
|
-
* in flight for
|
|
1733
|
+
* reconstructing the client's resulting buffer against the text its ranges
|
|
1734
|
+
* address — the pre-push buffer of the OLDEST push still in flight for
|
|
1735
|
+
* `clientFacing`, else whatever that client is believed to hold.
|
|
1048
1736
|
*
|
|
1049
|
-
* `undefined` when
|
|
1050
|
-
*
|
|
1051
|
-
*
|
|
1737
|
+
* `undefined` when the client's ranges address the synced text itself —
|
|
1738
|
+
* nothing in flight, and no evidence the client holds anything else. That
|
|
1739
|
+
* is the ordinary path, and the caller then applies the ranges directly.
|
|
1740
|
+
* The two texts part company without a push in flight whenever a client
|
|
1741
|
+
* attaches to a document another client has already written: it opened
|
|
1742
|
+
* from disk, so applying its ranges to the synced text splices lines they
|
|
1743
|
+
* never addressed.
|
|
1052
1744
|
*
|
|
1053
1745
|
* **Why the oldest, and why reconstruct at all.** The client applies our
|
|
1054
1746
|
* pushes in order and echoes each against the buffer it held before that
|
|
@@ -1079,22 +1771,41 @@ export class HydraniumTextDocuments<T extends TextDocument = TextDocument> exten
|
|
|
1079
1771
|
document: T,
|
|
1080
1772
|
changes: TextDocumentContentChangeEvent[]
|
|
1081
1773
|
): LanguageClientChangeOrigin | undefined {
|
|
1082
|
-
const
|
|
1083
|
-
|
|
1774
|
+
const queued = this.__pendingPushes.get(clientFacing);
|
|
1775
|
+
const pending = queued?.length ? queued : undefined;
|
|
1776
|
+
// The text the client's ranges address: the buffer it held before the
|
|
1777
|
+
// oldest push still in flight, else the buffer it is believed to hold.
|
|
1778
|
+
const clientText = pending?.[0].before ?? this.__shadow.clientText(clientFacing);
|
|
1779
|
+
if (pending === undefined && (clientText === undefined || clientText === document.getText())) {
|
|
1084
1780
|
return undefined;
|
|
1085
1781
|
}
|
|
1782
|
+
if (pending !== undefined && pending[0].before === undefined && changes.some(change => ContentChange.isIncremental(change))) {
|
|
1783
|
+
// A push sent to a client whose buffer was unknown — a first sync, or
|
|
1784
|
+
// the recovery push after a rejection. The shadow now holds the text
|
|
1785
|
+
// that push MOVES the client to, which is the one text the echo's
|
|
1786
|
+
// ranges provably do not address, so the fallback above is a baseline
|
|
1787
|
+
// known to be wrong rather than merely unverified. Drop the queue and
|
|
1788
|
+
// the shadow: the next sync is then a full replace, which lands on
|
|
1789
|
+
// whatever the client holds. A full-text change is exempt because it
|
|
1790
|
+
// reconstructs identically against any baseline.
|
|
1791
|
+
pending.length = 0;
|
|
1792
|
+
this.__shadow.invalidate(clientFacing);
|
|
1793
|
+
return { kind: 'unreconstructable' };
|
|
1794
|
+
}
|
|
1086
1795
|
// Through the configured factories, not `TextDocument` directly, so an
|
|
1087
1796
|
// adopter's custom text-document type governs how the ranges are applied
|
|
1088
1797
|
// here exactly as it does on the synced document.
|
|
1089
|
-
const probe = this.create(clientFacing, document.languageId, 0,
|
|
1090
|
-
const
|
|
1091
|
-
|
|
1092
|
-
|
|
1093
|
-
|
|
1094
|
-
|
|
1798
|
+
const probe = this.create(clientFacing, document.languageId, 0, clientText ?? document.getText());
|
|
1799
|
+
const reconstructed = this.update(probe, changes, 0).getText();
|
|
1800
|
+
if (pending !== undefined) {
|
|
1801
|
+
const matchIndex = pending.findIndex(push => push.afterHash === contentHash(reconstructed));
|
|
1802
|
+
if (matchIndex >= 0) {
|
|
1803
|
+
pending.splice(0, matchIndex + 1);
|
|
1804
|
+
return { kind: 'echo' };
|
|
1805
|
+
}
|
|
1806
|
+
pending.length = 0;
|
|
1095
1807
|
}
|
|
1096
|
-
|
|
1097
|
-
return { kind: 'divergent', text: clientText };
|
|
1808
|
+
return { kind: 'divergent', text: reconstructed };
|
|
1098
1809
|
}
|
|
1099
1810
|
|
|
1100
1811
|
/**
|