@hydranium/core 1.0.0-next.24 → 1.0.0-next.241
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 +22 -17
- package/lib/documents/ast-document-manager.d.ts +219 -122
- package/lib/documents/ast-document-manager.d.ts.map +1 -1
- package/lib/documents/ast-document-manager.js +241 -130
- 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 +146 -0
- package/lib/documents/client-session-registry.d.ts.map +1 -0
- package/lib/documents/client-session-registry.js +207 -0
- package/lib/documents/client-session-registry.js.map +1 -0
- package/lib/documents/dirty-state-tracker.d.ts +79 -0
- package/lib/documents/dirty-state-tracker.d.ts.map +1 -0
- package/lib/documents/dirty-state-tracker.js +69 -0
- package/lib/documents/dirty-state-tracker.js.map +1 -0
- package/lib/documents/document-release-handler.d.ts +179 -0
- package/lib/documents/document-release-handler.d.ts.map +1 -0
- package/lib/documents/document-release-handler.js +283 -0
- package/lib/documents/document-release-handler.js.map +1 -0
- package/lib/documents/document-release-scheduler.d.ts +67 -0
- package/lib/documents/document-release-scheduler.d.ts.map +1 -0
- package/lib/documents/document-release-scheduler.js +80 -0
- package/lib/documents/document-release-scheduler.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 +399 -282
- package/lib/documents/hydranium-text-documents.d.ts.map +1 -1
- package/lib/documents/hydranium-text-documents.js +816 -483
- package/lib/documents/hydranium-text-documents.js.map +1 -1
- package/lib/documents/index.d.ts +10 -2
- package/lib/documents/index.d.ts.map +1 -1
- package/lib/documents/index.js +10 -2
- package/lib/documents/index.js.map +1 -1
- package/lib/documents/language-client-shadow.d.ts +218 -0
- package/lib/documents/language-client-shadow.d.ts.map +1 -0
- package/lib/documents/language-client-shadow.js +283 -0
- package/lib/documents/language-client-shadow.js.map +1 -0
- package/lib/documents/model-ledger.d.ts +47 -0
- package/lib/documents/model-ledger.d.ts.map +1 -0
- package/lib/documents/model-ledger.js +30 -0
- package/lib/documents/model-ledger.js.map +1 -0
- package/lib/documents/text-ledger.d.ts +64 -0
- package/lib/documents/text-ledger.d.ts.map +1 -0
- package/lib/documents/text-ledger.js +63 -0
- package/lib/documents/text-ledger.js.map +1 -0
- package/lib/documents/version-sync-service.d.ts +134 -0
- package/lib/documents/version-sync-service.d.ts.map +1 -0
- package/lib/documents/version-sync-service.js +171 -0
- package/lib/documents/version-sync-service.js.map +1 -0
- package/lib/index.d.ts +5 -0
- package/lib/index.d.ts.map +1 -1
- package/lib/index.js +8 -0
- package/lib/index.js.map +1 -1
- package/lib/langium/ast-extension/ast-extension-service.d.ts.map +1 -1
- package/lib/langium/ast-extension/ast-extension-service.js.map +1 -1
- package/lib/langium/ast-extension/ast-node-builder.d.ts +32 -9
- package/lib/langium/ast-extension/ast-node-builder.d.ts.map +1 -1
- package/lib/langium/ast-extension/ast-node-builder.js +60 -22
- package/lib/langium/ast-extension/ast-node-builder.js.map +1 -1
- package/lib/langium/bootstrap.d.ts +23 -16
- package/lib/langium/bootstrap.d.ts.map +1 -1
- package/lib/langium/bootstrap.js +66 -28
- package/lib/langium/bootstrap.js.map +1 -1
- package/lib/langium/build-phase-pass/build-phase-pass-service.d.ts.map +1 -1
- package/lib/langium/build-phase-pass/build-phase-pass-service.js.map +1 -1
- package/lib/langium/composite-ast-reflection.d.ts +46 -0
- package/lib/langium/composite-ast-reflection.d.ts.map +1 -0
- package/lib/langium/composite-ast-reflection.js +97 -0
- package/lib/langium/composite-ast-reflection.js.map +1 -0
- package/lib/langium/config/configuration-provider.d.ts +81 -0
- package/lib/langium/config/configuration-provider.d.ts.map +1 -0
- package/lib/langium/config/configuration-provider.js +112 -0
- package/lib/langium/config/configuration-provider.js.map +1 -0
- package/lib/langium/config/index.d.ts +1 -0
- package/lib/langium/config/index.d.ts.map +1 -1
- package/lib/langium/config/index.js +1 -0
- package/lib/langium/config/index.js.map +1 -1
- package/lib/langium/config/settings.js.map +1 -1
- package/lib/langium/diagnostics/hydranium-langium-profiler.d.ts.map +1 -1
- package/lib/langium/diagnostics/hydranium-langium-profiler.js.map +1 -1
- package/lib/langium/diagnostics/logger.d.ts +10 -3
- package/lib/langium/diagnostics/logger.d.ts.map +1 -1
- package/lib/langium/diagnostics/logger.js +12 -5
- package/lib/langium/diagnostics/logger.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 +57 -16
- package/lib/langium/diagnostics/lsp-logger.js.map +1 -1
- package/lib/langium/diagnostics/server-tracer.d.ts.map +1 -1
- package/lib/langium/diagnostics/server-tracer.js.map +1 -1
- package/lib/langium/document-builder/build-pipeline-integration.d.ts +21 -1
- package/lib/langium/document-builder/build-pipeline-integration.d.ts.map +1 -1
- package/lib/langium/document-builder/build-pipeline-integration.js +32 -5
- package/lib/langium/document-builder/build-pipeline-integration.js.map +1 -1
- package/lib/langium/document-builder/build-session.d.ts.map +1 -1
- package/lib/langium/document-builder/build-session.js.map +1 -1
- package/lib/langium/document-builder/document-builder.d.ts +294 -33
- package/lib/langium/document-builder/document-builder.d.ts.map +1 -1
- package/lib/langium/document-builder/document-builder.js +477 -61
- package/lib/langium/document-builder/document-builder.js.map +1 -1
- package/lib/langium/documentation/comment-provider.d.ts.map +1 -1
- package/lib/langium/documentation/comment-provider.js.map +1 -1
- package/lib/langium/integration-services.d.ts +61 -19
- 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 +16 -8
- 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 +81 -24
- package/lib/langium/integrity/integrity-service.d.ts.map +1 -1
- package/lib/langium/integrity/integrity-service.js +264 -57
- package/lib/langium/integrity/integrity-service.js.map +1 -1
- package/lib/langium/keys/containment.d.ts +64 -0
- package/lib/langium/keys/containment.d.ts.map +1 -0
- package/lib/langium/keys/containment.js +53 -0
- package/lib/langium/keys/containment.js.map +1 -0
- package/lib/langium/keys/index.d.ts +1 -0
- package/lib/langium/keys/index.d.ts.map +1 -1
- package/lib/langium/keys/index.js +1 -0
- package/lib/langium/keys/index.js.map +1 -1
- package/lib/langium/keys/name-based-key-provider.d.ts +4 -0
- package/lib/langium/keys/name-based-key-provider.d.ts.map +1 -1
- package/lib/langium/keys/name-based-key-provider.js +4 -0
- package/lib/langium/keys/name-based-key-provider.js.map +1 -1
- package/lib/langium/keys/positional-key-provider.d.ts.map +1 -1
- package/lib/langium/keys/positional-key-provider.js.map +1 -1
- package/lib/langium/labeling/label-provider.d.ts.map +1 -1
- package/lib/langium/labeling/label-provider.js.map +1 -1
- package/lib/langium/language-module.d.ts +29 -4
- package/lib/langium/language-module.d.ts.map +1 -1
- package/lib/langium/language-module.js +18 -4
- package/lib/langium/language-module.js.map +1 -1
- package/lib/langium/model-service/client-session.d.ts +343 -0
- package/lib/langium/model-service/client-session.d.ts.map +1 -0
- package/lib/langium/model-service/client-session.js +411 -0
- package/lib/langium/model-service/client-session.js.map +1 -0
- package/lib/langium/model-service/index.d.ts +2 -0
- package/lib/langium/model-service/index.d.ts.map +1 -1
- package/lib/langium/model-service/index.js +2 -0
- package/lib/langium/model-service/index.js.map +1 -1
- package/lib/langium/model-service/model-events.d.ts +61 -0
- package/lib/langium/model-service/model-events.d.ts.map +1 -0
- package/lib/langium/model-service/model-events.js +10 -0
- package/lib/langium/model-service/model-events.js.map +1 -0
- package/lib/langium/model-service/model-service.d.ts +432 -282
- package/lib/langium/model-service/model-service.d.ts.map +1 -1
- package/lib/langium/model-service/model-service.js +504 -438
- package/lib/langium/model-service/model-service.js.map +1 -1
- package/lib/langium/module.d.ts +150 -35
- package/lib/langium/module.d.ts.map +1 -1
- package/lib/langium/module.js +47 -35
- package/lib/langium/module.js.map +1 -1
- package/lib/langium/naming/name-provider.d.ts +25 -4
- package/lib/langium/naming/name-provider.d.ts.map +1 -1
- package/lib/langium/naming/name-provider.js +2 -1
- package/lib/langium/naming/name-provider.js.map +1 -1
- package/lib/langium/naming/name-separator-validation.d.ts +23 -0
- package/lib/langium/naming/name-separator-validation.d.ts.map +1 -1
- package/lib/langium/naming/name-separator-validation.js +30 -1
- package/lib/langium/naming/name-separator-validation.js.map +1 -1
- package/lib/langium/project/abstract-project-manager.d.ts.map +1 -1
- package/lib/langium/project/abstract-project-manager.js +9 -2
- package/lib/langium/project/abstract-project-manager.js.map +1 -1
- package/lib/langium/project/project-change-event.d.ts +2 -2
- package/lib/langium/project/single-project-manager.d.ts.map +1 -1
- package/lib/langium/project/single-project-manager.js.map +1 -1
- package/lib/langium/residency/cst-residency-service.d.ts +30 -10
- package/lib/langium/residency/cst-residency-service.d.ts.map +1 -1
- package/lib/langium/residency/cst-residency-service.js +23 -57
- package/lib/langium/residency/cst-residency-service.js.map +1 -1
- package/lib/langium/scope/ast-node-description-provider.d.ts.map +1 -1
- package/lib/langium/scope/ast-node-description-provider.js.map +1 -1
- package/lib/langium/scope/hydranium-scope-computation.d.ts.map +1 -1
- package/lib/langium/scope/hydranium-scope-computation.js.map +1 -1
- package/lib/langium/scope/hydranium-scope-provider.d.ts +48 -13
- package/lib/langium/scope/hydranium-scope-provider.d.ts.map +1 -1
- package/lib/langium/scope/hydranium-scope-provider.js +56 -20
- package/lib/langium/scope/hydranium-scope-provider.js.map +1 -1
- package/lib/langium/scope/reference-builder.d.ts.map +1 -1
- package/lib/langium/scope/reference-builder.js.map +1 -1
- package/lib/langium/scope/reference-candidate-provider.d.ts.map +1 -1
- package/lib/langium/scope/reference-candidate-provider.js.map +1 -1
- package/lib/langium/scope/scope-extension-service.d.ts.map +1 -1
- package/lib/langium/scope/scope-extension-service.js.map +1 -1
- package/lib/langium/serialization/abstract-serializer.d.ts +11 -20
- package/lib/langium/serialization/abstract-serializer.d.ts.map +1 -1
- package/lib/langium/serialization/abstract-serializer.js +12 -21
- package/lib/langium/serialization/abstract-serializer.js.map +1 -1
- package/lib/langium/serialization/json-serializer.d.ts +1 -1
- package/lib/langium/serialization/json-serializer.d.ts.map +1 -1
- package/lib/langium/serialization/json-serializer.js.map +1 -1
- package/lib/langium/serialization/yaml-serializer.d.ts.map +1 -1
- package/lib/langium/serialization/yaml-serializer.js.map +1 -1
- package/lib/langium/service-registry.d.ts +29 -1
- package/lib/langium/service-registry.d.ts.map +1 -1
- package/lib/langium/service-registry.js +37 -0
- package/lib/langium/service-registry.js.map +1 -1
- package/lib/langium/shared-services.d.ts +21 -6
- package/lib/langium/shared-services.d.ts.map +1 -1
- package/lib/langium/shared-services.js.map +1 -1
- package/lib/langium/single-langium-copy.d.ts +22 -0
- package/lib/langium/single-langium-copy.d.ts.map +1 -0
- package/lib/langium/single-langium-copy.js +36 -0
- package/lib/langium/single-langium-copy.js.map +1 -0
- package/lib/langium/transfer/transfer-encoder.d.ts +77 -26
- package/lib/langium/transfer/transfer-encoder.d.ts.map +1 -1
- package/lib/langium/transfer/transfer-encoder.js +46 -24
- package/lib/langium/transfer/transfer-encoder.js.map +1 -1
- package/lib/langium/trivia/comment-preserver.d.ts +423 -0
- package/lib/langium/trivia/comment-preserver.d.ts.map +1 -0
- package/lib/langium/trivia/comment-preserver.js +906 -0
- package/lib/langium/trivia/comment-preserver.js.map +1 -0
- package/lib/langium/trivia/document-ending-preserver.d.ts +43 -0
- package/lib/langium/trivia/document-ending-preserver.d.ts.map +1 -0
- package/lib/langium/trivia/document-ending-preserver.js +48 -0
- package/lib/langium/trivia/document-ending-preserver.js.map +1 -0
- package/lib/langium/trivia/index.d.ts +14 -0
- package/lib/langium/trivia/index.d.ts.map +1 -0
- package/lib/langium/trivia/index.js +14 -0
- package/lib/langium/trivia/index.js.map +1 -0
- package/lib/langium/trivia/trivia-contribution.d.ts +37 -0
- package/lib/langium/trivia/trivia-contribution.d.ts.map +1 -0
- package/lib/langium/trivia/trivia-contribution.js +10 -0
- package/lib/langium/trivia/trivia-contribution.js.map +1 -0
- package/lib/langium/trivia/trivia-preserver.d.ts +50 -0
- package/lib/langium/trivia/trivia-preserver.d.ts.map +1 -0
- package/lib/langium/trivia/trivia-preserver.js +10 -0
- package/lib/langium/trivia/trivia-preserver.js.map +1 -0
- package/lib/langium/trivia/trivia-service.d.ts +70 -0
- package/lib/langium/trivia/trivia-service.d.ts.map +1 -0
- package/lib/langium/trivia/trivia-service.js +56 -0
- package/lib/langium/trivia/trivia-service.js.map +1 -0
- package/lib/langium/update-rewrite/normalize-empty-strings.d.ts.map +1 -1
- package/lib/langium/update-rewrite/update-rewrite-service.d.ts.map +1 -1
- package/lib/langium/update-rewrite/update-rewrite-service.js.map +1 -1
- package/lib/langium/update-rewrite/update-rewrite.d.ts +1 -1
- package/lib/langium/validation/document-validator.d.ts +280 -9
- package/lib/langium/validation/document-validator.d.ts.map +1 -1
- package/lib/langium/validation/document-validator.js +448 -5
- package/lib/langium/validation/document-validator.js.map +1 -1
- package/lib/langium/validation/validation-contribution-collector.d.ts +9 -1
- package/lib/langium/validation/validation-contribution-collector.d.ts.map +1 -1
- package/lib/langium/validation/validation-contribution-collector.js +1 -1
- package/lib/langium/validation/validation-contribution-collector.js.map +1 -1
- package/lib/langium/workspace/document-uri-policy.d.ts +15 -10
- package/lib/langium/workspace/document-uri-policy.d.ts.map +1 -1
- package/lib/langium/workspace/document-uri-policy.js +7 -5
- package/lib/langium/workspace/document-uri-policy.js.map +1 -1
- package/lib/langium/workspace/file-not-found.d.ts +23 -0
- package/lib/langium/workspace/file-not-found.d.ts.map +1 -0
- package/lib/langium/workspace/file-not-found.js +31 -0
- package/lib/langium/workspace/file-not-found.js.map +1 -0
- package/lib/langium/workspace/file-system-provider.d.ts +135 -9
- package/lib/langium/workspace/file-system-provider.d.ts.map +1 -1
- package/lib/langium/workspace/file-system-provider.js +93 -14
- package/lib/langium/workspace/file-system-provider.js.map +1 -1
- package/lib/langium/workspace/hydranium-langium-document-factory.d.ts +56 -1
- package/lib/langium/workspace/hydranium-langium-document-factory.d.ts.map +1 -1
- package/lib/langium/workspace/hydranium-langium-document-factory.js +79 -0
- package/lib/langium/workspace/hydranium-langium-document-factory.js.map +1 -1
- package/lib/langium/workspace/hydranium-workspace-lock.d.ts +43 -1
- package/lib/langium/workspace/hydranium-workspace-lock.d.ts.map +1 -1
- package/lib/langium/workspace/hydranium-workspace-lock.js +58 -1
- package/lib/langium/workspace/hydranium-workspace-lock.js.map +1 -1
- package/lib/langium/workspace/hydranium-workspace-manager.d.ts +82 -9
- package/lib/langium/workspace/hydranium-workspace-manager.d.ts.map +1 -1
- package/lib/langium/workspace/hydranium-workspace-manager.js +128 -10
- package/lib/langium/workspace/hydranium-workspace-manager.js.map +1 -1
- package/lib/langium/workspace/in-memory-file-system-provider.d.ts +26 -3
- package/lib/langium/workspace/in-memory-file-system-provider.d.ts.map +1 -1
- package/lib/langium/workspace/in-memory-file-system-provider.js +41 -15
- package/lib/langium/workspace/in-memory-file-system-provider.js.map +1 -1
- package/lib/langium/workspace/index-manager.d.ts.map +1 -1
- package/lib/langium/workspace/index-manager.js.map +1 -1
- package/lib/langium/workspace/index.d.ts +1 -0
- package/lib/langium/workspace/index.d.ts.map +1 -1
- package/lib/langium/workspace/index.js +1 -0
- package/lib/langium/workspace/index.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 +46 -4
- package/lib/langium/workspace/langium-documents.d.ts.map +1 -1
- package/lib/langium/workspace/langium-documents.js +60 -5
- package/lib/langium/workspace/langium-documents.js.map +1 -1
- package/lib/langium/workspace/persistent-file-system-provider.d.ts +1 -8
- package/lib/langium/workspace/persistent-file-system-provider.d.ts.map +1 -1
- package/lib/langium/workspace/persistent-file-system-provider.js +0 -7
- package/lib/langium/workspace/persistent-file-system-provider.js.map +1 -1
- package/lib/{documents → langium/workspace}/self-save-registry.d.ts +38 -7
- package/lib/langium/workspace/self-save-registry.d.ts.map +1 -0
- package/lib/{documents → langium/workspace}/self-save-registry.js +29 -16
- package/lib/langium/workspace/self-save-registry.js.map +1 -0
- package/lib/langium/workspace/virtual-document.d.ts +48 -15
- package/lib/langium/workspace/virtual-document.d.ts.map +1 -1
- package/lib/langium/workspace/virtual-document.js +78 -18
- package/lib/langium/workspace/virtual-document.js.map +1 -1
- package/lib/langium/workspace/write-lock-scope.d.ts +20 -10
- package/lib/langium/workspace/write-lock-scope.d.ts.map +1 -1
- package/lib/langium/workspace/write-lock-scope.js +12 -4
- package/lib/langium/workspace/write-lock-scope.js.map +1 -1
- package/lib/locale/index.d.ts +10 -0
- package/lib/locale/index.d.ts.map +1 -0
- package/lib/locale/index.js +10 -0
- package/lib/locale/index.js.map +1 -0
- package/lib/locale/server-locale.d.ts +73 -0
- package/lib/locale/server-locale.d.ts.map +1 -0
- package/lib/locale/server-locale.js +61 -0
- package/lib/locale/server-locale.js.map +1 -0
- package/lib/lsp/completion/hydranium-completion-provider.d.ts +44 -2
- package/lib/lsp/completion/hydranium-completion-provider.d.ts.map +1 -1
- package/lib/lsp/completion/hydranium-completion-provider.js +68 -0
- package/lib/lsp/completion/hydranium-completion-provider.js.map +1 -1
- package/lib/lsp/connection-features.d.ts +23 -0
- package/lib/lsp/connection-features.d.ts.map +1 -0
- package/lib/lsp/connection-features.js +60 -0
- package/lib/lsp/connection-features.js.map +1 -0
- package/lib/lsp/diagnostics-connection.d.ts +27 -0
- package/lib/lsp/diagnostics-connection.d.ts.map +1 -0
- package/lib/lsp/diagnostics-connection.js +53 -0
- package/lib/lsp/diagnostics-connection.js.map +1 -0
- package/lib/lsp/hydranium-document-update-handler.d.ts +92 -81
- package/lib/lsp/hydranium-document-update-handler.d.ts.map +1 -1
- package/lib/lsp/hydranium-document-update-handler.js +153 -99
- package/lib/lsp/hydranium-document-update-handler.js.map +1 -1
- package/lib/lsp/index.d.ts +3 -1
- package/lib/lsp/index.d.ts.map +1 -1
- package/lib/lsp/index.js +3 -1
- package/lib/lsp/index.js.map +1 -1
- package/lib/lsp/lsp-latency.d.ts +39 -0
- package/lib/lsp/lsp-latency.d.ts.map +1 -0
- package/lib/lsp/lsp-latency.js +58 -0
- package/lib/lsp/lsp-latency.js.map +1 -0
- package/lib/lsp/semantic-token-provider.d.ts +34 -1
- package/lib/lsp/semantic-token-provider.d.ts.map +1 -1
- package/lib/lsp/semantic-token-provider.js +55 -8
- package/lib/lsp/semantic-token-provider.js.map +1 -1
- package/lib/lsp/shared-module.d.ts +4 -8
- package/lib/lsp/shared-module.d.ts.map +1 -1
- package/lib/lsp/shared-module.js.map +1 -1
- package/lib/lsp/start-language-server.d.ts +8 -7
- package/lib/lsp/start-language-server.d.ts.map +1 -1
- package/lib/lsp/start-language-server.js +13 -7
- package/lib/lsp/start-language-server.js.map +1 -1
- package/lib/messages/carriers.d.ts +54 -0
- package/lib/messages/carriers.d.ts.map +1 -0
- package/lib/messages/carriers.js +62 -0
- package/lib/messages/carriers.js.map +1 -0
- package/lib/messages/index.d.ts +25 -0
- package/lib/messages/index.d.ts.map +1 -0
- package/lib/messages/index.js +25 -0
- package/lib/messages/index.js.map +1 -0
- package/lib/messages/renderer.d.ts +142 -0
- package/lib/messages/renderer.d.ts.map +1 -0
- package/lib/messages/renderer.js +165 -0
- package/lib/messages/renderer.js.map +1 -0
- package/lib/node/event-loop-monitor.js.map +1 -1
- package/lib/node/heap-ceiling.d.ts +61 -0
- package/lib/node/heap-ceiling.d.ts.map +1 -0
- package/lib/node/heap-ceiling.js +72 -0
- package/lib/node/heap-ceiling.js.map +1 -0
- package/lib/node/index.d.ts +1 -1
- package/lib/node/index.d.ts.map +1 -1
- package/lib/node/index.js +1 -1
- package/lib/node/index.js.map +1 -1
- package/lib/node/latency-from-env.d.ts +1 -1
- package/lib/node/latency-from-env.js +1 -1
- package/lib/node/lint-grammar.js.map +1 -1
- package/lib/node/measure-memory.d.ts.map +1 -1
- package/lib/node/measure-memory.js +1 -0
- package/lib/node/measure-memory.js.map +1 -1
- package/lib/node/memory-monitor.js.map +1 -1
- package/lib/node/node-file-system-provider.d.ts +41 -6
- package/lib/node/node-file-system-provider.d.ts.map +1 -1
- package/lib/node/node-file-system-provider.js +109 -49
- package/lib/node/node-file-system-provider.js.map +1 -1
- package/lib/node/profile-capture.d.ts +8 -2
- package/lib/node/profile-capture.d.ts.map +1 -1
- package/lib/node/profile-capture.js +1 -1
- package/lib/node/profile-capture.js.map +1 -1
- package/lib/node/profile-digest.js.map +1 -1
- package/lib/node/profiling-run.d.ts +13 -3
- package/lib/node/profiling-run.d.ts.map +1 -1
- package/lib/node/profiling-run.js +17 -8
- 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 +20 -4
- package/lib/node/socket-launcher.d.ts.map +1 -1
- package/lib/node/socket-launcher.js +5 -4
- package/lib/node/socket-launcher.js.map +1 -1
- package/lib/node/stdio-launcher.d.ts +6 -5
- package/lib/node/stdio-launcher.d.ts.map +1 -1
- package/lib/node/stdio-launcher.js +2 -2
- package/lib/node/stdio-launcher.js.map +1 -1
- package/lib/testing/document-uri-policy-conformance.js.map +1 -1
- package/lib/testing/fake-description.js.map +1 -1
- package/lib/testing/fake-document.d.ts +16 -4
- package/lib/testing/fake-document.d.ts.map +1 -1
- package/lib/testing/fake-document.js +18 -3
- package/lib/testing/fake-document.js.map +1 -1
- package/lib/testing/index.d.ts +1 -1
- package/lib/testing/index.d.ts.map +1 -1
- package/lib/testing/index.js +2 -1
- package/lib/testing/index.js.map +1 -1
- package/lib/testing/langium-test-helpers.d.ts.map +1 -1
- package/lib/testing/langium-test-helpers.js +1 -0
- package/lib/testing/langium-test-helpers.js.map +1 -1
- package/lib/testing/make-noop-language-services.js.map +1 -1
- package/lib/testing/make-noop-shared-services.d.ts +14 -0
- package/lib/testing/make-noop-shared-services.d.ts.map +1 -1
- package/lib/testing/make-noop-shared-services.js +28 -2
- package/lib/testing/make-noop-shared-services.js.map +1 -1
- package/lib/testing/make-test-services.d.ts +72 -14
- package/lib/testing/make-test-services.d.ts.map +1 -1
- package/lib/testing/make-test-services.js +42 -10
- package/lib/testing/make-test-services.js.map +1 -1
- package/lib/testing/make-test-tracer.d.ts +12 -0
- package/lib/testing/make-test-tracer.d.ts.map +1 -1
- package/lib/testing/make-test-tracer.js +13 -0
- package/lib/testing/make-test-tracer.js.map +1 -1
- package/lib/testing/node/golden-corpus.js.map +1 -1
- package/lib/testing/node/index.d.ts +1 -0
- package/lib/testing/node/index.d.ts.map +1 -1
- package/lib/testing/node/index.js +1 -0
- package/lib/testing/node/index.js.map +1 -1
- package/lib/testing/node/lsp-harness.d.ts.map +1 -1
- package/lib/testing/node/lsp-harness.js +2 -0
- package/lib/testing/node/lsp-harness.js.map +1 -1
- package/lib/testing/node/lsp-server-connection.d.ts +11 -3
- package/lib/testing/node/lsp-server-connection.d.ts.map +1 -1
- package/lib/testing/node/lsp-server-connection.js +43 -10
- 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 +34 -2
- package/lib/testing/node/spawned-server.js.map +1 -1
- package/lib/testing/node/unhandled-rejections.d.ts +20 -0
- package/lib/testing/node/unhandled-rejections.d.ts.map +1 -0
- package/lib/testing/node/unhandled-rejections.js +32 -0
- package/lib/testing/node/unhandled-rejections.js.map +1 -0
- package/lib/testing/playwright/browser-capture-bridge.js.map +1 -1
- package/lib/testing/playwright/e2e-profiling.js.map +1 -1
- package/lib/testing/playwright/flaky-network-proxy.d.ts +76 -0
- package/lib/testing/playwright/flaky-network-proxy.d.ts.map +1 -0
- package/lib/testing/playwright/flaky-network-proxy.js +164 -0
- package/lib/testing/playwright/flaky-network-proxy.js.map +1 -0
- package/lib/testing/playwright/index.d.ts +1 -0
- package/lib/testing/playwright/index.d.ts.map +1 -1
- package/lib/testing/playwright/index.js +1 -0
- package/lib/testing/playwright/index.js.map +1 -1
- package/lib/testing/playwright/server-log-capture.d.ts +24 -8
- package/lib/testing/playwright/server-log-capture.d.ts.map +1 -1
- package/lib/testing/playwright/server-log-capture.js +27 -6
- 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 +11 -52
- package/lib/testing/stub-ast-document-manager.d.ts.map +1 -1
- package/lib/testing/stub-ast-document-manager.js +24 -65
- package/lib/testing/stub-ast-document-manager.js.map +1 -1
- package/lib/testing/stub-document-builder.d.ts +26 -11
- package/lib/testing/stub-document-builder.d.ts.map +1 -1
- package/lib/testing/stub-document-builder.js +78 -5
- package/lib/testing/stub-document-builder.js.map +1 -1
- package/lib/testing/stub-hydranium-text-documents.d.ts +33 -10
- package/lib/testing/stub-hydranium-text-documents.d.ts.map +1 -1
- package/lib/testing/stub-hydranium-text-documents.js +115 -16
- package/lib/testing/stub-hydranium-text-documents.js.map +1 -1
- package/lib/testing/stub-index-manager.js.map +1 -1
- package/lib/testing/stub-langium-documents.d.ts +3 -2
- package/lib/testing/stub-langium-documents.d.ts.map +1 -1
- package/lib/testing/stub-langium-documents.js.map +1 -1
- package/lib/testing/stub-model-service.d.ts +7 -6
- package/lib/testing/stub-model-service.d.ts.map +1 -1
- package/lib/testing/stub-model-service.js +4 -4
- package/lib/testing/stub-model-service.js.map +1 -1
- package/lib/testing/stub-project-manager.js.map +1 -1
- package/lib/testing/stub-self-save-registry.d.ts +1 -1
- package/lib/testing/stub-self-save-registry.d.ts.map +1 -1
- package/lib/testing/stub-service-registry.d.ts +1 -1
- package/lib/testing/stub-service-registry.js.map +1 -1
- package/lib/testing/stub-writable-file-system.d.ts +1 -1
- package/lib/testing/stub-writable-file-system.d.ts.map +1 -1
- package/lib/util/connection-liveness.d.ts +7 -6
- package/lib/util/connection-liveness.d.ts.map +1 -1
- package/lib/util/connection-liveness.js +35 -14
- package/lib/util/connection-liveness.js.map +1 -1
- package/lib/util/environment.d.ts.map +1 -1
- package/lib/util/environment.js.map +1 -1
- package/lib/util/registry.d.ts.map +1 -1
- package/package.json +32 -48
- package/src/documents/ast-document-manager.ts +379 -231
- package/src/documents/client-ids.ts +5 -22
- package/src/documents/client-session-errors.ts +24 -0
- package/src/documents/client-session-registry.ts +262 -0
- package/src/documents/dirty-state-tracker.ts +130 -0
- package/src/documents/document-release-handler.ts +365 -0
- package/src/documents/document-release-scheduler.ts +121 -0
- package/src/documents/file-system-task-queue.ts +68 -0
- package/src/documents/hydranium-text-documents.ts +931 -595
- package/src/documents/index.ts +10 -2
- package/src/documents/language-client-shadow.ts +451 -0
- package/src/documents/model-ledger.ts +66 -0
- package/src/documents/text-ledger.ts +112 -0
- package/src/documents/version-sync-service.ts +267 -0
- package/src/index.ts +8 -0
- package/src/langium/ast-extension/ast-node-builder.ts +66 -22
- package/src/langium/bootstrap.ts +66 -28
- package/src/langium/composite-ast-reflection.ts +112 -0
- package/src/langium/config/configuration-provider.ts +119 -0
- package/src/langium/config/index.ts +1 -0
- package/src/langium/diagnostics/logger.ts +12 -5
- package/src/langium/diagnostics/lsp-logger.ts +59 -15
- package/src/langium/document-builder/build-pipeline-integration.ts +50 -5
- package/src/langium/document-builder/document-builder.ts +565 -59
- package/src/langium/integration-services.ts +83 -24
- package/src/langium/integrity/integrity-rule.ts +16 -8
- package/src/langium/integrity/integrity-service.ts +287 -62
- 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 +48 -7
- package/src/langium/model-service/client-session.ts +644 -0
- package/src/langium/model-service/index.ts +2 -0
- package/src/langium/model-service/model-events.ts +75 -0
- package/src/langium/model-service/model-service.ts +790 -468
- package/src/langium/module.ts +199 -64
- package/src/langium/naming/name-provider.ts +27 -5
- package/src/langium/naming/name-separator-validation.ts +34 -5
- package/src/langium/project/abstract-project-manager.ts +9 -1
- package/src/langium/project/project-change-event.ts +2 -2
- package/src/langium/residency/cst-residency-service.ts +45 -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 +41 -2
- package/src/langium/shared-services.ts +21 -6
- package/src/langium/single-langium-copy.ts +42 -0
- package/src/langium/transfer/transfer-encoder.ts +104 -37
- 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 +523 -10
- package/src/langium/validation/validation-contribution-collector.ts +10 -1
- package/src/langium/workspace/document-uri-policy.ts +15 -10
- package/src/langium/workspace/file-not-found.ts +35 -0
- package/src/langium/workspace/file-system-provider.ts +205 -17
- package/src/langium/workspace/hydranium-langium-document-factory.ts +117 -0
- package/src/langium/workspace/hydranium-workspace-lock.ts +86 -2
- package/src/langium/workspace/hydranium-workspace-manager.ts +154 -14
- package/src/langium/workspace/in-memory-file-system-provider.ts +48 -17
- package/src/langium/workspace/index.ts +1 -0
- package/src/langium/workspace/initialize-workspace.ts +43 -5
- package/src/langium/workspace/langium-documents.ts +75 -6
- package/src/langium/workspace/persistent-file-system-provider.ts +1 -8
- package/src/{documents → langium/workspace}/self-save-registry.ts +54 -15
- package/src/langium/workspace/virtual-document.ts +96 -19
- package/src/langium/workspace/write-lock-scope.ts +24 -11
- package/src/locale/index.ts +10 -0
- package/src/locale/server-locale.ts +86 -0
- package/src/lsp/completion/hydranium-completion-provider.ts +82 -2
- package/src/lsp/connection-features.ts +67 -0
- package/src/lsp/diagnostics-connection.ts +56 -0
- package/src/lsp/hydranium-document-update-handler.ts +187 -108
- 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 -1
- 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 +124 -53
- package/src/node/profile-capture.ts +9 -3
- package/src/node/profiling-run.ts +30 -8
- package/src/node/rename-over-open-readers.ts +78 -0
- package/src/node/socket-launcher.ts +24 -8
- package/src/node/stdio-launcher.ts +8 -7
- package/src/testing/fake-document.ts +24 -5
- package/src/testing/index.ts +2 -1
- package/src/testing/langium-test-helpers.ts +1 -0
- package/src/testing/make-noop-shared-services.ts +50 -2
- package/src/testing/make-test-services.ts +125 -31
- package/src/testing/make-test-tracer.ts +26 -0
- 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 +66 -12
- package/src/testing/node/scratch-workspace.ts +10 -5
- package/src/testing/node/spawned-server.ts +36 -2
- package/src/testing/node/unhandled-rejections.ts +31 -0
- package/src/testing/parse-semantic-root.ts +1 -1
- 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 +45 -11
- 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 +36 -138
- package/src/testing/stub-document-builder.ts +102 -18
- package/src/testing/stub-hydranium-text-documents.ts +165 -27
- package/src/testing/stub-langium-documents.ts +3 -2
- package/src/testing/stub-model-service.ts +9 -8
- package/src/testing/stub-self-save-registry.ts +1 -1
- package/src/testing/stub-service-registry.ts +1 -1
- package/src/testing/stub-writable-file-system.ts +1 -1
- package/src/util/connection-liveness.ts +37 -14
- package/src/util/environment.ts +9 -1
- package/lib/documents/language-client-text-shadow.d.ts +0 -101
- package/lib/documents/language-client-text-shadow.d.ts.map +0 -1
- package/lib/documents/language-client-text-shadow.js +0 -156
- package/lib/documents/language-client-text-shadow.js.map +0 -1
- package/lib/documents/self-save-registry.d.ts.map +0 -1
- package/lib/documents/self-save-registry.js.map +0 -1
- package/lib/lsp/instrument-connection.d.ts +0 -36
- package/lib/lsp/instrument-connection.d.ts.map +0 -1
- package/lib/lsp/instrument-connection.js +0 -62
- package/lib/lsp/instrument-connection.js.map +0 -1
- package/lib/node/process-memory.d.ts +0 -66
- package/lib/node/process-memory.d.ts.map +0 -1
- package/lib/node/process-memory.js +0 -252
- package/lib/node/process-memory.js.map +0 -1
- package/src/documents/language-client-text-shadow.ts +0 -175
- package/src/lsp/instrument-connection.ts +0 -66
- package/src/node/process-memory.ts +0 -299
|
@@ -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,7 +31,7 @@ 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,
|
|
@@ -45,10 +45,31 @@ import {
|
|
|
45
45
|
type WillSaveTextDocumentParams
|
|
46
46
|
} from 'vscode-languageserver';
|
|
47
47
|
import { type DocumentUri, TextDocument, type TextDocumentContentChangeEvent } from 'vscode-languageserver-textdocument';
|
|
48
|
-
import {
|
|
48
|
+
import {
|
|
49
|
+
type CanonicalUri,
|
|
50
|
+
type LanguageClientUri,
|
|
51
|
+
asLanguageClientUri,
|
|
52
|
+
DisposableCollection,
|
|
53
|
+
type TextState,
|
|
54
|
+
type TextVersion,
|
|
55
|
+
STALE_VERSION,
|
|
56
|
+
type Tracer,
|
|
57
|
+
UNRECORDED_VERSION
|
|
58
|
+
} from '@hydranium/protocol';
|
|
49
59
|
import { type LogNameOptions } from '../langium/diagnostics/logger.js';
|
|
50
60
|
import { LANGUAGE_CLIENT_ID } from './client-ids.js';
|
|
51
|
-
import {
|
|
61
|
+
import { INTEGRITY_CLIENT_ID } from '../langium/integrity/integrity-rule.js';
|
|
62
|
+
import { type ClientSessionClosedEvent, ClientSessionRegistry, type SessionEndCause } from './client-session-registry.js';
|
|
63
|
+
import { DefaultLanguageClientShadow, type LanguageClientChangeVerdict, type LanguageClientShadow } from './language-client-shadow.js';
|
|
64
|
+
import { DefaultTextLedger, type TextLedger } from './text-ledger.js';
|
|
65
|
+
import { isDocumentReleaseSkippedError, type ReleasedDocument } from './document-release-handler.js';
|
|
66
|
+
import { DefaultDocumentReleaseScheduler, type DocumentReleaseScheduler } from './document-release-scheduler.js';
|
|
67
|
+
import {
|
|
68
|
+
type CleanAnnouncement,
|
|
69
|
+
DefaultDirtyStateTracker,
|
|
70
|
+
type DirtyStateTracker,
|
|
71
|
+
type DocumentDirtyChangedEvent
|
|
72
|
+
} from './dirty-state-tracker.js';
|
|
52
73
|
|
|
53
74
|
/**
|
|
54
75
|
* The LSP spec's "version is intentionally unknown" for an
|
|
@@ -74,47 +95,39 @@ export interface HydraniumTextDocumentsOptions<T extends TextDocument = TextDocu
|
|
|
74
95
|
* Adopters with a custom text-document type (rare) pass their factory.
|
|
75
96
|
*/
|
|
76
97
|
readonly configuration?: TextDocumentsConfiguration<T>;
|
|
98
|
+
/**
|
|
99
|
+
* How long a document whose last open closed because its client's
|
|
100
|
+
* connection was lost keeps its text before the store releases it. An open
|
|
101
|
+
* by a client lost from the document, within this time of its own loss,
|
|
102
|
+
* cancels the release, so a client that registers again under its id after
|
|
103
|
+
* a dropped connection finds its unsaved edits. Any other open releases the
|
|
104
|
+
* document first and then opens it as a first open does, from the text the
|
|
105
|
+
* opener supplies (an editor's own) or else from the file. Meanwhile the
|
|
106
|
+
* document counts as open for the integrity service, which therefore writes
|
|
107
|
+
* none of its unsaved text to disk. A close the client makes itself, or
|
|
108
|
+
* ending its session, releases at once whatever this is.
|
|
109
|
+
*
|
|
110
|
+
* Defaults to 10 s. `0` releases such a document at once as well, in the
|
|
111
|
+
* close itself rather than on a timer.
|
|
112
|
+
*/
|
|
113
|
+
readonly releaseGraceMs?: number;
|
|
77
114
|
}
|
|
78
115
|
|
|
79
116
|
/**
|
|
80
|
-
*
|
|
81
|
-
*
|
|
82
|
-
*
|
|
83
|
-
* maps are the substrate of a close-on-stale-state desync — one map can be
|
|
84
|
-
* cleared while another lingers.)
|
|
85
|
-
*
|
|
86
|
-
* Two neighbours deliberately stay separate:
|
|
87
|
-
* - The inherited `__syncedDocuments` (Langium's parsed `TextDocument` store).
|
|
88
|
-
* - {@link LanguageClientTextShadow} (`__shadow`), a self-contained,
|
|
89
|
-
* separately-tested diff/apply-verify abstraction that owns its own baseline
|
|
90
|
-
* text; folding its storage here would couple a clean utility to this record
|
|
91
|
-
* for no real gain.
|
|
117
|
+
* The default of {@link HydraniumTextDocumentsOptions.releaseGraceMs}: long
|
|
118
|
+
* enough for a client whose connection dropped to register again and reopen
|
|
119
|
+
* its documents, which a data client does as soon as it has a connection.
|
|
92
120
|
*/
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
readonly
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
* sequence, which the server assigns (see {@link HydraniumTextDocuments.__versionSequences}).
|
|
104
|
-
*/
|
|
105
|
-
readonly clientVersions: Map<string, number>;
|
|
106
|
-
/** Content staged by integrity rules for a closed document. Consumed on next open. */
|
|
107
|
-
pendingContent?: string;
|
|
108
|
-
/**
|
|
109
|
-
* The URI(s) the LSP textual language client opened this (canonically-keyed)
|
|
110
|
-
* document under. Usually one; a set because the same physical file can be
|
|
111
|
-
* opened under more than one URI (a symlink path and its real path). This is
|
|
112
|
-
* the egress address: `applyEditToLanguageClient`
|
|
113
|
-
* targets these, since the document is *keyed* by its canonical identity but
|
|
114
|
-
* Monaco holds it under the URI it opened. Lifecycle-bound — cleared with the
|
|
115
|
-
* record on last close.
|
|
116
|
-
*/
|
|
117
|
-
languageClientUris?: Set<LanguageClientUri>;
|
|
121
|
+
const DEFAULT_RELEASE_GRACE_MS = 10_000;
|
|
122
|
+
|
|
123
|
+
/** Delivered by {@link HydraniumTextDocuments.onDidSaveInLanguageClient}. */
|
|
124
|
+
export interface LanguageClientSavedEvent {
|
|
125
|
+
readonly uri: string;
|
|
126
|
+
}
|
|
127
|
+
|
|
128
|
+
/** Delivered by {@link HydraniumTextDocuments.onDidReleaseDocument}. */
|
|
129
|
+
export interface DocumentReleasedEvent {
|
|
130
|
+
readonly uri: CanonicalUri;
|
|
118
131
|
}
|
|
119
132
|
|
|
120
133
|
/**
|
|
@@ -129,25 +142,20 @@ export interface OpenDocument {
|
|
|
129
142
|
}
|
|
130
143
|
|
|
131
144
|
/**
|
|
132
|
-
*
|
|
133
|
-
*
|
|
134
|
-
*
|
|
135
|
-
*
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
readonly contentHash: string;
|
|
142
|
-
}
|
|
143
|
-
|
|
144
|
-
/**
|
|
145
|
-
* Upper bound on {@link HydraniumTextDocuments.__pendingPushes} entries
|
|
146
|
-
* per URI. Echoes normally return within milliseconds and consume their
|
|
147
|
-
* entry; a queue this deep means the client stopped echoing — cap instead
|
|
148
|
-
* of leaking.
|
|
145
|
+
* What {@link HydraniumTextDocuments.commitRepair} did with an integrity repair.
|
|
146
|
+
*
|
|
147
|
+
* Three outcomes rather than a document-or-nothing, because the two ways of
|
|
148
|
+
* getting nothing call for opposite responses: `not-open` means there is no
|
|
149
|
+
* store document to correct and the caller carries on with the one it holds,
|
|
150
|
+
* while `stale` means there IS one and it has moved past the text the repair
|
|
151
|
+
* was computed against — so carrying on would persist a correction over an edit
|
|
152
|
+
* that superseded it. Collapsing them lets the second read as permission to
|
|
153
|
+
* proceed, which is the failure this shape exists to make unrepresentable.
|
|
149
154
|
*/
|
|
150
|
-
|
|
155
|
+
export type RepairCommit<T extends TextDocument> =
|
|
156
|
+
| { readonly status: 'committed'; readonly document: T }
|
|
157
|
+
| { readonly status: 'stale' }
|
|
158
|
+
| { readonly status: 'not-open' };
|
|
151
159
|
|
|
152
160
|
/**
|
|
153
161
|
* The one field of `vscode-languageserver`'s `Connection` this class has to
|
|
@@ -159,182 +167,137 @@ interface ConnectionWithTextDocumentSync {
|
|
|
159
167
|
}
|
|
160
168
|
|
|
161
169
|
/**
|
|
162
|
-
*
|
|
163
|
-
*
|
|
164
|
-
*
|
|
165
|
-
|
|
166
|
-
interface PendingPush {
|
|
167
|
-
/**
|
|
168
|
-
* The text the client held BEFORE this push — the shadow baseline the
|
|
169
|
-
* push's edits were diffed against, and therefore the text the client's
|
|
170
|
-
* echo addresses with its ranges.
|
|
171
|
-
*
|
|
172
|
-
* `undefined` when the push was a full replace sent with no baseline (a
|
|
173
|
-
* first sync, or the recovery push after a rejection). There is then no
|
|
174
|
-
* knowing what the client held, so the echo is reconstructed against the
|
|
175
|
-
* synced text instead — which is sound for a full replace, whose
|
|
176
|
-
* application is position-independent.
|
|
177
|
-
*/
|
|
178
|
-
readonly before: string | undefined;
|
|
179
|
-
/** {@link contentHash} of the text this push moves the client to. */
|
|
180
|
-
readonly afterHash: string;
|
|
181
|
-
}
|
|
182
|
-
|
|
183
|
-
/**
|
|
184
|
-
* What an incoming language-client change turns out to be once reconstructed
|
|
185
|
-
* against the pushes still in flight — the return of
|
|
186
|
-
* {@link HydraniumTextDocuments.classifyLanguageClientChange}.
|
|
187
|
-
*/
|
|
188
|
-
type LanguageClientChangeOrigin =
|
|
189
|
-
/** The client is reporting a text we pushed it. The synced document is already there. */
|
|
190
|
-
| { readonly kind: 'echo' }
|
|
191
|
-
/**
|
|
192
|
-
* The client's buffer has moved somewhere we did not push it — it coalesced
|
|
193
|
-
* a genuine keystroke into the echo, or typed before the push arrived. The
|
|
194
|
-
* reconstructed text is what it now holds, and is authoritative.
|
|
195
|
-
*/
|
|
196
|
-
| { readonly kind: 'divergent'; readonly text: string };
|
|
197
|
-
|
|
198
|
-
/**
|
|
199
|
-
* Cheap, stable, non-cryptographic content hash (cyrb53) for the version
|
|
200
|
-
* sequence's "did the content change across close/reopen?" question. Only
|
|
201
|
-
* needs to be collision-resistant enough that an accidental match across two
|
|
202
|
-
* DIFFERENT revisions of the same file is practically impossible; 53 bits of
|
|
203
|
-
* a well-mixed hash over full text + length gives that without pulling in
|
|
204
|
-
* `node:crypto` (this module must stay runnable in browser hosts).
|
|
205
|
-
*/
|
|
206
|
-
function contentHash(text: string): string {
|
|
207
|
-
let h1 = 0xdeadbeef;
|
|
208
|
-
let h2 = 0x41c6ce57;
|
|
209
|
-
for (let index = 0; index < text.length; index++) {
|
|
210
|
-
const code = text.charCodeAt(index);
|
|
211
|
-
h1 = Math.imul(h1 ^ code, 2654435761);
|
|
212
|
-
h2 = Math.imul(h2 ^ code, 1597334677);
|
|
213
|
-
}
|
|
214
|
-
h1 = Math.imul(h1 ^ (h1 >>> 16), 2246822507);
|
|
215
|
-
h1 ^= Math.imul(h2 ^ (h2 >>> 13), 3266489909);
|
|
216
|
-
h2 = Math.imul(h2 ^ (h2 >>> 16), 2246822507);
|
|
217
|
-
h2 ^= Math.imul(h1 ^ (h1 >>> 13), 3266489909);
|
|
218
|
-
return `${(4294967296 * (2097151 & h2) + (h1 >>> 0)).toString(36)}:${text.length}`;
|
|
219
|
-
}
|
|
220
|
-
|
|
221
|
-
/**
|
|
222
|
-
* Multi-client text-document tracking on top of Langium's `NormalizedTextDocuments`.
|
|
170
|
+
* The one text store every head writes to, on top of Langium's
|
|
171
|
+
* `NormalizedTextDocuments`, and the LSP text-sync endpoint: every
|
|
172
|
+
* `textDocument/*` notification and every `workspace/applyEdit` push goes
|
|
173
|
+
* through here.
|
|
223
174
|
*
|
|
224
|
-
*
|
|
225
|
-
*
|
|
226
|
-
*
|
|
227
|
-
*
|
|
228
|
-
*
|
|
229
|
-
*
|
|
230
|
-
*
|
|
231
|
-
*
|
|
232
|
-
*
|
|
233
|
-
*
|
|
234
|
-
*
|
|
235
|
-
*
|
|
236
|
-
*
|
|
237
|
-
*
|
|
238
|
-
*
|
|
239
|
-
*
|
|
175
|
+
* Each open, change, close and save is one synchronous transition over the
|
|
176
|
+
* held document and the collaborators its `create…` methods build. A
|
|
177
|
+
* collaborator that defers its part lets a listener of the transition's event
|
|
178
|
+
* read state from before it. A document no client holds any more is
|
|
179
|
+
* released to the `DocumentReleaseHandler` slot, after
|
|
180
|
+
* {@link HydraniumTextDocumentsOptions.releaseGraceMs} when its last client's
|
|
181
|
+
* connection was lost.
|
|
182
|
+
*
|
|
183
|
+
* Client-declared version ids feed only the per-client staleness guard and
|
|
184
|
+
* never a running shared sequence: the two count different things, and
|
|
185
|
+
* splicing them lets versions drift past base-version gate holders. A URI
|
|
186
|
+
* with no ledger record and no built root starts at its opener's declared id:
|
|
187
|
+
* no version was handed out for it.
|
|
188
|
+
*
|
|
189
|
+
* `didOpen` notifications arriving over the LSP connection wait on the
|
|
190
|
+
* workspace-ready promise, so a client's first open cannot race workspace
|
|
191
|
+
* discovery. Direct {@link notifyDidOpenTextDocument} calls (the non-LSP
|
|
192
|
+
* heads) do not pass that gate — their caller owns the ordering.
|
|
240
193
|
*/
|
|
241
194
|
export class HydraniumTextDocuments<T extends TextDocument = TextDocument> extends NormalizedTextDocuments<T> {
|
|
242
|
-
/**
|
|
243
|
-
|
|
244
|
-
* membership, version-author history, and integrity-staged pending content,
|
|
245
|
-
* keyed by normalized URI. One record per URI so the last-client close clears
|
|
246
|
-
* every axis atomically. The language-client diff baseline stays in
|
|
247
|
-
* {@link __shadow} (its own abstraction); the parsed-document store stays in
|
|
248
|
-
* the inherited `__syncedDocuments`.
|
|
249
|
-
*/
|
|
250
|
-
protected __documents = new Map<CanonicalUri, DocumentTracking>();
|
|
195
|
+
/** Content staged by integrity rules for a document no client holds, consumed by its first open. */
|
|
196
|
+
protected readonly __pendingContent = new Map<CanonicalUri, string>();
|
|
251
197
|
|
|
252
198
|
/**
|
|
253
|
-
*
|
|
254
|
-
*
|
|
255
|
-
*
|
|
256
|
-
*
|
|
257
|
-
* survive it — the shared version is a server-owned, monotonic,
|
|
258
|
-
* advances-iff-content-changes counter that never resets while the server
|
|
259
|
-
* lives. That invariant is what makes an optimistic `baseVersion` gate
|
|
260
|
-
* sound: "version unchanged ⇔ content unchanged", with no false conflicts
|
|
261
|
-
* from close/reopen version resets and no false passes from a reopened
|
|
262
|
-
* sequence coincidentally landing on a stale writer's number.
|
|
263
|
-
*
|
|
264
|
-
* Never pruned: two small values per URI ever touched — bounded by
|
|
265
|
-
* workspace size, not by activity.
|
|
266
|
-
*/
|
|
267
|
-
protected readonly __versionSequences = new Map<CanonicalUri, VersionSequence>();
|
|
268
|
-
|
|
269
|
-
/**
|
|
270
|
-
* Texts pushed to the LSP textual language client via
|
|
271
|
-
* {@link applyEditToLanguageClient} whose echoes have not come back yet
|
|
272
|
-
* ({@link PendingPush}), keyed like the shadow by language-client URI.
|
|
273
|
-
* Outbound pushes and inbound echoes are uncorrelated on the wire; this
|
|
274
|
-
* FIFO is the explicit correlation, and it is what
|
|
275
|
-
* {@link classifyLanguageClientChange} reconstructs against.
|
|
276
|
-
*
|
|
277
|
-
* **Each entry keeps the client's PRE-push text, not only a hash of the
|
|
278
|
-
* post-push one.** A hash alone can classify a full-text echo, whose
|
|
279
|
-
* application is a no-op either way — and that is all it ever classified,
|
|
280
|
-
* because a conforming client echoes INCREMENTAL ranges keyed to its
|
|
281
|
-
* previous buffer. Those ranges cannot be applied to the synced text (which
|
|
282
|
-
* the authored write already advanced) and cannot be reconstructed without
|
|
283
|
-
* the baseline: the line they insert lands twice, validates cleanly, and
|
|
284
|
-
* compounds on every later edit.
|
|
285
|
-
*
|
|
286
|
-
* Lifecycle: entries are consumed by the matching echo (together with any
|
|
287
|
-
* older entries it supersedes), and the whole queue drops when the client
|
|
288
|
-
* stops being a pure mirror — a divergent change, an `applyEdit`
|
|
289
|
-
* failure/rejection (shadow invalidation), a close, or an explicit
|
|
290
|
-
* shadow (re)baseline. {@link PENDING_ECHO_CAP} bounds the queue against
|
|
291
|
-
* a pathological echo that never arrives; the memory cost until then is
|
|
292
|
-
* one pre-push text per in-flight push, for milliseconds.
|
|
199
|
+
* Which client has which document open, which client ids are registered
|
|
200
|
+
* sessions, and each client's declared version, the staleness guard's
|
|
201
|
+
* baseline. Every open-state predicate on this class reads it, so an open
|
|
202
|
+
* recorded anywhere else is invisible to the last-close transition.
|
|
293
203
|
*/
|
|
294
|
-
protected readonly
|
|
204
|
+
protected readonly __sessions = new ClientSessionRegistry();
|
|
295
205
|
|
|
296
|
-
/**
|
|
297
|
-
|
|
298
|
-
* Owned here so {@link applyEditToLanguageClient} can compute minimal `workspace/applyEdit`
|
|
299
|
-
* diffs instead of full-document replaces (5–20 s → <500 ms on 20-30 KB YAML diagrams).
|
|
300
|
-
*
|
|
301
|
-
* Auto-tracked from the multi-client text-document events: open / change / close of
|
|
302
|
-
* the language client (re)baseline or invalidate the shadow. Other client ids
|
|
303
|
-
* (form editor, GLSP, integrity) do NOT touch the shadow — only what Monaco believes
|
|
304
|
-
* it has matters for the diff.
|
|
305
|
-
*
|
|
306
|
-
* Apply-verify safety net is built in: if the diff doesn't reconstruct `newText`
|
|
307
|
-
* exactly, {@link LanguageClientTextShadow.computeEdits} falls back to a full-range
|
|
308
|
-
* replace and invokes the `onFallback` callback — a diff regression becomes log
|
|
309
|
-
* noise, not a 0-byte save.
|
|
310
|
-
*
|
|
311
|
-
* Assigned in the constructor body so the `onFallback` callback can capture
|
|
312
|
-
* `this.logger` after the parameter-property assignment has run (field
|
|
313
|
-
* initializers fire BEFORE parameter-property assignment in TS).
|
|
314
|
-
*/
|
|
315
|
-
protected readonly __shadow: LanguageClientTextShadow;
|
|
206
|
+
/** The version each open document was opened at; see {@link openedVersion}. */
|
|
207
|
+
protected readonly __openedVersions = new Map<CanonicalUri, TextVersion>();
|
|
316
208
|
|
|
317
209
|
protected readonly tracer: Tracer;
|
|
318
210
|
protected readonly configuration: TextDocumentsConfiguration<T>;
|
|
211
|
+
protected __textLedger: TextLedger | undefined;
|
|
212
|
+
protected __languageClientShadow: LanguageClientShadow | undefined;
|
|
213
|
+
protected __dirtyStateTracker: DirtyStateTracker | undefined;
|
|
214
|
+
protected __documentReleaseScheduler: DocumentReleaseScheduler | undefined;
|
|
215
|
+
protected readonly documentReleasedEmitter = new Emitter<DocumentReleasedEvent>();
|
|
216
|
+
protected readonly languageClientSavedEmitter = new Emitter<LanguageClientSavedEvent>();
|
|
319
217
|
|
|
320
218
|
constructor(
|
|
321
219
|
protected services: ServerSharedServices,
|
|
322
|
-
options: HydraniumTextDocumentsOptions<T> = {}
|
|
220
|
+
protected readonly options: HydraniumTextDocumentsOptions<T> = {}
|
|
323
221
|
) {
|
|
324
222
|
const configuration = options.configuration ?? (TextDocument as unknown as TextDocumentsConfiguration<T>);
|
|
325
223
|
super(configuration);
|
|
326
224
|
this.configuration = configuration;
|
|
327
225
|
this.tracer = services.Tracer.for(options.logName ?? 'TextDocuments').trace('instantiated');
|
|
328
|
-
this.__shadow = new LanguageClientTextShadow(
|
|
329
|
-
(uri, reason) => this.tracer.with(uri).warn(`Diff apply-verify fallback (${reason}) — using full-document replace`),
|
|
330
|
-
this
|
|
331
|
-
);
|
|
332
226
|
}
|
|
333
227
|
|
|
334
|
-
//
|
|
335
|
-
//
|
|
336
|
-
|
|
337
|
-
|
|
228
|
+
// Each collaborator is built on first use, after every constructor has run,
|
|
229
|
+
// so a create method may read its subclass's fields and the other collaborators.
|
|
230
|
+
|
|
231
|
+
protected get textLedger(): TextLedger {
|
|
232
|
+
return (this.__textLedger ??= this.createTextLedger());
|
|
233
|
+
}
|
|
234
|
+
|
|
235
|
+
protected get languageClientShadow(): LanguageClientShadow {
|
|
236
|
+
return (this.__languageClientShadow ??= this.createLanguageClientShadow());
|
|
237
|
+
}
|
|
238
|
+
|
|
239
|
+
protected get dirtyStateTracker(): DirtyStateTracker {
|
|
240
|
+
return (this.__dirtyStateTracker ??= this.createDirtyStateTracker());
|
|
241
|
+
}
|
|
242
|
+
|
|
243
|
+
protected get documentReleaseScheduler(): DocumentReleaseScheduler {
|
|
244
|
+
return (this.__documentReleaseScheduler ??= this.createDocumentReleaseScheduler());
|
|
245
|
+
}
|
|
246
|
+
|
|
247
|
+
protected createTextLedger(): TextLedger {
|
|
248
|
+
return new DefaultTextLedger();
|
|
249
|
+
}
|
|
250
|
+
|
|
251
|
+
protected createLanguageClientShadow(): LanguageClientShadow {
|
|
252
|
+
return new DefaultLanguageClientShadow(this, this.tracer);
|
|
253
|
+
}
|
|
254
|
+
|
|
255
|
+
protected createDirtyStateTracker(): DirtyStateTracker {
|
|
256
|
+
return new DefaultDirtyStateTracker(this.textLedger);
|
|
257
|
+
}
|
|
258
|
+
|
|
259
|
+
protected createDocumentReleaseScheduler(): DocumentReleaseScheduler {
|
|
260
|
+
return new DefaultDocumentReleaseScheduler(this.services.Clock, this.options.releaseGraceMs ?? DEFAULT_RELEASE_GRACE_MS);
|
|
261
|
+
}
|
|
262
|
+
|
|
263
|
+
/** Hold `document` as the text of `key`, a new version authored by `author`. */
|
|
264
|
+
protected commitText(key: CanonicalUri, document: T, author: string): void {
|
|
265
|
+
this.__syncedDocuments.set(key, document);
|
|
266
|
+
this.setAuthor(key, document.version, author);
|
|
267
|
+
this.dirtyStateTracker.refreshDirty(key, document);
|
|
268
|
+
}
|
|
269
|
+
|
|
270
|
+
/**
|
|
271
|
+
* Apply `changes` to `document`, the held text of `key`, and hold the
|
|
272
|
+
* result. The version steps only when the text changes, which is what a
|
|
273
|
+
* base-version gate relies on: unchanged text keeps its version and its
|
|
274
|
+
* author. The new text is known only once the changes are applied, so they
|
|
275
|
+
* go in at a tentative step that an identical result rolls back.
|
|
276
|
+
*/
|
|
277
|
+
protected commitChange(
|
|
278
|
+
key: CanonicalUri,
|
|
279
|
+
document: T,
|
|
280
|
+
changes: TextDocumentContentChangeEvent[],
|
|
281
|
+
author: string
|
|
282
|
+
): { document: T; changed: boolean } {
|
|
283
|
+
const previousText = document.getText();
|
|
284
|
+
const version = document.version;
|
|
285
|
+
let next = this.update(document, changes, version + 1);
|
|
286
|
+
const changed = next.getText() !== previousText;
|
|
287
|
+
if (changed) {
|
|
288
|
+
this.commitText(key, next, author);
|
|
289
|
+
} else {
|
|
290
|
+
// An empty-changes update only re-stamps the version.
|
|
291
|
+
next = this.update(next, [], version);
|
|
292
|
+
this.__syncedDocuments.set(key, next);
|
|
293
|
+
}
|
|
294
|
+
return { document: next, changed };
|
|
295
|
+
}
|
|
296
|
+
|
|
297
|
+
// The configuration's factories. Every document the store makes or changes
|
|
298
|
+
// goes through them, so an override sees each call: the store's own writes,
|
|
299
|
+
// callers outside the didOpen/didChange flow, and the shadow's throwaway
|
|
300
|
+
// probes, at version 0 under a client URI.
|
|
338
301
|
|
|
339
302
|
public create(uri: string, languageId: string, version: number, content: string): T {
|
|
340
303
|
return this.configuration.create(uri, languageId, version, content);
|
|
@@ -403,7 +366,7 @@ export class HydraniumTextDocuments<T extends TextDocument = TextDocument> exten
|
|
|
403
366
|
const disposables = new DisposableCollection();
|
|
404
367
|
disposables.push(
|
|
405
368
|
connection.onDidOpenTextDocument(async (event: DidOpenTextDocumentParams) => {
|
|
406
|
-
await this.
|
|
369
|
+
await this.initialBuildFinished();
|
|
407
370
|
this.notifyDidOpenTextDocument(event);
|
|
408
371
|
})
|
|
409
372
|
);
|
|
@@ -429,7 +392,7 @@ export class HydraniumTextDocuments<T extends TextDocument = TextDocument> exten
|
|
|
429
392
|
);
|
|
430
393
|
disposables.push(
|
|
431
394
|
connection.onDidSaveTextDocument((event: DidSaveTextDocumentParams) => {
|
|
432
|
-
this.
|
|
395
|
+
void this.notifyLanguageClientSave(event);
|
|
433
396
|
})
|
|
434
397
|
);
|
|
435
398
|
return disposables;
|
|
@@ -450,84 +413,64 @@ export class HydraniumTextDocuments<T extends TextDocument = TextDocument> exten
|
|
|
450
413
|
const uri = this.documentKey(td.uri);
|
|
451
414
|
let document = this.__syncedDocuments.get(uri);
|
|
452
415
|
if (document !== undefined) {
|
|
453
|
-
//
|
|
454
|
-
//
|
|
455
|
-
//
|
|
456
|
-
//
|
|
457
|
-
//
|
|
458
|
-
//
|
|
459
|
-
//
|
|
460
|
-
|
|
461
|
-
|
|
462
|
-
const
|
|
463
|
-
|
|
416
|
+
// Client version ids are the client's own, so compared against what
|
|
417
|
+
// that client declared, never against the shared version: an authored
|
|
418
|
+
// write advances that without the client knowing, and gating on it
|
|
419
|
+
// drops real edits. The editor is checked per URI, since each is its
|
|
420
|
+
// own buffer; its client-wide entry is only the fallback for a URI it
|
|
421
|
+
// never opened, and may name another URI's buffer. A client with no
|
|
422
|
+
// baseline falls back to the shared version.
|
|
423
|
+
const clientUri = this.toLanguageClientUri(td.uri);
|
|
424
|
+
const editor = clientId === LANGUAGE_CLIENT_ID;
|
|
425
|
+
const lastSeen =
|
|
426
|
+
(editor ? this.languageClientShadow.declaredVersion(uri, clientUri) : undefined) ??
|
|
427
|
+
this.__sessions.clientVersionOf(uri, clientId) ??
|
|
428
|
+
document.version;
|
|
464
429
|
if (lastSeen >= td.version) {
|
|
465
430
|
// Distinguish "already at this version" (common: an echo from the client that triggered
|
|
466
431
|
// the update) from "incoming version older than ours" (stale race).
|
|
467
432
|
const reason =
|
|
468
433
|
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');
|
|
434
|
+
this.logUri(uri, `Ignore update by ${this.formatClientId(clientId)}: ${reason}`, 'debug');
|
|
470
435
|
return;
|
|
471
436
|
}
|
|
472
|
-
|
|
473
|
-
|
|
474
|
-
//
|
|
475
|
-
//
|
|
476
|
-
//
|
|
477
|
-
//
|
|
478
|
-
const
|
|
479
|
-
|
|
480
|
-
|
|
481
|
-
|
|
482
|
-
|
|
483
|
-
//
|
|
484
|
-
//
|
|
485
|
-
//
|
|
486
|
-
// per-client baseline advanced above (the client's ids keep
|
|
487
|
-
// counting); the shadow is deliberately NOT touched — it
|
|
488
|
-
// optimistically tracks the NEWEST pushed text, and dragging it
|
|
489
|
-
// back would make the next outbound diff wrong against what the
|
|
490
|
-
// client actually holds.
|
|
437
|
+
this.__sessions.setClientVersion(uri, clientId, td.version);
|
|
438
|
+
|
|
439
|
+
// An editor change is keyed to the buffer the editor holds, which is
|
|
440
|
+
// the synced text only while the two agree — an authored write
|
|
441
|
+
// advances the synced text without the editor knowing, and a push in
|
|
442
|
+
// flight moves the editor without the store knowing.
|
|
443
|
+
const verdict: LanguageClientChangeVerdict = editor
|
|
444
|
+
? this.languageClientShadow.acceptChange(uri, clientUri, td.version, document, changes)
|
|
445
|
+
: { kind: 'direct' };
|
|
446
|
+
if (verdict.kind === 'echo') {
|
|
447
|
+
// The synced document is already there, so the changes must not be
|
|
448
|
+
// applied a second time: nothing is minted and no rebuild fires. The
|
|
449
|
+
// shadow keeps the newest pushed text, which is what the next
|
|
450
|
+
// outbound diff has to be keyed to.
|
|
491
451
|
this.logUri(uri, `Skip rebuild: echo of a server-authored push (client version ${td.version})`, 'debug');
|
|
492
452
|
return;
|
|
493
453
|
}
|
|
494
454
|
|
|
495
|
-
//
|
|
496
|
-
//
|
|
497
|
-
//
|
|
498
|
-
|
|
499
|
-
|
|
500
|
-
|
|
501
|
-
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
|
|
505
|
-
|
|
506
|
-
document = this.configuration.update(document, inFlight === undefined ? changes : [{ text: inFlight.text }], sharedVersion + 1);
|
|
507
|
-
const changed = document.getText() !== previousText;
|
|
508
|
-
if (!changed) {
|
|
509
|
-
document = this.configuration.update(document, [], sharedVersion);
|
|
510
|
-
}
|
|
511
|
-
this.__syncedDocuments.set(uri, document);
|
|
512
|
-
if (changed) {
|
|
513
|
-
this.setAuthor(uri, document.version, clientId);
|
|
514
|
-
}
|
|
515
|
-
if (clientId === LANGUAGE_CLIENT_ID) {
|
|
516
|
-
// Monaco just told us about its new content; record it so the next outbound
|
|
517
|
-
// applyEditToLanguageClient diffs against the right baseline. Keyed by the
|
|
518
|
-
// language-client URI (what Monaco holds), not the canonical document key.
|
|
519
|
-
this.__shadow.set(this.toLanguageClientUri(td.uri), document.getText());
|
|
520
|
-
// Content-identical echo: the language client is echoing text we already had
|
|
521
|
-
// (e.g. Monaco re-emitting a server-pushed applyEditToLanguageClient). The model is
|
|
522
|
-
// unchanged, so skip the rebuild. The per-client baseline + shadow still advanced
|
|
523
|
-
// above so future staleness checks and diffs are correct. Restricted to the
|
|
524
|
-
// language client: a ModelService-authored change is never skipped.
|
|
525
|
-
if (!changed) {
|
|
455
|
+
// A divergent change is applied as its reconstructed text rather than
|
|
456
|
+
// as its own ranges: those ranges address the editor's own buffer, so
|
|
457
|
+
// applying them here would splice the wrong lines.
|
|
458
|
+
const committed = this.commitChange(uri, document, verdict.kind === 'direct' ? changes : [{ text: verdict.text }], clientId);
|
|
459
|
+
document = committed.document;
|
|
460
|
+
if (editor) {
|
|
461
|
+
this.languageClientShadow.setClientText(clientUri, document.getText());
|
|
462
|
+
// Content-identical echo: the editor is echoing text we already had.
|
|
463
|
+
// The model is unchanged, so skip the rebuild. Restricted to the
|
|
464
|
+
// editor: a ModelService-authored change is never skipped.
|
|
465
|
+
if (!committed.changed) {
|
|
526
466
|
this.logUri(uri, `Skip rebuild: content unchanged (echo at client version ${td.version})`, 'debug');
|
|
527
467
|
return;
|
|
528
468
|
}
|
|
529
469
|
}
|
|
530
|
-
this.log(
|
|
470
|
+
this.log(
|
|
471
|
+
document.uri,
|
|
472
|
+
`Update to version ${document.version} by ${this.formatClientId(clientId)}${committed.changed ? '' : ' (content unchanged)'}`
|
|
473
|
+
);
|
|
531
474
|
this.__onDidChangeContent.fire(Object.freeze({ document, clientId }));
|
|
532
475
|
}
|
|
533
476
|
}
|
|
@@ -544,73 +487,181 @@ export class HydraniumTextDocuments<T extends TextDocument = TextDocument> exten
|
|
|
544
487
|
* A content-identical write still fires the change event (rebuild): the
|
|
545
488
|
* authored write's server-side rebuild is correctness-bearing, it just
|
|
546
489
|
* mints no new version — nothing observable changed, so watchers'
|
|
547
|
-
*
|
|
490
|
+
* base versions stay valid.
|
|
548
491
|
*
|
|
549
492
|
* Returns the resulting shared version. Throws when the document is not
|
|
550
493
|
* open — callers (`AstDocumentManager.update`) open first.
|
|
551
494
|
*/
|
|
552
|
-
applyContentChange(uri: DocumentUri, text: string, clientId: string):
|
|
495
|
+
applyContentChange(uri: DocumentUri, text: string, clientId: string): TextVersion {
|
|
553
496
|
const key = this.documentKey(uri);
|
|
554
|
-
|
|
555
|
-
if (
|
|
497
|
+
const synced = this.__syncedDocuments.get(key);
|
|
498
|
+
if (synced === undefined) {
|
|
556
499
|
throw new Error(`Document ${uri} is not open for content changes`);
|
|
557
500
|
}
|
|
558
|
-
|
|
559
|
-
|
|
560
|
-
document
|
|
561
|
-
|
|
562
|
-
|
|
563
|
-
|
|
564
|
-
|
|
501
|
+
// Unchanged text calls no update: a configuration may return a new document for one.
|
|
502
|
+
const { document, changed } =
|
|
503
|
+
synced.getText() === text ? { document: synced, changed: false } : this.commitChange(key, synced, [{ text }], clientId);
|
|
504
|
+
this.log(
|
|
505
|
+
document.uri,
|
|
506
|
+
`Update to version ${document.version} by ${this.formatClientId(clientId)}${changed ? '' : ' (content unchanged)'}`
|
|
507
|
+
);
|
|
565
508
|
this.__onDidChangeContent.fire(Object.freeze({ document, clientId }));
|
|
566
509
|
return document.version;
|
|
567
510
|
}
|
|
568
511
|
|
|
569
|
-
|
|
512
|
+
/**
|
|
513
|
+
* Close `clientId`'s open of the document. When it was the last open, the
|
|
514
|
+
* document is released, at once or, for a `'lost'`
|
|
515
|
+
* close, after {@link HydraniumTextDocumentsOptions.releaseGraceMs}.
|
|
516
|
+
*/
|
|
517
|
+
public notifyDidCloseTextDocument(
|
|
518
|
+
event: DidCloseTextDocumentParams,
|
|
519
|
+
clientId = LANGUAGE_CLIENT_ID,
|
|
520
|
+
cause: SessionEndCause = 'closed'
|
|
521
|
+
): void {
|
|
570
522
|
const uri = this.documentKey(event.textDocument.uri);
|
|
571
|
-
if (
|
|
523
|
+
if (clientId === LANGUAGE_CLIENT_ID) {
|
|
524
|
+
const clientUri = this.toLanguageClientUri(event.textDocument.uri);
|
|
525
|
+
// A close under a URI the editor never opened the document under ends its hold.
|
|
526
|
+
if (this.languageClientShadow.isOpen(uri, clientUri)) {
|
|
527
|
+
this.languageClientShadow.removeOpen(uri, clientUri);
|
|
528
|
+
} else {
|
|
529
|
+
this.languageClientShadow.removeAllOpens(uri);
|
|
530
|
+
}
|
|
531
|
+
// Another URI still holds the document, so only this one's buffer goes.
|
|
532
|
+
if (this.languageClientShadow.isOpen(uri)) {
|
|
533
|
+
return;
|
|
534
|
+
}
|
|
535
|
+
}
|
|
536
|
+
if (!this.__sessions.removeOpen(uri, clientId)) {
|
|
572
537
|
return;
|
|
573
538
|
}
|
|
574
|
-
|
|
575
|
-
|
|
576
|
-
|
|
539
|
+
if (cause === 'lost') {
|
|
540
|
+
this.documentReleaseScheduler.recordLoss(uri, clientId);
|
|
541
|
+
}
|
|
577
542
|
const syncedDocument = this.__syncedDocuments.get(uri);
|
|
578
543
|
if (syncedDocument !== undefined) {
|
|
579
|
-
this.log(syncedDocument.uri, `Closed synced document: ${syncedDocument.version} by ${clientId}`);
|
|
544
|
+
this.log(syncedDocument.uri, `Closed synced document: ${syncedDocument.version} by ${this.formatClientId(clientId)}`);
|
|
580
545
|
this.__onDidClose.fire(Object.freeze({ document: syncedDocument, clientId }));
|
|
581
|
-
|
|
582
|
-
|
|
583
|
-
|
|
584
|
-
|
|
585
|
-
|
|
586
|
-
|
|
587
|
-
this.__documents.get(uri)?.languageClientUris?.delete(droppedUri);
|
|
588
|
-
this.__shadow.invalidate(droppedUri);
|
|
589
|
-
this.__pendingPushes.delete(droppedUri);
|
|
546
|
+
if (!this.isOpenInAnyClient(uri)) {
|
|
547
|
+
if (cause === 'lost') {
|
|
548
|
+
this.deferRelease(uri);
|
|
549
|
+
} else {
|
|
550
|
+
this.releaseDocument(uri);
|
|
551
|
+
}
|
|
590
552
|
}
|
|
591
|
-
|
|
592
|
-
|
|
593
|
-
|
|
594
|
-
|
|
595
|
-
|
|
596
|
-
|
|
597
|
-
|
|
598
|
-
|
|
599
|
-
|
|
600
|
-
|
|
601
|
-
|
|
602
|
-
|
|
603
|
-
|
|
604
|
-
|
|
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);
|
|
553
|
+
}
|
|
554
|
+
}
|
|
555
|
+
|
|
556
|
+
/**
|
|
557
|
+
* Keep the document, text and all, for the release grace, then release it.
|
|
558
|
+
* The document stays in the store meanwhile, so a lost client that opens it
|
|
559
|
+
* again within its own grace attaches to it and finds its unsaved text
|
|
560
|
+
* rather than reading disk; see {@link resolveDeferredRelease} for any other
|
|
561
|
+
* open.
|
|
562
|
+
*/
|
|
563
|
+
protected deferRelease(uri: CanonicalUri): void {
|
|
564
|
+
this.documentReleaseScheduler.defer(uri, () => {
|
|
565
|
+
if (!this.isOpenInAnyClient(uri)) {
|
|
566
|
+
this.releaseDocument(uri);
|
|
610
567
|
}
|
|
568
|
+
});
|
|
569
|
+
if (this.documentReleaseScheduler.isDeferred(uri)) {
|
|
570
|
+
this.log(uri, `No client left; release deferred for ${this.documentReleaseScheduler.graceMs} ms (connection lost)`);
|
|
571
|
+
}
|
|
572
|
+
}
|
|
573
|
+
|
|
574
|
+
/** Resolve a deferred release of `uri` for an open by `clientId`: a release the scheduler decides on runs now. */
|
|
575
|
+
protected resolveDeferredRelease(uri: CanonicalUri, clientId: string): void {
|
|
576
|
+
if (this.documentReleaseScheduler.resolveOpen(uri, clientId) === 'release') {
|
|
577
|
+
this.releaseDocument(uri);
|
|
611
578
|
}
|
|
612
579
|
}
|
|
613
580
|
|
|
581
|
+
/**
|
|
582
|
+
* Drop the document no client has open any more, announce it on
|
|
583
|
+
* {@link onDidReleaseDocument}, then hand it to the
|
|
584
|
+
* `DocumentReleaseHandler` slot: its listeners, such as the update
|
|
585
|
+
* handler dropping a change it still holds back, act before any build the
|
|
586
|
+
* handler runs.
|
|
587
|
+
*/
|
|
588
|
+
protected releaseDocument(uri: CanonicalUri): void {
|
|
589
|
+
const syncedDocument = this.__syncedDocuments.get(uri);
|
|
590
|
+
if (syncedDocument === undefined) {
|
|
591
|
+
return;
|
|
592
|
+
}
|
|
593
|
+
this.log(syncedDocument.uri, `Remove synced document: ${syncedDocument.version} (no client left)`);
|
|
594
|
+
// The next open continues the sequence instead of restarting at the
|
|
595
|
+
// reopening client's declared id.
|
|
596
|
+
this.textLedger.record(uri, syncedDocument);
|
|
597
|
+
this.textLedger.clearAuthors(uri);
|
|
598
|
+
const cleanAnnouncement = this.dirtyStateTracker.release(uri);
|
|
599
|
+
this.__syncedDocuments.delete(uri);
|
|
600
|
+
this.__openedVersions.delete(uri);
|
|
601
|
+
this.__sessions.forgetClientVersions(uri);
|
|
602
|
+
// A stage is for a first open; one released unconsumed is stale.
|
|
603
|
+
this.__pendingContent.delete(uri);
|
|
604
|
+
this.documentReleaseScheduler.clearLosses(uri);
|
|
605
|
+
this.documentReleasedEmitter.fire(Object.freeze({ uri }));
|
|
606
|
+
this.handOverRelease(this.toReleasedDocument(uri), cleanAnnouncement);
|
|
607
|
+
}
|
|
608
|
+
|
|
609
|
+
/**
|
|
610
|
+
* Call the `DocumentReleaseHandler` slot, and announce a document released
|
|
611
|
+
* dirty clean once the promise it returns settles, which is after the
|
|
612
|
+
* release event. A failure is logged rather than thrown: the store has let
|
|
613
|
+
* go of the document by now, and a throw would abort the transition that
|
|
614
|
+
* released it, a session's close of its other documents included.
|
|
615
|
+
*/
|
|
616
|
+
protected handOverRelease(released: ReleasedDocument, cleanAnnouncement: CleanAnnouncement | undefined): void {
|
|
617
|
+
let settled: Promise<void>;
|
|
618
|
+
try {
|
|
619
|
+
// Read here: a lazily built slot whose factory throws throws on this read.
|
|
620
|
+
const handler = this.services.workspace.DocumentReleaseHandler;
|
|
621
|
+
settled =
|
|
622
|
+
handler === undefined
|
|
623
|
+
? Promise.reject(new Error('no workspace.DocumentReleaseHandler bound'))
|
|
624
|
+
: Promise.resolve(handler.didReleaseDocument(released));
|
|
625
|
+
} catch (err: unknown) {
|
|
626
|
+
settled = Promise.reject(err);
|
|
627
|
+
}
|
|
628
|
+
// Names the text the build holds at the settle, so it follows anything a
|
|
629
|
+
// release listener did meanwhile: none when its build failed or it no
|
|
630
|
+
// longer has the document, since a removal leaves the record on the
|
|
631
|
+
// discarded text.
|
|
632
|
+
const announceClean = (built: boolean): void => {
|
|
633
|
+
if (cleanAnnouncement?.isOwed()) {
|
|
634
|
+
const inBuild = built && this.services.workspace.LangiumDocuments.getDocument(UriUtils.toUri(released.uri)) !== undefined;
|
|
635
|
+
cleanAnnouncement.announce(inBuild ? this.textState(released.uri) : undefined);
|
|
636
|
+
}
|
|
637
|
+
};
|
|
638
|
+
settled.then(
|
|
639
|
+
() => announceClean(true),
|
|
640
|
+
(err: unknown) => {
|
|
641
|
+
// A release skipped at teardown, its peer or its workspace gone, is
|
|
642
|
+
// routine, not a fault to investigate.
|
|
643
|
+
if (isDocumentReleaseSkippedError(err)) {
|
|
644
|
+
this.tracer.with(released.uri).debug(err.message);
|
|
645
|
+
} else {
|
|
646
|
+
this.tracer
|
|
647
|
+
.with(released.uri)
|
|
648
|
+
.error(`Release handler failed. ${err instanceof Error ? (err.stack ?? err.message) : String(err)}`);
|
|
649
|
+
}
|
|
650
|
+
// Left unsettled, a watcher keeps the document dirty though the store answers clean.
|
|
651
|
+
announceClean(false);
|
|
652
|
+
}
|
|
653
|
+
);
|
|
654
|
+
}
|
|
655
|
+
|
|
656
|
+
/** `uri` as the `DocumentReleaseHandler` slot receives it. */
|
|
657
|
+
protected toReleasedDocument(uri: CanonicalUri): ReleasedDocument {
|
|
658
|
+
return {
|
|
659
|
+
uri,
|
|
660
|
+
isFor: other => this.documentKey(other) === uri,
|
|
661
|
+
isReclaimed: () => this.isOpenInAnyClient(uri) || this.__syncedDocuments.has(uri)
|
|
662
|
+
};
|
|
663
|
+
}
|
|
664
|
+
|
|
614
665
|
public notifyWillSaveTextDocument(event: WillSaveTextDocumentParams): void {
|
|
615
666
|
const syncedDocument = this.__syncedDocuments.get(this.documentKey(event.textDocument.uri));
|
|
616
667
|
if (syncedDocument !== undefined) {
|
|
@@ -630,93 +681,178 @@ export class HydraniumTextDocuments<T extends TextDocument = TextDocument> exten
|
|
|
630
681
|
}
|
|
631
682
|
}
|
|
632
683
|
|
|
684
|
+
/**
|
|
685
|
+
* Handle a save the language client reports: fire
|
|
686
|
+
* {@link onDidSaveInLanguageClient}, then announce it on {@link onDidSave}
|
|
687
|
+
* only once the file read back from disk holds the store's current text.
|
|
688
|
+
*/
|
|
689
|
+
protected async notifyLanguageClientSave(event: DidSaveTextDocumentParams): Promise<void> {
|
|
690
|
+
const syncedDocument = this.__syncedDocuments.get(this.documentKey(event.textDocument.uri));
|
|
691
|
+
if (syncedDocument === undefined) {
|
|
692
|
+
return;
|
|
693
|
+
}
|
|
694
|
+
const uri = syncedDocument.uri;
|
|
695
|
+
this.languageClientSavedEmitter.fire(Object.freeze({ uri }));
|
|
696
|
+
// `onDidSave` tells its listeners that the shared document is on disk.
|
|
697
|
+
// The editor wrote its own buffer, which lags the store while another
|
|
698
|
+
// client's edit is still on its way to it, so only the file says
|
|
699
|
+
// whether that holds. Read it rather than trust the editor: `didSave`
|
|
700
|
+
// carries text only for a client that honours `includeText`, and asking
|
|
701
|
+
// for it means rewriting Langium's initialize answer, which advertises
|
|
702
|
+
// `save` as a Boolean. The read goes through the disk queue and waits on
|
|
703
|
+
// nothing but the provider, so it follows a server save queued
|
|
704
|
+
// meanwhile. A file changed again between the editor's write and this
|
|
705
|
+
// read compares unequal, and the save goes unannounced.
|
|
706
|
+
let onDisk: string | undefined;
|
|
707
|
+
try {
|
|
708
|
+
onDisk = await this.services.workspace.FileSystemTaskQueue.enqueue(uri, () =>
|
|
709
|
+
this.services.workspace.FileSystemProvider.readFile(UriUtils.toUri(uri))
|
|
710
|
+
);
|
|
711
|
+
} catch (err: unknown) {
|
|
712
|
+
this.tracer
|
|
713
|
+
.with(uri)
|
|
714
|
+
.debug(`Editor save not announced: reading the file back failed. ${err instanceof Error ? err.message : String(err)}`);
|
|
715
|
+
return;
|
|
716
|
+
}
|
|
717
|
+
// What the file holds, not what the editor meant to write: an editor
|
|
718
|
+
// that saved older text leaves the document dirty.
|
|
719
|
+
this.setDiskBaseline(uri, onDisk);
|
|
720
|
+
// An editor that saves and then closes releases the document while the
|
|
721
|
+
// read is under way; its save is still a save of the text it held.
|
|
722
|
+
const document = this.__syncedDocuments.get(this.documentKey(uri)) ?? syncedDocument;
|
|
723
|
+
if (onDisk !== document.getText()) {
|
|
724
|
+
this.tracer.with(uri).debug(`Editor save not announced: the file does not hold the text of version ${document.version}`);
|
|
725
|
+
return;
|
|
726
|
+
}
|
|
727
|
+
this.announceSave(document, LANGUAGE_CLIENT_ID);
|
|
728
|
+
}
|
|
729
|
+
|
|
730
|
+
/**
|
|
731
|
+
* Announce a save the server made. `event.text`, when given, is what the
|
|
732
|
+
* file now holds, written or found there, and becomes the disk baseline
|
|
733
|
+
* before the save is announced. It lags the store when an edit landed
|
|
734
|
+
* after the save took its text, and the document then stays dirty.
|
|
735
|
+
*/
|
|
633
736
|
public notifyDidSaveTextDocument(event: DidSaveTextDocumentParams, clientId = LANGUAGE_CLIENT_ID): void {
|
|
634
737
|
const syncedDocument = this.__syncedDocuments.get(this.documentKey(event.textDocument.uri));
|
|
635
738
|
if (syncedDocument !== undefined) {
|
|
636
|
-
|
|
637
|
-
|
|
739
|
+
if (event.text !== undefined) {
|
|
740
|
+
this.setDiskBaseline(syncedDocument.uri, event.text);
|
|
741
|
+
}
|
|
742
|
+
this.announceSave(syncedDocument, clientId);
|
|
638
743
|
}
|
|
639
744
|
}
|
|
640
745
|
|
|
746
|
+
/** Fire {@link onDidSave} for `document`, which need not be synced any more. */
|
|
747
|
+
protected announceSave(document: T, clientId: string): void {
|
|
748
|
+
this.log(document.uri, `Saved synced document: ${document.version} by ${this.formatClientId(clientId)}`);
|
|
749
|
+
this.__onDidSave.fire(Object.freeze({ document, clientId }));
|
|
750
|
+
}
|
|
751
|
+
|
|
641
752
|
public notifyDidOpenTextDocument(event: DidOpenTextDocumentParams, clientId = LANGUAGE_CLIENT_ID): void {
|
|
642
753
|
const td = event.textDocument;
|
|
643
754
|
const uri = this.documentKey(td.uri);
|
|
644
|
-
|
|
645
|
-
|
|
646
|
-
|
|
647
|
-
|
|
648
|
-
|
|
649
|
-
// open/rebuild; the document is already live.
|
|
650
|
-
if (clientId === LANGUAGE_CLIENT_ID) {
|
|
651
|
-
const clientFacing = this.toLanguageClientUri(td.uri);
|
|
652
|
-
const record = this.__documents.get(uri);
|
|
653
|
-
if (record && !record.languageClientUris?.has(clientFacing)) {
|
|
654
|
-
(record.languageClientUris ??= new Set<LanguageClientUri>()).add(clientFacing);
|
|
655
|
-
const open = this.__syncedDocuments.get(uri);
|
|
656
|
-
if (open) {
|
|
657
|
-
this.__shadow.set(clientFacing, open.getText());
|
|
658
|
-
}
|
|
659
|
-
}
|
|
660
|
-
}
|
|
661
|
-
return;
|
|
755
|
+
// Before the deferred release is resolved: refused after it, the open
|
|
756
|
+
// would leave a document whose grace it ended with no holder and no timer.
|
|
757
|
+
// A repeat open stays a no-op.
|
|
758
|
+
if (!this.__sessions.isOpenIn(uri, clientId)) {
|
|
759
|
+
this.__sessions.assertCanOpen(clientId);
|
|
662
760
|
}
|
|
761
|
+
this.resolveDeferredRelease(uri, clientId);
|
|
663
762
|
let document = this.__syncedDocuments.get(uri);
|
|
664
|
-
|
|
665
|
-
|
|
666
|
-
|
|
667
|
-
//
|
|
668
|
-
//
|
|
669
|
-
|
|
763
|
+
// The client's declared text, never the synced document: staged
|
|
764
|
+
// content this open consumes leaves the two different, and a baseline
|
|
765
|
+
// asserting the client already holds it suppresses the one sync that
|
|
766
|
+
// would deliver it. On an attach, another client may already have
|
|
767
|
+
// changed the synced text, so the baseline is equality-only; a refresh
|
|
768
|
+
// pushing the full text would dirty the file on open.
|
|
670
769
|
if (clientId === LANGUAGE_CLIENT_ID) {
|
|
671
|
-
|
|
672
|
-
// so outbound applyEditToLanguageClient can address the URI it actually holds.
|
|
673
|
-
(record.languageClientUris ??= new Set<LanguageClientUri>()).add(this.toLanguageClientUri(td.uri));
|
|
770
|
+
this.languageClientShadow.addOpen(uri, this.toLanguageClientUri(td.uri), td.version, td.text, document === undefined);
|
|
674
771
|
}
|
|
772
|
+
if (this.isOpenInClient(uri, clientId)) {
|
|
773
|
+
// A repeat open, or the editor's second URI for the file, e.g. a
|
|
774
|
+
// symlink and its real path: the shadow records it so pushes reach it,
|
|
775
|
+
// and nothing re-fires.
|
|
776
|
+
return;
|
|
777
|
+
}
|
|
778
|
+
const existingClients = this.__sessions.clientsOf(uri);
|
|
779
|
+
this.__sessions.addOpen(uri, clientId);
|
|
780
|
+
this.__sessions.setClientVersion(uri, clientId, td.version);
|
|
675
781
|
if (!document) {
|
|
676
782
|
// Use integrity-staged content if available, otherwise the client-provided (disk) text.
|
|
677
783
|
const pendingText = this.consumePendingContent(uri);
|
|
678
784
|
const text = pendingText ?? td.text;
|
|
679
785
|
const source = pendingText ? ', source=pending' : '';
|
|
680
|
-
|
|
681
|
-
|
|
682
|
-
|
|
683
|
-
|
|
684
|
-
|
|
685
|
-
//
|
|
686
|
-
|
|
687
|
-
|
|
688
|
-
|
|
689
|
-
this.log(uri, `Open document: Version ${version} by ${clientId} [first client${source}]`);
|
|
690
|
-
document = this.configuration.create(uri, td.languageId, version, text);
|
|
691
|
-
this.__syncedDocuments.set(uri, document);
|
|
692
|
-
this.setAuthor(uri, version, clientId);
|
|
693
|
-
if (clientId === LANGUAGE_CLIENT_ID) {
|
|
694
|
-
// Baseline the shadow to what Monaco just opened so the next outbound
|
|
695
|
-
// applyEditToLanguageClient diffs against the right starting point. Keyed by the
|
|
696
|
-
// language-client URI (what Monaco holds), not the canonical document key.
|
|
697
|
-
this.__shadow.set(this.toLanguageClientUri(td.uri), document.getText());
|
|
698
|
-
}
|
|
786
|
+
const version = this.textLedger.openingVersion(uri, text) ?? this.builtRootOpeningVersion(uri, text) ?? td.version;
|
|
787
|
+
this.log(uri, `Open document: Version ${version} by ${this.formatClientId(clientId)} [first client${source}]`);
|
|
788
|
+
document = this.create(uri, td.languageId, version, text);
|
|
789
|
+
this.commitText(uri, document, clientId);
|
|
790
|
+
this.__openedVersions.set(uri, version);
|
|
791
|
+
// The opener's text, not the staged content: a session's open read
|
|
792
|
+
// it from the file, and an editor opened its buffer from there. An
|
|
793
|
+
// editor that opens a buffer it never saved is taken as clean.
|
|
794
|
+
this.dirtyStateTracker.track(uri, document, td.text);
|
|
699
795
|
const toFire = Object.freeze({ document, clientId });
|
|
700
796
|
this.__onDidOpen.fire(toFire);
|
|
701
797
|
this.__onDidChangeContent.fire(toFire);
|
|
702
798
|
} else {
|
|
703
799
|
// An additional client attaches to a document already open by another client.
|
|
704
|
-
this.
|
|
705
|
-
uri,
|
|
706
|
-
`Attach client: ${clientId} joined existing document (version ${document.version}, ` +
|
|
707
|
-
`now open in: ${[...existingClients, clientId].join(', ')})`
|
|
708
|
-
);
|
|
800
|
+
this.logClientJoined(uri, clientId, document.version, existingClients);
|
|
709
801
|
this.refreshContent(uri, clientId);
|
|
710
802
|
}
|
|
711
803
|
}
|
|
712
804
|
|
|
805
|
+
/**
|
|
806
|
+
* Record `clientId` as an additional holder of a document another client
|
|
807
|
+
* already has open.
|
|
808
|
+
*
|
|
809
|
+
* Unlike the attach branch of {@link notifyDidOpenTextDocument} this does
|
|
810
|
+
* not refresh. That branch re-renders an attaching TEXTUAL view; a client
|
|
811
|
+
* reaching a document through a non-textual route has nothing to re-render,
|
|
812
|
+
* and refreshing per attach turns each into a Langium rebuild and dependent
|
|
813
|
+
* relink cascade.
|
|
814
|
+
*
|
|
815
|
+
* Returns whether a hold was added — `false` when `uri` is not open,
|
|
816
|
+
* `clientId` already holds it, or the document was waiting out the release
|
|
817
|
+
* grace for other clients and was released instead (see
|
|
818
|
+
* {@link resolveDeferredRelease}); the caller then opens it anew.
|
|
819
|
+
*/
|
|
820
|
+
attachClient(uri: DocumentUri, clientId: string): boolean {
|
|
821
|
+
const key = this.documentKey(uri);
|
|
822
|
+
if (!this.__syncedDocuments.has(key) || this.isOpenInClient(key, clientId)) {
|
|
823
|
+
return false;
|
|
824
|
+
}
|
|
825
|
+
// Before the deferred release is resolved, as for an open.
|
|
826
|
+
this.__sessions.assertCanOpen(clientId);
|
|
827
|
+
this.resolveDeferredRelease(key, clientId);
|
|
828
|
+
const document = this.__syncedDocuments.get(key);
|
|
829
|
+
if (!document) {
|
|
830
|
+
return false;
|
|
831
|
+
}
|
|
832
|
+
const existingClients = this.__sessions.clientsOf(key);
|
|
833
|
+
this.__sessions.addOpen(key, clientId);
|
|
834
|
+
// A client arriving this way holds no buffer of its own, so its guard
|
|
835
|
+
// starts at the synced version.
|
|
836
|
+
this.__sessions.setClientVersion(key, clientId, document.version);
|
|
837
|
+
this.logClientJoined(key, clientId, document.version, existingClients);
|
|
838
|
+
return true;
|
|
839
|
+
}
|
|
840
|
+
|
|
841
|
+
protected logClientJoined(uri: DocumentUri, clientId: string, version: number, existingClients: readonly string[]): void {
|
|
842
|
+
this.log(
|
|
843
|
+
uri,
|
|
844
|
+
`Attach client: ${this.formatClientId(clientId)} joined existing document (version ${version}, ` +
|
|
845
|
+
`now open in: ${[...existingClients, clientId].map(id => this.formatClientId(id)).join(', ')})`
|
|
846
|
+
);
|
|
847
|
+
}
|
|
848
|
+
|
|
713
849
|
refreshContent(uri: DocumentUri, clientId: string): void {
|
|
714
850
|
const syncedDocument = this.__syncedDocuments.get(this.documentKey(uri));
|
|
715
851
|
if (syncedDocument) {
|
|
716
852
|
// Trigger a (re-)build by firing a change event.
|
|
717
853
|
const timer = this.startTimerForUri(
|
|
718
854
|
syncedDocument.uri,
|
|
719
|
-
`Refresh synced document: Version ${syncedDocument.version} by ${clientId}`
|
|
855
|
+
`Refresh synced document: Version ${syncedDocument.version} by ${this.formatClientId(clientId)}`
|
|
720
856
|
);
|
|
721
857
|
this.__onDidChangeContent.fire(Object.freeze({ document: syncedDocument, clientId }));
|
|
722
858
|
timer.dispose();
|
|
@@ -730,7 +866,7 @@ export class HydraniumTextDocuments<T extends TextDocument = TextDocument> exten
|
|
|
730
866
|
* two URIs for one physical file (a symlink path and its real path) into a
|
|
731
867
|
* single registration — dedup at the editor layer, not just in
|
|
732
868
|
* `LangiumDocuments`. The URI the client opened under is preserved separately
|
|
733
|
-
* for egress addressing
|
|
869
|
+
* for egress addressing, by the {@link LanguageClientShadow}. The
|
|
734
870
|
* policy is always bound (the framework defaults it to
|
|
735
871
|
* `DefaultDocumentUriPolicy`, where canonical ≡ syntactic normalize).
|
|
736
872
|
*/
|
|
@@ -750,18 +886,8 @@ export class HydraniumTextDocuments<T extends TextDocument = TextDocument> exten
|
|
|
750
886
|
return asLanguageClientUri(UriUtils.normalize(uri));
|
|
751
887
|
}
|
|
752
888
|
|
|
753
|
-
/** Get-or-create the per-URI tracking record. `uri` must already be a {@link documentKey}. */
|
|
754
|
-
protected trackingFor(uri: CanonicalUri): DocumentTracking {
|
|
755
|
-
let record = this.__documents.get(uri);
|
|
756
|
-
if (!record) {
|
|
757
|
-
record = { clients: new Set(), versionAuthors: [], clientVersions: new Map() };
|
|
758
|
-
this.__documents.set(uri, record);
|
|
759
|
-
}
|
|
760
|
-
return record;
|
|
761
|
-
}
|
|
762
|
-
|
|
763
889
|
setAuthor(uri: DocumentUri, version: number, author: string): void {
|
|
764
|
-
this.
|
|
890
|
+
this.textLedger.setAuthor(this.documentKey(uri), version, author);
|
|
765
891
|
}
|
|
766
892
|
|
|
767
893
|
/**
|
|
@@ -786,57 +912,148 @@ export class HydraniumTextDocuments<T extends TextDocument = TextDocument> exten
|
|
|
786
912
|
|
|
787
913
|
/**
|
|
788
914
|
* Current SHARED version of the document at `uri`: the open document's
|
|
789
|
-
* version, else where
|
|
790
|
-
*
|
|
915
|
+
* version, else where its persisted sequence left off, else `0` for a URI
|
|
916
|
+
* this store has never seen. The shared sequence is
|
|
791
917
|
* server-owned and monotonic across close/reopen cycles, and advances
|
|
792
918
|
* exactly when the synced content changes — which is what makes it a sound
|
|
793
|
-
* optimistic-concurrency token (
|
|
919
|
+
* optimistic-concurrency token (base-version gates): version unchanged ⇔
|
|
794
920
|
* content unchanged.
|
|
795
921
|
*/
|
|
796
|
-
version(uri: DocumentUri):
|
|
797
|
-
return this.get(uri)?.version ?? this.
|
|
922
|
+
version(uri: DocumentUri): TextVersion {
|
|
923
|
+
return this.get(uri)?.version ?? this.textLedger.recordOf(this.documentKey(uri))?.version ?? 0;
|
|
924
|
+
}
|
|
925
|
+
|
|
926
|
+
/**
|
|
927
|
+
* The version the document at `uri` was opened at, which a client's write
|
|
928
|
+
* or an integrity repair steps past; `undefined` while it is not open.
|
|
929
|
+
*/
|
|
930
|
+
openedVersion(uri: DocumentUri): TextVersion | undefined {
|
|
931
|
+
return this.__openedVersions.get(this.documentKey(uri));
|
|
932
|
+
}
|
|
933
|
+
|
|
934
|
+
/**
|
|
935
|
+
* The text the store holds for `uri`: an open document's, or for a closed
|
|
936
|
+
* one, the clean text its version sequence left off at, which for a deleted
|
|
937
|
+
* document is its last text. `undefined` for a URI no build and no client
|
|
938
|
+
* gave the store.
|
|
939
|
+
*/
|
|
940
|
+
textState(uri: DocumentUri): TextState | undefined {
|
|
941
|
+
const document = this.get(uri);
|
|
942
|
+
if (document) {
|
|
943
|
+
return { version: document.version, hash: this.textLedger.hashOf(document), dirty: this.isDirty(uri) };
|
|
944
|
+
}
|
|
945
|
+
const recorded = this.textLedger.recordOf(this.documentKey(uri));
|
|
946
|
+
return recorded && { version: recorded.version, hash: recorded.hash, dirty: false };
|
|
947
|
+
}
|
|
948
|
+
|
|
949
|
+
/**
|
|
950
|
+
* The built root's recorded version for a first open of `key` with `text`,
|
|
951
|
+
* one on when the text differs from the root's; `undefined` when the root
|
|
952
|
+
* records no store version. Seeded from the opener's declared version
|
|
953
|
+
* instead, a write based on the built root passes the gate over other text,
|
|
954
|
+
* and the same text looks newer than its model. A built root records none
|
|
955
|
+
* only under a `LangiumDocuments` that does not reconcile at registration.
|
|
956
|
+
*/
|
|
957
|
+
protected builtRootOpeningVersion(key: CanonicalUri, text: string): TextVersion | undefined {
|
|
958
|
+
const built = this.services.workspace.LangiumDocuments.getDocument(UriUtils.toUri(key));
|
|
959
|
+
if (built === undefined) {
|
|
960
|
+
return undefined;
|
|
961
|
+
}
|
|
962
|
+
const ledger = this.services.workspace.ModelLedger;
|
|
963
|
+
const root = built.parseResult.value;
|
|
964
|
+
const recorded = ledger.versionOf(root);
|
|
965
|
+
if (recorded === UNRECORDED_VERSION || recorded === STALE_VERSION) {
|
|
966
|
+
return undefined;
|
|
967
|
+
}
|
|
968
|
+
return (ledger.textOf(root) ?? built.textDocument.getText()) === text ? recorded : recorded + 1;
|
|
798
969
|
}
|
|
799
970
|
|
|
800
971
|
/**
|
|
801
972
|
* Reconcile the persisted version sequence with content that reached the
|
|
802
973
|
* build OUTSIDE the store's write paths — a closed document rebuilt from
|
|
803
|
-
* disk
|
|
974
|
+
* disk after its release, or replaced by a watched-file change. Steps the
|
|
804
975
|
* sequence iff `text` differs from the sequence's last-known content and
|
|
805
976
|
* returns the resulting sequence version so the caller can re-stamp the
|
|
806
|
-
* rebuilt document (
|
|
977
|
+
* rebuilt document (`VersionSyncService.modelProduced`) —
|
|
807
978
|
* keeping the "version advances iff content changes" invariant for
|
|
808
979
|
* documents no client currently holds.
|
|
809
980
|
*
|
|
810
|
-
*
|
|
811
|
-
*
|
|
812
|
-
*
|
|
813
|
-
*
|
|
814
|
-
*
|
|
981
|
+
* For an open document, its version when it holds `text`, since a build
|
|
982
|
+
* that read the file while the document was closed can finish after an
|
|
983
|
+
* open; else `undefined`, and the caller has to build the document again.
|
|
984
|
+
*
|
|
985
|
+
* A document without a sequence starts one at `0` with `text`: snapshots
|
|
986
|
+
* hand out versions for documents no client opened, so an uncounted change
|
|
987
|
+
* would let a write based on the old text pass the gate.
|
|
815
988
|
*/
|
|
816
989
|
reconcileExternalContent(uri: DocumentUri, text: string): number | undefined {
|
|
817
990
|
const key = this.documentKey(uri);
|
|
818
|
-
|
|
819
|
-
|
|
991
|
+
const open = this.__syncedDocuments.get(key);
|
|
992
|
+
if (open !== undefined) {
|
|
993
|
+
return open.getText() === text ? open.version : undefined;
|
|
820
994
|
}
|
|
821
|
-
const
|
|
822
|
-
|
|
823
|
-
|
|
995
|
+
const before = this.textLedger.recordOf(key)?.version;
|
|
996
|
+
const version = this.textLedger.reconcile(key, text);
|
|
997
|
+
if (before !== undefined && version !== before) {
|
|
998
|
+
this.logUri(key, `External content change while closed: sequence stepped to version ${version}`, 'debug');
|
|
824
999
|
}
|
|
825
|
-
|
|
826
|
-
|
|
827
|
-
|
|
1000
|
+
return version;
|
|
1001
|
+
}
|
|
1002
|
+
|
|
1003
|
+
/**
|
|
1004
|
+
* Commit an integrity repair into the OPEN document for `uri`, returning the
|
|
1005
|
+
* document that now holds it, or `undefined` when there was nothing here to
|
|
1006
|
+
* commit into.
|
|
1007
|
+
*
|
|
1008
|
+
* The one thing this exists to do is address the store BY URI. A repair
|
|
1009
|
+
* reaches the resync as a text-document object, and that object is the
|
|
1010
|
+
* store's own only on the LSP path; a document built for an already-open URI
|
|
1011
|
+
* through `LangiumDocumentFactory.fromString` carries its own, so writing the
|
|
1012
|
+
* repair into it corrects a copy the store does not know about and the editor
|
|
1013
|
+
* never sees.
|
|
1014
|
+
*
|
|
1015
|
+
* `parsedFrom` is the text the repaired AST was parsed from, and a mismatch
|
|
1016
|
+
* against the current content REFUSES the commit: the store has moved on,
|
|
1017
|
+
* which means an editor change landed after that parse, and committing would
|
|
1018
|
+
* overwrite a newer edit with a repair computed against text the user has
|
|
1019
|
+
* already replaced. The build that change provokes recomputes the repair.
|
|
1020
|
+
*
|
|
1021
|
+
* Deliberately NOT compared by version. A separately created document seeds
|
|
1022
|
+
* its own numbering, so requiring the two to agree would refuse every commit
|
|
1023
|
+
* on the path this exists for. Content is the thing both sides can be held to.
|
|
1024
|
+
*
|
|
1025
|
+
* A changed text is a new version authored by {@link INTEGRITY_CLIENT_ID}.
|
|
1026
|
+
* Kept at the old version, the repair is invisible to every reader keyed on
|
|
1027
|
+
* versions: a write based on the unrepaired version passes the base-version gate
|
|
1028
|
+
* and replaces the repair, and an echo filter credits the repair to the
|
|
1029
|
+
* client whose edit it corrected. No change event is fired: the repair
|
|
1030
|
+
* rides the build already under way, and an event would re-enter it.
|
|
1031
|
+
*/
|
|
1032
|
+
commitRepair(uri: DocumentUri, parsedFrom: string, repaired: string): RepairCommit<T> {
|
|
1033
|
+
const key = this.documentKey(uri);
|
|
1034
|
+
const document = this.__syncedDocuments.get(key);
|
|
1035
|
+
if (document === undefined) {
|
|
1036
|
+
return { status: 'not-open' };
|
|
1037
|
+
}
|
|
1038
|
+
if (document.getText() !== parsedFrom) {
|
|
1039
|
+
this.logUri(key, 'Refuse repair commit: the open document moved on from the text the AST was parsed from', 'debug');
|
|
1040
|
+
return { status: 'stale' };
|
|
1041
|
+
}
|
|
1042
|
+
if (repaired === parsedFrom) {
|
|
1043
|
+
return { status: 'committed', document };
|
|
828
1044
|
}
|
|
829
|
-
|
|
830
|
-
|
|
831
|
-
|
|
832
|
-
|
|
1045
|
+
// Reassigned rather than mutated in place: the default configuration
|
|
1046
|
+
// updates and returns the SAME instance, but an adopter-supplied one may
|
|
1047
|
+
// return a new object, and the store must end up holding whichever it is.
|
|
1048
|
+
const updated = this.commitChange(key, document, [{ text: repaired }], INTEGRITY_CLIENT_ID).document;
|
|
1049
|
+
this.log(updated.uri, `Update to version ${updated.version} by ${this.formatClientId(INTEGRITY_CLIENT_ID)} (repair)`);
|
|
1050
|
+
return { status: 'committed', document: updated };
|
|
833
1051
|
}
|
|
834
1052
|
|
|
835
1053
|
getAuthor(uri: DocumentUri, version?: number): string | undefined {
|
|
836
|
-
const
|
|
837
|
-
|
|
838
|
-
|
|
839
|
-
if (!clientId && history) {
|
|
1054
|
+
const key = this.documentKey(uri);
|
|
1055
|
+
const clientId = this.textLedger.authorOf(key, version);
|
|
1056
|
+
if (!clientId && this.textLedger.authorOf(key) !== undefined) {
|
|
840
1057
|
// Only warn when there IS a history but the specific version is missing; no history at all
|
|
841
1058
|
// means the document was rebuilt internally (e.g. by a project manager), not an error.
|
|
842
1059
|
this.log(uri, `Could not detect author of version ${version}.`);
|
|
@@ -852,17 +1069,19 @@ export class HydraniumTextDocuments<T extends TextDocument = TextDocument> exten
|
|
|
852
1069
|
* True iff any client still holds `uri` open. Distinct from {@link isOpen},
|
|
853
1070
|
* which reads `__syncedDocuments` — that map is cleared only AFTER the
|
|
854
1071
|
* `onDidClose` event fires for the last client, so `isOpen` returns `true`
|
|
855
|
-
* during the close event itself. `isOpenInAnyClient` reads the
|
|
856
|
-
*
|
|
857
|
-
* subscriber that finds this `false` knows the last client just closed
|
|
858
|
-
*
|
|
1072
|
+
* during the close event itself. `isOpenInAnyClient` reads the open table
|
|
1073
|
+
* ({@link __sessions}), which is updated BEFORE the fire, so an `onDidClose`
|
|
1074
|
+
* subscriber that finds this `false` knows the last client just closed.
|
|
1075
|
+
* What the build keeps is the release's: a subscriber that re-read or
|
|
1076
|
+
* rebuilt the document would race the `DocumentReleaseHandler`, and after a
|
|
1077
|
+
* lost connection the release waits out its grace.
|
|
859
1078
|
*/
|
|
860
1079
|
isOpenInAnyClient(uri: DocumentUri): boolean {
|
|
861
|
-
return
|
|
1080
|
+
return this.__sessions.isOpen(this.documentKey(uri));
|
|
862
1081
|
}
|
|
863
1082
|
|
|
864
1083
|
isOpenInClient(uri: DocumentUri, client: string): boolean {
|
|
865
|
-
return
|
|
1084
|
+
return this.__sessions.isOpenIn(this.documentKey(uri), client);
|
|
866
1085
|
}
|
|
867
1086
|
|
|
868
1087
|
isOpenInLanguageClient(uri: DocumentUri): boolean {
|
|
@@ -872,15 +1091,20 @@ export class HydraniumTextDocuments<T extends TextDocument = TextDocument> exten
|
|
|
872
1091
|
return this.isOpenInClient(uri, LANGUAGE_CLIENT_ID);
|
|
873
1092
|
}
|
|
874
1093
|
|
|
1094
|
+
/** The clients that have `uri` open, in the order they opened it. */
|
|
1095
|
+
clientsOf(uri: DocumentUri): string[] {
|
|
1096
|
+
return this.__sessions.clientsOf(this.documentKey(uri));
|
|
1097
|
+
}
|
|
1098
|
+
|
|
875
1099
|
isOnlyOpenInClient(uri: DocumentUri, client: string): boolean {
|
|
876
|
-
const
|
|
877
|
-
return
|
|
1100
|
+
const clients = this.__sessions.clientsOf(this.documentKey(uri));
|
|
1101
|
+
return clients.length === 1 && clients[0] === client;
|
|
878
1102
|
}
|
|
879
1103
|
|
|
880
1104
|
/**
|
|
881
1105
|
* Every document currently held open by at least one client, with the client
|
|
882
|
-
* ids holding it. Reads the same
|
|
883
|
-
*
|
|
1106
|
+
* ids holding it. Reads the same open table as {@link isOpenInAnyClient}, so
|
|
1107
|
+
* it reflects a last-client close immediately.
|
|
884
1108
|
*
|
|
885
1109
|
* Diagnostics-oriented — the server-state snapshot lists these so an operator
|
|
886
1110
|
* can see WHY a document is pinned: a document that lingers here after its
|
|
@@ -888,31 +1112,235 @@ export class HydraniumTextDocuments<T extends TextDocument = TextDocument> exten
|
|
|
888
1112
|
* under a shedding policy, explains why its CST is never shed).
|
|
889
1113
|
*/
|
|
890
1114
|
openDocuments(): OpenDocument[] {
|
|
891
|
-
|
|
892
|
-
|
|
893
|
-
|
|
894
|
-
|
|
1115
|
+
return this.__sessions.openDocuments();
|
|
1116
|
+
}
|
|
1117
|
+
|
|
1118
|
+
/** Fires once a client session has ended, after every document it had open was closed. */
|
|
1119
|
+
get onDidCloseSession(): Event<ClientSessionClosedEvent> {
|
|
1120
|
+
return this.__sessions.onDidCloseSession;
|
|
1121
|
+
}
|
|
1122
|
+
|
|
1123
|
+
/**
|
|
1124
|
+
* Fires once a document no client has open is released: at its last close,
|
|
1125
|
+
* or, for a lost client's last close, when its release grace runs out,
|
|
1126
|
+
* another client opens it, or it is deleted, before the
|
|
1127
|
+
* `DocumentReleaseHandler` slot is handed the document.
|
|
1128
|
+
*/
|
|
1129
|
+
get onDidReleaseDocument(): Event<DocumentReleasedEvent> {
|
|
1130
|
+
return this.documentReleasedEmitter.event;
|
|
1131
|
+
}
|
|
1132
|
+
|
|
1133
|
+
/**
|
|
1134
|
+
* Fires for every save the language client reports of a document it has
|
|
1135
|
+
* open: the editor has written the file. {@link onDidSave} follows only
|
|
1136
|
+
* when the file holds the store's text.
|
|
1137
|
+
*/
|
|
1138
|
+
get onDidSaveInLanguageClient(): Event<LanguageClientSavedEvent> {
|
|
1139
|
+
return this.languageClientSavedEmitter.event;
|
|
1140
|
+
}
|
|
1141
|
+
|
|
1142
|
+
/**
|
|
1143
|
+
* Whether `uri` is waiting out the release grace: its last open closed with a
|
|
1144
|
+
* lost connection, and it still holds its unsaved text. Such a document is
|
|
1145
|
+
* open for no client, yet not closed either, so a caller that would persist
|
|
1146
|
+
* a closed document's text to disk treats it as open.
|
|
1147
|
+
*/
|
|
1148
|
+
isReleaseDeferred(uri: DocumentUri): boolean {
|
|
1149
|
+
return this.documentReleaseScheduler.isDeferred(this.documentKey(uri));
|
|
1150
|
+
}
|
|
1151
|
+
|
|
1152
|
+
/**
|
|
1153
|
+
* Whether the store holds `uri` with text that differs from its disk
|
|
1154
|
+
* baseline: what the server last knew the file to hold. `false` for a URI
|
|
1155
|
+
* the store does not hold; a document waiting out the release grace is still
|
|
1156
|
+
* held.
|
|
1157
|
+
*
|
|
1158
|
+
* The baseline is the text a first open brought, or what the server wrote,
|
|
1159
|
+
* or read back after an editor's save or a watched-file change, so it can
|
|
1160
|
+
* trail a change to the file that none of these has seen yet. A check that
|
|
1161
|
+
* must know the file reads it instead.
|
|
1162
|
+
*/
|
|
1163
|
+
isDirty(uri: DocumentUri): boolean {
|
|
1164
|
+
return this.dirtyStateTracker.isDirty(this.documentKey(uri));
|
|
1165
|
+
}
|
|
1166
|
+
|
|
1167
|
+
/**
|
|
1168
|
+
* Fires each time the answer of {@link isDirty} changes. For a document
|
|
1169
|
+
* released dirty it fires once the `DocumentReleaseHandler` slot reports the
|
|
1170
|
+
* release settled: at the version of the text the build then holds, or
|
|
1171
|
+
* without text when the document is gone or the handler failed, though
|
|
1172
|
+
* {@link isDirty} answers clean from the release on.
|
|
1173
|
+
*/
|
|
1174
|
+
get onDidChangeDirty(): Event<DocumentDirtyChangedEvent> {
|
|
1175
|
+
return this.dirtyStateTracker.onDidChangeDirty;
|
|
1176
|
+
}
|
|
1177
|
+
|
|
1178
|
+
/**
|
|
1179
|
+
* Record that the file behind `uri` holds `text`, or no file at all for
|
|
1180
|
+
* `undefined`. A no-op for a URI the store does not hold: the next first
|
|
1181
|
+
* open sets the baseline from its own text.
|
|
1182
|
+
*/
|
|
1183
|
+
setDiskBaseline(uri: DocumentUri, text: string | undefined): void {
|
|
1184
|
+
const key = this.documentKey(uri);
|
|
1185
|
+
const document = this.__syncedDocuments.get(key);
|
|
1186
|
+
if (document !== undefined) {
|
|
1187
|
+
this.dirtyStateTracker.setDiskBaseline(key, document, text);
|
|
1188
|
+
}
|
|
1189
|
+
}
|
|
1190
|
+
|
|
1191
|
+
/**
|
|
1192
|
+
* Read the file behind `uri` through its disk queue and take it as the
|
|
1193
|
+
* baseline. A file that cannot be read counts as none, the side that
|
|
1194
|
+
* leaves the document dirty.
|
|
1195
|
+
*/
|
|
1196
|
+
async reloadDiskBaseline(uri: DocumentUri): Promise<void> {
|
|
1197
|
+
const key = this.documentKey(uri);
|
|
1198
|
+
if (!this.__syncedDocuments.has(key)) {
|
|
1199
|
+
return;
|
|
1200
|
+
}
|
|
1201
|
+
let onDisk: string | undefined;
|
|
1202
|
+
try {
|
|
1203
|
+
onDisk = await this.services.workspace.FileSystemTaskQueue.enqueue(key, () =>
|
|
1204
|
+
this.services.workspace.FileSystemProvider.readFile(UriUtils.toUri(key))
|
|
1205
|
+
);
|
|
1206
|
+
} catch (err: unknown) {
|
|
1207
|
+
this.tracer.with(key).debug(`Disk baseline: the file cannot be read. ${err instanceof Error ? err.message : String(err)}`);
|
|
1208
|
+
}
|
|
1209
|
+
this.setDiskBaseline(key, onDisk);
|
|
1210
|
+
}
|
|
1211
|
+
|
|
1212
|
+
/**
|
|
1213
|
+
* Start a client session under `clientId`. Throws where
|
|
1214
|
+
* {@link ClientSessionRegistry.register} refuses the id.
|
|
1215
|
+
*/
|
|
1216
|
+
registerSession(clientId: string): void {
|
|
1217
|
+
this.__sessions.register(clientId);
|
|
1218
|
+
this.tracer.info(`Session started: ${this.formatClientId(clientId)}`);
|
|
1219
|
+
this.tracer.trace(`Session started: ${clientId}`);
|
|
1220
|
+
}
|
|
1221
|
+
|
|
1222
|
+
/**
|
|
1223
|
+
* End the client session `clientId`: close every document it has open, then
|
|
1224
|
+
* free the id. Immediate — each close runs the ordinary close path before
|
|
1225
|
+
* this returns, with `cause` as its cause. A no-op for an id that is not a
|
|
1226
|
+
* registered session.
|
|
1227
|
+
*/
|
|
1228
|
+
closeSession(clientId: string, cause: SessionEndCause = 'closed'): void {
|
|
1229
|
+
if (!this.__sessions.isRegistered(clientId)) {
|
|
1230
|
+
return;
|
|
1231
|
+
}
|
|
1232
|
+
try {
|
|
1233
|
+
for (const uri of this.__sessions.beginClose(clientId)) {
|
|
1234
|
+
this.notifyDidCloseTextDocument({ textDocument: { uri } }, clientId, cause);
|
|
895
1235
|
}
|
|
1236
|
+
} finally {
|
|
1237
|
+
this.__sessions.unregister(clientId, cause);
|
|
1238
|
+
this.tracer.info(`Session closed: ${this.formatClientId(clientId)}`);
|
|
1239
|
+
this.tracer.trace(`Session closed: ${clientId}`);
|
|
896
1240
|
}
|
|
897
|
-
return result;
|
|
898
1241
|
}
|
|
899
1242
|
|
|
900
1243
|
/**
|
|
901
|
-
*
|
|
1244
|
+
* Close every document the language client has open, as a `didClose` for
|
|
1245
|
+
* each would, so each last close releases its document. For a host whose editor connection
|
|
1246
|
+
* can end while the process lives on, such as a worker whose port's peer
|
|
1247
|
+
* closed: the language client is no session, so nothing else closes them.
|
|
902
1248
|
*
|
|
903
|
-
*
|
|
904
|
-
*
|
|
905
|
-
*
|
|
906
|
-
*
|
|
1249
|
+
* It first waits for the workspace initialization the open handler waits
|
|
1250
|
+
* for, so an open that arrived before the close is closed too; closing at
|
|
1251
|
+
* once would leave that open to land afterwards, held by a client that is
|
|
1252
|
+
* gone.
|
|
1253
|
+
*/
|
|
1254
|
+
async closeLanguageClientDocuments(): Promise<void> {
|
|
1255
|
+
await this.initialBuildFinished();
|
|
1256
|
+
for (const uri of this.__sessions.opensOf(LANGUAGE_CLIENT_ID)) {
|
|
1257
|
+
// A close for one URI while others remain keeps the client's hold.
|
|
1258
|
+
this.languageClientShadow.removeAllOpens(uri);
|
|
1259
|
+
this.notifyDidCloseTextDocument({ textDocument: { uri } });
|
|
1260
|
+
}
|
|
1261
|
+
}
|
|
1262
|
+
|
|
1263
|
+
/**
|
|
1264
|
+
* Settles once the initial workspace build has finished, whether it
|
|
1265
|
+
* completed, was cancelled or failed. Awaiting `workspaceInitialized` itself
|
|
1266
|
+
* throws after a cancelled build, which any write during startup causes, and
|
|
1267
|
+
* every open and close gated on it is then dropped for the process lifetime.
|
|
1268
|
+
* The workspace manager logs a failed build.
|
|
1269
|
+
*/
|
|
1270
|
+
protected async initialBuildFinished(): Promise<void> {
|
|
1271
|
+
await this.services.workspace.WorkspaceManager.workspaceInitialized.catch(() => undefined);
|
|
1272
|
+
}
|
|
1273
|
+
|
|
1274
|
+
/**
|
|
1275
|
+
* The file behind `uri` was deleted: close every open of it except the
|
|
1276
|
+
* language client's.
|
|
907
1277
|
*
|
|
908
|
-
*
|
|
909
|
-
*
|
|
910
|
-
*
|
|
911
|
-
*
|
|
912
|
-
|
|
1278
|
+
* The editor's open is left alone because the editor owns it: it keeps the
|
|
1279
|
+
* buffer of a deleted file and goes on sending changes for it, and a store
|
|
1280
|
+
* that had closed the document would drop every one of them until the editor
|
|
1281
|
+
* reopened.
|
|
1282
|
+
*/
|
|
1283
|
+
notifyDocumentDeleted(uri: DocumentUri): void {
|
|
1284
|
+
const key = this.documentKey(uri);
|
|
1285
|
+
for (const clientId of this.__sessions.clientsOf(key)) {
|
|
1286
|
+
if (clientId !== LANGUAGE_CLIENT_ID) {
|
|
1287
|
+
this.notifyDidCloseTextDocument({ textDocument: { uri: key } }, clientId);
|
|
1288
|
+
}
|
|
1289
|
+
}
|
|
1290
|
+
}
|
|
1291
|
+
|
|
1292
|
+
/**
|
|
1293
|
+
* Remove the document for `uri`, closing every open of it first — the
|
|
1294
|
+
* editor's included, since the document it would keep editing is gone.
|
|
1295
|
+
*
|
|
1296
|
+
* The base removes the synced document without consulting the open table,
|
|
1297
|
+
* which leaves every open recorded against a document that no longer exists:
|
|
1298
|
+
* the store then answers that the URI is open, and the next open attaches to
|
|
1299
|
+
* nothing.
|
|
1300
|
+
*/
|
|
1301
|
+
override delete(uri: string | URI | T): void {
|
|
1302
|
+
const key = this.documentKey((typeof uri === 'object' && 'uri' in uri ? uri.uri : uri).toString());
|
|
1303
|
+
this.languageClientShadow.removeAllOpens(key);
|
|
1304
|
+
for (const clientId of this.__sessions.clientsOf(key)) {
|
|
1305
|
+
this.notifyDidCloseTextDocument({ textDocument: { uri: key } }, clientId);
|
|
1306
|
+
}
|
|
1307
|
+
// A document waiting out the grace has no client left to close, and is
|
|
1308
|
+
// released now as its last close would have released it.
|
|
1309
|
+
if (this.documentReleaseScheduler.isDeferred(key)) {
|
|
1310
|
+
this.documentReleaseScheduler.cancel(key);
|
|
1311
|
+
this.releaseDocument(key);
|
|
1312
|
+
}
|
|
1313
|
+
super.delete(key);
|
|
1314
|
+
}
|
|
1315
|
+
|
|
1316
|
+
/**
|
|
1317
|
+
* A client id as log lines print it. An id containing `#` is cut eight
|
|
1318
|
+
* characters after its last `#`, which leaves a minted `label#uuid` as the
|
|
1319
|
+
* label and enough of the UUID to tell sessions apart; an id without `#`
|
|
1320
|
+
* prints whole. The full id goes out at trace level wherever a session
|
|
1321
|
+
* starts or ends.
|
|
1322
|
+
*/
|
|
1323
|
+
protected formatClientId(clientId: string): string {
|
|
1324
|
+
const separator = clientId.lastIndexOf('#');
|
|
1325
|
+
return separator < 0 ? clientId : clientId.slice(0, separator + 9);
|
|
1326
|
+
}
|
|
1327
|
+
|
|
1328
|
+
/**
|
|
1329
|
+
* Stages integrity-updated content for a document no client holds.
|
|
1330
|
+
*
|
|
1331
|
+
* Nothing is pushed to a file no client holds. The next open of it reads
|
|
1332
|
+
* disk, which lacks the update; {@link notifyDidOpenTextDocument} takes this
|
|
1333
|
+
* staged content in place of that text, and the open's sync then delivers
|
|
1334
|
+
* it to an editor as an unsaved change.
|
|
1335
|
+
*
|
|
1336
|
+
* Only a FIRST open consumes it, so stage only for a URI no client holds
|
|
1337
|
+
* ({@link isOpenInAnyClient} is `false`). A URI held only through another
|
|
1338
|
+
* head is not closed: an editor attaching to it joins the existing entry and
|
|
1339
|
+
* never reads the stage, and the release discards it. An entry waits for
|
|
1340
|
+
* that first open, at one serialised string per URI.
|
|
913
1341
|
*/
|
|
914
1342
|
stagePendingContent(uri: DocumentUri, text: string): void {
|
|
915
|
-
this.
|
|
1343
|
+
this.__pendingContent.set(this.documentKey(uri), text);
|
|
916
1344
|
}
|
|
917
1345
|
|
|
918
1346
|
/**
|
|
@@ -924,29 +1352,34 @@ export class HydraniumTextDocuments<T extends TextDocument = TextDocument> exten
|
|
|
924
1352
|
* - The shared services have no LSP {@link Connection} bound (non-LSP
|
|
925
1353
|
* hosts like CLI / tests).
|
|
926
1354
|
* - The shadow already matches `newText` (no edits needed; quiet skip).
|
|
1355
|
+
* - The language client has not opened the document. A client applies an
|
|
1356
|
+
* edit to a closed file by opening it, and that open races the edit;
|
|
1357
|
+
* the document's own open delivers its text instead.
|
|
927
1358
|
*
|
|
928
1359
|
* On `applyEdit` rejection (`result.applied === false`) or RPC failure the
|
|
929
|
-
* shadow is invalidated so the next call sends a full
|
|
1360
|
+
* shadow is invalidated so the next call sends a full replace, or nothing
|
|
1361
|
+
* when the client was last heard to hold that text.
|
|
930
1362
|
* Errors are re-thrown — callers wrap with their own retry / coalescing
|
|
931
1363
|
* policy as needed.
|
|
932
1364
|
*
|
|
933
1365
|
* The diff path is apply-verify-safe: the shadow internally checks that
|
|
934
1366
|
* `TextDocument.applyEdits(old, edits) === newText` and falls back to a
|
|
935
|
-
* full replace on mismatch
|
|
936
|
-
*
|
|
1367
|
+
* full replace on mismatch, logged, so a diff regression becomes log noise,
|
|
1368
|
+
* not data loss.
|
|
937
1369
|
*
|
|
938
1370
|
* That safety net verifies the diff against the SHADOW, which is what the
|
|
939
1371
|
* client is *believed* to hold — so it cannot see the client's buffer moving
|
|
940
1372
|
* underneath a push. A line-keyed edit is position-dependent: if a genuine
|
|
941
|
-
* client keystroke lands between
|
|
942
|
-
*
|
|
943
|
-
*
|
|
1373
|
+
* client keystroke lands between computing the edits and the client
|
|
1374
|
+
* applying them, the ranges address the wrong lines and splice the buffer
|
|
1375
|
+
* (observed as a duplicated declaration, which the integrity tier then
|
|
944
1376
|
* "repairs" into a suffixed name and persists). The edit is therefore
|
|
945
|
-
* addressed at the language client's
|
|
946
|
-
* `null` ("version intentionally unknown"), which is what lets the
|
|
947
|
-
* reject a push its buffer has outrun. On rejection the shadow is invalidated,
|
|
1377
|
+
* addressed at the language client's last known version for that URI rather
|
|
1378
|
+
* than at `null` ("version intentionally unknown"), which is what lets the
|
|
1379
|
+
* client reject a push its buffer has outrun. On rejection the shadow is invalidated,
|
|
948
1380
|
* so the caller's retry is a full-range replace — position-independent, and
|
|
949
|
-
* safe to apply to whatever the client now holds
|
|
1381
|
+
* safe to apply to whatever the client now holds — or nothing when the
|
|
1382
|
+
* client was last heard to hold that text.
|
|
950
1383
|
*/
|
|
951
1384
|
async applyEditToLanguageClient(
|
|
952
1385
|
uri: DocumentUri,
|
|
@@ -957,46 +1390,43 @@ export class HydraniumTextDocuments<T extends TextDocument = TextDocument> exten
|
|
|
957
1390
|
if (!connection) {
|
|
958
1391
|
return undefined;
|
|
959
1392
|
}
|
|
960
|
-
// The document is keyed by its canonical identity, but
|
|
961
|
-
//
|
|
962
|
-
|
|
963
|
-
// when the same file was opened under a symlink and its real path. Falls back
|
|
964
|
-
// to the normalized URI when nothing is tracked. The shadow is keyed by each
|
|
965
|
-
// URI, so every diff is against the right baseline.
|
|
966
|
-
const recorded = this.__documents.get(this.documentKey(uri))?.languageClientUris;
|
|
967
|
-
const targets: Iterable<LanguageClientUri> = recorded && recorded.size > 0 ? recorded : [this.toLanguageClientUri(uri)];
|
|
1393
|
+
// The document is keyed by its canonical identity, but the client holds it
|
|
1394
|
+
// under each URI it opened, and each is diffed against its own baseline.
|
|
1395
|
+
const key = this.documentKey(uri);
|
|
968
1396
|
let lastResult: ApplyWorkspaceEditResult | undefined;
|
|
969
|
-
for (const
|
|
970
|
-
//
|
|
971
|
-
//
|
|
972
|
-
//
|
|
973
|
-
const
|
|
974
|
-
|
|
975
|
-
if (edits.length === 0) {
|
|
1397
|
+
for (const clientUri of this.languageClientShadow.pushTargets(key)) {
|
|
1398
|
+
// Prepared per target, after the previous target's reply: prepared up
|
|
1399
|
+
// front, a later target is diffed against what it held before a change
|
|
1400
|
+
// that arrived meanwhile.
|
|
1401
|
+
const push = this.languageClientShadow.preparePush(key, clientUri, newText);
|
|
1402
|
+
if (push === undefined) {
|
|
976
1403
|
continue;
|
|
977
1404
|
}
|
|
978
|
-
// Record the push for echo correlation BEFORE the RPC — the client's
|
|
979
|
-
// echo can race the applyEdit response. See `__pendingPushes`.
|
|
980
|
-
this.recordPendingPush(targetUri, before, newText);
|
|
981
1405
|
try {
|
|
982
|
-
//
|
|
983
|
-
//
|
|
984
|
-
//
|
|
985
|
-
//
|
|
986
|
-
//
|
|
987
|
-
|
|
1406
|
+
// A full `ApplyWorkspaceEditParams`, `edit` and all — NOT a bare
|
|
1407
|
+
// `WorkspaceEdit` with a `label` beside it. `applyEdit` takes
|
|
1408
|
+
// `ApplyWorkspaceEditParams | WorkspaceEdit` and discriminates on
|
|
1409
|
+
// `!!value.edit`, so `{ label, documentChanges }` is wrapped as
|
|
1410
|
+
// `{ edit: { label, documentChanges } }` — putting the label inside
|
|
1411
|
+
// the edit, where LSP defines no such field and no client reads it.
|
|
1412
|
+
// The union is also what hides it at compile time: excess-property
|
|
1413
|
+
// checking admits a property present in EITHER member, so an object
|
|
1414
|
+
// matching neither type-checks against the union.
|
|
1415
|
+
const version = push.version ?? UNKNOWN_CLIENT_VERSION;
|
|
988
1416
|
const result = await connection.workspace.applyEdit({
|
|
989
1417
|
label: options?.label,
|
|
990
|
-
|
|
1418
|
+
edit: {
|
|
1419
|
+
documentChanges: [TextDocumentEdit.create(OptionalVersionedTextDocumentIdentifier.create(clientUri, version), push.edits)]
|
|
1420
|
+
}
|
|
991
1421
|
});
|
|
992
1422
|
if (result && result.applied === false) {
|
|
993
|
-
|
|
994
|
-
|
|
1423
|
+
push.notifyOutcome('refused');
|
|
1424
|
+
} else if (result?.applied) {
|
|
1425
|
+
push.notifyOutcome('applied');
|
|
995
1426
|
}
|
|
996
1427
|
lastResult = result;
|
|
997
|
-
} catch (err) {
|
|
998
|
-
|
|
999
|
-
this.__pendingPushes.delete(targetUri);
|
|
1428
|
+
} catch (err: unknown) {
|
|
1429
|
+
push.notifyOutcome('failed');
|
|
1000
1430
|
throw err;
|
|
1001
1431
|
}
|
|
1002
1432
|
}
|
|
@@ -1004,125 +1434,31 @@ export class HydraniumTextDocuments<T extends TextDocument = TextDocument> exten
|
|
|
1004
1434
|
}
|
|
1005
1435
|
|
|
1006
1436
|
/**
|
|
1007
|
-
*
|
|
1008
|
-
*
|
|
1009
|
-
*
|
|
1010
|
-
*
|
|
1011
|
-
*
|
|
1012
|
-
*
|
|
1013
|
-
*
|
|
1014
|
-
*
|
|
1015
|
-
* Falls back to {@link UNKNOWN_CLIENT_VERSION} when the client has never
|
|
1016
|
-
* declared one, which is the honest answer for a document it has not opened.
|
|
1017
|
-
* That is also the case in which there is no shadow, so the push is already a
|
|
1018
|
-
* position-independent full replace and has nothing to gain from a gate.
|
|
1019
|
-
*/
|
|
1020
|
-
protected languageClientVersion(uri: DocumentUri): number {
|
|
1021
|
-
return this.__documents.get(this.documentKey(uri))?.clientVersions.get(LANGUAGE_CLIENT_ID) ?? UNKNOWN_CLIENT_VERSION;
|
|
1022
|
-
}
|
|
1023
|
-
|
|
1024
|
-
/**
|
|
1025
|
-
* Append a push to the in-flight queue for `targetUri`
|
|
1026
|
-
* (see {@link __pendingPushes}). Bounded: beyond
|
|
1027
|
-
* {@link PENDING_ECHO_CAP} the oldest entry drops with a debug log — an
|
|
1028
|
-
* echo that far outstanding means the client is not echoing at all, and
|
|
1029
|
-
* an unbounded queue must not become the leak.
|
|
1030
|
-
*/
|
|
1031
|
-
protected recordPendingPush(targetUri: LanguageClientUri, before: string | undefined, newText: string): void {
|
|
1032
|
-
let pending = this.__pendingPushes.get(targetUri);
|
|
1033
|
-
if (!pending) {
|
|
1034
|
-
pending = [];
|
|
1035
|
-
this.__pendingPushes.set(targetUri, pending);
|
|
1036
|
-
}
|
|
1037
|
-
pending.push({ before, afterHash: contentHash(newText) });
|
|
1038
|
-
if (pending.length > PENDING_ECHO_CAP) {
|
|
1039
|
-
pending.shift();
|
|
1040
|
-
this.logUri(targetUri, `Pending-echo queue exceeded ${PENDING_ECHO_CAP} entries; dropped the oldest`, 'debug');
|
|
1041
|
-
}
|
|
1042
|
-
}
|
|
1043
|
-
|
|
1044
|
-
/**
|
|
1045
|
-
* Decide what an incoming language-client change actually is, by
|
|
1046
|
-
* reconstructing the client's resulting buffer against the OLDEST push still
|
|
1047
|
-
* in flight for `clientFacing`.
|
|
1048
|
-
*
|
|
1049
|
-
* `undefined` when nothing of ours is in flight, which is the ordinary path:
|
|
1050
|
-
* the client's ranges then address the synced text and the caller applies
|
|
1051
|
-
* them to it directly.
|
|
1052
|
-
*
|
|
1053
|
-
* **Why the oldest, and why reconstruct at all.** The client applies our
|
|
1054
|
-
* pushes in order and echoes each against the buffer it held before that
|
|
1055
|
-
* push, so the first echo to arrive belongs to the oldest entry — a FIFO
|
|
1056
|
-
* correspondence the queue preserves by consuming from the front. Comparing
|
|
1057
|
-
* the reconstruction against every pending hash, not only the oldest, is
|
|
1058
|
-
* what recognises an echo that a newer write already superseded: a rapid
|
|
1059
|
-
* write sequence can deliver the echo of push N after the store applied
|
|
1060
|
-
* push N+1, and everything older is then accounted for too.
|
|
1061
|
-
*
|
|
1062
|
-
* A reconstruction matching NO pending push means the client's buffer went
|
|
1063
|
-
* somewhere we did not send it — it coalesced a keystroke into the echo, or
|
|
1064
|
-
* typed before the push landed. That text is authoritative, and the queue
|
|
1065
|
-
* drops: the client has stopped being a pure mirror, so no outstanding echo
|
|
1066
|
-
* can match again. (A push still in flight at that point will be refused by
|
|
1067
|
-
* the client's own version gate, which invalidates the shadow and makes the
|
|
1068
|
-
* next sync a position-independent full replace.)
|
|
1069
|
-
*
|
|
1070
|
-
* Content equality is a sound echo proof because entries live only between a
|
|
1071
|
-
* push and its echo — a milliseconds window, never history — and the
|
|
1072
|
-
* client's `didChange` stream is ordered, so every buffer state arrives in
|
|
1073
|
-
* mutation order. An UNDO returning the buffer to previously-pushed text is
|
|
1074
|
-
* therefore never swallowed: the edit that preceded it already emptied the
|
|
1075
|
-
* queue, so undo revisits PAST states while the queue holds IN-FLIGHT ones.
|
|
1437
|
+
* Explicitly baseline the language-client shadow for a URI the client has
|
|
1438
|
+
* open, for an adopter that knows what the client holds without a
|
|
1439
|
+
* `didChange` saying so (e.g. after a sideband save). Normal didOpen /
|
|
1440
|
+
* didChange paths from the LSP language client already auto-track the
|
|
1441
|
+
* shadow. A seed for a URI the client has not opened is kept but changes no
|
|
1442
|
+
* push, since nothing is pushed there; its open replaces it with the text it
|
|
1443
|
+
* declares.
|
|
1076
1444
|
*/
|
|
1077
|
-
|
|
1078
|
-
|
|
1079
|
-
document: T,
|
|
1080
|
-
changes: TextDocumentContentChangeEvent[]
|
|
1081
|
-
): LanguageClientChangeOrigin | undefined {
|
|
1082
|
-
const pending = this.__pendingPushes.get(clientFacing);
|
|
1083
|
-
if (pending === undefined || pending.length === 0) {
|
|
1084
|
-
return undefined;
|
|
1085
|
-
}
|
|
1086
|
-
// Through the configured factories, not `TextDocument` directly, so an
|
|
1087
|
-
// adopter's custom text-document type governs how the ranges are applied
|
|
1088
|
-
// here exactly as it does on the synced document.
|
|
1089
|
-
const probe = this.create(clientFacing, document.languageId, 0, pending[0].before ?? document.getText());
|
|
1090
|
-
const clientText = this.update(probe, changes, 0).getText();
|
|
1091
|
-
const matchIndex = pending.findIndex(push => push.afterHash === contentHash(clientText));
|
|
1092
|
-
if (matchIndex >= 0) {
|
|
1093
|
-
pending.splice(0, matchIndex + 1);
|
|
1094
|
-
return { kind: 'echo' };
|
|
1095
|
-
}
|
|
1096
|
-
pending.length = 0;
|
|
1097
|
-
return { kind: 'divergent', text: clientText };
|
|
1445
|
+
setLanguageClientText(uri: DocumentUri, text: string): void {
|
|
1446
|
+
this.languageClientShadow.setClientText(this.toLanguageClientUri(uri), text);
|
|
1098
1447
|
}
|
|
1099
1448
|
|
|
1100
1449
|
/**
|
|
1101
|
-
*
|
|
1102
|
-
*
|
|
1103
|
-
*
|
|
1104
|
-
* paths from the LSP language client already auto-track the shadow.
|
|
1450
|
+
* Drop the shadow baseline for a URI; the next applyEditToLanguageClient
|
|
1451
|
+
* sends a full replace, or nothing when the client was last heard to hold
|
|
1452
|
+
* that text.
|
|
1105
1453
|
*/
|
|
1106
|
-
setLanguageClientText(uri: DocumentUri, text: string): void {
|
|
1107
|
-
const clientFacing = this.toLanguageClientUri(uri);
|
|
1108
|
-
this.__shadow.set(clientFacing, text);
|
|
1109
|
-
// An explicit rebaseline supersedes whatever was in flight.
|
|
1110
|
-
this.__pendingPushes.delete(clientFacing);
|
|
1111
|
-
}
|
|
1112
|
-
|
|
1113
|
-
/** Drop the shadow baseline for a URI; the next applyEditToLanguageClient sends a full replace. */
|
|
1114
1454
|
invalidateLanguageClientText(uri: DocumentUri): void {
|
|
1115
|
-
|
|
1116
|
-
this.__shadow.invalidate(clientFacing);
|
|
1117
|
-
this.__pendingPushes.delete(clientFacing);
|
|
1455
|
+
this.languageClientShadow.invalidateClientText(this.toLanguageClientUri(uri));
|
|
1118
1456
|
}
|
|
1119
1457
|
|
|
1120
1458
|
protected consumePendingContent(uri: DocumentUri): string | undefined {
|
|
1121
|
-
const
|
|
1122
|
-
const content =
|
|
1123
|
-
|
|
1124
|
-
record.pendingContent = undefined;
|
|
1125
|
-
}
|
|
1459
|
+
const key = this.documentKey(uri);
|
|
1460
|
+
const content = this.__pendingContent.get(key);
|
|
1461
|
+
this.__pendingContent.delete(key);
|
|
1126
1462
|
return content;
|
|
1127
1463
|
}
|
|
1128
1464
|
|