@hydranium/core 1.0.0-next.39 → 1.0.0-next.390

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.
Files changed (805) hide show
  1. package/README.md +78 -82
  2. package/lib/browser/host-heads-in-worker.d.ts +77 -0
  3. package/lib/browser/host-heads-in-worker.d.ts.map +1 -0
  4. package/lib/browser/host-heads-in-worker.js +169 -0
  5. package/lib/browser/host-heads-in-worker.js.map +1 -0
  6. package/lib/browser/index.d.ts +12 -0
  7. package/lib/browser/index.d.ts.map +1 -0
  8. package/lib/browser/index.js +17 -0
  9. package/lib/browser/index.js.map +1 -0
  10. package/lib/browser/indexeddb-file-system-store.d.ts +82 -0
  11. package/lib/browser/indexeddb-file-system-store.d.ts.map +1 -0
  12. package/lib/browser/indexeddb-file-system-store.js +181 -0
  13. package/lib/browser/indexeddb-file-system-store.js.map +1 -0
  14. package/lib/browser/start-language-server-in-worker.d.ts +32 -0
  15. package/lib/browser/start-language-server-in-worker.d.ts.map +1 -0
  16. package/lib/browser/start-language-server-in-worker.js +40 -0
  17. package/lib/browser/start-language-server-in-worker.js.map +1 -0
  18. package/lib/documents/ast-document-manager.d.ts +254 -140
  19. package/lib/documents/ast-document-manager.d.ts.map +1 -1
  20. package/lib/documents/ast-document-manager.js +311 -128
  21. package/lib/documents/ast-document-manager.js.map +1 -1
  22. package/lib/documents/client-ids.d.ts +5 -19
  23. package/lib/documents/client-ids.d.ts.map +1 -1
  24. package/lib/documents/client-ids.js +5 -19
  25. package/lib/documents/client-ids.js.map +1 -1
  26. package/lib/documents/client-session-errors.d.ts +15 -0
  27. package/lib/documents/client-session-errors.d.ts.map +1 -0
  28. package/lib/documents/client-session-errors.js +15 -0
  29. package/lib/documents/client-session-errors.js.map +1 -0
  30. package/lib/documents/client-session-registry.d.ts +146 -0
  31. package/lib/documents/client-session-registry.d.ts.map +1 -0
  32. package/lib/documents/client-session-registry.js +207 -0
  33. package/lib/documents/client-session-registry.js.map +1 -0
  34. package/lib/documents/dirty-state-tracker.d.ts +101 -0
  35. package/lib/documents/dirty-state-tracker.d.ts.map +1 -0
  36. package/lib/documents/dirty-state-tracker.js +85 -0
  37. package/lib/documents/dirty-state-tracker.js.map +1 -0
  38. package/lib/documents/document-release-handler.d.ts +204 -0
  39. package/lib/documents/document-release-handler.d.ts.map +1 -0
  40. package/lib/documents/document-release-handler.js +317 -0
  41. package/lib/documents/document-release-handler.js.map +1 -0
  42. package/lib/documents/document-release-scheduler.d.ts +67 -0
  43. package/lib/documents/document-release-scheduler.d.ts.map +1 -0
  44. package/lib/documents/document-release-scheduler.js +80 -0
  45. package/lib/documents/document-release-scheduler.js.map +1 -0
  46. package/lib/documents/file-system-task-queue.d.ts +52 -0
  47. package/lib/documents/file-system-task-queue.d.ts.map +1 -0
  48. package/lib/documents/file-system-task-queue.js +40 -0
  49. package/lib/documents/file-system-task-queue.js.map +1 -0
  50. package/lib/documents/hydranium-text-documents.d.ts +453 -282
  51. package/lib/documents/hydranium-text-documents.d.ts.map +1 -1
  52. package/lib/documents/hydranium-text-documents.js +918 -504
  53. package/lib/documents/hydranium-text-documents.js.map +1 -1
  54. package/lib/documents/index.d.ts +10 -2
  55. package/lib/documents/index.d.ts.map +1 -1
  56. package/lib/documents/index.js +10 -2
  57. package/lib/documents/index.js.map +1 -1
  58. package/lib/documents/language-client-shadow.d.ts +234 -0
  59. package/lib/documents/language-client-shadow.d.ts.map +1 -0
  60. package/lib/documents/language-client-shadow.js +306 -0
  61. package/lib/documents/language-client-shadow.js.map +1 -0
  62. package/lib/documents/model-ledger.d.ts +47 -0
  63. package/lib/documents/model-ledger.d.ts.map +1 -0
  64. package/lib/documents/model-ledger.js +30 -0
  65. package/lib/documents/model-ledger.js.map +1 -0
  66. package/lib/documents/text-ledger.d.ts +64 -0
  67. package/lib/documents/text-ledger.d.ts.map +1 -0
  68. package/lib/documents/text-ledger.js +63 -0
  69. package/lib/documents/text-ledger.js.map +1 -0
  70. package/lib/documents/version-sync-service.d.ts +153 -0
  71. package/lib/documents/version-sync-service.d.ts.map +1 -0
  72. package/lib/documents/version-sync-service.js +186 -0
  73. package/lib/documents/version-sync-service.js.map +1 -0
  74. package/lib/index.d.ts +3 -0
  75. package/lib/index.d.ts.map +1 -1
  76. package/lib/index.js +3 -0
  77. package/lib/index.js.map +1 -1
  78. package/lib/langium/ast-extension/ast-extension-service.d.ts +42 -31
  79. package/lib/langium/ast-extension/ast-extension-service.d.ts.map +1 -1
  80. package/lib/langium/ast-extension/ast-extension-service.js +45 -19
  81. package/lib/langium/ast-extension/ast-extension-service.js.map +1 -1
  82. package/lib/langium/ast-extension/ast-node-builder.d.ts +12 -7
  83. package/lib/langium/ast-extension/ast-node-builder.d.ts.map +1 -1
  84. package/lib/langium/ast-extension/ast-node-builder.js +25 -9
  85. package/lib/langium/ast-extension/ast-node-builder.js.map +1 -1
  86. package/lib/langium/bootstrap.d.ts +49 -36
  87. package/lib/langium/bootstrap.d.ts.map +1 -1
  88. package/lib/langium/bootstrap.js +75 -36
  89. package/lib/langium/bootstrap.js.map +1 -1
  90. package/lib/langium/build-phase-pass/build-phase-pass-service.d.ts +9 -9
  91. package/lib/langium/build-phase-pass/build-phase-pass-service.d.ts.map +1 -1
  92. package/lib/langium/build-phase-pass/build-phase-pass-service.js +25 -16
  93. package/lib/langium/build-phase-pass/build-phase-pass-service.js.map +1 -1
  94. package/lib/langium/build-phase-pass/build-phase-pass.d.ts +20 -8
  95. package/lib/langium/build-phase-pass/build-phase-pass.d.ts.map +1 -1
  96. package/lib/langium/build-phase-pass/build-phase-pass.js +20 -0
  97. package/lib/langium/build-phase-pass/build-phase-pass.js.map +1 -1
  98. package/lib/langium/composite-ast-reflection.d.ts +46 -0
  99. package/lib/langium/composite-ast-reflection.d.ts.map +1 -0
  100. package/lib/langium/composite-ast-reflection.js +97 -0
  101. package/lib/langium/composite-ast-reflection.js.map +1 -0
  102. package/lib/langium/config/configuration-provider.d.ts +81 -0
  103. package/lib/langium/config/configuration-provider.d.ts.map +1 -0
  104. package/lib/langium/config/configuration-provider.js +112 -0
  105. package/lib/langium/config/configuration-provider.js.map +1 -0
  106. package/lib/langium/config/index.d.ts +1 -0
  107. package/lib/langium/config/index.d.ts.map +1 -1
  108. package/lib/langium/config/index.js +1 -0
  109. package/lib/langium/config/index.js.map +1 -1
  110. package/lib/langium/config/settings.js.map +1 -1
  111. package/lib/langium/diagnostics/console-tee.d.ts +27 -0
  112. package/lib/langium/diagnostics/console-tee.d.ts.map +1 -0
  113. package/lib/langium/diagnostics/console-tee.js +141 -0
  114. package/lib/langium/diagnostics/console-tee.js.map +1 -0
  115. package/lib/langium/diagnostics/hydranium-langium-profiler.d.ts +9 -20
  116. package/lib/langium/diagnostics/hydranium-langium-profiler.d.ts.map +1 -1
  117. package/lib/langium/diagnostics/hydranium-langium-profiler.js +15 -24
  118. package/lib/langium/diagnostics/hydranium-langium-profiler.js.map +1 -1
  119. package/lib/langium/diagnostics/log-preamble.js +1 -1
  120. package/lib/langium/diagnostics/log-preamble.js.map +1 -1
  121. package/lib/langium/diagnostics/logger.d.ts +25 -6
  122. package/lib/langium/diagnostics/logger.d.ts.map +1 -1
  123. package/lib/langium/diagnostics/logger.js +49 -17
  124. package/lib/langium/diagnostics/logger.js.map +1 -1
  125. package/lib/langium/diagnostics/lsp-logger.d.ts +25 -0
  126. package/lib/langium/diagnostics/lsp-logger.d.ts.map +1 -1
  127. package/lib/langium/diagnostics/lsp-logger.js +81 -46
  128. package/lib/langium/diagnostics/lsp-logger.js.map +1 -1
  129. package/lib/langium/diagnostics/server-tracer.d.ts.map +1 -1
  130. package/lib/langium/diagnostics/server-tracer.js.map +1 -1
  131. package/lib/langium/document-builder/build-pipeline-integration.d.ts +21 -1
  132. package/lib/langium/document-builder/build-pipeline-integration.d.ts.map +1 -1
  133. package/lib/langium/document-builder/build-pipeline-integration.js +43 -30
  134. package/lib/langium/document-builder/build-pipeline-integration.js.map +1 -1
  135. package/lib/langium/document-builder/build-session.d.ts +6 -5
  136. package/lib/langium/document-builder/build-session.d.ts.map +1 -1
  137. package/lib/langium/document-builder/build-session.js +5 -5
  138. package/lib/langium/document-builder/build-session.js.map +1 -1
  139. package/lib/langium/document-builder/document-builder.d.ts +390 -40
  140. package/lib/langium/document-builder/document-builder.d.ts.map +1 -1
  141. package/lib/langium/document-builder/document-builder.js +635 -102
  142. package/lib/langium/document-builder/document-builder.js.map +1 -1
  143. package/lib/langium/documentation/comment-provider.d.ts.map +1 -1
  144. package/lib/langium/documentation/comment-provider.js.map +1 -1
  145. package/lib/langium/integration-services.d.ts +20 -23
  146. package/lib/langium/integration-services.d.ts.map +1 -1
  147. package/lib/langium/integration-services.js.map +1 -1
  148. package/lib/langium/integrity/integrity-rule.d.ts +22 -8
  149. package/lib/langium/integrity/integrity-rule.d.ts.map +1 -1
  150. package/lib/langium/integrity/integrity-rule.js.map +1 -1
  151. package/lib/langium/integrity/integrity-service.d.ts +217 -29
  152. package/lib/langium/integrity/integrity-service.d.ts.map +1 -1
  153. package/lib/langium/integrity/integrity-service.js +588 -84
  154. package/lib/langium/integrity/integrity-service.js.map +1 -1
  155. package/lib/langium/keys/containment.d.ts +3 -2
  156. package/lib/langium/keys/containment.d.ts.map +1 -1
  157. package/lib/langium/keys/containment.js.map +1 -1
  158. package/lib/langium/keys/name-based-key-provider.d.ts +17 -10
  159. package/lib/langium/keys/name-based-key-provider.d.ts.map +1 -1
  160. package/lib/langium/keys/name-based-key-provider.js +24 -12
  161. package/lib/langium/keys/name-based-key-provider.js.map +1 -1
  162. package/lib/langium/keys/positional-key-provider.d.ts.map +1 -1
  163. package/lib/langium/keys/positional-key-provider.js.map +1 -1
  164. package/lib/langium/labeling/label-provider.d.ts.map +1 -1
  165. package/lib/langium/labeling/label-provider.js.map +1 -1
  166. package/lib/langium/language-module.d.ts +30 -5
  167. package/lib/langium/language-module.d.ts.map +1 -1
  168. package/lib/langium/language-module.js +21 -5
  169. package/lib/langium/language-module.js.map +1 -1
  170. package/lib/langium/model-service/client-session.d.ts +405 -0
  171. package/lib/langium/model-service/client-session.d.ts.map +1 -0
  172. package/lib/langium/model-service/client-session.js +479 -0
  173. package/lib/langium/model-service/client-session.js.map +1 -0
  174. package/lib/langium/model-service/index.d.ts +2 -0
  175. package/lib/langium/model-service/index.d.ts.map +1 -1
  176. package/lib/langium/model-service/index.js +2 -0
  177. package/lib/langium/model-service/index.js.map +1 -1
  178. package/lib/langium/model-service/model-events.d.ts +68 -0
  179. package/lib/langium/model-service/model-events.d.ts.map +1 -0
  180. package/lib/langium/model-service/model-events.js +10 -0
  181. package/lib/langium/model-service/model-events.js.map +1 -0
  182. package/lib/langium/model-service/model-service.d.ts +441 -323
  183. package/lib/langium/model-service/model-service.d.ts.map +1 -1
  184. package/lib/langium/model-service/model-service.js +602 -407
  185. package/lib/langium/model-service/model-service.js.map +1 -1
  186. package/lib/langium/module.d.ts +96 -37
  187. package/lib/langium/module.d.ts.map +1 -1
  188. package/lib/langium/module.js +41 -29
  189. package/lib/langium/module.js.map +1 -1
  190. package/lib/langium/naming/name-provider.d.ts +32 -7
  191. package/lib/langium/naming/name-provider.d.ts.map +1 -1
  192. package/lib/langium/naming/name-provider.js +10 -4
  193. package/lib/langium/naming/name-provider.js.map +1 -1
  194. package/lib/langium/naming/name-separator-validation.d.ts.map +1 -1
  195. package/lib/langium/project/abstract-project-manager.d.ts +184 -13
  196. package/lib/langium/project/abstract-project-manager.d.ts.map +1 -1
  197. package/lib/langium/project/abstract-project-manager.js +336 -16
  198. package/lib/langium/project/abstract-project-manager.js.map +1 -1
  199. package/lib/langium/project/project-change-event.d.ts +22 -3
  200. package/lib/langium/project/project-change-event.d.ts.map +1 -1
  201. package/lib/langium/project/project-manager.d.ts +28 -2
  202. package/lib/langium/project/project-manager.d.ts.map +1 -1
  203. package/lib/langium/project/single-project-manager.d.ts +7 -1
  204. package/lib/langium/project/single-project-manager.d.ts.map +1 -1
  205. package/lib/langium/project/single-project-manager.js +12 -0
  206. package/lib/langium/project/single-project-manager.js.map +1 -1
  207. package/lib/langium/residency/cst-residency-service.d.ts +92 -52
  208. package/lib/langium/residency/cst-residency-service.d.ts.map +1 -1
  209. package/lib/langium/residency/cst-residency-service.js +154 -58
  210. package/lib/langium/residency/cst-residency-service.js.map +1 -1
  211. package/lib/langium/scope/ast-node-description-provider.d.ts +46 -10
  212. package/lib/langium/scope/ast-node-description-provider.d.ts.map +1 -1
  213. package/lib/langium/scope/ast-node-description-provider.js +88 -15
  214. package/lib/langium/scope/ast-node-description-provider.js.map +1 -1
  215. package/lib/langium/scope/built-local-symbols.d.ts +12 -0
  216. package/lib/langium/scope/built-local-symbols.d.ts.map +1 -0
  217. package/lib/langium/scope/built-local-symbols.js +11 -0
  218. package/lib/langium/scope/built-local-symbols.js.map +1 -0
  219. package/lib/langium/scope/fallback-scope.d.ts +27 -0
  220. package/lib/langium/scope/fallback-scope.d.ts.map +1 -0
  221. package/lib/langium/scope/fallback-scope.js +35 -0
  222. package/lib/langium/scope/fallback-scope.js.map +1 -0
  223. package/lib/langium/scope/hydranium-scope-computation.d.ts +21 -18
  224. package/lib/langium/scope/hydranium-scope-computation.d.ts.map +1 -1
  225. package/lib/langium/scope/hydranium-scope-computation.js +38 -39
  226. package/lib/langium/scope/hydranium-scope-computation.js.map +1 -1
  227. package/lib/langium/scope/hydranium-scope-provider.d.ts +122 -32
  228. package/lib/langium/scope/hydranium-scope-provider.d.ts.map +1 -1
  229. package/lib/langium/scope/hydranium-scope-provider.js +217 -39
  230. package/lib/langium/scope/hydranium-scope-provider.js.map +1 -1
  231. package/lib/langium/scope/index.d.ts +1 -0
  232. package/lib/langium/scope/index.d.ts.map +1 -1
  233. package/lib/langium/scope/index.js +1 -0
  234. package/lib/langium/scope/index.js.map +1 -1
  235. package/lib/langium/scope/reference-builder.d.ts.map +1 -1
  236. package/lib/langium/scope/reference-builder.js.map +1 -1
  237. package/lib/langium/scope/reference-candidate-provider.d.ts +6 -5
  238. package/lib/langium/scope/reference-candidate-provider.d.ts.map +1 -1
  239. package/lib/langium/scope/reference-candidate-provider.js +3 -2
  240. package/lib/langium/scope/reference-candidate-provider.js.map +1 -1
  241. package/lib/langium/scope/scope-extension-service.d.ts +69 -37
  242. package/lib/langium/scope/scope-extension-service.d.ts.map +1 -1
  243. package/lib/langium/scope/scope-extension-service.js +102 -29
  244. package/lib/langium/scope/scope-extension-service.js.map +1 -1
  245. package/lib/langium/scope/scoped-ast-node-description.d.ts +1 -3
  246. package/lib/langium/scope/scoped-ast-node-description.d.ts.map +1 -1
  247. package/lib/langium/scope/scoped-ast-node-description.js +1 -3
  248. package/lib/langium/scope/scoped-ast-node-description.js.map +1 -1
  249. package/lib/langium/serialization/abstract-serializer.d.ts +38 -27
  250. package/lib/langium/serialization/abstract-serializer.d.ts.map +1 -1
  251. package/lib/langium/serialization/abstract-serializer.js +54 -30
  252. package/lib/langium/serialization/abstract-serializer.js.map +1 -1
  253. package/lib/langium/serialization/json-serializer.d.ts +8 -1
  254. package/lib/langium/serialization/json-serializer.d.ts.map +1 -1
  255. package/lib/langium/serialization/json-serializer.js +13 -3
  256. package/lib/langium/serialization/json-serializer.js.map +1 -1
  257. package/lib/langium/serialization/serializer.d.ts +1 -1
  258. package/lib/langium/serialization/yaml-serializer.d.ts +12 -0
  259. package/lib/langium/serialization/yaml-serializer.d.ts.map +1 -1
  260. package/lib/langium/serialization/yaml-serializer.js +24 -4
  261. package/lib/langium/serialization/yaml-serializer.js.map +1 -1
  262. package/lib/langium/service-registry.d.ts +29 -1
  263. package/lib/langium/service-registry.d.ts.map +1 -1
  264. package/lib/langium/service-registry.js +37 -0
  265. package/lib/langium/service-registry.js.map +1 -1
  266. package/lib/langium/shared-services.d.ts +10 -4
  267. package/lib/langium/shared-services.d.ts.map +1 -1
  268. package/lib/langium/shared-services.js.map +1 -1
  269. package/lib/langium/single-langium-copy.d.ts +22 -0
  270. package/lib/langium/single-langium-copy.d.ts.map +1 -0
  271. package/lib/langium/single-langium-copy.js +36 -0
  272. package/lib/langium/single-langium-copy.js.map +1 -0
  273. package/lib/langium/transfer/transfer-encoder.d.ts +60 -39
  274. package/lib/langium/transfer/transfer-encoder.d.ts.map +1 -1
  275. package/lib/langium/transfer/transfer-encoder.js +35 -24
  276. package/lib/langium/transfer/transfer-encoder.js.map +1 -1
  277. package/lib/langium/trivia/comment-preserver.d.ts +543 -0
  278. package/lib/langium/trivia/comment-preserver.d.ts.map +1 -0
  279. package/lib/langium/trivia/comment-preserver.js +1165 -0
  280. package/lib/langium/trivia/comment-preserver.js.map +1 -0
  281. package/lib/langium/trivia/document-ending-preserver.d.ts +51 -0
  282. package/lib/langium/trivia/document-ending-preserver.d.ts.map +1 -0
  283. package/lib/langium/trivia/document-ending-preserver.js +62 -0
  284. package/lib/langium/trivia/document-ending-preserver.js.map +1 -0
  285. package/lib/langium/trivia/index.d.ts +14 -0
  286. package/lib/langium/trivia/index.d.ts.map +1 -0
  287. package/lib/langium/trivia/index.js +14 -0
  288. package/lib/langium/trivia/index.js.map +1 -0
  289. package/lib/langium/trivia/trivia-contribution.d.ts +37 -0
  290. package/lib/langium/trivia/trivia-contribution.d.ts.map +1 -0
  291. package/lib/langium/trivia/trivia-contribution.js +10 -0
  292. package/lib/langium/trivia/trivia-contribution.js.map +1 -0
  293. package/lib/langium/trivia/trivia-preserver.d.ts +52 -0
  294. package/lib/langium/trivia/trivia-preserver.d.ts.map +1 -0
  295. package/lib/langium/trivia/trivia-preserver.js +10 -0
  296. package/lib/langium/trivia/trivia-preserver.js.map +1 -0
  297. package/lib/langium/trivia/trivia-service.d.ts +70 -0
  298. package/lib/langium/trivia/trivia-service.d.ts.map +1 -0
  299. package/lib/langium/trivia/trivia-service.js +56 -0
  300. package/lib/langium/trivia/trivia-service.js.map +1 -0
  301. package/lib/langium/update-rewrite/normalize-empty-strings.d.ts.map +1 -1
  302. package/lib/langium/update-rewrite/update-rewrite-service.d.ts +1 -1
  303. package/lib/langium/update-rewrite/update-rewrite-service.d.ts.map +1 -1
  304. package/lib/langium/update-rewrite/update-rewrite-service.js.map +1 -1
  305. package/lib/langium/update-rewrite/update-rewrite.d.ts +1 -1
  306. package/lib/langium/validation/document-validator.d.ts +168 -23
  307. package/lib/langium/validation/document-validator.d.ts.map +1 -1
  308. package/lib/langium/validation/document-validator.js +264 -26
  309. package/lib/langium/validation/document-validator.js.map +1 -1
  310. package/lib/langium/validation/validation-contribution-collector.d.ts +9 -1
  311. package/lib/langium/validation/validation-contribution-collector.d.ts.map +1 -1
  312. package/lib/langium/validation/validation-contribution-collector.js +1 -1
  313. package/lib/langium/validation/validation-contribution-collector.js.map +1 -1
  314. package/lib/langium/workspace/ast-node-locator.d.ts +24 -0
  315. package/lib/langium/workspace/ast-node-locator.d.ts.map +1 -0
  316. package/lib/langium/workspace/ast-node-locator.js +32 -0
  317. package/lib/langium/workspace/ast-node-locator.js.map +1 -0
  318. package/lib/langium/workspace/document-uri-policy.d.ts +24 -15
  319. package/lib/langium/workspace/document-uri-policy.d.ts.map +1 -1
  320. package/lib/langium/workspace/document-uri-policy.js +22 -13
  321. package/lib/langium/workspace/document-uri-policy.js.map +1 -1
  322. package/lib/langium/workspace/file-not-found.d.ts +23 -0
  323. package/lib/langium/workspace/file-not-found.d.ts.map +1 -0
  324. package/lib/langium/workspace/file-not-found.js +31 -0
  325. package/lib/langium/workspace/file-not-found.js.map +1 -0
  326. package/lib/langium/workspace/file-system-provider.d.ts +167 -8
  327. package/lib/langium/workspace/file-system-provider.d.ts.map +1 -1
  328. package/lib/langium/workspace/file-system-provider.js +115 -13
  329. package/lib/langium/workspace/file-system-provider.js.map +1 -1
  330. package/lib/langium/workspace/hydranium-langium-document-factory.d.ts +78 -4
  331. package/lib/langium/workspace/hydranium-langium-document-factory.d.ts.map +1 -1
  332. package/lib/langium/workspace/hydranium-langium-document-factory.js +188 -5
  333. package/lib/langium/workspace/hydranium-langium-document-factory.js.map +1 -1
  334. package/lib/langium/workspace/hydranium-workspace-lock.d.ts +50 -1
  335. package/lib/langium/workspace/hydranium-workspace-lock.d.ts.map +1 -1
  336. package/lib/langium/workspace/hydranium-workspace-lock.js +73 -1
  337. package/lib/langium/workspace/hydranium-workspace-lock.js.map +1 -1
  338. package/lib/langium/workspace/hydranium-workspace-manager.d.ts +105 -21
  339. package/lib/langium/workspace/hydranium-workspace-manager.d.ts.map +1 -1
  340. package/lib/langium/workspace/hydranium-workspace-manager.js +186 -31
  341. package/lib/langium/workspace/hydranium-workspace-manager.js.map +1 -1
  342. package/lib/langium/workspace/in-memory-file-system-provider.d.ts +26 -9
  343. package/lib/langium/workspace/in-memory-file-system-provider.d.ts.map +1 -1
  344. package/lib/langium/workspace/in-memory-file-system-provider.js +45 -22
  345. package/lib/langium/workspace/in-memory-file-system-provider.js.map +1 -1
  346. package/lib/langium/workspace/index-manager.d.ts.map +1 -1
  347. package/lib/langium/workspace/index-manager.js.map +1 -1
  348. package/lib/langium/workspace/index.d.ts +3 -0
  349. package/lib/langium/workspace/index.d.ts.map +1 -1
  350. package/lib/langium/workspace/index.js +3 -0
  351. package/lib/langium/workspace/index.js.map +1 -1
  352. package/lib/langium/workspace/initialize-workspace.d.ts +40 -3
  353. package/lib/langium/workspace/initialize-workspace.d.ts.map +1 -1
  354. package/lib/langium/workspace/initialize-workspace.js +68 -3
  355. package/lib/langium/workspace/initialize-workspace.js.map +1 -1
  356. package/lib/langium/workspace/langium-documents.d.ts +7 -0
  357. package/lib/langium/workspace/langium-documents.d.ts.map +1 -1
  358. package/lib/langium/workspace/langium-documents.js +18 -1
  359. package/lib/langium/workspace/langium-documents.js.map +1 -1
  360. package/lib/langium/workspace/persistent-file-system-provider.d.ts +16 -10
  361. package/lib/langium/workspace/persistent-file-system-provider.d.ts.map +1 -1
  362. package/lib/langium/workspace/persistent-file-system-provider.js +25 -13
  363. package/lib/langium/workspace/persistent-file-system-provider.js.map +1 -1
  364. package/lib/{documents → langium/workspace}/self-save-registry.d.ts +7 -9
  365. package/lib/langium/workspace/self-save-registry.d.ts.map +1 -0
  366. package/lib/{documents → langium/workspace}/self-save-registry.js +9 -11
  367. package/lib/langium/workspace/self-save-registry.js.map +1 -0
  368. package/lib/langium/workspace/syntax-errors.d.ts +23 -0
  369. package/lib/langium/workspace/syntax-errors.d.ts.map +1 -0
  370. package/lib/langium/workspace/syntax-errors.js +29 -0
  371. package/lib/langium/workspace/syntax-errors.js.map +1 -0
  372. package/lib/langium/workspace/virtual-document.d.ts +55 -21
  373. package/lib/langium/workspace/virtual-document.d.ts.map +1 -1
  374. package/lib/langium/workspace/virtual-document.js +87 -24
  375. package/lib/langium/workspace/virtual-document.js.map +1 -1
  376. package/lib/langium/workspace/write-lock-scope.d.ts +22 -10
  377. package/lib/langium/workspace/write-lock-scope.d.ts.map +1 -1
  378. package/lib/langium/workspace/write-lock-scope.js +15 -5
  379. package/lib/langium/workspace/write-lock-scope.js.map +1 -1
  380. package/lib/launcher/integrated-server.d.ts +3 -1
  381. package/lib/launcher/integrated-server.d.ts.map +1 -1
  382. package/lib/locale/server-locale.d.ts +6 -6
  383. package/lib/locale/server-locale.d.ts.map +1 -1
  384. package/lib/locale/server-locale.js.map +1 -1
  385. package/lib/lsp/completion/hydranium-completion-provider.d.ts +44 -2
  386. package/lib/lsp/completion/hydranium-completion-provider.d.ts.map +1 -1
  387. package/lib/lsp/completion/hydranium-completion-provider.js +68 -0
  388. package/lib/lsp/completion/hydranium-completion-provider.js.map +1 -1
  389. package/lib/lsp/connection-features.d.ts +23 -0
  390. package/lib/lsp/connection-features.d.ts.map +1 -0
  391. package/lib/lsp/connection-features.js +60 -0
  392. package/lib/lsp/connection-features.js.map +1 -0
  393. package/lib/lsp/diagnostics-connection.d.ts +27 -0
  394. package/lib/lsp/diagnostics-connection.d.ts.map +1 -0
  395. package/lib/lsp/diagnostics-connection.js +53 -0
  396. package/lib/lsp/diagnostics-connection.js.map +1 -0
  397. package/lib/lsp/edit-requests-guard.d.ts +31 -0
  398. package/lib/lsp/edit-requests-guard.d.ts.map +1 -0
  399. package/lib/lsp/edit-requests-guard.js +125 -0
  400. package/lib/lsp/edit-requests-guard.js.map +1 -0
  401. package/lib/lsp/hydranium-document-update-handler.d.ts +126 -82
  402. package/lib/lsp/hydranium-document-update-handler.d.ts.map +1 -1
  403. package/lib/lsp/hydranium-document-update-handler.js +234 -101
  404. package/lib/lsp/hydranium-document-update-handler.js.map +1 -1
  405. package/lib/lsp/index.d.ts +6 -2
  406. package/lib/lsp/index.d.ts.map +1 -1
  407. package/lib/lsp/index.js +6 -2
  408. package/lib/lsp/index.js.map +1 -1
  409. package/lib/lsp/lsp-latency.d.ts +39 -0
  410. package/lib/lsp/lsp-latency.d.ts.map +1 -0
  411. package/lib/lsp/lsp-latency.js +58 -0
  412. package/lib/lsp/lsp-latency.js.map +1 -0
  413. package/lib/lsp/save-text-document.d.ts +31 -0
  414. package/lib/lsp/save-text-document.d.ts.map +1 -0
  415. package/lib/lsp/save-text-document.js +52 -0
  416. package/lib/lsp/save-text-document.js.map +1 -0
  417. package/lib/lsp/semantic-token-provider.d.ts +58 -2
  418. package/lib/lsp/semantic-token-provider.d.ts.map +1 -1
  419. package/lib/lsp/semantic-token-provider.js +98 -9
  420. package/lib/lsp/semantic-token-provider.js.map +1 -1
  421. package/lib/lsp/shared-module.d.ts +4 -8
  422. package/lib/lsp/shared-module.d.ts.map +1 -1
  423. package/lib/lsp/shared-module.js.map +1 -1
  424. package/lib/lsp/start-language-server.d.ts +12 -7
  425. package/lib/lsp/start-language-server.d.ts.map +1 -1
  426. package/lib/lsp/start-language-server.js +21 -7
  427. package/lib/lsp/start-language-server.js.map +1 -1
  428. package/lib/messages/carriers.d.ts +4 -6
  429. package/lib/messages/carriers.d.ts.map +1 -1
  430. package/lib/messages/carriers.js +4 -6
  431. package/lib/messages/carriers.js.map +1 -1
  432. package/lib/messages/index.d.ts +2 -2
  433. package/lib/messages/index.d.ts.map +1 -1
  434. package/lib/messages/index.js +2 -2
  435. package/lib/messages/index.js.map +1 -1
  436. package/lib/messages/renderer.d.ts +10 -4
  437. package/lib/messages/renderer.d.ts.map +1 -1
  438. package/lib/messages/renderer.js +6 -0
  439. package/lib/messages/renderer.js.map +1 -1
  440. package/lib/node/event-loop-monitor.d.ts.map +1 -1
  441. package/lib/node/event-loop-monitor.js +3 -2
  442. package/lib/node/event-loop-monitor.js.map +1 -1
  443. package/lib/node/heap-ceiling.d.ts +61 -0
  444. package/lib/node/heap-ceiling.d.ts.map +1 -0
  445. package/lib/node/heap-ceiling.js +72 -0
  446. package/lib/node/heap-ceiling.js.map +1 -0
  447. package/lib/node/index.d.ts +1 -1
  448. package/lib/node/index.d.ts.map +1 -1
  449. package/lib/node/index.js +5 -1
  450. package/lib/node/index.js.map +1 -1
  451. package/lib/node/latency-from-env.d.ts +1 -1
  452. package/lib/node/latency-from-env.js +1 -1
  453. package/lib/node/lint-grammar.js.map +1 -1
  454. package/lib/node/log-file-sink.d.ts +3 -2
  455. package/lib/node/log-file-sink.d.ts.map +1 -1
  456. package/lib/node/log-file-sink.js +6 -2
  457. package/lib/node/log-file-sink.js.map +1 -1
  458. package/lib/node/log-preamble-node.d.ts +5 -3
  459. package/lib/node/log-preamble-node.d.ts.map +1 -1
  460. package/lib/node/log-preamble-node.js +13 -10
  461. package/lib/node/log-preamble-node.js.map +1 -1
  462. package/lib/node/measure-memory.d.ts.map +1 -1
  463. package/lib/node/measure-memory.js +5 -4
  464. package/lib/node/measure-memory.js.map +1 -1
  465. package/lib/node/memory-monitor.d.ts +2 -2
  466. package/lib/node/memory-monitor.d.ts.map +1 -1
  467. package/lib/node/memory-monitor.js +9 -10
  468. package/lib/node/memory-monitor.js.map +1 -1
  469. package/lib/node/node-file-system-provider.d.ts +67 -9
  470. package/lib/node/node-file-system-provider.d.ts.map +1 -1
  471. package/lib/node/node-file-system-provider.js +198 -53
  472. package/lib/node/node-file-system-provider.js.map +1 -1
  473. package/lib/node/profile-capture.d.ts +12 -4
  474. package/lib/node/profile-capture.d.ts.map +1 -1
  475. package/lib/node/profile-capture.js +8 -6
  476. package/lib/node/profile-capture.js.map +1 -1
  477. package/lib/node/profile-digest.js.map +1 -1
  478. package/lib/node/profiling-run.d.ts +13 -3
  479. package/lib/node/profiling-run.d.ts.map +1 -1
  480. package/lib/node/profiling-run.js +17 -8
  481. package/lib/node/profiling-run.js.map +1 -1
  482. package/lib/node/rename-over-open-readers.d.ts +61 -0
  483. package/lib/node/rename-over-open-readers.d.ts.map +1 -0
  484. package/lib/node/rename-over-open-readers.js +80 -0
  485. package/lib/node/rename-over-open-readers.js.map +1 -0
  486. package/lib/node/server-diagnostics.js +1 -1
  487. package/lib/node/server-diagnostics.js.map +1 -1
  488. package/lib/node/server-state-snapshot.d.ts +6 -5
  489. package/lib/node/server-state-snapshot.d.ts.map +1 -1
  490. package/lib/node/server-state-snapshot.js +20 -17
  491. package/lib/node/server-state-snapshot.js.map +1 -1
  492. package/lib/node/socket-launcher.d.ts +43 -7
  493. package/lib/node/socket-launcher.d.ts.map +1 -1
  494. package/lib/node/socket-launcher.js +42 -7
  495. package/lib/node/socket-launcher.js.map +1 -1
  496. package/lib/node/startup-cpu-profile.d.ts +29 -0
  497. package/lib/node/startup-cpu-profile.d.ts.map +1 -0
  498. package/lib/node/startup-cpu-profile.js +91 -0
  499. package/lib/node/startup-cpu-profile.js.map +1 -0
  500. package/lib/node/stdio-launcher.d.ts +13 -13
  501. package/lib/node/stdio-launcher.d.ts.map +1 -1
  502. package/lib/node/stdio-launcher.js +21 -11
  503. package/lib/node/stdio-launcher.js.map +1 -1
  504. package/lib/node/validate-workspace.d.ts +1 -1
  505. package/lib/node/validate-workspace.d.ts.map +1 -1
  506. package/lib/node/validate-workspace.js +5 -1
  507. package/lib/node/validate-workspace.js.map +1 -1
  508. package/lib/testing/document-uri-policy-conformance.js +1 -1
  509. package/lib/testing/document-uri-policy-conformance.js.map +1 -1
  510. package/lib/testing/fake-description.js.map +1 -1
  511. package/lib/testing/fake-document.d.ts +2 -1
  512. package/lib/testing/fake-document.d.ts.map +1 -1
  513. package/lib/testing/fake-document.js.map +1 -1
  514. package/lib/testing/index.d.ts +1 -1
  515. package/lib/testing/index.d.ts.map +1 -1
  516. package/lib/testing/index.js +2 -1
  517. package/lib/testing/index.js.map +1 -1
  518. package/lib/testing/langium-test-helpers.d.ts.map +1 -1
  519. package/lib/testing/langium-test-helpers.js +1 -0
  520. package/lib/testing/langium-test-helpers.js.map +1 -1
  521. package/lib/testing/make-noop-language-services.js.map +1 -1
  522. package/lib/testing/make-noop-shared-services.js.map +1 -1
  523. package/lib/testing/make-test-services.d.ts +45 -14
  524. package/lib/testing/make-test-services.d.ts.map +1 -1
  525. package/lib/testing/make-test-services.js +23 -7
  526. package/lib/testing/make-test-services.js.map +1 -1
  527. package/lib/testing/make-test-tracer.d.ts +12 -0
  528. package/lib/testing/make-test-tracer.d.ts.map +1 -1
  529. package/lib/testing/make-test-tracer.js +13 -0
  530. package/lib/testing/make-test-tracer.js.map +1 -1
  531. package/lib/testing/node/applied-edit-capture.d.ts +29 -0
  532. package/lib/testing/node/applied-edit-capture.d.ts.map +1 -0
  533. package/lib/testing/node/applied-edit-capture.js +117 -0
  534. package/lib/testing/node/applied-edit-capture.js.map +1 -0
  535. package/lib/testing/node/golden-corpus.js.map +1 -1
  536. package/lib/testing/node/index.d.ts +4 -1
  537. package/lib/testing/node/index.d.ts.map +1 -1
  538. package/lib/testing/node/index.js +4 -1
  539. package/lib/testing/node/index.js.map +1 -1
  540. package/lib/testing/node/lsp-harness.d.ts.map +1 -1
  541. package/lib/testing/node/lsp-harness.js +2 -0
  542. package/lib/testing/node/lsp-harness.js.map +1 -1
  543. package/lib/testing/node/lsp-server-connection.d.ts +21 -6
  544. package/lib/testing/node/lsp-server-connection.d.ts.map +1 -1
  545. package/lib/testing/node/lsp-server-connection.js +49 -106
  546. package/lib/testing/node/lsp-server-connection.js.map +1 -1
  547. package/lib/testing/node/scratch-workspace.d.ts +2 -1
  548. package/lib/testing/node/scratch-workspace.d.ts.map +1 -1
  549. package/lib/testing/node/scratch-workspace.js +12 -6
  550. package/lib/testing/node/scratch-workspace.js.map +1 -1
  551. package/lib/testing/node/settle-server.d.ts +33 -0
  552. package/lib/testing/node/settle-server.d.ts.map +1 -0
  553. package/lib/testing/node/settle-server.js +84 -0
  554. package/lib/testing/node/settle-server.js.map +1 -0
  555. package/lib/testing/node/spawned-server.d.ts +30 -1
  556. package/lib/testing/node/spawned-server.d.ts.map +1 -1
  557. package/lib/testing/node/spawned-server.js +39 -2
  558. package/lib/testing/node/spawned-server.js.map +1 -1
  559. package/lib/testing/playwright/browser-capture-bridge.js.map +1 -1
  560. package/lib/testing/playwright/e2e-profiling.js.map +1 -1
  561. package/lib/testing/playwright/flaky-network-proxy.d.ts +76 -0
  562. package/lib/testing/playwright/flaky-network-proxy.d.ts.map +1 -0
  563. package/lib/testing/playwright/flaky-network-proxy.js +164 -0
  564. package/lib/testing/playwright/flaky-network-proxy.js.map +1 -0
  565. package/lib/testing/playwright/index.d.ts +1 -0
  566. package/lib/testing/playwright/index.d.ts.map +1 -1
  567. package/lib/testing/playwright/index.js +1 -0
  568. package/lib/testing/playwright/index.js.map +1 -1
  569. package/lib/testing/playwright/server-log-capture.d.ts +46 -16
  570. package/lib/testing/playwright/server-log-capture.d.ts.map +1 -1
  571. package/lib/testing/playwright/server-log-capture.js +111 -40
  572. package/lib/testing/playwright/server-log-capture.js.map +1 -1
  573. package/lib/testing/playwright/server-log-fixture.d.ts +16 -0
  574. package/lib/testing/playwright/server-log-fixture.d.ts.map +1 -1
  575. package/lib/testing/playwright/server-log-fixture.js +25 -6
  576. package/lib/testing/playwright/server-log-fixture.js.map +1 -1
  577. package/lib/testing/playwright/server-log-region.d.ts +15 -0
  578. package/lib/testing/playwright/server-log-region.d.ts.map +1 -0
  579. package/lib/testing/playwright/server-log-region.js +30 -0
  580. package/lib/testing/playwright/server-log-region.js.map +1 -0
  581. package/lib/testing/playwright/server-log-rename-reporter.d.ts.map +1 -1
  582. package/lib/testing/playwright/server-log-rename-reporter.js +4 -3
  583. package/lib/testing/playwright/server-log-rename-reporter.js.map +1 -1
  584. package/lib/testing/run-update-pipeline.d.ts +8 -5
  585. package/lib/testing/run-update-pipeline.d.ts.map +1 -1
  586. package/lib/testing/run-update-pipeline.js.map +1 -1
  587. package/lib/testing/stub-ast-document-manager.d.ts +11 -51
  588. package/lib/testing/stub-ast-document-manager.d.ts.map +1 -1
  589. package/lib/testing/stub-ast-document-manager.js +31 -59
  590. package/lib/testing/stub-ast-document-manager.js.map +1 -1
  591. package/lib/testing/stub-document-builder.d.ts +25 -11
  592. package/lib/testing/stub-document-builder.d.ts.map +1 -1
  593. package/lib/testing/stub-document-builder.js +91 -2
  594. package/lib/testing/stub-document-builder.js.map +1 -1
  595. package/lib/testing/stub-hydranium-text-documents.d.ts +33 -10
  596. package/lib/testing/stub-hydranium-text-documents.d.ts.map +1 -1
  597. package/lib/testing/stub-hydranium-text-documents.js +132 -16
  598. package/lib/testing/stub-hydranium-text-documents.js.map +1 -1
  599. package/lib/testing/stub-index-manager.js.map +1 -1
  600. package/lib/testing/stub-langium-documents.d.ts +3 -2
  601. package/lib/testing/stub-langium-documents.d.ts.map +1 -1
  602. package/lib/testing/stub-langium-documents.js.map +1 -1
  603. package/lib/testing/stub-model-service.d.ts +8 -7
  604. package/lib/testing/stub-model-service.d.ts.map +1 -1
  605. package/lib/testing/stub-model-service.js +4 -4
  606. package/lib/testing/stub-model-service.js.map +1 -1
  607. package/lib/testing/stub-project-manager.d.ts.map +1 -1
  608. package/lib/testing/stub-project-manager.js +10 -0
  609. package/lib/testing/stub-project-manager.js.map +1 -1
  610. package/lib/testing/stub-self-save-registry.d.ts +1 -1
  611. package/lib/testing/stub-self-save-registry.d.ts.map +1 -1
  612. package/lib/testing/stub-service-registry.d.ts +1 -1
  613. package/lib/testing/stub-service-registry.js.map +1 -1
  614. package/lib/testing/stub-writable-file-system.d.ts +1 -1
  615. package/lib/testing/stub-writable-file-system.d.ts.map +1 -1
  616. package/lib/testing/stub-writable-file-system.js +2 -1
  617. package/lib/testing/stub-writable-file-system.js.map +1 -1
  618. package/lib/util/connection-liveness.d.ts +22 -6
  619. package/lib/util/connection-liveness.d.ts.map +1 -1
  620. package/lib/util/connection-liveness.js +75 -15
  621. package/lib/util/connection-liveness.js.map +1 -1
  622. package/lib/util/environment.d.ts +7 -0
  623. package/lib/util/environment.d.ts.map +1 -1
  624. package/lib/util/environment.js +15 -1
  625. package/lib/util/environment.js.map +1 -1
  626. package/lib/util/registry.d.ts.map +1 -1
  627. package/package.json +41 -60
  628. package/src/browser/host-heads-in-worker.ts +218 -0
  629. package/src/browser/index.ts +17 -0
  630. package/src/browser/indexeddb-file-system-store.ts +192 -0
  631. package/src/browser/start-language-server-in-worker.ts +56 -0
  632. package/src/documents/ast-document-manager.ts +477 -250
  633. package/src/documents/client-ids.ts +5 -22
  634. package/src/documents/client-session-errors.ts +26 -0
  635. package/src/documents/client-session-registry.ts +262 -0
  636. package/src/documents/dirty-state-tracker.ts +167 -0
  637. package/src/documents/document-release-handler.ts +404 -0
  638. package/src/documents/document-release-scheduler.ts +121 -0
  639. package/src/documents/file-system-task-queue.ts +77 -0
  640. package/src/documents/hydranium-text-documents.ts +1044 -615
  641. package/src/documents/index.ts +10 -2
  642. package/src/documents/language-client-shadow.ts +501 -0
  643. package/src/documents/model-ledger.ts +66 -0
  644. package/src/documents/text-ledger.ts +112 -0
  645. package/src/documents/version-sync-service.ts +304 -0
  646. package/src/index.ts +3 -0
  647. package/src/langium/ast-extension/ast-extension-service.ts +77 -41
  648. package/src/langium/ast-extension/ast-node-builder.ts +35 -13
  649. package/src/langium/bootstrap.ts +79 -43
  650. package/src/langium/build-phase-pass/build-phase-pass-service.ts +29 -19
  651. package/src/langium/build-phase-pass/build-phase-pass.ts +37 -8
  652. package/src/langium/composite-ast-reflection.ts +112 -0
  653. package/src/langium/config/configuration-provider.ts +119 -0
  654. package/src/langium/config/index.ts +1 -0
  655. package/src/langium/diagnostics/console-tee.ts +150 -0
  656. package/src/langium/diagnostics/hydranium-langium-profiler.ts +15 -39
  657. package/src/langium/diagnostics/log-preamble.ts +1 -1
  658. package/src/langium/diagnostics/logger.ts +51 -17
  659. package/src/langium/diagnostics/lsp-logger.ts +83 -45
  660. package/src/langium/document-builder/build-pipeline-integration.ts +57 -32
  661. package/src/langium/document-builder/build-session.ts +4 -3
  662. package/src/langium/document-builder/document-builder.ts +773 -106
  663. package/src/langium/integration-services.ts +20 -23
  664. package/src/langium/integrity/integrity-rule.ts +22 -8
  665. package/src/langium/integrity/integrity-service.ts +656 -90
  666. package/src/langium/keys/containment.ts +3 -2
  667. package/src/langium/keys/name-based-key-provider.ts +24 -12
  668. package/src/langium/language-module.ts +52 -9
  669. package/src/langium/model-service/client-session.ts +769 -0
  670. package/src/langium/model-service/index.ts +2 -0
  671. package/src/langium/model-service/model-events.ts +82 -0
  672. package/src/langium/model-service/model-service.ts +885 -532
  673. package/src/langium/module.ts +141 -65
  674. package/src/langium/naming/name-provider.ts +34 -8
  675. package/src/langium/project/abstract-project-manager.ts +409 -20
  676. package/src/langium/project/project-change-event.ts +25 -3
  677. package/src/langium/project/project-manager.ts +31 -2
  678. package/src/langium/project/single-project-manager.ts +16 -1
  679. package/src/langium/residency/cst-residency-service.ts +210 -87
  680. package/src/langium/scope/ast-node-description-provider.ts +111 -16
  681. package/src/langium/scope/built-local-symbols.ts +13 -0
  682. package/src/langium/scope/fallback-scope.ts +38 -0
  683. package/src/langium/scope/hydranium-scope-computation.ts +45 -44
  684. package/src/langium/scope/hydranium-scope-provider.ts +245 -41
  685. package/src/langium/scope/index.ts +1 -0
  686. package/src/langium/scope/reference-candidate-provider.ts +6 -5
  687. package/src/langium/scope/scope-extension-service.ts +148 -56
  688. package/src/langium/scope/scoped-ast-node-description.ts +1 -3
  689. package/src/langium/serialization/abstract-serializer.ts +57 -41
  690. package/src/langium/serialization/json-serializer.ts +14 -3
  691. package/src/langium/serialization/serializer.ts +1 -1
  692. package/src/langium/serialization/yaml-serializer.ts +26 -4
  693. package/src/langium/service-registry.ts +41 -2
  694. package/src/langium/shared-services.ts +13 -4
  695. package/src/langium/single-langium-copy.ts +42 -0
  696. package/src/langium/transfer/transfer-encoder.ts +76 -50
  697. package/src/langium/trivia/comment-preserver.ts +1410 -0
  698. package/src/langium/trivia/document-ending-preserver.ts +71 -0
  699. package/src/langium/trivia/index.ts +14 -0
  700. package/src/langium/trivia/trivia-contribution.ts +39 -0
  701. package/src/langium/trivia/trivia-preserver.ts +56 -0
  702. package/src/langium/trivia/trivia-service.ts +99 -0
  703. package/src/langium/update-rewrite/update-rewrite-service.ts +1 -1
  704. package/src/langium/update-rewrite/update-rewrite.ts +1 -1
  705. package/src/langium/validation/document-validator.ts +312 -31
  706. package/src/langium/validation/validation-contribution-collector.ts +10 -1
  707. package/src/langium/workspace/ast-node-locator.ts +33 -0
  708. package/src/langium/workspace/document-uri-policy.ts +32 -18
  709. package/src/langium/workspace/file-not-found.ts +35 -0
  710. package/src/langium/workspace/file-system-provider.ts +258 -16
  711. package/src/langium/workspace/hydranium-langium-document-factory.ts +239 -4
  712. package/src/langium/workspace/hydranium-workspace-lock.ts +101 -2
  713. package/src/langium/workspace/hydranium-workspace-manager.ts +214 -35
  714. package/src/langium/workspace/in-memory-file-system-provider.ts +54 -23
  715. package/src/langium/workspace/index.ts +3 -0
  716. package/src/langium/workspace/initialize-workspace.ts +96 -4
  717. package/src/langium/workspace/langium-documents.ts +19 -1
  718. package/src/langium/workspace/persistent-file-system-provider.ts +27 -15
  719. package/src/{documents → langium/workspace}/self-save-registry.ts +12 -14
  720. package/src/langium/workspace/syntax-errors.ts +34 -0
  721. package/src/langium/workspace/virtual-document.ts +106 -25
  722. package/src/langium/workspace/write-lock-scope.ts +27 -12
  723. package/src/launcher/integrated-server.ts +3 -1
  724. package/src/locale/server-locale.ts +6 -6
  725. package/src/lsp/completion/hydranium-completion-provider.ts +82 -2
  726. package/src/lsp/connection-features.ts +67 -0
  727. package/src/lsp/diagnostics-connection.ts +56 -0
  728. package/src/lsp/edit-requests-guard.ts +152 -0
  729. package/src/lsp/hydranium-document-update-handler.ts +284 -110
  730. package/src/lsp/index.ts +6 -2
  731. package/src/lsp/lsp-latency.ts +62 -0
  732. package/src/lsp/save-text-document.ts +63 -0
  733. package/src/lsp/semantic-token-provider.ts +146 -8
  734. package/src/lsp/shared-module.ts +4 -8
  735. package/src/lsp/start-language-server.ts +21 -7
  736. package/src/messages/carriers.ts +4 -6
  737. package/src/messages/index.ts +11 -2
  738. package/src/messages/renderer.ts +11 -3
  739. package/src/node/event-loop-monitor.ts +3 -4
  740. package/src/node/heap-ceiling.ts +108 -0
  741. package/src/node/index.ts +5 -1
  742. package/src/node/latency-from-env.ts +1 -1
  743. package/src/node/log-file-sink.ts +6 -2
  744. package/src/node/log-preamble-node.ts +20 -10
  745. package/src/node/measure-memory.ts +5 -4
  746. package/src/node/memory-monitor.ts +10 -10
  747. package/src/node/node-file-system-provider.ts +214 -57
  748. package/src/node/profile-capture.ts +16 -15
  749. package/src/node/profiling-run.ts +30 -8
  750. package/src/node/rename-over-open-readers.ts +94 -0
  751. package/src/node/server-diagnostics.ts +1 -1
  752. package/src/node/server-state-snapshot.ts +28 -20
  753. package/src/node/socket-launcher.ts +78 -14
  754. package/src/node/startup-cpu-profile.ts +94 -0
  755. package/src/node/stdio-launcher.ts +29 -19
  756. package/src/node/validate-workspace.ts +8 -2
  757. package/src/testing/document-uri-policy-conformance.ts +1 -1
  758. package/src/testing/fake-document.ts +2 -1
  759. package/src/testing/index.ts +2 -1
  760. package/src/testing/langium-test-helpers.ts +1 -0
  761. package/src/testing/make-test-services.ts +83 -31
  762. package/src/testing/make-test-tracer.ts +26 -0
  763. package/src/testing/node/applied-edit-capture.ts +141 -0
  764. package/src/testing/node/index.ts +4 -1
  765. package/src/testing/node/lsp-harness.ts +2 -0
  766. package/src/testing/node/lsp-server-connection.ts +83 -119
  767. package/src/testing/node/scratch-workspace.ts +12 -6
  768. package/src/testing/node/settle-server.ts +89 -0
  769. package/src/testing/node/spawned-server.ts +57 -3
  770. package/src/testing/parse-semantic-root.ts +1 -1
  771. package/src/testing/playwright/flaky-network-proxy.ts +240 -0
  772. package/src/testing/playwright/index.ts +1 -0
  773. package/src/testing/playwright/server-log-capture.ts +137 -47
  774. package/src/testing/playwright/server-log-fixture.ts +46 -6
  775. package/src/testing/playwright/server-log-region.ts +32 -0
  776. package/src/testing/playwright/server-log-rename-reporter.ts +4 -3
  777. package/src/testing/run-update-pipeline.ts +8 -5
  778. package/src/testing/stub-ast-document-manager.ts +47 -123
  779. package/src/testing/stub-document-builder.ts +128 -15
  780. package/src/testing/stub-hydranium-text-documents.ts +184 -27
  781. package/src/testing/stub-langium-documents.ts +3 -2
  782. package/src/testing/stub-model-service.ts +9 -8
  783. package/src/testing/stub-project-manager.ts +10 -0
  784. package/src/testing/stub-self-save-registry.ts +1 -1
  785. package/src/testing/stub-service-registry.ts +1 -1
  786. package/src/testing/stub-writable-file-system.ts +3 -2
  787. package/src/util/connection-liveness.ts +81 -15
  788. package/src/util/environment.ts +24 -2
  789. package/lib/documents/language-client-text-shadow.d.ts +0 -124
  790. package/lib/documents/language-client-text-shadow.d.ts.map +0 -1
  791. package/lib/documents/language-client-text-shadow.js +0 -190
  792. package/lib/documents/language-client-text-shadow.js.map +0 -1
  793. package/lib/documents/self-save-registry.d.ts.map +0 -1
  794. package/lib/documents/self-save-registry.js.map +0 -1
  795. package/lib/lsp/instrument-connection.d.ts +0 -36
  796. package/lib/lsp/instrument-connection.d.ts.map +0 -1
  797. package/lib/lsp/instrument-connection.js +0 -62
  798. package/lib/lsp/instrument-connection.js.map +0 -1
  799. package/lib/node/process-memory.d.ts +0 -66
  800. package/lib/node/process-memory.d.ts.map +0 -1
  801. package/lib/node/process-memory.js +0 -252
  802. package/lib/node/process-memory.js.map +0 -1
  803. package/src/documents/language-client-text-shadow.ts +0 -211
  804. package/src/lsp/instrument-connection.ts +0 -66
  805. package/src/node/process-memory.ts +0 -299
@@ -9,31 +9,51 @@
9
9
 
10
10
  import {
11
11
  type CanonicalUri,
12
- type CloseModelArgs,
13
- ConflictError,
14
12
  defineMessage,
15
- Logger,
16
13
  type MaybeObservableValue,
17
14
  type MaybePromise,
18
15
  ObservableValue,
19
- type TransferDiagnostic,
16
+ randomUuid,
17
+ TIMED_OUT,
20
18
  type TransferElement,
21
- type OpenModelArgs,
19
+ type TextVersion,
22
20
  type Tracer,
23
- type TransferSaveArgs,
24
- type TransferUpdateArgs
21
+ UNRECORDED_VERSION,
22
+ describeErrorWithStack
25
23
  } from '@hydranium/protocol';
26
- import { type AstNode, DocumentState, type LangiumDocument, UriUtils, type URI } from '@hydranium/langium';
24
+ import {
25
+ type AstNode,
26
+ DocumentState,
27
+ type LangiumDocument,
28
+ OperationCancelled,
29
+ isOperationCancelled,
30
+ UriUtils,
31
+ type URI
32
+ } from '@hydranium/langium';
33
+ import { type AstDiagnostic } from '../validation/document-validator.js';
27
34
  import { type DocumentUriPolicy } from '../workspace/document-uri-policy.js';
28
- import { ReentrantWriteLockError, isInsideWriteLock } from '../workspace/write-lock-scope.js';
29
- import { type CancellationToken, type Disposable } from 'vscode-languageserver';
30
- import { AstDocument, type AstDocumentSavedEvent, type AstDocumentUpdatedEvent } from '../../documents/ast-document-manager.js';
31
- import { isConnectionGoneError } from '../../util/connection-liveness.js';
35
+ import { hasSyntaxErrors } from '../workspace/syntax-errors.js';
36
+ import { ReentrantWriteLockError, isInsideWriteLock, isWriteLockScopeInstalled } from '../workspace/write-lock-scope.js';
37
+ import { type ApplyWorkspaceEditResult, CancellationToken, Disposable } from 'vscode-languageserver';
38
+ import { AstDocument } from '../../documents/ast-document-manager.js';
39
+ import { isClientGoneError } from '../../util/connection-liveness.js';
32
40
  import { type LogNameOptions } from '../diagnostics/logger.js';
33
41
  import { IntegrityService } from '../integrity/integrity-service.js';
34
42
  import { labelPhaseListener } from '../document-builder/labeled-phase-listener.js';
35
43
  import { LANGUAGE_CLIENT_ID } from '../../documents/client-ids.js';
44
+ import { type OpenOptions } from '../../documents/client-session-registry.js';
36
45
  import { type ServerSharedServices } from '../module.js';
46
+ import { type ClientSession } from './client-session.js';
47
+ import {
48
+ type ModelDeletedEvent,
49
+ type ModelDirtyChangedEvent,
50
+ type ModelEventFilter,
51
+ type ModelPhaseFilter,
52
+ type ModelReleasedEvent,
53
+ type ModelSavedEvent,
54
+ type ModelsBuiltEvent,
55
+ type ModelUpdatedEvent
56
+ } from './model-events.js';
37
57
 
38
58
  /**
39
59
  * The undo-stack entry for a server-authored write pushed to the editor.
@@ -52,17 +72,13 @@ import { type ServerSharedServices } from '../module.js';
52
72
  */
53
73
  export const MODEL_UPDATE_EDIT = defineMessage('hydranium/core/model-update-edit', 'Update Model');
54
74
 
55
- /** Max time {@link ModelService.settleSave} waits for the build to settle and the sync chain to drain. */
56
- const SAVE_SETTLE_TIMEOUT_MS = 10_000;
57
-
58
75
  /**
59
- * Marks the {@link SAVE_SETTLE_TIMEOUT_MS} branch of
60
- * {@link ModelService.settleSave}'s race so it stays distinguishable from a
61
- * genuine rejection (a cancelled token, an `applyEdit` reverse-RPC error, a
62
- * build throw). With a plain `Error` the only log line an adopter has blames
63
- * the timeout for every one of them, which points debugging at the wrong layer.
76
+ * Max time {@link ModelService.settleLanguageClient} waits. A save answers up to
77
+ * this long after its persist, and a data-head update or a diagram's settle
78
+ * request after its write, so a client timing out one of those answers must
79
+ * allow it plus the work before.
64
80
  */
65
- class SaveSettleTimeoutError extends Error {}
81
+ const LANGUAGE_CLIENT_SETTLE_TIMEOUT_MS = 10_000;
66
82
 
67
83
  /**
68
84
  * Constructor options for {@link ModelService}. All fields are optional,
@@ -70,75 +86,81 @@ class SaveSettleTimeoutError extends Error {}
70
86
  */
71
87
  export interface ModelServiceOptions extends LogNameOptions {
72
88
  /**
73
- * When set, {@link ModelService.update} logs a `warn` line if its
74
- * end-to-end wait (serialise + content-change apply + rebuild +
75
- * settled-phase wait) exceeds this many milliseconds. Default
76
- * `undefined` (no warn line ever emitted; the underlying
77
- * `Logger.time` debug timing log is unchanged either way).
89
+ * Let the facade's build run without the workspace write lock when its
90
+ * caller already holds it: an integrity rule or build-phase pass that
91
+ * writes back through a session's `update` / `save`, or calls `rebuild`.
92
+ * Default `false`.
93
+ *
94
+ * `WorkspaceLock` is not reentrant. Taking it from inside a holder cancels
95
+ * that holder and then waits for it to end, while the holder waits for this
96
+ * call, so neither completes. On `false` that call fails with
97
+ * {@link ReentrantWriteLockError} instead, wherever a host installs a
98
+ * write-lock scope tracker (`@hydranium/core/node` does at entry load); on
99
+ * `true` its build takes no lock. The wait after that build can still hang,
100
+ * because a document no build will carry is re-queued through the lock, and
101
+ * the re-queue waits for the holder to end.
78
102
  *
79
- * Pure observability — does NOT abort the update, does NOT change
80
- * resolution semantics. Adopters wanting a hard timeout that throws
81
- * instead override {@link ModelService.update} on their subclass and
82
- * race the parent call against their own deadline.
103
+ * A session's delete is refused that way on either value, since its builds
104
+ * always take the lock.
83
105
  *
84
- * Recommended starting threshold: 2-5 seconds for interactive paths
85
- * (form save, diagram edit). Workspaces with very large documents
86
- * or slow validation may legitimately exceed 5s on the cold path —
87
- * tune per workspace.
106
+ * Every other facade build takes the lock on either value. Unlocked, it can
107
+ * overlap another build of the same document: both run a full validation
108
+ * pass that Langium appends, and a caller can be handed a version that an
109
+ * integrity repair still running in the other build then moves past. Without
110
+ * a tracker the two cases cannot be told apart (see
111
+ * {@link isWriteLockScopeInstalled}), so `true` builds without the lock every
112
+ * time and accepts both.
88
113
  *
89
- * Accepts a {@link MaybeObservableValue} so the threshold can be a
90
- * fixed constant or bound to a user setting via `Settings.number`
91
- * and retuned live. Leaving it unset disables the warn line entirely
92
- * (and skips the per-update stopwatch).
114
+ * Accepts a {@link MaybeObservableValue} so it can be bound to a setting and
115
+ * flipped without a restart.
93
116
  */
94
- readonly slowUpdateWarnMs?: MaybeObservableValue<number>;
117
+ readonly allowReentrantBuilds?: MaybeObservableValue<boolean>;
95
118
  /**
96
- * Serialise the facade's own build under the workspace WRITE lock, the way
97
- * Langium's `DefaultDocumentUpdateHandler` dispatches its build. Default
98
- * `true`.
99
- *
100
- * **Why it defaults on.** Unlocked, the facade's build races the LSP bridge's
101
- * build of the same URI — both are legitimate (the bridge exists only under a
102
- * `Connection`, so the facade stands in for it headless), but nothing
103
- * serialises them, so both run a full validation pass and Langium appends the
104
- * second onto the first. Every diagnostic is then duplicated, and the
105
- * duplication compounds per rebuild. Serialised, Langium elides the second
106
- * build entirely, so the redundant work goes too.
107
- *
108
- * **What `false` costs.** The facade's build is then unserialised and can run
109
- * concurrently with the bridge's build of the same URI, so the affected
110
- * documents are validated twice per write — double the validation work.
111
- * Reported diagnostics stay correct even then, because
112
- * `HydraniumDocumentBuilder.dedupeDiagnostics` collapses the byte-identical
113
- * duplicates a repeated pass produces before any listener sees them; what this
114
- * option removes is the wasted pass, not just its visible symptom.
119
+ * Let a structured write keep the text the document's root was parsed from
120
+ * when that text serializes to the same text as the written model, so an
121
+ * update that changes nothing in the model leaves hand formatting alone.
122
+ * Default `false`: every structured write applies the canonical text.
115
123
  *
116
- * **What `false` buys.** `WorkspaceLock` is not reentrant. A caller that
117
- * reaches `update` / `save` / `rebuild` while already holding the write lock —
118
- * an integrity rule or build-phase pass that writes through this facade —
119
- * deadlocks: acquiring the lock cancels the running holder, and the new
120
- * acquisition then waits for that holder to release while the holder waits
121
- * for this call. On `true` that shape is DETECTED and rejected with
122
- * {@link ReentrantWriteLockError} rather than hanging, wherever a host
123
- * installs a write-lock scope tracker (`@hydranium/core/node` does at entry
124
- * load; see {@link isInsideWriteLock}). Setting `false` is the escape hatch
125
- * for an adopter whose reentrant shape is unavoidable — nothing acquires the
126
- * lock then, so there is nothing to be reentrant about; prefer it over
127
- * unserialised builds only in that case.
124
+ * Costs a parse, an encode and a serialization per write whose text
125
+ * differs; remembering the text last written instead would not cover a
126
+ * file formatted outside the framework. Text with lexer or parser errors is
127
+ * replaced as usual by {@link ModelService.modelToText}, though a session
128
+ * refuses to write a model there.
128
129
  *
129
- * Accepts a {@link MaybeObservableValue} so it can be bound to a setting and
130
- * flipped without a restart.
130
+ * Accepts a {@link MaybeObservableValue} so it can be bound to a setting.
131
+ */
132
+ readonly keepUnchangedText?: MaybeObservableValue<boolean>;
133
+ }
134
+
135
+ /** One {@link ModelService.onModelUpdated} subscription; `uri` is canonical, absent for every document. */
136
+ export interface ModelUpdateSubscriber<TAst extends AstNode, TDiagnostic extends AstDiagnostic = AstDiagnostic> {
137
+ readonly uri?: CanonicalUri;
138
+ readonly listener: (event: ModelUpdatedEvent<TAst, TDiagnostic>) => void;
139
+ }
140
+
141
+ /** Options for a {@link DefaultModelService} wait on one document. */
142
+ export interface SyncedWaitOptions {
143
+ /**
144
+ * Build a root parsed from text older than the store's at the call, and
145
+ * reject once that build, or one the builder re-queues, is given up. Without
146
+ * it, such a root is left to other builds, and a wait they never end stays
147
+ * pending until its token is cancelled.
131
148
  */
132
- readonly serializeBuilds?: MaybeObservableValue<boolean>;
149
+ readonly sync?: boolean;
133
150
  }
134
151
 
135
152
  /**
153
+ * The seam every non-LSP head talks to: the data server, the GLSP head and an
154
+ * adopter's own services reach documents through this slot rather than through
155
+ * the workspace stores.
156
+ *
136
157
  * In-process facade over the framework's document plumbing
137
158
  * (`HydraniumTextDocuments`, `LangiumDocuments`,
138
- * `DocumentBuilder`, `WritableFileSystemProvider`). Owns the
139
- * `open / request / update / save / ready` lifecycle that protocol heads
140
- * (LSP, data-server, GLSP) delegate to so coordinating those primitives
141
- * doesn't have to be re-implemented per-head.
159
+ * `DocumentBuilder`, `WritableFileSystemProvider`). Owns the document
160
+ * lifecycle the data-server and GLSP heads delegate to — client sessions that
161
+ * open, update, save and close documents, the phase reads, and `ready` — so
162
+ * coordinating those primitives doesn't have to be re-implemented per head.
163
+ * Every open and write goes through a session from {@link createSession}.
142
164
  *
143
165
  * "Model" here means the parsed AST — distinct from the wire-shape
144
166
  * `TransferDocument` in `@hydranium/protocol`.
@@ -148,9 +170,9 @@ export interface ModelServiceOptions extends LogNameOptions {
148
170
  * Multiple in-process consumers want the same workspace-level
149
171
  * operations:
150
172
  * - The data-server head turns these into typed RPC methods.
151
- * - The GLSP head uses the same lifecycle for diagram-driven edits;
152
- * GModel operation handlers route through `update` for AST mutation,
153
- * `waitForDocumentState` for indexed-phase waits before reads, etc.
173
+ * - The GLSP head uses the same lifecycle for diagram-driven edits: GModel
174
+ * operation handlers write through the diagram's session and wait on phases
175
+ * before reading.
154
176
  * - Server-internal callers (integrity service, ad-hoc bridges, tests)
155
177
  * want the same operations without the wire serialisation step.
156
178
  *
@@ -163,15 +185,16 @@ export interface ModelServiceOptions extends LogNameOptions {
163
185
  *
164
186
  * **Read-latest supersession**
165
187
  *
166
- * The default `update` and `save` flows use Langium's per-URI
167
- * `DocumentBuilder.waitUntil` to wait for the integrity-settled landmark
168
- * ({@link IntegrityService.SettledState}), then read the post-build state. Concurrent
169
- * in-process callers on the same URI all see the latest post-build
170
- * snapshot — none deadlock waiting for a specific version's settled
171
- * event. Adopters wanting strict version-matched semantics (resolve
172
- * with vN's snapshot specifically, log "vN superseded by vM at vN+1")
173
- * override {@link update} to attach a phase-listener with explicit
174
- * version checks; the framework default doesn't need it for safety.
188
+ * A session's default `update` and `save` use Langium's per-URI
189
+ * `DocumentBuilder.waitUntil` to wait for `Validated` (the integrity-settled
190
+ * landmark {@link IntegrityService.SettledState} when rebuilds do not
191
+ * validate), then read the post-build state. Concurrent in-process callers
192
+ * on the same URI all see the latest post-build snapshot — none deadlock
193
+ * waiting for a specific version's settled event. Adopters wanting strict
194
+ * version-matched semantics (resolve with vN's snapshot specifically, log
195
+ * "vN superseded by vM at vN+1") override
196
+ * `DefaultClientSession.updateDocument` to attach a phase-listener with
197
+ * explicit version checks; the framework default doesn't need it for safety.
175
198
  *
176
199
  * **Returns AST snapshots, not wire envelopes**
177
200
  *
@@ -184,32 +207,26 @@ export interface ModelServiceOptions extends LogNameOptions {
184
207
  * the injected `TransferEncoder` — symmetric with the
185
208
  * `getModelDocument` envelope path.
186
209
  *
187
- * **Subscriptions** ({@link onModelUpdated} / {@link onModelSaved} /
188
- * {@link onClientClosed}) are thin pass-throughs over
189
- * `DocumentBuilder.onDocumentPhase` and
190
- * `HydraniumTextDocuments.onDidSave` / `onDidClose`. Filtering
191
- * by URI happens here so consumers can subscribe per-document without
192
- * implementing the URI gate at each callsite.
210
+ * **Subscriptions** (`on*`) are how a head follows documents; it subscribes
211
+ * here rather than to the builder or the text store. Each takes a filter, and
212
+ * one without a `uri` hears every document.
193
213
  *
194
- * **Generic parameters.**
195
- * - `TAst` — the AST root type each consumer expects on the returned
196
- * {@link AstDocument}. Constrained to {@link AstNode}.
197
- * - `TDiagnostic` — wire diagnostic shape used by the injected
198
- * `TransferEncoder`. Defaults to {@link TransferDiagnostic}.
199
- * - `TTransfer` — transfer-model root accepted by `update` / `save`
200
- * args. Constrained to {@link TransferElement}. Defaults to the
201
- * structural base.
202
- */
203
- /**
204
- * The seam every non-LSP head talks to: the data server, the GLSP head and an
205
- * adopter's own services reach documents through this slot rather than through
206
- * the workspace stores.
214
+ * **Two families.** `waitFor*` only waits: it rejects for a URI with no
215
+ * document, and for a root behind the store's text it waits for whatever
216
+ * builds it next, so it never ends if nothing does. `ensureDocumentState` and
217
+ * the phase shorthands over it build a missing document, and build a root
218
+ * behind its text, rejecting when that build fails twice. Both re-queue a
219
+ * document the builder's last build left short of the state.
207
220
  *
208
- * **Two families, and the distinction matters more than the names suggest.**
209
- * `waitFor*` is a pure wait — it never triggers a build, so a caller waiting on
210
- * a document no build has touched waits until something else builds it.
211
- * `ensureDocumentState` and the phase shorthands over it *dispatch*: warm
212
- * documents are awaited, cold ones are built.
221
+ * Both resolve at the state with a root parsed from text no older than the
222
+ * store's version at the call; inside the write lock, at the state alone, since
223
+ * the build that would sync the document to that version cannot start until
224
+ * it is released.
225
+ *
226
+ * Do not await one inside a build phase listener: a browser host installs no
227
+ * write-lock scope, so the wait cannot tell it is inside a build and waits for
228
+ * one that cannot start. Nor inside a `WorkspaceLock.read`: the lock starts no
229
+ * write, the build included, while a read runs.
213
230
  *
214
231
  * **Diagnostics are typed `never` below `Validated`.** Validation is the last
215
232
  * phase, so at any earlier landmark the array either is not yet computed or
@@ -225,10 +242,27 @@ export interface ModelServiceOptions extends LogNameOptions {
225
242
  * The waits resolve at or ABOVE their target, so an already-validated document
226
243
  * does carry usable diagnostics and the `never` over-forbids there. That
227
244
  * direction is the safe one: the alternative permits stale reads silently. A
228
- * member taking a phase as a PARAMETER cannot judge statically and so returns
229
- * `TDiagnostic`, leaving the choice to the caller.
245
+ * member taking a phase as a PARAMETER returns `TDiagnostic`, and leaves them
246
+ * absent for a phase below `Validated`.
247
+ *
248
+ * **Generic parameters.**
249
+ * - `TAst` — the AST root type each consumer expects on the returned
250
+ * {@link AstDocument}. Constrained to {@link AstNode}.
251
+ * - `TDiagnostic` — the AST-layer diagnostic: whatever the build left on
252
+ * `LangiumDocument.diagnostics`, carried through on the returned
253
+ * {@link AstDocument}. Defaults to {@link AstDiagnostic}.
254
+ * **Not the `TransferEncoder`'s parameter of the same name**, which is
255
+ * that encoder's OUTPUT and so names the wire shape. This one names its
256
+ * input, and an adopter binds the two to different types.
257
+ * - `TTransfer` — transfer-model root a session's `update` / `save` accept
258
+ * args. Constrained to {@link TransferElement}. Defaults to the
259
+ * structural base.
230
260
  */
231
- export interface ModelService<TAst extends AstNode, TDiagnostic = TransferDiagnostic, TTransfer extends TransferElement = TransferElement> {
261
+ export interface ModelService<
262
+ TAst extends AstNode,
263
+ TDiagnostic extends AstDiagnostic = AstDiagnostic,
264
+ TTransfer extends TransferElement = TransferElement
265
+ > {
232
266
  /**
233
267
  * Resolves once the workspace has been initialised and its first build has
234
268
  * completed — the gate every read should wait behind, since a document
@@ -240,38 +274,129 @@ export interface ModelService<TAst extends AstNode, TDiagnostic = TransferDiagno
240
274
  */
241
275
  readonly ready: Promise<void>;
242
276
 
243
- // Pure waits — never trigger a build.
277
+ // Wait only; a root behind its text is left to another build.
244
278
  waitForDocumentState(uri: string, state: DocumentState, cancelToken?: CancellationToken): Promise<AstDocument<TAst, TDiagnostic>>;
245
279
  waitForDocumentSettled(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>>;
246
280
  waitForBuilderState(state: DocumentState, cancelToken?: CancellationToken): Promise<void>;
247
281
 
248
- // Wait if warm, build if cold.
282
+ // Build what is missing or behind its text, then wait.
249
283
  ensureDocumentState(uri: string, state?: DocumentState, cancelToken?: CancellationToken): Promise<AstDocument<TAst, TDiagnostic>>;
250
284
  rebuild(uri: string, state?: DocumentState, cancelToken?: CancellationToken): Promise<AstDocument<TAst, TDiagnostic>>;
285
+ /**
286
+ * Throw where {@link rebuild} would reject as reentrant. A write calls it
287
+ * before applying its text: a text applied and then refused stays applied
288
+ * with no build to follow it.
289
+ */
290
+ assertCanBuild(uri: string): void;
251
291
  parsed(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>>;
252
292
  linked(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>>;
253
293
  settled(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>>;
254
294
  indexed(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>>;
255
295
  validated(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, TDiagnostic>>;
256
296
 
257
- update(args: TransferUpdateArgs<TTransfer>, cancelToken?: CancellationToken): Promise<AstDocument<TAst, TDiagnostic>>;
258
- save(args: TransferSaveArgs<TTransfer>, cancelToken?: CancellationToken): Promise<AstDocument<TAst, TDiagnostic>>;
259
-
260
- open(args: OpenModelArgs): Promise<Disposable>;
261
- close(args: CloseModelArgs): Promise<void>;
262
297
  isOpen(uri: string): boolean;
298
+ /**
299
+ * The version the document at `uri` was opened at, which a client's write
300
+ * or an integrity repair steps past; `undefined` while it is not open.
301
+ */
302
+ openedVersion(uri: string): TextVersion | undefined;
303
+ snapshot(uri: string): AstDocument<TAst, TDiagnostic> | undefined;
304
+ /**
305
+ * The text a session's write of `model` to `uri` applies: a textual model
306
+ * as given, a structured one rewritten and serialised. Also the text to
307
+ * create a document with: for a `uri` with no text the trivia preservers
308
+ * still run, so it gets their defaults, such as
309
+ * `DocumentEndingPreserver.DEFAULT_ENDING`. With
310
+ * {@link ModelServiceOptions.keepUnchangedText} set, a model equal to the
311
+ * document's gives the text its root was parsed from instead.
312
+ */
313
+ modelToText(uri: string, model: TTransfer | string, cancelToken?: CancellationToken): Promise<string>;
263
314
  getDocument(uri: string): LangiumDocument | undefined;
315
+ /**
316
+ * Resolve once the document's build has settled and the language client
317
+ * has answered the push of its text, applied or refused and logged, so a
318
+ * save answering after it does not race that push. Does not wait again for
319
+ * a push an earlier settle timed out on and the client has not answered
320
+ * since. Never rejects: past its bound it warns and resolves, and a failed
321
+ * wait is logged and resolves.
322
+ */
323
+ settleLanguageClient(uri: string, cancelToken?: CancellationToken): Promise<void>;
324
+ /**
325
+ * Whether a push of the document's text into the language client awaits the
326
+ * client's answer. A push a settle already timed out on does not count: that
327
+ * settle has warned about it.
328
+ */
329
+ isLanguageClientPushPending(uri: string): boolean;
330
+
331
+ /**
332
+ * Fires as a document reaches the filter's phase, `Validated` by default.
333
+ * Listeners run inside the build, so one that throws is logged and the
334
+ * others still run.
335
+ */
336
+ onModelUpdated(listener: (event: ModelUpdatedEvent<TAst, TDiagnostic>) => void, filter?: ModelPhaseFilter): Disposable;
337
+ /**
338
+ * Fires once per build that reaches the phase, with every document it
339
+ * carried there. A listener that throws is logged, as for {@link onModelUpdated}.
340
+ */
341
+ onModelsBuilt(listener: (event: ModelsBuiltEvent) => void, filter?: Pick<ModelPhaseFilter, 'phase'>): Disposable;
342
+ /**
343
+ * Fires for every save, whichever client made it, as the store announces
344
+ * it. A document saved before its first build arrives as an empty envelope
345
+ * at `UNRECORDED_VERSION`, whose `root` is `undefined` despite its type.
346
+ */
347
+ onModelSaved(listener: (event: ModelSavedEvent<TAst, TDiagnostic>) => void, filter?: ModelEventFilter): Disposable;
348
+ /**
349
+ * Fires for every document a build removes, with the session whose
350
+ * `delete` removed it, as `AstDocumentManager.attributeDeletion` names it.
351
+ */
352
+ onModelDeleted(listener: (event: ModelDeletedEvent) => void, filter?: ModelEventFilter): Disposable;
353
+ /** Fires when a document's text starts or stops differing from its file. */
354
+ onDirtyChanged(listener: (event: ModelDirtyChangedEvent) => void, filter?: ModelEventFilter): Disposable;
355
+ /**
356
+ * Fires when the store releases a document no client has open any more.
357
+ * What the build keeps for it is up to the
358
+ * `DocumentReleaseHandler` slot; the default reverts it to disk, and that
359
+ * rebuild follows as an {@link onModelUpdated} event, unless a client opens
360
+ * the document first or its file is deleted.
361
+ */
362
+ onModelReleased(listener: (event: ModelReleasedEvent) => void, filter?: ModelEventFilter): Disposable;
363
+ /** Fires when `filter.clientId` closes `filter.uri`, its session ending included. */
364
+ onClientClosed(listener: () => void, filter: { readonly uri: string; readonly clientId: string }): Disposable;
264
365
 
265
- onModelUpdated(uri: string, listener: (event: AstDocumentUpdatedEvent<TAst, TDiagnostic>) => void): Disposable;
266
- onModelSaved(uri: string, listener: (event: AstDocumentSavedEvent<TAst, TDiagnostic>) => void): Disposable;
267
- onClientClosed(uri: string, clientId: string, listener: () => void): Disposable;
366
+ /**
367
+ * Start a client session, the only way to open and write documents through
368
+ * this service. Pass a `label` naming the participant; without one it is
369
+ * `session`. The id defaults to `label#` plus a random UUID; a fixed
370
+ * `clientId` is taken as given. Throws `ReservedClientIdError` when the id
371
+ * is reserved by the framework, and `DuplicateClientIdError` when it is
372
+ * held by another live session or has documents open under it as a client
373
+ * that is not a session.
374
+ *
375
+ * A `resumeToken` matching the one the live session under `clientId` was
376
+ * started with ends that session as lost first, so the documents it was
377
+ * last to hold keep their unsaved text for the new one. The token guards
378
+ * against taking over a session by accident, not against a peer: anyone who
379
+ * knows it can end the session.
380
+ *
381
+ * `TOpenOptions` types the options the session's `open` takes and its
382
+ * `openOptions` returns. The narrowing is an unchecked cast, and it holds
383
+ * only for the caller that started the session: a holder reached through
384
+ * {@link getSession} sees plain `OpenOptions`.
385
+ */
386
+ createSession<TOpenOptions extends OpenOptions = OpenOptions>(
387
+ label?: string,
388
+ clientId?: string,
389
+ options?: { readonly resumeToken?: string }
390
+ ): ClientSession<TAst, TDiagnostic, TTransfer, TOpenOptions>;
391
+ /** The live session started under `clientId`, or `undefined` once it has ended or was never started. */
392
+ getSession(clientId: string): ClientSession<TAst, TDiagnostic, TTransfer> | undefined;
268
393
  }
269
394
 
270
395
  export class DefaultModelService<
271
396
  TAst extends AstNode,
272
- TDiagnostic = TransferDiagnostic,
397
+ TDiagnostic extends AstDiagnostic = AstDiagnostic,
273
398
  /**
274
- * Structured payload accepted by `update` / `save`. Constrained to
399
+ * Structured payload a session's `update` / `save` accept. Constrained to
275
400
  * {@link TransferElement} — the minimal `{ readonly $type: string }`
276
401
  * shape. Both transfer-model overlay roots (which extend
277
402
  * `TransferElement` explicitly) and AST root types (which have
@@ -291,14 +416,10 @@ export class DefaultModelService<
291
416
  * (see {@link DocumentUriPolicy}).
292
417
  */
293
418
  protected readonly uriPolicy: DocumentUriPolicy;
294
- /**
295
- * Live slow-update-warn threshold cell, or `undefined` when the option
296
- * was not supplied (warn line + stopwatch disabled). Reads `.value` per
297
- * update so a setting-bound threshold retunes without reconstruction.
298
- */
299
- protected readonly slowUpdateWarn?: ObservableValue<number>;
300
- /** See {@link ModelServiceOptions.serializeBuilds}. Defaults to `true`. */
301
- protected readonly serializeBuilds: ObservableValue<boolean>;
419
+ /** See {@link ModelServiceOptions.allowReentrantBuilds}. Defaults to `false`. */
420
+ protected readonly allowReentrantBuilds: ObservableValue<boolean>;
421
+ /** See {@link ModelServiceOptions.keepUnchangedText}. Defaults to `false`. */
422
+ protected readonly keepUnchangedText: ObservableValue<boolean>;
302
423
 
303
424
  /**
304
425
  * Per-URI applyEdit coalescing: at most one in-flight `applyEditToLanguageClient`
@@ -308,6 +429,30 @@ export class DefaultModelService<
308
429
  */
309
430
  protected readonly syncChains = new Map<string, Promise<void>>();
310
431
  protected readonly pendingSync = new Map<string, string>();
432
+ /**
433
+ * The sync chains a settle timed out on, until the client answers their
434
+ * push. A later settle does not wait on one meanwhile: GLSP runs a diagram's
435
+ * saves one at a time, so each would add the full bound and a queued save
436
+ * outlast its client's timeout.
437
+ */
438
+ protected readonly timedOutSyncChains = new WeakSet<Promise<void>>();
439
+
440
+ /** The live sessions this service started, by client id, for {@link getSession}. */
441
+ protected readonly sessions = new Map<string, ClientSession<TAst, TDiagnostic, TTransfer>>();
442
+ /**
443
+ * Drops an ended session from {@link sessions}. Subscribed by the first
444
+ * {@link createSession} rather than at construction, so a services tree with
445
+ * no text store, or one that knows nothing of sessions, still constructs
446
+ * this service.
447
+ */
448
+ protected sessionCloseListener?: Disposable;
449
+ /** The token each live session was started with, by client id, for a takeover by {@link createSession}. */
450
+ protected readonly resumeTokens = new Map<string, string>();
451
+ /**
452
+ * The {@link onModelUpdated} subscribers, by phase. One builder listener per
453
+ * phase serves them all, kept for the life of the service.
454
+ */
455
+ protected readonly updateSubscribers = new Map<DocumentState, Set<ModelUpdateSubscriber<TAst, TDiagnostic>>>();
311
456
 
312
457
  /**
313
458
  * Workspace-level readiness gate. Resolves when the framework has
@@ -349,30 +494,27 @@ export class DefaultModelService<
349
494
  ) {
350
495
  this.tracer = services.Tracer.for(options.logName ?? 'ModelService').trace('instantiated');
351
496
  this.uriPolicy = services.workspace.DocumentUriPolicy;
352
- this.slowUpdateWarn = options.slowUpdateWarnMs !== undefined ? ObservableValue.from(options.slowUpdateWarnMs) : undefined;
353
- this.serializeBuilds = ObservableValue.from(options.serializeBuilds ?? true);
497
+ this.allowReentrantBuilds = ObservableValue.from(options.allowReentrantBuilds ?? false);
498
+ this.keepUnchangedText = ObservableValue.from(options.keepUnchangedText ?? false);
354
499
  // Optional-chain so a harness that binds no WorkspaceManager awaits
355
500
  // `undefined` and resolves immediately; production hosts always have it
356
501
  // bound.
357
502
  // Deliberately NO fallback to Langium's `ready`: it resolves pre-build,
358
503
  // so falling back to it would silently reinstate the very gap this gate
359
504
  // exists to close.
360
- // Captured rather than read off `this` inside the closure, which TS cannot
361
- // prove runs after the field is assigned.
362
- const tracer = this.tracer;
363
505
  this.ready = (async () => {
364
506
  try {
365
507
  await services.workspace.WorkspaceManager?.workspaceInitialized;
366
- } catch (error: unknown) {
508
+ } catch {
367
509
  // NEVER rejects, deliberately. This gate is about TIMING — "the
368
510
  // initial build has finished" — not about whether it succeeded, and
369
- // Langium's `ready` (what it replaced) could not reject at all.
370
- // `workspaceInitialized` can: it rejects on a cancelled initial
371
- // build (routine — any write preempts one) and on a failed one
372
- // (e.g. a disposed connection at teardown). Propagating either would
373
- // fail every `waitForReady` for the rest of the process lifetime,
374
- // a far worse failure than the late gate this exists to fix.
375
- tracer.debug(`Initial workspace build did not complete cleanly: ${error instanceof Error ? error.message : String(error)}`);
511
+ // the workspace manager's `ready` (what it replaced) rejects only on
512
+ // a failed startup. `workspaceInitialized` also rejects on a
513
+ // cancelled initial build (routine — any write preempts one) and on
514
+ // a failed one (e.g. a disposed connection at teardown).
515
+ // Propagating either would fail every `waitForReady` for the rest
516
+ // of the process lifetime, a far worse failure than the late gate
517
+ // this exists to fix. The workspace manager logs the outcome.
376
518
  }
377
519
  })();
378
520
  // One persistent listener mirroring non-LSP-client changes back to the LSP
@@ -394,10 +536,12 @@ export class DefaultModelService<
394
536
  // ============================================================
395
537
 
396
538
  /**
397
- * Wait for the document at `uri` to reach `state`. Pure wait — does
398
- * not trigger a build. If `uri` is not yet in the document registry
399
- * the call will hang until something else drives it through the
400
- * pipeline; for the cold-start case use {@link rebuild} instead.
539
+ * Wait for the document at `uri` to reach `state` with a root no older than
540
+ * the store's text at the call. Rejects if `uri` is not in the document
541
+ * registry. A root behind its text is not built: the wait lasts until
542
+ * something else builds it, so use {@link ensureDocumentState} where
543
+ * nothing may. Builds that keep failing leave the wait pending, to its
544
+ * cancellation token.
401
545
  *
402
546
  * Wrapped in a debug-level timing log via {@link Tracer.time} so
403
547
  * slow per-URI waits surface in build telemetry; the URI is
@@ -411,15 +555,12 @@ export class DefaultModelService<
411
555
  * Wait for the document at `uri` to reach the integrity-settled landmark
412
556
  * ({@link IntegrityService.SettledState}) — the earliest phase at which the
413
557
  * AST + serialised text are stable post-integrity. Convenience wrapper over
414
- * {@link waitForDocumentState} for the common "wait until content is stable"
415
- * case (e.g. settling a save). Pure wait — does not trigger a build.
558
+ * {@link waitForDocumentState}, and like it builds nothing behind its text.
416
559
  */
417
560
  async waitForDocumentSettled(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>> {
418
- return (await this.waitForDocumentStateCanonical(
419
- this.uriPolicy.canonicalUri(uri),
420
- IntegrityService.SettledState,
421
- cancelToken
422
- )) as AstDocument<TAst, never>;
561
+ return this.withoutDiagnostics(
562
+ await this.waitForDocumentStateCanonical(this.uriPolicy.canonicalUri(uri), IntegrityService.SettledState, cancelToken)
563
+ );
423
564
  }
424
565
 
425
566
  /**
@@ -431,21 +572,120 @@ export class DefaultModelService<
431
572
  * the identity once instead of re-running the (filesystem-touching) `realpath`
432
573
  * at every wait. The `CanonicalUri` parameter type enforces that — a raw
433
574
  * `string` cannot be passed without minting through the URI policy.
575
+ *
576
+ * With `options.sync`, a root behind the store's text is built, as in
577
+ * {@link ensureDocumentState}; without it, the root is left to other builds,
578
+ * as in {@link waitForDocumentState}. Below `Validated` the envelope has no
579
+ * diagnostics: see {@link withoutDiagnostics}.
434
580
  */
435
581
  protected async waitForDocumentStateCanonical(
436
582
  uri: CanonicalUri,
437
583
  state: DocumentState,
438
- cancelToken?: CancellationToken
584
+ cancelToken?: CancellationToken,
585
+ options: SyncedWaitOptions = {}
439
586
  ): Promise<AstDocument<TAst, TDiagnostic>> {
440
587
  const documentUri = UriUtils.toUri(uri);
588
+ // Read at call time: a later edit must not extend this wait.
589
+ const textVersion = isInsideWriteLock() ? undefined : this.services.workspace.TextDocuments.textState(uri)?.version;
441
590
  await this.tracer
442
591
  .withUri(uri)
443
592
  .time(
444
593
  `Wait for document state '${DocumentState[state]}'`,
445
- () => this.services.workspace.DocumentBuilder.waitUntil(state, documentUri, cancelToken),
594
+ () => this.waitUntilSynced(documentUri, state, textVersion, cancelToken, options),
446
595
  'debug'
447
596
  );
448
- return this.toAstDocument(documentUri);
597
+ const document = this.toAstDocument(documentUri);
598
+ return state >= DocumentState.Validated ? document : this.withoutDiagnostics(document);
599
+ }
600
+
601
+ /**
602
+ * Wait for `state` with a root parsed from text at `textVersion` or later. A
603
+ * root no factory recorded counts as synced, since no build records it.
604
+ * With `options.sync`, a root still behind is built through
605
+ * `VersionSyncService.syncTo`, and the wait rejects once that build, or one
606
+ * the builder re-queues to reach `state`, is given up. Without it, the wait
607
+ * lasts until another build parses the text, and stays pending when the
608
+ * builder gives up re-queuing the document.
609
+ */
610
+ protected async waitUntilSynced(
611
+ uri: URI,
612
+ state: DocumentState,
613
+ textVersion: TextVersion | undefined,
614
+ cancelToken?: CancellationToken,
615
+ options: SyncedWaitOptions = {}
616
+ ): Promise<void> {
617
+ const builder = this.services.workspace.DocumentBuilder;
618
+ const sync = this.services.workspace.VersionSyncService;
619
+ const waitOptions = { rejectWhenStuck: options.sync === true };
620
+ await builder.waitUntil(state, uri, cancelToken, waitOptions);
621
+ if (textVersion === undefined) {
622
+ return;
623
+ }
624
+ while (!sync.isSyncedTo(uri, textVersion)) {
625
+ const build = options.sync === true ? sync.syncTo(uri, textVersion) : undefined;
626
+ this.tracer
627
+ .withUri(uri.toString())
628
+ .debug(`waiting for ${uri.toString()} to reach ${DocumentState[state]} at v${textVersion} or later`);
629
+ await this.nextParseOrDeletion(uri, cancelToken, build);
630
+ await builder.waitUntil(state, uri, cancelToken, waitOptions);
631
+ }
632
+ }
633
+
634
+ /**
635
+ * Resolves once a parse of `uri` has been recorded or a build has deleted
636
+ * it, rejecting with `OperationCancelled` when `cancelToken` is cancelled
637
+ * first, and with an error when `build`, the build requested for it, is
638
+ * given up. A `Parsed` phase listener cannot serve: a cancel right after the
639
+ * parse skips it, and the resumed build does not parse again.
640
+ */
641
+ protected nextParseOrDeletion(uri: URI, cancelToken: CancellationToken = CancellationToken.None, build?: Promise<void>): Promise<void> {
642
+ const builder = this.services.workspace.DocumentBuilder;
643
+ return new Promise<void>((resolve, reject) => {
644
+ let ended = false;
645
+ let cancelled = false;
646
+ // Handled before any return, so a build given up after the wait ended is not an unhandled rejection.
647
+ build?.catch((error: unknown) => {
648
+ const line = `The build that would sync the root to its text failed. ${describeErrorWithStack(error)}`;
649
+ if (cancelled) {
650
+ // The waiter has gone, so nothing else reports this.
651
+ this.tracer.withUri(uri.toString()).error(line);
652
+ } else if (ended) {
653
+ // A parse or deletion came first: the waiter goes on and reports its own outcome, and the retry warned.
654
+ this.tracer.withUri(uri.toString()).debug(line);
655
+ } else {
656
+ done(() => reject(new Error(`The build that would sync ${uri.toString()} to its text failed`, { cause: error })));
657
+ }
658
+ });
659
+ // A cancelled token's listener runs a macrotask later, after a build
660
+ // that started meanwhile may have parsed.
661
+ if (cancelToken.isCancellationRequested) {
662
+ ended = true;
663
+ cancelled = true;
664
+ reject(OperationCancelled);
665
+ return;
666
+ }
667
+ const done = (settle: () => void): void => {
668
+ ended = true;
669
+ parsed.dispose();
670
+ deleted.dispose();
671
+ cancelling.dispose();
672
+ settle();
673
+ };
674
+ const parsed = this.services.workspace.VersionSyncService.onDidRecordModel(document => {
675
+ if (UriUtils.equals(document.uri, uri)) {
676
+ done(resolve);
677
+ }
678
+ });
679
+ const deleted = builder.onUpdate((_changed, deletedUris) => {
680
+ if (deletedUris.some(deletedUri => UriUtils.equals(deletedUri, uri))) {
681
+ done(resolve);
682
+ }
683
+ });
684
+ const cancelling = cancelToken.onCancellationRequested(() => {
685
+ cancelled = true;
686
+ done(() => reject(OperationCancelled));
687
+ });
688
+ });
449
689
  }
450
690
 
451
691
  /**
@@ -469,31 +709,35 @@ export class DefaultModelService<
469
709
  * Force a fresh build of the document at `uri` and wait for it to
470
710
  * reach `state` (or the integrity-settled landmark
471
711
  * {@link IntegrityService.SettledState} if omitted).
472
- * Always triggers `DocumentBuilder.update([uri], [])` regardless of
473
- * whether the document is already in the registry — call this when
474
- * you want to re-process from scratch.
712
+ * Always builds the document, whether or not it is already in the
713
+ * registry, in a build of its own or in one already scheduled that carries
714
+ * it — call this when you want to re-process from scratch.
475
715
  *
476
- * The facade is responsible for firing `DocumentBuilder.update`
477
- * directly because Langium's `DefaultDocumentUpdateHandler.didChangeContent`
716
+ * The facade is responsible for requesting the build itself because Langium's `DefaultDocumentUpdateHandler.didChangeContent`
478
717
  * (the standard text-document → builder bridge) only runs under an
479
718
  * LSP `Connection`. Running headless the bridge never fires; the
480
719
  * facade stands in for it on its own update path.
481
720
  *
482
721
  * Coexistence with an LSP head running on the same `DocumentBuilder` is
483
- * fine, but not because the builder merges the two: Langium does NOT
484
- * coalesce concurrent builds of the same URI. The LSP head fires `update`
485
- * from the LSP-driven event and the facade fires it from its own RPC-driven
486
- * event — both legitimate — so this method takes the workspace WRITE lock,
487
- * the same one Langium's own text-change bridge builds under, to serialise
488
- * them. Two unserialised builds of one URI each run a full validation pass
489
- * and Langium appends the second set onto the first, duplicating every
490
- * diagnostic. Opt out via
491
- * {@link ModelServiceOptions.serializeBuilds} — see there for the
492
- * non-reentrancy hazard that is the reason the opt-out exists.
722
+ * fine: the LSP head builds from the LSP-driven event and the facade from
723
+ * its own RPC-driven event — both legitimate — and both go through
724
+ * `HydraniumDocumentBuilder.scheduleUpdate`, which serialises them under
725
+ * the workspace WRITE lock and lets the second share the first's build
726
+ * where that build carries it. Langium alone does not coalesce concurrent
727
+ * builds of one URI: two unserialised builds each run a full validation
728
+ * pass and Langium appends the second set onto the first, duplicating every
729
+ * diagnostic. A caller that already holds the lock builds without it only
730
+ * under {@link ModelServiceOptions.allowReentrantBuilds} — see there for the
731
+ * non-reentrancy hazard.
732
+ *
733
+ * An override calls the base before it awaits. Under an LSP connection the
734
+ * store's change event has already asked the update handler to build a
735
+ * session's write; an override whose await outlasts that build makes the
736
+ * base's request start a build of its own, so the write is built and
737
+ * delivered twice.
493
738
  *
494
- * Returns an empty `{ root, diagnostics }` envelope when the document
495
- * cannot be loaded; adopters that want to throw override this method
496
- * on their subclass.
739
+ * Rejects when the build leaves no document for `uri`, as for a URI with
740
+ * neither a file nor text: the wait after it has nothing to wait on.
497
741
  *
498
742
  * Consumers wanting "give me this doc at state X, building only if
499
743
  * needed" — use the per-state methods ({@link parsed} / {@link linked}
@@ -505,8 +749,8 @@ export class DefaultModelService<
505
749
 
506
750
  /**
507
751
  * Internal build core operating on an already-{@link CanonicalUri canonical}
508
- * URI — the build counterpart to {@link waitForDocumentStateCanonical}. Drives
509
- * `DocumentBuilder.update` then waits via the canonical wait core, so the
752
+ * URI — the build counterpart to {@link waitForDocumentStateCanonical}.
753
+ * Requests the build, then waits via the canonical wait core, so the
510
754
  * identity is resolved once at the public door and neither sink re-runs the
511
755
  * `realpath`. (`DocumentBuilder.update` still resolves each URI internally for
512
756
  * directory flattening — that is the build's own existence-aware resolution,
@@ -518,58 +762,45 @@ export class DefaultModelService<
518
762
  cancelToken?: CancellationToken
519
763
  ): Promise<AstDocument<TAst, TDiagnostic>> {
520
764
  const documentUri = UriUtils.toUri(uri);
521
- // Runs under the workspace WRITE lock, matching Langium's own
522
- // `DefaultDocumentUpdateHandler`, which dispatches its build as
523
- // `workspaceLock.write(token => documentBuilder.update(...))`.
765
+ // Runs under the workspace WRITE lock, through the builder's
766
+ // `scheduleUpdate` like the LSP update handler's build, so the build the
767
+ // store's change event already scheduled for this write carries this
768
+ // request too rather than being cancelled by it.
524
769
  //
525
770
  // Unlocked, this build races the LSP bridge's build of the same URI: both
526
771
  // are legitimate (the bridge only exists under a `Connection`, so the
527
- // facade stands in for it headless), and the coexistence note above relied
528
- // on Langium coalescing them by URI. It does not — nothing serialises the
529
- // two, so both reach `Validated`, and because each computes its missing
772
+ // facade stands in for it headless), and nothing serialises the two, so
773
+ // both reach `Validated`, and because each computes its missing
530
774
  // validation categories before the other has recorded its own, both run a
531
775
  // FULL pass and Langium appends the second onto the first (its append is
532
776
  // meant for category-partitioned passes). The user-visible result is every
533
777
  // diagnostic duplicated, plus double the validation work per write.
534
778
  //
535
- // Opt out via `ModelServiceOptions.serializeBuilds` — see there for
536
- // the non-reentrancy hazard that opt-out exists for.
537
- if (this.serializeBuilds.value) {
538
- // Fail loudly on the one shape the lock cannot survive. `WorkspaceLock`
539
- // is not reentrant: acquiring the write lock cancels the running holder,
540
- // so a caller already inside one — an integrity rule or build-phase pass
541
- // writing back through this facade — would cancel its own enclosing
542
- // build and then likely stall in the phase wait below. The check is
543
- // gated on `serializeBuilds` deliberately, because acquiring the lock IS
544
- // the hazard: with serialisation off there is nothing to be reentrant
545
- // about, which makes the existing opt-out the guard's opt-out too.
546
- // Detection needs async-context propagation, so it is inert until a host
547
- // installs a tracker (`@hydranium/core/node` does) — see
548
- // `isInsideWriteLock`.
549
- if (isInsideWriteLock()) {
550
- throw new ReentrantWriteLockError(uri);
551
- }
552
- // The lock's OWN token, not the caller's: a later `write` cancels the
553
- // running one through that token, so substituting the caller's would
554
- // leave this build deaf to the lock's cancellation protocol. A caller
555
- // token still governs the phase wait below.
556
- await this.services.workspace.WorkspaceLock.write(lockToken =>
557
- this.services.workspace.DocumentBuilder.update([documentUri], [], lockToken)
558
- );
559
- } else {
779
+ // A caller already inside the lock would cancel its own build and stall in
780
+ // the wait below; `allowReentrantBuilds` builds it unlocked, and without a
781
+ // tracker it cannot be told apart from any other caller.
782
+ if (this.allowReentrantBuilds.value && (isInsideWriteLock() || !isWriteLockScopeInstalled())) {
560
783
  await this.services.workspace.DocumentBuilder.update([documentUri], [], cancelToken);
784
+ } else {
785
+ this.assertCanBuild(uri);
786
+ // The build runs on the lock's own token, which a later write cancels;
787
+ // the caller's token governs only the phase wait below.
788
+ await this.services.workspace.DocumentBuilder.scheduleUpdate([documentUri], []);
789
+ }
790
+ return this.waitForDocumentStateCanonical(uri, state ?? IntegrityService.SettledState, cancelToken, { sync: true });
791
+ }
792
+
793
+ assertCanBuild(uri: string): void {
794
+ if (isInsideWriteLock() && !this.allowReentrantBuilds.value) {
795
+ throw new ReentrantWriteLockError(uri);
561
796
  }
562
- return this.waitForDocumentStateCanonical(uri, state ?? IntegrityService.SettledState, cancelToken);
563
797
  }
564
798
 
565
799
  /**
566
800
  * Per-state typed convenience methods. Each ensures the document at
567
801
  * `uri` reaches the named phase and returns the AST envelope with
568
- * the narrowest accurate diagnostics type for that phase. Smart
569
- * dispatch internally: warm path (URI already in the document
570
- * registry) just waits via {@link waitForDocumentState}; cold path
571
- * triggers a build via {@link rebuild}. Consumers do not need to
572
- * know which path was taken.
802
+ * the narrowest accurate diagnostics type for that phase, building as
803
+ * {@link ensureDocumentState} does.
573
804
  *
574
805
  * Phase invariants encoded in the return type:
575
806
  * - `parsed` / `linked` / `settled` / `indexed` return
@@ -578,16 +809,13 @@ export class DefaultModelService<
578
809
  * - `validated` returns `AstDocument<TAst, TDiagnostic>` — diagnostics
579
810
  * are populated.
580
811
  *
581
- * **The `never` is a claim about the PHASE, not a guarantee about the
582
- * instance, and the gap is reachable rather than theoretical.** The wait
583
- * underneath resolves at or ABOVE the requested state, so a document
584
- * something else already carried past `Validated` comes back from
585
- * `settled()` with a populated diagnostics array typed `never`. Nothing
586
- * strips it — the envelope copies the live document's array verbatim — and
587
- * any host that validates its workspace before a consumer asks produces
588
- * exactly that. So read an empty array as "none were computed, or there are
589
- * none", never as "this document is clean", and call {@link validated} when
590
- * the answer has to mean the second.
812
+ * **The `never` is enforced, not merely declared.** The wait underneath
813
+ * resolves at or ABOVE the requested state, so a document something else
814
+ * already carried past `Validated` would otherwise come back from
815
+ * `settled()` carrying a full diagnostics array typed `never`; these four
816
+ * strip it. An empty array here therefore means "this read does not report
817
+ * diagnostics", never "this document is clean" — call {@link validated}
818
+ * when the answer has to mean the second.
591
819
  *
592
820
  * `settled` is the integrity-overlay name for "all integrity rules
593
821
  * have fired"; it maps to {@link IntegrityService.SettledState} (which
@@ -596,19 +824,19 @@ export class DefaultModelService<
596
824
  * ever moves.
597
825
  */
598
826
  async parsed(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>> {
599
- return this.ensureDocumentState(uri, DocumentState.Parsed, cancelToken) as Promise<AstDocument<TAst, never>>;
827
+ return this.withoutDiagnostics(await this.ensureDocumentState(uri, DocumentState.Parsed, cancelToken));
600
828
  }
601
829
 
602
830
  async linked(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>> {
603
- return this.ensureDocumentState(uri, DocumentState.Linked, cancelToken) as Promise<AstDocument<TAst, never>>;
831
+ return this.withoutDiagnostics(await this.ensureDocumentState(uri, DocumentState.Linked, cancelToken));
604
832
  }
605
833
 
606
834
  async settled(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>> {
607
- return this.ensureDocumentState(uri, IntegrityService.SettledState, cancelToken) as Promise<AstDocument<TAst, never>>;
835
+ return this.withoutDiagnostics(await this.ensureDocumentState(uri, IntegrityService.SettledState, cancelToken));
608
836
  }
609
837
 
610
838
  async indexed(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>> {
611
- return this.ensureDocumentState(uri, DocumentState.IndexedReferences, cancelToken) as Promise<AstDocument<TAst, never>>;
839
+ return this.withoutDiagnostics(await this.ensureDocumentState(uri, DocumentState.IndexedReferences, cancelToken));
612
840
  }
613
841
 
614
842
  async validated(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, TDiagnostic>> {
@@ -618,18 +846,13 @@ export class DefaultModelService<
618
846
  /**
619
847
  * Ensure the document at `uri` reaches `state` (or the integrity-settled
620
848
  * landmark {@link IntegrityService.SettledState} if omitted) and return its
621
- * AST envelope. Smart
622
- * dispatch: warm path (URI already in `LangiumDocuments`) just waits
623
- * via {@link waitForDocumentState}; cold path forces a build via
624
- * {@link rebuild}.
625
- *
626
- * Pairs with {@link rebuild} — same default phase, but `rebuild`
627
- * always builds while this skips the build for an already-loaded
628
- * document. Also pairs with {@link waitForDocumentState} — the verb
629
- * difference (`ensure` vs `waitFor`) signals the side-effect
630
- * difference. The per-state convenience methods (`parsed` / `linked`
631
- * / `settled` / `indexed` / `validated`) all delegate here with an
632
- * explicit phase.
849
+ * AST envelope, with a root no older than the store's text at the call.
850
+ * A document not in `LangiumDocuments` is built via {@link rebuild}; a
851
+ * loaded one whose root is behind its text is built through
852
+ * `VersionSyncService.syncTo`. Until `state` is reached, the call rejects
853
+ * once that build, or one the builder re-queues, has failed twice, or the
854
+ * builder stops re-queuing the document. A loaded, current document is only
855
+ * awaited.
633
856
  */
634
857
  async ensureDocumentState(uri: string, state?: DocumentState, cancelToken?: CancellationToken): Promise<AstDocument<TAst, TDiagnostic>> {
635
858
  return this.ensureDocumentStateCanonical(this.uriPolicy.canonicalUri(uri), state, cancelToken);
@@ -652,187 +875,73 @@ export class DefaultModelService<
652
875
  ): Promise<AstDocument<TAst, TDiagnostic>> {
653
876
  const target = state ?? IntegrityService.SettledState;
654
877
  if (this.services.workspace.LangiumDocuments.hasDocument(UriUtils.toUri(uri))) {
655
- return this.waitForDocumentStateCanonical(uri, target, cancelToken);
878
+ return this.waitForDocumentStateCanonical(uri, target, cancelToken, { sync: true });
656
879
  }
657
880
  return this.rebuild(uri, target, cancelToken);
658
881
  }
659
882
 
660
883
  /**
661
- * Apply an update for `uri`. The structured-or-textual `model` payload
662
- * is serialised (via {@link serialize} after {@link rewriteModel} when
663
- * structured), pushed into the multi-client text-document store with
664
- * a fresh version, drives a build to the target phase, and returns
665
- * the post-build AST snapshot.
666
- *
667
- * **Read-latest supersession**: concurrent callers on the same URI
668
- * all see the same post-build state once `waitUntil` resolves; none
669
- * deadlock waiting for a specific version's settled event. The
670
- * framework emits a post-resolution `debug` log line distinguishing
671
- * "vN ready" from "vN ready at vM (superseded)" so callers can
672
- * observe when their write was overtaken by a newer one before
673
- * settling — purely observability, doesn't change resolution
674
- * semantics. Adopters wanting version-matched resolution (resolve
675
- * with vN's specific settled snapshot, intermediate-phase
676
- * observability, slow-warn / hard-timeout behaviour) override this
677
- * method.
678
- */
679
- async update(args: TransferUpdateArgs<TTransfer>, cancelToken?: CancellationToken): Promise<AstDocument<TAst, TDiagnostic>> {
680
- const stopwatch = this.slowUpdateWarn !== undefined ? this.services.Clock.stopwatch() : undefined;
681
- // Per-stage self-time breakdown of the update/reconcile chain (serialise →
682
- // open → apply → rebuild), opt-in at debug — the default path skips the
683
- // session and `run` calls the stage directly. `update` is a per-operation
684
- // method (one user save / diagram edit), not a per-node hot loop, so the
685
- // stage closures `run` allocates on the non-debug path are negligible.
686
- // Canonicalize the write URI once at the door and thread the resulting
687
- // CanonicalUri through the chain. The text store keys documents by their
688
- // canonical identity, so any spelling of a file — a canonical
689
- // (server-identity) URI from a GLSP cross-document save derived from
690
- // `findDocument(node).uri`, or the symlink path an editor opened — collapses
691
- // to the one registration; there is no second registration to fork. The
692
- // build step reuses the canonical wait core (`rebuildCanonical`) so the
693
- // identity is not re-resolved downstream.
694
- const uri = this.uriPolicy.canonicalUri(args.uri);
695
- const session = Logger.isLevelEnabled('debug') ? this.tracer.profile(`model-update ${uri}`) : undefined;
696
- const run = async <T>(stage: string, fn: () => MaybePromise<T>): Promise<T> => (session ? session.scope(stage, fn) : fn());
697
- // Open WITH the new text so a cold URI (no open editor, no file on disk) is
698
- // created from the payload rather than read from the filesystem — `update`
699
- // is an upsert. For an already-open document `open` refreshes content (the
700
- // text is ignored on that branch), so existing-document behaviour is
701
- // unchanged. `version` is intentionally NOT forwarded to `open`, so a cold
702
- // create stays at its initial version rather than adopting a number the
703
- // caller chose.
704
- //
705
- // The gate's version is read BEFORE that open, and must be: for a document
706
- // no client holds open, the open assigns the shared version from the
707
- // INCOMING text, so a version read afterwards has already absorbed the
708
- // caller's own write. Gating on it rejected every modifying write to a
709
- // closed document, having compared the caller's `baseVersion` against a
710
- // number the caller itself produced — and a serialised round-trip that is
711
- // not byte-identical to the stored text was enough to trigger it. Reading
712
- // first keeps both cases the gate exists for: an unknown URI answers 0, so
713
- // a based-on-version update of a not-yet-existing document still trips it,
714
- // and a genuine conflict still trips it, another writer having advanced the
715
- // sequence past the version the caller read.
716
- const currentVersion = this.services.workspace.TextDocuments.version(uri);
717
- const text = await run('serialize', () => this.modelToText(uri, args.model, cancelToken));
718
- await run('open', () => this.open({ uri, clientId: args.clientId, text }));
719
- if (args.baseVersion !== undefined && currentVersion !== args.baseVersion) {
720
- // Distinct from the post-build "superseded" debug line below: this is a
721
- // based-on-stale rejection (the write never applies), not two writes racing.
722
- this.tracer.debug(`Conflict on ${uri}: based-on v${args.baseVersion} stale, server at v${currentVersion}`);
723
- throw new ConflictError(uri, args.baseVersion, currentVersion);
724
- }
725
- const appliedVersion = await run('apply', () => this.services.workspace.AstDocumentManager.update(uri, text, args.clientId));
726
- // Dispatch through the public `rebuild` (which re-canonicalizes the already-
727
- // canonical `uri` once, idempotently) rather than `rebuildCanonical`, so an
728
- // adopter `rebuild` override stays in the update path. The redundant call is
729
- // a single kernel-cached `realpath`; correctness of the override contract
730
- // wins over shaving it.
731
- const doc = await run('rebuild', () => this.rebuild(uri, undefined, cancelToken));
732
- const finalVersion = this.services.workspace.TextDocuments.version(uri);
733
- if (finalVersion > appliedVersion) {
734
- this.tracer.debug(`Update to v${appliedVersion} ready at v${finalVersion} (superseded)`);
735
- } else {
736
- this.tracer.debug(`Update to v${appliedVersion} ready`);
737
- }
738
- if (this.slowUpdateWarn !== undefined && stopwatch) {
739
- const elapsed = Math.round(stopwatch.elapsedMs);
740
- const threshold = this.slowUpdateWarn.value;
741
- if (elapsed >= threshold) {
742
- this.tracer.withUri(uri).warn(`Slow update: ${elapsed}ms ≥ ${threshold}ms (v${appliedVersion}, client=${args.clientId})`);
743
- }
744
- }
745
- // One line per stage (serialise / open / apply / rebuild) + unaccounted — only when profiling.
746
- session?.report('debug');
747
- return doc;
748
- }
749
-
750
- /**
751
- * Persist `uri` to disk. Same content-change + settled-phase flow as
752
- * {@link update}, then writes via the
753
- * `WritableFileSystemProvider` and notifies the multi-client
754
- * text-document store of the save (so any open LSP-side editor sees
755
- * the `onDidSave` event regardless of who originated the persist).
756
- *
757
- * Returns the post-save AST snapshot.
758
- */
759
- async save(args: TransferSaveArgs<TTransfer>, cancelToken?: CancellationToken): Promise<AstDocument<TAst, TDiagnostic>> {
760
- // Dispatch through `update` (not its internals) so an adopter `update`
761
- // override — version-matched resolution, etc. — applies to saves too.
762
- const doc = await this.update(args, cancelToken);
763
- // Persist under the same canonical identity `update` operated on. Writing
764
- // the canonical (real) path follows any symlink to the same file, and the
765
- // `onDidSave` keys the one canonical registration.
766
- const uri = this.uriPolicy.canonicalUri(args.uri);
767
- await this.services.workspace.AstDocumentManager.save(uri, args.clientId);
768
- return doc;
769
- }
770
-
771
- /**
772
- * Wait for the document at `uri` to reach the integrity-settled landmark and
884
+ * Wait for the document at `uri` to reach the integrity-settled landmark,
885
+ * building a root behind its text as {@link ensureDocumentState} does, and
773
886
  * drain any in-flight write-path applyEdit sync chain (see {@link syncChains})
774
- * so every language client reflects the latest content before a save returns.
775
- * No-op tail for headless adopters — `syncChains` is empty without an LSP
776
- * client. Bounded by {@link SAVE_SETTLE_TIMEOUT_MS} so a hung build, or an
777
- * applyEdit reverse-RPC deadlock, can't freeze the caller; on timeout it logs
778
- * a warning and returns rather than throwing.
887
+ * so the language client has answered the push of the latest content before
888
+ * this returns; a push it refused twice is logged, not retried. No-op tail
889
+ * for headless adopters — `syncChains` is empty without an LSP client.
890
+ * Bounded at 10 s so a hung build, or an applyEdit reverse-RPC deadlock,
891
+ * can't freeze the caller; it returns rather than throwing, warning on
892
+ * timeout. A failed wait is logged at `error`, at `debug` when cancelled and
893
+ * at `warn` when the document is gone.
779
894
  *
780
- * Adopters with a save flow that must converge editor + disk before returning
781
- * (e.g. a dual form/code editor that would otherwise show a content-conflict
782
- * dialog on rapid save) call this after their `save`.
895
+ * The framework's save handlers call this after their persist, the data
896
+ * head's updates after their write and the GLSP head's settle request for
897
+ * each document a save writes; an adopter's own save path that answers a
898
+ * client calls it after its `save` too.
783
899
  */
784
- protected async settleSave(uri: string, cancelToken?: CancellationToken): Promise<void> {
900
+ async settleLanguageClient(uri: string, cancelToken?: CancellationToken): Promise<void> {
785
901
  const canonical = this.uriPolicy.canonicalUri(uri);
786
902
  const key = UriUtils.toUri(canonical).toString();
787
- const timeout = new Promise<void>((_, reject) =>
788
- setTimeout(() => reject(new SaveSettleTimeoutError('settle timeout')), SAVE_SETTLE_TIMEOUT_MS)
789
- );
790
- try {
791
- await Promise.race([this.waitForDocumentStateCanonical(canonical, IntegrityService.SettledState, cancelToken), timeout]);
792
- const pending = this.syncChains.get(key);
793
- if (pending) {
794
- await Promise.race([pending, timeout]);
903
+ // One race over both waits, so the bound is one deadline for the pair;
904
+ // a race per wait would let the caller wait twice the bound.
905
+ let awaitedChain: Promise<void> | undefined;
906
+ const settled = (async (): Promise<void> => {
907
+ await this.waitForDocumentStateCanonical(canonical, IntegrityService.SettledState, cancelToken, { sync: true });
908
+ const chain = this.syncChains.get(key);
909
+ if (chain && this.timedOutSyncChains.has(chain)) {
910
+ this.tracer.withUri(key).debug('Language client settle not waiting again for a push the client has not answered');
911
+ return;
795
912
  }
796
- } catch (err: unknown) {
797
- if (err instanceof SaveSettleTimeoutError) {
798
- this.tracer.withUri(key).warn(`Save settle exceeded ${SAVE_SETTLE_TIMEOUT_MS}ms — returning anyway`);
913
+ awaitedChain = chain;
914
+ await chain;
915
+ })();
916
+ // The settle ends a failed wait, so it logs it, at one level whether the wait failed inside the bound or after it.
917
+ const reportFailedWait = (error: unknown, when: string): void => {
918
+ const tracer = this.tracer.withUri(key);
919
+ if (isOperationCancelled(error)) {
920
+ tracer.debug(`Language client settle cancelled ${when}`);
921
+ } else if (!this.services.workspace.LangiumDocuments.hasDocument(UriUtils.toUri(canonical))) {
922
+ tracer.warn(`Language client settle failed ${when}; the document is gone. ${describeErrorWithStack(error)}`);
799
923
  } else {
800
- const detail = err instanceof Error ? (err.stack ?? err.message) : String(err);
801
- this.tracer.withUri(key).warn(`Save settle failed before the timeout — returning anyway. ${detail}`);
924
+ tracer.error(`Language client settle failed ${when}. ${describeErrorWithStack(error)}`);
802
925
  }
926
+ };
927
+ try {
928
+ if ((await this.services.Clock.raceTimer(settled, LANGUAGE_CLIENT_SETTLE_TIMEOUT_MS)) === TIMED_OUT) {
929
+ this.tracer.withUri(key).warn(`Language client settle exceeded ${LANGUAGE_CLIENT_SETTLE_TIMEOUT_MS}ms — returning anyway`);
930
+ if (awaitedChain) {
931
+ this.timedOutSyncChains.add(awaitedChain);
932
+ }
933
+ // The race has settled, so a later failure of the wait, such as a given-up sync build, reaches no one else.
934
+ void settled.catch((error: unknown) => reportFailedWait(error, 'after the timeout'));
935
+ }
936
+ } catch (err: unknown) {
937
+ // Its own line, so the failure is not blamed on the bound.
938
+ reportFailedWait(err, 'before the timeout — returning anyway');
803
939
  }
804
940
  }
805
941
 
806
- /**
807
- * Open the document at `args.uri` on behalf of `args.clientId`.
808
- * Multi-client: each (uri, clientId) pair is tracked as one
809
- * registration; the underlying document stays open until the last
810
- * client closes it. If `args.text` is omitted the document content
811
- * is read from the `FileSystemProvider`.
812
- *
813
- * Returns a {@link Disposable} that closes the registration when
814
- * disposed — useful for `using` blocks and shutdown cleanup.
815
- *
816
- * Delegates to the framework-bound
817
- * `services.workspace.AstDocumentManager`. Adopter subclasses with
818
- * extra open-time behaviour (logging, sync-chain bootstrapping)
819
- * override on their `ModelService` subclass and call `super.open`.
820
- *
821
- * The open path does not thread cancellation: `AstDocumentManager.open`
822
- * and the filesystem read behind it take no token, so a cancelled caller
823
- * still completes the open.
824
- */
825
- async open(args: OpenModelArgs): Promise<Disposable> {
826
- return this.services.workspace.AstDocumentManager.open(args);
827
- }
828
-
829
- /**
830
- * Close the document at `args.uri` for `args.clientId`. Counterpart
831
- * to {@link open}; the underlying document stays open until every
832
- * registered client has closed.
833
- */
834
- async close(args: CloseModelArgs): Promise<void> {
835
- return this.services.workspace.AstDocumentManager.close(args);
942
+ isLanguageClientPushPending(uri: string): boolean {
943
+ const chain = this.syncChains.get(UriUtils.toUri(this.uriPolicy.canonicalUri(uri)).toString());
944
+ return chain !== undefined && !this.timedOutSyncChains.has(chain);
836
945
  }
837
946
 
838
947
  /**
@@ -843,6 +952,37 @@ export class DefaultModelService<
843
952
  return this.services.workspace.AstDocumentManager.isOpen(uri);
844
953
  }
845
954
 
955
+ openedVersion(uri: string): TextVersion | undefined {
956
+ return this.services.workspace.TextDocuments.openedVersion(uri);
957
+ }
958
+
959
+ /**
960
+ * Snapshot of `uri` as it stands RIGHT NOW — the synchronous sibling of the
961
+ * phase reads, which all wait. `undefined` when no document is registered,
962
+ * or only the builder's placeholder for one its build has not parsed yet:
963
+ * that root is no parse of any text, and its version gates no write.
964
+ *
965
+ * **This is what a writer wants, and {@link getDocument} is not.** The
966
+ * envelope's `version` is copied by value at projection time, so it cannot
967
+ * move afterwards; a version read off the live document at write time is
968
+ * whatever the server is at *now*, which is the number an optimistic gate is
969
+ * about to compare it against.
970
+ *
971
+ * Diagnostics only from a document that has reached `Validated`, and absent
972
+ * otherwise. Unlike the phase reads this one names no phase, so
973
+ * the state it finds is the only thing that can say whether the array
974
+ * describes the content being handed back or whatever an earlier build left.
975
+ * A caller that needs them unconditionally waits, via {@link validated}.
976
+ */
977
+ snapshot(uri: string): AstDocument<TAst, TDiagnostic> | undefined {
978
+ const document = this.getDocument(uri);
979
+ if (!document || this.services.workspace.ModelLedger.isPlaceholder(document.parseResult.value)) {
980
+ return undefined;
981
+ }
982
+ const envelope = this.services.workspace.AstDocumentManager.toAstDocument(document) as AstDocument<TAst, TDiagnostic>;
983
+ return document.state >= DocumentState.Validated ? envelope : this.withoutDiagnostics(envelope);
984
+ }
985
+
846
986
  /**
847
987
  * The built {@link LangiumDocument} for `uri`, looked up by canonical identity —
848
988
  * the synchronous, phase-agnostic sibling of {@link ensureDocumentState} /
@@ -851,11 +991,135 @@ export class DefaultModelService<
851
991
  * into `LangiumDocuments` directly: a symlinked / `..` / case-divergent URI
852
992
  * still resolves to the one document the build keys by its real path. Returns
853
993
  * `undefined` if no document is registered for `uri`.
994
+ *
995
+ * **Live, so do not take a base version off it.** `textDocument` is the
996
+ * store's own object rather than a copy, so `.version` read here answers for
997
+ * the moment of the READ, not the moment of the earlier content — pass it to
998
+ * a write and the server compares its current version against itself, the
999
+ * gate passes unconditionally, and a concurrent edit is overwritten with
1000
+ * nothing logged. Use {@link snapshot} for that, or a phase read.
854
1001
  */
855
1002
  getDocument(uri: string): LangiumDocument | undefined {
856
1003
  return this.services.workspace.AstDocumentManager.getDocument(uri);
857
1004
  }
858
1005
 
1006
+ // ============================================================
1007
+ // Client sessions
1008
+ // ============================================================
1009
+
1010
+ createSession<TOpenOptions extends OpenOptions = OpenOptions>(
1011
+ label?: string,
1012
+ clientId?: string,
1013
+ options: { readonly resumeToken?: string } = {}
1014
+ ): ClientSession<TAst, TDiagnostic, TTransfer, TOpenOptions> {
1015
+ const sessionLabel = label ?? 'session';
1016
+ const id = clientId ?? `${sessionLabel}#${randomUuid()}`;
1017
+ const textDocuments = this.services.workspace.TextDocuments;
1018
+ if (options.resumeToken !== undefined && this.resumeTokens.get(id) === options.resumeToken) {
1019
+ this.sessions.get(id)?.dispose('lost');
1020
+ }
1021
+ textDocuments.registerSession(id);
1022
+ this.sessionCloseListener ??= textDocuments.onDidCloseSession(event => {
1023
+ // Also reached when the store ends a session directly; disposing the
1024
+ // handle makes its later calls fail rather than write under an id
1025
+ // this service no longer treats as a session. Forgotten first: a
1026
+ // dispose listener may start a replacement under the same id.
1027
+ const ended = this.sessions.get(event.clientId);
1028
+ this.sessions.delete(event.clientId);
1029
+ this.resumeTokens.delete(event.clientId);
1030
+ ended?.dispose(event.cause);
1031
+ });
1032
+ let session: ClientSession<TAst, TDiagnostic, TTransfer, TOpenOptions>;
1033
+ try {
1034
+ // Unchecked: the session keeps whatever options its `open` is handed,
1035
+ // and the factory types it for every grammar, so the narrowed type
1036
+ // holds only for the caller that started it.
1037
+ session = this.services.model.ClientSessionFactory.create(id, sessionLabel) as ClientSession<
1038
+ TAst,
1039
+ TDiagnostic,
1040
+ TTransfer,
1041
+ TOpenOptions
1042
+ >;
1043
+ } catch (err: unknown) {
1044
+ textDocuments.closeSession(id);
1045
+ throw err;
1046
+ }
1047
+ this.sessions.set(id, session);
1048
+ if (options.resumeToken !== undefined) {
1049
+ this.resumeTokens.set(id, options.resumeToken);
1050
+ }
1051
+ return session;
1052
+ }
1053
+
1054
+ getSession(clientId: string): ClientSession<TAst, TDiagnostic, TTransfer> | undefined {
1055
+ return this.sessions.get(clientId);
1056
+ }
1057
+
1058
+ /**
1059
+ * Convert a structured-or-textual `model` payload to its textual form.
1060
+ *
1061
+ * Textual payloads (LSP / pre-serialised callers) pass through untouched.
1062
+ * Structured payloads run the per-language `UpdateRewriteService` chain
1063
+ * (transfer-model transforms; diff-aware rewrites see the previous AST root),
1064
+ * then serialise. The chain is the single transfer-model-transform seam — a
1065
+ * unary normalisation is just a rewrite that ignores `previous`, as
1066
+ * `NormalizeEmptyStringsContribution` does. The chain is empty by
1067
+ * default, so this is a no-op for adopters that register none.
1068
+ *
1069
+ * The serialised text then takes the trivia of the text it replaces, or of
1070
+ * an empty one when `uri` has none, so a created document gets the
1071
+ * preservers' defaults rather than the serializer's bare output. Under
1072
+ * {@link ModelServiceOptions.keepUnchangedText} the document's own text is
1073
+ * returned when it parses to a model that serializes to the same text.
1074
+ */
1075
+ async modelToText(uri: string, model: TTransfer | string, cancelToken?: CancellationToken): Promise<string> {
1076
+ if (typeof model === 'string') {
1077
+ return model;
1078
+ }
1079
+ const rewritten = await this.rewriteModel(uri, model, cancelToken);
1080
+ const target = UriUtils.toUri(uri);
1081
+ const trivia = this.services.ServiceRegistry?.getServices(target)?.trivia?.TriviaService;
1082
+ // Extracted BEFORE serializing, so it reads the document the write is
1083
+ // about to replace rather than whatever a concurrent build left behind.
1084
+ const existing = this.services.workspace.LangiumDocuments.getDocument(target);
1085
+ let document = existing;
1086
+ if (trivia !== undefined && document === undefined) {
1087
+ // With no text, an empty one: every preserver still runs, so a created
1088
+ // document takes the defaults a blank one gets.
1089
+ const source = (await this.textToTakeTriviaFrom(uri, target)) ?? '';
1090
+ document = this.services.workspace.LangiumDocumentFactory.fromString(source, target);
1091
+ }
1092
+ const extracted = trivia !== undefined && document !== undefined ? trivia.extract(document) : undefined;
1093
+ const withTrivia = (serialized: string): string =>
1094
+ extracted === undefined ? serialized : trivia!.apply(serialized, extracted, target);
1095
+ const text = withTrivia(await this.serialize(uri, rewritten));
1096
+ if (!this.keepUnchangedText.value || existing === undefined) {
1097
+ return text;
1098
+ }
1099
+ // The text the root was parsed from, not the store's: the store changes
1100
+ // its text in place before the next build, and a root compared against
1101
+ // newer text would keep that text for a model it does not hold.
1102
+ const parsedText = existing.parseResult.value?.$cstNode?.root.fullText;
1103
+ if (parsedText === undefined || parsedText === text) {
1104
+ return text;
1105
+ }
1106
+ // Parsed afresh rather than the live root, which a writer may have
1107
+ // mutated in place: every write of the mutated model would then compare
1108
+ // equal and apply the text from before the mutation. Parsed into a
1109
+ // document at `target`, so the encoder's hooks see the URI the written
1110
+ // side was encoded with.
1111
+ const parsed = this.services.workspace.LangiumDocumentFactory.fromString(parsedText, target).parseResult;
1112
+ if (hasSyntaxErrors(parsed)) {
1113
+ return text;
1114
+ }
1115
+ // Through `serialize`, so an override of it applies to both sides. Not
1116
+ // rewritten: a rewrite that changes the document's model then compares
1117
+ // unequal and is written, rather than hidden behind the kept text.
1118
+ const transfer = this.services.model.TransferEncoder.toTransfer(parsed.value, 'grammar') as TTransfer;
1119
+ const current = withTrivia(await this.serialize(uri, transfer));
1120
+ return current === text ? parsedText : text;
1121
+ }
1122
+
859
1123
  // ============================================================
860
1124
  // LSP-client sync (mirror non-LSP-client changes back to Monaco)
861
1125
  // ============================================================
@@ -864,18 +1128,14 @@ export class DefaultModelService<
864
1128
  * Mirror a server-side change of `document` back to the LSP textual language
865
1129
  * client, run per document as it reaches the post-integrity settled phase.
866
1130
  * The single framework caller of
867
- * `HydraniumTextDocuments.applyEditToLanguageClient` and
868
- * `HydraniumTextDocuments.stagePendingContent`.
869
- *
870
- * Routes to one of two mechanisms by language-client registration, because
871
- * an open and a closed document answer different questions:
1131
+ * `HydraniumTextDocuments.applyEditToLanguageClient`.
872
1132
  *
873
- * - **Open in the language client** → {@link syncOpenDocument}: mirror the
874
- * settled text via a coalesced `applyEditToLanguageClient`, routed purely by
875
- * **content**.
876
- * - **Closed in the language client** → {@link stageClosedDocument}: stage the
877
- * text for the eventual first `didOpen`, gated by **provenance**
878
- * ({@link isNonLanguageClientEdit}).
1133
+ * Only a document open in the language client is mirrored, through
1134
+ * {@link syncOpenDocument}, routed purely by **content**. A document open
1135
+ * only in another client needs nothing: a language client opening it joins
1136
+ * the existing entry and is refreshed from the store. A session writes only
1137
+ * what it has open, so no session edit of a closed document waits here for
1138
+ * the language client's next open.
879
1139
  *
880
1140
  * The decision is **re-derived from the current settled state every time** (it
881
1141
  * is not a one-shot enrolment), which is what makes it self-healing: a doc
@@ -885,20 +1145,18 @@ export class DefaultModelService<
885
1145
  */
886
1146
  protected syncToLanguageClient(document: LangiumDocument): void {
887
1147
  // `document.textDocument.uri` is the server-identity (canonical) URI off the
888
- // build. Route by language-client registration (a presence question —
889
- // `isOpenInLanguageClient` canonicalizes internally, so a divergent open path
890
- // still resolves to the same record), but key the outbound sync by this
891
- // CANONICAL URI — the same key `settleSave` looks the chain up under —
892
- // so a save-settle can drain the in-flight applyEdit. The canonical→client-URI
1148
+ // build. Route by client registration (presence questions — both
1149
+ // predicates canonicalize internally, so a divergent open path still
1150
+ // resolves to the same record), but key the outbound sync by this
1151
+ // CANONICAL URI — the same key `settleLanguageClient` looks the chain up
1152
+ // under — so a settle can drain the in-flight applyEdit. The canonical→client-URI
893
1153
  // translation (a symlinked path the client opened, or a dual-open fan-out)
894
1154
  // happens at the `applyEditToLanguageClient` egress, where the text store maps
895
1155
  // the canonical key to the recorded language-client URI(s); driving the chain
896
- // in client space here would key it under a URI `settleSave` never computes, so
897
- // the drain would miss for a divergent open path.
1156
+ // in client space here would key it under a URI `settleLanguageClient`
1157
+ // never computes, so the drain would miss for a divergent open path.
898
1158
  if (this.services.workspace.TextDocuments.isOpenInLanguageClient(document.textDocument.uri)) {
899
1159
  this.syncOpenDocument(document.textDocument.uri, document.textDocument.getText());
900
- } else {
901
- this.stageClosedDocument(document);
902
1160
  }
903
1161
  }
904
1162
 
@@ -917,46 +1175,6 @@ export class DefaultModelService<
917
1175
  this.queueSync(uri, text);
918
1176
  }
919
1177
 
920
- /**
921
- * Stage the settled text of a document closed in the language client so the
922
- * eventual first `didOpen` sees this in-memory text instead of stale disk —
923
- * but only for a {@link isNonLanguageClientEdit genuine non-language-client edit}.
924
- * A document rebuilt by an internal build is skipped, leaving disk authoritative
925
- * on the next open.
926
- */
927
- protected stageClosedDocument(document: LangiumDocument): void {
928
- if (this.isNonLanguageClientEdit(document)) {
929
- this.services.workspace.TextDocuments.stagePendingContent(document.textDocument.uri, document.textDocument.getText());
930
- }
931
- }
932
-
933
- /**
934
- * Whether `document`'s settled state is a genuine edit by a client *other than
935
- * the language client* — a write a form / GLSP / integrity client actually made.
936
- * Excludes two non-edits: the **language client** itself (the LSP/Monaco text
937
- * client — it already holds its own edits, and the staging here exists to feed
938
- * it) and an **internal build** (workspace startup, a cascade relink, a
939
- * `didClose`-reload). This is the gate for {@link stageClosedDocument}: staging
940
- * an internal build would
941
- * (a) pre-stage every file on boot and (b) re-stage discarded content after
942
- * close (e.g. a disposing GLSP session's debounced submit firing after close),
943
- * which then shadows clean disk on the next open.
944
- *
945
- * The signal is "a known client other than the language client authored this
946
- * version **and** the URI was in the last build's changed set
947
- * (`isTriggeringEdit`)". A framework-internal rebuild reports no author
948
- * (`getAuthor` → `undefined`), so it fails `hasKnownAuthor` without comparing
949
- * against a sentinel. This is NOT redundant with content/registration — it
950
- * distinguishes "client edited" from "framework rebuilt", which neither the
951
- * shadow nor `isTriggeringEdit` alone can.
952
- */
953
- protected isNonLanguageClientEdit(document: LangiumDocument): boolean {
954
- const documents = this.services.workspace.AstDocumentManager;
955
- const author = documents.getAuthor(document);
956
- const hasKnownAuthor = !!author && author !== LANGUAGE_CLIENT_ID;
957
- return hasKnownAuthor && documents.isTriggeringEdit(document.textDocument.uri);
958
- }
959
-
960
1178
  /**
961
1179
  * Enqueue a sync to the language client. The pending slot per URI holds only
962
1180
  * the latest text: if a newer settle fires while the current RPC is in
@@ -1007,17 +1225,31 @@ export class DefaultModelService<
1007
1225
  const text = this.pendingSync.get(uri)!;
1008
1226
  this.pendingSync.delete(uri);
1009
1227
  try {
1010
- let result = await this.services.workspace.TextDocuments.applyEditToLanguageClient(uri, text, { label: this.editLabel() });
1011
- if (result?.applied === false && !this.pendingSync.has(uri)) {
1012
- // The push is addressed at the client's LAST DECLARED VERSION, so a
1228
+ const textDocuments = this.services.workspace.TextDocuments;
1229
+ // An answer, or a failure, ends a hang a settle timed out on, so the
1230
+ // chain's later pushes are waited for again.
1231
+ const push = async (): Promise<ApplyWorkspaceEditResult | undefined> => {
1232
+ try {
1233
+ return await textDocuments.applyEditToLanguageClient(uri, text, { label: this.editLabel() });
1234
+ } finally {
1235
+ const chain = this.syncChains.get(uri);
1236
+ if (chain) {
1237
+ this.timedOutSyncChains.delete(chain);
1238
+ }
1239
+ }
1240
+ };
1241
+ let result = await push();
1242
+ if (result?.applied === false && !this.pendingSync.has(uri) && textDocuments.get(uri)?.getText() === text) {
1243
+ // The push is addressed at the client's last known version, so a
1013
1244
  // rejection normally means the client's buffer moved while the
1014
1245
  // line-keyed diff was in flight — exactly the case where applying it
1015
1246
  // would splice the file. Dropping the push there would leave the
1016
1247
  // editor showing text the server has already superseded, with no
1017
1248
  // later settle guaranteed to correct it (a content-identical echo
1018
- // mints no rebuild). The rejection invalidated the shadow, so the
1019
- // retry is a full-range replace: position-independent, and therefore
1020
- // correct against whatever the client now holds.
1249
+ // mints no rebuild). After a rejection the retry is a full-range
1250
+ // replace: position-independent, and therefore correct against
1251
+ // whatever the client now holds. It sends nothing when the client
1252
+ // was last heard to hold the text already.
1021
1253
  //
1022
1254
  // Retried INLINE rather than re-enqueued, and exactly once. Inline
1023
1255
  // because a re-enqueue would have to out-order any settle that lands
@@ -1026,9 +1258,11 @@ export class DefaultModelService<
1026
1258
  // the workspace) must cost one extra RPC rather than spin. The
1027
1259
  // `pendingSync` check skips the retry when a newer settle has already
1028
1260
  // queued — best-effort, since a settle arriving later simply pushes
1029
- // after this and still wins.
1030
- uriLogger.warn(`Language client rejected applyEdit at its declared version — re-pushing a full replace`);
1031
- result = await this.services.workspace.TextDocuments.applyEditToLanguageClient(uri, text, { label: this.editLabel() });
1261
+ // after this and still wins. It is skipped too once the store holds
1262
+ // other text: the keystroke that made the client refuse replaced it,
1263
+ // and re-pushing would overwrite that keystroke in the editor.
1264
+ uriLogger.debug(`Re-pushing a full replace after the language client refused applyEdit`);
1265
+ result = await push();
1032
1266
  if (result?.applied === false) {
1033
1267
  uriLogger.warn(`Language client rejected the full-replace retry too — client content is stale`);
1034
1268
  }
@@ -1039,52 +1273,156 @@ export class DefaultModelService<
1039
1273
  // ordinary shutdown. Reporting it at `error` makes routine teardown
1040
1274
  // look like it needs investigating. A genuine applyEdit failure
1041
1275
  // (client refused, request malformed) still surfaces at `error`.
1042
- if (isConnectionGoneError(err)) {
1276
+ if (isClientGoneError(err)) {
1043
1277
  uriLogger.debug(`applyEdit to ${LANGUAGE_CLIENT_ID} skipped: client disconnected`);
1044
1278
  } else {
1045
- uriLogger.error(`applyEdit to ${LANGUAGE_CLIENT_ID} failed: ${err}`);
1279
+ uriLogger.error(`applyEdit to ${LANGUAGE_CLIENT_ID} failed: ${describeErrorWithStack(err)}`);
1046
1280
  }
1047
1281
  }
1048
1282
  }
1049
1283
  }
1050
1284
 
1051
1285
  // ============================================================
1052
- // Subscription pass-throughs
1286
+ // Subscriptions
1053
1287
  // ============================================================
1054
1288
 
1055
- /**
1056
- * Subscribe to AST-snapshot updates for `uri`. Fires after each
1057
- * rebuild that reaches the target phase. Delegates to the
1058
- * `HydraniumTextDocuments` — single listener registration shared with
1059
- * any direct `HydraniumTextDocuments.onUpdate` subscriber, so the same
1060
- * underlying `DocumentBuilder.onDocumentPhase` listener serves both
1061
- * call paths. `sourceClientId` is resolved from the multi-client
1062
- * author history; reason discrimination follows the manager's own
1063
- * `lastUpdate` snapshot (see `AstDocumentManager.onUpdate`).
1064
- */
1065
- onModelUpdated(uri: string, listener: (event: AstDocumentUpdatedEvent<TAst, TDiagnostic>) => void): Disposable {
1066
- return this.services.workspace.AstDocumentManager.onUpdate(uri, listener as never);
1289
+ onModelUpdated(listener: (event: ModelUpdatedEvent<TAst, TDiagnostic>) => void, filter: ModelPhaseFilter = {}): Disposable {
1290
+ const phase = filter.phase ?? DocumentState.Validated;
1291
+ let subscribers = this.updateSubscribers.get(phase);
1292
+ if (!subscribers) {
1293
+ const created = new Set<ModelUpdateSubscriber<TAst, TDiagnostic>>();
1294
+ this.updateSubscribers.set(phase, created);
1295
+ this.services.workspace.DocumentBuilder.onDocumentPhase(
1296
+ phase,
1297
+ labelPhaseListener(
1298
+ (document, cancelToken) => this.deliverUpdate(phase, created, document, cancelToken),
1299
+ 'ModelService.onModelUpdated'
1300
+ )
1301
+ );
1302
+ subscribers = created;
1303
+ }
1304
+ const subscriber = { uri: this.filterUri(filter), listener };
1305
+ subscribers.add(subscriber);
1306
+ return Disposable.create(() => subscribers.delete(subscriber));
1067
1307
  }
1068
1308
 
1069
- /**
1070
- * Subscribe to save events for `uri`. Fires on every persist through
1071
- * the multi-client text-document store — including saves originated
1072
- * by other heads (LSP editor `Ctrl+S`, the data-server `save`, etc.)
1073
- * so subscribers see one consistent stream regardless of who wrote
1074
- * the file. Delegates to the manager — single listener registration
1075
- * shared with any direct `HydraniumTextDocuments.onSave` subscriber.
1076
- */
1077
- onModelSaved(uri: string, listener: (event: AstDocumentSavedEvent<TAst, TDiagnostic>) => void): Disposable {
1078
- return this.services.workspace.AstDocumentManager.onSave(uri, listener as never);
1309
+ onModelsBuilt(listener: (event: ModelsBuiltEvent) => void, filter: Pick<ModelPhaseFilter, 'phase'> = {}): Disposable {
1310
+ const phase = filter.phase ?? DocumentState.Validated;
1311
+ return this.services.workspace.DocumentBuilder.onBuildPhase(phase, (built, cancelToken) => {
1312
+ if (cancelToken.isCancellationRequested) {
1313
+ return;
1314
+ }
1315
+ try {
1316
+ listener(Object.freeze({ uris: built.map(document => this.uriPolicy.canonicalUri(document.uri.toString())), phase }));
1317
+ } catch (err: unknown) {
1318
+ this.tracer.error(`onModelsBuilt listener threw: ${describeErrorWithStack(err)}`);
1319
+ }
1320
+ });
1321
+ }
1322
+
1323
+ onModelSaved(listener: (event: ModelSavedEvent<TAst, TDiagnostic>) => void, filter: ModelEventFilter = {}): Disposable {
1324
+ const target = this.filterUri(filter);
1325
+ return this.services.workspace.TextDocuments.onDidSave(event => {
1326
+ // LangiumDocuments keys by the canonical form, the saved event by the
1327
+ // client-facing one.
1328
+ const uri = this.uriPolicy.canonicalUri(event.document.uri);
1329
+ if (this.matches(target, uri)) {
1330
+ listener({ document: this.toAstDocument(UriUtils.toUri(uri)), sourceClientId: event.clientId });
1331
+ }
1332
+ });
1333
+ }
1334
+
1335
+ onModelDeleted(listener: (event: ModelDeletedEvent) => void, filter: ModelEventFilter = {}): Disposable {
1336
+ const target = this.filterUri(filter);
1337
+ return this.services.workspace.DocumentBuilder.onUpdate((_changed, deleted) => {
1338
+ for (const deletedUri of deleted) {
1339
+ const uri = this.uriPolicy.canonicalUri(deletedUri.toString());
1340
+ if (this.matches(target, uri)) {
1341
+ listener(Object.freeze({ uri, sourceClientId: this.services.workspace.AstDocumentManager.attributeDeletion(uri) }));
1342
+ }
1343
+ }
1344
+ });
1345
+ }
1346
+
1347
+ onDirtyChanged(listener: (event: ModelDirtyChangedEvent) => void, filter: ModelEventFilter = {}): Disposable {
1348
+ const target = this.filterUri(filter);
1349
+ return this.services.workspace.TextDocuments.onDidChangeDirty(event => {
1350
+ if (this.matches(target, event.uri)) {
1351
+ listener(event);
1352
+ }
1353
+ });
1354
+ }
1355
+
1356
+ onModelReleased(listener: (event: ModelReleasedEvent) => void, filter: ModelEventFilter = {}): Disposable {
1357
+ const target = this.filterUri(filter);
1358
+ return this.services.workspace.TextDocuments.onDidReleaseDocument(event => {
1359
+ if (this.matches(target, event.uri)) {
1360
+ listener(event);
1361
+ }
1362
+ });
1363
+ }
1364
+
1365
+ onClientClosed(listener: () => void, filter: { readonly uri: string; readonly clientId: string }): Disposable {
1366
+ const target = this.uriPolicy.canonicalUri(filter.uri);
1367
+ return this.services.workspace.TextDocuments.onDidClose(event => {
1368
+ if (event.clientId === filter.clientId && this.uriPolicy.canonicalUri(event.document.uri) === target) {
1369
+ listener();
1370
+ }
1371
+ });
1372
+ }
1373
+
1374
+ protected filterUri(filter: ModelEventFilter): CanonicalUri | undefined {
1375
+ return filter.uri === undefined ? undefined : this.uriPolicy.canonicalUri(filter.uri);
1376
+ }
1377
+
1378
+ protected matches(target: CanonicalUri | undefined, uri: CanonicalUri): boolean {
1379
+ return target === undefined || target === uri;
1079
1380
  }
1080
1381
 
1081
1382
  /**
1082
- * Subscribe to the `(uri, clientId)` close event. Delegates to the
1083
- * manager so the listener registry is shared with any direct
1084
- * `HydraniumTextDocuments.onClientClosed` subscriber.
1383
+ * Hand every subscriber of `phase` for `document` one event, built once, so
1384
+ * all of them see the same attribution. Built inside the build's listener
1385
+ * and handed out without an await: after one, another build can have reset
1386
+ * the document.
1085
1387
  */
1086
- onClientClosed(uri: string, clientId: string, listener: () => void): Disposable {
1087
- return this.services.workspace.AstDocumentManager.onClientClosed(uri, clientId, listener);
1388
+ protected deliverUpdate(
1389
+ phase: DocumentState,
1390
+ subscribers: ReadonlySet<ModelUpdateSubscriber<TAst, TDiagnostic>>,
1391
+ document: LangiumDocument,
1392
+ cancelToken: CancellationToken
1393
+ ): void {
1394
+ if (cancelToken.isCancellationRequested || subscribers.size === 0) {
1395
+ return;
1396
+ }
1397
+ const uri = this.uriPolicy.canonicalUri(document.uri.toString());
1398
+ const matching = [...subscribers].filter(subscriber => this.matches(subscriber.uri, uri));
1399
+ if (matching.length === 0) {
1400
+ return;
1401
+ }
1402
+ const manager = this.services.workspace.AstDocumentManager;
1403
+ const envelope = manager.toAstDocument(document) as AstDocument<TAst, TDiagnostic>;
1404
+ const event: ModelUpdatedEvent<TAst, TDiagnostic> = Object.freeze({
1405
+ // Copied: a validation run without a reset, of further categories,
1406
+ // appends to the live array.
1407
+ document:
1408
+ phase >= DocumentState.Validated
1409
+ ? { ...envelope, ...(envelope.diagnostics && { diagnostics: [...envelope.diagnostics] }) }
1410
+ : (this.withoutDiagnostics(envelope) as AstDocument<TAst, TDiagnostic>),
1411
+ ...manager.attributeUpdate(document),
1412
+ phase
1413
+ });
1414
+ for (const { listener } of matching) {
1415
+ // A write queued by an earlier listener cancels this build. Thrown,
1416
+ // so the builder leaves the version undelivered for those skipped.
1417
+ if (cancelToken.isCancellationRequested) {
1418
+ throw OperationCancelled;
1419
+ }
1420
+ try {
1421
+ listener(event);
1422
+ } catch (err: unknown) {
1423
+ this.tracer.with(uri).error(`onModelUpdated listener threw: ${describeErrorWithStack(err)}`);
1424
+ }
1425
+ }
1088
1426
  }
1089
1427
 
1090
1428
  // ============================================================
@@ -1102,13 +1440,13 @@ export class DefaultModelService<
1102
1440
  * Adopters whose serializer call shape differs (custom service
1103
1441
  * names, generator-driven YAML pretty printers, etc.) override this
1104
1442
  * method. Routes through `Serializer.serializeTransfer` because
1105
- * `ModelService.update` / `ModelService.save` always receive a
1443
+ * a session's `update` / `save` always receive a
1106
1444
  * transfer-model shape (cross-references as plain strings) from
1107
1445
  * adopter callers — the AST-shape entry point is `serializeAst`.
1108
1446
  *
1109
1447
  * Returns {@link MaybePromise} so adopter `Serializer` overrides can be
1110
1448
  * async (remote schema lookup, external canonical-value resolution); the
1111
- * single caller ({@link modelToText} → {@link update}) is already `async`,
1449
+ * single caller ({@link modelToText}) is already `async`,
1112
1450
  * so a naive `await` covers both branches without extra ceremony.
1113
1451
  */
1114
1452
  protected serialize(uri: string, root: TTransfer): MaybePromise<string> {
@@ -1121,22 +1459,15 @@ export class DefaultModelService<
1121
1459
  // ============================================================
1122
1460
 
1123
1461
  /**
1124
- * Convert a structured-or-textual `model` payload to its textual form.
1125
- *
1126
- * Textual payloads (LSP / pre-serialised callers) pass through untouched.
1127
- * Structured payloads run the per-language `UpdateRewriteService` chain
1128
- * (transfer-model transforms; diff-aware rewrites see the previous AST root),
1129
- * then serialise. The chain is the single transfer-model-transform seam — a
1130
- * unary normalisation is just a rewrite that ignores `previous`, as
1131
- * `NormalizeEmptyStringsContribution` does. The chain is empty by
1132
- * default, so this is a no-op for adopters that register none.
1462
+ * The text a write into a document not yet built should take its trivia
1463
+ * from: the store's, which a write always has, since it writes only a
1464
+ * document its client has open. `undefined` when the store holds no text
1465
+ * for `uri`: a document not yet created, or a file on disk that the
1466
+ * workspace has not read and no client has open. The preservers then run
1467
+ * over empty text, as for a created document; no answer skips them.
1133
1468
  */
1134
- protected async modelToText(uri: string, model: TTransfer | string, cancelToken?: CancellationToken): Promise<string> {
1135
- if (typeof model === 'string') {
1136
- return model;
1137
- }
1138
- const rewritten = await this.rewriteModel(uri, model, cancelToken);
1139
- return this.serialize(uri, rewritten);
1469
+ protected async textToTakeTriviaFrom(uri: string, _target: URI): Promise<string | undefined> {
1470
+ return this.services.workspace.TextDocuments.get(uri)?.getText();
1140
1471
  }
1141
1472
 
1142
1473
  /**
@@ -1160,15 +1491,37 @@ export class DefaultModelService<
1160
1491
 
1161
1492
  /**
1162
1493
  * Build an {@link AstDocument} envelope from the current
1163
- * {@link LangiumDocument} state via the shared {@link AstDocument.from}
1164
- * projection. Returns an empty envelope (built via
1494
+ * {@link LangiumDocument} state via `AstDocumentManager.toAstDocument`,
1495
+ * the projection events use too. Returns an empty envelope (built via
1165
1496
  * {@link AstDocument.create}) when the document is absent from the
1166
- * registry — adopters that prefer to throw override on their subclass.
1497
+ * registry — adopters that prefer to throw override on their subclass. Its
1498
+ * version is {@link UNRECORDED_VERSION}, so a write based on it conflicts.
1167
1499
  */
1168
1500
  protected toAstDocument(uri: URI): AstDocument<TAst, TDiagnostic> {
1169
1501
  const document = this.services.workspace.LangiumDocuments.getDocument(uri);
1170
1502
  return document
1171
- ? AstDocument.from<TAst, TDiagnostic>(document)
1172
- : AstDocument.create<TAst, TDiagnostic>(uri.toString(), 0, undefined as unknown as TAst, []);
1503
+ ? (this.services.workspace.AstDocumentManager.toAstDocument(document) as AstDocument<TAst, TDiagnostic>)
1504
+ : AstDocument.create<TAst, TDiagnostic>(uri.toString(), UNRECORDED_VERSION, undefined as unknown as TAst);
1505
+ }
1506
+
1507
+ /**
1508
+ * The same envelope with no diagnostics, for a read that names a phase below
1509
+ * `Validated`. Absent rather than `[]`, which says the document was validated
1510
+ * and found clean.
1511
+ *
1512
+ * Langium fills `LangiumDocument.diagnostics` from inside `validateDocument`
1513
+ * and from nowhere else, so below that phase the array holds whatever an
1514
+ * EARLIER build left — a verdict about text the document may no longer have.
1515
+ * The wait underneath resolves at or above the phase asked for, so a document
1516
+ * something else carried past `Validated` would otherwise hand a full array
1517
+ * back from `parsed()`.
1518
+ *
1519
+ * A copy rather than a clear: the envelope is freshly built here, but
1520
+ * {@link toAstDocument} is overridable and an adopter's version may return
1521
+ * one it also keeps.
1522
+ */
1523
+ protected withoutDiagnostics(document: AstDocument<TAst, TDiagnostic>): AstDocument<TAst, never> {
1524
+ const { diagnostics: _diagnostics, ...rest } = document;
1525
+ return rest;
1173
1526
  }
1174
1527
  }