Files
orca/cloud/dev/scripts/operate-relay-regional-rehome.test.mjs
Jinwoo Hong f5be177e44 fix(relay): rehome hosts to their preferred region in either direction (#19241)
* fix(relay): rehome hosts to their preferred region in either direction

The regional-rehome worker only moved hosts from a us-central1 cell to an
asia-east2 one, so a host whose desktop later records us-central1 stays where
it was put. Rehoming now compares the fresh preference against the region of
the cell the host is on and moves it to a general cell in the preferred
region either way, through the same drain, migrate, safety, and rate-limit
machinery.

- relay_region_rehome_attempts.preferred_region accepts both regions; existing
  databases are upgraded in place by an idempotent named-constraint swap that
  is safe when several directors start at once.
- A target must carry the drain protocol too: moving a host onto a cell it
  can never be drained off again is the trap this change exists to undo. The
  fleet whose health gates a rehome is now every general drainable cell,
  which is exactly the set of legal sources and targets.
- The trust probe accepts a source cell in any region.

No wire change, and no behaviour change while the durable control is off.

* fix(relay): bound bidirectional rehoming with a per-host cooldown

Moving hosts in both directions removed the property that made the old
one-way worker self-terminating: a desktop whose region probe flips would be
dragged back and forth, one full drain and migrate per flip, because the
preference age never expires while the host keeps reconnecting.

- relay_region_rehome_control gains host_cooldown_ms, an operator input
  plumbed like preference_max_age_ms (workflow, ops script, admin route,
  durable row) and defaulted to seven days. A host with any attempt row
  inside the window, whichever way that move went, is not a candidate; the
  claim re-reads it under lock so an attempt landing between scan and claim
  cannot start a second move. Skips are named host_cooldown, and the lookup
  rides a new index on (user_id, relay_host_id, created_at).
- The candidate scan now also requires the target cell to be enabled, so it
  mirrors the claim-time filter exactly and stops spending batch slots on
  candidates that are certain to be skipped.
- Region CHECK lists are rendered from the shared region list instead of
  being written out four times.
- The operations runbook states that cells without the drain protocol are
  neither sources, targets, nor members of the safety gate.

* fix(relay): keep rehome reads and brakes working across the cooldown rollout

The ops script validated hostCooldownMs on every inspected control, so
against any director image predating the field inspect, pause, disable, and
failed-enable recovery all threw client-side. The workflow always runs from
main while the director image is operator-supplied, so that window opened at
merge and reopened on every rollback: the operator lost read-only visibility
and both emergency brakes while the worker could still be enabled.

The field is now validated only when the director reports it, and every apply
body that echoes an inspected control omits the key when that control lacks
it, so a legacy director never sees an unknown key. The write path stays
fail-closed the other way: enable refuses up front, before any mutation, when
the director does not report a cooldown it could honour.

Also replaces two bare 'us-central1' defaults with RELAY_DEFAULT_REGION.
2026-09-07 04:40:37 -04:00

423 lines
13 KiB
JavaScript

import assert from 'node:assert/strict'
import { test } from 'node:test'
import {
main,
operateRegionalRehome,
parseRegionalRehomeArguments,
recoverRegionalRehomeEnable
} from './operate-relay-regional-rehome.mjs'
const membership = {
existingOnly: ['production-gce-c1'],
migrationOnly: ['production-gce-c2'],
general: ['production-gce-c7', 'production-gce-c27']
}
function argumentsFor(mode, confirmation) {
return [
'--mode', mode,
'--director-origin', 'https://relay.onorca.dev',
'--expected-selector-generation', '11',
'--expected-existing-only-cells', membership.existingOnly.join(','),
'--expected-migration-only-cells', membership.migrationOnly.join(','),
'--expected-general-cells', membership.general.join(','),
'--expected-control-generation', '4',
...(mode === 'inspect' ? [] : [
'--not-before', '2000000000000',
'--rate-per-minute', '10',
'--preference-max-age-ms', '86400000',
'--host-cooldown-ms', '604800000',
'--drain-grace-ms', '60000',
'--confirmation', confirmation
])
]
}
function control(generation, enabled) {
return {
generation,
enabled,
observationStartedAt: 1,
notBefore: 2_000_000_000_000,
ratePerMinute: 10,
preferenceMaxAgeMs: 86_400_000,
hostCooldownMs: 604_800_000,
drainGraceMs: 60_000
}
}
// The control a director predating the per-host cooldown reports.
function legacyControl(generation, enabled) {
const { hostCooldownMs: _absent, ...rest } = control(generation, enabled)
return rest
}
function legacyDirector(controls) {
const requests = []
const post = async (path, body) => {
requests.push({ path, body })
if (path === '/v1/admin/admission-selector/status') {
return { selector: { generation: 11, membership } }
}
return { v: 1, control: controls.shift() }
}
return { requests, post }
}
test('parses exact selector and typed control confirmation', () => {
const parsed = parseRegionalRehomeArguments(
argumentsFor('enable', 'ENABLE_REGIONAL_REHOMING'),
{ ORCA_RELAY_ADMIN_ID_TOKEN: 'token' }
)
assert.equal(parsed.expectedSelectorGeneration, 11)
assert.equal(parsed.expectedControlGeneration, 4)
assert.equal(parsed.ratePerMinute, 10)
assert.equal(parsed.hostCooldownMs, 604_800_000)
assert.throws(
() => parseRegionalRehomeArguments(
argumentsFor('enable', 'ENABLE_REGIONAL_REHOMING').filter(
(value, index, all) =>
value !== '--host-cooldown-ms' && all[index - 1] !== '--host-cooldown-ms'
),
{ ORCA_RELAY_ADMIN_ID_TOKEN: 'token' }
),
/complete durable control shape/
)
assert.throws(
() => parseRegionalRehomeArguments(
argumentsFor('pause', 'DISABLE_REGIONAL_REHOMING'),
{ ORCA_RELAY_ADMIN_ID_TOKEN: 'token' }
),
/confirmation/
)
assert.throws(
() => parseRegionalRehomeArguments(
argumentsFor('inspect').concat('--rate-per-minute', '10'),
{ ORCA_RELAY_ADMIN_ID_TOKEN: 'token' }
),
/inspect cannot/
)
})
test('binds enable to exact selector and durable control generations', async () => {
const requests = []
const controls = [
{ generation: 4, enabled: false },
{ generation: 5, enabled: true },
{ generation: 5, enabled: true }
].map((control) => ({
observationStartedAt: 1,
notBefore: 0,
ratePerMinute: 10,
preferenceMaxAgeMs: 86_400_000,
hostCooldownMs: 604_800_000,
drainGraceMs: 60_000,
...control
}))
const config = parseRegionalRehomeArguments(
argumentsFor('enable', 'ENABLE_REGIONAL_REHOMING'),
{ ORCA_RELAY_ADMIN_ID_TOKEN: 'token' }
)
const result = await operateRegionalRehome(config, {
post: async (path, body) => {
requests.push({ path, body })
if (path === '/v1/admin/admission-selector/status') {
return { selector: { generation: 11, membership } }
}
return { v: 1, control: controls.shift() }
}
})
assert.equal(result.control.generation, 5)
assert.equal(result.control.hostCooldownMs, 604_800_000)
assert.deepEqual(requests[2].body, {
v: 1,
action: 'apply',
expectedGeneration: 4,
enabled: true,
notBefore: 2_000_000_000_000,
ratePerMinute: 10,
preferenceMaxAgeMs: 86_400_000,
hostCooldownMs: 604_800_000,
drainGraceMs: 60_000,
confirmation: 'ENABLE_REGIONAL_REHOMING'
})
})
test('inspects a director that predates the per-host cooldown', async () => {
const director = legacyDirector([legacyControl(4, true)])
const config = parseRegionalRehomeArguments(
argumentsFor('inspect'),
{ ORCA_RELAY_ADMIN_ID_TOKEN: 'token' }
)
const result = await operateRegionalRehome(config, { post: director.post })
assert.equal(result.control.generation, 4)
assert.equal(result.control.hostCooldownMs, undefined)
})
for (const [mode, confirmation, enabledBefore] of [
['pause', 'PAUSE_REGIONAL_REHOMING', true],
['disable', 'DISABLE_REGIONAL_REHOMING', false]
]) {
test(`${mode} still brakes a director that predates the cooldown`, async () => {
const director = legacyDirector([
legacyControl(4, enabledBefore),
legacyControl(5, false),
legacyControl(5, false)
])
const config = parseRegionalRehomeArguments(
argumentsFor(mode, confirmation),
{ ORCA_RELAY_ADMIN_ID_TOKEN: 'token' }
)
const result = await operateRegionalRehome(config, { post: director.post })
assert.equal(result.control.generation, 5)
// The unknown key would be refused by that director's strict schema.
assert.equal('hostCooldownMs' in director.requests[2].body, false)
assert.equal(director.requests[2].body.confirmation, 'DISABLE_REGIONAL_REHOMING')
})
}
test('failed-enable recovery brakes a director that predates the cooldown', async () => {
const requests = []
let current = legacyControl(7, true)
const result = await recoverRegionalRehomeEnable({
mode: 'recover-enable',
expectedControlGeneration: 4
}, async (_path, body) => {
requests.push(body)
if (body.action === 'inspect') return { control: current }
current = legacyControl(8, false)
return { control: current }
})
assert.equal(result.control.generation, 8)
assert.equal('hostCooldownMs' in requests[1], false)
})
test('refuses to enable a director that does not report the cooldown', async () => {
const director = legacyDirector([legacyControl(4, false)])
const config = parseRegionalRehomeArguments(
argumentsFor('enable', 'ENABLE_REGIONAL_REHOMING'),
{ ORCA_RELAY_ADMIN_ID_TOKEN: 'token' }
)
await assert.rejects(
operateRegionalRehome(config, { post: director.post }),
/per-host rehome cooldown/
)
// Read-only: selector status and the control inspect, and nothing else.
assert.equal(director.requests.length, 2)
assert.equal(director.requests.every(({ body }) => body.action !== 'apply'), true)
})
test('fails closed on selector drift before reading or mutating control', async () => {
let calls = 0
const config = parseRegionalRehomeArguments(
argumentsFor('disable', 'DISABLE_REGIONAL_REHOMING'),
{ ORCA_RELAY_ADMIN_ID_TOKEN: 'token' }
)
await assert.rejects(
operateRegionalRehome(config, {
post: async () => {
calls += 1
return { selector: { generation: 12, membership } }
}
}),
/selector/
)
assert.equal(calls, 1)
})
test('failed-enable recovery CAS-disables an advanced enabled generation', async () => {
const requests = []
let current = control(7, true)
const result = await recoverRegionalRehomeEnable({
mode: 'recover-enable',
expectedControlGeneration: 4
}, async (_path, body) => {
requests.push(body)
if (body.action === 'inspect') return { control: current }
assert.equal(body.expectedGeneration, 7)
current = control(8, false)
throw new Error('enable recovery response was lost')
})
assert.equal(result.recovered, true)
assert.deepEqual(result.control, control(8, false))
assert.deepEqual(requests[1], {
v: 1,
action: 'apply',
expectedGeneration: 7,
enabled: false,
notBefore: 2_000_000_000_000,
ratePerMinute: 10,
preferenceMaxAgeMs: 86_400_000,
hostCooldownMs: 604_800_000,
drainGraceMs: 60_000,
confirmation: 'DISABLE_REGIONAL_REHOMING'
})
})
test('failed-enable recovery retries once when the first CAS never commits', async () => {
let current = control(7, true)
const applyRequests = []
const result = await recoverRegionalRehomeEnable({
mode: 'recover-enable',
expectedControlGeneration: 4
}, async (_path, body) => {
if (body.action === 'inspect') return { control: current }
applyRequests.push(body)
if (applyRequests.length === 1) {
throw new Error('disable request was lost before commit')
}
current = control(8, false)
throw new Error('retry response was lost after commit')
})
assert.equal(applyRequests.length, 2)
assert.deepEqual(applyRequests[1], applyRequests[0])
assert.equal(result.recovered, true)
assert.deepEqual(result.control, control(8, false))
})
test('failed-enable recovery stops after two uncommitted CAS attempts', async () => {
let applyCalls = 0
await assert.rejects(
recoverRegionalRehomeEnable({
mode: 'recover-enable',
expectedControlGeneration: 4
}, async (_path, body) => {
if (body.action === 'inspect') return { control: control(7, true) }
applyCalls += 1
throw new Error(`disable attempt ${applyCalls} was lost before commit`)
}),
/exhausted two bounded CAS attempts/
)
assert.equal(applyCalls, 2)
})
test('failed-enable recovery is a verified no-op before enable and after cleanup', async () => {
for (const current of [control(4, false), control(8, false)]) {
const requests = []
const result = await recoverRegionalRehomeEnable({
mode: 'recover-enable',
expectedControlGeneration: 4
}, async (_path, body) => {
requests.push(body)
return { control: current }
})
assert.equal(result.recovered, false)
assert.equal(result.control.enabled, false)
assert.deepEqual(requests.map(({ action }) => action), ['inspect', 'inspect'])
}
})
test('failed-enable recovery rejects an unchanged pre-existing enabled state', async () => {
await assert.rejects(
recoverRegionalRehomeEnable({
mode: 'recover-enable',
expectedControlGeneration: 4
}, async () => ({ control: control(4, true) })),
/cannot belong to the failed enable attempt/
)
})
test('parses recovery without depending on selector diagnostics', () => {
const recoveryArguments = [
'--mode', 'recover-enable',
'--director-origin', 'https://relay.onorca.dev',
'--expected-control-generation', '4',
'--confirmation', 'RECOVER_FAILED_REGIONAL_REHOME_ENABLE'
]
const parsed = parseRegionalRehomeArguments(
recoveryArguments,
{ ORCA_RELAY_ADMIN_ID_TOKEN: 'token' }
)
assert.equal(parsed.expectedControlGeneration, 4)
assert.equal(parsed.expectedMembership, undefined)
assert.throws(
() => parseRegionalRehomeArguments(
recoveryArguments.concat('--not-before', '2000000000000'),
{ ORCA_RELAY_ADMIN_ID_TOKEN: 'token' }
),
/cannot carry durable control shape/
)
})
test('main executes recovery mode and emits verified disabled control', async () => {
let current = control(5, true)
let output = ''
await main([
'--mode', 'recover-enable',
'--director-origin', 'https://relay.onorca.dev',
'--expected-control-generation', '4',
'--confirmation', 'RECOVER_FAILED_REGIONAL_REHOME_ENABLE'
], { ORCA_RELAY_ADMIN_ID_TOKEN: 'token' }, {
post: async (_path, body) => {
if (body.action === 'apply') current = control(6, false)
return { control: current }
}
}, (value) => {
output += value
})
assert.deepEqual(JSON.parse(output), {
event: 'relay_regional_rehome_control',
mode: 'recover-enable',
recovered: true,
control: control(6, false)
})
})
test('retries a transient 503 on the director control endpoint', async () => {
const config = parseRegionalRehomeArguments(
argumentsFor('inspect'),
{ ORCA_RELAY_ADMIN_ID_TOKEN: 'token' }
)
const paths = []
let selectorCalls = 0
const result = await operateRegionalRehome(config, {
wait: async () => {},
fetch: async (url) => {
const path = new URL(url).pathname
paths.push(path)
if (path === '/v1/admin/admission-selector/status') {
selectorCalls += 1
// The first read of each admin path 503s the way a warming instance does.
if (selectorCalls === 1) return new Response('warming up', { status: 503 })
return Response.json({ selector: { generation: 11, membership } })
}
if (paths.filter((value) => value === path).length === 1) {
return new Response('warming up', { status: 503 })
}
return Response.json({ v: 1, control: control(4, false) })
}
})
assert.equal(result.control.generation, 4)
assert.deepEqual(paths, [
'/v1/admin/admission-selector/status',
'/v1/admin/admission-selector/status',
'/v1/admin/regional-rehome-control',
'/v1/admin/regional-rehome-control'
])
})
test('fails when both attempts at the director control endpoint return 503', async () => {
const config = parseRegionalRehomeArguments(
argumentsFor('inspect'),
{ ORCA_RELAY_ADMIN_ID_TOKEN: 'token' }
)
let calls = 0
await assert.rejects(
operateRegionalRehome(config, {
wait: async () => {},
fetch: async () => {
calls += 1
return new Response('warming up', { status: 503 })
}
}),
/returned 503/
)
assert.equal(calls, 2)
})