@hydranium/core 1.0.0-next.28 → 1.0.0-next.281

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