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