@hydranium/core 1.0.0-next.19 → 1.0.0-next.192
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 +6 -2
- package/lib/documents/ast-document-manager.d.ts +204 -62
- package/lib/documents/ast-document-manager.d.ts.map +1 -1
- package/lib/documents/ast-document-manager.js +249 -83
- package/lib/documents/ast-document-manager.js.map +1 -1
- package/lib/documents/client-ids.d.ts +5 -19
- package/lib/documents/client-ids.d.ts.map +1 -1
- package/lib/documents/client-ids.js +5 -19
- package/lib/documents/client-ids.js.map +1 -1
- package/lib/documents/client-session-errors.d.ts +15 -0
- package/lib/documents/client-session-errors.d.ts.map +1 -0
- package/lib/documents/client-session-errors.js +15 -0
- package/lib/documents/client-session-errors.js.map +1 -0
- package/lib/documents/client-session-registry.d.ts +138 -0
- package/lib/documents/client-session-registry.d.ts.map +1 -0
- package/lib/documents/client-session-registry.js +187 -0
- package/lib/documents/client-session-registry.js.map +1 -0
- package/lib/documents/file-system-task-queue.d.ts +49 -0
- package/lib/documents/file-system-task-queue.d.ts.map +1 -0
- package/lib/documents/file-system-task-queue.js +34 -0
- package/lib/documents/file-system-task-queue.js.map +1 -0
- package/lib/documents/hydranium-text-documents.d.ts +523 -101
- package/lib/documents/hydranium-text-documents.d.ts.map +1 -1
- package/lib/documents/hydranium-text-documents.js +961 -177
- package/lib/documents/hydranium-text-documents.js.map +1 -1
- package/lib/documents/index.d.ts +5 -0
- package/lib/documents/index.d.ts.map +1 -1
- package/lib/documents/index.js +5 -0
- package/lib/documents/index.js.map +1 -1
- package/lib/documents/language-client-text-shadow.d.ts +41 -9
- package/lib/documents/language-client-text-shadow.d.ts.map +1 -1
- package/lib/documents/language-client-text-shadow.js +56 -11
- package/lib/documents/language-client-text-shadow.js.map +1 -1
- package/lib/documents/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/self-save-registry.d.ts +37 -6
- package/lib/documents/self-save-registry.d.ts.map +1 -1
- package/lib/documents/self-save-registry.js +28 -15
- package/lib/documents/self-save-registry.js.map +1 -1
- package/lib/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 +3 -0
- package/lib/index.d.ts.map +1 -1
- package/lib/index.js +6 -0
- package/lib/index.js.map +1 -1
- package/lib/langium/ast-extension/ast-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.map +1 -1
- package/lib/langium/bootstrap.js +32 -9
- 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/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 +56 -13
- 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 +93 -0
- package/lib/langium/document-builder/build-session.d.ts.map +1 -0
- package/lib/langium/document-builder/build-session.js +72 -0
- package/lib/langium/document-builder/build-session.js.map +1 -0
- package/lib/langium/document-builder/document-builder.d.ts +382 -29
- package/lib/langium/document-builder/document-builder.d.ts.map +1 -1
- package/lib/langium/document-builder/document-builder.js +659 -61
- package/lib/langium/document-builder/document-builder.js.map +1 -1
- package/lib/langium/document-builder/index.d.ts +1 -0
- package/lib/langium/document-builder/index.d.ts.map +1 -1
- package/lib/langium/document-builder/index.js +1 -0
- package/lib/langium/document-builder/index.js.map +1 -1
- package/lib/langium/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 +45 -1
- package/lib/langium/integration-services.d.ts.map +1 -1
- package/lib/langium/integration-services.js +10 -5
- package/lib/langium/integration-services.js.map +1 -1
- package/lib/langium/integrity/integrity-rule.d.ts +13 -5
- package/lib/langium/integrity/integrity-rule.d.ts.map +1 -1
- package/lib/langium/integrity/integrity-rule.js.map +1 -1
- package/lib/langium/integrity/integrity-service.d.ts +58 -13
- package/lib/langium/integrity/integrity-service.d.ts.map +1 -1
- package/lib/langium/integrity/integrity-service.js +204 -29
- 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 +27 -2
- package/lib/langium/language-module.d.ts.map +1 -1
- package/lib/langium/language-module.js +16 -2
- package/lib/langium/language-module.js.map +1 -1
- package/lib/langium/model-service/client-session.d.ts +311 -0
- package/lib/langium/model-service/client-session.d.ts.map +1 -0
- package/lib/langium/model-service/client-session.js +398 -0
- package/lib/langium/model-service/client-session.js.map +1 -0
- package/lib/langium/model-service/index.d.ts +1 -0
- package/lib/langium/model-service/index.d.ts.map +1 -1
- package/lib/langium/model-service/index.js +1 -0
- package/lib/langium/model-service/index.js.map +1 -1
- package/lib/langium/model-service/model-service.d.ts +353 -253
- package/lib/langium/model-service/model-service.d.ts.map +1 -1
- package/lib/langium/model-service/model-service.js +361 -408
- 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 +50 -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 +31 -11
- 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 +15 -1
- package/lib/langium/service-registry.d.ts.map +1 -1
- package/lib/langium/service-registry.js +16 -0
- package/lib/langium/service-registry.js.map +1 -1
- package/lib/langium/shared-services.d.ts +21 -4
- package/lib/langium/shared-services.d.ts.map +1 -1
- package/lib/langium/shared-services.js.map +1 -1
- package/lib/langium/transfer/transfer-encoder.d.ts +75 -23
- package/lib/langium/transfer/transfer-encoder.d.ts.map +1 -1
- package/lib/langium/transfer/transfer-encoder.js +44 -21
- 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 +294 -10
- package/lib/langium/validation/document-validator.d.ts.map +1 -1
- package/lib/langium/validation/document-validator.js +448 -5
- package/lib/langium/validation/document-validator.js.map +1 -1
- package/lib/langium/validation/validation-contribution-collector.d.ts.map +1 -1
- package/lib/langium/validation/validation-contribution-collector.js.map +1 -1
- package/lib/langium/workspace/document-uri-policy.d.ts +17 -12
- package/lib/langium/workspace/document-uri-policy.d.ts.map +1 -1
- package/lib/langium/workspace/document-uri-policy.js +10 -9
- package/lib/langium/workspace/document-uri-policy.js.map +1 -1
- package/lib/langium/workspace/file-not-found.d.ts +17 -0
- package/lib/langium/workspace/file-not-found.d.ts.map +1 -0
- package/lib/langium/workspace/file-not-found.js +20 -0
- package/lib/langium/workspace/file-not-found.js.map +1 -0
- package/lib/langium/workspace/file-system-provider.d.ts +84 -8
- 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 +81 -8
- 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 +25 -2
- 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/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 +86 -17
- package/lib/langium/workspace/langium-documents.d.ts.map +1 -1
- package/lib/langium/workspace/langium-documents.js +101 -29
- package/lib/langium/workspace/langium-documents.js.map +1 -1
- package/lib/langium/workspace/persistent-file-system-provider.d.ts +0 -7
- 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/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 +90 -79
- 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 -0
- package/lib/node/index.d.ts.map +1 -1
- package/lib/node/index.js +1 -0
- package/lib/node/index.js.map +1 -1
- package/lib/node/latency-from-env.d.ts +1 -1
- package/lib/node/latency-from-env.js +1 -1
- package/lib/node/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 +39 -4
- 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/process-memory.js.map +1 -1
- package/lib/node/profile-capture.d.ts +8 -2
- package/lib/node/profile-capture.d.ts.map +1 -1
- package/lib/node/profile-capture.js.map +1 -1
- package/lib/node/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 +16 -1
- package/lib/node/socket-launcher.d.ts.map +1 -1
- package/lib/node/socket-launcher.js +4 -3
- package/lib/node/socket-launcher.js.map +1 -1
- package/lib/node/stdio-launcher.d.ts +1 -1
- package/lib/node/stdio-launcher.d.ts.map +1 -1
- package/lib/node/stdio-launcher.js +1 -1
- package/lib/node/stdio-launcher.js.map +1 -1
- package/lib/testing/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 +69 -14
- package/lib/testing/make-test-services.d.ts.map +1 -1
- package/lib/testing/make-test-services.js +39 -10
- package/lib/testing/make-test-services.js.map +1 -1
- 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 +42 -9
- package/lib/testing/node/lsp-server-connection.js.map +1 -1
- package/lib/testing/node/scratch-workspace.d.ts.map +1 -1
- package/lib/testing/node/scratch-workspace.js +10 -5
- package/lib/testing/node/scratch-workspace.js.map +1 -1
- package/lib/testing/node/spawned-server.d.ts +14 -0
- package/lib/testing/node/spawned-server.d.ts.map +1 -1
- package/lib/testing/node/spawned-server.js +33 -1
- package/lib/testing/node/spawned-server.js.map +1 -1
- package/lib/testing/node/unhandled-rejections.d.ts +20 -0
- package/lib/testing/node/unhandled-rejections.d.ts.map +1 -0
- package/lib/testing/node/unhandled-rejections.js +32 -0
- package/lib/testing/node/unhandled-rejections.js.map +1 -0
- package/lib/testing/playwright/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 -9
- package/lib/testing/stub-ast-document-manager.d.ts.map +1 -1
- package/lib/testing/stub-ast-document-manager.js +23 -9
- package/lib/testing/stub-ast-document-manager.js.map +1 -1
- package/lib/testing/stub-document-builder.d.ts +26 -11
- package/lib/testing/stub-document-builder.d.ts.map +1 -1
- package/lib/testing/stub-document-builder.js +57 -4
- package/lib/testing/stub-document-builder.js.map +1 -1
- package/lib/testing/stub-hydranium-text-documents.d.ts +22 -7
- package/lib/testing/stub-hydranium-text-documents.d.ts.map +1 -1
- package/lib/testing/stub-hydranium-text-documents.js +97 -15
- 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-service-registry.js.map +1 -1
- package/lib/util/connection-liveness.d.ts +7 -6
- package/lib/util/connection-liveness.d.ts.map +1 -1
- package/lib/util/connection-liveness.js +35 -14
- package/lib/util/connection-liveness.js.map +1 -1
- package/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 +35 -26
- package/src/documents/ast-document-manager.ts +377 -125
- package/src/documents/client-ids.ts +5 -22
- package/src/documents/client-session-errors.ts +24 -0
- package/src/documents/client-session-registry.ts +240 -0
- package/src/documents/file-system-task-queue.ts +68 -0
- package/src/documents/hydranium-text-documents.ts +1175 -225
- package/src/documents/index.ts +5 -0
- package/src/documents/language-client-text-shadow.ts +59 -11
- package/src/documents/model-ledger.ts +66 -0
- package/src/documents/self-save-registry.ts +52 -13
- package/src/documents/version-sync-service.ts +267 -0
- package/src/index.ts +6 -0
- package/src/langium/ast-extension/ast-node-builder.ts +66 -22
- package/src/langium/bootstrap.ts +32 -9
- 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 +58 -12
- package/src/langium/document-builder/build-pipeline-integration.ts +50 -5
- package/src/langium/document-builder/build-session.ts +87 -0
- package/src/langium/document-builder/document-builder.ts +776 -59
- package/src/langium/document-builder/index.ts +1 -0
- package/src/langium/integration-services.ts +67 -6
- package/src/langium/integrity/integrity-rule.ts +13 -5
- package/src/langium/integrity/integrity-service.ts +220 -30
- package/src/langium/keys/containment.ts +87 -0
- package/src/langium/keys/index.ts +1 -0
- package/src/langium/keys/name-based-key-provider.ts +4 -0
- package/src/langium/language-module.ts +42 -4
- package/src/langium/model-service/client-session.ts +614 -0
- package/src/langium/model-service/index.ts +1 -0
- package/src/langium/model-service/model-service.ts +570 -433
- package/src/langium/module.ts +201 -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 +46 -15
- package/src/langium/scope/hydranium-scope-provider.ts +60 -22
- package/src/langium/serialization/abstract-serializer.ts +13 -32
- package/src/langium/service-registry.ts +19 -2
- package/src/langium/shared-services.ts +25 -4
- package/src/langium/transfer/transfer-encoder.ts +102 -34
- package/src/langium/trivia/comment-preserver.ts +1100 -0
- package/src/langium/trivia/document-ending-preserver.ts +55 -0
- package/src/langium/trivia/index.ts +14 -0
- package/src/langium/trivia/trivia-contribution.ts +39 -0
- package/src/langium/trivia/trivia-preserver.ts +54 -0
- package/src/langium/trivia/trivia-service.ts +99 -0
- package/src/langium/update-rewrite/update-rewrite.ts +1 -1
- package/src/langium/validation/document-validator.ts +537 -11
- package/src/langium/workspace/document-uri-policy.ts +17 -12
- package/src/langium/workspace/file-not-found.ts +23 -0
- package/src/langium/workspace/file-system-provider.ts +153 -16
- 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 +153 -13
- package/src/langium/workspace/in-memory-file-system-provider.ts +47 -16
- package/src/langium/workspace/initialize-workspace.ts +43 -5
- package/src/langium/workspace/langium-documents.ts +124 -33
- package/src/langium/workspace/persistent-file-system-provider.ts +0 -7
- 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 +185 -106
- package/src/lsp/index.ts +3 -1
- package/src/lsp/lsp-latency.ts +62 -0
- package/src/lsp/semantic-token-provider.ts +74 -7
- package/src/lsp/shared-module.ts +4 -8
- package/src/lsp/start-language-server.ts +13 -7
- package/src/messages/carriers.ts +78 -0
- package/src/messages/index.ts +36 -0
- package/src/messages/renderer.ts +212 -0
- package/src/node/heap-ceiling.ts +108 -0
- package/src/node/index.ts +1 -0
- package/src/node/latency-from-env.ts +1 -1
- package/src/node/measure-memory.ts +1 -0
- package/src/node/node-file-system-provider.ts +122 -51
- package/src/node/profile-capture.ts +8 -2
- package/src/node/profiling-run.ts +30 -8
- package/src/node/rename-over-open-readers.ts +78 -0
- package/src/node/socket-launcher.ts +19 -4
- package/src/node/stdio-launcher.ts +1 -2
- package/src/testing/fake-document.ts +24 -5
- package/src/testing/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 +120 -31
- package/src/testing/node/index.ts +1 -0
- package/src/testing/node/lsp-harness.ts +2 -0
- package/src/testing/node/lsp-server-connection.ts +61 -11
- package/src/testing/node/scratch-workspace.ts +10 -5
- package/src/testing/node/spawned-server.ts +35 -1
- package/src/testing/node/unhandled-rejections.ts +31 -0
- package/src/testing/playwright/flaky-network-proxy.ts +240 -0
- package/src/testing/playwright/index.ts +1 -0
- package/src/testing/playwright/server-log-capture.ts +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 +37 -22
- package/src/testing/stub-document-builder.ts +83 -17
- package/src/testing/stub-hydranium-text-documents.ts +133 -23
- package/src/testing/stub-langium-documents.ts +3 -2
- package/src/testing/stub-model-service.ts +9 -8
- package/src/util/connection-liveness.ts +37 -14
- package/src/util/environment.ts +9 -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/src/lsp/instrument-connection.ts +0 -66
|
@@ -9,42 +9,50 @@
|
|
|
9
9
|
|
|
10
10
|
import {
|
|
11
11
|
type CanonicalUri,
|
|
12
|
-
|
|
13
|
-
ConflictError,
|
|
14
|
-
Logger,
|
|
12
|
+
defineMessage,
|
|
15
13
|
type MaybeObservableValue,
|
|
16
14
|
type MaybePromise,
|
|
17
15
|
ObservableValue,
|
|
18
|
-
|
|
16
|
+
TIMED_OUT,
|
|
19
17
|
type TransferElement,
|
|
20
|
-
type
|
|
18
|
+
type TextVersion,
|
|
21
19
|
type Tracer,
|
|
22
|
-
|
|
23
|
-
type TransferUpdateArgs
|
|
20
|
+
UNRECORDED_VERSION
|
|
24
21
|
} from '@hydranium/protocol';
|
|
25
|
-
import { type AstNode, DocumentState, type LangiumDocument, UriUtils, type URI } from '@hydranium/langium';
|
|
22
|
+
import { type AstNode, DocumentState, type LangiumDocument, OperationCancelled, UriUtils, type URI } from '@hydranium/langium';
|
|
23
|
+
import { type AstDiagnostic } from '../validation/document-validator.js';
|
|
26
24
|
import { type DocumentUriPolicy } from '../workspace/document-uri-policy.js';
|
|
27
|
-
import { ReentrantWriteLockError, isInsideWriteLock } from '../workspace/write-lock-scope.js';
|
|
28
|
-
import {
|
|
25
|
+
import { ReentrantWriteLockError, isInsideWriteLock, isWriteLockScopeInstalled } from '../workspace/write-lock-scope.js';
|
|
26
|
+
import { CancellationToken, type Disposable } from 'vscode-languageserver';
|
|
29
27
|
import { AstDocument, type AstDocumentSavedEvent, type AstDocumentUpdatedEvent } from '../../documents/ast-document-manager.js';
|
|
30
28
|
import { isConnectionGoneError } from '../../util/connection-liveness.js';
|
|
31
29
|
import { type LogNameOptions } from '../diagnostics/logger.js';
|
|
32
30
|
import { IntegrityService } from '../integrity/integrity-service.js';
|
|
33
31
|
import { labelPhaseListener } from '../document-builder/labeled-phase-listener.js';
|
|
34
32
|
import { LANGUAGE_CLIENT_ID } from '../../documents/client-ids.js';
|
|
33
|
+
import { type OpenOptions } from '../../documents/client-session-registry.js';
|
|
35
34
|
import { type ServerSharedServices } from '../module.js';
|
|
36
|
-
|
|
37
|
-
/** Max time {@link ModelService.settleSave} waits for the build to settle and the sync chain to drain. */
|
|
38
|
-
const SAVE_SETTLE_TIMEOUT_MS = 10_000;
|
|
35
|
+
import { type ClientSession } from './client-session.js';
|
|
39
36
|
|
|
40
37
|
/**
|
|
41
|
-
*
|
|
42
|
-
*
|
|
43
|
-
*
|
|
44
|
-
*
|
|
45
|
-
*
|
|
38
|
+
* The undo-stack entry for a server-authored write pushed to the editor.
|
|
39
|
+
*
|
|
40
|
+
* **A user-facing LABEL, not a log string**, which is easy to miss because it
|
|
41
|
+
* travels as an options field rather than as a message: LSP specifies
|
|
42
|
+
* `ApplyWorkspaceEditParams.label` as "presented in the user interface for
|
|
43
|
+
* example on an undo stack to undo the workspace edit". So a user who edits
|
|
44
|
+
* through a form or drags a diagram node reads this in their editor's undo menu
|
|
45
|
+
* — which is why it is rendered like any other message the server sends rather
|
|
46
|
+
* than left as the English literal it was.
|
|
47
|
+
*
|
|
48
|
+
* Parameterless deliberately. The obvious improvement is to name the document,
|
|
49
|
+
* and it is the wrong one: an undo menu is already grouped under the file, so
|
|
50
|
+
* the URI would be noise in the one place it is redundant.
|
|
46
51
|
*/
|
|
47
|
-
|
|
52
|
+
export const MODEL_UPDATE_EDIT = defineMessage('hydranium/core/model-update-edit', 'Update Model');
|
|
53
|
+
|
|
54
|
+
/** Max time {@link DefaultModelService.settleSave} waits for the build to settle and the sync chain to drain. */
|
|
55
|
+
const SAVE_SETTLE_TIMEOUT_MS = 10_000;
|
|
48
56
|
|
|
49
57
|
/**
|
|
50
58
|
* Constructor options for {@link ModelService}. All fields are optional,
|
|
@@ -52,75 +60,57 @@ class SaveSettleTimeoutError extends Error {}
|
|
|
52
60
|
*/
|
|
53
61
|
export interface ModelServiceOptions extends LogNameOptions {
|
|
54
62
|
/**
|
|
55
|
-
*
|
|
56
|
-
*
|
|
57
|
-
*
|
|
58
|
-
* `
|
|
59
|
-
* `Logger.time` debug timing log is unchanged either way).
|
|
60
|
-
*
|
|
61
|
-
* Pure observability — does NOT abort the update, does NOT change
|
|
62
|
-
* resolution semantics. Adopters wanting a hard timeout that throws
|
|
63
|
-
* instead override {@link ModelService.update} on their subclass and
|
|
64
|
-
* race the parent call against their own deadline.
|
|
65
|
-
*
|
|
66
|
-
* Recommended starting threshold: 2-5 seconds for interactive paths
|
|
67
|
-
* (form save, diagram edit). Workspaces with very large documents
|
|
68
|
-
* or slow validation may legitimately exceed 5s on the cold path —
|
|
69
|
-
* tune per workspace.
|
|
70
|
-
*
|
|
71
|
-
* Accepts a {@link MaybeObservableValue} so the threshold can be a
|
|
72
|
-
* fixed constant or bound to a user setting via `Settings.number`
|
|
73
|
-
* and retuned live. Leaving it unset disables the warn line entirely
|
|
74
|
-
* (and skips the per-update stopwatch).
|
|
75
|
-
*/
|
|
76
|
-
readonly slowUpdateWarnMs?: MaybeObservableValue<number>;
|
|
77
|
-
/**
|
|
78
|
-
* Serialise the facade's own build under the workspace WRITE lock, the way
|
|
79
|
-
* Langium's `DefaultDocumentUpdateHandler` dispatches its build. Default
|
|
80
|
-
* `true`.
|
|
81
|
-
*
|
|
82
|
-
* **Why it defaults on.** Unlocked, the facade's build races the LSP bridge's
|
|
83
|
-
* build of the same URI — both are legitimate (the bridge exists only under a
|
|
84
|
-
* `Connection`, so the facade stands in for it headless), but nothing
|
|
85
|
-
* serialises them, so both run a full validation pass and Langium appends the
|
|
86
|
-
* second onto the first. Every diagnostic is then duplicated, and the
|
|
87
|
-
* duplication compounds per rebuild. Serialised, Langium elides the second
|
|
88
|
-
* build entirely, so the redundant work goes too.
|
|
63
|
+
* Let the facade's build run without the workspace write lock when its
|
|
64
|
+
* caller already holds it: an integrity rule or build-phase pass that
|
|
65
|
+
* writes back through a session's `update` / `save`, or calls `rebuild`.
|
|
66
|
+
* Default `false`.
|
|
89
67
|
*
|
|
90
|
-
*
|
|
91
|
-
*
|
|
92
|
-
*
|
|
93
|
-
*
|
|
94
|
-
* `
|
|
95
|
-
*
|
|
96
|
-
*
|
|
68
|
+
* `WorkspaceLock` is not reentrant. Taking it from inside a holder cancels
|
|
69
|
+
* that holder and then waits for it to end, while the holder waits for this
|
|
70
|
+
* call, so neither completes. On `false` that call fails with
|
|
71
|
+
* {@link ReentrantWriteLockError} instead, wherever a host installs a
|
|
72
|
+
* write-lock scope tracker (`@hydranium/core/node` does at entry load); on
|
|
73
|
+
* `true` its build takes no lock. The wait after that build can still hang,
|
|
74
|
+
* because a document no build will carry is re-queued through the lock, and
|
|
75
|
+
* the re-queue waits for the holder to end.
|
|
97
76
|
*
|
|
98
|
-
*
|
|
99
|
-
*
|
|
100
|
-
*
|
|
101
|
-
*
|
|
102
|
-
*
|
|
103
|
-
*
|
|
104
|
-
*
|
|
105
|
-
* installs a write-lock scope tracker (`@hydranium/core/node` does at entry
|
|
106
|
-
* load; see {@link isInsideWriteLock}). Setting `false` is the escape hatch
|
|
107
|
-
* for an adopter whose reentrant shape is unavoidable — nothing acquires the
|
|
108
|
-
* lock then, so there is nothing to be reentrant about; prefer it over
|
|
109
|
-
* unserialised builds only in that case.
|
|
77
|
+
* Every other facade build takes the lock on either value. Unlocked, it can
|
|
78
|
+
* overlap another build of the same document: both run a full validation
|
|
79
|
+
* pass that Langium appends, and a caller can be handed a version that an
|
|
80
|
+
* integrity repair still running in the other build then moves past. Without
|
|
81
|
+
* a tracker the two cases cannot be told apart (see
|
|
82
|
+
* {@link isWriteLockScopeInstalled}), so `true` builds without the lock every
|
|
83
|
+
* time and accepts both.
|
|
110
84
|
*
|
|
111
85
|
* Accepts a {@link MaybeObservableValue} so it can be bound to a setting and
|
|
112
86
|
* flipped without a restart.
|
|
113
87
|
*/
|
|
114
|
-
readonly
|
|
88
|
+
readonly allowReentrantBuilds?: MaybeObservableValue<boolean>;
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
/** Options for a {@link DefaultModelService} wait on one document. */
|
|
92
|
+
export interface SyncedWaitOptions {
|
|
93
|
+
/**
|
|
94
|
+
* Build a root parsed from text older than the store's at the call, and
|
|
95
|
+
* reject once that build, or one the builder re-queues, is given up. Without
|
|
96
|
+
* it, such a root is left to other builds, and a wait they never end stays
|
|
97
|
+
* pending until its token is cancelled.
|
|
98
|
+
*/
|
|
99
|
+
readonly sync?: boolean;
|
|
115
100
|
}
|
|
116
101
|
|
|
117
102
|
/**
|
|
103
|
+
* The seam every non-LSP head talks to: the data server, the GLSP head and an
|
|
104
|
+
* adopter's own services reach documents through this slot rather than through
|
|
105
|
+
* the workspace stores.
|
|
106
|
+
*
|
|
118
107
|
* In-process facade over the framework's document plumbing
|
|
119
108
|
* (`HydraniumTextDocuments`, `LangiumDocuments`,
|
|
120
|
-
* `DocumentBuilder`, `WritableFileSystemProvider`). Owns the
|
|
121
|
-
*
|
|
122
|
-
*
|
|
123
|
-
* doesn't have to be re-implemented per
|
|
109
|
+
* `DocumentBuilder`, `WritableFileSystemProvider`). Owns the document
|
|
110
|
+
* lifecycle the data-server and GLSP heads delegate to — client sessions that
|
|
111
|
+
* open, update, save and close documents, the phase reads, and `ready` — so
|
|
112
|
+
* coordinating those primitives doesn't have to be re-implemented per head.
|
|
113
|
+
* Every open and write goes through a session from {@link createSession}.
|
|
124
114
|
*
|
|
125
115
|
* "Model" here means the parsed AST — distinct from the wire-shape
|
|
126
116
|
* `TransferDocument` in `@hydranium/protocol`.
|
|
@@ -130,9 +120,9 @@ export interface ModelServiceOptions extends LogNameOptions {
|
|
|
130
120
|
* Multiple in-process consumers want the same workspace-level
|
|
131
121
|
* operations:
|
|
132
122
|
* - The data-server head turns these into typed RPC methods.
|
|
133
|
-
* - The GLSP head uses the same lifecycle for diagram-driven edits
|
|
134
|
-
*
|
|
135
|
-
*
|
|
123
|
+
* - The GLSP head uses the same lifecycle for diagram-driven edits: GModel
|
|
124
|
+
* operation handlers write through the diagram's session and wait on phases
|
|
125
|
+
* before reading.
|
|
136
126
|
* - Server-internal callers (integrity service, ad-hoc bridges, tests)
|
|
137
127
|
* want the same operations without the wire serialisation step.
|
|
138
128
|
*
|
|
@@ -145,15 +135,16 @@ export interface ModelServiceOptions extends LogNameOptions {
|
|
|
145
135
|
*
|
|
146
136
|
* **Read-latest supersession**
|
|
147
137
|
*
|
|
148
|
-
*
|
|
149
|
-
* `DocumentBuilder.waitUntil` to wait for the integrity-settled
|
|
150
|
-
*
|
|
151
|
-
*
|
|
152
|
-
*
|
|
153
|
-
* event. Adopters wanting strict
|
|
154
|
-
* with vN's snapshot specifically, log
|
|
155
|
-
*
|
|
156
|
-
*
|
|
138
|
+
* A session's default `update` and `save` use Langium's per-URI
|
|
139
|
+
* `DocumentBuilder.waitUntil` to wait for `Validated` (the integrity-settled
|
|
140
|
+
* landmark {@link IntegrityService.SettledState} when rebuilds do not
|
|
141
|
+
* validate), then read the post-build state. Concurrent in-process callers
|
|
142
|
+
* on the same URI all see the latest post-build snapshot — none deadlock
|
|
143
|
+
* waiting for a specific version's settled event. Adopters wanting strict
|
|
144
|
+
* version-matched semantics (resolve with vN's snapshot specifically, log
|
|
145
|
+
* "vN superseded by vM at vN+1") override
|
|
146
|
+
* `DefaultClientSession.updateDocument` to attach a phase-listener with
|
|
147
|
+
* explicit version checks; the framework default doesn't need it for safety.
|
|
157
148
|
*
|
|
158
149
|
* **Returns AST snapshots, not wire envelopes**
|
|
159
150
|
*
|
|
@@ -173,20 +164,129 @@ export interface ModelServiceOptions extends LogNameOptions {
|
|
|
173
164
|
* by URI happens here so consumers can subscribe per-document without
|
|
174
165
|
* implementing the URI gate at each callsite.
|
|
175
166
|
*
|
|
167
|
+
* **Two families.** `waitFor*` only waits: it rejects for a URI with no
|
|
168
|
+
* document, and for a root behind the store's text it waits for whatever
|
|
169
|
+
* builds it next, so it never ends if nothing does. `ensureDocumentState` and
|
|
170
|
+
* the phase shorthands over it build a missing document, and build a root
|
|
171
|
+
* behind its text, rejecting when that build fails twice. Both re-queue a
|
|
172
|
+
* document the builder's last build left short of the state.
|
|
173
|
+
*
|
|
174
|
+
* Both resolve at the state with a root parsed from text no older than the
|
|
175
|
+
* store's version at the call; inside the write lock, at the state alone, since
|
|
176
|
+
* the build that would sync the document to that version cannot start until
|
|
177
|
+
* it is released.
|
|
178
|
+
*
|
|
179
|
+
* Do not await one inside a build phase listener: a browser host installs no
|
|
180
|
+
* write-lock scope, so the wait cannot tell it is inside a build and waits for
|
|
181
|
+
* one that cannot start. Nor inside a `WorkspaceLock.read`: the lock starts no
|
|
182
|
+
* write, the build included, while a read runs.
|
|
183
|
+
*
|
|
184
|
+
* **Diagnostics are typed `never` below `Validated`.** Validation is the last
|
|
185
|
+
* phase, so at any earlier landmark the array either is not yet computed or
|
|
186
|
+
* still holds the previous build's, and reading it would take stale results
|
|
187
|
+
* for fresh ones. A caller that needs diagnostics asks for {@link validated}.
|
|
188
|
+
*
|
|
189
|
+
* What the `never` buys, exactly: reading a field off an element is a compile
|
|
190
|
+
* error, and nothing can be appended. It does NOT stop a caller assigning an
|
|
191
|
+
* element to a typed variable, because `never` is assignable to everything — so
|
|
192
|
+
* this is a guard against reaching for diagnostics by accident, not a seal
|
|
193
|
+
* against doing it deliberately.
|
|
194
|
+
*
|
|
195
|
+
* The waits resolve at or ABOVE their target, so an already-validated document
|
|
196
|
+
* does carry usable diagnostics and the `never` over-forbids there. That
|
|
197
|
+
* direction is the safe one: the alternative permits stale reads silently. A
|
|
198
|
+
* member taking a phase as a PARAMETER returns `TDiagnostic`, and leaves them
|
|
199
|
+
* absent for a phase below `Validated`.
|
|
200
|
+
*
|
|
176
201
|
* **Generic parameters.**
|
|
177
202
|
* - `TAst` — the AST root type each consumer expects on the returned
|
|
178
203
|
* {@link AstDocument}. Constrained to {@link AstNode}.
|
|
179
|
-
* - `TDiagnostic` —
|
|
180
|
-
* `
|
|
181
|
-
*
|
|
204
|
+
* - `TDiagnostic` — the AST-layer diagnostic: whatever the build left on
|
|
205
|
+
* `LangiumDocument.diagnostics`, carried through on the returned
|
|
206
|
+
* {@link AstDocument}. Defaults to {@link AstDiagnostic}.
|
|
207
|
+
* **Not the `TransferEncoder`'s parameter of the same name**, which is
|
|
208
|
+
* that encoder's OUTPUT and so names the wire shape. This one names its
|
|
209
|
+
* input, and an adopter binds the two to different types.
|
|
210
|
+
* - `TTransfer` — transfer-model root a session's `update` / `save` accept
|
|
182
211
|
* args. Constrained to {@link TransferElement}. Defaults to the
|
|
183
212
|
* structural base.
|
|
184
213
|
*/
|
|
185
|
-
export
|
|
214
|
+
export interface ModelService<
|
|
186
215
|
TAst extends AstNode,
|
|
187
|
-
TDiagnostic =
|
|
216
|
+
TDiagnostic extends AstDiagnostic = AstDiagnostic,
|
|
217
|
+
TTransfer extends TransferElement = TransferElement
|
|
218
|
+
> {
|
|
219
|
+
/**
|
|
220
|
+
* Resolves once the workspace has been initialised and its first build has
|
|
221
|
+
* completed — the gate every read should wait behind, since a document
|
|
222
|
+
* queried before it may be unbuilt and reach no phase.
|
|
223
|
+
*
|
|
224
|
+
* A property rather than a method, matching `ProjectManager.ready` and
|
|
225
|
+
* Langium's `WorkspaceManager.ready`. An implementation needing a stricter
|
|
226
|
+
* gate supplies a Promise that awaits its own concern as well.
|
|
227
|
+
*/
|
|
228
|
+
readonly ready: Promise<void>;
|
|
229
|
+
|
|
230
|
+
// Wait only; a root behind its text is left to another build.
|
|
231
|
+
waitForDocumentState(uri: string, state: DocumentState, cancelToken?: CancellationToken): Promise<AstDocument<TAst, TDiagnostic>>;
|
|
232
|
+
waitForDocumentSettled(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>>;
|
|
233
|
+
waitForBuilderState(state: DocumentState, cancelToken?: CancellationToken): Promise<void>;
|
|
234
|
+
|
|
235
|
+
// Build what is missing or behind its text, then wait.
|
|
236
|
+
ensureDocumentState(uri: string, state?: DocumentState, cancelToken?: CancellationToken): Promise<AstDocument<TAst, TDiagnostic>>;
|
|
237
|
+
rebuild(uri: string, state?: DocumentState, cancelToken?: CancellationToken): Promise<AstDocument<TAst, TDiagnostic>>;
|
|
238
|
+
/**
|
|
239
|
+
* Throw where {@link rebuild} would reject as reentrant. A write calls it
|
|
240
|
+
* before applying its text: a text applied and then refused stays applied
|
|
241
|
+
* with no build to follow it.
|
|
242
|
+
*/
|
|
243
|
+
assertCanBuild(uri: string): void;
|
|
244
|
+
parsed(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>>;
|
|
245
|
+
linked(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>>;
|
|
246
|
+
settled(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>>;
|
|
247
|
+
indexed(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>>;
|
|
248
|
+
validated(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, TDiagnostic>>;
|
|
249
|
+
|
|
250
|
+
isOpen(uri: string): boolean;
|
|
251
|
+
snapshot(uri: string): AstDocument<TAst, TDiagnostic> | undefined;
|
|
188
252
|
/**
|
|
189
|
-
*
|
|
253
|
+
* The text a session's write of `model` to `uri` applies: a textual model
|
|
254
|
+
* as given, a structured one rewritten and serialised.
|
|
255
|
+
*/
|
|
256
|
+
modelToText(uri: string, model: TTransfer | string, cancelToken?: CancellationToken): Promise<string>;
|
|
257
|
+
getDocument(uri: string): LangiumDocument | undefined;
|
|
258
|
+
|
|
259
|
+
onModelUpdated(uri: string, listener: (event: AstDocumentUpdatedEvent<TAst, TDiagnostic>) => void): Disposable;
|
|
260
|
+
onModelSaved(uri: string, listener: (event: AstDocumentSavedEvent<TAst, TDiagnostic>) => void): Disposable;
|
|
261
|
+
onClientClosed(uri: string, clientId: string, listener: () => void): Disposable;
|
|
262
|
+
|
|
263
|
+
/**
|
|
264
|
+
* Start a client session, the only way to open and write documents through
|
|
265
|
+
* this service. Pass a `label` naming the participant; without one it is
|
|
266
|
+
* `session`. The id defaults to `label#` plus a random UUID; a fixed
|
|
267
|
+
* `clientId` is taken as given. Throws `ReservedClientIdError` when the id
|
|
268
|
+
* is reserved by the framework, and `DuplicateClientIdError` when it is
|
|
269
|
+
* held by another live session or has documents open under it as a client
|
|
270
|
+
* that is not a session.
|
|
271
|
+
*
|
|
272
|
+
* `TOpenOptions` types the options the session's `open` takes and its
|
|
273
|
+
* `openOptions` returns. The narrowing is an unchecked cast, and it holds
|
|
274
|
+
* only for the caller that started the session: a holder reached through
|
|
275
|
+
* {@link getSession} sees plain `OpenOptions`.
|
|
276
|
+
*/
|
|
277
|
+
createSession<TOpenOptions extends OpenOptions = OpenOptions>(
|
|
278
|
+
label?: string,
|
|
279
|
+
clientId?: string
|
|
280
|
+
): ClientSession<TAst, TDiagnostic, TTransfer, TOpenOptions>;
|
|
281
|
+
/** The live session started under `clientId`, or `undefined` once it has ended or was never started. */
|
|
282
|
+
getSession(clientId: string): ClientSession<TAst, TDiagnostic, TTransfer> | undefined;
|
|
283
|
+
}
|
|
284
|
+
|
|
285
|
+
export class DefaultModelService<
|
|
286
|
+
TAst extends AstNode,
|
|
287
|
+
TDiagnostic extends AstDiagnostic = AstDiagnostic,
|
|
288
|
+
/**
|
|
289
|
+
* Structured payload a session's `update` / `save` accept. Constrained to
|
|
190
290
|
* {@link TransferElement} — the minimal `{ readonly $type: string }`
|
|
191
291
|
* shape. Both transfer-model overlay roots (which extend
|
|
192
292
|
* `TransferElement` explicitly) and AST root types (which have
|
|
@@ -195,7 +295,7 @@ export class ModelService<
|
|
|
195
295
|
* integrity service) that pass AST roots remain compatible.
|
|
196
296
|
*/
|
|
197
297
|
TTransfer extends TransferElement = TransferElement
|
|
198
|
-
> {
|
|
298
|
+
> implements ModelService<TAst, TDiagnostic, TTransfer> {
|
|
199
299
|
protected readonly tracer: Tracer;
|
|
200
300
|
/**
|
|
201
301
|
* The single document-identity seam (`services.workspace.DocumentUriPolicy`),
|
|
@@ -206,14 +306,8 @@ export class ModelService<
|
|
|
206
306
|
* (see {@link DocumentUriPolicy}).
|
|
207
307
|
*/
|
|
208
308
|
protected readonly uriPolicy: DocumentUriPolicy;
|
|
209
|
-
/**
|
|
210
|
-
|
|
211
|
-
* was not supplied (warn line + stopwatch disabled). Reads `.value` per
|
|
212
|
-
* update so a setting-bound threshold retunes without reconstruction.
|
|
213
|
-
*/
|
|
214
|
-
protected readonly slowUpdateWarn?: ObservableValue<number>;
|
|
215
|
-
/** See {@link ModelServiceOptions.serializeBuilds}. Defaults to `true`. */
|
|
216
|
-
protected readonly serializeBuilds: ObservableValue<boolean>;
|
|
309
|
+
/** See {@link ModelServiceOptions.allowReentrantBuilds}. Defaults to `false`. */
|
|
310
|
+
protected readonly allowReentrantBuilds: ObservableValue<boolean>;
|
|
217
311
|
|
|
218
312
|
/**
|
|
219
313
|
* Per-URI applyEdit coalescing: at most one in-flight `applyEditToLanguageClient`
|
|
@@ -224,6 +318,16 @@ export class ModelService<
|
|
|
224
318
|
protected readonly syncChains = new Map<string, Promise<void>>();
|
|
225
319
|
protected readonly pendingSync = new Map<string, string>();
|
|
226
320
|
|
|
321
|
+
/** The live sessions this service started, by client id, for {@link getSession}. */
|
|
322
|
+
protected readonly sessions = new Map<string, ClientSession<TAst, TDiagnostic, TTransfer>>();
|
|
323
|
+
/**
|
|
324
|
+
* Drops an ended session from {@link sessions}. Subscribed by the first
|
|
325
|
+
* {@link createSession} rather than at construction, so a services tree with
|
|
326
|
+
* no text store, or one that knows nothing of sessions, still constructs
|
|
327
|
+
* this service.
|
|
328
|
+
*/
|
|
329
|
+
protected sessionCloseListener?: Disposable;
|
|
330
|
+
|
|
227
331
|
/**
|
|
228
332
|
* Workspace-level readiness gate. Resolves when the framework has
|
|
229
333
|
* finished its first workspace build cycle and the `ModelService`
|
|
@@ -264,21 +368,17 @@ export class ModelService<
|
|
|
264
368
|
) {
|
|
265
369
|
this.tracer = services.Tracer.for(options.logName ?? 'ModelService').trace('instantiated');
|
|
266
370
|
this.uriPolicy = services.workspace.DocumentUriPolicy;
|
|
267
|
-
this.
|
|
268
|
-
this.serializeBuilds = ObservableValue.from(options.serializeBuilds ?? true);
|
|
371
|
+
this.allowReentrantBuilds = ObservableValue.from(options.allowReentrantBuilds ?? false);
|
|
269
372
|
// Optional-chain so a harness that binds no WorkspaceManager awaits
|
|
270
373
|
// `undefined` and resolves immediately; production hosts always have it
|
|
271
374
|
// bound.
|
|
272
375
|
// Deliberately NO fallback to Langium's `ready`: it resolves pre-build,
|
|
273
376
|
// so falling back to it would silently reinstate the very gap this gate
|
|
274
377
|
// exists to close.
|
|
275
|
-
// Captured rather than read off `this` inside the closure, which TS cannot
|
|
276
|
-
// prove runs after the field is assigned.
|
|
277
|
-
const tracer = this.tracer;
|
|
278
378
|
this.ready = (async () => {
|
|
279
379
|
try {
|
|
280
380
|
await services.workspace.WorkspaceManager?.workspaceInitialized;
|
|
281
|
-
} catch
|
|
381
|
+
} catch {
|
|
282
382
|
// NEVER rejects, deliberately. This gate is about TIMING — "the
|
|
283
383
|
// initial build has finished" — not about whether it succeeded, and
|
|
284
384
|
// Langium's `ready` (what it replaced) could not reject at all.
|
|
@@ -286,8 +386,8 @@ export class ModelService<
|
|
|
286
386
|
// build (routine — any write preempts one) and on a failed one
|
|
287
387
|
// (e.g. a disposed connection at teardown). Propagating either would
|
|
288
388
|
// fail every `waitForReady` for the rest of the process lifetime,
|
|
289
|
-
// a far worse failure than the late gate this exists to fix.
|
|
290
|
-
|
|
389
|
+
// a far worse failure than the late gate this exists to fix. The
|
|
390
|
+
// workspace manager logs the outcome.
|
|
291
391
|
}
|
|
292
392
|
})();
|
|
293
393
|
// One persistent listener mirroring non-LSP-client changes back to the LSP
|
|
@@ -309,10 +409,12 @@ export class ModelService<
|
|
|
309
409
|
// ============================================================
|
|
310
410
|
|
|
311
411
|
/**
|
|
312
|
-
* Wait for the document at `uri` to reach `state
|
|
313
|
-
*
|
|
314
|
-
*
|
|
315
|
-
*
|
|
412
|
+
* Wait for the document at `uri` to reach `state` with a root no older than
|
|
413
|
+
* the store's text at the call. Rejects if `uri` is not in the document
|
|
414
|
+
* registry. A root behind its text is not built: the wait lasts until
|
|
415
|
+
* something else builds it, so use {@link ensureDocumentState} where
|
|
416
|
+
* nothing may. Builds that keep failing leave the wait pending, to its
|
|
417
|
+
* cancellation token.
|
|
316
418
|
*
|
|
317
419
|
* Wrapped in a debug-level timing log via {@link Tracer.time} so
|
|
318
420
|
* slow per-URI waits surface in build telemetry; the URI is
|
|
@@ -326,11 +428,12 @@ export class ModelService<
|
|
|
326
428
|
* Wait for the document at `uri` to reach the integrity-settled landmark
|
|
327
429
|
* ({@link IntegrityService.SettledState}) — the earliest phase at which the
|
|
328
430
|
* AST + serialised text are stable post-integrity. Convenience wrapper over
|
|
329
|
-
* {@link waitForDocumentState}
|
|
330
|
-
* case (e.g. settling a save). Pure wait — does not trigger a build.
|
|
431
|
+
* {@link waitForDocumentState}, and like it builds nothing behind its text.
|
|
331
432
|
*/
|
|
332
|
-
async waitForDocumentSettled(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst,
|
|
333
|
-
return this.
|
|
433
|
+
async waitForDocumentSettled(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>> {
|
|
434
|
+
return this.withoutDiagnostics(
|
|
435
|
+
await this.waitForDocumentStateCanonical(this.uriPolicy.canonicalUri(uri), IntegrityService.SettledState, cancelToken)
|
|
436
|
+
);
|
|
334
437
|
}
|
|
335
438
|
|
|
336
439
|
/**
|
|
@@ -342,21 +445,108 @@ export class ModelService<
|
|
|
342
445
|
* the identity once instead of re-running the (filesystem-touching) `realpath`
|
|
343
446
|
* at every wait. The `CanonicalUri` parameter type enforces that — a raw
|
|
344
447
|
* `string` cannot be passed without minting through the URI policy.
|
|
448
|
+
*
|
|
449
|
+
* With `options.sync`, a root behind the store's text is built, as in
|
|
450
|
+
* {@link ensureDocumentState}; without it, the root is left to other builds,
|
|
451
|
+
* as in {@link waitForDocumentState}. Below `Validated` the envelope has no
|
|
452
|
+
* diagnostics: see {@link withoutDiagnostics}.
|
|
345
453
|
*/
|
|
346
454
|
protected async waitForDocumentStateCanonical(
|
|
347
455
|
uri: CanonicalUri,
|
|
348
456
|
state: DocumentState,
|
|
349
|
-
cancelToken?: CancellationToken
|
|
457
|
+
cancelToken?: CancellationToken,
|
|
458
|
+
options: SyncedWaitOptions = {}
|
|
350
459
|
): Promise<AstDocument<TAst, TDiagnostic>> {
|
|
351
460
|
const documentUri = UriUtils.toUri(uri);
|
|
461
|
+
// Read at call time: a later edit must not extend this wait.
|
|
462
|
+
const textVersion = isInsideWriteLock() ? undefined : this.services.workspace.TextDocuments.textState(uri)?.version;
|
|
352
463
|
await this.tracer
|
|
353
464
|
.withUri(uri)
|
|
354
465
|
.time(
|
|
355
466
|
`Wait for document state '${DocumentState[state]}'`,
|
|
356
|
-
() => this.
|
|
467
|
+
() => this.waitUntilSynced(documentUri, state, textVersion, cancelToken, options),
|
|
357
468
|
'debug'
|
|
358
469
|
);
|
|
359
|
-
|
|
470
|
+
const document = this.toAstDocument(documentUri);
|
|
471
|
+
return state >= DocumentState.Validated ? document : this.withoutDiagnostics(document);
|
|
472
|
+
}
|
|
473
|
+
|
|
474
|
+
/**
|
|
475
|
+
* Wait for `state` with a root parsed from text at `textVersion` or later. A
|
|
476
|
+
* root no factory recorded counts as synced, since no build records it.
|
|
477
|
+
* With `options.sync`, a root still behind is built through
|
|
478
|
+
* `VersionSyncService.syncTo`, and the wait rejects once that build, or one
|
|
479
|
+
* the builder re-queues to reach `state`, is given up. Without it, the wait
|
|
480
|
+
* lasts until another build parses the text, and stays pending when the
|
|
481
|
+
* builder gives up re-queuing the document.
|
|
482
|
+
*/
|
|
483
|
+
protected async waitUntilSynced(
|
|
484
|
+
uri: URI,
|
|
485
|
+
state: DocumentState,
|
|
486
|
+
textVersion: TextVersion | undefined,
|
|
487
|
+
cancelToken?: CancellationToken,
|
|
488
|
+
options: SyncedWaitOptions = {}
|
|
489
|
+
): Promise<void> {
|
|
490
|
+
const builder = this.services.workspace.DocumentBuilder;
|
|
491
|
+
const sync = this.services.workspace.VersionSyncService;
|
|
492
|
+
const waitOptions = { rejectWhenStuck: options.sync === true };
|
|
493
|
+
await builder.waitUntil(state, uri, cancelToken, waitOptions);
|
|
494
|
+
if (textVersion === undefined) {
|
|
495
|
+
return;
|
|
496
|
+
}
|
|
497
|
+
while (!sync.isSyncedTo(uri, textVersion)) {
|
|
498
|
+
const build = options.sync === true ? sync.syncTo(uri, textVersion) : undefined;
|
|
499
|
+
this.tracer
|
|
500
|
+
.withUri(uri.toString())
|
|
501
|
+
.debug(`waiting for ${uri.toString()} to reach ${DocumentState[state]} at v${textVersion} or later`);
|
|
502
|
+
await this.nextParseOrDeletion(uri, cancelToken, build);
|
|
503
|
+
await builder.waitUntil(state, uri, cancelToken, waitOptions);
|
|
504
|
+
}
|
|
505
|
+
}
|
|
506
|
+
|
|
507
|
+
/**
|
|
508
|
+
* Resolves once a parse of `uri` has been recorded or a build has deleted
|
|
509
|
+
* it, rejecting with `OperationCancelled` when `cancelToken` is cancelled
|
|
510
|
+
* first, and with an error when `build`, the build requested for it, is
|
|
511
|
+
* given up. A `Parsed` phase listener cannot serve: a cancel right after the
|
|
512
|
+
* parse skips it, and the resumed build does not parse again.
|
|
513
|
+
*/
|
|
514
|
+
protected nextParseOrDeletion(
|
|
515
|
+
uri: URI,
|
|
516
|
+
cancelToken: CancellationToken = CancellationToken.None,
|
|
517
|
+
build?: Promise<boolean>
|
|
518
|
+
): Promise<void> {
|
|
519
|
+
const builder = this.services.workspace.DocumentBuilder;
|
|
520
|
+
return new Promise<void>((resolve, reject) => {
|
|
521
|
+
// A cancelled token's listener runs a macrotask later, after a build
|
|
522
|
+
// that started meanwhile may have parsed.
|
|
523
|
+
if (cancelToken.isCancellationRequested) {
|
|
524
|
+
reject(OperationCancelled);
|
|
525
|
+
return;
|
|
526
|
+
}
|
|
527
|
+
const done = (settle: () => void): void => {
|
|
528
|
+
parsed.dispose();
|
|
529
|
+
deleted.dispose();
|
|
530
|
+
cancelled.dispose();
|
|
531
|
+
settle();
|
|
532
|
+
};
|
|
533
|
+
const parsed = this.services.workspace.VersionSyncService.onDidRecordModel(document => {
|
|
534
|
+
if (UriUtils.equals(document.uri, uri)) {
|
|
535
|
+
done(resolve);
|
|
536
|
+
}
|
|
537
|
+
});
|
|
538
|
+
const deleted = builder.onUpdate((_changed, deletedUris) => {
|
|
539
|
+
if (deletedUris.some(deletedUri => UriUtils.equals(deletedUri, uri))) {
|
|
540
|
+
done(resolve);
|
|
541
|
+
}
|
|
542
|
+
});
|
|
543
|
+
const cancelled = cancelToken.onCancellationRequested(() => done(() => reject(OperationCancelled)));
|
|
544
|
+
void build?.then(built => {
|
|
545
|
+
if (!built) {
|
|
546
|
+
done(() => reject(new Error(`The build that would sync ${uri.toString()} to its text failed`)));
|
|
547
|
+
}
|
|
548
|
+
});
|
|
549
|
+
});
|
|
360
550
|
}
|
|
361
551
|
|
|
362
552
|
/**
|
|
@@ -380,31 +570,35 @@ export class ModelService<
|
|
|
380
570
|
* Force a fresh build of the document at `uri` and wait for it to
|
|
381
571
|
* reach `state` (or the integrity-settled landmark
|
|
382
572
|
* {@link IntegrityService.SettledState} if omitted).
|
|
383
|
-
* Always
|
|
384
|
-
*
|
|
385
|
-
* you want to re-process from scratch.
|
|
573
|
+
* Always builds the document, whether or not it is already in the
|
|
574
|
+
* registry, in a build of its own or in one already scheduled that carries
|
|
575
|
+
* it — call this when you want to re-process from scratch.
|
|
386
576
|
*
|
|
387
|
-
* The facade is responsible for
|
|
388
|
-
* directly because Langium's `DefaultDocumentUpdateHandler.didChangeContent`
|
|
577
|
+
* The facade is responsible for requesting the build itself because Langium's `DefaultDocumentUpdateHandler.didChangeContent`
|
|
389
578
|
* (the standard text-document → builder bridge) only runs under an
|
|
390
579
|
* LSP `Connection`. Running headless the bridge never fires; the
|
|
391
580
|
* facade stands in for it on its own update path.
|
|
392
581
|
*
|
|
393
582
|
* Coexistence with an LSP head running on the same `DocumentBuilder` is
|
|
394
|
-
* fine
|
|
395
|
-
*
|
|
396
|
-
*
|
|
397
|
-
*
|
|
398
|
-
*
|
|
399
|
-
*
|
|
400
|
-
* and Langium appends the second set onto the first, duplicating every
|
|
401
|
-
* diagnostic.
|
|
402
|
-
* {@link ModelServiceOptions.
|
|
403
|
-
* non-reentrancy hazard
|
|
583
|
+
* fine: the LSP head builds from the LSP-driven event and the facade from
|
|
584
|
+
* its own RPC-driven event — both legitimate — and both go through
|
|
585
|
+
* `HydraniumDocumentBuilder.scheduleUpdate`, which serialises them under
|
|
586
|
+
* the workspace WRITE lock and lets the second share the first's build
|
|
587
|
+
* where that build carries it. Langium alone does not coalesce concurrent
|
|
588
|
+
* builds of one URI: two unserialised builds each run a full validation
|
|
589
|
+
* pass and Langium appends the second set onto the first, duplicating every
|
|
590
|
+
* diagnostic. A caller that already holds the lock builds without it only
|
|
591
|
+
* under {@link ModelServiceOptions.allowReentrantBuilds} — see there for the
|
|
592
|
+
* non-reentrancy hazard.
|
|
593
|
+
*
|
|
594
|
+
* An override calls the base before it awaits. Under an LSP connection the
|
|
595
|
+
* store's change event has already asked the update handler to build a
|
|
596
|
+
* session's write; an override whose await outlasts that build makes the
|
|
597
|
+
* base's request start a build of its own, so the write is built and
|
|
598
|
+
* delivered twice.
|
|
404
599
|
*
|
|
405
|
-
*
|
|
406
|
-
*
|
|
407
|
-
* on their subclass.
|
|
600
|
+
* Rejects when the build leaves no document for `uri`, as for a URI with
|
|
601
|
+
* neither a file nor text: the wait after it has nothing to wait on.
|
|
408
602
|
*
|
|
409
603
|
* Consumers wanting "give me this doc at state X, building only if
|
|
410
604
|
* needed" — use the per-state methods ({@link parsed} / {@link linked}
|
|
@@ -416,8 +610,8 @@ export class ModelService<
|
|
|
416
610
|
|
|
417
611
|
/**
|
|
418
612
|
* Internal build core operating on an already-{@link CanonicalUri canonical}
|
|
419
|
-
* URI — the build counterpart to {@link waitForDocumentStateCanonical}.
|
|
420
|
-
*
|
|
613
|
+
* URI — the build counterpart to {@link waitForDocumentStateCanonical}.
|
|
614
|
+
* Requests the build, then waits via the canonical wait core, so the
|
|
421
615
|
* identity is resolved once at the public door and neither sink re-runs the
|
|
422
616
|
* `realpath`. (`DocumentBuilder.update` still resolves each URI internally for
|
|
423
617
|
* directory flattening — that is the build's own existence-aware resolution,
|
|
@@ -429,66 +623,61 @@ export class ModelService<
|
|
|
429
623
|
cancelToken?: CancellationToken
|
|
430
624
|
): Promise<AstDocument<TAst, TDiagnostic>> {
|
|
431
625
|
const documentUri = UriUtils.toUri(uri);
|
|
432
|
-
// Runs under the workspace WRITE lock,
|
|
433
|
-
// `
|
|
434
|
-
//
|
|
626
|
+
// Runs under the workspace WRITE lock, through the builder's
|
|
627
|
+
// `scheduleUpdate` like the LSP update handler's build, so the build the
|
|
628
|
+
// store's change event already scheduled for this write carries this
|
|
629
|
+
// request too rather than being cancelled by it.
|
|
435
630
|
//
|
|
436
631
|
// Unlocked, this build races the LSP bridge's build of the same URI: both
|
|
437
632
|
// are legitimate (the bridge only exists under a `Connection`, so the
|
|
438
|
-
// facade stands in for it headless), and
|
|
439
|
-
//
|
|
440
|
-
// two, so both reach `Validated`, and because each computes its missing
|
|
633
|
+
// facade stands in for it headless), and nothing serialises the two, so
|
|
634
|
+
// both reach `Validated`, and because each computes its missing
|
|
441
635
|
// validation categories before the other has recorded its own, both run a
|
|
442
636
|
// FULL pass and Langium appends the second onto the first (its append is
|
|
443
637
|
// meant for category-partitioned passes). The user-visible result is every
|
|
444
638
|
// diagnostic duplicated, plus double the validation work per write.
|
|
445
639
|
//
|
|
446
|
-
//
|
|
447
|
-
// the
|
|
448
|
-
|
|
449
|
-
|
|
450
|
-
// is not reentrant: acquiring the write lock cancels the running holder,
|
|
451
|
-
// so a caller already inside one — an integrity rule or build-phase pass
|
|
452
|
-
// writing back through this facade — would cancel its own enclosing
|
|
453
|
-
// build and then likely stall in the phase wait below. The check is
|
|
454
|
-
// gated on `serializeBuilds` deliberately, because acquiring the lock IS
|
|
455
|
-
// the hazard: with serialisation off there is nothing to be reentrant
|
|
456
|
-
// about, which makes the existing opt-out the guard's opt-out too.
|
|
457
|
-
// Detection needs async-context propagation, so it is inert until a host
|
|
458
|
-
// installs a tracker (`@hydranium/core/node` does) — see
|
|
459
|
-
// `isInsideWriteLock`.
|
|
460
|
-
if (isInsideWriteLock()) {
|
|
461
|
-
throw new ReentrantWriteLockError(uri);
|
|
462
|
-
}
|
|
463
|
-
// The lock's OWN token, not the caller's: a later `write` cancels the
|
|
464
|
-
// running one through that token, so substituting the caller's would
|
|
465
|
-
// leave this build deaf to the lock's cancellation protocol. A caller
|
|
466
|
-
// token still governs the phase wait below.
|
|
467
|
-
await this.services.workspace.WorkspaceLock.write(lockToken =>
|
|
468
|
-
this.services.workspace.DocumentBuilder.update([documentUri], [], lockToken)
|
|
469
|
-
);
|
|
470
|
-
} else {
|
|
640
|
+
// A caller already inside the lock would cancel its own build and stall in
|
|
641
|
+
// the wait below; `allowReentrantBuilds` builds it unlocked, and without a
|
|
642
|
+
// tracker it cannot be told apart from any other caller.
|
|
643
|
+
if (this.allowReentrantBuilds.value && (isInsideWriteLock() || !isWriteLockScopeInstalled())) {
|
|
471
644
|
await this.services.workspace.DocumentBuilder.update([documentUri], [], cancelToken);
|
|
645
|
+
} else {
|
|
646
|
+
this.assertCanBuild(uri);
|
|
647
|
+
// The build runs on the lock's own token, which a later write cancels;
|
|
648
|
+
// the caller's token governs only the phase wait below.
|
|
649
|
+
await this.services.workspace.DocumentBuilder.scheduleUpdate([documentUri], []);
|
|
650
|
+
}
|
|
651
|
+
return this.waitForDocumentStateCanonical(uri, state ?? IntegrityService.SettledState, cancelToken, { sync: true });
|
|
652
|
+
}
|
|
653
|
+
|
|
654
|
+
assertCanBuild(uri: string): void {
|
|
655
|
+
if (isInsideWriteLock() && !this.allowReentrantBuilds.value) {
|
|
656
|
+
throw new ReentrantWriteLockError(uri);
|
|
472
657
|
}
|
|
473
|
-
return this.waitForDocumentStateCanonical(uri, state ?? IntegrityService.SettledState, cancelToken);
|
|
474
658
|
}
|
|
475
659
|
|
|
476
660
|
/**
|
|
477
661
|
* Per-state typed convenience methods. Each ensures the document at
|
|
478
662
|
* `uri` reaches the named phase and returns the AST envelope with
|
|
479
|
-
* the narrowest accurate diagnostics type for that phase
|
|
480
|
-
*
|
|
481
|
-
* registry) just waits via {@link waitForDocumentState}; cold path
|
|
482
|
-
* triggers a build via {@link rebuild}. Consumers do not need to
|
|
483
|
-
* know which path was taken.
|
|
663
|
+
* the narrowest accurate diagnostics type for that phase, building as
|
|
664
|
+
* {@link ensureDocumentState} does.
|
|
484
665
|
*
|
|
485
666
|
* Phase invariants encoded in the return type:
|
|
486
667
|
* - `parsed` / `linked` / `settled` / `indexed` return
|
|
487
|
-
* `AstDocument<TAst, never>` — diagnostics
|
|
488
|
-
*
|
|
668
|
+
* `AstDocument<TAst, never>` — no diagnostics have been computed at
|
|
669
|
+
* those phases.
|
|
489
670
|
* - `validated` returns `AstDocument<TAst, TDiagnostic>` — diagnostics
|
|
490
671
|
* are populated.
|
|
491
672
|
*
|
|
673
|
+
* **The `never` is enforced, not merely declared.** The wait underneath
|
|
674
|
+
* resolves at or ABOVE the requested state, so a document something else
|
|
675
|
+
* already carried past `Validated` would otherwise come back from
|
|
676
|
+
* `settled()` carrying a full diagnostics array typed `never`; these four
|
|
677
|
+
* strip it. An empty array here therefore means "this read does not report
|
|
678
|
+
* diagnostics", never "this document is clean" — call {@link validated}
|
|
679
|
+
* when the answer has to mean the second.
|
|
680
|
+
*
|
|
492
681
|
* `settled` is the integrity-overlay name for "all integrity rules
|
|
493
682
|
* have fired"; it maps to {@link IntegrityService.SettledState} (which
|
|
494
683
|
* equals `DocumentState.IndexedReferences`), but the dedicated method
|
|
@@ -496,19 +685,19 @@ export class ModelService<
|
|
|
496
685
|
* ever moves.
|
|
497
686
|
*/
|
|
498
687
|
async parsed(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>> {
|
|
499
|
-
return this.ensureDocumentState(uri, DocumentState.Parsed, cancelToken)
|
|
688
|
+
return this.withoutDiagnostics(await this.ensureDocumentState(uri, DocumentState.Parsed, cancelToken));
|
|
500
689
|
}
|
|
501
690
|
|
|
502
691
|
async linked(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>> {
|
|
503
|
-
return this.ensureDocumentState(uri, DocumentState.Linked, cancelToken)
|
|
692
|
+
return this.withoutDiagnostics(await this.ensureDocumentState(uri, DocumentState.Linked, cancelToken));
|
|
504
693
|
}
|
|
505
694
|
|
|
506
695
|
async settled(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>> {
|
|
507
|
-
return this.ensureDocumentState(uri, IntegrityService.SettledState, cancelToken)
|
|
696
|
+
return this.withoutDiagnostics(await this.ensureDocumentState(uri, IntegrityService.SettledState, cancelToken));
|
|
508
697
|
}
|
|
509
698
|
|
|
510
699
|
async indexed(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>> {
|
|
511
|
-
return this.ensureDocumentState(uri, DocumentState.IndexedReferences, cancelToken)
|
|
700
|
+
return this.withoutDiagnostics(await this.ensureDocumentState(uri, DocumentState.IndexedReferences, cancelToken));
|
|
512
701
|
}
|
|
513
702
|
|
|
514
703
|
async validated(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, TDiagnostic>> {
|
|
@@ -518,18 +707,13 @@ export class ModelService<
|
|
|
518
707
|
/**
|
|
519
708
|
* Ensure the document at `uri` reaches `state` (or the integrity-settled
|
|
520
709
|
* landmark {@link IntegrityService.SettledState} if omitted) and return its
|
|
521
|
-
* AST envelope.
|
|
522
|
-
*
|
|
523
|
-
*
|
|
524
|
-
*
|
|
525
|
-
*
|
|
526
|
-
*
|
|
527
|
-
*
|
|
528
|
-
* document. Also pairs with {@link waitForDocumentState} — the verb
|
|
529
|
-
* difference (`ensure` vs `waitFor`) signals the side-effect
|
|
530
|
-
* difference. The per-state convenience methods (`parsed` / `linked`
|
|
531
|
-
* / `settled` / `indexed` / `validated`) all delegate here with an
|
|
532
|
-
* explicit phase.
|
|
710
|
+
* AST envelope, with a root no older than the store's text at the call.
|
|
711
|
+
* A document not in `LangiumDocuments` is built via {@link rebuild}; a
|
|
712
|
+
* loaded one whose root is behind its text is built through
|
|
713
|
+
* `VersionSyncService.syncTo`. Until `state` is reached, the call rejects
|
|
714
|
+
* once that build, or one the builder re-queues, has failed twice, or the
|
|
715
|
+
* builder stops re-queuing the document. A loaded, current document is only
|
|
716
|
+
* awaited.
|
|
533
717
|
*/
|
|
534
718
|
async ensureDocumentState(uri: string, state?: DocumentState, cancelToken?: CancellationToken): Promise<AstDocument<TAst, TDiagnostic>> {
|
|
535
719
|
return this.ensureDocumentStateCanonical(this.uriPolicy.canonicalUri(uri), state, cancelToken);
|
|
@@ -552,120 +736,20 @@ export class ModelService<
|
|
|
552
736
|
): Promise<AstDocument<TAst, TDiagnostic>> {
|
|
553
737
|
const target = state ?? IntegrityService.SettledState;
|
|
554
738
|
if (this.services.workspace.LangiumDocuments.hasDocument(UriUtils.toUri(uri))) {
|
|
555
|
-
return this.waitForDocumentStateCanonical(uri, target, cancelToken);
|
|
739
|
+
return this.waitForDocumentStateCanonical(uri, target, cancelToken, { sync: true });
|
|
556
740
|
}
|
|
557
741
|
return this.rebuild(uri, target, cancelToken);
|
|
558
742
|
}
|
|
559
743
|
|
|
560
744
|
/**
|
|
561
|
-
*
|
|
562
|
-
*
|
|
563
|
-
* structured), pushed into the multi-client text-document store with
|
|
564
|
-
* a fresh version, drives a build to the target phase, and returns
|
|
565
|
-
* the post-build AST snapshot.
|
|
566
|
-
*
|
|
567
|
-
* **Read-latest supersession**: concurrent callers on the same URI
|
|
568
|
-
* all see the same post-build state once `waitUntil` resolves; none
|
|
569
|
-
* deadlock waiting for a specific version's settled event. The
|
|
570
|
-
* framework emits a post-resolution `debug` log line distinguishing
|
|
571
|
-
* "vN ready" from "vN ready at vM (superseded)" so callers can
|
|
572
|
-
* observe when their write was overtaken by a newer one before
|
|
573
|
-
* settling — purely observability, doesn't change resolution
|
|
574
|
-
* semantics. Adopters wanting version-matched resolution (resolve
|
|
575
|
-
* with vN's specific settled snapshot, intermediate-phase
|
|
576
|
-
* observability, slow-warn / hard-timeout behaviour) override this
|
|
577
|
-
* method.
|
|
578
|
-
*/
|
|
579
|
-
async update(args: TransferUpdateArgs<TTransfer>, cancelToken?: CancellationToken): Promise<AstDocument<TAst, TDiagnostic>> {
|
|
580
|
-
const stopwatch = this.slowUpdateWarn !== undefined ? this.services.Clock.stopwatch() : undefined;
|
|
581
|
-
// Per-stage self-time breakdown of the update/reconcile chain (serialise →
|
|
582
|
-
// open → apply → rebuild), opt-in at debug — the default path skips the
|
|
583
|
-
// session and `run` calls the stage directly. `update` is a per-operation
|
|
584
|
-
// method (one user save / diagram edit), not a per-node hot loop, so the
|
|
585
|
-
// stage closures `run` allocates on the non-debug path are negligible.
|
|
586
|
-
// Canonicalize the write URI once at the door and thread the resulting
|
|
587
|
-
// CanonicalUri through the chain. The text store keys documents by their
|
|
588
|
-
// canonical identity, so any spelling of a file — a canonical
|
|
589
|
-
// (server-identity) URI from a GLSP cross-document save derived from
|
|
590
|
-
// `findDocument(node).uri`, or the symlink path an editor opened — collapses
|
|
591
|
-
// to the one registration; there is no second registration to fork. The
|
|
592
|
-
// build step reuses the canonical wait core (`rebuildCanonical`) so the
|
|
593
|
-
// identity is not re-resolved downstream.
|
|
594
|
-
const uri = this.uriPolicy.canonicalUri(args.uri);
|
|
595
|
-
const session = Logger.isLevelEnabled('debug') ? this.tracer.profile(`model-update ${uri}`) : undefined;
|
|
596
|
-
const run = async <T>(stage: string, fn: () => MaybePromise<T>): Promise<T> => (session ? session.scope(stage, fn) : fn());
|
|
597
|
-
// Open WITH the new text so a cold URI (no open editor, no file on disk) is
|
|
598
|
-
// created from the payload rather than read from the filesystem — `update`
|
|
599
|
-
// is an upsert. For an already-open document `open` refreshes content (the
|
|
600
|
-
// text is ignored on that branch), so existing-document behaviour is
|
|
601
|
-
// unchanged. `version` is intentionally NOT forwarded to `open`: a cold
|
|
602
|
-
// create stays at its initial version, so a based-on-`version` update of a
|
|
603
|
-
// not-yet-existing document still trips the conflict gate below.
|
|
604
|
-
const text = await run('serialize', () => this.modelToText(uri, args.model, cancelToken));
|
|
605
|
-
await run('open', () => this.open({ uri, clientId: args.clientId, text }));
|
|
606
|
-
if (args.baseVersion !== undefined) {
|
|
607
|
-
const current = this.services.workspace.TextDocuments.version(uri);
|
|
608
|
-
if (current !== args.baseVersion) {
|
|
609
|
-
// Distinct from the post-build "superseded" debug line below: this is a
|
|
610
|
-
// based-on-stale rejection (the write never applies), not two writes racing.
|
|
611
|
-
this.tracer.debug(`Conflict on ${uri}: based-on v${args.baseVersion} stale, server at v${current}`);
|
|
612
|
-
throw new ConflictError(uri, args.baseVersion, current);
|
|
613
|
-
}
|
|
614
|
-
}
|
|
615
|
-
const appliedVersion = await run('apply', () => this.services.workspace.AstDocumentManager.update(uri, text, args.clientId));
|
|
616
|
-
// Dispatch through the public `rebuild` (which re-canonicalizes the already-
|
|
617
|
-
// canonical `uri` once, idempotently) rather than `rebuildCanonical`, so an
|
|
618
|
-
// adopter `rebuild` override stays in the update path. The redundant call is
|
|
619
|
-
// a single kernel-cached `realpath`; correctness of the override contract
|
|
620
|
-
// wins over shaving it.
|
|
621
|
-
const doc = await run('rebuild', () => this.rebuild(uri, undefined, cancelToken));
|
|
622
|
-
const finalVersion = this.services.workspace.TextDocuments.version(uri);
|
|
623
|
-
if (finalVersion > appliedVersion) {
|
|
624
|
-
this.tracer.debug(`Update to v${appliedVersion} ready at v${finalVersion} (superseded)`);
|
|
625
|
-
} else {
|
|
626
|
-
this.tracer.debug(`Update to v${appliedVersion} ready`);
|
|
627
|
-
}
|
|
628
|
-
if (this.slowUpdateWarn !== undefined && stopwatch) {
|
|
629
|
-
const elapsed = Math.round(stopwatch.elapsedMs);
|
|
630
|
-
const threshold = this.slowUpdateWarn.value;
|
|
631
|
-
if (elapsed >= threshold) {
|
|
632
|
-
this.tracer.withUri(uri).warn(`Slow update: ${elapsed}ms ≥ ${threshold}ms (v${appliedVersion}, client=${args.clientId})`);
|
|
633
|
-
}
|
|
634
|
-
}
|
|
635
|
-
// One line per stage (serialise / open / apply / rebuild) + unaccounted — only when profiling.
|
|
636
|
-
session?.report('debug');
|
|
637
|
-
return doc;
|
|
638
|
-
}
|
|
639
|
-
|
|
640
|
-
/**
|
|
641
|
-
* Persist `uri` to disk. Same content-change + settled-phase flow as
|
|
642
|
-
* {@link update}, then writes via the
|
|
643
|
-
* `WritableFileSystemProvider` and notifies the multi-client
|
|
644
|
-
* text-document store of the save (so any open LSP-side editor sees
|
|
645
|
-
* the `onDidSave` event regardless of who originated the persist).
|
|
646
|
-
*
|
|
647
|
-
* Returns the post-save AST snapshot.
|
|
648
|
-
*/
|
|
649
|
-
async save(args: TransferSaveArgs<TTransfer>, cancelToken?: CancellationToken): Promise<AstDocument<TAst, TDiagnostic>> {
|
|
650
|
-
// Dispatch through `update` (not its internals) so an adopter `update`
|
|
651
|
-
// override — version-matched resolution, etc. — applies to saves too.
|
|
652
|
-
const doc = await this.update(args, cancelToken);
|
|
653
|
-
// Persist under the same canonical identity `update` operated on. Writing
|
|
654
|
-
// the canonical (real) path follows any symlink to the same file, and the
|
|
655
|
-
// `onDidSave` keys the one canonical registration.
|
|
656
|
-
const uri = this.uriPolicy.canonicalUri(args.uri);
|
|
657
|
-
await this.services.workspace.AstDocumentManager.save(uri, args.clientId);
|
|
658
|
-
return doc;
|
|
659
|
-
}
|
|
660
|
-
|
|
661
|
-
/**
|
|
662
|
-
* Wait for the document at `uri` to reach the integrity-settled landmark and
|
|
745
|
+
* Wait for the document at `uri` to reach the integrity-settled landmark,
|
|
746
|
+
* building a root behind its text as {@link ensureDocumentState} does, and
|
|
663
747
|
* drain any in-flight write-path applyEdit sync chain (see {@link syncChains})
|
|
664
748
|
* so every language client reflects the latest content before a save returns.
|
|
665
749
|
* No-op tail for headless adopters — `syncChains` is empty without an LSP
|
|
666
750
|
* client. Bounded by {@link SAVE_SETTLE_TIMEOUT_MS} so a hung build, or an
|
|
667
|
-
* applyEdit reverse-RPC deadlock, can't freeze the caller; on timeout
|
|
668
|
-
* a warning and returns rather than throwing.
|
|
751
|
+
* applyEdit reverse-RPC deadlock, can't freeze the caller; on timeout or a
|
|
752
|
+
* failed wait it logs a warning and returns rather than throwing.
|
|
669
753
|
*
|
|
670
754
|
* Adopters with a save flow that must converge editor + disk before returning
|
|
671
755
|
* (e.g. a dual form/code editor that would otherwise show a content-conflict
|
|
@@ -674,57 +758,24 @@ export class ModelService<
|
|
|
674
758
|
protected async settleSave(uri: string, cancelToken?: CancellationToken): Promise<void> {
|
|
675
759
|
const canonical = this.uriPolicy.canonicalUri(uri);
|
|
676
760
|
const key = UriUtils.toUri(canonical).toString();
|
|
677
|
-
|
|
678
|
-
|
|
679
|
-
)
|
|
761
|
+
// One race over both waits, so the bound is one deadline for the pair;
|
|
762
|
+
// a race per wait would let the save take twice the bound.
|
|
763
|
+
const settled = (async (): Promise<void> => {
|
|
764
|
+
await this.waitForDocumentStateCanonical(canonical, IntegrityService.SettledState, cancelToken, { sync: true });
|
|
765
|
+
await this.syncChains.get(key);
|
|
766
|
+
})();
|
|
680
767
|
try {
|
|
681
|
-
await
|
|
682
|
-
const pending = this.syncChains.get(key);
|
|
683
|
-
if (pending) {
|
|
684
|
-
await Promise.race([pending, timeout]);
|
|
685
|
-
}
|
|
686
|
-
} catch (err: unknown) {
|
|
687
|
-
if (err instanceof SaveSettleTimeoutError) {
|
|
768
|
+
if ((await this.services.Clock.raceTimer(settled, SAVE_SETTLE_TIMEOUT_MS)) === TIMED_OUT) {
|
|
688
769
|
this.tracer.withUri(key).warn(`Save settle exceeded ${SAVE_SETTLE_TIMEOUT_MS}ms — returning anyway`);
|
|
689
|
-
} else {
|
|
690
|
-
const detail = err instanceof Error ? (err.stack ?? err.message) : String(err);
|
|
691
|
-
this.tracer.withUri(key).warn(`Save settle failed before the timeout — returning anyway. ${detail}`);
|
|
692
770
|
}
|
|
771
|
+
} catch (err: unknown) {
|
|
772
|
+
// A failed wait, such as a cancelled token or a document the builder
|
|
773
|
+
// does not hold, gets its own line so it is not blamed on the bound.
|
|
774
|
+
const detail = err instanceof Error ? (err.stack ?? err.message) : String(err);
|
|
775
|
+
this.tracer.withUri(key).warn(`Save settle failed before the timeout — returning anyway. ${detail}`);
|
|
693
776
|
}
|
|
694
777
|
}
|
|
695
778
|
|
|
696
|
-
/**
|
|
697
|
-
* Open the document at `args.uri` on behalf of `args.clientId`.
|
|
698
|
-
* Multi-client: each (uri, clientId) pair is tracked as one
|
|
699
|
-
* registration; the underlying document stays open until the last
|
|
700
|
-
* client closes it. If `args.text` is omitted the document content
|
|
701
|
-
* is read from the `FileSystemProvider`.
|
|
702
|
-
*
|
|
703
|
-
* Returns a {@link Disposable} that closes the registration when
|
|
704
|
-
* disposed — useful for `using` blocks and shutdown cleanup.
|
|
705
|
-
*
|
|
706
|
-
* Delegates to the framework-bound
|
|
707
|
-
* `services.workspace.AstDocumentManager`. Adopter subclasses with
|
|
708
|
-
* extra open-time behaviour (logging, sync-chain bootstrapping)
|
|
709
|
-
* override on their `ModelService` subclass and call `super.open`.
|
|
710
|
-
*
|
|
711
|
-
* The open path does not thread cancellation: `AstDocumentManager.open`
|
|
712
|
-
* and the filesystem read behind it take no token, so a cancelled caller
|
|
713
|
-
* still completes the open.
|
|
714
|
-
*/
|
|
715
|
-
async open(args: OpenModelArgs): Promise<Disposable> {
|
|
716
|
-
return this.services.workspace.AstDocumentManager.open(args);
|
|
717
|
-
}
|
|
718
|
-
|
|
719
|
-
/**
|
|
720
|
-
* Close the document at `args.uri` for `args.clientId`. Counterpart
|
|
721
|
-
* to {@link open}; the underlying document stays open until every
|
|
722
|
-
* registered client has closed.
|
|
723
|
-
*/
|
|
724
|
-
async close(args: CloseModelArgs): Promise<void> {
|
|
725
|
-
return this.services.workspace.AstDocumentManager.close(args);
|
|
726
|
-
}
|
|
727
|
-
|
|
728
779
|
/**
|
|
729
780
|
* True when the document at `uri` is currently open for at least one
|
|
730
781
|
* client. Pure read; no side effects.
|
|
@@ -733,6 +784,33 @@ export class ModelService<
|
|
|
733
784
|
return this.services.workspace.AstDocumentManager.isOpen(uri);
|
|
734
785
|
}
|
|
735
786
|
|
|
787
|
+
/**
|
|
788
|
+
* Snapshot of `uri` as it stands RIGHT NOW — the synchronous sibling of the
|
|
789
|
+
* phase reads, which all wait. `undefined` when no document is registered,
|
|
790
|
+
* or only the builder's placeholder for one its build has not parsed yet:
|
|
791
|
+
* that root is no parse of any text, and its version gates no write.
|
|
792
|
+
*
|
|
793
|
+
* **This is what a writer wants, and {@link getDocument} is not.** The
|
|
794
|
+
* envelope's `version` is copied by value at projection time, so it cannot
|
|
795
|
+
* move afterwards; a version read off the live document at write time is
|
|
796
|
+
* whatever the server is at *now*, which is the number an optimistic gate is
|
|
797
|
+
* about to compare it against.
|
|
798
|
+
*
|
|
799
|
+
* Diagnostics only from a document that has reached `Validated`, and absent
|
|
800
|
+
* otherwise. Unlike the phase reads this one names no phase, so
|
|
801
|
+
* the state it finds is the only thing that can say whether the array
|
|
802
|
+
* describes the content being handed back or whatever an earlier build left.
|
|
803
|
+
* A caller that needs them unconditionally waits, via {@link validated}.
|
|
804
|
+
*/
|
|
805
|
+
snapshot(uri: string): AstDocument<TAst, TDiagnostic> | undefined {
|
|
806
|
+
const document = this.getDocument(uri);
|
|
807
|
+
if (!document || this.services.workspace.ModelLedger.isPlaceholder(document.parseResult.value)) {
|
|
808
|
+
return undefined;
|
|
809
|
+
}
|
|
810
|
+
const envelope = this.services.workspace.AstDocumentManager.toAstDocument(document) as AstDocument<TAst, TDiagnostic>;
|
|
811
|
+
return document.state >= DocumentState.Validated ? envelope : this.withoutDiagnostics(envelope);
|
|
812
|
+
}
|
|
813
|
+
|
|
736
814
|
/**
|
|
737
815
|
* The built {@link LangiumDocument} for `uri`, looked up by canonical identity —
|
|
738
816
|
* the synchronous, phase-agnostic sibling of {@link ensureDocumentState} /
|
|
@@ -741,11 +819,92 @@ export class ModelService<
|
|
|
741
819
|
* into `LangiumDocuments` directly: a symlinked / `..` / case-divergent URI
|
|
742
820
|
* still resolves to the one document the build keys by its real path. Returns
|
|
743
821
|
* `undefined` if no document is registered for `uri`.
|
|
822
|
+
*
|
|
823
|
+
* **Live, so do not take a base version off it.** `textDocument` is the
|
|
824
|
+
* store's own object rather than a copy, so `.version` read here answers for
|
|
825
|
+
* the moment of the READ, not the moment of the earlier content — pass it to
|
|
826
|
+
* a write and the server compares its current version against itself, the
|
|
827
|
+
* gate passes unconditionally, and a concurrent edit is overwritten with
|
|
828
|
+
* nothing logged. Use {@link snapshot} for that, or a phase read.
|
|
744
829
|
*/
|
|
745
830
|
getDocument(uri: string): LangiumDocument | undefined {
|
|
746
831
|
return this.services.workspace.AstDocumentManager.getDocument(uri);
|
|
747
832
|
}
|
|
748
833
|
|
|
834
|
+
// ============================================================
|
|
835
|
+
// Client sessions
|
|
836
|
+
// ============================================================
|
|
837
|
+
|
|
838
|
+
createSession<TOpenOptions extends OpenOptions = OpenOptions>(
|
|
839
|
+
label?: string,
|
|
840
|
+
clientId?: string
|
|
841
|
+
): ClientSession<TAst, TDiagnostic, TTransfer, TOpenOptions> {
|
|
842
|
+
const sessionLabel = label ?? 'session';
|
|
843
|
+
const id = clientId ?? `${sessionLabel}#${globalThis.crypto.randomUUID()}`;
|
|
844
|
+
const textDocuments = this.services.workspace.TextDocuments;
|
|
845
|
+
textDocuments.registerSession(id);
|
|
846
|
+
this.sessionCloseListener ??= textDocuments.onDidCloseSession(event => {
|
|
847
|
+
// Also reached when the store ends a session directly; disposing the
|
|
848
|
+
// handle makes its later calls fail rather than write under an id
|
|
849
|
+
// this service no longer treats as a session.
|
|
850
|
+
this.sessions.get(event.clientId)?.dispose();
|
|
851
|
+
this.sessions.delete(event.clientId);
|
|
852
|
+
});
|
|
853
|
+
let session: ClientSession<TAst, TDiagnostic, TTransfer, TOpenOptions>;
|
|
854
|
+
try {
|
|
855
|
+
// Unchecked: the session keeps whatever options its `open` is handed,
|
|
856
|
+
// and the factory types it for every grammar, so the narrowed type
|
|
857
|
+
// holds only for the caller that started it.
|
|
858
|
+
session = this.services.model.ClientSessionFactory.create(id, sessionLabel) as ClientSession<
|
|
859
|
+
TAst,
|
|
860
|
+
TDiagnostic,
|
|
861
|
+
TTransfer,
|
|
862
|
+
TOpenOptions
|
|
863
|
+
>;
|
|
864
|
+
} catch (err: unknown) {
|
|
865
|
+
textDocuments.closeSession(id);
|
|
866
|
+
throw err;
|
|
867
|
+
}
|
|
868
|
+
this.sessions.set(id, session);
|
|
869
|
+
return session;
|
|
870
|
+
}
|
|
871
|
+
|
|
872
|
+
getSession(clientId: string): ClientSession<TAst, TDiagnostic, TTransfer> | undefined {
|
|
873
|
+
return this.sessions.get(clientId);
|
|
874
|
+
}
|
|
875
|
+
|
|
876
|
+
/**
|
|
877
|
+
* Convert a structured-or-textual `model` payload to its textual form.
|
|
878
|
+
*
|
|
879
|
+
* Textual payloads (LSP / pre-serialised callers) pass through untouched.
|
|
880
|
+
* Structured payloads run the per-language `UpdateRewriteService` chain
|
|
881
|
+
* (transfer-model transforms; diff-aware rewrites see the previous AST root),
|
|
882
|
+
* then serialise. The chain is the single transfer-model-transform seam — a
|
|
883
|
+
* unary normalisation is just a rewrite that ignores `previous`, as
|
|
884
|
+
* `NormalizeEmptyStringsContribution` does. The chain is empty by
|
|
885
|
+
* default, so this is a no-op for adopters that register none.
|
|
886
|
+
*/
|
|
887
|
+
async modelToText(uri: string, model: TTransfer | string, cancelToken?: CancellationToken): Promise<string> {
|
|
888
|
+
if (typeof model === 'string') {
|
|
889
|
+
return model;
|
|
890
|
+
}
|
|
891
|
+
const rewritten = await this.rewriteModel(uri, model, cancelToken);
|
|
892
|
+
const target = UriUtils.toUri(uri);
|
|
893
|
+
const trivia = this.services.ServiceRegistry?.getServices(target)?.trivia?.TriviaService;
|
|
894
|
+
// Extracted BEFORE serializing, so it reads the document the write is
|
|
895
|
+
// about to replace rather than whatever a concurrent build left behind.
|
|
896
|
+
let document = this.services.workspace.LangiumDocuments.getDocument(target);
|
|
897
|
+
if (trivia !== undefined && document === undefined) {
|
|
898
|
+
const source = await this.textToTakeTriviaFrom(uri, target);
|
|
899
|
+
if (source !== undefined) {
|
|
900
|
+
document = this.services.workspace.LangiumDocumentFactory.fromString(source, target);
|
|
901
|
+
}
|
|
902
|
+
}
|
|
903
|
+
const extracted = trivia !== undefined && document !== undefined ? trivia.extract(document) : undefined;
|
|
904
|
+
const serialized = await this.serialize(uri, rewritten);
|
|
905
|
+
return extracted === undefined ? serialized : trivia!.apply(serialized, extracted, target);
|
|
906
|
+
}
|
|
907
|
+
|
|
749
908
|
// ============================================================
|
|
750
909
|
// LSP-client sync (mirror non-LSP-client changes back to Monaco)
|
|
751
910
|
// ============================================================
|
|
@@ -754,18 +913,14 @@ export class ModelService<
|
|
|
754
913
|
* Mirror a server-side change of `document` back to the LSP textual language
|
|
755
914
|
* client, run per document as it reaches the post-integrity settled phase.
|
|
756
915
|
* The single framework caller of
|
|
757
|
-
* `HydraniumTextDocuments.applyEditToLanguageClient
|
|
758
|
-
* `HydraniumTextDocuments.stagePendingContent`.
|
|
759
|
-
*
|
|
760
|
-
* Routes to one of two mechanisms by language-client registration, because
|
|
761
|
-
* an open and a closed document answer different questions:
|
|
916
|
+
* `HydraniumTextDocuments.applyEditToLanguageClient`.
|
|
762
917
|
*
|
|
763
|
-
*
|
|
764
|
-
*
|
|
765
|
-
*
|
|
766
|
-
*
|
|
767
|
-
*
|
|
768
|
-
*
|
|
918
|
+
* Only a document open in the language client is mirrored, through
|
|
919
|
+
* {@link syncOpenDocument}, routed purely by **content**. A document open
|
|
920
|
+
* only in another client needs nothing: a language client opening it joins
|
|
921
|
+
* the existing entry and is refreshed from the store. A session writes only
|
|
922
|
+
* what it has open, so no session edit of a closed document waits here for
|
|
923
|
+
* the language client's next open.
|
|
769
924
|
*
|
|
770
925
|
* The decision is **re-derived from the current settled state every time** (it
|
|
771
926
|
* is not a one-shot enrolment), which is what makes it self-healing: a doc
|
|
@@ -775,9 +930,9 @@ export class ModelService<
|
|
|
775
930
|
*/
|
|
776
931
|
protected syncToLanguageClient(document: LangiumDocument): void {
|
|
777
932
|
// `document.textDocument.uri` is the server-identity (canonical) URI off the
|
|
778
|
-
// build. Route by
|
|
779
|
-
//
|
|
780
|
-
//
|
|
933
|
+
// build. Route by client registration (presence questions — both
|
|
934
|
+
// predicates canonicalize internally, so a divergent open path still
|
|
935
|
+
// resolves to the same record), but key the outbound sync by this
|
|
781
936
|
// CANONICAL URI — the same key `settleSave` looks the chain up under —
|
|
782
937
|
// so a save-settle can drain the in-flight applyEdit. The canonical→client-URI
|
|
783
938
|
// translation (a symlinked path the client opened, or a dual-open fan-out)
|
|
@@ -787,8 +942,6 @@ export class ModelService<
|
|
|
787
942
|
// the drain would miss for a divergent open path.
|
|
788
943
|
if (this.services.workspace.TextDocuments.isOpenInLanguageClient(document.textDocument.uri)) {
|
|
789
944
|
this.syncOpenDocument(document.textDocument.uri, document.textDocument.getText());
|
|
790
|
-
} else {
|
|
791
|
-
this.stageClosedDocument(document);
|
|
792
945
|
}
|
|
793
946
|
}
|
|
794
947
|
|
|
@@ -807,46 +960,6 @@ export class ModelService<
|
|
|
807
960
|
this.queueSync(uri, text);
|
|
808
961
|
}
|
|
809
962
|
|
|
810
|
-
/**
|
|
811
|
-
* Stage the settled text of a document closed in the language client so the
|
|
812
|
-
* eventual first `didOpen` sees this in-memory text instead of stale disk —
|
|
813
|
-
* but only for a {@link isNonLanguageClientEdit genuine non-language-client edit}.
|
|
814
|
-
* A document rebuilt by an internal build is skipped, leaving disk authoritative
|
|
815
|
-
* on the next open.
|
|
816
|
-
*/
|
|
817
|
-
protected stageClosedDocument(document: LangiumDocument): void {
|
|
818
|
-
if (this.isNonLanguageClientEdit(document)) {
|
|
819
|
-
this.services.workspace.TextDocuments.stagePendingContent(document.textDocument.uri, document.textDocument.getText());
|
|
820
|
-
}
|
|
821
|
-
}
|
|
822
|
-
|
|
823
|
-
/**
|
|
824
|
-
* Whether `document`'s settled state is a genuine edit by a client *other than
|
|
825
|
-
* the language client* — a write a form / GLSP / integrity client actually made.
|
|
826
|
-
* Excludes two non-edits: the **language client** itself (the LSP/Monaco text
|
|
827
|
-
* client — it already holds its own edits, and the staging here exists to feed
|
|
828
|
-
* it) and an **internal build** (workspace startup, a cascade relink, a
|
|
829
|
-
* `didClose`-reload). This is the gate for {@link stageClosedDocument}: staging
|
|
830
|
-
* an internal build would
|
|
831
|
-
* (a) pre-stage every file on boot and (b) re-stage discarded content after
|
|
832
|
-
* close (e.g. a disposing GLSP session's debounced submit firing after close),
|
|
833
|
-
* which then shadows clean disk on the next open.
|
|
834
|
-
*
|
|
835
|
-
* The signal is "a known client other than the language client authored this
|
|
836
|
-
* version **and** the URI was in the last build's changed set
|
|
837
|
-
* (`isDirectChange`)". A framework-internal rebuild reports no author
|
|
838
|
-
* (`getAuthor` → `undefined`), so it fails `hasKnownAuthor` without comparing
|
|
839
|
-
* against a sentinel. This is NOT redundant with content/registration — it
|
|
840
|
-
* distinguishes "client edited" from "framework rebuilt", which neither the
|
|
841
|
-
* shadow nor `isDirectChange` alone can.
|
|
842
|
-
*/
|
|
843
|
-
protected isNonLanguageClientEdit(document: LangiumDocument): boolean {
|
|
844
|
-
const documents = this.services.workspace.AstDocumentManager;
|
|
845
|
-
const author = documents.getAuthor(document);
|
|
846
|
-
const hasKnownAuthor = !!author && author !== LANGUAGE_CLIENT_ID;
|
|
847
|
-
return hasKnownAuthor && documents.isDirectChange(document.textDocument.uri);
|
|
848
|
-
}
|
|
849
|
-
|
|
850
963
|
/**
|
|
851
964
|
* Enqueue a sync to the language client. The pending slot per URI holds only
|
|
852
965
|
* the latest text: if a newer settle fires while the current RPC is in
|
|
@@ -878,15 +991,28 @@ export class ModelService<
|
|
|
878
991
|
this.syncChains.set(uri, chain);
|
|
879
992
|
}
|
|
880
993
|
|
|
994
|
+
/**
|
|
995
|
+
* The undo-stack label for a server-authored write, in the locale the server
|
|
996
|
+
* was handed at init.
|
|
997
|
+
*
|
|
998
|
+
* One method rather than the literal at each `applyEdit`, because the two
|
|
999
|
+
* call sites are the same edit — a push and its full-replace retry — and an
|
|
1000
|
+
* undo menu showing two different words for one operation would read as two
|
|
1001
|
+
* operations.
|
|
1002
|
+
*/
|
|
1003
|
+
protected editLabel(): string {
|
|
1004
|
+
return this.services.MessageRenderer.renderMessage(MODEL_UPDATE_EDIT);
|
|
1005
|
+
}
|
|
1006
|
+
|
|
881
1007
|
protected async drainSyncQueue(uri: string): Promise<void> {
|
|
882
1008
|
const uriLogger = this.tracer.withUri(uri);
|
|
883
1009
|
while (this.pendingSync.has(uri)) {
|
|
884
1010
|
const text = this.pendingSync.get(uri)!;
|
|
885
1011
|
this.pendingSync.delete(uri);
|
|
886
1012
|
try {
|
|
887
|
-
let result = await this.services.workspace.TextDocuments.applyEditToLanguageClient(uri, text, { label:
|
|
1013
|
+
let result = await this.services.workspace.TextDocuments.applyEditToLanguageClient(uri, text, { label: this.editLabel() });
|
|
888
1014
|
if (result?.applied === false && !this.pendingSync.has(uri)) {
|
|
889
|
-
// The push is addressed at the client's
|
|
1015
|
+
// The push is addressed at the client's last known version, so a
|
|
890
1016
|
// rejection normally means the client's buffer moved while the
|
|
891
1017
|
// line-keyed diff was in flight — exactly the case where applying it
|
|
892
1018
|
// would splice the file. Dropping the push there would leave the
|
|
@@ -904,8 +1030,8 @@ export class ModelService<
|
|
|
904
1030
|
// `pendingSync` check skips the retry when a newer settle has already
|
|
905
1031
|
// queued — best-effort, since a settle arriving later simply pushes
|
|
906
1032
|
// after this and still wins.
|
|
907
|
-
uriLogger.
|
|
908
|
-
result = await this.services.workspace.TextDocuments.applyEditToLanguageClient(uri, text, { label:
|
|
1033
|
+
uriLogger.debug(`Re-pushing a full replace after the language client refused applyEdit`);
|
|
1034
|
+
result = await this.services.workspace.TextDocuments.applyEditToLanguageClient(uri, text, { label: this.editLabel() });
|
|
909
1035
|
if (result?.applied === false) {
|
|
910
1036
|
uriLogger.warn(`Language client rejected the full-replace retry too — client content is stale`);
|
|
911
1037
|
}
|
|
@@ -935,9 +1061,8 @@ export class ModelService<
|
|
|
935
1061
|
* `HydraniumTextDocuments` — single listener registration shared with
|
|
936
1062
|
* any direct `HydraniumTextDocuments.onUpdate` subscriber, so the same
|
|
937
1063
|
* underlying `DocumentBuilder.onDocumentPhase` listener serves both
|
|
938
|
-
* call paths.
|
|
939
|
-
*
|
|
940
|
-
* `lastUpdate` snapshot (see `AstDocumentManager.onUpdate`).
|
|
1064
|
+
* call paths. The event's reason, source and cause are
|
|
1065
|
+
* {@link AstDocumentManager.attributeUpdate}'s.
|
|
941
1066
|
*/
|
|
942
1067
|
onModelUpdated(uri: string, listener: (event: AstDocumentUpdatedEvent<TAst, TDiagnostic>) => void): Disposable {
|
|
943
1068
|
return this.services.workspace.AstDocumentManager.onUpdate(uri, listener as never);
|
|
@@ -979,13 +1104,13 @@ export class ModelService<
|
|
|
979
1104
|
* Adopters whose serializer call shape differs (custom service
|
|
980
1105
|
* names, generator-driven YAML pretty printers, etc.) override this
|
|
981
1106
|
* method. Routes through `Serializer.serializeTransfer` because
|
|
982
|
-
* `
|
|
1107
|
+
* a session's `update` / `save` always receive a
|
|
983
1108
|
* transfer-model shape (cross-references as plain strings) from
|
|
984
1109
|
* adopter callers — the AST-shape entry point is `serializeAst`.
|
|
985
1110
|
*
|
|
986
1111
|
* Returns {@link MaybePromise} so adopter `Serializer` overrides can be
|
|
987
1112
|
* async (remote schema lookup, external canonical-value resolution); the
|
|
988
|
-
* single caller ({@link modelToText}
|
|
1113
|
+
* single caller ({@link modelToText}) is already `async`,
|
|
989
1114
|
* so a naive `await` covers both branches without extra ceremony.
|
|
990
1115
|
*/
|
|
991
1116
|
protected serialize(uri: string, root: TTransfer): MaybePromise<string> {
|
|
@@ -998,22 +1123,12 @@ export class ModelService<
|
|
|
998
1123
|
// ============================================================
|
|
999
1124
|
|
|
1000
1125
|
/**
|
|
1001
|
-
*
|
|
1002
|
-
*
|
|
1003
|
-
*
|
|
1004
|
-
* Structured payloads run the per-language `UpdateRewriteService` chain
|
|
1005
|
-
* (transfer-model transforms; diff-aware rewrites see the previous AST root),
|
|
1006
|
-
* then serialise. The chain is the single transfer-model-transform seam — a
|
|
1007
|
-
* unary normalisation is just a rewrite that ignores `previous`, as
|
|
1008
|
-
* `NormalizeEmptyStringsContribution` does. The chain is empty by
|
|
1009
|
-
* default, so this is a no-op for adopters that register none.
|
|
1126
|
+
* The text a write into a document not yet built should take its trivia
|
|
1127
|
+
* from: the store's, which a write always has, since it writes only a
|
|
1128
|
+
* document its client has open.
|
|
1010
1129
|
*/
|
|
1011
|
-
protected async
|
|
1012
|
-
|
|
1013
|
-
return model;
|
|
1014
|
-
}
|
|
1015
|
-
const rewritten = await this.rewriteModel(uri, model, cancelToken);
|
|
1016
|
-
return this.serialize(uri, rewritten);
|
|
1130
|
+
protected async textToTakeTriviaFrom(uri: string, _target: URI): Promise<string | undefined> {
|
|
1131
|
+
return this.services.workspace.TextDocuments.get(uri)?.getText();
|
|
1017
1132
|
}
|
|
1018
1133
|
|
|
1019
1134
|
/**
|
|
@@ -1037,15 +1152,37 @@ export class ModelService<
|
|
|
1037
1152
|
|
|
1038
1153
|
/**
|
|
1039
1154
|
* Build an {@link AstDocument} envelope from the current
|
|
1040
|
-
* {@link LangiumDocument} state via
|
|
1041
|
-
* projection. Returns an empty envelope (built via
|
|
1155
|
+
* {@link LangiumDocument} state via `AstDocumentManager.toAstDocument`,
|
|
1156
|
+
* the projection events use too. Returns an empty envelope (built via
|
|
1042
1157
|
* {@link AstDocument.create}) when the document is absent from the
|
|
1043
|
-
* registry — adopters that prefer to throw override on their subclass.
|
|
1158
|
+
* registry — adopters that prefer to throw override on their subclass. Its
|
|
1159
|
+
* version is {@link UNRECORDED_VERSION}, so a write based on it conflicts.
|
|
1044
1160
|
*/
|
|
1045
1161
|
protected toAstDocument(uri: URI): AstDocument<TAst, TDiagnostic> {
|
|
1046
1162
|
const document = this.services.workspace.LangiumDocuments.getDocument(uri);
|
|
1047
1163
|
return document
|
|
1048
|
-
? AstDocument
|
|
1049
|
-
: AstDocument.create<TAst, TDiagnostic>(uri.toString(),
|
|
1164
|
+
? (this.services.workspace.AstDocumentManager.toAstDocument(document) as AstDocument<TAst, TDiagnostic>)
|
|
1165
|
+
: AstDocument.create<TAst, TDiagnostic>(uri.toString(), UNRECORDED_VERSION, undefined as unknown as TAst);
|
|
1166
|
+
}
|
|
1167
|
+
|
|
1168
|
+
/**
|
|
1169
|
+
* The same envelope with no diagnostics, for a read that names a phase below
|
|
1170
|
+
* `Validated`. Absent rather than `[]`, which says the document was validated
|
|
1171
|
+
* and found clean.
|
|
1172
|
+
*
|
|
1173
|
+
* Langium fills `LangiumDocument.diagnostics` from inside `validateDocument`
|
|
1174
|
+
* and from nowhere else, so below that phase the array holds whatever an
|
|
1175
|
+
* EARLIER build left — a verdict about text the document may no longer have.
|
|
1176
|
+
* The wait underneath resolves at or above the phase asked for, so a document
|
|
1177
|
+
* something else carried past `Validated` would otherwise hand a full array
|
|
1178
|
+
* back from `parsed()`.
|
|
1179
|
+
*
|
|
1180
|
+
* A copy rather than a clear: the envelope is freshly built here, but
|
|
1181
|
+
* {@link toAstDocument} is overridable and an adopter's version may return
|
|
1182
|
+
* one it also keeps.
|
|
1183
|
+
*/
|
|
1184
|
+
protected withoutDiagnostics(document: AstDocument<TAst, TDiagnostic>): AstDocument<TAst, never> {
|
|
1185
|
+
const { diagnostics: _diagnostics, ...rest } = document;
|
|
1186
|
+
return rest;
|
|
1050
1187
|
}
|
|
1051
1188
|
}
|