@hydranium/core 1.0.0-next.14 → 1.0.0-next.148

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 (489) hide show
  1. package/README.md +5 -1
  2. package/lib/documents/ast-document-manager.d.ts +187 -27
  3. package/lib/documents/ast-document-manager.d.ts.map +1 -1
  4. package/lib/documents/ast-document-manager.js +235 -38
  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 +138 -0
  15. package/lib/documents/client-session-registry.d.ts.map +1 -0
  16. package/lib/documents/client-session-registry.js +187 -0
  17. package/lib/documents/client-session-registry.js.map +1 -0
  18. package/lib/documents/file-system-task-queue.d.ts +49 -0
  19. package/lib/documents/file-system-task-queue.d.ts.map +1 -0
  20. package/lib/documents/file-system-task-queue.js +34 -0
  21. package/lib/documents/file-system-task-queue.js.map +1 -0
  22. package/lib/documents/hydranium-text-documents.d.ts +386 -57
  23. package/lib/documents/hydranium-text-documents.d.ts.map +1 -1
  24. package/lib/documents/hydranium-text-documents.js +700 -126
  25. package/lib/documents/hydranium-text-documents.js.map +1 -1
  26. package/lib/documents/index.d.ts +3 -0
  27. package/lib/documents/index.d.ts.map +1 -1
  28. package/lib/documents/index.js +3 -0
  29. package/lib/documents/index.js.map +1 -1
  30. package/lib/documents/language-client-text-shadow.d.ts +41 -9
  31. package/lib/documents/language-client-text-shadow.d.ts.map +1 -1
  32. package/lib/documents/language-client-text-shadow.js +56 -11
  33. package/lib/documents/language-client-text-shadow.js.map +1 -1
  34. package/lib/documents/self-save-registry.d.ts +37 -6
  35. package/lib/documents/self-save-registry.d.ts.map +1 -1
  36. package/lib/documents/self-save-registry.js +28 -15
  37. package/lib/documents/self-save-registry.js.map +1 -1
  38. package/lib/index.d.ts +3 -0
  39. package/lib/index.d.ts.map +1 -1
  40. package/lib/index.js +6 -0
  41. package/lib/index.js.map +1 -1
  42. package/lib/langium/ast-extension/ast-node-builder.d.ts +32 -9
  43. package/lib/langium/ast-extension/ast-node-builder.d.ts.map +1 -1
  44. package/lib/langium/ast-extension/ast-node-builder.js +60 -22
  45. package/lib/langium/ast-extension/ast-node-builder.js.map +1 -1
  46. package/lib/langium/bootstrap.d.ts.map +1 -1
  47. package/lib/langium/bootstrap.js +16 -9
  48. package/lib/langium/bootstrap.js.map +1 -1
  49. package/lib/langium/config/configuration-provider.d.ts +81 -0
  50. package/lib/langium/config/configuration-provider.d.ts.map +1 -0
  51. package/lib/langium/config/configuration-provider.js +112 -0
  52. package/lib/langium/config/configuration-provider.js.map +1 -0
  53. package/lib/langium/config/index.d.ts +1 -0
  54. package/lib/langium/config/index.d.ts.map +1 -1
  55. package/lib/langium/config/index.js +1 -0
  56. package/lib/langium/config/index.js.map +1 -1
  57. package/lib/langium/diagnostics/lsp-logger.d.ts +17 -0
  58. package/lib/langium/diagnostics/lsp-logger.d.ts.map +1 -1
  59. package/lib/langium/diagnostics/lsp-logger.js +40 -6
  60. package/lib/langium/diagnostics/lsp-logger.js.map +1 -1
  61. package/lib/langium/document-builder/build-pipeline-integration.d.ts +21 -1
  62. package/lib/langium/document-builder/build-pipeline-integration.d.ts.map +1 -1
  63. package/lib/langium/document-builder/build-pipeline-integration.js +32 -5
  64. package/lib/langium/document-builder/build-pipeline-integration.js.map +1 -1
  65. package/lib/langium/document-builder/build-session.d.ts +93 -0
  66. package/lib/langium/document-builder/build-session.d.ts.map +1 -0
  67. package/lib/langium/document-builder/build-session.js +72 -0
  68. package/lib/langium/document-builder/build-session.js.map +1 -0
  69. package/lib/langium/document-builder/document-builder.d.ts +352 -16
  70. package/lib/langium/document-builder/document-builder.d.ts.map +1 -1
  71. package/lib/langium/document-builder/document-builder.js +616 -40
  72. package/lib/langium/document-builder/document-builder.js.map +1 -1
  73. package/lib/langium/document-builder/index.d.ts +1 -0
  74. package/lib/langium/document-builder/index.d.ts.map +1 -1
  75. package/lib/langium/document-builder/index.js +1 -0
  76. package/lib/langium/document-builder/index.js.map +1 -1
  77. package/lib/langium/integration-services.d.ts +45 -1
  78. package/lib/langium/integration-services.d.ts.map +1 -1
  79. package/lib/langium/integration-services.js +10 -5
  80. package/lib/langium/integration-services.js.map +1 -1
  81. package/lib/langium/integrity/integrity-rule.d.ts +13 -5
  82. package/lib/langium/integrity/integrity-rule.d.ts.map +1 -1
  83. package/lib/langium/integrity/integrity-rule.js.map +1 -1
  84. package/lib/langium/integrity/integrity-service.d.ts +50 -6
  85. package/lib/langium/integrity/integrity-service.d.ts.map +1 -1
  86. package/lib/langium/integrity/integrity-service.js +193 -17
  87. package/lib/langium/integrity/integrity-service.js.map +1 -1
  88. package/lib/langium/keys/containment.d.ts +64 -0
  89. package/lib/langium/keys/containment.d.ts.map +1 -0
  90. package/lib/langium/keys/containment.js +53 -0
  91. package/lib/langium/keys/containment.js.map +1 -0
  92. package/lib/langium/keys/index.d.ts +1 -0
  93. package/lib/langium/keys/index.d.ts.map +1 -1
  94. package/lib/langium/keys/index.js +1 -0
  95. package/lib/langium/keys/index.js.map +1 -1
  96. package/lib/langium/keys/name-based-key-provider.d.ts +4 -0
  97. package/lib/langium/keys/name-based-key-provider.d.ts.map +1 -1
  98. package/lib/langium/keys/name-based-key-provider.js +4 -0
  99. package/lib/langium/keys/name-based-key-provider.js.map +1 -1
  100. package/lib/langium/language-module.d.ts +27 -2
  101. package/lib/langium/language-module.d.ts.map +1 -1
  102. package/lib/langium/language-module.js +16 -2
  103. package/lib/langium/language-module.js.map +1 -1
  104. package/lib/langium/model-service/client-session.d.ts +307 -0
  105. package/lib/langium/model-service/client-session.d.ts.map +1 -0
  106. package/lib/langium/model-service/client-session.js +395 -0
  107. package/lib/langium/model-service/client-session.js.map +1 -0
  108. package/lib/langium/model-service/index.d.ts +1 -0
  109. package/lib/langium/model-service/index.d.ts.map +1 -1
  110. package/lib/langium/model-service/index.js +1 -0
  111. package/lib/langium/model-service/index.js.map +1 -1
  112. package/lib/langium/model-service/model-service.d.ts +261 -198
  113. package/lib/langium/model-service/model-service.d.ts.map +1 -1
  114. package/lib/langium/model-service/model-service.js +232 -344
  115. package/lib/langium/model-service/model-service.js.map +1 -1
  116. package/lib/langium/module.d.ts +107 -24
  117. package/lib/langium/module.d.ts.map +1 -1
  118. package/lib/langium/module.js +30 -12
  119. package/lib/langium/module.js.map +1 -1
  120. package/lib/langium/naming/name-provider.d.ts +25 -4
  121. package/lib/langium/naming/name-provider.d.ts.map +1 -1
  122. package/lib/langium/naming/name-provider.js +2 -1
  123. package/lib/langium/naming/name-provider.js.map +1 -1
  124. package/lib/langium/naming/name-separator-validation.d.ts +23 -0
  125. package/lib/langium/naming/name-separator-validation.d.ts.map +1 -1
  126. package/lib/langium/naming/name-separator-validation.js +30 -1
  127. package/lib/langium/naming/name-separator-validation.js.map +1 -1
  128. package/lib/langium/residency/cst-residency-service.d.ts +31 -11
  129. package/lib/langium/residency/cst-residency-service.d.ts.map +1 -1
  130. package/lib/langium/residency/cst-residency-service.js +13 -56
  131. package/lib/langium/residency/cst-residency-service.js.map +1 -1
  132. package/lib/langium/scope/hydranium-scope-provider.d.ts +48 -13
  133. package/lib/langium/scope/hydranium-scope-provider.d.ts.map +1 -1
  134. package/lib/langium/scope/hydranium-scope-provider.js +56 -20
  135. package/lib/langium/scope/hydranium-scope-provider.js.map +1 -1
  136. package/lib/langium/serialization/abstract-serializer.d.ts +11 -20
  137. package/lib/langium/serialization/abstract-serializer.d.ts.map +1 -1
  138. package/lib/langium/serialization/abstract-serializer.js +12 -21
  139. package/lib/langium/serialization/abstract-serializer.js.map +1 -1
  140. package/lib/langium/service-registry.d.ts +15 -1
  141. package/lib/langium/service-registry.d.ts.map +1 -1
  142. package/lib/langium/service-registry.js +16 -0
  143. package/lib/langium/service-registry.js.map +1 -1
  144. package/lib/langium/shared-services.d.ts +15 -2
  145. package/lib/langium/shared-services.d.ts.map +1 -1
  146. package/lib/langium/shared-services.js.map +1 -1
  147. package/lib/langium/transfer/transfer-encoder.d.ts +60 -17
  148. package/lib/langium/transfer/transfer-encoder.d.ts.map +1 -1
  149. package/lib/langium/transfer/transfer-encoder.js +38 -16
  150. package/lib/langium/transfer/transfer-encoder.js.map +1 -1
  151. package/lib/langium/trivia/comment-preserver.d.ts +423 -0
  152. package/lib/langium/trivia/comment-preserver.d.ts.map +1 -0
  153. package/lib/langium/trivia/comment-preserver.js +906 -0
  154. package/lib/langium/trivia/comment-preserver.js.map +1 -0
  155. package/lib/langium/trivia/document-ending-preserver.d.ts +43 -0
  156. package/lib/langium/trivia/document-ending-preserver.d.ts.map +1 -0
  157. package/lib/langium/trivia/document-ending-preserver.js +48 -0
  158. package/lib/langium/trivia/document-ending-preserver.js.map +1 -0
  159. package/lib/langium/trivia/index.d.ts +14 -0
  160. package/lib/langium/trivia/index.d.ts.map +1 -0
  161. package/lib/langium/trivia/index.js +14 -0
  162. package/lib/langium/trivia/index.js.map +1 -0
  163. package/lib/langium/trivia/trivia-contribution.d.ts +37 -0
  164. package/lib/langium/trivia/trivia-contribution.d.ts.map +1 -0
  165. package/lib/langium/trivia/trivia-contribution.js +10 -0
  166. package/lib/langium/trivia/trivia-contribution.js.map +1 -0
  167. package/lib/langium/trivia/trivia-preserver.d.ts +50 -0
  168. package/lib/langium/trivia/trivia-preserver.d.ts.map +1 -0
  169. package/lib/langium/trivia/trivia-preserver.js +10 -0
  170. package/lib/langium/trivia/trivia-preserver.js.map +1 -0
  171. package/lib/langium/trivia/trivia-service.d.ts +70 -0
  172. package/lib/langium/trivia/trivia-service.d.ts.map +1 -0
  173. package/lib/langium/trivia/trivia-service.js +56 -0
  174. package/lib/langium/trivia/trivia-service.js.map +1 -0
  175. package/lib/langium/update-rewrite/update-rewrite.d.ts +1 -1
  176. package/lib/langium/validation/document-validator.d.ts +294 -10
  177. package/lib/langium/validation/document-validator.d.ts.map +1 -1
  178. package/lib/langium/validation/document-validator.js +448 -5
  179. package/lib/langium/validation/document-validator.js.map +1 -1
  180. package/lib/langium/workspace/document-uri-policy.d.ts +3 -4
  181. package/lib/langium/workspace/document-uri-policy.d.ts.map +1 -1
  182. package/lib/langium/workspace/document-uri-policy.js +3 -4
  183. package/lib/langium/workspace/document-uri-policy.js.map +1 -1
  184. package/lib/langium/workspace/file-system-provider.d.ts +9 -1
  185. package/lib/langium/workspace/file-system-provider.d.ts.map +1 -1
  186. package/lib/langium/workspace/file-system-provider.js +40 -7
  187. package/lib/langium/workspace/file-system-provider.js.map +1 -1
  188. package/lib/langium/workspace/hydranium-langium-document-factory.d.ts +25 -0
  189. package/lib/langium/workspace/hydranium-langium-document-factory.d.ts.map +1 -1
  190. package/lib/langium/workspace/hydranium-langium-document-factory.js +25 -0
  191. package/lib/langium/workspace/hydranium-langium-document-factory.js.map +1 -1
  192. package/lib/langium/workspace/hydranium-workspace-lock.d.ts +13 -0
  193. package/lib/langium/workspace/hydranium-workspace-lock.d.ts.map +1 -1
  194. package/lib/langium/workspace/hydranium-workspace-lock.js +18 -0
  195. package/lib/langium/workspace/hydranium-workspace-lock.js.map +1 -1
  196. package/lib/langium/workspace/hydranium-workspace-manager.d.ts +21 -1
  197. package/lib/langium/workspace/hydranium-workspace-manager.d.ts.map +1 -1
  198. package/lib/langium/workspace/hydranium-workspace-manager.js +28 -0
  199. package/lib/langium/workspace/hydranium-workspace-manager.js.map +1 -1
  200. package/lib/langium/workspace/in-memory-file-system-provider.d.ts +23 -0
  201. package/lib/langium/workspace/in-memory-file-system-provider.d.ts.map +1 -1
  202. package/lib/langium/workspace/in-memory-file-system-provider.js +55 -9
  203. package/lib/langium/workspace/in-memory-file-system-provider.js.map +1 -1
  204. package/lib/langium/workspace/initialize-workspace.d.ts +31 -2
  205. package/lib/langium/workspace/initialize-workspace.d.ts.map +1 -1
  206. package/lib/langium/workspace/initialize-workspace.js +13 -5
  207. package/lib/langium/workspace/initialize-workspace.js.map +1 -1
  208. package/lib/langium/workspace/langium-documents.d.ts +79 -17
  209. package/lib/langium/workspace/langium-documents.d.ts.map +1 -1
  210. package/lib/langium/workspace/langium-documents.js +83 -28
  211. package/lib/langium/workspace/langium-documents.js.map +1 -1
  212. package/lib/langium/workspace/virtual-document.d.ts +18 -3
  213. package/lib/langium/workspace/virtual-document.d.ts.map +1 -1
  214. package/lib/langium/workspace/virtual-document.js +19 -2
  215. package/lib/langium/workspace/virtual-document.js.map +1 -1
  216. package/lib/langium/workspace/write-lock-scope.d.ts +4 -3
  217. package/lib/langium/workspace/write-lock-scope.d.ts.map +1 -1
  218. package/lib/langium/workspace/write-lock-scope.js +4 -3
  219. package/lib/langium/workspace/write-lock-scope.js.map +1 -1
  220. package/lib/locale/index.d.ts +10 -0
  221. package/lib/locale/index.d.ts.map +1 -0
  222. package/lib/locale/index.js +10 -0
  223. package/lib/locale/index.js.map +1 -0
  224. package/lib/locale/server-locale.d.ts +73 -0
  225. package/lib/locale/server-locale.d.ts.map +1 -0
  226. package/lib/locale/server-locale.js +61 -0
  227. package/lib/locale/server-locale.js.map +1 -0
  228. package/lib/lsp/completion/hydranium-completion-provider.d.ts +44 -2
  229. package/lib/lsp/completion/hydranium-completion-provider.d.ts.map +1 -1
  230. package/lib/lsp/completion/hydranium-completion-provider.js +68 -0
  231. package/lib/lsp/completion/hydranium-completion-provider.js.map +1 -1
  232. package/lib/lsp/connection-features.d.ts +23 -0
  233. package/lib/lsp/connection-features.d.ts.map +1 -0
  234. package/lib/lsp/connection-features.js +60 -0
  235. package/lib/lsp/connection-features.js.map +1 -0
  236. package/lib/lsp/diagnostics-connection.d.ts +27 -0
  237. package/lib/lsp/diagnostics-connection.d.ts.map +1 -0
  238. package/lib/lsp/diagnostics-connection.js +53 -0
  239. package/lib/lsp/diagnostics-connection.js.map +1 -0
  240. package/lib/lsp/hydranium-document-update-handler.d.ts +90 -79
  241. package/lib/lsp/hydranium-document-update-handler.d.ts.map +1 -1
  242. package/lib/lsp/hydranium-document-update-handler.js +152 -99
  243. package/lib/lsp/hydranium-document-update-handler.js.map +1 -1
  244. package/lib/lsp/index.d.ts +3 -1
  245. package/lib/lsp/index.d.ts.map +1 -1
  246. package/lib/lsp/index.js +3 -1
  247. package/lib/lsp/index.js.map +1 -1
  248. package/lib/lsp/lsp-latency.d.ts +39 -0
  249. package/lib/lsp/lsp-latency.d.ts.map +1 -0
  250. package/lib/lsp/lsp-latency.js +58 -0
  251. package/lib/lsp/lsp-latency.js.map +1 -0
  252. package/lib/lsp/semantic-token-provider.d.ts +34 -1
  253. package/lib/lsp/semantic-token-provider.d.ts.map +1 -1
  254. package/lib/lsp/semantic-token-provider.js +55 -8
  255. package/lib/lsp/semantic-token-provider.js.map +1 -1
  256. package/lib/lsp/shared-module.d.ts +4 -8
  257. package/lib/lsp/shared-module.d.ts.map +1 -1
  258. package/lib/lsp/shared-module.js.map +1 -1
  259. package/lib/lsp/start-language-server.d.ts +8 -7
  260. package/lib/lsp/start-language-server.d.ts.map +1 -1
  261. package/lib/lsp/start-language-server.js +13 -7
  262. package/lib/lsp/start-language-server.js.map +1 -1
  263. package/lib/messages/carriers.d.ts +54 -0
  264. package/lib/messages/carriers.d.ts.map +1 -0
  265. package/lib/messages/carriers.js +62 -0
  266. package/lib/messages/carriers.js.map +1 -0
  267. package/lib/messages/index.d.ts +25 -0
  268. package/lib/messages/index.d.ts.map +1 -0
  269. package/lib/messages/index.js +25 -0
  270. package/lib/messages/index.js.map +1 -0
  271. package/lib/messages/renderer.d.ts +142 -0
  272. package/lib/messages/renderer.d.ts.map +1 -0
  273. package/lib/messages/renderer.js +165 -0
  274. package/lib/messages/renderer.js.map +1 -0
  275. package/lib/node/heap-ceiling.d.ts +61 -0
  276. package/lib/node/heap-ceiling.d.ts.map +1 -0
  277. package/lib/node/heap-ceiling.js +72 -0
  278. package/lib/node/heap-ceiling.js.map +1 -0
  279. package/lib/node/index.d.ts +1 -0
  280. package/lib/node/index.d.ts.map +1 -1
  281. package/lib/node/index.js +1 -0
  282. package/lib/node/index.js.map +1 -1
  283. package/lib/node/latency-from-env.d.ts +1 -1
  284. package/lib/node/latency-from-env.js +1 -1
  285. package/lib/node/measure-memory.d.ts.map +1 -1
  286. package/lib/node/measure-memory.js +1 -0
  287. package/lib/node/measure-memory.js.map +1 -1
  288. package/lib/node/node-file-system-provider.d.ts +35 -1
  289. package/lib/node/node-file-system-provider.d.ts.map +1 -1
  290. package/lib/node/node-file-system-provider.js +140 -45
  291. package/lib/node/node-file-system-provider.js.map +1 -1
  292. package/lib/node/profile-capture.d.ts +8 -2
  293. package/lib/node/profile-capture.d.ts.map +1 -1
  294. package/lib/node/profile-capture.js.map +1 -1
  295. package/lib/node/profiling-run.d.ts +2 -2
  296. package/lib/node/profiling-run.js +1 -1
  297. package/lib/node/profiling-run.js.map +1 -1
  298. package/lib/node/rename-over-open-readers.d.ts +52 -0
  299. package/lib/node/rename-over-open-readers.d.ts.map +1 -0
  300. package/lib/node/rename-over-open-readers.js +66 -0
  301. package/lib/node/rename-over-open-readers.js.map +1 -0
  302. package/lib/node/socket-launcher.d.ts +16 -1
  303. package/lib/node/socket-launcher.d.ts.map +1 -1
  304. package/lib/node/socket-launcher.js +4 -3
  305. package/lib/node/socket-launcher.js.map +1 -1
  306. package/lib/node/stdio-launcher.d.ts +1 -1
  307. package/lib/node/stdio-launcher.d.ts.map +1 -1
  308. package/lib/node/stdio-launcher.js +1 -1
  309. package/lib/node/stdio-launcher.js.map +1 -1
  310. package/lib/testing/fake-document.d.ts +16 -4
  311. package/lib/testing/fake-document.d.ts.map +1 -1
  312. package/lib/testing/fake-document.js +18 -3
  313. package/lib/testing/fake-document.js.map +1 -1
  314. package/lib/testing/make-noop-shared-services.d.ts +14 -0
  315. package/lib/testing/make-noop-shared-services.d.ts.map +1 -1
  316. package/lib/testing/make-noop-shared-services.js +28 -2
  317. package/lib/testing/make-noop-shared-services.js.map +1 -1
  318. package/lib/testing/make-test-services.d.ts +62 -14
  319. package/lib/testing/make-test-services.d.ts.map +1 -1
  320. package/lib/testing/make-test-services.js +27 -6
  321. package/lib/testing/make-test-services.js.map +1 -1
  322. package/lib/testing/node/index.d.ts +1 -0
  323. package/lib/testing/node/index.d.ts.map +1 -1
  324. package/lib/testing/node/index.js +1 -0
  325. package/lib/testing/node/index.js.map +1 -1
  326. package/lib/testing/node/lsp-harness.d.ts.map +1 -1
  327. package/lib/testing/node/lsp-harness.js +2 -0
  328. package/lib/testing/node/lsp-harness.js.map +1 -1
  329. package/lib/testing/node/lsp-server-connection.d.ts +11 -3
  330. package/lib/testing/node/lsp-server-connection.d.ts.map +1 -1
  331. package/lib/testing/node/lsp-server-connection.js +42 -9
  332. package/lib/testing/node/lsp-server-connection.js.map +1 -1
  333. package/lib/testing/node/scratch-workspace.d.ts.map +1 -1
  334. package/lib/testing/node/scratch-workspace.js +10 -5
  335. package/lib/testing/node/scratch-workspace.js.map +1 -1
  336. package/lib/testing/node/spawned-server.d.ts +14 -0
  337. package/lib/testing/node/spawned-server.d.ts.map +1 -1
  338. package/lib/testing/node/spawned-server.js +33 -1
  339. package/lib/testing/node/spawned-server.js.map +1 -1
  340. package/lib/testing/node/unhandled-rejections.d.ts +20 -0
  341. package/lib/testing/node/unhandled-rejections.d.ts.map +1 -0
  342. package/lib/testing/node/unhandled-rejections.js +32 -0
  343. package/lib/testing/node/unhandled-rejections.js.map +1 -0
  344. package/lib/testing/playwright/flaky-network-proxy.d.ts +76 -0
  345. package/lib/testing/playwright/flaky-network-proxy.d.ts.map +1 -0
  346. package/lib/testing/playwright/flaky-network-proxy.js +164 -0
  347. package/lib/testing/playwright/flaky-network-proxy.js.map +1 -0
  348. package/lib/testing/playwright/index.d.ts +1 -0
  349. package/lib/testing/playwright/index.d.ts.map +1 -1
  350. package/lib/testing/playwright/index.js +1 -0
  351. package/lib/testing/playwright/index.js.map +1 -1
  352. package/lib/testing/playwright/server-log-capture.d.ts +14 -4
  353. package/lib/testing/playwright/server-log-capture.d.ts.map +1 -1
  354. package/lib/testing/playwright/server-log-capture.js +21 -4
  355. package/lib/testing/playwright/server-log-capture.js.map +1 -1
  356. package/lib/testing/playwright/server-log-rename-reporter.d.ts.map +1 -1
  357. package/lib/testing/playwright/server-log-rename-reporter.js +10 -1
  358. package/lib/testing/playwright/server-log-rename-reporter.js.map +1 -1
  359. package/lib/testing/run-update-pipeline.d.ts +4 -4
  360. package/lib/testing/run-update-pipeline.d.ts.map +1 -1
  361. package/lib/testing/stub-ast-document-manager.d.ts +10 -9
  362. package/lib/testing/stub-ast-document-manager.d.ts.map +1 -1
  363. package/lib/testing/stub-ast-document-manager.js +17 -9
  364. package/lib/testing/stub-ast-document-manager.js.map +1 -1
  365. package/lib/testing/stub-document-builder.d.ts +26 -11
  366. package/lib/testing/stub-document-builder.d.ts.map +1 -1
  367. package/lib/testing/stub-document-builder.js +57 -4
  368. package/lib/testing/stub-document-builder.js.map +1 -1
  369. package/lib/testing/stub-hydranium-text-documents.d.ts +22 -7
  370. package/lib/testing/stub-hydranium-text-documents.d.ts.map +1 -1
  371. package/lib/testing/stub-hydranium-text-documents.js +92 -15
  372. package/lib/testing/stub-hydranium-text-documents.js.map +1 -1
  373. package/lib/testing/stub-langium-documents.d.ts +3 -2
  374. package/lib/testing/stub-langium-documents.d.ts.map +1 -1
  375. package/lib/testing/stub-langium-documents.js.map +1 -1
  376. package/lib/testing/stub-model-service.d.ts +7 -6
  377. package/lib/testing/stub-model-service.d.ts.map +1 -1
  378. package/lib/testing/stub-model-service.js +4 -4
  379. package/lib/testing/stub-model-service.js.map +1 -1
  380. package/lib/util/connection-liveness.d.ts +7 -6
  381. package/lib/util/connection-liveness.d.ts.map +1 -1
  382. package/lib/util/connection-liveness.js +35 -14
  383. package/lib/util/connection-liveness.js.map +1 -1
  384. package/package.json +17 -8
  385. package/src/documents/ast-document-manager.ts +345 -62
  386. package/src/documents/client-ids.ts +5 -22
  387. package/src/documents/client-session-errors.ts +24 -0
  388. package/src/documents/client-session-registry.ts +240 -0
  389. package/src/documents/file-system-task-queue.ts +68 -0
  390. package/src/documents/hydranium-text-documents.ts +856 -154
  391. package/src/documents/index.ts +3 -0
  392. package/src/documents/language-client-text-shadow.ts +59 -11
  393. package/src/documents/self-save-registry.ts +52 -13
  394. package/src/index.ts +6 -0
  395. package/src/langium/ast-extension/ast-node-builder.ts +66 -22
  396. package/src/langium/bootstrap.ts +16 -9
  397. package/src/langium/config/configuration-provider.ts +119 -0
  398. package/src/langium/config/index.ts +1 -0
  399. package/src/langium/diagnostics/lsp-logger.ts +41 -6
  400. package/src/langium/document-builder/build-pipeline-integration.ts +50 -5
  401. package/src/langium/document-builder/build-session.ts +87 -0
  402. package/src/langium/document-builder/document-builder.ts +698 -39
  403. package/src/langium/document-builder/index.ts +1 -0
  404. package/src/langium/integration-services.ts +67 -6
  405. package/src/langium/integrity/integrity-rule.ts +13 -5
  406. package/src/langium/integrity/integrity-service.ts +202 -17
  407. package/src/langium/keys/containment.ts +87 -0
  408. package/src/langium/keys/index.ts +1 -0
  409. package/src/langium/keys/name-based-key-provider.ts +4 -0
  410. package/src/langium/language-module.ts +42 -4
  411. package/src/langium/model-service/client-session.ts +606 -0
  412. package/src/langium/model-service/index.ts +1 -0
  413. package/src/langium/model-service/model-service.ts +393 -349
  414. package/src/langium/module.ts +137 -30
  415. package/src/langium/naming/name-provider.ts +27 -5
  416. package/src/langium/naming/name-separator-validation.ts +34 -5
  417. package/src/langium/residency/cst-residency-service.ts +36 -14
  418. package/src/langium/scope/hydranium-scope-provider.ts +60 -22
  419. package/src/langium/serialization/abstract-serializer.ts +13 -32
  420. package/src/langium/service-registry.ts +19 -2
  421. package/src/langium/shared-services.ts +19 -2
  422. package/src/langium/transfer/transfer-encoder.ts +85 -24
  423. package/src/langium/trivia/comment-preserver.ts +1100 -0
  424. package/src/langium/trivia/document-ending-preserver.ts +55 -0
  425. package/src/langium/trivia/index.ts +14 -0
  426. package/src/langium/trivia/trivia-contribution.ts +39 -0
  427. package/src/langium/trivia/trivia-preserver.ts +54 -0
  428. package/src/langium/trivia/trivia-service.ts +99 -0
  429. package/src/langium/update-rewrite/update-rewrite.ts +1 -1
  430. package/src/langium/validation/document-validator.ts +537 -11
  431. package/src/langium/workspace/document-uri-policy.ts +3 -4
  432. package/src/langium/workspace/file-system-provider.ts +48 -8
  433. package/src/langium/workspace/hydranium-langium-document-factory.ts +34 -0
  434. package/src/langium/workspace/hydranium-workspace-lock.ts +21 -0
  435. package/src/langium/workspace/hydranium-workspace-manager.ts +30 -1
  436. package/src/langium/workspace/in-memory-file-system-provider.ts +62 -10
  437. package/src/langium/workspace/initialize-workspace.ts +43 -5
  438. package/src/langium/workspace/langium-documents.ts +106 -33
  439. package/src/langium/workspace/virtual-document.ts +21 -3
  440. package/src/langium/workspace/write-lock-scope.ts +4 -3
  441. package/src/locale/index.ts +10 -0
  442. package/src/locale/server-locale.ts +86 -0
  443. package/src/lsp/completion/hydranium-completion-provider.ts +82 -2
  444. package/src/lsp/connection-features.ts +67 -0
  445. package/src/lsp/diagnostics-connection.ts +56 -0
  446. package/src/lsp/hydranium-document-update-handler.ts +182 -106
  447. package/src/lsp/index.ts +3 -1
  448. package/src/lsp/lsp-latency.ts +62 -0
  449. package/src/lsp/semantic-token-provider.ts +74 -7
  450. package/src/lsp/shared-module.ts +4 -8
  451. package/src/lsp/start-language-server.ts +13 -7
  452. package/src/messages/carriers.ts +78 -0
  453. package/src/messages/index.ts +36 -0
  454. package/src/messages/renderer.ts +212 -0
  455. package/src/node/heap-ceiling.ts +108 -0
  456. package/src/node/index.ts +1 -0
  457. package/src/node/latency-from-env.ts +1 -1
  458. package/src/node/measure-memory.ts +1 -0
  459. package/src/node/node-file-system-provider.ts +154 -47
  460. package/src/node/profile-capture.ts +8 -2
  461. package/src/node/profiling-run.ts +3 -3
  462. package/src/node/rename-over-open-readers.ts +78 -0
  463. package/src/node/socket-launcher.ts +19 -4
  464. package/src/node/stdio-launcher.ts +1 -2
  465. package/src/testing/fake-document.ts +24 -5
  466. package/src/testing/make-noop-shared-services.ts +50 -2
  467. package/src/testing/make-test-services.ts +103 -27
  468. package/src/testing/node/index.ts +1 -0
  469. package/src/testing/node/lsp-harness.ts +2 -0
  470. package/src/testing/node/lsp-server-connection.ts +61 -11
  471. package/src/testing/node/scratch-workspace.ts +10 -5
  472. package/src/testing/node/spawned-server.ts +35 -1
  473. package/src/testing/node/unhandled-rejections.ts +31 -0
  474. package/src/testing/playwright/flaky-network-proxy.ts +240 -0
  475. package/src/testing/playwright/index.ts +1 -0
  476. package/src/testing/playwright/server-log-capture.ts +24 -5
  477. package/src/testing/playwright/server-log-rename-reporter.ts +12 -1
  478. package/src/testing/run-update-pipeline.ts +4 -4
  479. package/src/testing/stub-ast-document-manager.ts +28 -21
  480. package/src/testing/stub-document-builder.ts +83 -17
  481. package/src/testing/stub-hydranium-text-documents.ts +127 -22
  482. package/src/testing/stub-langium-documents.ts +3 -2
  483. package/src/testing/stub-model-service.ts +9 -8
  484. package/src/util/connection-liveness.ts +37 -14
  485. package/lib/lsp/instrument-connection.d.ts +0 -36
  486. package/lib/lsp/instrument-connection.d.ts.map +0 -1
  487. package/lib/lsp/instrument-connection.js +0 -62
  488. package/lib/lsp/instrument-connection.js.map +0 -1
  489. package/src/lsp/instrument-connection.ts +0 -66
@@ -19,10 +19,14 @@
19
19
  // eslint-disable-next-line @typescript-eslint/no-restricted-imports
20
20
  import { NormalizedTextDocuments } from '@hydranium/langium/lsp';
21
21
  import { UriUtils } from '@hydranium/langium';
22
- import { OptionalVersionedTextDocumentIdentifier, TextDocumentEdit, TextDocumentSyncKind } from 'vscode-languageserver';
22
+ import { Emitter, OptionalVersionedTextDocumentIdentifier, TextDocumentContentChangeEvent as ContentChange, TextDocumentEdit, TextDocumentSyncKind } from 'vscode-languageserver';
23
23
  import { TextDocument } from 'vscode-languageserver-textdocument';
24
- import { asLanguageClientUri, DisposableCollection } from '@hydranium/protocol';
24
+ import { asLanguageClientUri, cyrb53, DisposableCollection } from '@hydranium/protocol';
25
+ import { HYDRANIUM_BUILD_REASONS } from '../langium/document-builder/document-builder.js';
26
+ import { isConnectionGoneError } from '../util/connection-liveness.js';
25
27
  import { LANGUAGE_CLIENT_ID } from './client-ids.js';
28
+ import { INTEGRITY_CLIENT_ID } from '../langium/integrity/integrity-rule.js';
29
+ import { ClientSessionRegistry } from './client-session-registry.js';
26
30
  import { isFullReplace, LanguageClientTextShadow } from './language-client-text-shadow.js';
27
31
  /**
28
32
  * The LSP spec's "version is intentionally unknown" for an
@@ -32,6 +36,12 @@ import { isFullReplace, LanguageClientTextShadow } from './language-client-text-
32
36
  * cast at each call site.
33
37
  */
34
38
  const UNKNOWN_CLIENT_VERSION = null;
39
+ /**
40
+ * The default of {@link HydraniumTextDocumentsOptions.revertGraceMs}: long
41
+ * enough for a client whose connection dropped to register again and reopen
42
+ * its documents, which a data client does as soon as it has a connection.
43
+ */
44
+ const DEFAULT_REVERT_GRACE_MS = 10_000;
35
45
  /**
36
46
  * Upper bound on {@link HydraniumTextDocuments.__pendingPushes} entries
37
47
  * per URI. Echoes normally return within milliseconds and consume their
@@ -39,6 +49,17 @@ const UNKNOWN_CLIENT_VERSION = null;
39
49
  * of leaking.
40
50
  */
41
51
  const PENDING_ECHO_CAP = 32;
52
+ /**
53
+ * Whether `err` reports that the file of `target` does not exist, as a Node
54
+ * file system and the framework's providers do: code `ENOENT`, with `target`'s
55
+ * path. A missing file of another document is a different failure.
56
+ */
57
+ function isFileNotFound(err, target) {
58
+ if (typeof err !== 'object' || err === null || !('code' in err) || err.code !== 'ENOENT') {
59
+ return false;
60
+ }
61
+ return !('path' in err) || err.path === target.fsPath;
62
+ }
42
63
  /**
43
64
  * Cheap, stable, non-cryptographic content hash (cyrb53) for the version
44
65
  * sequence's "did the content change across close/reopen?" question. Only
@@ -48,32 +69,28 @@ const PENDING_ECHO_CAP = 32;
48
69
  * `node:crypto` (this module must stay runnable in browser hosts).
49
70
  */
50
71
  function contentHash(text) {
51
- let h1 = 0xdeadbeef;
52
- let h2 = 0x41c6ce57;
53
- for (let index = 0; index < text.length; index++) {
54
- const code = text.charCodeAt(index);
55
- h1 = Math.imul(h1 ^ code, 2654435761);
56
- h2 = Math.imul(h2 ^ code, 1597334677);
57
- }
58
- h1 = Math.imul(h1 ^ (h1 >>> 16), 2246822507);
59
- h1 ^= Math.imul(h2 ^ (h2 >>> 13), 3266489909);
60
- h2 = Math.imul(h2 ^ (h2 >>> 16), 2246822507);
61
- h2 ^= Math.imul(h1 ^ (h1 >>> 13), 3266489909);
62
- return `${(4294967296 * (2097151 & h2) + (h1 >>> 0)).toString(36)}:${text.length}`;
72
+ const { high, low } = cyrb53([text]);
73
+ return `${(4294967296 * (2097151 & high) + low).toString(36)}:${text.length}`;
63
74
  }
64
75
  /**
65
76
  * Multi-client text-document tracking on top of Langium's `NormalizedTextDocuments`.
66
77
  *
67
78
  * Adds the framework features used by the integrity, model-server, and GLSP layers:
68
- * - Per-document client membership (multiple clients can attach to the same URI).
79
+ * - Per-document client membership (multiple clients can attach to the same
80
+ * URI) and the client-session table, both kept by {@link __sessions}.
69
81
  * - A SERVER-OWNED shared version sequence: per-URI, monotonic across
70
82
  * close/reopen cycles, advancing exactly when the synced content changes.
71
83
  * Client-declared version ids (Monaco's buffer numbering) feed only a
72
84
  * per-client staleness guard and never leak into the shared sequence —
73
85
  * the two are different things (an editor's edit-operation counter vs the
74
86
  * document's content-revision number), and splicing them lets versions drift
75
- * silently past `baseVersion` gate holders.
87
+ * silently past based-on gate holders.
76
88
  * - Version-author history so each edit is attributable to its originating client.
89
+ * - The revert to disk once no client has a document open, for every head
90
+ * ({@link revertToDisk}), deferred by
91
+ * {@link HydraniumTextDocumentsOptions.revertGraceMs} after a lost connection.
92
+ * - A disk baseline per open document, and whether its text differs from it
93
+ * ({@link isDirty}).
77
94
  * - Pending-content staging used by the integrity service to thread corrections
78
95
  * through `workspace/applyEdit` cycles for currently-closed documents.
79
96
  * - `didOpen` notifications arriving over the LSP connection wait on the
@@ -84,22 +101,26 @@ function contentHash(text) {
84
101
  export class HydraniumTextDocuments extends NormalizedTextDocuments {
85
102
  services;
86
103
  /**
87
- * Per-URI client-facing tracking ({@link DocumentTracking}): client
88
- * membership, version-author history, and integrity-staged pending content,
89
- * keyed by normalized URI. One record per URI so the last-client close clears
90
- * every axis atomically. The language-client diff baseline stays in
91
- * {@link __shadow} (its own abstraction); the parsed-document store stays in
92
- * the inherited `__syncedDocuments`.
104
+ * Per-URI client-facing tracking ({@link DocumentTrackingRecord}), keyed by
105
+ * canonical URI. One record per URI, so dropping it clears every axis at
106
+ * once. Which client has the document open is kept apart, in
107
+ * {@link __sessions}.
93
108
  */
94
109
  __documents = new Map();
110
+ /**
111
+ * Which client has which document open, and which client ids are registered
112
+ * sessions. Every open-state predicate on this class reads it, so an open
113
+ * recorded anywhere else is invisible to the last-close transition.
114
+ */
115
+ __sessions = new ClientSessionRegistry();
95
116
  /**
96
117
  * Per-URI shared-version continuity across close/reopen cycles
97
118
  * ({@link VersionSequence}), written at last-client close and consulted by
98
- * the next first-client open. DELIBERATELY outside {@link DocumentTracking}:
119
+ * the next first-client open. DELIBERATELY outside {@link DocumentTrackingRecord}:
99
120
  * that record is deleted on last close, while the version sequence must
100
121
  * survive it — the shared version is a server-owned, monotonic,
101
122
  * advances-iff-content-changes counter that never resets while the server
102
- * lives. That invariant is what makes an optimistic `baseVersion` gate
123
+ * lives. That invariant is what makes an optimistic based-on gate
103
124
  * sound: "version unchanged ⇔ content unchanged", with no false conflicts
104
125
  * from close/reopen version resets and no false passes from a reopened
105
126
  * sequence coincidentally landing on a stale writer's number.
@@ -111,7 +132,7 @@ export class HydraniumTextDocuments extends NormalizedTextDocuments {
111
132
  /**
112
133
  * Texts pushed to the LSP textual language client via
113
134
  * {@link applyEditToLanguageClient} whose echoes have not come back yet
114
- * ({@link PendingPush}), keyed like the shadow by language-client URI.
135
+ * ({@link PendingLanguageClientPush}), keyed like the shadow by language-client URI.
115
136
  * Outbound pushes and inbound echoes are uncorrelated on the wire; this
116
137
  * FIFO is the explicit correlation, and it is what
117
138
  * {@link classifyLanguageClientChange} reconstructs against.
@@ -156,6 +177,11 @@ export class HydraniumTextDocuments extends NormalizedTextDocuments {
156
177
  __shadow;
157
178
  tracer;
158
179
  configuration;
180
+ /** See {@link HydraniumTextDocumentsOptions.revertGraceMs}. */
181
+ revertGraceMs;
182
+ lastOpenClosedEmitter = new Emitter();
183
+ languageClientSavedEmitter = new Emitter();
184
+ dirtyChangedEmitter = new Emitter();
159
185
  constructor(services, options = {}) {
160
186
  const configuration = options.configuration ?? TextDocument;
161
187
  super(configuration);
@@ -163,6 +189,8 @@ export class HydraniumTextDocuments extends NormalizedTextDocuments {
163
189
  this.configuration = configuration;
164
190
  this.tracer = services.Tracer.for(options.logName ?? 'TextDocuments').trace('instantiated');
165
191
  this.__shadow = new LanguageClientTextShadow((uri, reason) => this.tracer.with(uri).warn(`Diff apply-verify fallback (${reason}) — using full-document replace`), this);
192
+ this.revertGraceMs = options.revertGraceMs ?? DEFAULT_REVERT_GRACE_MS;
193
+ this.onDidCloseLastOpen(event => void this.revertToDisk(event.uri));
166
194
  }
167
195
  // Re-exposed configuration factories — for framework-internal callers
168
196
  // (LanguageClientTextShadow's apply-verify probe; IntegrityService.resyncDocument)
@@ -235,7 +263,7 @@ export class HydraniumTextDocuments extends NormalizedTextDocuments {
235
263
  }));
236
264
  disposables.push(connection.onWillSaveTextDocumentWaitUntil((event, token) => this.notifyWillSaveTextDocumentWaitUntil(event, token)));
237
265
  disposables.push(connection.onDidSaveTextDocument((event) => {
238
- this.notifyDidSaveTextDocument(event);
266
+ void this.notifyLanguageClientSave(event);
239
267
  }));
240
268
  return disposables;
241
269
  }
@@ -267,18 +295,19 @@ export class HydraniumTextDocuments extends NormalizedTextDocuments {
267
295
  // Distinguish "already at this version" (common: an echo from the client that triggered
268
296
  // the update) from "incoming version older than ours" (stale race).
269
297
  const reason = lastSeen === td.version ? `already at version ${lastSeen}` : `incoming version ${td.version} older than current ${lastSeen}`;
270
- this.logUri(uri, `Ignore update by ${clientId}: ${reason}`, 'debug');
298
+ this.logUri(uri, `Ignore update by ${this.formatClientId(clientId)}: ${reason}`, 'debug');
271
299
  return;
272
300
  }
273
301
  record.clientVersions.set(clientId, td.version);
274
- // A language-client change arriving while one of our own pushes is in
275
- // flight is keyed to the buffer the client held BEFORE that push, NOT
276
- // to the synced text — the authored write already advanced the latter.
302
+ // A language-client change is keyed to the buffer that client holds,
303
+ // which is the synced text only while the two agree — an authored
304
+ // write advances the synced text without the client knowing, and a
305
+ // push in flight moves the client without the store knowing.
277
306
  // Resolve which it is, and against what, before touching anything.
278
- const inFlight = clientId === LANGUAGE_CLIENT_ID
307
+ const origin = clientId === LANGUAGE_CLIENT_ID
279
308
  ? this.classifyLanguageClientChange(this.toLanguageClientUri(td.uri), document, changes)
280
309
  : undefined;
281
- if (inFlight?.kind === 'echo') {
310
+ if (origin?.kind === 'echo') {
282
311
  // The client is reporting a text we pushed it, so the synced
283
312
  // document is ALREADY there and the changes must not be applied a
284
313
  // second time. Nothing is minted and no rebuild fires. The
@@ -290,18 +319,22 @@ export class HydraniumTextDocuments extends NormalizedTextDocuments {
290
319
  this.logUri(uri, `Skip rebuild: echo of a server-authored push (client version ${td.version})`, 'debug');
291
320
  return;
292
321
  }
322
+ if (origin?.kind === 'unreconstructable') {
323
+ this.tracer.with(uri).warn(`Drop change: no known client buffer for its ranges (client version ${td.version})`);
324
+ return;
325
+ }
293
326
  // The SHARED version advances iff the content actually changes — the
294
- // invariant optimistic `baseVersion` gates rely on. The new text is
327
+ // invariant optimistic based-on gates rely on. The new text is
295
328
  // only known after applying the (possibly incremental) changes, so
296
329
  // apply at a tentative +1 and roll the version back on an identical
297
330
  // result (an empty-changes update only re-stamps the version).
298
331
  //
299
- // A divergent in-flight change is applied as its RECONSTRUCTED text
300
- // rather than as its own ranges: the ranges address the pre-push
301
- // baseline, so applying them here would splice the wrong lines.
332
+ // A divergent change is applied as its RECONSTRUCTED text rather than
333
+ // as its own ranges: those ranges address the client's own buffer, so
334
+ // applying them here would splice the wrong lines.
302
335
  const previousText = document.getText();
303
336
  const sharedVersion = document.version;
304
- document = this.configuration.update(document, inFlight === undefined ? changes : [{ text: inFlight.text }], sharedVersion + 1);
337
+ document = this.configuration.update(document, origin === undefined ? changes : [{ text: origin.text }], sharedVersion + 1);
305
338
  const changed = document.getText() !== previousText;
306
339
  if (!changed) {
307
340
  document = this.configuration.update(document, [], sharedVersion);
@@ -309,6 +342,7 @@ export class HydraniumTextDocuments extends NormalizedTextDocuments {
309
342
  this.__syncedDocuments.set(uri, document);
310
343
  if (changed) {
311
344
  this.setAuthor(uri, document.version, clientId);
345
+ this.refreshDirty(uri);
312
346
  }
313
347
  if (clientId === LANGUAGE_CLIENT_ID) {
314
348
  // Monaco just told us about its new content; record it so the next outbound
@@ -325,7 +359,7 @@ export class HydraniumTextDocuments extends NormalizedTextDocuments {
325
359
  return;
326
360
  }
327
361
  }
328
- this.log(document.uri, `Update to version ${document.version} by ${clientId}${changed ? '' : ' (content unchanged)'}`);
362
+ this.log(document.uri, `Update to version ${document.version} by ${this.formatClientId(clientId)}${changed ? '' : ' (content unchanged)'}`);
329
363
  this.__onDidChangeContent.fire(Object.freeze({ document, clientId }));
330
364
  }
331
365
  }
@@ -341,7 +375,7 @@ export class HydraniumTextDocuments extends NormalizedTextDocuments {
341
375
  * A content-identical write still fires the change event (rebuild): the
342
376
  * authored write's server-side rebuild is correctness-bearing, it just
343
377
  * mints no new version — nothing observable changed, so watchers'
344
- * `baseVersion` pointers stay valid.
378
+ * based-on versions stay valid.
345
379
  *
346
380
  * Returns the resulting shared version. Throws when the document is not
347
381
  * open — callers (`AstDocumentManager.update`) open first.
@@ -357,52 +391,186 @@ export class HydraniumTextDocuments extends NormalizedTextDocuments {
357
391
  document = this.configuration.update(document, [{ text }], document.version + 1);
358
392
  this.__syncedDocuments.set(key, document);
359
393
  this.setAuthor(key, document.version, clientId);
394
+ this.refreshDirty(key);
360
395
  }
361
- this.log(document.uri, `Update to version ${document.version} by ${clientId}${changed ? '' : ' (content unchanged)'}`);
396
+ this.log(document.uri, `Update to version ${document.version} by ${this.formatClientId(clientId)}${changed ? '' : ' (content unchanged)'}`);
362
397
  this.__onDidChangeContent.fire(Object.freeze({ document, clientId }));
363
398
  return document.version;
364
399
  }
365
- notifyDidCloseTextDocument(event, clientId = LANGUAGE_CLIENT_ID) {
400
+ /**
401
+ * Close `clientId`'s open of the document. When it was the last open, the
402
+ * document is released and reverts to disk, at once or, for a `'lost'`
403
+ * close, after {@link HydraniumTextDocumentsOptions.revertGraceMs}.
404
+ */
405
+ notifyDidCloseTextDocument(event, clientId = LANGUAGE_CLIENT_ID, cause = 'closed') {
366
406
  const uri = this.documentKey(event.textDocument.uri);
367
- if (!this.isOpenInClient(uri, clientId)) {
407
+ if (!this.__sessions.removeOpen(uri, clientId)) {
368
408
  return;
369
409
  }
370
- const closingRecord = this.__documents.get(uri);
371
- closingRecord?.clients.delete(clientId);
372
- closingRecord?.clientVersions.delete(clientId);
410
+ const record = this.__documents.get(uri);
411
+ record?.clientVersions.delete(clientId);
412
+ if (record && cause === 'lost') {
413
+ (record.lostClients ??= new Map()).set(clientId, this.services.Clock.stopwatch());
414
+ }
373
415
  const syncedDocument = this.__syncedDocuments.get(uri);
374
416
  if (syncedDocument !== undefined) {
375
- this.log(syncedDocument.uri, `Closed synced document: ${syncedDocument.version} by ${clientId}`);
417
+ this.log(syncedDocument.uri, `Closed synced document: ${syncedDocument.version} by ${this.formatClientId(clientId)}`);
376
418
  this.__onDidClose.fire(Object.freeze({ document: syncedDocument, clientId }));
377
419
  if (clientId === LANGUAGE_CLIENT_ID) {
378
420
  // Monaco closed the document; drop the URI it held and the shadow
379
421
  // baselined under it. (If this was the last URI/client the whole record
380
- // is deleted below, clearing the set anyway.)
422
+ // is deleted on release, clearing the set anyway.)
381
423
  const droppedUri = this.toLanguageClientUri(event.textDocument.uri);
382
424
  this.__documents.get(uri)?.languageClientUris?.delete(droppedUri);
383
425
  this.__shadow.invalidate(droppedUri);
384
426
  this.__pendingPushes.delete(droppedUri);
385
427
  }
386
- if (!this.__documents.get(uri)?.clients.size) {
387
- // Last client closed the document; delete sync state. The downstream
388
- // "rebuild from disk for file URIs / drop from index for ephemeral
389
- // URIs" decision lives in `HydraniumDocumentUpdateHandler.didCloseDocument`,
390
- // which subscribes to `onDidClose` and consults `isOpenInAnyClient`
391
- // to detect the last-close transition.
392
- this.log(syncedDocument.uri, `Remove synced document: ${syncedDocument.version} (no client left)`);
393
- // Persist where the shared version sequence left off (version +
394
- // content hash) so the next open CONTINUES the sequence instead of
395
- // restarting at the reopening client's declared id. Hashed once
396
- // here at close, not on every change.
397
- this.__versionSequences.set(uri, {
398
- version: syncedDocument.version,
399
- contentHash: contentHash(syncedDocument.getText())
400
- });
401
- this.__syncedDocuments.delete(uri);
402
- // One delete clears every per-URI axis (version history + any staged
403
- // pending content) so a future open with the same URI starts fresh.
404
- this.__documents.delete(uri);
428
+ if (!this.__sessions.isOpen(uri)) {
429
+ if (cause === 'lost' && this.revertGraceMs > 0) {
430
+ this.deferRelease(uri);
431
+ }
432
+ else {
433
+ this.releaseDocument(uri);
434
+ }
435
+ }
436
+ }
437
+ }
438
+ /**
439
+ * Keep the document, text and all, for the revert grace, then release it.
440
+ * The document stays in the store meanwhile, so a lost client that opens it
441
+ * again within its own grace attaches to it and finds its unsaved text
442
+ * rather than reading disk; see {@link resolvePendingRevert} for any other
443
+ * open.
444
+ */
445
+ deferRelease(uri) {
446
+ this.log(uri, `No client left; revert deferred for ${this.revertGraceMs} ms (connection lost)`);
447
+ const timer = this.services.Clock.setTimer(() => {
448
+ this.__sessions.cancelRevert(uri);
449
+ if (!this.__sessions.isOpen(uri)) {
450
+ this.releaseDocument(uri);
405
451
  }
452
+ }, this.revertGraceMs);
453
+ this.__sessions.deferRevert(uri, timer);
454
+ }
455
+ /**
456
+ * Resolve the pending revert of `uri` for an open by `clientId`. An open by a
457
+ * client lost from the document within its grace cancels the revert, and
458
+ * the client finds its unsaved text. Any other open releases the document
459
+ * first, so it opens as a first open does: cancelling for every open hands
460
+ * a lost client's unsaved text to whoever opens next, a reloaded page or an
461
+ * editor, with nothing marking it unsaved.
462
+ */
463
+ resolvePendingRevert(uri, clientId) {
464
+ const record = this.__documents.get(uri);
465
+ if (record) {
466
+ this.pruneLostClients(record);
467
+ }
468
+ const returning = record?.lostClients?.delete(clientId) ?? false;
469
+ if (!this.__sessions.isRevertPending(uri)) {
470
+ return;
471
+ }
472
+ this.__sessions.cancelRevert(uri);
473
+ if (!returning) {
474
+ this.releaseDocument(uri);
475
+ }
476
+ }
477
+ /** Drop the entries of {@link DocumentTrackingRecord.lostClients} whose grace has run out. */
478
+ pruneLostClients(record) {
479
+ for (const [clientId, sinceLoss] of record.lostClients ?? []) {
480
+ if (sinceLoss.elapsedMs >= this.revertGraceMs) {
481
+ record.lostClients?.delete(clientId);
482
+ }
483
+ }
484
+ }
485
+ /**
486
+ * Drop the document no client has open any more, then announce it on
487
+ * {@link onDidCloseLastOpen}, which is what reverts it to disk.
488
+ */
489
+ releaseDocument(uri) {
490
+ const syncedDocument = this.__syncedDocuments.get(uri);
491
+ if (syncedDocument === undefined) {
492
+ return;
493
+ }
494
+ this.log(syncedDocument.uri, `Remove synced document: ${syncedDocument.version} (no client left)`);
495
+ // Persist where the shared version sequence left off (version +
496
+ // content hash) so the next open CONTINUES the sequence instead of
497
+ // restarting at the reopening client's declared id. Hashed once
498
+ // here at release, not on every change.
499
+ this.__versionSequences.set(uri, {
500
+ version: syncedDocument.version,
501
+ contentHash: contentHash(syncedDocument.getText())
502
+ });
503
+ const wasDirty = this.__documents.get(uri)?.dirty === true;
504
+ this.__syncedDocuments.delete(uri);
505
+ // One delete clears every per-URI axis (version history + any staged
506
+ // pending content) so a future open with the same URI starts fresh.
507
+ this.__documents.delete(uri);
508
+ if (wasDirty) {
509
+ this.dirtyChangedEmitter.fire(Object.freeze({ uri, dirty: false }));
510
+ }
511
+ this.lastOpenClosedEmitter.fire(Object.freeze({ uri }));
512
+ }
513
+ /**
514
+ * Rebuild a released document from the file system provider, so the build
515
+ * stops carrying the unsaved text of its last client.
516
+ *
517
+ * The provider decides, for every scheme, by `exists`: a document it can
518
+ * serve is rebuilt from its text, and any other — an editor's `untitled:`
519
+ * buffer, a file never saved, or one deleted meanwhile — is removed
520
+ * from the workspace. A `virtual:` document survives, since the framework's
521
+ * providers serve it from the index; an edited one therefore keeps its last
522
+ * client's text, and keeping it read-only is the client's job.
523
+ *
524
+ * The answer is read in the document's disk queue, so the rebuild follows
525
+ * any save still queued rather than reverting past it; a file that goes
526
+ * after that read is removed when its rebuild finds none.
527
+ *
528
+ * Whether to revert at all is decided inside the write lock, as its holder:
529
+ * decided before waiting for the lock, a client that opens or re-creates the
530
+ * document meanwhile would have its text rebuilt over, or the document
531
+ * removed. A document some client has open again, or that waits out a new
532
+ * grace, is left to that client.
533
+ */
534
+ async revertToDisk(uri) {
535
+ const workspace = this.services.workspace;
536
+ const target = UriUtils.toUri(uri);
537
+ const reopened = () => this.isOpenInAnyClient(uri) || this.__syncedDocuments.has(uri);
538
+ try {
539
+ // Read before the lock: every build and read waits while the lock is
540
+ // held, and this read waits on the file's save I/O.
541
+ const onDisk = await workspace.FileSystemTaskQueue.enqueue(uri, () => workspace.FileSystemProvider.exists(target));
542
+ await workspace.WorkspaceManager?.ready;
543
+ await workspace.WorkspaceLock.write(async (token) => {
544
+ if (reopened()) {
545
+ return;
546
+ }
547
+ workspace.DocumentBuilder.markNextReason(HYDRANIUM_BUILD_REASONS.didClose);
548
+ try {
549
+ await (onDisk
550
+ ? workspace.DocumentBuilder.update([target], [], token)
551
+ : workspace.DocumentBuilder.update([], [target], token));
552
+ }
553
+ catch (err) {
554
+ if (!onDisk || !isFileNotFound(err, target)) {
555
+ throw err;
556
+ }
557
+ // The file went after its existence was read.
558
+ this.tracer.with(uri).debug('Revert found no file; removing the document instead');
559
+ workspace.DocumentBuilder.markNextReason(HYDRANIUM_BUILD_REASONS.didClose);
560
+ await workspace.DocumentBuilder.update([], [target], token);
561
+ }
562
+ });
563
+ }
564
+ catch (err) {
565
+ // A revert that finishes after the LSP peer went away fails its
566
+ // diagnostics publish, and one that runs after its workspace was torn
567
+ // down finds no file: teardown races, not failed reverts.
568
+ if (isConnectionGoneError(err) || isFileNotFound(err, target)) {
569
+ this.tracer.with(uri).debug(`Revert on last close skipped: ${err instanceof Error ? err.message : String(err)}`);
570
+ return;
571
+ }
572
+ const detail = err instanceof Error ? (err.stack ?? err.message) : String(err);
573
+ this.tracer.with(uri).error(`Revert on last close dropped. ${detail}`);
406
574
  }
407
575
  }
408
576
  notifyWillSaveTextDocument(event) {
@@ -420,39 +588,99 @@ export class HydraniumTextDocuments extends NormalizedTextDocuments {
420
588
  return [];
421
589
  }
422
590
  }
591
+ /**
592
+ * Handle a save the language client reports: fire
593
+ * {@link onDidSaveInLanguageClient}, then announce it on {@link onDidSave}
594
+ * only once the file read back from disk holds the store's current text.
595
+ */
596
+ async notifyLanguageClientSave(event) {
597
+ const syncedDocument = this.__syncedDocuments.get(this.documentKey(event.textDocument.uri));
598
+ if (syncedDocument === undefined) {
599
+ return;
600
+ }
601
+ const uri = syncedDocument.uri;
602
+ this.languageClientSavedEmitter.fire(Object.freeze({ uri }));
603
+ // `onDidSave` tells its listeners that the shared document is on disk.
604
+ // The editor wrote its own buffer, which lags the store while another
605
+ // client's edit is still on its way to it, so only the file says
606
+ // whether that holds. Read it rather than trust the editor: `didSave`
607
+ // carries text only for a client that honours `includeText`, and asking
608
+ // for it means rewriting Langium's initialize answer, which advertises
609
+ // `save` as a Boolean. The read goes through the disk queue and waits on
610
+ // nothing but the provider, so it follows a server save queued
611
+ // meanwhile. A file changed again between the editor's write and this
612
+ // read compares unequal, and the save goes unannounced.
613
+ let onDisk;
614
+ try {
615
+ onDisk = await this.services.workspace.FileSystemTaskQueue.enqueue(uri, () => this.services.workspace.FileSystemProvider.readFile(UriUtils.toUri(uri)));
616
+ }
617
+ catch (err) {
618
+ this.tracer
619
+ .with(uri)
620
+ .debug(`Editor save not announced: reading the file back failed. ${err instanceof Error ? err.message : String(err)}`);
621
+ return;
622
+ }
623
+ // What the file holds, not what the editor meant to write: an editor
624
+ // that saved older text leaves the document dirty.
625
+ this.updateDiskBaseline(uri, onDisk);
626
+ // An editor that saves and then closes releases the document while the
627
+ // read is under way; its save is still a save of the text it held.
628
+ const document = this.__syncedDocuments.get(this.documentKey(uri)) ?? syncedDocument;
629
+ if (onDisk !== document.getText()) {
630
+ this.tracer.with(uri).debug(`Editor save not announced: the file does not hold the text of version ${document.version}`);
631
+ return;
632
+ }
633
+ this.announceSave(document, LANGUAGE_CLIENT_ID);
634
+ }
635
+ /**
636
+ * Announce a save the server made. `event.text`, when given, is what the
637
+ * file now holds, written or found there, and becomes the disk baseline
638
+ * before the save is announced. It lags the store when an edit landed
639
+ * after the save took its text, and the document then stays dirty.
640
+ */
423
641
  notifyDidSaveTextDocument(event, clientId = LANGUAGE_CLIENT_ID) {
424
642
  const syncedDocument = this.__syncedDocuments.get(this.documentKey(event.textDocument.uri));
425
643
  if (syncedDocument !== undefined) {
426
- this.log(syncedDocument.uri, `Saved synced document: ${syncedDocument.version} by ${clientId}`);
427
- this.__onDidSave.fire(Object.freeze({ document: syncedDocument, clientId }));
644
+ if (event.text !== undefined) {
645
+ this.updateDiskBaseline(syncedDocument.uri, event.text);
646
+ }
647
+ this.announceSave(syncedDocument, clientId);
428
648
  }
429
649
  }
650
+ /** Fire {@link onDidSave} for `document`, which need not be synced any more. */
651
+ announceSave(document, clientId) {
652
+ this.log(document.uri, `Saved synced document: ${document.version} by ${this.formatClientId(clientId)}`);
653
+ this.__onDidSave.fire(Object.freeze({ document, clientId }));
654
+ }
430
655
  notifyDidOpenTextDocument(event, clientId = LANGUAGE_CLIENT_ID) {
431
656
  const td = event.textDocument;
432
657
  const uri = this.documentKey(td.uri);
658
+ this.resolvePendingRevert(uri, clientId);
433
659
  if (this.isOpenInClient(uri, clientId)) {
434
660
  // Already open for this client under this canonical identity. If this is a
435
661
  // NEW client-facing URI for the same file (a second tab reached via a
436
- // divergent path, e.g. a symlink and its real path), record it and baseline
437
- // its shadow so outbound edits reach this tab too — but do NOT re-fire
438
- // open/rebuild; the document is already live.
662
+ // divergent path, e.g. a symlink and its real path), record it so outbound
663
+ // edits reach this tab too — but do NOT re-fire open/rebuild; the document
664
+ // is already live.
439
665
  if (clientId === LANGUAGE_CLIENT_ID) {
440
666
  const clientFacing = this.toLanguageClientUri(td.uri);
441
667
  const record = this.__documents.get(uri);
442
668
  if (record && !record.languageClientUris?.has(clientFacing)) {
443
669
  (record.languageClientUris ??= new Set()).add(clientFacing);
444
- const open = this.__syncedDocuments.get(uri);
445
- if (open) {
446
- this.__shadow.set(clientFacing, open.getText());
447
- }
670
+ // This tab's own buffer, NOT the synced text: a second tab is a second
671
+ // client model, read from disk, so a server-authored write already
672
+ // applied to the first tab leaves it BEHIND the synced document. Keying
673
+ // a diff to the synced text here addresses lines this tab does not have
674
+ // and drops content it does.
675
+ this.__shadow.setOpenedText(clientFacing, td.text);
448
676
  }
449
677
  }
450
678
  return;
451
679
  }
452
680
  let document = this.__syncedDocuments.get(uri);
681
+ const existingClients = this.__sessions.clientsOf(uri);
682
+ this.__sessions.addOpen(uri, clientId);
453
683
  const record = this.trackingFor(uri);
454
- const existingClients = [...record.clients];
455
- record.clients.add(clientId);
456
684
  // Baseline the per-client staleness guard at the version id the client
457
685
  // declared for its own buffer (client-owned per LSP).
458
686
  record.clientVersions.set(clientId, td.version);
@@ -468,21 +696,37 @@ export class HydraniumTextDocuments extends NormalizedTextDocuments {
468
696
  const source = pendingText ? ', source=pending' : '';
469
697
  // The SHARED version is server-assigned: continue the persisted
470
698
  // sequence — same version when the content is unchanged since the
471
- // last close (so watchers' `baseVersion` pointers stay valid), one
699
+ // last close (so watchers' based-on versions stay valid), one
472
700
  // step when it changed (so no stale pointer can coincidentally pass
473
701
  // the optimistic gate). Only a first-ever open adopts the client's
474
702
  // declared id as the sequence seed.
475
703
  const sequence = this.__versionSequences.get(uri);
476
704
  const version = sequence === undefined ? td.version : sequence.contentHash === contentHash(text) ? sequence.version : sequence.version + 1;
477
- this.log(uri, `Open document: Version ${version} by ${clientId} [first client${source}]`);
705
+ this.log(uri, `Open document: Version ${version} by ${this.formatClientId(clientId)} [first client${source}]`);
478
706
  document = this.configuration.create(uri, td.languageId, version, text);
479
707
  this.__syncedDocuments.set(uri, document);
480
708
  this.setAuthor(uri, version, clientId);
709
+ // The opener's text, not the staged content: a session's open read
710
+ // it from the file, and an editor opened its buffer from there. An
711
+ // editor that opens a buffer it never saved is taken as clean.
712
+ record.diskBaseline = td.text;
713
+ this.refreshDirty(uri);
481
714
  if (clientId === LANGUAGE_CLIENT_ID) {
482
715
  // Baseline the shadow to what Monaco just opened so the next outbound
483
716
  // applyEditToLanguageClient diffs against the right starting point. Keyed by the
484
717
  // language-client URI (what Monaco holds), not the canonical document key.
485
- this.__shadow.set(this.toLanguageClientUri(td.uri), document.getText());
718
+ //
719
+ // The CLIENT's declared text, never the synced document: staged content
720
+ // consumed above leaves the two different, and a baseline asserting the
721
+ // client already holds the staged text suppresses the one sync that would
722
+ // deliver it. Skipped entirely when a push is already outstanding for this
723
+ // URI — an `applyEdit` to a closed file has the client open from disk and
724
+ // apply afterwards, so that shadow records what it is about to hold and
725
+ // disk text would key the next diff to a buffer nobody has.
726
+ const clientFacing = this.toLanguageClientUri(td.uri);
727
+ if (!this.__shadow.isTracked(clientFacing)) {
728
+ this.__shadow.set(clientFacing, td.text);
729
+ }
486
730
  }
487
731
  const toFire = Object.freeze({ document, clientId });
488
732
  this.__onDidOpen.fire(toFire);
@@ -490,16 +734,64 @@ export class HydraniumTextDocuments extends NormalizedTextDocuments {
490
734
  }
491
735
  else {
492
736
  // An additional client attaches to a document already open by another client.
493
- this.log(uri, `Attach client: ${clientId} joined existing document (version ${document.version}, ` +
494
- `now open in: ${[...existingClients, clientId].join(', ')})`);
737
+ this.logClientJoined(uri, clientId, document.version, existingClients);
738
+ if (clientId === LANGUAGE_CLIENT_ID) {
739
+ // Monaco's own buffer, which on this path is NOT the synced text — another
740
+ // client opened the document and may already have changed it. Recorded as
741
+ // an equality-only baseline (never a diff one, see `setOpenedText`) so the
742
+ // refresh below does not push a full replace of content Monaco already
743
+ // holds, which would dirty the file on open.
744
+ this.__shadow.setOpenedText(this.toLanguageClientUri(td.uri), td.text);
745
+ }
495
746
  this.refreshContent(uri, clientId);
496
747
  }
497
748
  }
749
+ /**
750
+ * Record `clientId` as an additional holder of a document another client
751
+ * already has open.
752
+ *
753
+ * Unlike the attach branch of {@link notifyDidOpenTextDocument} this does
754
+ * not refresh. That branch re-renders an attaching TEXTUAL view; a client
755
+ * reaching a document through a non-textual route has nothing to re-render,
756
+ * and refreshing per attach turns each into a Langium rebuild and dependent
757
+ * relink cascade.
758
+ *
759
+ * The staleness guard baselines at the SYNCED version, not a declared buffer
760
+ * version, because a client arriving this way holds no buffer of its own.
761
+ * Unifying the two routes therefore rebaselines a textual client's guard to a
762
+ * version it never declared.
763
+ *
764
+ * Returns whether a hold was added — `false` when `uri` is not open,
765
+ * `clientId` already holds it, or the document was waiting out the revert
766
+ * grace for other clients and was released instead (see
767
+ * {@link resolvePendingRevert}); the caller then opens it anew.
768
+ */
769
+ attachClient(uri, clientId) {
770
+ const key = this.documentKey(uri);
771
+ if (!this.__syncedDocuments.has(key) || this.isOpenInClient(key, clientId)) {
772
+ return false;
773
+ }
774
+ this.resolvePendingRevert(key, clientId);
775
+ const document = this.__syncedDocuments.get(key);
776
+ if (!document) {
777
+ return false;
778
+ }
779
+ const existingClients = this.__sessions.clientsOf(key);
780
+ this.__sessions.addOpen(key, clientId);
781
+ const record = this.trackingFor(key);
782
+ record.clientVersions.set(clientId, document.version);
783
+ this.logClientJoined(key, clientId, document.version, existingClients);
784
+ return true;
785
+ }
786
+ logClientJoined(uri, clientId, version, existingClients) {
787
+ this.log(uri, `Attach client: ${this.formatClientId(clientId)} joined existing document (version ${version}, ` +
788
+ `now open in: ${[...existingClients, clientId].map(id => this.formatClientId(id)).join(', ')})`);
789
+ }
498
790
  refreshContent(uri, clientId) {
499
791
  const syncedDocument = this.__syncedDocuments.get(this.documentKey(uri));
500
792
  if (syncedDocument) {
501
793
  // Trigger a (re-)build by firing a change event.
502
- const timer = this.startTimerForUri(syncedDocument.uri, `Refresh synced document: Version ${syncedDocument.version} by ${clientId}`);
794
+ const timer = this.startTimerForUri(syncedDocument.uri, `Refresh synced document: Version ${syncedDocument.version} by ${this.formatClientId(clientId)}`);
503
795
  this.__onDidChangeContent.fire(Object.freeze({ document: syncedDocument, clientId }));
504
796
  timer.dispose();
505
797
  }
@@ -511,7 +803,7 @@ export class HydraniumTextDocuments extends NormalizedTextDocuments {
511
803
  * two URIs for one physical file (a symlink path and its real path) into a
512
804
  * single registration — dedup at the editor layer, not just in
513
805
  * `LangiumDocuments`. The URI the client opened under is preserved separately
514
- * for egress addressing (see {@link DocumentTracking.languageClientUris}). The
806
+ * for egress addressing (see {@link DocumentTrackingRecord.languageClientUris}). The
515
807
  * policy is always bound (the framework defaults it to
516
808
  * `DefaultDocumentUriPolicy`, where canonical ≡ syntactic normalize).
517
809
  */
@@ -533,7 +825,7 @@ export class HydraniumTextDocuments extends NormalizedTextDocuments {
533
825
  trackingFor(uri) {
534
826
  let record = this.__documents.get(uri);
535
827
  if (!record) {
536
- record = { clients: new Set(), versionAuthors: [], clientVersions: new Map() };
828
+ record = { versionAuthors: [], clientVersions: new Map() };
537
829
  this.__documents.set(uri, record);
538
830
  }
539
831
  return record;
@@ -566,7 +858,7 @@ export class HydraniumTextDocuments extends NormalizedTextDocuments {
566
858
  * `0` for a URI this store has never seen. The shared sequence is
567
859
  * server-owned and monotonic across close/reopen cycles, and advances
568
860
  * exactly when the synced content changes — which is what makes it a sound
569
- * optimistic-concurrency token (`baseVersion` gates): version unchanged ⇔
861
+ * optimistic-concurrency token (based-on gates): version unchanged ⇔
570
862
  * content unchanged.
571
863
  */
572
864
  version(uri) {
@@ -606,6 +898,58 @@ export class HydraniumTextDocuments extends NormalizedTextDocuments {
606
898
  this.logUri(key, `External content change while closed: sequence stepped to version ${stepped.version}`, 'debug');
607
899
  return stepped.version;
608
900
  }
901
+ /**
902
+ * Commit an integrity repair into the OPEN document for `uri`, returning the
903
+ * document that now holds it, or `undefined` when there was nothing here to
904
+ * commit into.
905
+ *
906
+ * The one thing this exists to do is address the store BY URI. A repair
907
+ * reaches the resync as a text-document object, and that object is the
908
+ * store's own only on the LSP path; a document built for an already-open URI
909
+ * through `LangiumDocumentFactory.fromString` carries its own, so writing the
910
+ * repair into it corrects a copy the store does not know about and the editor
911
+ * never sees.
912
+ *
913
+ * `parsedFrom` is the text the repaired AST was parsed from, and a mismatch
914
+ * against the current content REFUSES the commit: the store has moved on,
915
+ * which means an editor change landed after that parse, and committing would
916
+ * overwrite a newer edit with a repair computed against text the user has
917
+ * already replaced. The build that change provokes recomputes the repair.
918
+ *
919
+ * Deliberately NOT compared by version. A separately created document seeds
920
+ * its own numbering, so requiring the two to agree would refuse every commit
921
+ * on the path this exists for. Content is the thing both sides can be held to.
922
+ *
923
+ * A changed text is a new version authored by {@link INTEGRITY_CLIENT_ID}.
924
+ * Kept at the old version, the repair is invisible to every reader keyed on
925
+ * versions: a write based on the unrepaired version passes the based-on gate
926
+ * and replaces the repair, and an echo filter credits the repair to the
927
+ * client whose edit it corrected. No change event is fired: the repair
928
+ * rides the build already under way, and an event would re-enter it.
929
+ */
930
+ commitRepair(uri, parsedFrom, repaired) {
931
+ const key = this.documentKey(uri);
932
+ const document = this.__syncedDocuments.get(key);
933
+ if (document === undefined) {
934
+ return { status: 'not-open' };
935
+ }
936
+ if (document.getText() !== parsedFrom) {
937
+ this.logUri(key, 'Refuse repair commit: the open document moved on from the text the AST was parsed from', 'debug');
938
+ return { status: 'stale' };
939
+ }
940
+ if (repaired === parsedFrom) {
941
+ return { status: 'committed', document };
942
+ }
943
+ // Reassigned rather than mutated in place: the default configuration
944
+ // updates and returns the SAME instance, but an adopter-supplied one may
945
+ // return a new object, and the store must end up holding whichever it is.
946
+ const updated = this.configuration.update(document, [{ text: repaired }], document.version + 1);
947
+ this.__syncedDocuments.set(key, updated);
948
+ this.setAuthor(key, updated.version, INTEGRITY_CLIENT_ID);
949
+ this.refreshDirty(key);
950
+ this.log(updated.uri, `Update to version ${updated.version} by ${this.formatClientId(INTEGRITY_CLIENT_ID)} (repair)`);
951
+ return { status: 'committed', document: updated };
952
+ }
609
953
  getAuthor(uri, version) {
610
954
  const history = this.__documents.get(this.documentKey(uri))?.versionAuthors;
611
955
  // Either the requested version, or the latest. `version !== undefined` so we treat 0 correctly.
@@ -624,16 +968,16 @@ export class HydraniumTextDocuments extends NormalizedTextDocuments {
624
968
  * True iff any client still holds `uri` open. Distinct from {@link isOpen},
625
969
  * which reads `__syncedDocuments` — that map is cleared only AFTER the
626
970
  * `onDidClose` event fires for the last client, so `isOpen` returns `true`
627
- * during the close event itself. `isOpenInAnyClient` reads the tracking
628
- * record's `clients` set, which is updated BEFORE the fire, so an `onDidClose`
971
+ * during the close event itself. `isOpenInAnyClient` reads the open table
972
+ * ({@link __sessions}), which is updated BEFORE the fire, so an `onDidClose`
629
973
  * subscriber that finds this `false` knows the last client just closed and a
630
974
  * disk re-read / rebuild can proceed.
631
975
  */
632
976
  isOpenInAnyClient(uri) {
633
- return (this.__documents.get(this.documentKey(uri))?.clients.size ?? 0) > 0;
977
+ return this.__sessions.isOpen(this.documentKey(uri));
634
978
  }
635
979
  isOpenInClient(uri, client) {
636
- return !!this.__documents.get(this.documentKey(uri))?.clients.has(client);
980
+ return this.__sessions.isOpenIn(this.documentKey(uri), client);
637
981
  }
638
982
  isOpenInLanguageClient(uri) {
639
983
  // Takes any URI form (canonicalizes internally via `documentKey`, like
@@ -642,13 +986,13 @@ export class HydraniumTextDocuments extends NormalizedTextDocuments {
642
986
  return this.isOpenInClient(uri, LANGUAGE_CLIENT_ID);
643
987
  }
644
988
  isOnlyOpenInClient(uri, client) {
645
- const key = this.documentKey(uri);
646
- return this.__documents.get(key)?.clients.size === 1 && this.isOpenInClient(key, client);
989
+ const clients = this.__sessions.clientsOf(this.documentKey(uri));
990
+ return clients.length === 1 && clients[0] === client;
647
991
  }
648
992
  /**
649
993
  * Every document currently held open by at least one client, with the client
650
- * ids holding it. Reads the same per-URI tracking records as
651
- * {@link isOpenInAnyClient}, so it reflects a last-client close immediately.
994
+ * ids holding it. Reads the same open table as {@link isOpenInAnyClient}, so
995
+ * it reflects a last-client close immediately.
652
996
  *
653
997
  * Diagnostics-oriented — the server-state snapshot lists these so an operator
654
998
  * can see WHY a document is pinned: a document that lingers here after its
@@ -656,27 +1000,221 @@ export class HydraniumTextDocuments extends NormalizedTextDocuments {
656
1000
  * under a shedding policy, explains why its CST is never shed).
657
1001
  */
658
1002
  openDocuments() {
659
- const result = [];
660
- for (const [uri, tracking] of this.__documents) {
661
- if (tracking.clients.size > 0) {
662
- result.push({ uri, clients: [...tracking.clients] });
1003
+ return this.__sessions.openDocuments();
1004
+ }
1005
+ /** Fires once a client session has ended, after every document it had open was closed. */
1006
+ get onDidCloseSession() {
1007
+ return this.__sessions.onDidCloseSession;
1008
+ }
1009
+ /**
1010
+ * Fires once a document no client has open is released: at its last close,
1011
+ * or, for a lost client's last close, when its revert grace runs out,
1012
+ * another client opens it, or it is deleted. The document then reverts to
1013
+ * disk.
1014
+ */
1015
+ get onDidCloseLastOpen() {
1016
+ return this.lastOpenClosedEmitter.event;
1017
+ }
1018
+ /**
1019
+ * Fires for every save the language client reports of a document it has
1020
+ * open: the editor has written the file. {@link onDidSave} follows only
1021
+ * when the file holds the store's text.
1022
+ */
1023
+ get onDidSaveInLanguageClient() {
1024
+ return this.languageClientSavedEmitter.event;
1025
+ }
1026
+ /**
1027
+ * Whether `uri` is waiting out the revert grace: its last open closed with a
1028
+ * lost connection, and it still holds its unsaved text. Such a document is
1029
+ * open for no client, yet not closed either, so a caller that would persist
1030
+ * a closed document's text to disk treats it as open.
1031
+ */
1032
+ isRevertPending(uri) {
1033
+ return this.__sessions.isRevertPending(this.documentKey(uri));
1034
+ }
1035
+ /**
1036
+ * Whether the store holds `uri` with text that differs from its disk
1037
+ * baseline: what the server last knew the file to hold. `false` for a URI
1038
+ * the store does not hold; a document waiting out the revert grace is still
1039
+ * held.
1040
+ *
1041
+ * The baseline is the text a first open brought, or what the server wrote,
1042
+ * or read back after an editor's save or a watched-file change, so it can
1043
+ * trail a change to the file that none of these has seen yet. A check that
1044
+ * must know the file reads it instead.
1045
+ */
1046
+ isDirty(uri) {
1047
+ return this.__documents.get(this.documentKey(uri))?.dirty ?? false;
1048
+ }
1049
+ /** Fires each time the answer of {@link isDirty} changes, the release of a dirty document included. */
1050
+ get onDidChangeDirty() {
1051
+ return this.dirtyChangedEmitter.event;
1052
+ }
1053
+ /**
1054
+ * Record that the file behind `uri` holds `text`, or no file at all for
1055
+ * `undefined`. A no-op for a URI the store does not hold: the next first
1056
+ * open sets the baseline from its own text.
1057
+ */
1058
+ updateDiskBaseline(uri, text) {
1059
+ const key = this.documentKey(uri);
1060
+ const record = this.__documents.get(key);
1061
+ if (!record || !this.__syncedDocuments.has(key)) {
1062
+ return;
1063
+ }
1064
+ record.diskBaseline = text;
1065
+ this.refreshDirty(key);
1066
+ }
1067
+ /**
1068
+ * Read the file behind `uri` through its disk queue and take it as the
1069
+ * baseline. A file that cannot be read counts as none, the side that
1070
+ * leaves the document dirty.
1071
+ */
1072
+ async reloadDiskBaseline(uri) {
1073
+ const key = this.documentKey(uri);
1074
+ if (!this.__syncedDocuments.has(key)) {
1075
+ return;
1076
+ }
1077
+ let onDisk;
1078
+ try {
1079
+ onDisk = await this.services.workspace.FileSystemTaskQueue.enqueue(key, () => this.services.workspace.FileSystemProvider.readFile(UriUtils.toUri(key)));
1080
+ }
1081
+ catch (err) {
1082
+ this.tracer.with(key).debug(`Disk baseline: the file cannot be read. ${err instanceof Error ? err.message : String(err)}`);
1083
+ }
1084
+ this.updateDiskBaseline(key, onDisk);
1085
+ }
1086
+ /** Compare the held text of `uri` with its baseline, and announce a changed answer. */
1087
+ refreshDirty(uri) {
1088
+ const record = this.__documents.get(uri);
1089
+ const document = this.__syncedDocuments.get(uri);
1090
+ if (!record || !document) {
1091
+ return;
1092
+ }
1093
+ const dirty = document.getText() !== record.diskBaseline;
1094
+ if (dirty !== (record.dirty ?? false)) {
1095
+ record.dirty = dirty;
1096
+ this.dirtyChangedEmitter.fire(Object.freeze({ uri, dirty }));
1097
+ }
1098
+ }
1099
+ /**
1100
+ * Start a client session under `clientId`. Throws where
1101
+ * {@link ClientSessionRegistry.register} refuses the id.
1102
+ */
1103
+ registerSession(clientId) {
1104
+ this.__sessions.register(clientId);
1105
+ this.tracer.info(`Session started: ${this.formatClientId(clientId)}`);
1106
+ this.tracer.trace(`Session started: ${clientId}`);
1107
+ }
1108
+ /**
1109
+ * End the client session `clientId`: close every document it has open, then
1110
+ * free the id. Immediate — each close runs the ordinary close path before
1111
+ * this returns, with `cause` as its cause. A no-op for an id that is not a
1112
+ * registered session.
1113
+ */
1114
+ closeSession(clientId, cause = 'closed') {
1115
+ if (!this.__sessions.isRegistered(clientId)) {
1116
+ return;
1117
+ }
1118
+ try {
1119
+ for (const uri of this.__sessions.beginClose(clientId)) {
1120
+ this.notifyDidCloseTextDocument({ textDocument: { uri } }, clientId, cause);
1121
+ }
1122
+ }
1123
+ finally {
1124
+ this.__sessions.unregister(clientId);
1125
+ this.tracer.info(`Session closed: ${this.formatClientId(clientId)}`);
1126
+ this.tracer.trace(`Session closed: ${clientId}`);
1127
+ }
1128
+ }
1129
+ /**
1130
+ * Close every document the language client has open, as a `didClose` for
1131
+ * each would, so each last close reverts. For a host whose editor connection
1132
+ * can end while the process lives on, such as a worker whose port's peer
1133
+ * closed: the language client is no session, so nothing else closes them.
1134
+ *
1135
+ * It first waits for the workspace initialization the open handler waits
1136
+ * for, so an open that arrived before the close is closed too; closing at
1137
+ * once would leave that open to land afterwards, held by a client that is
1138
+ * gone.
1139
+ */
1140
+ async closeLanguageClientDocuments() {
1141
+ await this.services.workspace.WorkspaceManager.workspaceInitialized;
1142
+ for (const uri of this.__sessions.opensOf(LANGUAGE_CLIENT_ID)) {
1143
+ // Every spelling the client opened the file under, since the close
1144
+ // below drops only the canonical one's.
1145
+ const clientUris = this.__documents.get(uri)?.languageClientUris;
1146
+ for (const clientUri of clientUris ?? []) {
1147
+ this.invalidateLanguageClientText(clientUri);
663
1148
  }
1149
+ clientUris?.clear();
1150
+ this.notifyDidCloseTextDocument({ textDocument: { uri } });
664
1151
  }
665
- return result;
666
1152
  }
667
1153
  /**
668
- * Stages integrity-updated content for a closed document.
1154
+ * The file behind `uri` was deleted: close every open of it except the
1155
+ * language client's.
1156
+ *
1157
+ * The editor's open is left alone because the editor owns it: it keeps the
1158
+ * buffer of a deleted file and goes on sending changes for it, and a store
1159
+ * that had closed the document would drop every one of them until the editor
1160
+ * reopened.
1161
+ */
1162
+ notifyDocumentDeleted(uri) {
1163
+ const key = this.documentKey(uri);
1164
+ for (const clientId of this.__sessions.clientsOf(key)) {
1165
+ if (clientId !== LANGUAGE_CLIENT_ID) {
1166
+ this.notifyDidCloseTextDocument({ textDocument: { uri: key } }, clientId);
1167
+ }
1168
+ }
1169
+ }
1170
+ /**
1171
+ * Remove the document for `uri`, closing every open of it first — the
1172
+ * editor's included, since the document it would keep editing is gone.
1173
+ *
1174
+ * The base removes the synced document without consulting the open table,
1175
+ * which leaves every open recorded against a document that no longer exists:
1176
+ * the store then answers that the URI is open, and the next open attaches to
1177
+ * nothing.
1178
+ */
1179
+ delete(uri) {
1180
+ const key = this.documentKey((typeof uri === 'object' && 'uri' in uri ? uri.uri : uri).toString());
1181
+ for (const clientId of this.__sessions.clientsOf(key)) {
1182
+ this.notifyDidCloseTextDocument({ textDocument: { uri: key } }, clientId);
1183
+ }
1184
+ // A document waiting out the grace has no client left to close, and is
1185
+ // released now as its last close would have released it.
1186
+ if (this.__sessions.isRevertPending(key)) {
1187
+ this.__sessions.cancelRevert(key);
1188
+ this.releaseDocument(key);
1189
+ }
1190
+ super.delete(key);
1191
+ }
1192
+ /**
1193
+ * A client id as log lines print it. An id containing `#` is cut eight
1194
+ * characters after its last `#`, which leaves a minted `label#uuid` as the
1195
+ * label and enough of the UUID to tell sessions apart; an id without `#`
1196
+ * prints whole. The full id goes out at trace level wherever a session
1197
+ * starts or ends.
1198
+ */
1199
+ formatClientId(clientId) {
1200
+ const separator = clientId.lastIndexOf('#');
1201
+ return separator < 0 ? clientId : clientId.slice(0, separator + 9);
1202
+ }
1203
+ /**
1204
+ * Stages integrity-updated content for a document no client holds.
669
1205
  *
670
1206
  * When `workspace/applyEdit` targets a closed file, the client opens it from
671
1207
  * disk (stale) and sends `didOpen` before applying the edit. This staged
672
1208
  * content is consumed by {@link notifyDidOpenTextDocument} to replace the
673
1209
  * stale disk text, preventing a brief revert of the integrity update.
674
1210
  *
675
- * Not cleared on close: pending content is only staged for already-closed
676
- * documents (the integrity service checks `isOpenInLanguageClient` first), so
677
- * a close → stage → open cycle cannot occur. The only scenario where an
678
- * entry lingers is if `workspace/applyEdit` fails and the file is never
679
- * opened — the memory cost is one serialised string per URI.
1211
+ * Only a FIRST open consumes it, so stage only for a URI no client holds
1212
+ * ({@link isOpenInAnyClient} is `false`). A URI held only through another
1213
+ * head is not closed: an editor attaching to it joins the existing entry and
1214
+ * never reads the stage, and the last close discards the stage with the
1215
+ * tracking record. An entry lingers only if `workspace/applyEdit` fails and
1216
+ * the file is never opened — the memory cost is one serialised string per
1217
+ * URI.
680
1218
  */
681
1219
  stagePendingContent(uri, text) {
682
1220
  this.trackingFor(this.documentKey(uri)).pendingContent = text;
@@ -729,10 +1267,11 @@ export class HydraniumTextDocuments extends NormalizedTextDocuments {
729
1267
  const targets = recorded && recorded.size > 0 ? recorded : [this.toLanguageClientUri(uri)];
730
1268
  let lastResult;
731
1269
  for (const targetUri of targets) {
732
- // Read BEFORE computeEdits, which overwrites it. This is the text the
733
- // edits below are keyed to, and therefore the only text the client's
734
- // echo of them can be reconstructed against.
735
- const before = this.__shadow.get(targetUri);
1270
+ // Read BEFORE computeEdits, which overwrites the baseline and drops
1271
+ // the opened snapshot. This is the text the client holds, and
1272
+ // therefore the only text its echo of this push can be reconstructed
1273
+ // against — whether or not the push below is keyed to it.
1274
+ const before = this.__shadow.clientText(targetUri);
736
1275
  const edits = this.__shadow.computeEdits(targetUri, newText);
737
1276
  if (edits.length === 0) {
738
1277
  continue;
@@ -747,9 +1286,20 @@ export class HydraniumTextDocuments extends NormalizedTextDocuments {
747
1286
  // it is exactly what the caller retries with after a rejection, so
748
1287
  // gating it there would refuse the recovery too.
749
1288
  const version = isFullReplace(edits) ? UNKNOWN_CLIENT_VERSION : this.languageClientVersion(uri);
1289
+ // A full `ApplyWorkspaceEditParams`, `edit` and all — NOT a bare
1290
+ // `WorkspaceEdit` with a `label` beside it. `applyEdit` takes
1291
+ // `ApplyWorkspaceEditParams | WorkspaceEdit` and discriminates on
1292
+ // `!!value.edit`, so `{ label, documentChanges }` is wrapped as
1293
+ // `{ edit: { label, documentChanges } }` — putting the label inside
1294
+ // the edit, where LSP defines no such field and no client reads it.
1295
+ // The union is also what hides it at compile time: excess-property
1296
+ // checking admits a property present in EITHER member, so an object
1297
+ // matching neither type-checks against the union.
750
1298
  const result = await connection.workspace.applyEdit({
751
1299
  label: options?.label,
752
- documentChanges: [TextDocumentEdit.create(OptionalVersionedTextDocumentIdentifier.create(targetUri, version), edits)]
1300
+ edit: {
1301
+ documentChanges: [TextDocumentEdit.create(OptionalVersionedTextDocumentIdentifier.create(targetUri, version), edits)]
1302
+ }
753
1303
  });
754
1304
  if (result && result.applied === false) {
755
1305
  this.__shadow.invalidate(targetUri);
@@ -803,12 +1353,17 @@ export class HydraniumTextDocuments extends NormalizedTextDocuments {
803
1353
  }
804
1354
  /**
805
1355
  * Decide what an incoming language-client change actually is, by
806
- * reconstructing the client's resulting buffer against the OLDEST push still
807
- * in flight for `clientFacing`.
1356
+ * reconstructing the client's resulting buffer against the text its ranges
1357
+ * address — the pre-push buffer of the OLDEST push still in flight for
1358
+ * `clientFacing`, else whatever that client is believed to hold.
808
1359
  *
809
- * `undefined` when nothing of ours is in flight, which is the ordinary path:
810
- * the client's ranges then address the synced text and the caller applies
811
- * them to it directly.
1360
+ * `undefined` when the client's ranges address the synced text itself —
1361
+ * nothing in flight, and no evidence the client holds anything else. That
1362
+ * is the ordinary path, and the caller then applies the ranges directly.
1363
+ * The two texts part company without a push in flight whenever a client
1364
+ * attaches to a document another client has already written: it opened
1365
+ * from disk, so applying its ranges to the synced text splices lines they
1366
+ * never addressed.
812
1367
  *
813
1368
  * **Why the oldest, and why reconstruct at all.** The client applies our
814
1369
  * pushes in order and echoes each against the buffer it held before that
@@ -835,22 +1390,41 @@ export class HydraniumTextDocuments extends NormalizedTextDocuments {
835
1390
  * queue, so undo revisits PAST states while the queue holds IN-FLIGHT ones.
836
1391
  */
837
1392
  classifyLanguageClientChange(clientFacing, document, changes) {
838
- const pending = this.__pendingPushes.get(clientFacing);
839
- if (pending === undefined || pending.length === 0) {
1393
+ const queued = this.__pendingPushes.get(clientFacing);
1394
+ const pending = queued?.length ? queued : undefined;
1395
+ // The text the client's ranges address: the buffer it held before the
1396
+ // oldest push still in flight, else the buffer it is believed to hold.
1397
+ const clientText = pending?.[0].before ?? this.__shadow.clientText(clientFacing);
1398
+ if (pending === undefined && (clientText === undefined || clientText === document.getText())) {
840
1399
  return undefined;
841
1400
  }
1401
+ if (pending !== undefined && pending[0].before === undefined && changes.some(change => ContentChange.isIncremental(change))) {
1402
+ // A push sent to a client whose buffer was unknown — a first sync, or
1403
+ // the recovery push after a rejection. The shadow now holds the text
1404
+ // that push MOVES the client to, which is the one text the echo's
1405
+ // ranges provably do not address, so the fallback above is a baseline
1406
+ // known to be wrong rather than merely unverified. Drop the queue and
1407
+ // the shadow: the next sync is then a full replace, which lands on
1408
+ // whatever the client holds. A full-text change is exempt because it
1409
+ // reconstructs identically against any baseline.
1410
+ pending.length = 0;
1411
+ this.__shadow.invalidate(clientFacing);
1412
+ return { kind: 'unreconstructable' };
1413
+ }
842
1414
  // Through the configured factories, not `TextDocument` directly, so an
843
1415
  // adopter's custom text-document type governs how the ranges are applied
844
1416
  // here exactly as it does on the synced document.
845
- const probe = this.create(clientFacing, document.languageId, 0, pending[0].before ?? document.getText());
846
- const clientText = this.update(probe, changes, 0).getText();
847
- const matchIndex = pending.findIndex(push => push.afterHash === contentHash(clientText));
848
- if (matchIndex >= 0) {
849
- pending.splice(0, matchIndex + 1);
850
- return { kind: 'echo' };
851
- }
852
- pending.length = 0;
853
- return { kind: 'divergent', text: clientText };
1417
+ const probe = this.create(clientFacing, document.languageId, 0, clientText ?? document.getText());
1418
+ const reconstructed = this.update(probe, changes, 0).getText();
1419
+ if (pending !== undefined) {
1420
+ const matchIndex = pending.findIndex(push => push.afterHash === contentHash(reconstructed));
1421
+ if (matchIndex >= 0) {
1422
+ pending.splice(0, matchIndex + 1);
1423
+ return { kind: 'echo' };
1424
+ }
1425
+ pending.length = 0;
1426
+ }
1427
+ return { kind: 'divergent', text: reconstructed };
854
1428
  }
855
1429
  /**
856
1430
  * Explicitly baseline the language-client text shadow for a URI. Useful in