|
1 | | -import { randomBytes } from "node:crypto" |
2 | 1 | import { execFile } from "node:child_process" |
| 2 | +import { randomBytes } from "node:crypto" |
3 | 3 | import { createConnection } from "node:net" |
4 | 4 | import { promisify } from "node:util" |
5 | 5 | import type { WorkspaceRecipeRuntimeService } from "@automattic/wp-codebox-core" |
6 | 6 |
|
7 | 7 | const execFileAsync = promisify(execFile) |
8 | 8 | const MYSQL_IMAGE = "mysql:8.4" |
9 | 9 |
|
10 | | -export interface RuntimeServiceEvidence { id: string; kind: string; provider: string; version: string; readiness: "ready" | "failed"; lifecycle: "provisioned" | "released"; teardown?: "completed" | "failed" } |
11 | | -interface ManagedRuntimeService { env: Record<string, string>; evidence: RuntimeServiceEvidence; release(): Promise<void> } |
| 10 | +export interface RuntimeServiceEvidence { |
| 11 | + id: string |
| 12 | + kind: string |
| 13 | + provider: string |
| 14 | + version: string |
| 15 | + readiness: "pending" | "ready" | "failed" |
| 16 | + lifecycle: "provisioning" | "provisioned" | "released" | "failed" |
| 17 | + teardown?: "completed" | "failed" |
| 18 | + diagnostic?: { code: "readiness-failed" | "provision-failed" | "teardown-failed" | "interrupted" } |
| 19 | +} |
| 20 | + |
| 21 | +export class RuntimeServiceProvisionError extends Error { |
| 22 | + constructor(message: string, readonly evidence: RuntimeServiceEvidence[]) { |
| 23 | + super(message) |
| 24 | + this.name = "RuntimeServiceProvisionError" |
| 25 | + } |
| 26 | +} |
| 27 | + |
| 28 | +interface ManagedRuntimeService { |
| 29 | + env: Record<string, string> |
| 30 | + evidence: RuntimeServiceEvidence |
| 31 | + release(): Promise<void> |
| 32 | +} |
| 33 | + |
| 34 | +export interface RuntimeServiceDependencies { |
| 35 | + execute(command: string, args: string[], options: { env?: NodeJS.ProcessEnv; signal?: AbortSignal; timeout: number }): Promise<{ stdout: string }> |
| 36 | + waitForReady(host: string, port: number, timeoutMs: number, signal?: AbortSignal): Promise<void> |
| 37 | + randomBytes(size: number): Buffer |
| 38 | +} |
| 39 | + |
| 40 | +const defaultDependencies: RuntimeServiceDependencies = { |
| 41 | + execute: async (command, args, options) => await execFileAsync(command, args, options), |
| 42 | + waitForReady: waitForMysqlProtocol, |
| 43 | + randomBytes, |
| 44 | +} |
12 | 45 |
|
13 | 46 | export function runtimeServicePlan(services: WorkspaceRecipeRuntimeService[]): Array<{ id: string; kind: string; provider: string; version: string; bind: "loopback"; port: "ephemeral"; persistentVolume: false; outputs: Record<string, string> }> { |
14 | 47 | return services.map((service) => ({ id: service.id, kind: service.kind, provider: "docker", version: MYSQL_IMAGE, bind: "loopback", port: "ephemeral", persistentVolume: false, outputs: service.outputs })) |
15 | 48 | } |
16 | 49 |
|
17 | | -export async function provisionRuntimeServices(services: WorkspaceRecipeRuntimeService[]): Promise<{ env: Record<string, string>; evidence: RuntimeServiceEvidence[]; release(): Promise<void> }> { |
| 50 | +export async function provisionRuntimeServices(services: WorkspaceRecipeRuntimeService[], options: { signal?: AbortSignal; dependencies?: RuntimeServiceDependencies } = {}): Promise<{ env: Record<string, string>; evidence: RuntimeServiceEvidence[]; release(): Promise<void> }> { |
| 51 | + const dependencies = options.dependencies ?? defaultDependencies |
18 | 52 | const provisioned: ManagedRuntimeService[] = [] |
19 | | - try { for (const service of services) provisioned.push(await provisionRuntimeService(service)) } catch (error) { await Promise.allSettled(provisioned.map((service) => service.release())); throw error } |
20 | | - return { env: Object.assign({}, ...provisioned.map((service) => service.env)), evidence: provisioned.map((service) => service.evidence), async release() { await Promise.all(provisioned.reverse().map((service) => service.release())) } } |
| 53 | + const evidence: RuntimeServiceEvidence[] = [] |
| 54 | + try { |
| 55 | + for (const service of services) { |
| 56 | + const managed = await provisionRuntimeService(service, dependencies, options.signal, evidence) |
| 57 | + provisioned.push(managed) |
| 58 | + } |
| 59 | + } catch (error) { |
| 60 | + await releaseServices(provisioned) |
| 61 | + if (error instanceof RuntimeServiceProvisionError) throw error |
| 62 | + throw new RuntimeServiceProvisionError("Managed runtime service provisioning failed", evidence) |
| 63 | + } |
| 64 | + |
| 65 | + return { |
| 66 | + env: Object.assign({}, ...provisioned.map((service) => service.env)), |
| 67 | + evidence, |
| 68 | + async release() { |
| 69 | + await releaseServices(provisioned) |
| 70 | + }, |
| 71 | + } |
21 | 72 | } |
22 | 73 |
|
23 | | -async function provisionRuntimeService(service: WorkspaceRecipeRuntimeService): Promise<ManagedRuntimeService> { |
24 | | - if (service.kind !== "mysql") throw new Error(`Unsupported managed runtime service kind: ${service.kind}`) |
25 | | - const container = `wp-codebox-${service.id}-${randomBytes(6).toString("hex")}` |
26 | | - const password = randomBytes(24).toString("base64url") |
27 | | - const args = ["run", "--detach", "--rm", "--name", container, "--publish", "127.0.0.1::3306", "--tmpfs", "/var/lib/mysql", "--env", "MYSQL_DATABASE=runtime", "--env", "MYSQL_USER=runtime", "--env", `MYSQL_PASSWORD=${password}`, "--env", `MYSQL_ROOT_PASSWORD=${password}`, MYSQL_IMAGE] |
| 74 | +async function provisionRuntimeService(service: WorkspaceRecipeRuntimeService, dependencies: RuntimeServiceDependencies, signal: AbortSignal | undefined, evidenceList: RuntimeServiceEvidence[]): Promise<ManagedRuntimeService> { |
| 75 | + const evidence: RuntimeServiceEvidence = { id: service.id, kind: service.kind, provider: "docker", version: MYSQL_IMAGE, readiness: "pending", lifecycle: "provisioning" } |
| 76 | + evidenceList.push(evidence) |
| 77 | + if (service.kind !== "mysql") { |
| 78 | + evidence.lifecycle = "failed" |
| 79 | + evidence.diagnostic = { code: "provision-failed" } |
| 80 | + throw new RuntimeServiceProvisionError(`Unsupported managed runtime service kind: ${service.kind}`, evidenceList) |
| 81 | + } |
| 82 | + |
| 83 | + const container = `wp-codebox-${service.id}-${dependencies.randomBytes(6).toString("hex")}` |
| 84 | + const password = dependencies.randomBytes(24).toString("base64url") |
| 85 | + const childEnvironment = { PATH: process.env.PATH, MYSQL_DATABASE: "runtime", MYSQL_USER: "runtime", MYSQL_PASSWORD: password, MYSQL_ROOT_PASSWORD: password } |
| 86 | + const runArgs = ["run", "--detach", "--rm", "--name", container, "--publish", "127.0.0.1::3306", "--tmpfs", "/var/lib/mysql", "--env", "MYSQL_DATABASE", "--env", "MYSQL_USER", "--env", "MYSQL_PASSWORD", "--env", "MYSQL_ROOT_PASSWORD", MYSQL_IMAGE] |
| 87 | + let started = false |
28 | 88 | try { |
29 | | - await execFileAsync("docker", args, { timeout: 30_000 }) |
30 | | - const { stdout } = await execFileAsync("docker", ["port", container, "3306/tcp"], { timeout: 10_000 }) |
| 89 | + throwIfAborted(signal) |
| 90 | + await dependencies.execute("docker", runArgs, { env: childEnvironment, signal, timeout: 30_000 }) |
| 91 | + started = true |
| 92 | + const { stdout } = await dependencies.execute("docker", ["port", container, "3306/tcp"], { signal, timeout: 10_000 }) |
31 | 93 | const port = parseLoopbackPort(stdout) |
32 | | - await waitForMysqlProtocol("127.0.0.1", port, 30_000) |
| 94 | + await dependencies.waitForReady("127.0.0.1", port, 30_000, signal) |
| 95 | + throwIfAborted(signal) |
| 96 | + evidence.readiness = "ready" |
| 97 | + evidence.lifecycle = "provisioned" |
33 | 98 | const values: Record<string, string> = { host: "127.0.0.1", port: String(port), username: "runtime", password, database: "runtime" } |
34 | | - const env = Object.fromEntries(Object.entries(service.outputs).map(([output, name]) => [name, values[output] ?? ""])) |
35 | | - let released = false |
36 | | - const evidence: RuntimeServiceEvidence = { id: service.id, kind: service.kind, provider: "docker", version: MYSQL_IMAGE, readiness: "ready", lifecycle: "provisioned" } |
37 | | - return { env, evidence, async release() { if (released) return; released = true; try { await execFileAsync("docker", ["rm", "--force", container], { timeout: 30_000 }); evidence.lifecycle = "released"; evidence.teardown = "completed" } catch { evidence.teardown = "failed"; throw new Error(`Managed runtime service teardown failed: ${service.id}`) } } } |
| 99 | + return { env: Object.fromEntries(Object.entries(service.outputs).map(([output, name]) => [name, values[output] ?? ""])), evidence, async release() { await releaseService(container, evidence, dependencies, signal) } } |
| 100 | + } catch (error) { |
| 101 | + evidence.readiness = "failed" |
| 102 | + evidence.lifecycle = "failed" |
| 103 | + evidence.diagnostic = { code: signal?.aborted ? "interrupted" : started ? "readiness-failed" : "provision-failed" } |
| 104 | + if (started) await releaseService(container, evidence, dependencies, undefined).catch(() => undefined) |
| 105 | + throw new RuntimeServiceProvisionError(`Managed runtime service failed: ${service.id}`, evidenceList) |
| 106 | + } |
| 107 | +} |
| 108 | + |
| 109 | +async function releaseServices(services: ManagedRuntimeService[]): Promise<void> { |
| 110 | + const results = await Promise.allSettled([...services].reverse().map(async (service) => await service.release())) |
| 111 | + const failure = results.find((result): result is PromiseRejectedResult => result.status === "rejected") |
| 112 | + if (failure) throw failure.reason |
| 113 | +} |
| 114 | + |
| 115 | +async function releaseService(container: string, evidence: RuntimeServiceEvidence, dependencies: RuntimeServiceDependencies, signal?: AbortSignal): Promise<void> { |
| 116 | + if (evidence.teardown) return |
| 117 | + try { |
| 118 | + await dependencies.execute("docker", ["rm", "--force", container], { signal, timeout: 30_000 }) |
| 119 | + evidence.lifecycle = "released" |
| 120 | + evidence.teardown = "completed" |
38 | 121 | } catch { |
39 | | - await execFileAsync("docker", ["rm", "--force", container], { timeout: 30_000 }).catch(() => undefined) |
40 | | - throw new Error(`Managed runtime service failed readiness: ${service.id} (${MYSQL_IMAGE})`) |
| 122 | + evidence.lifecycle = "failed" |
| 123 | + evidence.teardown = "failed" |
| 124 | + evidence.diagnostic = { code: "teardown-failed" } |
| 125 | + throw new Error(`Managed runtime service teardown failed: ${evidence.id}`) |
41 | 126 | } |
42 | 127 | } |
43 | 128 |
|
44 | 129 | export function parseLoopbackPort(output: string): number { |
45 | | - const match = output.trim().match(/^127\.0\.0\.1:(\d+)$/m); const port = match ? Number(match[1]) : NaN |
| 130 | + const match = output.trim().match(/^127\.0\.0\.1:(\d+)$/m) |
| 131 | + const port = match ? Number(match[1]) : NaN |
46 | 132 | if (!Number.isInteger(port) || port < 1 || port > 65535) throw new Error("Managed runtime service did not publish a loopback port") |
47 | 133 | return port |
48 | 134 | } |
49 | 135 |
|
50 | | -export async function waitForMysqlProtocol(host: string, port: number, timeoutMs: number): Promise<void> { |
| 136 | +export async function waitForMysqlProtocol(host: string, port: number, timeoutMs: number, signal?: AbortSignal): Promise<void> { |
51 | 137 | const deadline = Date.now() + timeoutMs |
52 | | - while (Date.now() < deadline) { try { await mysqlHandshake(host, port); return } catch { await new Promise((resolve) => setTimeout(resolve, 100)) } } |
| 138 | + while (Date.now() < deadline) { |
| 139 | + throwIfAborted(signal) |
| 140 | + try { |
| 141 | + await mysqlHandshake(host, port, signal) |
| 142 | + return |
| 143 | + } catch (error) { |
| 144 | + if (signal?.aborted) throw error |
| 145 | + await abortableDelay(100, signal) |
| 146 | + } |
| 147 | + } |
53 | 148 | throw new Error(`MySQL protocol readiness timed out after ${timeoutMs}ms`) |
54 | 149 | } |
55 | 150 |
|
56 | | -function mysqlHandshake(host: string, port: number): Promise<void> { |
| 151 | +function mysqlHandshake(host: string, port: number, signal?: AbortSignal): Promise<void> { |
57 | 152 | return new Promise((resolve, reject) => { |
58 | | - const socket = createConnection({ host, port }); const timer = setTimeout(() => socket.destroy(new Error("connection timeout")), 1_000) |
| 153 | + const socket = createConnection({ host, port }) |
| 154 | + const timer = setTimeout(() => socket.destroy(new Error("connection timeout")), 1_000) |
| 155 | + const abort = () => socket.destroy(new Error("aborted")) |
| 156 | + signal?.addEventListener("abort", abort, { once: true }) |
59 | 157 | socket.once("error", reject) |
60 | | - socket.once("data", (chunk: Buffer) => { clearTimeout(timer); socket.destroy(); if (chunk.length < 5 || chunk[4] !== 10) reject(new Error("invalid MySQL protocol handshake")); else resolve() }) |
61 | | - socket.once("close", () => clearTimeout(timer)) |
| 158 | + socket.once("data", (chunk: Buffer) => { |
| 159 | + clearTimeout(timer) |
| 160 | + socket.destroy() |
| 161 | + if (chunk.length < 5 || chunk[4] !== 10) reject(new Error("invalid MySQL protocol handshake")) |
| 162 | + else resolve() |
| 163 | + }) |
| 164 | + socket.once("close", () => { clearTimeout(timer); signal?.removeEventListener("abort", abort) }) |
| 165 | + }) |
| 166 | +} |
| 167 | + |
| 168 | +function throwIfAborted(signal: AbortSignal | undefined): void { |
| 169 | + if (signal?.aborted) throw new Error("Managed runtime service provisioning interrupted") |
| 170 | +} |
| 171 | + |
| 172 | +function abortableDelay(milliseconds: number, signal?: AbortSignal): Promise<void> { |
| 173 | + return new Promise((resolve, reject) => { |
| 174 | + const timer = setTimeout(resolve, milliseconds) |
| 175 | + signal?.addEventListener("abort", () => { clearTimeout(timer); reject(new Error("Managed runtime service provisioning interrupted")) }, { once: true }) |
62 | 176 | }) |
63 | 177 | } |
0 commit comments