socketduct 0.1.18 → 0.1.19

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.
@@ -1,17 +1,21 @@
1
1
  /* eslint-disable jsdoc/escape-inline-tags, jsdoc/require-param, jsdoc/require-returns */
2
2
  import assert from "node:assert/strict"
3
- import {mkdtemp, readdir, rm} from "node:fs/promises"
3
+ import {mkdtemp, readFile, readdir, rm, stat, writeFile} from "node:fs/promises"
4
4
  import {connect as connectTcp, createServer} from "node:net"
5
5
  import {tmpdir} from "node:os"
6
6
  import {join} from "node:path"
7
7
  import {Duplex} from "node:stream"
8
8
  import test from "node:test"
9
9
  import {connect as connectTls} from "node:tls"
10
+ import zlib from "node:zlib"
10
11
 
11
12
  import {StaticTokenStore} from "../../src/auth/static-token-store.js"
12
13
  import {MultiplexedSocketductTransportSet} from "../../src/client/multiplexed-transport-set.js"
14
+ import {ZSTD_CODEC} from "../../src/protocol/compression.js"
15
+ import {encodeV3Data, AdaptiveCompressor} from "../../src/protocol/v3-compression.js"
13
16
  import {encodeV3Control, encodeV3Frame, V3FrameDecoder, V3FrameType} from "../../src/protocol/v3-frame.js"
14
17
  import {OutboundReverseGateway, ReverseGatewayConnection, startReverseGatewayHub} from "../../src/reverse/index.js"
18
+ import {SessionSpool} from "../../src/spool/spool-file.js"
15
19
  import {generateTestCertificates} from "../helpers/tls-certificates.js"
16
20
 
17
21
  /** @param {import('node:net').Server} server - Server. */
@@ -93,6 +97,44 @@ async function waitUntil(predicate, label) {
93
97
  }
94
98
  }
95
99
 
100
+ /**
101
+ * @param {string} spoolDirectory - Private persistent spool root.
102
+ * @param {Partial<Record<string, unknown>>} [overrides] - Recovery-state overrides.
103
+ * @param {Array<{sequence: number, data: Buffer}>} [chunks] - Durable client replay chunks.
104
+ */
105
+ async function seedReverseClientRecovery(spoolDirectory, overrides = {}, chunks = []) {
106
+ /** @type {Record<string, unknown>} */
107
+ const state = {
108
+ version: 3,
109
+ role: "reverse-client",
110
+ connectionId: "recovered_client_01",
111
+ generation: 41,
112
+ gatewayId: "o2",
113
+ streamId: 1,
114
+ identifier: "recovered_stream_01",
115
+ name: "durable-reverse-stream",
116
+ target: {host: "docker-server", port: 2375},
117
+ state: "open",
118
+ opened: true,
119
+ openingSent: true,
120
+ sendSequence: chunks.at(-1)?.sequence ?? 0,
121
+ sendAck: 0,
122
+ receiveSequence: 0,
123
+ receiveAck: 0,
124
+ localEnded: false,
125
+ remoteEnded: false,
126
+ endSent: false,
127
+ ...overrides
128
+ }
129
+ if (state.gatewayId === undefined) delete state.gatewayId
130
+ const identifier = /** @type {string} */ (state.identifier)
131
+ const spool = new SessionSpool({rootDir: spoolDirectory, maxBytes: 1024 * 1024, maxAgeMs: 60_000})
132
+ await spool.createNew({sessionId: identifier, ownerId: "reverse-client-v3"})
133
+ for (const chunk of chunks) await spool.appendChunk({sessionId: identifier, ownerId: "reverse-client-v3", ...chunk})
134
+ await spool.writeRecoveryState(identifier, state)
135
+ return state
136
+ }
137
+
96
138
  /**
97
139
  * @param {{connect(): Promise<void>}} connection - Terminal reverse connection.
98
140
  * @param {string} label - Failure context.
@@ -265,6 +307,373 @@ test("reverse client contains a TLS AUTH write race inside the transport", async
265
307
  await assert.rejects(connecting, /closed/i)
266
308
  })
267
309
 
310
+ test("recovered reverse clients require explicit cold durable identity before any physical attempt", async (t) => {
311
+ const root = await mkdtemp(join(tmpdir(), "socketduct-reverse-recovery-contract-"))
312
+ t.after(() => rm(root, {recursive: true, force: true}))
313
+ const spoolDirectory = join(root, "client-spool")
314
+ await seedReverseClientRecovery(spoolDirectory, {sendAck: 2}, [
315
+ {sequence: 2, data: Buffer.from("aa")},
316
+ {sequence: 4, data: Buffer.from("bb")}
317
+ ])
318
+ let physicalAttempts = 0
319
+ /** @type {Record<string, unknown>[]} */
320
+ const diagnostics = []
321
+ const base = {
322
+ gatewayId: "o2",
323
+ connectionId: "recovered_client_01",
324
+ hub: {host: "127.0.0.1", port: 3100, token: "client-token"},
325
+ tls: {servername: "localhost"},
326
+ spoolDirectory,
327
+ initialGeneration: 0,
328
+ logger: {log: (/** @type {string} */ event, /** @type {Record<string, unknown>} */ fields = {}) => diagnostics.push({event, ...fields})},
329
+ createPhysicalSocket: () => {
330
+ physicalAttempts += 1
331
+ return /** @type {import('node:tls').TLSSocket} */ (/** @type {unknown} */ (new AuthWriteSocket()))
332
+ }
333
+ }
334
+
335
+ const client = new ReverseGatewayConnection(base)
336
+ t.after(() => client.close())
337
+ assert.throws(() => client.createConnection({recover: true, identifier: "recovered_stream_01", host: "docker-server", port: 2375}), /must use registerRecoveredConnection/i)
338
+ assert.throws(() => client.registerRecoveredConnection(/** @type {import('../../src/client/multiplexed-connection.js').VirtualConnectionOptions} */ ({identifier: "recovered_stream_01", host: "docker-server", port: 2375})), /recover: true/i)
339
+ const recovered = client.registerRecoveredConnection({recover: true, identifier: "recovered_stream_01", sessionName: "durable-reverse-stream", host: "docker-server", port: 2375})
340
+ assert.equal(recovered.streamId, 1)
341
+ assert.equal(client.status().physicalState, "configured")
342
+ assert.equal(client.status().connectionGeneration, 41)
343
+ assert.equal(client.status().spoolBytes, 2)
344
+ assert.equal(physicalAttempts, 0)
345
+
346
+ const recoveryContents = await readFile(join(spoolDirectory, "recovered_stream_01", "recovery.json"), "utf8")
347
+ assert.doesNotMatch(recoveryContents, /client-token/)
348
+ assert.doesNotMatch(JSON.stringify(diagnostics), /client-token/)
349
+ assert.equal((await stat(spoolDirectory)).mode & 0o777, 0o700)
350
+ for (const file of ["metadata.json", "recovery.json", "chunks.jsonl", "usage.json"]) {
351
+ assert.equal((await stat(join(spoolDirectory, "recovered_stream_01", file))).mode & 0o777, 0o600)
352
+ }
353
+
354
+ const {connectionId: _connectionId, ...withoutConnectionOptions} = base
355
+ void _connectionId
356
+ const withoutConnectionId = new ReverseGatewayConnection(withoutConnectionOptions)
357
+ assert.throws(() => withoutConnectionId.registerRecoveredConnection({recover: true, identifier: "recovered_stream_01", host: "docker-server", port: 2375}), /explicit stable connectionId/i)
358
+ await withoutConnectionId.close()
359
+ const {spoolDirectory: _spoolDirectory, ...withoutSpoolOptions} = base
360
+ void _spoolDirectory
361
+ const withoutSpoolDirectory = new ReverseGatewayConnection(withoutSpoolOptions)
362
+ assert.throws(() => withoutSpoolDirectory.registerRecoveredConnection({recover: true, identifier: "recovered_stream_01", host: "docker-server", port: 2375}), /explicit persistent spoolDirectory/i)
363
+ await withoutSpoolDirectory.close()
364
+
365
+ const routeSpoolDirectory = join(root, "route-spool")
366
+ await seedReverseClientRecovery(routeSpoolDirectory, {gatewayId: undefined, routeClass: "starlink", identifier: "recovered_route_stream", streamId: 3})
367
+ const {gatewayId: _gatewayId, ...routeBase} = base
368
+ void _gatewayId
369
+ const routeClient = new ReverseGatewayConnection({...routeBase, routeClass: "starlink", spoolDirectory: routeSpoolDirectory})
370
+ const recoveredRoute = routeClient.registerRecoveredConnection({recover: true, identifier: "recovered_route_stream", host: "docker-server", port: 2375})
371
+ assert.equal(recoveredRoute.streamId, 3)
372
+ assert.equal(physicalAttempts, 0)
373
+ await routeClient.close()
374
+
375
+ const lateRoot = join(root, "late-spool")
376
+ await seedReverseClientRecovery(lateRoot, {identifier: "recovered_stream_02", streamId: 3})
377
+ const late = new ReverseGatewayConnection({...base, spoolDirectory: lateRoot})
378
+ const connecting = late.connect()
379
+ void connecting.catch(() => {})
380
+ assert.throws(() => late.registerRecoveredConnection({recover: true, identifier: "recovered_stream_02", host: "docker-server", port: 2375}), /before.*physical connection/i)
381
+ await late.close()
382
+ })
383
+
384
+ test("recovered reverse state rejects missing corrupt stale mismatched and unbounded spools before network activity", async (t) => {
385
+ const root = await mkdtemp(join(tmpdir(), "socketduct-reverse-recovery-invalid-"))
386
+ t.after(() => rm(root, {recursive: true, force: true}))
387
+ let physicalAttempts = 0
388
+ let caseNumber = 0
389
+
390
+ /**
391
+ * @param {string} label - Filesystem-safe case label.
392
+ * @param {Partial<Record<string, unknown>>} [stateOverrides] - Invalid state mutation.
393
+ * @param {{chunks?: Array<{sequence: number, data: Buffer}>, maxStreamBufferBytes?: number, register?: Record<string, unknown>, mutate?: (input: {spoolDirectory: string, identifier: string, state: Record<string, unknown>}) => Promise<void>, maxAgeMs?: number}} [caseOptions] - Invalid spool shape.
394
+ */
395
+ async function assertInvalidRecovery(label, stateOverrides = {}, caseOptions = {}) {
396
+ caseNumber += 1
397
+ const spoolDirectory = join(root, `${caseNumber}-${label}`)
398
+ const identifier = `invalid_stream_${String(caseNumber).padStart(2, "0")}`
399
+ const state = await seedReverseClientRecovery(spoolDirectory, {identifier, ...stateOverrides}, caseOptions.chunks)
400
+ await caseOptions.mutate?.({spoolDirectory, identifier, state})
401
+ const client = new ReverseGatewayConnection({
402
+ gatewayId: "o2",
403
+ connectionId: "recovered_client_01",
404
+ hub: {host: "127.0.0.1", port: 3100, token: "never-written-token"},
405
+ tls: {servername: "localhost"},
406
+ spoolDirectory,
407
+ initialGeneration: 0,
408
+ ...(caseOptions.maxAgeMs === undefined ? {} : {maxAgeMs: caseOptions.maxAgeMs}),
409
+ ...(caseOptions.maxStreamBufferBytes === undefined ? {} : {maxStreamBufferBytes: caseOptions.maxStreamBufferBytes}),
410
+ createPhysicalSocket: () => { physicalAttempts += 1; return /** @type {import('node:tls').TLSSocket} */ (/** @type {unknown} */ (new AuthWriteSocket())) }
411
+ })
412
+ const register = {recover: true, identifier, sessionName: "durable-reverse-stream", host: "docker-server", port: 2375, ...caseOptions.register}
413
+ assert.throws(() => client.registerRecoveredConnection(/** @type {import('../../src/client/multiplexed-connection.js').VirtualConnectionOptions} */ (register)), /Invalid|exceed|recovery/i, label)
414
+ assert.equal(client.status().virtualStreams, 0, label)
415
+ await client.close()
416
+ }
417
+
418
+ await assertInvalidRecovery("wrong-connection", {connectionId: "other_client_01"})
419
+ await assertInvalidRecovery("wrong-selector", {gatewayId: "other"})
420
+ await assertInvalidRecovery("ambiguous-selector", {routeClass: "starlink"})
421
+ await assertInvalidRecovery("wrong-role", {role: "reverse-gateway"})
422
+ await assertInvalidRecovery("wrong-stream", {streamId: 2})
423
+ await assertInvalidRecovery("zero-generation", {generation: 0})
424
+ await assertInvalidRecovery("exhausted-generation", {generation: Number.MAX_SAFE_INTEGER})
425
+ await assertInvalidRecovery("terminal-lifecycle", {state: "closed"})
426
+ await assertInvalidRecovery("inconsistent-half-close", {localEnded: true})
427
+ await assertInvalidRecovery("missing-open", {openingSent: false})
428
+ await assertInvalidRecovery("end-before-open", {state: "opening", opened: false, localEnded: true, endSent: true})
429
+ await assertInvalidRecovery("remote-end-before-open", {state: "opening", opened: false, remoteEnded: true})
430
+ await assertInvalidRecovery("wrong-target", {}, {register: {host: "other-target"}})
431
+ await assertInvalidRecovery("wrong-name", {}, {register: {sessionName: "other-name"}})
432
+ await assertInvalidRecovery("wrong-identifier", {}, {mutate: async ({spoolDirectory, identifier, state}) => {
433
+ await writeFile(join(spoolDirectory, identifier, "recovery.json"), `${JSON.stringify({...state, identifier: "different_stream_01"})}\n`)
434
+ }})
435
+ await assertInvalidRecovery("noncontiguous", {sendSequence: 2}, {chunks: [{sequence: 2, data: Buffer.from("x")}]} )
436
+ await assertInvalidRecovery("oversized", {}, {chunks: [{sequence: 8, data: Buffer.alloc(8)}], maxStreamBufferBytes: 4})
437
+ await assertInvalidRecovery("wrong-owner", {}, {mutate: async ({spoolDirectory, identifier}) => {
438
+ const metadataPath = join(spoolDirectory, identifier, "metadata.json")
439
+ const metadata = JSON.parse(await readFile(metadataPath, "utf8"))
440
+ await writeFile(metadataPath, `${JSON.stringify({...metadata, ownerId: "reverse-gateway-v3"})}\n`)
441
+ }})
442
+ await assertInvalidRecovery("corrupt", {}, {mutate: async ({spoolDirectory, identifier}) => {
443
+ await writeFile(join(spoolDirectory, identifier, "recovery.json"), "{not-json\n")
444
+ }})
445
+ await assertInvalidRecovery("expired", {}, {maxAgeMs: 1, mutate: async ({spoolDirectory, identifier}) => {
446
+ const metadataPath = join(spoolDirectory, identifier, "metadata.json")
447
+ const metadata = JSON.parse(await readFile(metadataPath, "utf8"))
448
+ await writeFile(metadataPath, `${JSON.stringify({...metadata, createdAt: "2000-01-01T00:00:00.000Z"})}\n`)
449
+ }})
450
+
451
+ const routeSpoolDirectory = join(root, "wrong-route-class")
452
+ await seedReverseClientRecovery(routeSpoolDirectory, {gatewayId: undefined, routeClass: "starlink", identifier: "wrong_route_stream"})
453
+ const wrongRoute = new ReverseGatewayConnection({routeClass: "zyxel", connectionId: "recovered_client_01", hub: {host: "127.0.0.1", port: 3100, token: "never-written-token"}, tls: {servername: "localhost"}, spoolDirectory: routeSpoolDirectory, createPhysicalSocket: () => { physicalAttempts += 1; return /** @type {import('node:tls').TLSSocket} */ (/** @type {unknown} */ (new AuthWriteSocket())) }})
454
+ assert.throws(() => wrongRoute.registerRecoveredConnection({recover: true, identifier: "wrong_route_stream", host: "docker-server", port: 2375}), /Invalid.*selector/i)
455
+ await wrongRoute.close()
456
+
457
+ const missing = new ReverseGatewayConnection({gatewayId: "o2", connectionId: "recovered_client_01", hub: {host: "127.0.0.1", port: 3100, token: "never-written-token"}, tls: {servername: "localhost"}, spoolDirectory: join(root, "missing"), createPhysicalSocket: () => { physicalAttempts += 1; return /** @type {import('node:tls').TLSSocket} */ (/** @type {unknown} */ (new AuthWriteSocket())) }})
458
+ assert.throws(() => missing.registerRecoveredConnection({recover: true, identifier: "missing_stream_01", sessionName: "durable-reverse-stream", host: "docker-server", port: 2375}), /Invalid.*recovery/i)
459
+ await missing.close()
460
+ assert.equal(physicalAttempts, 0)
461
+ })
462
+
463
+ test("recovered reverse stream reports session loss after hub state loss without opening a target", async (t) => {
464
+ const root = await mkdtemp(join(tmpdir(), "socketduct-reverse-recovery-hub-loss-"))
465
+ t.after(() => rm(root, {recursive: true, force: true}))
466
+ const certificates = generateTestCertificates(root)
467
+ const spoolDirectory = join(root, "client-spool")
468
+ await seedReverseClientRecovery(spoolDirectory, {generation: 100})
469
+ const tokens = new StaticTokenStore([{username: "home", token: "gateway-token"}, {username: "app", token: "client-token"}])
470
+ const hub = await startReverseGatewayHub({tokens, tls: {certFile: certificates.serverCertFile, keyFile: certificates.serverKeyFile}, authorizeGateway: () => true, authorizeClientGateway: () => true, authorizeOpen: () => true})
471
+ t.after(() => hub.close())
472
+ const tls = {caFile: certificates.caCertFile, servername: "localhost"}
473
+ let targetCreates = 0
474
+ const gateway = new OutboundReverseGateway({gatewayId: "o2", connectionId: "hub_loss_gateway_01", hub: {host: "127.0.0.1", port: hub.port, token: "gateway-token"}, tls, authorizeTarget: () => true, createTargetConnection: () => {
475
+ targetCreates += 1
476
+ throw new Error("lost hub state must not recreate a target")
477
+ }})
478
+ t.after(() => gateway.close())
479
+ await gateway.start()
480
+ const client = new ReverseGatewayConnection({gatewayId: "o2", connectionId: "recovered_client_01", hub: {host: "127.0.0.1", port: hub.port, token: "client-token"}, tls, spoolDirectory, initialGeneration: 0})
481
+ t.after(() => client.close())
482
+ const socket = client.registerRecoveredConnection({recover: true, identifier: "recovered_stream_01", sessionName: "durable-reverse-stream", host: "docker-server", port: 2375})
483
+ const lost = nextError(socket)
484
+ await client.connect()
485
+ assert.equal((await withTimeout(lost, "hub-state-loss recovery")).code, "RESUME_SESSION_LOST")
486
+ assert.equal(targetCreates, 0)
487
+ assert.equal(gateway.status().targetOpens, 0)
488
+ })
489
+
490
+ test("replacement reverse client restores a spooled stream without OPEN or a second target", async (t) => {
491
+ const root = await mkdtemp(join(tmpdir(), "socketduct-reverse-client-replacement-"))
492
+ t.after(() => rm(root, {recursive: true, force: true}))
493
+ const certificates = generateTestCertificates(root)
494
+ const spoolDirectory = join(root, "client-spool")
495
+ let targetAccepts = 0
496
+ const targetSockets = new Set()
497
+ const target = createServer((socket) => {
498
+ targetAccepts += 1
499
+ targetSockets.add(socket)
500
+ socket.once("close", () => targetSockets.delete(socket))
501
+ socket.on("data", (chunk) => socket.write(Buffer.concat([Buffer.from("target:"), chunk])))
502
+ })
503
+ const targetPort = await listen(target)
504
+ t.after(() => { for (const socket of targetSockets) socket.destroy(); return new Promise((resolve) => target.close(() => resolve(undefined))) })
505
+ const tokens = new StaticTokenStore([{username: "home", token: "gateway-token"}, {username: "app", token: "client-token"}])
506
+ const hub = await startReverseGatewayHub({tokens, tls: {certFile: certificates.serverCertFile, keyFile: certificates.serverKeyFile}, authorizeGateway: () => true, authorizeClientGateway: () => true, authorizeOpen: () => true, resumeWindowMs: 2_000})
507
+ t.after(() => hub.close())
508
+ const tls = {caFile: certificates.caCertFile, servername: "localhost"}
509
+ const gateway = new OutboundReverseGateway({gatewayId: "o2", connectionId: "recovered_gateway_01", hub: {host: "127.0.0.1", port: hub.port, token: "gateway-token"}, tls, authorizeTarget: () => true, reconnectDelayMs: 10, maxReconnectDelayMs: 20})
510
+ t.after(() => gateway.close())
511
+ await gateway.start()
512
+
513
+ const connectionOptions = {gatewayId: "o2", connectionId: "recovered_client_live", hub: {host: "127.0.0.1", port: hub.port, token: "client-token"}, tls, spoolDirectory, reconnectDelayMs: 10, maxReconnectDelayMs: 20}
514
+ const original = new ReverseGatewayConnection(connectionOptions)
515
+ await original.connect()
516
+ const originalSocket = original.createConnection({identifier: "recovered_live_stream", sessionName: "durable-docker-operation", host: "127.0.0.1", port: targetPort})
517
+ await onceEvent(originalSocket, "connect")
518
+ const initial = readBytes(originalSocket, 13)
519
+ originalSocket.write("before")
520
+ assert.equal((await withTimeout(initial, "initial reverse response")).toString(), "target:before")
521
+ assert.equal(targetAccepts, 1)
522
+ const oldGeneration = original.status().connectionGeneration
523
+ await original.detach()
524
+ const detachedState = JSON.parse(await readFile(join(spoolDirectory, "recovered_live_stream", "recovery.json"), "utf8"))
525
+ assert.equal(detachedState.receiveAck, 13, "detach must persist application-consumed target bytes")
526
+
527
+ /** @type {number[]} */
528
+ const outboundTypes = []
529
+ const replacement = new ReverseGatewayConnection({...connectionOptions, initialGeneration: 0, createPhysicalSocket: (options) => {
530
+ const physical = connectTls({host: options.host, port: options.port, ...options.tls})
531
+ const originalWrite = physical.write.bind(physical)
532
+ physical.write = /** @type {typeof physical.write} */ ((chunk, ...args) => {
533
+ if (Buffer.isBuffer(chunk) && chunk.length >= 6) outboundTypes.push(/** @type {number} */ (chunk[5]))
534
+ return Reflect.apply(originalWrite, physical, [chunk, ...args])
535
+ })
536
+ return physical
537
+ }})
538
+ t.after(() => replacement.close())
539
+ const recovered = replacement.registerRecoveredConnection({recover: true, identifier: "recovered_live_stream", sessionName: "durable-docker-operation", host: "127.0.0.1", port: targetPort})
540
+ const connected = onceEvent(recovered, "connect")
541
+ await replacement.connect()
542
+ await withTimeout(connected, "recovered reverse VirtualSocket")
543
+ assert(replacement.status().connectionGeneration > oldGeneration)
544
+ assert.equal(outboundTypes.includes(V3FrameType.OPEN), false)
545
+ assert.equal(targetAccepts, 1)
546
+ const resumed = readBytes(recovered, 12)
547
+ recovered.write("after")
548
+ assert.equal((await withTimeout(resumed, "recovered reverse response")).toString(), "target:after")
549
+ assert.equal(targetAccepts, 1)
550
+ const recoveredClosed = onceEvent(recovered, "close")
551
+ recovered.destroy()
552
+ await recoveredClosed
553
+ await replacement.close()
554
+ })
555
+
556
+ test("reverse client detach waits for queued asynchronous DATA and prevents late spool mutation", async (t) => {
557
+ const root = await mkdtemp(join(tmpdir(), "socketduct-reverse-client-detach-barrier-"))
558
+ t.after(() => rm(root, {recursive: true, force: true}))
559
+ const certificates = generateTestCertificates(root)
560
+ const tokens = new StaticTokenStore([{username: "home", token: "gateway-token"}, {username: "app", token: "client-token"}])
561
+ const hub = await startReverseGatewayHub({tokens, tls: {certFile: certificates.serverCertFile, keyFile: certificates.serverKeyFile}, authorizeGateway: () => true, authorizeClientGateway: () => true, authorizeOpen: () => true, resumeWindowMs: 2_000})
562
+ t.after(() => hub.close())
563
+ const tls = {caFile: certificates.caCertFile, servername: "localhost"}
564
+ /** @type {HeldWriteTarget[]} */
565
+ const targets = []
566
+ const gateway = new OutboundReverseGateway({gatewayId: "o2", connectionId: "detach_barrier_gateway", hub: {host: "127.0.0.1", port: hub.port, token: "gateway-token"}, tls, authorizeTarget: () => true, createTargetConnection: () => {
567
+ const target = new HeldWriteTarget()
568
+ targets.push(target)
569
+ return /** @type {import('node:net').Socket} */ (/** @type {unknown} */ (target))
570
+ }})
571
+ t.after(() => gateway.close())
572
+ t.after(() => { for (const target of targets) target.release() })
573
+ await gateway.start()
574
+
575
+ /** @type {import('node:tls').TLSSocket | undefined} */
576
+ let physical
577
+ const spoolDirectory = join(root, "client-spool")
578
+ const client = new ReverseGatewayConnection({gatewayId: "o2", connectionId: "detach_barrier_client", hub: {host: "127.0.0.1", port: hub.port, token: "client-token"}, tls, spoolDirectory, createPhysicalSocket: (options) => {
579
+ physical = connectTls({host: options.host, port: options.port, ...options.tls})
580
+ return physical
581
+ }})
582
+ t.after(() => client.close())
583
+ await client.connect()
584
+ const socket = client.createConnection({identifier: "detach_barrier_stream", host: "held-target", port: 2375})
585
+ await onceEvent(socket, "connect")
586
+ assert(physical !== undefined)
587
+
588
+ const payload = Buffer.from("queued-after-detach-".repeat(64))
589
+ const encoded = await encodeV3Data(payload, ZSTD_CODEC, new AdaptiveCompressor())
590
+ assert.notEqual(encoded.flags, 0, "fixture DATA must cross the asynchronous decompression boundary")
591
+ const originalDecompress = zlib.zstdDecompress
592
+ assert.equal(typeof originalDecompress, "function")
593
+ /** @type {(() => void) | undefined} */
594
+ let releaseDecompression
595
+ /** @type {() => void} */
596
+ let markDecompressionStarted = () => {}
597
+ const decompressionStarted = new Promise((resolve) => { markDecompressionStarted = () => resolve(undefined) })
598
+ /** @type {() => void} */
599
+ let markDecompressionFinished = () => {}
600
+ const decompressionFinished = new Promise((resolve) => { markDecompressionFinished = () => resolve(undefined) })
601
+ zlib.zstdDecompress = /** @type {typeof zlib.zstdDecompress} */ ((input, options, callback) => {
602
+ markDecompressionStarted()
603
+ releaseDecompression = () => originalDecompress(input, options, (error, result) => {
604
+ callback(error, result)
605
+ markDecompressionFinished()
606
+ })
607
+ })
608
+ t.after(() => {
609
+ releaseDecompression?.()
610
+ zlib.zstdDecompress = originalDecompress
611
+ })
612
+
613
+ physical.emit("data", encodeV3Frame({type: V3FrameType.DATA, streamId: socket.streamId, sequence: payload.length, flags: encoded.flags}, encoded.payload))
614
+ await withTimeout(decompressionStarted, "queued reverse DATA decompression")
615
+ let detached = false
616
+ const detaching = client.detach().then(() => { detached = true })
617
+ await new Promise((resolve) => setImmediate(resolve))
618
+ const resolvedBeforeQueue = detached
619
+ releaseDecompression?.()
620
+ releaseDecompression = undefined
621
+ await withTimeout(decompressionFinished, "released reverse DATA decompression")
622
+ await withTimeout(detaching, "reverse client detach barrier")
623
+ await new Promise((resolve) => setImmediate(resolve))
624
+
625
+ assert.equal(resolvedBeforeQueue, false, "detach must not resolve while an old-generation frame handler is queued")
626
+ assert.equal(socket.readableLength, 0, "a queued old-generation frame must not deliver after detach starts")
627
+ const recovery = JSON.parse(await readFile(join(spoolDirectory, "detach_barrier_stream", "recovery.json"), "utf8"))
628
+ assert.equal(recovery.receiveSequence, 0)
629
+ assert.equal(recovery.receiveAck, 0)
630
+ })
631
+
632
+ test("replacement gateway submits an empty resume manifest and resets omitted streams once", async (t) => {
633
+ const root = await mkdtemp(join(tmpdir(), "socketduct-reverse-gateway-replacement-"))
634
+ t.after(() => rm(root, {recursive: true, force: true}))
635
+ const certificates = generateTestCertificates(root)
636
+ let targetAccepts = 0
637
+ const targetSockets = new Set()
638
+ const target = createServer((socket) => { targetAccepts += 1; targetSockets.add(socket); socket.once("close", () => targetSockets.delete(socket)) })
639
+ const targetPort = await listen(target)
640
+ t.after(() => { for (const socket of targetSockets) socket.destroy(); return new Promise((resolve) => target.close(() => resolve(undefined))) })
641
+ const tokens = new StaticTokenStore([{username: "home", token: "gateway-token"}, {username: "app", token: "client-token"}])
642
+ const hub = await startReverseGatewayHub({tokens, tls: {certFile: certificates.serverCertFile, keyFile: certificates.serverKeyFile}, authorizeGateway: () => true, authorizeClientGateway: () => true, authorizeOpen: () => true, resumeWindowMs: 2_000})
643
+ t.after(() => hub.close())
644
+ const tls = {caFile: certificates.caCertFile, servername: "localhost"}
645
+ const gatewayOptions = {gatewayId: "o2", connectionId: "replacement_gateway_01", hub: {host: "127.0.0.1", port: hub.port, token: "gateway-token"}, tls, authorizeTarget: () => true}
646
+ const originalGateway = new OutboundReverseGateway({...gatewayOptions, reconnectDelayMs: 10_000, maxReconnectDelayMs: 10_000})
647
+ await originalGateway.start()
648
+ const client = new ReverseGatewayConnection({gatewayId: "o2", connectionId: "replacement_gateway_client", hub: {host: "127.0.0.1", port: hub.port, token: "client-token"}, tls, reconnectDelayMs: 10, maxReconnectDelayMs: 20})
649
+ t.after(() => client.close())
650
+ await client.connect()
651
+ const socket = client.createConnection({identifier: "replacement_stream_01", host: "127.0.0.1", port: targetPort})
652
+ let resets = 0
653
+ const reset = new Promise((resolve) => socket.on("error", (error) => { resets += 1; resolve(error) }))
654
+ await onceEvent(socket, "connect")
655
+ assert.equal(targetAccepts, 1)
656
+ const generation = originalGateway.status().connectionGeneration
657
+ await hub.closeActiveGateway("o2")
658
+ await originalGateway.close()
659
+
660
+ let replacementTargetCreates = 0
661
+ const replacement = new OutboundReverseGateway({...gatewayOptions, initialGeneration: generation, createTargetConnection: () => {
662
+ replacementTargetCreates += 1
663
+ throw new Error("replacement gateway must not recreate a retained target")
664
+ }})
665
+ t.after(() => replacement.close())
666
+ await replacement.start()
667
+ const error = /** @type {Error & {code?: string}} */ (await withTimeout(reset, "omitted replacement stream reset"))
668
+ assert.equal(error.code, "RESUME_SESSION_LOST")
669
+ await waitUntil(() => hub.status().virtualStreams === 0, "omitted bridge cleanup")
670
+ await new Promise((resolve) => setImmediate(resolve))
671
+ assert.equal(resets, 1)
672
+ assert.equal(replacementTargetCreates, 0)
673
+ assert.equal(replacement.status().targetOpens, 0)
674
+ assert.equal(targetAccepts, 1)
675
+ })
676
+
268
677
  class DataThenErrorTarget extends Duplex {
269
678
  /** @param {Buffer} payload - Bytes observed before the terminal target error. */
270
679
  constructor(payload) {
@@ -1111,6 +1520,17 @@ test("reverse hub rejects bad credentials, unknown gateways, duplicate owners, a
1111
1520
  await replacement.start()
1112
1521
  await waitUntil(() => primary.status().physicalState === "closed", "newer generation fences prior owner")
1113
1522
  assert.equal(hub.status().healthyGateways, 1)
1523
+
1524
+ const primaryClient = new ReverseGatewayConnection({gatewayId: "o2", connectionId: "stable_client_owner", initialGeneration: 100, hub: {host: "127.0.0.1", port: hub.port, token: "client-valid-token"}, tls})
1525
+ t.after(() => primaryClient.close())
1526
+ await primaryClient.connect()
1527
+ const equalClient = new ReverseGatewayConnection({gatewayId: "o2", connectionId: "stable_client_owner", initialGeneration: 100, hub: {host: "127.0.0.1", port: hub.port, token: "client-valid-token"}, tls, continuousReconnect: false})
1528
+ t.after(() => equalClient.close())
1529
+ await assert.rejects(withTimeout(equalClient.connect(), "equal client generation"), (error) => /** @type {{code?: string}} */ (error).code === "STALE_GENERATION")
1530
+ const newerClient = new ReverseGatewayConnection({gatewayId: "o2", connectionId: "stable_client_owner", initialGeneration: 200, hub: {host: "127.0.0.1", port: hub.port, token: "client-valid-token"}, tls})
1531
+ t.after(() => newerClient.close())
1532
+ await newerClient.connect()
1533
+ await waitUntil(() => primaryClient.status().physicalState === "closed", "newer client generation fences prior claimant")
1114
1534
  })
1115
1535
 
1116
1536
  test("hub and gateway both enforce target policy without opening a proxy", async (t) => {
@@ -289,6 +289,17 @@ test("route-class members are first-class reverse transports with route-class al
289
289
  assert(connectionIds.every((connectionId) => typeof connectionId === "string"))
290
290
  assert.equal(new Set(connectionIds).size, 2)
291
291
 
292
+ assert.throws(() => set.recoverConnection(/** @type {Parameters<MultiplexedSocketductTransportSet['recoverConnection']>[0]} */ (/** @type {unknown} */ ({host: "target.internal", port: 443, identifier: "route_stream_01"}))), /exactly one.*gatewayId.*routeClass/i)
293
+ assert.throws(() => set.recoverConnection(/** @type {Parameters<MultiplexedSocketductTransportSet['recoverConnection']>[0]} */ (/** @type {unknown} */ ({gatewayId: "starlink", routeClass: "zyxel", host: "target.internal", port: 443, identifier: "route_stream_01"}))), /exactly one.*gatewayId.*routeClass/i)
294
+ assert.throws(() => set.recoverConnection({routeClass: "missing", host: "target.internal", port: 443, identifier: "route_stream_01"}), /unknown routeClass/i)
295
+ const recovered = set.recoverConnection({routeClass: "zyxel", host: "target.internal", port: 443, identifier: "route_stream_01", sessionName: "durable-route"})
296
+ assert.equal(/** @type {{gatewayId?: string}} */ (recovered).gatewayId, undefined)
297
+ assert.equal(/** @type {{routeClass?: string}} */ (recovered).routeClass, "zyxel")
298
+ assert.equal(Object.getOwnPropertyDescriptor(recovered, "routeClass")?.writable, false)
299
+ assert.deepEqual(members.map((member) => member.opens), [0, 1])
300
+ assert.equal(/** @type {{recover?: unknown}} */ (at(members, 1).recoveryConnectionCalls[0]).recover, true)
301
+ assert.equal(Object.hasOwn(/** @type {object} */ (at(members, 1).recoveryConnectionCalls[0]), "routeClass"), false)
302
+
292
303
  const started = set.start()
293
304
  at(members, 0).ready()
294
305
  await started
@@ -845,7 +856,7 @@ test("pending socket end reserves and sends DataView bytes", async () => {
845
856
  await set.close()
846
857
  })
847
858
 
848
- test("recovery requires an original configured gateway and registration before start", async () => {
859
+ test("recovery requires one original configured selector and registration before start", async () => {
849
860
  const {set, members} = fixture()
850
861
  assert.throws(() => set.recoverConnection(/** @type {Parameters<MultiplexedSocketductTransportSet['recoverConnection']>[0]} */ (/** @type {unknown} */ ({host: "target.internal", port: 443, identifier: "stable_stream_01"}))), /gatewayId/i)
851
862
  assert.throws(() => set.recoverConnection({gatewayId: "unknown", host: "target.internal", port: 443, identifier: "stable_stream_01"}), /unknown gatewayId/i)
@@ -191,6 +191,139 @@ test("SessionSpool synchronously rejects expired durable recovery state", async
191
191
  })
192
192
  })
193
193
 
194
+ test("SessionSpool loadChunksSync restores only unacknowledged owned chunks", async () => {
195
+ await withTempDir(async (root) => {
196
+ const sessionId = "session_recovery_chunks"
197
+ const spool = new SessionSpool({rootDir: root, maxBytes: 16})
198
+ await spool.createNew({sessionId, ownerId: "reverse-client-v3"})
199
+ await spool.appendChunk({sessionId, ownerId: "reverse-client-v3", sequence: 3, data: Buffer.from("old")})
200
+ await spool.appendChunk({sessionId, ownerId: "reverse-client-v3", sequence: 6, data: Buffer.from("new")})
201
+
202
+ const chunks = spool.loadChunksSync(sessionId, "reverse-client-v3", 3, 6)
203
+
204
+ assert.deepEqual(chunks.map((chunk) => chunk.sequence), [6])
205
+ assert.equal(chunks[0]?.data.toString(), "new")
206
+ assert.equal(spool.getUsedBytes(sessionId), 3)
207
+ assert.throws(
208
+ () => spool.loadChunksSync(sessionId, "other-owner", 3, 6),
209
+ /Invalid Socketduct recovery chunks/
210
+ )
211
+ })
212
+ })
213
+
214
+ test("SessionSpool recovery repairs interruption after chunk append before usage update", async () => {
215
+ await withTempDir(async (root) => {
216
+ const sessionId = "session_append_interruption"
217
+ const spool = new SessionSpool({rootDir: root, maxBytes: 16})
218
+ await spool.createNew({sessionId, ownerId: "reverse-client-v3"})
219
+ await spool.appendChunk({sessionId, ownerId: "reverse-client-v3", sequence: 3, data: Buffer.from("one")})
220
+ const chunksPath = join(root, sessionId, "chunks.jsonl")
221
+ const committed = await readFile(chunksPath, "utf8")
222
+ await writeFile(chunksPath, `${committed}${JSON.stringify({sequence: 6, dataBase64: Buffer.from("two").toString("base64")})}\n`)
223
+
224
+ const chunks = spool.loadChunksSync(sessionId, "reverse-client-v3", 0, 3)
225
+
226
+ assert.deepEqual(chunks.map((chunk) => chunk.sequence), [3])
227
+ assert.equal(await readFile(chunksPath, "utf8"), committed)
228
+ assert.deepEqual(JSON.parse(await readFile(join(root, sessionId, "usage.json"), "utf8")), {totalBytes: 3})
229
+ assert.equal((await stat(chunksPath)).mode & 0o777, 0o600)
230
+ assert.equal((await stat(join(root, sessionId, "usage.json"))).mode & 0o777, 0o600)
231
+ })
232
+ })
233
+
234
+ test("SessionSpool recovery repairs interruption after usage update before recovery commit", async () => {
235
+ await withTempDir(async (root) => {
236
+ const sessionId = "session_usage_interruption"
237
+ const spool = new SessionSpool({rootDir: root, maxBytes: 16})
238
+ await spool.createNew({sessionId, ownerId: "reverse-client-v3"})
239
+ await spool.appendChunk({sessionId, ownerId: "reverse-client-v3", sequence: 3, data: Buffer.from("one")})
240
+ await spool.appendChunk({sessionId, ownerId: "reverse-client-v3", sequence: 6, data: Buffer.from("two")})
241
+
242
+ const chunks = spool.loadChunksSync(sessionId, "reverse-client-v3", 0, 3)
243
+
244
+ assert.deepEqual(chunks.map((chunk) => chunk.sequence), [3])
245
+ assert.deepEqual(JSON.parse(await readFile(join(root, sessionId, "usage.json"), "utf8")), {totalBytes: 3})
246
+ })
247
+ })
248
+
249
+ test("SessionSpool recovery repairs interruption after acknowledged chunk truncation", async () => {
250
+ await withTempDir(async (root) => {
251
+ const sessionId = "session_truncate_interruption"
252
+ const spool = new SessionSpool({rootDir: root, maxBytes: 16})
253
+ await spool.createNew({sessionId, ownerId: "reverse-client-v3"})
254
+ await spool.appendChunk({sessionId, ownerId: "reverse-client-v3", sequence: 3, data: Buffer.from("one")})
255
+ await spool.appendChunk({sessionId, ownerId: "reverse-client-v3", sequence: 6, data: Buffer.from("two")})
256
+ const chunksPath = join(root, sessionId, "chunks.jsonl")
257
+ await writeFile(chunksPath, `${JSON.stringify({sequence: 6, dataBase64: Buffer.from("two").toString("base64")})}\n`)
258
+
259
+ const chunks = spool.loadChunksSync(sessionId, "reverse-client-v3", 3, 6)
260
+
261
+ assert.deepEqual(chunks.map((chunk) => chunk.sequence), [6])
262
+ assert.deepEqual(JSON.parse(await readFile(join(root, sessionId, "usage.json"), "utf8")), {totalBytes: 3})
263
+ })
264
+ })
265
+
266
+ test("SessionSpool recovery repairs a partial trailing JSONL record after committed chunks", async () => {
267
+ await withTempDir(async (root) => {
268
+ const sessionId = "session_partial_interruption"
269
+ const spool = new SessionSpool({rootDir: root, maxBytes: 16})
270
+ await spool.createNew({sessionId, ownerId: "reverse-client-v3"})
271
+ await spool.appendChunk({sessionId, ownerId: "reverse-client-v3", sequence: 3, data: Buffer.from("one")})
272
+ await spool.appendChunk({sessionId, ownerId: "reverse-client-v3", sequence: 6, data: Buffer.from("two")})
273
+ const chunksPath = join(root, sessionId, "chunks.jsonl")
274
+ const committed = await readFile(chunksPath, "utf8")
275
+ await writeFile(chunksPath, `${committed}{"sequence":9,"dataBase64":"thr`)
276
+
277
+ const chunks = spool.loadChunksSync(sessionId, "reverse-client-v3", 0, 6)
278
+
279
+ assert.deepEqual(chunks.map((chunk) => chunk.sequence), [3, 6])
280
+ assert.equal(await readFile(chunksPath, "utf8"), committed)
281
+ })
282
+ })
283
+
284
+ test("SessionSpool recovery rejects corruption before or outside a partial uncommitted tail", async () => {
285
+ await withTempDir(async (root) => {
286
+ const sessionId = "session_committed_corruption"
287
+ const spool = new SessionSpool({rootDir: root, maxBytes: 16})
288
+ await spool.createNew({sessionId, ownerId: "reverse-client-v3"})
289
+ await spool.appendChunk({sessionId, ownerId: "reverse-client-v3", sequence: 3, data: Buffer.from("one")})
290
+ const chunksPath = join(root, sessionId, "chunks.jsonl")
291
+ await writeFile(chunksPath, `${await readFile(chunksPath, "utf8")}{"sequence":6,"dataBase64":"tw`)
292
+
293
+ assert.throws(
294
+ () => spool.loadChunksSync(sessionId, "reverse-client-v3", 0, 6),
295
+ /Invalid Socketduct recovery chunks/
296
+ )
297
+ })
298
+
299
+ await withTempDir(async (root) => {
300
+ const sessionId = "session_tail_corruption"
301
+ const spool = new SessionSpool({rootDir: root, maxBytes: 16})
302
+ await spool.createNew({sessionId, ownerId: "reverse-client-v3"})
303
+ await spool.appendChunk({sessionId, ownerId: "reverse-client-v3", sequence: 3, data: Buffer.from("one")})
304
+ const chunksPath = join(root, sessionId, "chunks.jsonl")
305
+ await writeFile(chunksPath, `${await readFile(chunksPath, "utf8")}{not-json}\n`)
306
+
307
+ assert.throws(
308
+ () => spool.loadChunksSync(sessionId, "reverse-client-v3", 0, 3),
309
+ /Invalid Socketduct recovery chunks/
310
+ )
311
+ })
312
+
313
+ await withTempDir(async (root) => {
314
+ const sessionId = "session_usage_corruption"
315
+ const spool = new SessionSpool({rootDir: root, maxBytes: 16})
316
+ await spool.createNew({sessionId, ownerId: "reverse-client-v3"})
317
+ await spool.appendChunk({sessionId, ownerId: "reverse-client-v3", sequence: 3, data: Buffer.from("one")})
318
+ await writeFile(join(root, sessionId, "usage.json"), "{not-json\n")
319
+
320
+ assert.throws(
321
+ () => spool.loadChunksSync(sessionId, "reverse-client-v3", 0, 3),
322
+ /Invalid Socketduct recovery chunks/
323
+ )
324
+ })
325
+ })
326
+
194
327
  test("SessionSpool cleans expired abandoned entries so their stable IDs can be reused", async () => {
195
328
  await withTempDir(async (root) => {
196
329
  let now = 1_000_000