velocious 1.0.726 → 1.0.727

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 (71) hide show
  1. package/build/configuration-types.js +1 -1
  2. package/build/configuration.js +17 -2
  3. package/build/database/advisory-lock-lock-server-backend.js +30 -24
  4. package/build/database/advisory-lock-lock-server-embedded-client.js +74 -0
  5. package/build/database/advisory-lock-lock-server-engine.js +544 -0
  6. package/build/database/advisory-lock-lock-server-local-client.js +260 -0
  7. package/build/database/advisory-lock-lock-server-socket-path.js +17 -0
  8. package/build/database/advisory-lock-lock-server-transport.js +30 -0
  9. package/build/database/record/auditing.js +89 -11
  10. package/build/database/record/index.js +1 -1
  11. package/build/environment-handlers/base.js +50 -9
  12. package/build/environment-handlers/node/advisory-lock-lock-server-local-server.js +206 -0
  13. package/build/environment-handlers/node.js +30 -3
  14. package/build/http-server/server-lock.js +29 -16
  15. package/build/src/configuration-types.d.ts +3 -1
  16. package/build/src/configuration-types.d.ts.map +1 -1
  17. package/build/src/configuration-types.js +2 -2
  18. package/build/src/configuration.d.ts +3 -1
  19. package/build/src/configuration.d.ts.map +1 -1
  20. package/build/src/configuration.js +18 -3
  21. package/build/src/database/advisory-lock-lock-server-backend.d.ts +10 -3
  22. package/build/src/database/advisory-lock-lock-server-backend.d.ts.map +1 -1
  23. package/build/src/database/advisory-lock-lock-server-backend.js +25 -22
  24. package/build/src/database/advisory-lock-lock-server-embedded-client.d.ts +24 -0
  25. package/build/src/database/advisory-lock-lock-server-embedded-client.d.ts.map +1 -0
  26. package/build/src/database/advisory-lock-lock-server-embedded-client.js +64 -0
  27. package/build/src/database/advisory-lock-lock-server-engine.d.ts +285 -0
  28. package/build/src/database/advisory-lock-lock-server-engine.d.ts.map +1 -0
  29. package/build/src/database/advisory-lock-lock-server-engine.js +460 -0
  30. package/build/src/database/advisory-lock-lock-server-local-client.d.ts +114 -0
  31. package/build/src/database/advisory-lock-lock-server-local-client.d.ts.map +1 -0
  32. package/build/src/database/advisory-lock-lock-server-local-client.js +227 -0
  33. package/build/src/database/advisory-lock-lock-server-socket-path.d.ts +9 -0
  34. package/build/src/database/advisory-lock-lock-server-socket-path.d.ts.map +1 -0
  35. package/build/src/database/advisory-lock-lock-server-socket-path.js +16 -0
  36. package/build/src/database/advisory-lock-lock-server-transport.d.ts +18 -0
  37. package/build/src/database/advisory-lock-lock-server-transport.d.ts.map +1 -0
  38. package/build/src/database/advisory-lock-lock-server-transport.js +27 -0
  39. package/build/src/database/record/auditing.d.ts +14 -4
  40. package/build/src/database/record/auditing.d.ts.map +1 -1
  41. package/build/src/database/record/auditing.js +77 -12
  42. package/build/src/database/record/index.d.ts +4 -2
  43. package/build/src/database/record/index.d.ts.map +1 -1
  44. package/build/src/database/record/index.js +2 -2
  45. package/build/src/environment-handlers/base.d.ts +86 -7
  46. package/build/src/environment-handlers/base.d.ts.map +1 -1
  47. package/build/src/environment-handlers/base.js +48 -9
  48. package/build/src/environment-handlers/node/advisory-lock-lock-server-local-server.d.ts +2 -0
  49. package/build/src/environment-handlers/node/advisory-lock-lock-server-local-server.d.ts.map +1 -0
  50. package/build/src/environment-handlers/node/advisory-lock-lock-server-local-server.js +179 -0
  51. package/build/src/environment-handlers/node.d.ts +10 -4
  52. package/build/src/environment-handlers/node.d.ts.map +1 -1
  53. package/build/src/environment-handlers/node.js +30 -4
  54. package/build/src/http-server/server-lock.d.ts +22 -11
  55. package/build/src/http-server/server-lock.d.ts.map +1 -1
  56. package/build/src/http-server/server-lock.js +30 -17
  57. package/package.json +1 -1
  58. package/src/configuration-types.js +1 -1
  59. package/src/configuration.js +17 -2
  60. package/src/database/advisory-lock-lock-server-backend.js +30 -24
  61. package/src/database/advisory-lock-lock-server-embedded-client.js +74 -0
  62. package/src/database/advisory-lock-lock-server-engine.js +544 -0
  63. package/src/database/advisory-lock-lock-server-local-client.js +260 -0
  64. package/src/database/advisory-lock-lock-server-socket-path.js +17 -0
  65. package/src/database/advisory-lock-lock-server-transport.js +30 -0
  66. package/src/database/record/auditing.js +89 -11
  67. package/src/database/record/index.js +1 -1
  68. package/src/environment-handlers/base.js +50 -9
  69. package/src/environment-handlers/node/advisory-lock-lock-server-local-server.js +206 -0
  70. package/src/environment-handlers/node.js +30 -3
  71. package/src/http-server/server-lock.js +29 -16
@@ -882,7 +882,7 @@
882
882
  * behavior; the file backend is disabled by default and only selectable by
883
883
  * explicit configuration.
884
884
  * @typedef {object} AdvisoryLocksConfiguration
885
- * @property {{file?: {directory?: string, enabled?: boolean, leaseMs?: number, renewIntervalMs?: number}, lockServer?: {authToken?: string, connectTimeoutMs?: number, enabled?: boolean, host?: string, leaseMs?: number, port?: number, reprobeCooldownMs?: number, url?: string}}} [backends] - Backend enablement. `file.enabled` defaults to false; enabling it is the deployment's explicit single-host declaration. `lockServer` defaults to enabled when a host/port/url or the `VELOCIOUS_LOCK_SERVER_HOST`/`_PORT` env pair is configured.
885
+ * @property {{file?: {directory?: string, enabled?: boolean, leaseMs?: number, renewIntervalMs?: number}, lockServer?: {authToken?: string, connectTimeoutMs?: number, enabled?: boolean, host?: string, leaseMs?: number, mode?: "embedded" | "external" | "local", port?: number, reprobeCooldownMs?: number, socketPath?: string, url?: string}}} [backends] - Backend enablement. `file.enabled` defaults to false; enabling it is the deployment's explicit single-host declaration. `lockServer` defaults to enabled when a host/port/url or the `VELOCIOUS_LOCK_SERVER_HOST`/`_PORT` env pair is configured.
886
886
  * @property {import("./database/advisory-lock-backend-policy.js").AdvisoryLockBackendPolicyEntry[]} [policy] - Per-lock-name minimum/allowed/preferred tier rules (design §5).
887
887
  */
888
888
 
@@ -4234,7 +4234,7 @@ export default class VelociousConfiguration {
4234
4234
  * Full backward compatibility: an app that configures nothing gets today's
4235
4235
  * driver-native-only behavior — the file backend is **disabled by default**
4236
4236
  * and only ever selectable by explicit configuration.
4237
- * @returns {{backends: {file: {directory?: string, enabled: boolean, leaseMs: number, renewIntervalMs: number}, lockServer: {authToken: string, connectTimeoutMs: number, enabled: boolean, leaseMs: number, reprobeCooldownMs: number, url: string}}, policy: import("./database/advisory-lock-backend-policy.js").AdvisoryLockBackendPolicyEntry[]}} - Advisory-lock configuration with defaults applied.
4237
+ * @returns {{backends: {file: {directory?: string, enabled: boolean, leaseMs: number, renewIntervalMs: number}, lockServer: {authToken: string, connectTimeoutMs: number, enabled: boolean, leaseMs: number, mode: "embedded" | "external" | "local", reprobeCooldownMs: number, socketPath: string, url: string}}, policy: import("./database/advisory-lock-backend-policy.js").AdvisoryLockBackendPolicyEntry[]}} - Advisory-lock configuration with defaults applied.
4238
4238
  */
4239
4239
  getAdvisoryLockConfig() {
4240
4240
  const configured = this._advisoryLocks || {}
@@ -4249,6 +4249,15 @@ export default class VelociousConfiguration {
4249
4249
  : (typeof envPort === "number" && Number.isFinite(envPort) ? envPort : 3006)
4250
4250
  const lockServerUrl = lockServerConfigured.url
4251
4251
  || `ws://${lockServerHost || "127.0.0.1"}:${lockServerPort}/websocket`
4252
+ // STC-715: `embedded` runs the lock-server engine in this process, `local`
4253
+ // spawns it as a child over stdio JSON-lines. Both default `enabled` to true
4254
+ // when the mode is named explicitly — no host/port/url required. `external`
4255
+ // (the default) keeps today's rule: enabled only via url/host/port config
4256
+ // or the env pair, so an app that configures nothing is unchanged.
4257
+ const configuredMode = lockServerConfigured.mode
4258
+ const lockServerMode = configuredMode === "embedded" || configuredMode === "local" || configuredMode === "external"
4259
+ ? configuredMode
4260
+ : "external"
4252
4261
 
4253
4262
  return {
4254
4263
  backends: {
@@ -4265,9 +4274,13 @@ export default class VelociousConfiguration {
4265
4274
  connectTimeoutMs: typeof lockServerConfigured.connectTimeoutMs === "number" ? lockServerConfigured.connectTimeoutMs : 3000,
4266
4275
  enabled: typeof lockServerConfigured.enabled === "boolean"
4267
4276
  ? lockServerConfigured.enabled
4268
- : Boolean(lockServerConfigured.url || lockServerConfigured.host || envHost || typeof lockServerConfigured.port === "number" || envPortRaw),
4277
+ : lockServerMode === "external"
4278
+ ? Boolean(lockServerConfigured.url || lockServerConfigured.host || envHost || typeof lockServerConfigured.port === "number" || envPortRaw)
4279
+ : true,
4269
4280
  leaseMs: typeof lockServerConfigured.leaseMs === "number" ? lockServerConfigured.leaseMs : 30_000,
4281
+ mode: lockServerMode,
4270
4282
  reprobeCooldownMs: typeof lockServerConfigured.reprobeCooldownMs === "number" ? lockServerConfigured.reprobeCooldownMs : 5000,
4283
+ socketPath: typeof lockServerConfigured.socketPath === "string" ? lockServerConfigured.socketPath : "",
4271
4284
  url: lockServerUrl
4272
4285
  }
4273
4286
  },
@@ -4337,11 +4350,13 @@ export default class VelociousConfiguration {
4337
4350
  authToken: config.backends.lockServer.authToken,
4338
4351
  connectTimeoutMs: config.backends.lockServer.connectTimeoutMs,
4339
4352
  leaseMs: config.backends.lockServer.leaseMs,
4353
+ mode: config.backends.lockServer.mode,
4340
4354
  onError: (/** @type {Error} */ error) => {
4341
4355
  this.getErrorEvents().emit("framework-error", {context: "advisory-lock-lock-server", error})
4342
4356
  this.getErrorEvents().emit("all-error", {context: "advisory-lock-lock-server", error, errorType: "framework-error"})
4343
4357
  },
4344
4358
  reprobeCooldownMs: config.backends.lockServer.reprobeCooldownMs,
4359
+ socketPath: config.backends.lockServer.socketPath,
4345
4360
  url: config.backends.lockServer.url
4346
4361
  })
4347
4362
 
@@ -1,8 +1,5 @@
1
1
  // @ts-check
2
2
 
3
- import WebSocket from "ws"
4
-
5
- import VelociousWebsocketClient from "../http-client/websocket-client.js"
6
3
  import {AdvisoryLockServiceUnavailableError} from "./advisory-lock-errors.js"
7
4
 
8
5
  /**
@@ -40,6 +37,13 @@ const LOCK_SERVER_CONNECTION_TYPE = "lock"
40
37
  *
41
38
  * Unavailability is cached for `reprobeCooldownMs` so a flapping server cannot
42
39
  * turn every waiting caller into a connection attempt (design §2).
40
+ *
41
+ * The transport is injected through `clientFactory` (STC-715): this module no
42
+ * longer imports `ws` itself, so it is safe for browser/Expo bundles. The Node
43
+ * handler injects the websocket transport for `external` mode, the spawned
44
+ * stdio/UDS client for `local` mode, and the in-process engine client for
45
+ * `embedded` mode — all three speak the same protocol surface through this
46
+ * adapter.
43
47
  */
44
48
  export default class AdvisoryLockLockServerBackend {
45
49
  /**
@@ -47,14 +51,14 @@ export default class AdvisoryLockLockServerBackend {
47
51
  * constructing this object never performs I/O.
48
52
  * @param {object} args - Backend options.
49
53
  * @param {string} [args.authToken] - Shared secret; the server fails closed without a matching token.
50
- * @param {(args: {authToken: string, url: string}) => LockServerClientLike} [args.clientFactory] - Transport factory (tests inject a fake).
54
+ * @param {(args: {authToken: string, url: string}) => LockServerClientLike} args.clientFactory - Transport factory injected by the environment handler (websocket for external mode, spawned child for local mode, in-process engine for embedded mode).
51
55
  * @param {number} [args.connectTimeoutMs] - Handshake timeout.
52
56
  * @param {number} [args.leaseMs] - Lease duration used until the server advertises its own.
53
57
  * @param {(error: Error) => void} [args.onError] - Async error reporter.
54
58
  * @param {number} [args.reprobeCooldownMs] - How long an unavailable server is not re-probed.
55
- * @param {string} args.url - Lock-server websocket URL.
59
+ * @param {string} args.url - Lock-server endpoint (websocket URL for external mode; informational for embedded/local modes).
56
60
  */
57
- constructor({authToken = "", clientFactory = defaultClientFactory, connectTimeoutMs = 3000, leaseMs = 30_000, onError, reprobeCooldownMs = 5000, url}) {
61
+ constructor({authToken = "", clientFactory, connectTimeoutMs = 3000, leaseMs = 30_000, onError, reprobeCooldownMs = 5000, url}) {
58
62
  this.url = url
59
63
  this.authToken = authToken
60
64
  this.clientFactory = clientFactory
@@ -117,6 +121,8 @@ export default class AdvisoryLockLockServerBackend {
117
121
  this.status.lastProbeAt = new Date().toISOString()
118
122
 
119
123
  try {
124
+ if (typeof this.clientFactory !== "function") throw new Error("The lock-server backend requires a clientFactory transport from the environment handler")
125
+
120
126
  const client = this.clientFactory({authToken: this.authToken, url: this.url})
121
127
 
122
128
  this.client = client
@@ -350,6 +356,24 @@ export default class AdvisoryLockLockServerBackend {
350
356
  return
351
357
  }
352
358
 
359
+ // Transport-side death (spawned child exited, embedded engine closed):
360
+ // fail every pending request now and start the re-probe cooldown instead
361
+ // of letting each request burn its own timeout. This is the crash-detection
362
+ // half of the local-mode lifecycle (STC-715); the cooldown is the restart
363
+ // backoff and the next acquisition spawns the child again.
364
+ if (body.type === "response" && body.transportClosed === true) {
365
+ const error = new AdvisoryLockServiceUnavailableError(
366
+ `Lock server ${this.url} transport closed: ${String(body.error || "transport closed")}`,
367
+ {lockName: "", reason: "transport-closed"}
368
+ )
369
+
370
+ this.markUnavailable(error)
371
+ this.teardown()
372
+ this.reportError(error)
373
+
374
+ return
375
+ }
376
+
353
377
  if (body.type === "lost") {
354
378
  const name = String(body.name ?? "")
355
379
  const hold = this.holds.get(name)
@@ -547,21 +571,3 @@ export default class AdvisoryLockLockServerBackend {
547
571
  if (this.onError) this.onError(normalized)
548
572
  }
549
573
  }
550
-
551
- /**
552
- * Default transport factory: the framework websocket client with the Node
553
- * `ws` implementation bound explicitly (no global mutation).
554
- * @param {{authToken: string, url: string}} args - Connection args.
555
- * @returns {LockServerClientLike} - Websocket client.
556
- */
557
- function defaultClientFactory({url}) {
558
- // Node's global WebSocket is not guaranteed to exist, so the implementation is
559
- // bound explicitly instead of mutating `globalThis`.
560
- const webSocketImplementation = /** @type {typeof globalThis.WebSocket} */ (/** @type {unknown} */ (WebSocket))
561
-
562
- return /** @type {LockServerClientLike} */ (/** @type {unknown} */ (new VelociousWebsocketClient({
563
- heartbeatIntervalMs: 10_000,
564
- url,
565
- webSocketImplementation
566
- })))
567
- }
@@ -0,0 +1,74 @@
1
+ // @ts-check
2
+
3
+ import AdvisoryLockLockServerEngine from "./advisory-lock-lock-server-engine.js"
4
+
5
+ /**
6
+ * @typedef {import("./advisory-lock-lock-server-backend.js").LockServerClientLike} LockServerClientLike
7
+ * @typedef {import("./advisory-lock-lock-server-backend.js").LockServerConnectionLike} LockServerConnectionLike
8
+ */
9
+
10
+ /**
11
+ * In-process transport factory for the `embedded` lock-server mode (STC-715).
12
+ * It wires the lock-server backend adapter to an `AdvisoryLockLockServerEngine`
13
+ * living in the same process over plain function calls — no sockets, no `ws`,
14
+ * no Node builtins — so browser/Expo bundles can run the lock-server tier.
15
+ *
16
+ * The engine mints the holder id for the connection exactly like the external
17
+ * daemon does over the websocket transport, so the adapter's lease/epoch/
18
+ * fencing behavior is identical across modes.
19
+ * @param {AdvisoryLockLockServerEngine} engine - Engine this transport connects to.
20
+ * @returns {(args: {authToken: string, url: string}) => LockServerClientLike} - Client factory for the backend adapter.
21
+ */
22
+ export function createEmbeddedLockServerClientFactory(engine) {
23
+ return () => {
24
+ /** @type {string | null} */
25
+ let connectionId = null
26
+ /** @type {((body: Record<string, unknown>) => void) | null} */
27
+ let onMessage = null
28
+
29
+ /** @type {LockServerClientLike} */
30
+ const client = {
31
+ async connect() {},
32
+
33
+ close() {
34
+ if (connectionId !== null) engine.connectionClose(connectionId)
35
+
36
+ connectionId = null
37
+ },
38
+
39
+ openConnection(_type, {onMessage: messageHandler}) {
40
+ onMessage = messageHandler
41
+
42
+ connectionId = engine.openConnection({
43
+ onClose: () => {
44
+ onMessage?.({error: "Embedded lock server engine is closed", status: "transport-closed", transportClosed: true, type: "response"})
45
+ },
46
+ send: (/** @type {Record<string, unknown>} */ body) => messageHandler(body)
47
+ })
48
+
49
+ // The engine answers the connection-open frame with a hello-ack, just
50
+ // like the external daemon does after verifying auth and protocol.
51
+ queueMicrotask(() => messageHandler({leaseMs: engine.leaseMs, protocolVersion: 2, type: "hello-ack"}))
52
+
53
+ /** @type {LockServerConnectionLike} */
54
+ const connection = {
55
+ close: () => {
56
+ if (connectionId !== null) engine.connectionClose(connectionId)
57
+
58
+ connectionId = null
59
+ },
60
+ ready: Promise.resolve(),
61
+ sendMessage: (/** @type {Record<string, unknown>} */ body) => {
62
+ if (connectionId === null) throw new Error("Embedded lock server connection is not open")
63
+
64
+ engine.handleMessage(connectionId, body)
65
+ }
66
+ }
67
+
68
+ return connection
69
+ }
70
+ }
71
+
72
+ return client
73
+ }
74
+ }