@hydranium/protocol 1.0.0-next.36 → 1.0.0-next.361

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 (297) hide show
  1. package/README.md +44 -83
  2. package/lib/abstract-logger.d.ts +11 -0
  3. package/lib/abstract-logger.d.ts.map +1 -1
  4. package/lib/abstract-logger.js +16 -0
  5. package/lib/abstract-logger.js.map +1 -1
  6. package/lib/client/data-connection.d.ts +303 -0
  7. package/lib/client/data-connection.d.ts.map +1 -0
  8. package/lib/client/data-connection.js +534 -0
  9. package/lib/client/data-connection.js.map +1 -0
  10. package/lib/client/data-events.d.ts +18 -1
  11. package/lib/client/data-events.d.ts.map +1 -1
  12. package/lib/client/data-events.js +26 -0
  13. package/lib/client/data-events.js.map +1 -1
  14. package/lib/client/data-port.d.ts +34 -24
  15. package/lib/client/data-port.d.ts.map +1 -1
  16. package/lib/client/data-session.d.ts +691 -89
  17. package/lib/client/data-session.d.ts.map +1 -1
  18. package/lib/client/data-session.js +1155 -115
  19. package/lib/client/data-session.js.map +1 -1
  20. package/lib/client/index.d.ts +15 -9
  21. package/lib/client/index.d.ts.map +1 -1
  22. package/lib/client/index.js +15 -9
  23. package/lib/client/index.js.map +1 -1
  24. package/lib/client/message-relay.d.ts +6 -4
  25. package/lib/client/message-relay.d.ts.map +1 -1
  26. package/lib/client/message-relay.js +4 -4
  27. package/lib/client/message-relay.js.map +1 -1
  28. package/lib/client/post-message-transport.d.ts +69 -3
  29. package/lib/client/post-message-transport.d.ts.map +1 -1
  30. package/lib/client/post-message-transport.js +175 -1
  31. package/lib/client/post-message-transport.js.map +1 -1
  32. package/lib/client/rpc-connection.d.ts +173 -0
  33. package/lib/client/rpc-connection.d.ts.map +1 -0
  34. package/lib/client/rpc-connection.js +225 -0
  35. package/lib/client/rpc-connection.js.map +1 -0
  36. package/lib/client/worker-handshake.d.ts +94 -0
  37. package/lib/client/worker-handshake.d.ts.map +1 -0
  38. package/lib/client/worker-handshake.js +51 -0
  39. package/lib/client/worker-handshake.js.map +1 -0
  40. package/lib/client-ids.d.ts +45 -0
  41. package/lib/client-ids.d.ts.map +1 -0
  42. package/lib/client-ids.js +48 -0
  43. package/lib/client-ids.js.map +1 -0
  44. package/lib/clock.d.ts +50 -10
  45. package/lib/clock.d.ts.map +1 -1
  46. package/lib/clock.js +36 -1
  47. package/lib/clock.js.map +1 -1
  48. package/lib/console-logger.d.ts +23 -0
  49. package/lib/console-logger.d.ts.map +1 -0
  50. package/lib/console-logger.js +39 -0
  51. package/lib/console-logger.js.map +1 -0
  52. package/lib/data/data-protocol-methods.d.ts +4 -4
  53. package/lib/data/data-protocol-methods.d.ts.map +1 -1
  54. package/lib/data/data-protocol-methods.js +13 -1
  55. package/lib/data/data-protocol-methods.js.map +1 -1
  56. package/lib/data/data-server-protocol.d.ts +171 -48
  57. package/lib/data/data-server-protocol.d.ts.map +1 -1
  58. package/lib/data/events.d.ts +144 -33
  59. package/lib/data/events.d.ts.map +1 -1
  60. package/lib/data/requests.d.ts +76 -11
  61. package/lib/data/requests.d.ts.map +1 -1
  62. package/lib/debouncer.d.ts +7 -4
  63. package/lib/debouncer.d.ts.map +1 -1
  64. package/lib/debouncer.js +10 -10
  65. package/lib/debouncer.js.map +1 -1
  66. package/lib/errors.d.ts +188 -30
  67. package/lib/errors.d.ts.map +1 -1
  68. package/lib/errors.js +269 -32
  69. package/lib/errors.js.map +1 -1
  70. package/lib/format-log-arg.d.ts +33 -0
  71. package/lib/format-log-arg.d.ts.map +1 -0
  72. package/lib/format-log-arg.js +158 -0
  73. package/lib/format-log-arg.js.map +1 -0
  74. package/lib/glsp-edits-settled-actions.d.ts +54 -0
  75. package/lib/glsp-edits-settled-actions.d.ts.map +1 -0
  76. package/lib/glsp-edits-settled-actions.js +28 -0
  77. package/lib/glsp-edits-settled-actions.js.map +1 -0
  78. package/lib/glsp-request-model-args.d.ts +16 -0
  79. package/lib/glsp-request-model-args.d.ts.map +1 -0
  80. package/lib/glsp-request-model-args.js +19 -0
  81. package/lib/glsp-request-model-args.js.map +1 -0
  82. package/lib/glsp-save-model-actions.d.ts +55 -0
  83. package/lib/glsp-save-model-actions.d.ts.map +1 -0
  84. package/lib/glsp-save-model-actions.js +28 -0
  85. package/lib/glsp-save-model-actions.js.map +1 -0
  86. package/lib/index.d.ts +11 -0
  87. package/lib/index.d.ts.map +1 -1
  88. package/lib/index.js +11 -0
  89. package/lib/index.js.map +1 -1
  90. package/lib/latency-collector.d.ts +10 -4
  91. package/lib/latency-collector.d.ts.map +1 -1
  92. package/lib/latency-collector.js +2 -0
  93. package/lib/latency-collector.js.map +1 -1
  94. package/lib/logger.d.ts +38 -7
  95. package/lib/logger.d.ts.map +1 -1
  96. package/lib/logger.js +42 -4
  97. package/lib/logger.js.map +1 -1
  98. package/lib/messages/index.d.ts +4 -2
  99. package/lib/messages/index.d.ts.map +1 -1
  100. package/lib/messages/index.js +15 -4
  101. package/lib/messages/index.js.map +1 -1
  102. package/lib/messages/primitives.d.ts +59 -4
  103. package/lib/messages/primitives.d.ts.map +1 -1
  104. package/lib/messages/primitives.js +97 -4
  105. package/lib/messages/primitives.js.map +1 -1
  106. package/lib/model-server.d.ts +60 -13
  107. package/lib/model-server.d.ts.map +1 -1
  108. package/lib/model-server.js +4 -2
  109. package/lib/model-server.js.map +1 -1
  110. package/lib/model-service/base-version.d.ts +67 -0
  111. package/lib/model-service/base-version.d.ts.map +1 -0
  112. package/lib/model-service/base-version.js +44 -0
  113. package/lib/model-service/base-version.js.map +1 -0
  114. package/lib/model-service/index.d.ts +1 -1
  115. package/lib/model-service/index.d.ts.map +1 -1
  116. package/lib/model-service/index.js +4 -5
  117. package/lib/model-service/index.js.map +1 -1
  118. package/lib/model-service/reference-candidate.d.ts +5 -3
  119. package/lib/model-service/reference-candidate.d.ts.map +1 -1
  120. package/lib/node/index.d.ts +10 -0
  121. package/lib/node/index.d.ts.map +1 -0
  122. package/lib/node/index.js +29 -0
  123. package/lib/node/index.js.map +1 -0
  124. package/lib/node/process-memory.d.ts +66 -0
  125. package/lib/node/process-memory.d.ts.map +1 -0
  126. package/lib/node/process-memory.js +291 -0
  127. package/lib/node/process-memory.js.map +1 -0
  128. package/lib/noop-logger.d.ts.map +1 -1
  129. package/lib/noop-logger.js.map +1 -1
  130. package/lib/observable-value.js.map +1 -1
  131. package/lib/patch-merge.d.ts +63 -35
  132. package/lib/patch-merge.d.ts.map +1 -1
  133. package/lib/patch-merge.js +171 -25
  134. package/lib/patch-merge.js.map +1 -1
  135. package/lib/pending-work-tracker.d.ts +30 -0
  136. package/lib/pending-work-tracker.d.ts.map +1 -0
  137. package/lib/pending-work-tracker.js +47 -0
  138. package/lib/pending-work-tracker.js.map +1 -0
  139. package/lib/profile-session.d.ts +24 -8
  140. package/lib/profile-session.d.ts.map +1 -1
  141. package/lib/profile-session.js +13 -4
  142. package/lib/profile-session.js.map +1 -1
  143. package/lib/profiling.d.ts +15 -2
  144. package/lib/profiling.d.ts.map +1 -1
  145. package/lib/profiling.js.map +1 -1
  146. package/lib/project.d.ts +4 -1
  147. package/lib/project.d.ts.map +1 -1
  148. package/lib/project.js.map +1 -1
  149. package/lib/random-uuid.d.ts +14 -0
  150. package/lib/random-uuid.d.ts.map +1 -0
  151. package/lib/random-uuid.js +24 -0
  152. package/lib/random-uuid.js.map +1 -0
  153. package/lib/reconcile-write.d.ts +70 -0
  154. package/lib/reconcile-write.d.ts.map +1 -0
  155. package/lib/reconcile-write.js +69 -0
  156. package/lib/reconcile-write.js.map +1 -0
  157. package/lib/rpc/bind-rpc-methods.d.ts +6 -2
  158. package/lib/rpc/bind-rpc-methods.d.ts.map +1 -1
  159. package/lib/rpc/bind-rpc-methods.js +17 -7
  160. package/lib/rpc/bind-rpc-methods.js.map +1 -1
  161. package/lib/rpc/create-rpc-proxy.d.ts +3 -0
  162. package/lib/rpc/create-rpc-proxy.d.ts.map +1 -1
  163. package/lib/rpc/create-rpc-proxy.js +6 -1
  164. package/lib/rpc/create-rpc-proxy.js.map +1 -1
  165. package/lib/rpc/index.d.ts +1 -0
  166. package/lib/rpc/index.d.ts.map +1 -1
  167. package/lib/rpc/index.js +1 -0
  168. package/lib/rpc/index.js.map +1 -1
  169. package/lib/rpc/send-by-method-name.d.ts +76 -0
  170. package/lib/rpc/send-by-method-name.d.ts.map +1 -0
  171. package/lib/rpc/send-by-method-name.js +120 -0
  172. package/lib/rpc/send-by-method-name.js.map +1 -0
  173. package/lib/rpc/wire-prefix.js.map +1 -1
  174. package/lib/save-text-document.d.ts +40 -0
  175. package/lib/save-text-document.d.ts.map +1 -0
  176. package/lib/save-text-document.js +34 -0
  177. package/lib/save-text-document.js.map +1 -0
  178. package/lib/testing/catalogue-audit.d.ts +1 -1
  179. package/lib/testing/catalogue-audit.js +1 -1
  180. package/lib/testing/catalogue-audit.js.map +1 -1
  181. package/lib/testing/data-doubles.d.ts +41 -12
  182. package/lib/testing/data-doubles.d.ts.map +1 -1
  183. package/lib/testing/data-doubles.js +56 -8
  184. package/lib/testing/data-doubles.js.map +1 -1
  185. package/lib/testing/fake-clock.d.ts +17 -2
  186. package/lib/testing/fake-clock.d.ts.map +1 -1
  187. package/lib/testing/fake-clock.js +61 -46
  188. package/lib/testing/fake-clock.js.map +1 -1
  189. package/lib/testing/index.d.ts +1 -0
  190. package/lib/testing/index.d.ts.map +1 -1
  191. package/lib/testing/index.js +4 -3
  192. package/lib/testing/index.js.map +1 -1
  193. package/lib/testing/node/duplex-connection.d.ts.map +1 -1
  194. package/lib/testing/node/duplex-connection.js +3 -2
  195. package/lib/testing/node/duplex-connection.js.map +1 -1
  196. package/lib/testing/node/duplex-stream.js.map +1 -1
  197. package/lib/testing/node/index.d.ts +1 -0
  198. package/lib/testing/node/index.d.ts.map +1 -1
  199. package/lib/testing/node/index.js +2 -2
  200. package/lib/testing/node/index.js.map +1 -1
  201. package/lib/testing/node/message-port-pair.d.ts +25 -0
  202. package/lib/testing/node/message-port-pair.d.ts.map +1 -0
  203. package/lib/testing/node/message-port-pair.js +26 -0
  204. package/lib/testing/node/message-port-pair.js.map +1 -0
  205. package/lib/testing/transfer-node-builder.d.ts +81 -0
  206. package/lib/testing/transfer-node-builder.d.ts.map +1 -0
  207. package/lib/testing/transfer-node-builder.js +47 -0
  208. package/lib/testing/transfer-node-builder.js.map +1 -0
  209. package/lib/testing/wait-for.d.ts +9 -3
  210. package/lib/testing/wait-for.d.ts.map +1 -1
  211. package/lib/testing/wait-for.js +57 -11
  212. package/lib/testing/wait-for.js.map +1 -1
  213. package/lib/tracer.d.ts.map +1 -1
  214. package/lib/tracer.js +5 -9
  215. package/lib/tracer.js.map +1 -1
  216. package/lib/transfer-diagnostic.js.map +1 -1
  217. package/lib/transfer-document.d.ts +96 -32
  218. package/lib/transfer-document.d.ts.map +1 -1
  219. package/lib/transfer-document.js +17 -9
  220. package/lib/transfer-document.js.map +1 -1
  221. package/lib/transfer-element.d.ts +4 -4
  222. package/lib/types.d.ts +32 -0
  223. package/lib/types.d.ts.map +1 -0
  224. package/lib/{model-service/args.js → types.js} +2 -2
  225. package/lib/types.js.map +1 -0
  226. package/lib/uri.d.ts.map +1 -1
  227. package/lib/uri.js.map +1 -1
  228. package/lib/util.d.ts +8 -2
  229. package/lib/util.d.ts.map +1 -1
  230. package/lib/util.js +32 -4
  231. package/lib/util.js.map +1 -1
  232. package/package.json +24 -40
  233. package/src/abstract-logger.ts +18 -0
  234. package/src/client/data-connection.ts +654 -0
  235. package/src/client/data-events.ts +38 -1
  236. package/src/client/data-port.ts +36 -25
  237. package/src/client/data-session.ts +1476 -137
  238. package/src/client/index.ts +15 -9
  239. package/src/client/message-relay.ts +6 -4
  240. package/src/client/post-message-transport.ts +224 -4
  241. package/src/client/rpc-connection.ts +302 -0
  242. package/src/client/worker-handshake.ts +121 -0
  243. package/src/client-ids.ts +49 -0
  244. package/src/clock.ts +68 -10
  245. package/src/console-logger.ts +39 -0
  246. package/src/data/data-protocol-methods.ts +14 -4
  247. package/src/data/data-server-protocol.ts +198 -48
  248. package/src/data/events.ts +150 -33
  249. package/src/data/requests.ts +82 -11
  250. package/src/debouncer.ts +11 -11
  251. package/src/errors.ts +331 -40
  252. package/src/format-log-arg.ts +176 -0
  253. package/src/glsp-edits-settled-actions.ts +62 -0
  254. package/src/glsp-request-model-args.ts +16 -0
  255. package/src/glsp-save-model-actions.ts +64 -0
  256. package/src/index.ts +11 -0
  257. package/src/latency-collector.ts +10 -3
  258. package/src/logger.ts +44 -8
  259. package/src/messages/index.ts +4 -2
  260. package/src/messages/primitives.ts +129 -5
  261. package/src/model-server.ts +64 -19
  262. package/src/model-service/base-version.ts +75 -0
  263. package/src/model-service/index.ts +4 -5
  264. package/src/model-service/reference-candidate.ts +5 -3
  265. package/src/node/index.ts +14 -0
  266. package/src/node/process-memory.ts +299 -0
  267. package/src/patch-merge.ts +230 -45
  268. package/src/pending-work-tracker.ts +47 -0
  269. package/src/profile-session.ts +31 -11
  270. package/src/profiling.ts +15 -2
  271. package/src/project.ts +4 -1
  272. package/src/random-uuid.ts +21 -0
  273. package/src/reconcile-write.ts +131 -0
  274. package/src/rpc/README.md +6 -6
  275. package/src/rpc/bind-rpc-methods.ts +18 -8
  276. package/src/rpc/create-rpc-proxy.ts +6 -1
  277. package/src/rpc/index.ts +1 -0
  278. package/src/rpc/send-by-method-name.ts +140 -0
  279. package/src/save-text-document.ts +39 -0
  280. package/src/testing/catalogue-audit.ts +1 -1
  281. package/src/testing/data-doubles.ts +141 -19
  282. package/src/testing/fake-clock.ts +76 -48
  283. package/src/testing/index.ts +4 -3
  284. package/src/testing/node/duplex-connection.ts +3 -2
  285. package/src/testing/node/index.ts +2 -2
  286. package/src/testing/node/message-port-pair.ts +40 -0
  287. package/src/testing/transfer-node-builder.ts +107 -0
  288. package/src/testing/wait-for.ts +61 -13
  289. package/src/tracer.ts +5 -9
  290. package/src/transfer-document.ts +116 -34
  291. package/src/transfer-element.ts +4 -4
  292. package/src/types.ts +30 -0
  293. package/src/util.ts +33 -6
  294. package/lib/model-service/args.d.ts +0 -64
  295. package/lib/model-service/args.d.ts.map +0 -1
  296. package/lib/model-service/args.js.map +0 -1
  297. package/src/model-service/args.ts +0 -67
@@ -33,9 +33,19 @@
33
33
 
34
34
  import { Emitter, type MessageConnection } from 'vscode-jsonrpc';
35
35
  import type { DataPort } from '../client/data-port';
36
+ import { DATA_CLIENT_PROTOCOL_METHODS } from '../data/data-protocol-methods';
36
37
  import type { DataClientProtocol } from '../data/data-server-protocol';
37
- import type { ProjectsChangedEvent, TransferDocumentSavedEvent, TransferDocumentUpdatedEvent } from '../data/events';
38
+ import type {
39
+ ProjectsChangedEvent,
40
+ TransferDocumentDeletedEvent,
41
+ TransferDocumentDirtyChangedEvent,
42
+ TransferDocumentSavedEvent,
43
+ TransferDocumentsBuiltEvent,
44
+ TransferDocumentUpdatedEvent
45
+ } from '../data/events';
46
+ import type { Logger } from '../logger';
38
47
  import type { ResolvedMessage } from '../messages/primitives';
48
+ import type { RpcProxyLifecycle } from '../rpc/create-rpc-proxy';
39
49
  import type { Project } from '../project';
40
50
  import type { TransferDiagnostic } from '../transfer-diagnostic';
41
51
  import type { TransferElement } from '../transfer-element';
@@ -50,15 +60,14 @@ export interface FakeDataPortOptions {
50
60
  *
51
61
  * Throwing (or rejecting) here is the transport-construction failure path,
52
62
  * which the consumer surfaces through {@link FakeDataPort.reported}.
63
+ *
64
+ * The double disposes none of these connections and goes on connecting
65
+ * after its dispose, where a real port releases its connection and refuses:
66
+ * the test owns them.
53
67
  */
54
68
  connect(): MessageConnection | Promise<MessageConnection>;
55
- /**
56
- * Stable client identity. Defaults to `'fake-data-port'`, which avoids the
57
- * three sentinels the framework reserves (`'language-client'`, `'unknown'`,
58
- * `'revert-on-close'`); override it when a test needs two distinguishable
59
- * clients on one server.
60
- */
61
- clientId?: string;
69
+ /** The port's {@link DataPort.logger}. */
70
+ logger?: Logger;
62
71
  }
63
72
 
64
73
  /** A {@link DataPort} that records what passed through it. */
@@ -101,9 +110,9 @@ export function makeFakeDataPort(options: FakeDataPortOptions): FakeDataPort {
101
110
  const reported: { error: unknown; message: ResolvedMessage }[] = [];
102
111
  const disposeEmitter = new Emitter<void>();
103
112
  return {
104
- clientId: options.clientId ?? 'fake-data-port',
105
113
  connections,
106
114
  reported,
115
+ logger: options.logger,
107
116
  onDispose: disposeEmitter.event,
108
117
  async connect(): Promise<MessageConnection> {
109
118
  const connection = await options.connect();
@@ -122,26 +131,78 @@ export function makeFakeDataPort(options: FakeDataPortOptions): FakeDataPort {
122
131
  };
123
132
  }
124
133
 
134
+ type UpperLetter =
135
+ | 'A'
136
+ | 'B'
137
+ | 'C'
138
+ | 'D'
139
+ | 'E'
140
+ | 'F'
141
+ | 'G'
142
+ | 'H'
143
+ | 'I'
144
+ | 'J'
145
+ | 'K'
146
+ | 'L'
147
+ | 'M'
148
+ | 'N'
149
+ | 'O'
150
+ | 'P'
151
+ | 'Q'
152
+ | 'R'
153
+ | 'S'
154
+ | 'T'
155
+ | 'U'
156
+ | 'V'
157
+ | 'W'
158
+ | 'X'
159
+ | 'Y'
160
+ | 'Z';
161
+
162
+ /**
163
+ * A notification name `TClient` adds to {@link DataClientProtocol}. Limited to
164
+ * `on` plus a letter A–Z, the names the proxy sends as notifications; any other
165
+ * name would be bound as a request. The {@link RpcProxyLifecycle} names are
166
+ * excluded too: the proxy returns its own events for them and sends nothing.
167
+ */
168
+ export type AdditionalClientMethod<TClient> = Exclude<keyof TClient, keyof DataClientProtocol<TransferElement> | keyof RpcProxyLifecycle> &
169
+ `on${UpperLetter}${string}`;
170
+
125
171
  /** A {@link DataClientProtocol} plus the arrays it records into. */
126
172
  export interface CapturingDataClient<
127
173
  TTransfer extends TransferElement,
128
174
  TDiagnostic extends TransferDiagnostic = TransferDiagnostic,
129
- TProject extends Project = Project
175
+ TProject extends Project = Project,
176
+ TClient extends DataClientProtocol<TTransfer, TDiagnostic, TProject> = DataClientProtocol<TTransfer, TDiagnostic, TProject>
130
177
  > {
131
178
  /** The client to hand to a `DataSession` or bind as an RPC `localTarget`. */
132
- readonly client: DataClientProtocol<TTransfer, TDiagnostic, TProject>;
179
+ readonly client: TClient;
133
180
  /** Every `onDocumentUpdated` event, in arrival order. */
134
181
  readonly updates: TransferDocumentUpdatedEvent<TTransfer, TDiagnostic>[];
135
182
  /** Every `onDocumentSaved` event, in arrival order. */
136
183
  readonly saves: TransferDocumentSavedEvent<TTransfer, TDiagnostic>[];
184
+ /** Every `onDocumentDirtyChanged` event, in arrival order. */
185
+ readonly dirtyChanges: TransferDocumentDirtyChangedEvent[];
186
+ /** Every `onDocumentDeleted` event, in arrival order. */
187
+ readonly deletions: TransferDocumentDeletedEvent[];
188
+ /** Every `onDocumentsBuilt` event, in arrival order. */
189
+ readonly builds: TransferDocumentsBuiltEvent[];
137
190
  /** Every `onProjectsChanged` event, in arrival order. */
138
191
  readonly projectsChanges: ProjectsChangedEvent<TProject>[];
192
+ /**
193
+ * Every event of each additional client method, keyed by method, in arrival
194
+ * order. A method of `TClient` left out of `additionalClientMethods` has no
195
+ * entry.
196
+ */
197
+ readonly additionalNotifications: {
198
+ readonly [K in AdditionalClientMethod<TClient>]: TClient[K] extends (event: infer TEvent) => void ? TEvent[] : never;
199
+ };
139
200
  }
140
201
 
141
202
  /**
142
203
  * A {@link DataClientProtocol} that records every notification it receives.
143
204
  *
144
- * Recording ALL THREE channels even when a suite reads one is deliberate: an
205
+ * Recording EVERY channel even when a suite reads one is deliberate: an
145
206
  * event delivered on the wrong channel is a real defect of the data head, and a
146
207
  * double that drops the other two turns it into silence on the one being
147
208
  * watched.
@@ -150,31 +211,92 @@ export interface CapturingDataClient<
150
211
  * the corresponding array stays empty — that is what makes an override usable
151
212
  * as a barrier (rejecting, counting differently, throwing) rather than only as
152
213
  * a spy.
214
+ *
215
+ * `additionalClientMethods` names the notifications `TClient` adds to
216
+ * {@link DataClientProtocol}. Each is recorded and overridable the same way;
217
+ * one left out is not on the client at all, and overriding it throws, since
218
+ * nothing would call the override.
153
219
  */
154
220
  export function makeCapturingDataClient<
155
221
  TTransfer extends TransferElement,
156
222
  TDiagnostic extends TransferDiagnostic = TransferDiagnostic,
157
- TProject extends Project = Project
158
- >(overrides: Partial<DataClientProtocol<TTransfer, TDiagnostic, TProject>> = {}): CapturingDataClient<TTransfer, TDiagnostic, TProject> {
223
+ TProject extends Project = Project,
224
+ TClient extends DataClientProtocol<TTransfer, TDiagnostic, TProject> = DataClientProtocol<TTransfer, TDiagnostic, TProject>
225
+ >(
226
+ overrides: Partial<TClient> = {},
227
+ additionalClientMethods: readonly AdditionalClientMethod<TClient>[] = []
228
+ ): CapturingDataClient<TTransfer, TDiagnostic, TProject, TClient> {
229
+ const bound = new Set<string>([...DATA_CLIENT_PROTOCOL_METHODS, ...additionalClientMethods]);
230
+ for (const name of Object.keys(overrides)) {
231
+ if (!bound.has(name)) {
232
+ throw new Error(
233
+ `Override '${name}' is neither a DataClientProtocol method nor listed in additionalClientMethods, so nothing would call it.`
234
+ );
235
+ }
236
+ }
237
+ const frameworkOverrides: Partial<DataClientProtocol<TTransfer, TDiagnostic, TProject>> = overrides;
159
238
  const updates: TransferDocumentUpdatedEvent<TTransfer, TDiagnostic>[] = [];
160
239
  const saves: TransferDocumentSavedEvent<TTransfer, TDiagnostic>[] = [];
240
+ const dirtyChanges: TransferDocumentDirtyChangedEvent[] = [];
241
+ const deletions: TransferDocumentDeletedEvent[] = [];
242
+ const builds: TransferDocumentsBuiltEvent[] = [];
161
243
  const projectsChanges: ProjectsChangedEvent<TProject>[] = [];
162
- const client: DataClientProtocol<TTransfer, TDiagnostic, TProject> = {
244
+ const frameworkClient: DataClientProtocol<TTransfer, TDiagnostic, TProject> = {
163
245
  onDocumentUpdated:
164
- overrides.onDocumentUpdated ??
246
+ frameworkOverrides.onDocumentUpdated ??
165
247
  (event => {
166
248
  updates.push(event);
167
249
  }),
168
250
  onDocumentSaved:
169
- overrides.onDocumentSaved ??
251
+ frameworkOverrides.onDocumentSaved ??
170
252
  (event => {
171
253
  saves.push(event);
172
254
  }),
255
+ onDocumentDirtyChanged:
256
+ frameworkOverrides.onDocumentDirtyChanged ??
257
+ (event => {
258
+ dirtyChanges.push(event);
259
+ }),
260
+ onDocumentDeleted:
261
+ frameworkOverrides.onDocumentDeleted ??
262
+ (event => {
263
+ deletions.push(event);
264
+ }),
265
+ onDocumentsBuilt:
266
+ frameworkOverrides.onDocumentsBuilt ??
267
+ (event => {
268
+ builds.push(event);
269
+ }),
173
270
  onProjectsChanged:
174
- overrides.onProjectsChanged ??
271
+ frameworkOverrides.onProjectsChanged ??
175
272
  (event => {
176
273
  projectsChanges.push(event);
177
274
  })
178
275
  };
179
- return { client, updates, saves, projectsChanges };
276
+ const additionalNotifications: Record<string, unknown[]> = {};
277
+ const additionalHandlers: Record<string, unknown> = {};
278
+ for (const method of additionalClientMethods) {
279
+ const events: unknown[] = [];
280
+ additionalNotifications[method] = events;
281
+ additionalHandlers[method] =
282
+ overrides[method] ??
283
+ ((event: unknown) => {
284
+ events.push(event);
285
+ });
286
+ }
287
+ return {
288
+ client: { ...frameworkClient, ...additionalHandlers } as unknown as TClient,
289
+ updates,
290
+ saves,
291
+ dirtyChanges,
292
+ deletions,
293
+ builds,
294
+ projectsChanges,
295
+ additionalNotifications: additionalNotifications as CapturingDataClient<
296
+ TTransfer,
297
+ TDiagnostic,
298
+ TProject,
299
+ TClient
300
+ >['additionalNotifications']
301
+ };
180
302
  }
@@ -7,7 +7,7 @@
7
7
  * SPDX-License-Identifier: MIT
8
8
  ********************************************************************************/
9
9
 
10
- import { type Clock, type Stopwatch, type Timed } from '../clock';
10
+ import { type Clock, type Stopwatch, SystemClock } from '../clock';
11
11
  import { Disposable } from '../util';
12
12
 
13
13
  /** A {@link Clock} whose time only moves when the test calls {@link FakeClock.advance}. */
@@ -17,9 +17,19 @@ export interface FakeClock extends Clock {
17
17
  * whose deadline falls within the window — in chronological order, each at
18
18
  * its own deadline (so `now()` inside a callback reads the fire instant, not
19
19
  * the advance target). Timers scheduled by a callback fire too if they fall
20
- * within the same window.
20
+ * within the same window. A {@link Clock.raceTimer} over a promise that
21
+ * settles through a chain still pending loses to the timer, so let that
22
+ * chain settle before advancing.
21
23
  */
22
24
  advance(ms: number): void;
25
+ /**
26
+ * Move `now()` by `ms`, backwards when negative, leaving stopwatches and
27
+ * timers where they are: the wall-clock step a time sync or a manual change makes,
28
+ * which a duration taken from two `now()` readings gets wrong.
29
+ */
30
+ jumpWallClock(ms: number): void;
31
+ /** How many {@link Clock.setTimer} timers have neither fired nor been disposed. */
32
+ pendingTimers(): number;
23
33
  }
24
34
 
25
35
  interface FakeTimer {
@@ -35,72 +45,90 @@ interface FakeTimer {
35
45
  * (`Date.now` for `now()`, `performance.now()` for the stopwatch); the fake
36
46
  * collapses them onto ONE virtual time axis, so a single
37
47
  * {@link FakeClock.advance} drives `now()`, every live stopwatch's elapsed, and
38
- * any due timer together.
48
+ * any due timer together; only {@link FakeClock.jumpWallClock} pulls `now()`
49
+ * off that axis.
39
50
  *
40
51
  * Server-free and DI-free — lives in `@hydranium/protocol/testing` so every
41
52
  * head can bind it without pulling in a server package.
53
+ *
54
+ * The clock is a `SystemClock` with its time replaced, so its methods live on
55
+ * its prototype and a spread of it carries none of them. Replace one by
56
+ * assigning it onto the clock, or layer over the clock with `Object.create`.
42
57
  */
43
58
  export function makeFakeClock(options: { now?: number } = {}): FakeClock {
44
- let current = options.now ?? 0;
45
- const timers: FakeTimer[] = [];
59
+ return new VirtualClock(options.now ?? 0);
60
+ }
61
+
62
+ /**
63
+ * A `SystemClock` whose time, stopwatches and timers read one virtual axis, so
64
+ * the `measure` and `raceTimer` it inherits run on that axis too.
65
+ */
66
+ class VirtualClock extends SystemClock implements FakeClock {
67
+ protected readonly timers: FakeTimer[] = [];
68
+ /** What {@link jumpWallClock} has added to `now()`. */
69
+ protected wallClockOffset = 0;
46
70
 
47
- const makeStopwatch = (): Stopwatch => {
48
- const start = current;
49
- let lastLap = current;
71
+ constructor(protected current: number) {
72
+ super();
73
+ }
74
+
75
+ override now(): number {
76
+ return this.current + this.wallClockOffset;
77
+ }
78
+
79
+ jumpWallClock(ms: number): void {
80
+ this.wallClockOffset += ms;
81
+ }
82
+
83
+ override setTimer(callback: () => void, ms: number): Disposable {
84
+ const timer: FakeTimer = { at: this.current + ms, callback, disposed: false, fired: false };
85
+ this.timers.push(timer);
86
+ return Disposable.create(() => {
87
+ timer.disposed = true;
88
+ });
89
+ }
90
+
91
+ override stopwatch(): Stopwatch {
92
+ const read = (): number => this.current;
93
+ const start = read();
94
+ let lastLap = start;
50
95
  let stopped: number | undefined;
51
96
  return {
52
97
  get elapsedMs(): number {
53
- return (stopped ?? current) - start;
98
+ return (stopped ?? read()) - start;
54
99
  },
55
100
  lap(): number {
56
- const at = stopped ?? current;
101
+ const at = stopped ?? read();
57
102
  const split = at - lastLap;
58
103
  lastLap = at;
59
104
  return split;
60
105
  },
61
106
  stop(): number {
62
- if (stopped === undefined) {
63
- stopped = current;
64
- }
107
+ stopped ??= read();
65
108
  return stopped - start;
66
109
  }
67
110
  };
68
- };
111
+ }
69
112
 
70
- return {
71
- now: () => current,
72
- setTimer(callback: () => void, ms: number): Disposable {
73
- const timer: FakeTimer = { at: current + ms, callback, disposed: false, fired: false };
74
- timers.push(timer);
75
- return Disposable.create(() => {
76
- timer.disposed = true;
77
- });
78
- },
79
- stopwatch: makeStopwatch,
80
- measure: (<T>(callback: () => T | Promise<T>): Timed<T> | Promise<Timed<T>> => {
81
- const stopwatch = makeStopwatch();
82
- const result = callback();
83
- if (result instanceof Promise) {
84
- return (result as Promise<T>).then(value => ({ result: value, elapsedMs: stopwatch.elapsedMs }));
85
- }
86
- return { result: result as T, elapsedMs: stopwatch.elapsedMs };
87
- }) as Clock['measure'],
88
- advance(ms: number): void {
89
- const target = current + ms;
90
- // Fire due timers one at a time, re-scanning after each so a callback
91
- // that schedules a nearer timer still fires within this window.
92
- for (;;) {
93
- const next = timers
94
- .filter(timer => !timer.disposed && !timer.fired && timer.at <= target)
95
- .sort((left, right) => left.at - right.at)[0];
96
- if (!next) {
97
- break;
98
- }
99
- current = next.at;
100
- next.fired = true;
101
- next.callback();
113
+ pendingTimers(): number {
114
+ return this.timers.filter(timer => !timer.disposed && !timer.fired).length;
115
+ }
116
+
117
+ advance(ms: number): void {
118
+ const target = this.current + ms;
119
+ // Fire due timers one at a time, re-scanning after each so a callback
120
+ // that schedules a nearer timer still fires within this window.
121
+ for (;;) {
122
+ const next = this.timers
123
+ .filter(timer => !timer.disposed && !timer.fired && timer.at <= target)
124
+ .sort((left, right) => left.at - right.at)[0];
125
+ if (!next) {
126
+ break;
102
127
  }
103
- current = target;
128
+ this.current = next.at;
129
+ next.fired = true;
130
+ next.callback();
104
131
  }
105
- };
132
+ this.current = target;
133
+ }
106
134
  }
@@ -11,13 +11,13 @@
11
11
  // primitives: `makeFakeClock` (deterministic `Clock` double on one virtual time
12
12
  // axis), `waitFor` / `tick`, the client-side data-head doubles
13
13
  // (`makeFakeDataPort` / `makeCapturingDataClient`), the translation-catalogue
14
- // audit (`flattenCatalogue` / `findUndeclaredCodes` / `findSharedCodes`), and
15
- // the `Harness` marker
14
+ // audit (`flattenCatalogue` / `findUndeclaredCodes` / `findSharedCodes`), the
15
+ // transfer-node builder (`makeTransferNodeBuilder`), and the `Harness` marker
16
16
  // interface every framework harness extends. Kept out of the main barrel so production bundles don't pull
17
17
  // the test scaffolding in by default; adopters opt in by importing from
18
18
  // `@hydranium/protocol/testing`.
19
19
  //
20
- // Neutrality is gated (`scripts/check-neutral-bundles.mjs`), which is why the
20
+ // Neutrality is gated (`scripts/check-neutral-bundles.mts`), which is why the
21
21
  // duplex transports are NOT here: a `PassThrough` pair is in their exported
22
22
  // type, so they cannot be made portable and live at `./testing/node` instead.
23
23
  // The same rule the package surface uses — the portable name is the short one.
@@ -26,4 +26,5 @@ export * from './catalogue-audit';
26
26
  export * from './data-doubles';
27
27
  export * from './fake-clock';
28
28
  export * from './harness';
29
+ export * from './transfer-node-builder';
29
30
  export * from './wait-for';
@@ -32,8 +32,9 @@ export function makeDuplexConnectionPair(): DuplexConnectionPair {
32
32
  const pair = makeDuplexStreamPair();
33
33
  const { clientToServer, serverToClient } = pair;
34
34
 
35
- const left = createMessageConnection(new StreamMessageReader(serverToClient), new StreamMessageWriter(clientToServer));
36
- const right = createMessageConnection(new StreamMessageReader(clientToServer), new StreamMessageWriter(serverToClient));
35
+ // `console`, so a protocol fault on either end shows in the test's output.
36
+ const left = createMessageConnection(new StreamMessageReader(serverToClient), new StreamMessageWriter(clientToServer), console);
37
+ const right = createMessageConnection(new StreamMessageReader(clientToServer), new StreamMessageWriter(serverToClient), console);
37
38
 
38
39
  left.listen();
39
40
  right.listen();
@@ -8,8 +8,7 @@
8
8
  ********************************************************************************/
9
9
 
10
10
  // Subpath barrel for `@hydranium/protocol/testing/node` — the test transports
11
- // that need a Node runtime: a crossed `PassThrough` pair and the in-process
12
- // `MessageConnection` bridge over it.
11
+ // that need a Node runtime.
13
12
  //
14
13
  // Separate from `./testing` because a `PassThrough` is in `DuplexStreamPair`'s
15
14
  // exported type and `StreamMessageReader` comes from `vscode-jsonrpc/node`, so
@@ -20,3 +19,4 @@
20
19
 
21
20
  export * from './duplex-connection';
22
21
  export * from './duplex-stream';
22
+ export * from './message-port-pair';
@@ -0,0 +1,40 @@
1
+ /********************************************************************************
2
+ * Copyright (c) 2026 EclipseSource and others.
3
+ *
4
+ * This program and the accompanying materials are made available under the
5
+ * terms of the MIT License which is available in the project root.
6
+ *
7
+ * SPDX-License-Identifier: MIT
8
+ ********************************************************************************/
9
+
10
+ import { MessageChannel } from 'node:worker_threads';
11
+ import type { TransferredMessagePort } from '../../client/post-message-transport';
12
+
13
+ /**
14
+ * The two ends of a `worker_threads` `MessageChannel`, typed as the transferred
15
+ * browser ports `createMessagePortTransport` takes. Node's port clones and keeps
16
+ * order as a browser's does, which is what lets a headless test stand in for a
17
+ * worker.
18
+ *
19
+ * `dispose` closes both ports. Node reports that as a close and a browser port
20
+ * reports nothing, so a test that asserts on a close does so before teardown.
21
+ */
22
+ export interface MessagePortPair {
23
+ readonly port1: TransferredMessagePort;
24
+ readonly port2: TransferredMessagePort;
25
+ dispose(): void;
26
+ }
27
+
28
+ export function makeMessagePortPair(): MessagePortPair {
29
+ const channel = new MessageChannel();
30
+ return {
31
+ // Node's port satisfies the structural type at runtime; the cast records
32
+ // one platform's port standing in for the other's.
33
+ port1: channel.port1 as unknown as TransferredMessagePort,
34
+ port2: channel.port2 as unknown as TransferredMessagePort,
35
+ dispose(): void {
36
+ channel.port1.close();
37
+ channel.port2.close();
38
+ }
39
+ };
40
+ }
@@ -0,0 +1,107 @@
1
+ /********************************************************************************
2
+ * Copyright (c) 2026 EclipseSource and others.
3
+ *
4
+ * This program and the accompanying materials are made available under the
5
+ * terms of the MIT License which is available in the project root.
6
+ *
7
+ * SPDX-License-Identifier: MIT
8
+ ********************************************************************************/
9
+
10
+ import type { TransferElement } from '../transfer-element';
11
+ import type { ConcreteTypeName, SingleTypeName } from '../types';
12
+
13
+ /**
14
+ * The per-type constant the generated transfer model emits under each type's
15
+ * name, as Langium does for the AST. Its `$type` literal picks the interface
16
+ * out of the builder's type map.
17
+ */
18
+ export interface TransferTypeConstant<TType extends string = string> {
19
+ readonly $type: TType;
20
+ }
21
+
22
+ /**
23
+ * What {@link makeTransferNodeBuilder} reads from a reflection: each type's
24
+ * grammar properties and their defaults. The generated
25
+ * `<LanguageId>TransferReflection` satisfies it without importing it, and
26
+ * keeps the literal type of its `types` so the builder can tell which fields
27
+ * the grammar defaults.
28
+ */
29
+ export interface TransferReflection {
30
+ getTypeMetaData(type: string): { readonly properties: Readonly<Record<string, { readonly defaultValue?: unknown }>> };
31
+ }
32
+
33
+ /** The properties of `TType` that `TReflection`'s literal `types` gives a `defaultValue`; none for a reflection typed only as the interface. */
34
+ type DefaultedKeys<TReflection, TType> = TReflection extends { readonly types: infer Types }
35
+ ? TType extends keyof Types
36
+ ? Types[TType] extends { readonly properties: infer Properties }
37
+ ? { [K in keyof Properties]: Properties[K] extends { readonly defaultValue: unknown } ? K : never }[keyof Properties]
38
+ : never
39
+ : never
40
+ : never;
41
+
42
+ /**
43
+ * Init payload of a {@link TransferNodeBuilder}: every field of `T` as its
44
+ * interface declares it, except that the fields named by `TDefaulted`, which
45
+ * the grammar defaults, are optional. `$type` comes from the constant.
46
+ */
47
+ export type TransferNodeInit<T extends TransferElement, TDefaulted extends PropertyKey = never> = Omit<T, '$type' | TDefaulted> &
48
+ Partial<Pick<T, Extract<TDefaulted, keyof T>>>;
49
+
50
+ /**
51
+ * Transfer-node factory bound to a grammar's type map, the transfer twin of
52
+ * core's `AstNodeBuilder`. `TMap` is the generated `<LanguageId>TransferTypes`,
53
+ * `TReflection` the type of the generated reflection.
54
+ */
55
+ export interface TransferNodeBuilder<TMap, TReflection extends TransferReflection = TransferReflection> {
56
+ /** A complete node: the grammar's defaults, then `init`. */
57
+ <TType extends ConcreteTypeName<TMap>>(
58
+ typeConstant: TransferTypeConstant<TType> & SingleTypeName<TType>,
59
+ init: TransferNodeInit<Extract<TMap[TType], TransferElement>, DefaultedKeys<TReflection, TType>>
60
+ ): Extract<TMap[TType], TransferElement>;
61
+ /**
62
+ * A node holding only `init`, with no defaults filled, typed as the
63
+ * incomplete node it is.
64
+ */
65
+ partial<TType extends ConcreteTypeName<TMap>>(
66
+ typeConstant: TransferTypeConstant<TType> & SingleTypeName<TType>,
67
+ init?: Partial<Omit<Extract<TMap[TType], TransferElement>, '$type'>>
68
+ ): Partial<Extract<TMap[TType], TransferElement>> & TransferTypeConstant<TType>;
69
+ }
70
+
71
+ /**
72
+ * Bind a {@link TransferNodeBuilder} to a grammar's reflection, so a test names
73
+ * only the fields it cares about and a containment field the grammar gains
74
+ * later needs no change at the call site.
75
+ *
76
+ * Defaults come from the reflection's grammar metadata alone, so a derived
77
+ * field the overlay adds is never defaulted, and stays required. An array
78
+ * default is a fresh `[]` per node. An init field named as `undefined` keeps
79
+ * its default, since the init type cannot refuse `undefined` for an optional
80
+ * field and a plain assign would leave the node typed complete without it.
81
+ *
82
+ * The constant's `$type` is written after `init`, because the init type keeps
83
+ * out only a `$type` written in the call: a spread of another node passes the
84
+ * check and would otherwise hand back a node typed as one type and tagged as
85
+ * another.
86
+ */
87
+ export function makeTransferNodeBuilder<TMap, TReflection extends TransferReflection = TransferReflection>(
88
+ reflection: TReflection
89
+ ): TransferNodeBuilder<TMap, TReflection> {
90
+ const build = (typeConstant: TransferTypeConstant, init: object): object => {
91
+ const node: Record<string, unknown> = { $type: typeConstant.$type };
92
+ for (const [name, property] of Object.entries(reflection.getTypeMetaData(typeConstant.$type).properties)) {
93
+ if (property.defaultValue !== undefined) {
94
+ node[name] = Array.isArray(property.defaultValue) ? [...property.defaultValue] : property.defaultValue;
95
+ }
96
+ }
97
+ for (const [name, value] of Object.entries(init)) {
98
+ if (value !== undefined || !Object.hasOwn(node, name)) {
99
+ node[name] = value;
100
+ }
101
+ }
102
+ node.$type = typeConstant.$type;
103
+ return node;
104
+ };
105
+ const partial = (typeConstant: TransferTypeConstant, init: object = {}): object => ({ ...init, $type: typeConstant.$type });
106
+ return Object.assign(build, { partial }) as TransferNodeBuilder<TMap, TReflection>;
107
+ }