@zyno-io/ts-server-foundation 26.930.307 → 26.1003.2243
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/devconsole/assets/{index-DiM3kQs3.js → index-D2vB_Tew.js} +1 -1
- package/dist/devconsole/index.html +1 -1
- package/dist/src/devconsole/generated/devconsole.d.ts +4 -0
- package/dist/src/devconsole/generated/devconsole.d.ts.map +1 -1
- package/dist/src/devconsole/generated/devconsole.js +33 -1
- package/dist/src/devconsole/generated/devconsole.js.map +1 -1
- package/dist/src/http/response.js +1 -1
- package/dist/src/services/mesh-client/mesh-srpc-server.js +1 -1
- package/dist/src/srpc/SrpcClient.d.ts +4 -0
- package/dist/src/srpc/SrpcClient.d.ts.map +1 -1
- package/dist/src/srpc/SrpcClient.js +52 -4
- package/dist/src/srpc/SrpcClient.js.map +1 -1
- package/dist/src/srpc/SrpcServer.d.ts.map +1 -1
- package/dist/src/srpc/SrpcServer.js +41 -2
- package/dist/src/srpc/SrpcServer.js.map +1 -1
- package/dist/src/srpc/observer.js +1 -1
- package/dist/src/srpc/types.d.ts +18 -3
- package/dist/src/srpc/types.d.ts.map +1 -1
- package/dist/src/srpc/types.js +43 -3
- package/dist/src/srpc/types.js.map +1 -1
- package/docs/content/mesh-client.md +10 -0
- package/docs/content/srpc.md +73 -14
- package/package.json +2 -2
- package/resources/proto/devconsole.proto +2 -0
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/srpc/types.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/srpc/types.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAqBA,sEAAsE;AACtE,IAAY,gBAOX;AAPD,WAAY,gBAAgB;IACxB,qEAAe,CAAA;IACf,yDAAS,CAAA;IACT,iEAAa,CAAA;IACb,iEAAa,CAAA;IACb,uDAAQ,CAAA;IACR,uDAAQ,CAAA;AACZ,CAAC,EAPW,gBAAgB,aAAhB,gBAAgB,GAAhB,gBAAgB,QAO3B;AAED,gFAAgF;AACnE,QAAA,2BAA2B,GAAG,KAAK,CAAC;AAwBjD,MAAM,kBAAkB,GAAG,iBAAiB,CAAC;AAC7C,MAAM,iBAAiB,GAAG,iBAAiB,CAAC;AAE5C,gFAAgF;AAChF,0BAAiC,KAA2B;IACxD,OAAO,CACH,KAAK,IAAI,IAAI;QACb,OAAO,KAAK,CAAC,OAAO,KAAK,QAAQ;QACjC,kBAAkB,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC;QACtC,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC;QAC/B,OAAO,KAAK,CAAC,MAAM,KAAK,QAAQ;QAChC,iBAAiB,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC;QACpC,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC;QAC9B,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,UAAU,CAAC;QAClC,KAAK,CAAC,UAAU,IAAI,CAAC;QACrB,KAAK,CAAC,UAAU,IAAI,IAAI,CAC3B,CAAC;AACN,CAAC;;AAgBD,eAAuB,SAAQ,KAAK;IAGrB,WAAW;IAFtB,YACI,OAAe,EACR,WAAqB;QAE5B,KAAK,CAAC,OAAO,CAAC,CAAC;2BAFR,WAAW;QAGlB,IAAI,CAAC,IAAI,GAAG,WAAW,CAAC;IAC5B,CAAC;;CACJ;;;;AAED,mFAAmF;AACnF,4BAAmC,KAAc;IAC7C,MAAM,WAAW,GAAG,KAAK,YAAY,SAAS,CAAC;IAC/C,MAAM,OAAO,GAAG,WAAW,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC5D,MAAM,SAAS,GAAG,WAAW,IAAI,OAAO,KAAK,CAAC,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;IACxG,OAAO;QACH,KAAK,EAAE,OAAO;QACd,GAAG,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC;KACpD,CAAC;AACN,CAAC;AAqBD,MAAM,kBAAkB,GAAG,IAAI,GAAG,CAAC,CAAC,WAAW,EAAE,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,OAAO,EAAE,UAAU,EAAE,qBAAqB,CAAC,CAAC,CAAC;AAE3I,sEAAsE;AACtE,qCAA4C,OAAoB;IAC5D,OAAO,CACH,OAAO,CAAC,UAAU,KAAK,IAAI;QAC3B,OAAO,OAAO,CAAC,SAAS,KAAK,QAAQ;QACrC,OAAO,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC;QAC5B,CAAC,OAAO,CAAC,KAAK;QACd,OAAO,CAAC,KAAK,KAAK,SAAS;QAC3B,CAAC,OAAO,CAAC,SAAS;QAClB,CAAC,OAAO,CAAC,QAAQ;QACjB,CAAC,OAAO,CAAC,mBAAmB;QAC5B,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,kBAAkB,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,KAAK,KAAK,SAAS,CAAC,CACtG,CAAC;AACN,CAAC;AAED,sFAAsF;AACtF,4CAA0E,KAAwB;IAC9F,IAAI,CAAC;QACD,MAAM,OAAO,GAAG,iBAAiB,CAAC,KAAK,EAAE,EAAE,SAAS,EAAE,gBAAgB,EAAE,UAAU,EAAE,IAAI,EAAO,CAAC,CAAC;QACjG,MAAM,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACtC,OAAO,2BAA2B,CAAC,OAAO,CAAC,CAAC;IAChD,CAAC;IAAC,MAAM,CAAC;QACL,OAAO,KAAK,CAAC;IACjB,CAAC;AACL,CAAC;AAED,yFAAyF;AACzF,4BAAmC,OAAoB;IACnD,OAAO,CACH,CAAC,CAAC,OAAO,CAAC,QAAQ;QAClB,CAAC,OAAO,CAAC,UAAU;QACnB,OAAO,CAAC,mBAAmB,KAAK,SAAS;QACzC,OAAO,CAAC,KAAK,KAAK,SAAS;QAC3B,OAAO,CAAC,SAAS,KAAK,SAAS;QAC/B,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,kBAAkB,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,KAAK,KAAK,SAAS,CAAC,CACtG,CAAC;AACN,CAAC;AAED,gFAAgF;AAChF,0BAAiC,OAAoB;IACjD,IAAI,OAAO,CAAC,UAAU;QAAE,OAAO,CAAC,YAAY,CAAC,CAAC;IAC9C,IAAI,OAAO,CAAC,QAAQ;QAAE,OAAO,CAAC,UAAU,CAAC,CAAC;IAC1C,IAAI,OAAO,CAAC,mBAAmB;QAAE,OAAO,CAAC,qBAAqB,CAAC,CAAC;IAChE,IAAI,OAAO,CAAC,KAAK,KAAK,SAAS;QAAE,OAAO,CAAC,OAAO,CAAC,CAAC;IAElD,MAAM,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC;SAChC,MAAM,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,kBAAkB,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,KAAK,KAAK,SAAS,CAAC;SAC7E,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC;IACzB,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;AACxE,CAAC;AAED,kGAAkG;AAClG,4BAAmC,OAAoB;IACnD,IACI,OAAO,CAAC,SAAS;QACjB,OAAO,CAAC,KAAK;QACb,OAAO,CAAC,KAAK,KAAK,SAAS;QAC3B,OAAO,CAAC,SAAS,KAAK,SAAS;QAC/B,OAAO,CAAC,UAAU;QAClB,OAAO,CAAC,QAAQ;QAChB,OAAO,CAAC,mBAAmB;QAE3B,OAAO,KAAK,CAAC;IACjB,MAAM,KAAK,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACxC,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,cAAc,CAAC,IAAK,OAAmC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC;AAC7H,CAAC;;AAqFD,6BAAqC,SAAQ,KAAK;IAC9C,YAAY,QAAgB;QACxB,KAAK,CAAC,0BAA0B,QAAQ,EAAE,CAAC,CAAC;QAC5C,IAAI,CAAC,IAAI,GAAG,yBAAyB,CAAC;IAC1C,CAAC;;CACJ;;;;;AAED,8BAAsC,SAAQ,KAAK;IAC/C,YAAY,QAAgB;QACxB,KAAK,CAAC,oCAAoC,QAAQ,EAAE,CAAC,CAAC;QACtD,IAAI,CAAC,IAAI,GAAG,0BAA0B,CAAC;IAC3C,CAAC;;CACJ;;;;;AAED,+BAAuC,SAAQ,KAAK;IAChD,YAAY,QAAgB,EAAE,KAAe;QACzC,KAAK,CAAC,qCAAqC,QAAQ,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;QAClE,IAAI,CAAC,IAAI,GAAG,2BAA2B,CAAC;IAC5C,CAAC;;CACJ;;;;;AAED,oCAA4C,SAAQ,KAAK;IACrD,YAAY,QAAgB,EAAE,KAAe;QACzC,KAAK,CAAC,8CAA8C,QAAQ,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;QAC3E,IAAI,CAAC,IAAI,GAAG,gCAAgC,CAAC;IACjD,CAAC;;CACJ;;;;;AAED,2BAAmC,SAAQ,KAAK;IAC5C,YAAY,OAAe;QACvB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,uBAAuB,CAAC;IACxC,CAAC;;CACJ;;;;;AAED,iCAAyC,SAAQ,KAAK;IAClD,YAAY,OAAO,GAAG,sCAAsC;QACxD,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,6BAA6B,CAAC;IAC9C,CAAC;;CACJ;;;;;AAED,2BAAmC,SAAQ,KAAK;IAC5C,YAAY,OAAO,GAAG,uCAAuC;QACzD,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,uBAAuB,CAAC;IACxC,CAAC;;CACJ;;;;;AAED,2BAAmC,SAAQ,KAAK;IAC5C,YAAY,OAAO,GAAG,4BAA4B;QAC9C,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,uBAAuB,CAAC;IACxC,CAAC;;CACJ;;;;AAWD,mCAAmD,OAA8C;IAC7F,OAAO,OAAO,OAAO,KAAK,UAAU,IAAI,OAAQ,OAAgD,CAAC,SAAS,EAAE,MAAM,KAAK,UAAU,CAAC;AACtI,CAAC;AAED,2BAAqC,KAAwB,EAAE,OAAU;IACrE,MAAM,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IACtC,MAAM,KAAK,GAAG,QAAQ,IAAI,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC;IAC/D,OAAO,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AAC/D,CAAC"}
|
|
@@ -338,6 +338,16 @@ new MeshSrpcServer(options: ISrpcServerOptions & MeshSrpcServerOptions)
|
|
|
338
338
|
|
|
339
339
|
`MeshSrpcServerOptions`:
|
|
340
340
|
|
|
341
|
+
The inherited `ISrpcServerOptions.disconnectOnRequestTimeout` policy defaults
|
|
342
|
+
to `true` for protocol-v4 streams; v1–v3 are unaffected. The physical client
|
|
343
|
+
owner revokes an unacknowledged request at its existing deadline, with normal
|
|
344
|
+
registry cleanup, when its remaining timeout budget exceeds the client's
|
|
345
|
+
three-second receipt window. Shorter calls time out without judging liveness. An acknowledged handler may time out without losing its
|
|
346
|
+
session. Local, forwarded typed, and service calls share this policy, which
|
|
347
|
+
survives requester shutdown. A routing or peer-link timeout alone does not
|
|
348
|
+
revoke the endpoint. See [Errors And Timeouts](./srpc#errors-and-timeouts) for
|
|
349
|
+
receipt and delivery semantics.
|
|
350
|
+
|
|
341
351
|
| Option | Type | Description |
|
|
342
352
|
| ------------------------- | -------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
|
|
343
353
|
| `meshKey` | `string` | Mesh key |
|
package/docs/content/srpc.md
CHANGED
|
@@ -165,13 +165,14 @@ server.registerDisconnectHandler((stream, cause) => {
|
|
|
165
165
|
|
|
166
166
|
Server options:
|
|
167
167
|
|
|
168
|
-
| Option | Description
|
|
169
|
-
| --------------- |
|
|
170
|
-
| `logger` | Logger with `info`, `warn`, `error`, and `debug` methods.
|
|
171
|
-
| `clientMessage` | Generated codec for client-to-server envelope messages.
|
|
172
|
-
| `serverMessage` | Generated codec for server-to-client envelope messages.
|
|
173
|
-
| `wsPath` | WebSocket path.
|
|
174
|
-
| `httpServer` | Optional Node HTTP server for direct upgrade registration.
|
|
168
|
+
| Option | Description |
|
|
169
|
+
| --------------- | ------------------------------------------------------------------------------------------------ |
|
|
170
|
+
| `logger` | Logger with `info`, `warn`, `error`, and `debug` methods. |
|
|
171
|
+
| `clientMessage` | Generated codec for client-to-server envelope messages. |
|
|
172
|
+
| `serverMessage` | Generated codec for server-to-client envelope messages. |
|
|
173
|
+
| `wsPath` | WebSocket path. |
|
|
174
|
+
| `httpServer` | Optional Node HTTP server for direct upgrade registration. |
|
|
175
|
+
| `logTraffic` | Optional [traffic logging](#traffic-logging); heartbeats are excluded unless explicitly enabled. |
|
|
175
176
|
|
|
176
177
|
Handlers may also be zero-argument classes with a `handle(stream, data)` method. A new class instance is created for each request; SRPC does not resolve handler classes through application DI.
|
|
177
178
|
|
|
@@ -226,13 +227,14 @@ client.disconnect();
|
|
|
226
227
|
|
|
227
228
|
Client options:
|
|
228
229
|
|
|
229
|
-
| Option | Default | Description
|
|
230
|
-
| ----------------- | ------- |
|
|
231
|
-
| `enableReconnect` | `true` | Reconnects after unexpected disconnects.
|
|
230
|
+
| Option | Default | Description |
|
|
231
|
+
| ----------------- | ------- | --------------------------------------------------------------------------------------- |
|
|
232
|
+
| `enableReconnect` | `true` | Reconnects after unexpected disconnects. |
|
|
233
|
+
| `logTraffic` | `false` | [Traffic logging](#traffic-logging); heartbeats are excluded unless explicitly enabled. |
|
|
232
234
|
|
|
233
235
|
The exported `SrpcClientOptions` type describes this object. `connect({ supersede?: boolean })` controls only that connection attempt and is separate from the constructor options.
|
|
234
236
|
|
|
235
|
-
Protocol-v2 and protocol-
|
|
237
|
+
Protocol-v2, protocol-v3, and protocol-v4 connections reject a duplicate `clientId` unless `connect({ supersede: true })` is used. Legacy protocol-v1 connections retain replacement behavior: a later connection with the same `clientId` silently supersedes the existing stream.
|
|
236
238
|
|
|
237
239
|
The optional `PingPong.type` enum distinguishes handshake messages from client pings and server pongs. Generated TypeScript codecs represent it as a numeric `PingPongType` enum with the prefixed names shown above and an optional `type` property (`undefined` when absent). The library exports matching numeric values as `SrpcPingPongType`.
|
|
238
240
|
|
|
@@ -255,7 +257,7 @@ This is wire-compatible with empty legacy `PingPong` messages. Old protobuf deco
|
|
|
255
257
|
|
|
256
258
|
Clients sign connection metadata with HMAC-SHA256. New clients send `pv=3`, `appv`, `ts`, `nonce`, `aud`, `id`, `cid`, `signature`, optional `cap` capabilities and `supersede`, and custom metadata as ordinary WebSocket query parameters. Every query parameter other than those transport fields becomes `stream.meta`. The canonical signature covers the request path, audience, protocol version, capabilities, and normalized metadata.
|
|
257
259
|
|
|
258
|
-
Servers require an explicit `pv` by default, but accept `_v` when `pv` is absent for compatibility. The protocol version selects the authentication format: v1/v2 use the legacy HMAC format and v3
|
|
260
|
+
Servers require an explicit `pv` by default, but accept `_v` when `pv` is absent for compatibility. The protocol version selects the authentication format: v1/v2 use the legacy HMAC format and v3/v4 use the canonical HMAC format. Legacy `_supersede` and `m--<key>` metadata are accepted; `_supersede` is used only when `supersede` is absent, and `m--<key>` is normalized to `<key>` in `stream.meta` with unprefixed metadata taking precedence. Set `defaultUnspecifiedProtocolVersion` to `1`, `2`, or `3` only while migrating an unmarked client. Protocol v2 continues to use its original signature (`1`, `appv`, `ts`, `id`, `cid`), whose stream ID is consumed once for replay protection and whose capability field is ignored. Clients use v3 by default. Set `SrpcClientOptions.protocolVersion: 4` after both envelope codecs and the server support receipts. The canonical signature binds the advertised version. Deploy servers before clients: v4 requires a server that recognizes v4. An explicit `pv=1` always selects v1 behavior; use it only while supporting a legacy client that intentionally relies on same-`clientId` replacement.
|
|
259
261
|
|
|
260
262
|
By default the server verifies signatures with `SRPC_AUTH_SECRET`. Provide per-client secrets with:
|
|
261
263
|
|
|
@@ -300,7 +302,7 @@ Connected streams expose metadata:
|
|
|
300
302
|
|
|
301
303
|
The exported `SrpcStream<TMeta>` type describes these server-side streams. It also exposes the underlying WebSocket and request queue through `$ws` and `$queue`; treat those fields as low-level protocol surfaces and prefer `SrpcServer.invoke()`, handlers, and `SrpcByteStream` for application work.
|
|
302
304
|
|
|
303
|
-
Established-stream disconnect callbacks receive `disconnect`, `supersede`, `timeout`, or `badArg`. A rejected protocol-v2 or protocol-
|
|
305
|
+
Established-stream disconnect callbacks receive `disconnect`, `supersede`, `timeout`, or `badArg`. A rejected protocol-v2, protocol-v3, or protocol-v4 duplicate closes with the `conflict` wire cause and rejects the connecting client with `SrpcConflictError` before activation, so connection and disconnect callbacks do not run for that rejected stream. `supersede` identifies a replaced connection, `timeout` identifies ping inactivity or an unacknowledged v4 request deadline, and `badArg` identifies malformed or out-of-sequence messages. Outstanding invocations reject when their stream disconnects.
|
|
304
306
|
|
|
305
307
|
## Byte Streams
|
|
306
308
|
|
|
@@ -346,7 +348,7 @@ Observers receive connection entries with `{ type, stream, at }`, disconnection
|
|
|
346
348
|
|
|
347
349
|
## Traffic Logging
|
|
348
350
|
|
|
349
|
-
Set `logTraffic: true` on an `SrpcServer` or `SrpcClient` to log
|
|
351
|
+
Set `logTraffic: true` on an `SrpcServer` or `SrpcClient` to log inbound and outbound envelopes at info level with their direction and message type, excluding `pingPong`-only heartbeat envelopes. Heartbeat logging defaults to off, including when body logging is enabled. To also log the decoded body, opt in explicitly:
|
|
350
352
|
|
|
351
353
|
```ts
|
|
352
354
|
logTraffic: {
|
|
@@ -354,6 +356,17 @@ logTraffic: {
|
|
|
354
356
|
}
|
|
355
357
|
```
|
|
356
358
|
|
|
359
|
+
To include heartbeat envelopes, use `logTraffic: { pingPong: true }`, or combine both options:
|
|
360
|
+
|
|
361
|
+
```ts
|
|
362
|
+
logTraffic: {
|
|
363
|
+
pingPong: true,
|
|
364
|
+
bodies: true
|
|
365
|
+
}
|
|
366
|
+
```
|
|
367
|
+
|
|
368
|
+
Only envelopes whose sole payload is `pingPong` are suppressed, including heartbeat pongs with `reply: true`. Envelope metadata such as `requestId` and `trace`, and undefined fields from generated codecs, do not prevent heartbeat suppression. Envelopes containing `pingPong` alongside another payload, `byteStreamOperation`, or a defined `error` or `userError` remain logged so other traffic is visible, including with codecs that allow multiple payload fields. These options affect only traffic logs; heartbeat handling, activation, and observer notifications are unchanged.
|
|
369
|
+
|
|
357
370
|
Traffic bodies can contain application data, so enable body logging only where that data is appropriate for the configured log sink and retention policy.
|
|
358
371
|
|
|
359
372
|
## Observability
|
|
@@ -386,3 +399,49 @@ and byte-stream frames as well as inbound frames. A definitive WebSocket send
|
|
|
386
399
|
throw or callback error also revokes before closing. Normal graceful
|
|
387
400
|
disconnects retain their ordinary close-event semantics and carry the supplied
|
|
388
401
|
bounded close reason.
|
|
402
|
+
|
|
403
|
+
Protocol v4 adds receipt acknowledgments: `{ requestId, requestAck: true }`
|
|
404
|
+
contains no reply, error, or application payload. Servers acknowledge admitted
|
|
405
|
+
requests before dispatch. Clients race their final response against a three-second
|
|
406
|
+
receipt delay: a result or error within that window suppresses the receipt;
|
|
407
|
+
otherwise the client sends one receipt while the handler continues. Pending
|
|
408
|
+
receipts are canceled when the connection ends. A receipt confirms transport
|
|
409
|
+
admission, not authorization, success, or completion. Replies and errors continue
|
|
410
|
+
to use `reply: true`. Notifications receive no acknowledgment.
|
|
411
|
+
|
|
412
|
+
For server-to-client calls, `disconnectOnRequestTimeout` defaults to `true`,
|
|
413
|
+
but applies only to explicitly negotiated v4 calls whose timeout budget exceeds
|
|
414
|
+
the three-second receipt window. Shorter calls still time out normally, but cannot
|
|
415
|
+
establish that a client has missed its receipt deadline. For eligible calls, if the
|
|
416
|
+
RPC deadline expires without either a receipt or a final response, the existing timer
|
|
417
|
+
synchronously revokes the exact stream with cause `timeout` and close code
|
|
418
|
+
`4003`, before the close handshake or inactivity timer completes. Normal
|
|
419
|
+
cleanup rejects other pending calls and runs disconnect callbacks once. A
|
|
420
|
+
replacement generation is preserved. Setting the option to `false` disables
|
|
421
|
+
this policy; v1–v3 retain their prior timeout behavior even when it is enabled.
|
|
422
|
+
|
|
423
|
+
A receipt does not resolve a call, extend its deadline, release its queue
|
|
424
|
+
accounting, or request a retry. If an acknowledged handler takes too long,
|
|
425
|
+
`invoke()` still rejects at its ordinary deadline but the session remains
|
|
426
|
+
usable. Late receipts and results for expired calls are ignored for the normal
|
|
427
|
+
bounded tombstone period. A final response before receipt also completes the
|
|
428
|
+
call normally.
|
|
429
|
+
|
|
430
|
+
Both envelope codecs must preserve `requestAck` before a client advertises
|
|
431
|
+
v4. For protobuf, add `bool requestAck` (or `optional bool requestAck`) using an
|
|
432
|
+
unused field number in each message container and regenerate bindings. TSF's
|
|
433
|
+
DevConsole schema and the RMM bridge schema reserve field 9 for this purpose.
|
|
434
|
+
A v4 client or server refuses negotiation when its codecs drop the field.
|
|
435
|
+
`SrpcClient` stays on v3 by default so upgrading TSF alone does not advertise a
|
|
436
|
+
wire version unsupported by an existing server or codec. Versionless clients
|
|
437
|
+
cannot acquire v4 through `defaultUnspecifiedProtocolVersion`.
|
|
438
|
+
|
|
439
|
+
The policy also applies to `MeshSrpcServer`: the physical connection owner
|
|
440
|
+
tracks receipts and enforces its existing local RPC deadline. Local, forwarded
|
|
441
|
+
typed, and service calls share this path. Owner-side expiry continues if the
|
|
442
|
+
requesting node disappears. Routing or peer-link deadlines alone do not revoke
|
|
443
|
+
the client, and mesh registry removal uses the existing ownership-safe cleanup.
|
|
444
|
+
|
|
445
|
+
Delivery remains indeterminate on timeout, with or without a receipt. A
|
|
446
|
+
receipt does not prove an operation ran, and a missing receipt does not prove
|
|
447
|
+
it did not. Commands are not automatically retried.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@zyno-io/ts-server-foundation",
|
|
3
|
-
"version": "26.
|
|
3
|
+
"version": "26.1003.2243",
|
|
4
4
|
"description": "TypeScript server foundation with reflected type metadata",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"bin": {
|
|
@@ -92,7 +92,7 @@
|
|
|
92
92
|
"@ttsc/graph": "^0.30.1",
|
|
93
93
|
"@types/ws": "^8.18.1",
|
|
94
94
|
"@zyno-io/config": "^1.14.0",
|
|
95
|
-
"@zyno-io/ts-reflection": "26.
|
|
95
|
+
"@zyno-io/ts-reflection": "26.1003.2243",
|
|
96
96
|
"bcrypt": "^6.0.0",
|
|
97
97
|
"bullmq": "^6.3.4",
|
|
98
98
|
"busboy": "^1.6.0",
|
|
@@ -223,6 +223,7 @@ message DevConsoleClientMessage {
|
|
|
223
223
|
optional string error = 3;
|
|
224
224
|
optional bool userError = 4;
|
|
225
225
|
optional TraceContext trace = 5;
|
|
226
|
+
optional bool requestAck = 9; // Transport v4 receipt; reply remains false.
|
|
226
227
|
|
|
227
228
|
oneof request {
|
|
228
229
|
// framework
|
|
@@ -261,6 +262,7 @@ message DevConsoleServerMessage {
|
|
|
261
262
|
optional string error = 3;
|
|
262
263
|
optional bool userError = 4;
|
|
263
264
|
optional TraceContext trace = 5;
|
|
265
|
+
optional bool requestAck = 9; // Transport v4 receipt; reply remains false.
|
|
264
266
|
|
|
265
267
|
oneof response {
|
|
266
268
|
// framework
|