@serfab/cadre-host 0.9.0 → 0.11.0

package/src/orchestrator/types.ts

@@ -1,141 +1,141 @@
-/**
- * Public + internal types for the HostProcessOrchestrator.
- */
-
-import type { ChildProcess } from 'node:child_process';
-import type { PushCredentials } from '@serfab/cadre-core';
-
-/** User-facing configuration for `HostProcessOrchestrator`. */
-export interface HostProcessConfig {
-  /** Root directory under which per-container workdirs live. */
-  rootDir: string;
-  /** Port allocation range (default 10000..20000). */
-  portRange?: { start: number; end: number };
-  /** Default resource limits (memory only in v1). */
-  defaultResources?: { memoryLimit?: string };
-  /** SIGTERM → SIGKILL grace period (default 10000 ms). */
-  stopTimeoutMs?: number;
-  /** Log rotation: bytes per file (default 10 MB). */
-  logMaxBytes?: number;
-  /** Log rotation: max rotated files (default 5). */
-  logMaxFiles?: number;
-  /**
-   * Test-only hook: override the child entrypoint. When set, the orchestrator
-   * spawns `node <entrypoint> ...` instead of resolving `@serfab/cadre-cli`.
-   */
-  spawn?: { entrypoint?: string };
-  /**
-   * Resolver for the platform push credentials (FCM/APNs) to inject into a
-   * spawned strand-participating node's `cadre.json` (`config.push`). Called
-   * fresh on EVERY spawn/re-spawn so the secret store stays the source of truth
-   * and no raw private key is ever persisted in `state.json`. Returns `undefined`
-   * when no push credentials are configured (the default — push is opt-in). The
-   * resolver itself is responsible for rejecting a partial credential set.
-   */
-  pushResolver?: PushCredentialsResolver;
-}
-
-/**
- * Resolves the push credentials to inject into a node being spawned. Re-invoked
- * per spawn so a restart re-reads the secret store rather than replaying stale
- * (or persisted) material. See {@link HostProcessConfig.pushResolver}.
- */
-export type PushCredentialsResolver = () => Promise<PushCredentials | undefined>;
-
-/** Per-child allocated ports. `admin` carries the loopback admin channel (6.6). */
-export interface NodePorts {
-  health: number;
-  metrics: number;
-  p2p: number;
-  /** Loopback admin-channel port. Bound only by the owner node. */
-  admin: number;
-}
-
-/** In-memory record per managed child. */
-export interface Handle {
-  containerId: string;
-  dockerId: string;
-  pid: number;
-  startupToken: string;
-  workdir: string;
-  ports: NodePorts;
-  spawnedAt: string;
-  partyId: string;
-  profile: 'storage' | 'transaction';
-  /** True for the admin's owner node (binds the admin channel). */
-  owner?: boolean;
-  /** Live ChildProcess reference; absent after re-attach via init(). */
-  child?: ChildProcess;
-  /** Marked false when init() finds the PID dead or token mismatched. */
-  alive: boolean;
-}
-
-/** Public view of a managed node — surfaced to `/api/nodes` callers. */
-export interface ManagedNodeInfo {
-  /** Friendly container id passed at create time. */
-  id: string;
-  /** Opaque dockerId (`pid:token`) — pass to stop/getStats/getLogs. */
-  dockerId: string;
-  partyId: string;
-  profile: 'storage' | 'transaction';
-  /** Runtime state derived from `Handle.alive`. */
-  status: 'running' | 'stopped';
-  spawnedAt: string;
-  workdir: string;
-  ports: NodePorts;
-  /** True for the admin's owner node. */
-  owner?: boolean;
-}
-
-/**
- * Persisted spawn parameters for the admin's owner node. Stored alongside
- * the handles so an orchestrator restart can re-spawn the owner node from
- * `/api/nodes/:id/{start,restart}` without the caller re-supplying them.
- */
-export interface OwnerSpawnConfig {
-  /** Absolute path to the host's libp2p protobuf identity (`identity.key`). */
-  identityPath: string;
-  /** Control-network partyId (the host's installId). */
-  partyId: string;
-  /** External libp2p port — mapped to the child's listen address. */
-  libp2pPort: number;
-  /** Node profile. Defaults to `storage` (the household node holds strands). */
-  profile?: 'storage' | 'transaction';
-}
-
-/**
- * Listener invoked when a managed node's lifecycle state changes
- * (create, child exit, manual stop). Subscribe via
- * `HostProcessOrchestrator.onStateChange`.
- */
-export type NodeStateListener = (info: ManagedNodeInfo) => void;
-
-const TOKEN_SEPARATOR = ':';
-
-/**
- * Encode an opaque handle that callers treat the same way they treat a
- * Docker container hash. The shape is `<pid>:<token>`; tokens are hex
- * generated from `crypto.randomBytes` so they never contain `:`.
- */
-export function encodeDockerId(pid: number, token: string): string {
-  if (!Number.isInteger(pid) || pid <= 0) {
-    throw new Error(`Invalid pid for docker id: ${pid}`);
-  }
-  if (token.length === 0 || token.includes(TOKEN_SEPARATOR)) {
-    throw new Error(`Invalid token for docker id: ${JSON.stringify(token)}`);
-  }
-  return `${pid}${TOKEN_SEPARATOR}${token}`;
-}
-
-export function decodeDockerId(id: string): { pid: number; token: string } {
-  const idx = id.indexOf(TOKEN_SEPARATOR);
-  if (idx <= 0) {
-    throw new Error(`Malformed dockerId: ${id}`);
-  }
-  const pid = Number.parseInt(id.slice(0, idx), 10);
-  const token = id.slice(idx + 1);
-  if (!Number.isInteger(pid) || pid <= 0 || token.length === 0) {
-    throw new Error(`Malformed dockerId: ${id}`);
-  }
-  return { pid, token };
-}
+/**
+ * Public + internal types for the HostProcessOrchestrator.
+ */
+
+import type { ChildProcess } from 'node:child_process';
+import type { PushCredentials } from '@serfab/cadre-core';
+
+/** User-facing configuration for `HostProcessOrchestrator`. */
+export interface HostProcessConfig {
+  /** Root directory under which per-container workdirs live. */
+  rootDir: string;
+  /** Port allocation range (default 10000..20000). */
+  portRange?: { start: number; end: number };
+  /** Default resource limits (memory only in v1). */
+  defaultResources?: { memoryLimit?: string };
+  /** SIGTERM → SIGKILL grace period (default 10000 ms). */
+  stopTimeoutMs?: number;
+  /** Log rotation: bytes per file (default 10 MB). */
+  logMaxBytes?: number;
+  /** Log rotation: max rotated files (default 5). */
+  logMaxFiles?: number;
+  /**
+   * Test-only hook: override the child entrypoint. When set, the orchestrator
+   * spawns `node <entrypoint> ...` instead of resolving `@serfab/cadre-cli`.
+   */
+  spawn?: { entrypoint?: string };
+  /**
+   * Resolver for the platform push credentials (FCM/APNs) to inject into a
+   * spawned strand-participating node's `cadre.json` (`config.push`). Called
+   * fresh on EVERY spawn/re-spawn so the secret store stays the source of truth
+   * and no raw private key is ever persisted in `state.json`. Returns `undefined`
+   * when no push credentials are configured (the default — push is opt-in). The
+   * resolver itself is responsible for rejecting a partial credential set.
+   */
+  pushResolver?: PushCredentialsResolver;
+}
+
+/**
+ * Resolves the push credentials to inject into a node being spawned. Re-invoked
+ * per spawn so a restart re-reads the secret store rather than replaying stale
+ * (or persisted) material. See {@link HostProcessConfig.pushResolver}.
+ */
+export type PushCredentialsResolver = () => Promise<PushCredentials | undefined>;
+
+/** Per-child allocated ports. `admin` carries the loopback admin channel (6.6). */
+export interface NodePorts {
+  health: number;
+  metrics: number;
+  p2p: number;
+  /** Loopback admin-channel port. Bound only by the owner node. */
+  admin: number;
+}
+
+/** In-memory record per managed child. */
+export interface Handle {
+  containerId: string;
+  dockerId: string;
+  pid: number;
+  startupToken: string;
+  workdir: string;
+  ports: NodePorts;
+  spawnedAt: string;
+  partyId: string;
+  profile: 'storage' | 'transaction';
+  /** True for the admin's owner node (binds the admin channel). */
+  owner?: boolean;
+  /** Live ChildProcess reference; absent after re-attach via init(). */
+  child?: ChildProcess;
+  /** Marked false when init() finds the PID dead or token mismatched. */
+  alive: boolean;
+}
+
+/** Public view of a managed node — surfaced to `/api/nodes` callers. */
+export interface ManagedNodeInfo {
+  /** Friendly container id passed at create time. */
+  id: string;
+  /** Opaque dockerId (`pid:token`) — pass to stop/getStats/getLogs. */
+  dockerId: string;
+  partyId: string;
+  profile: 'storage' | 'transaction';
+  /** Runtime state derived from `Handle.alive`. */
+  status: 'running' | 'stopped';
+  spawnedAt: string;
+  workdir: string;
+  ports: NodePorts;
+  /** True for the admin's owner node. */
+  owner?: boolean;
+}
+
+/**
+ * Persisted spawn parameters for the admin's owner node. Stored alongside
+ * the handles so an orchestrator restart can re-spawn the owner node from
+ * `/api/nodes/:id/{start,restart}` without the caller re-supplying them.
+ */
+export interface OwnerSpawnConfig {
+  /** Absolute path to the host's libp2p protobuf identity (`identity.key`). */
+  identityPath: string;
+  /** Control-network partyId (the host's installId). */
+  partyId: string;
+  /** External libp2p port — mapped to the child's listen address. */
+  libp2pPort: number;
+  /** Node profile. Defaults to `storage` (the household node holds strands). */
+  profile?: 'storage' | 'transaction';
+}
+
+/**
+ * Listener invoked when a managed node's lifecycle state changes
+ * (create, child exit, manual stop). Subscribe via
+ * `HostProcessOrchestrator.onStateChange`.
+ */
+export type NodeStateListener = (info: ManagedNodeInfo) => void;
+
+const TOKEN_SEPARATOR = ':';
+
+/**
+ * Encode an opaque handle that callers treat the same way they treat a
+ * Docker container hash. The shape is `<pid>:<token>`; tokens are hex
+ * generated from `crypto.randomBytes` so they never contain `:`.
+ */
+export function encodeDockerId(pid: number, token: string): string {
+  if (!Number.isInteger(pid) || pid <= 0) {
+    throw new Error(`Invalid pid for docker id: ${pid}`);
+  }
+  if (token.length === 0 || token.includes(TOKEN_SEPARATOR)) {
+    throw new Error(`Invalid token for docker id: ${JSON.stringify(token)}`);
+  }
+  return `${pid}${TOKEN_SEPARATOR}${token}`;
+}
+
+export function decodeDockerId(id: string): { pid: number; token: string } {
+  const idx = id.indexOf(TOKEN_SEPARATOR);
+  if (idx <= 0) {
+    throw new Error(`Malformed dockerId: ${id}`);
+  }
+  const pid = Number.parseInt(id.slice(0, idx), 10);
+  const token = id.slice(idx + 1);
+  if (!Number.isInteger(pid) || pid <= 0 || token.length === 0) {
+    throw new Error(`Malformed dockerId: ${id}`);
+  }
+  return { pid, token };
+}