mirror of
https://github.com/stablyai/orca.git
synced 2026-10-30 16:47:34 +00:00
An owner-capable `pty.openClient` had two failure modes that presented as something else. If the relay still held an owner record but the request carried no matching resume proof, admission fell through to a SUBSCRIBER grant — a success-shaped response the client cannot use, which it then rejected as "did not grant an authenticated PTY session owner". And if the relay had forgotten the record the client named, admission threw a stale-recovery error, which the client answered by deleting its own recovery row — `clientInstanceId` included — and reopening. Two round trips, and the identity that lets it resume that target at all went with the deletion. Now every owner grant carries a required `resumed` flag, a forgotten record mints a fresh claim in one round trip, a held claim returns one of three coded refusals, duplicate opens on one connection are rejected even when identical, and an attached-holder refusal becomes a typed error routed through the terminal-relay-error callback instead of feeding redeploy backoff a link that is working fine. Independent review caught two regressions in the first attempt, both now fixed and both with tests that fail without them: **A backpressure teardown could take a live owner's session.** The safety argument was that a record only becomes `disconnected` from an observed peer close — but two of the six paths there are capacity paths, where the relay destroys the client's socket itself because its lane queue filled. That is the signature of a client that is ALIVE but not draining fast enough. Demonstrated: the real owner is torn down for backpressure, a rival is granted ownership 270ms into a nominal 30s grace, and the owner's later reconnect with a valid resume proof is refused permanently, backoff cleared, no retry. Closes now carry a cause (`peer-closed` | `local`, defaulting to `local`, which only ever widens a grace), and the floor applies only to closes the transport actually observed on the peer's side. Capacity teardowns, decode faults and sink failures keep the default. **A client's own zombie connection blocked it permanently.** Only `SshRelaySession` ever requests owner, and every endpoint-credential client shares one principal — so in a normal single-app deployment an `active` incumbent refusing you is almost always your own half-open connection the relay never saw close. That was refused as terminal, where main recovered on bounded backoff once keepalive noticed. The refusal already held both client identities; a match is now a distinct transient refusal that falls through to relay-lost backoff, restoring that recovery. A genuinely different client is still blocked. Also: each retry deadline now starts when its own phase begins, instead of both being computed at entry where a slow first phase could leave the second with zero attempts. Fixes STA-3365.
181 lines
5.5 KiB
TypeScript
181 lines
5.5 KiB
TypeScript
import { describe, expect, it, vi } from 'vitest'
|
|
import type { SshChannelMultiplexer } from './ssh-channel-multiplexer'
|
|
import { openSshPtyConsumerSession } from './ssh-pty-consumer-session'
|
|
|
|
function muxReturning(result: unknown): {
|
|
mux: SshChannelMultiplexer
|
|
request: ReturnType<typeof vi.fn>
|
|
} {
|
|
const request = vi.fn().mockResolvedValue(result)
|
|
return { mux: { request } as unknown as SshChannelMultiplexer, request }
|
|
}
|
|
|
|
function legacyOwnerGrant(overrides: Record<string, unknown> = {}): Record<string, unknown> {
|
|
return {
|
|
protocolVersion: 1,
|
|
serverBuildId: 'build-a',
|
|
clientGeneration: 3,
|
|
role: 'session-owner',
|
|
ownerGeneration: 7,
|
|
ownerLease: 'lease-a',
|
|
resumed: false,
|
|
...overrides
|
|
}
|
|
}
|
|
|
|
describe('openSshPtyConsumerSession', () => {
|
|
it('makes openClient the one request needed for token-free legacy readiness', async () => {
|
|
const { mux, request } = muxReturning(legacyOwnerGrant())
|
|
|
|
await expect(
|
|
openSshPtyConsumerSession(mux, {
|
|
clientInstanceId: 'client-a',
|
|
expectedServerBuildId: 'build-a'
|
|
})
|
|
).resolves.toEqual({
|
|
state: {
|
|
mode: 'negotiated',
|
|
clientInstanceId: 'client-a',
|
|
clientGeneration: 3,
|
|
ownerGeneration: 7,
|
|
ownerLease: 'lease-a'
|
|
},
|
|
resumed: false
|
|
})
|
|
expect(request).toHaveBeenCalledWith(
|
|
'pty.openClient',
|
|
{
|
|
protocolVersion: 1,
|
|
clientInstanceId: 'client-a',
|
|
requestedRole: 'session-owner'
|
|
},
|
|
{ timeoutMs: 10_000 }
|
|
)
|
|
})
|
|
|
|
it('carries recovery generation and lease on reconnect', async () => {
|
|
const { mux, request } = muxReturning(
|
|
legacyOwnerGrant({ ownerGeneration: 8, ownerLease: 'lease-a', resumed: true })
|
|
)
|
|
const admission = await openSshPtyConsumerSession(mux, {
|
|
clientInstanceId: 'client-a',
|
|
expectedServerBuildId: 'build-a',
|
|
resume: { ownerGeneration: 7, ownerLease: 'lease-a' }
|
|
})
|
|
|
|
expect(request.mock.calls[0][1]).toMatchObject({
|
|
resume: { ownerGeneration: 7, ownerLease: 'lease-a' }
|
|
})
|
|
expect(admission.resumed).toBe(true)
|
|
})
|
|
|
|
it.each([undefined, 'yes', 1, null])(
|
|
'rejects an owner grant that does not state whether the claim was resumed',
|
|
async (resumed) => {
|
|
const grant = legacyOwnerGrant()
|
|
// Why not a legacy peer: the build id already matched, and client and relay ship together.
|
|
if (resumed === undefined) {
|
|
delete grant.resumed
|
|
} else {
|
|
grant.resumed = resumed
|
|
}
|
|
const { mux } = muxReturning(grant)
|
|
|
|
await expect(
|
|
openSshPtyConsumerSession(mux, {
|
|
clientInstanceId: 'client-a',
|
|
expectedServerBuildId: 'build-a'
|
|
})
|
|
).rejects.toThrow('whether the claim was resumed')
|
|
}
|
|
)
|
|
|
|
it('rejects a prior or mismatched relay build', async () => {
|
|
const { mux } = muxReturning(legacyOwnerGrant({ serverBuildId: 'old-build' }))
|
|
|
|
await expect(
|
|
openSshPtyConsumerSession(mux, {
|
|
clientInstanceId: 'client-a',
|
|
expectedServerBuildId: 'build-a'
|
|
})
|
|
).rejects.toThrow('session contract mismatch')
|
|
})
|
|
|
|
it('rejects an owner lease that cannot be resumed through the relay protocol', async () => {
|
|
const { mux } = muxReturning(legacyOwnerGrant({ ownerLease: 'x'.repeat(513) }))
|
|
|
|
await expect(
|
|
openSshPtyConsumerSession(mux, {
|
|
clientInstanceId: 'client-a',
|
|
expectedServerBuildId: 'build-a'
|
|
})
|
|
).rejects.toThrow('did not grant')
|
|
})
|
|
|
|
it('does not silently downgrade when V1 was offered', async () => {
|
|
const { mux } = muxReturning(legacyOwnerGrant())
|
|
|
|
await expect(
|
|
openSshPtyConsumerSession(mux, {
|
|
clientInstanceId: 'client-a',
|
|
expectedServerBuildId: 'build-a',
|
|
outputFlowControl: { requestedWindowSu: 64 }
|
|
})
|
|
).rejects.toThrow('did not grant')
|
|
})
|
|
|
|
it('rejects an unoffered V1 capability in a legacy session', async () => {
|
|
const { mux } = muxReturning(
|
|
legacyOwnerGrant({
|
|
capabilities: { outputFlowControl: { version: 1, windowSu: 64 } }
|
|
})
|
|
)
|
|
|
|
await expect(
|
|
openSshPtyConsumerSession(mux, {
|
|
clientInstanceId: 'client-a',
|
|
expectedServerBuildId: 'build-a'
|
|
})
|
|
).rejects.toThrow('unoffered')
|
|
})
|
|
|
|
it('uses explicit token-free fallback only for same-build method-not-found', async () => {
|
|
const error = Object.assign(new Error('Method not found: pty.openClient'), { code: -32601 })
|
|
const request = vi.fn().mockRejectedValue(error)
|
|
const mux = { request } as unknown as SshChannelMultiplexer
|
|
|
|
await expect(
|
|
openSshPtyConsumerSession(mux, {
|
|
clientInstanceId: 'client-a',
|
|
expectedServerBuildId: 'build-a',
|
|
allowSameBuildLegacyFallback: true,
|
|
outputFlowControl: { requestedWindowSu: 64 }
|
|
})
|
|
).resolves.toEqual({
|
|
state: {
|
|
mode: 'legacy-fallback',
|
|
clientInstanceId: 'client-a',
|
|
serverBuildId: 'build-a'
|
|
},
|
|
resumed: false
|
|
})
|
|
})
|
|
|
|
it.each([
|
|
Object.assign(new Error('timeout'), { code: 'TIMEOUT' }),
|
|
Object.assign(new Error('auth failed'), { code: -32000 }),
|
|
Object.assign(new Error('method missing'), { code: -32601 })
|
|
])('does not downgrade an unproved or non-method-not-found error', async (error) => {
|
|
const request = vi.fn().mockRejectedValue(error)
|
|
const mux = { request } as unknown as SshChannelMultiplexer
|
|
|
|
await expect(
|
|
openSshPtyConsumerSession(mux, {
|
|
clientInstanceId: 'client-a',
|
|
expectedServerBuildId: 'build-a',
|
|
allowSameBuildLegacyFallback: error.code !== -32601
|
|
})
|
|
).rejects.toBe(error)
|
|
})
|
|
})
|