Skip to content

Never stop coding. Free MIT AI gateway: one endpoint, 375 providers (150+ free), 1,400+ models Kimi, Claude, GPT, Gemini, GLM, DeepSeek, MiniMax. Works with Claude Code, Codex, Cursor, OpenCode, Cline & Copilot. Quota-aware auto-fallback, RTK+Caveman compression saves 15-95% tokens, MCP/A2A, Desktop/PWA. Built by 900+ contributors

22.2 KB
Raw Blame
import {
  createCodexAccountPool,
  getCodexParentAccountDiagnostic,
} from "@omniroute/open-sse/services/codexAccount/index.ts";
import type { AdaptiveAdmissionPublicSnapshot } from "@omniroute/open-sse/services/admission/runtime.ts";
import type { PerConnectionAdmissionController } from "@/shared/middleware/chatBodyAdmission";
import type { WalMaintenanceState } from "@/lib/db/walMaintenance";

type JsonRecord = Record<string, unknown>;

/** Process-wide structural chat-admission snapshot type (chatBodyAdmission.ts). */
export type ChatAdmissionSnapshot = ReturnType<PerConnectionAdmissionController["snapshot"]>;

/**
 * Low-card structural chat-admission health summary (#11244) — the bounded
 * heavyweight-lease gate from chatBodyAdmission.ts (#10110/#10437), NOT the
 * adaptive shadow-mode layer above. Lane keys are opaque HMAC fairness
 * fingerprints (resolveSessionId), never raw credentials.
 */
export type ChatAdmissionHealthSummary = {
  activeHeavy: number;
  activeHealthyHeadroom: number;
  waiting: number;
  queuedBytes: number;
  shedTotal: number;
  shedsByReason: Record<string, number>;
  lanes: Array<{ key: string; waiting: number }>;
  /** #503-fanout: live ingest bytes reserved through the byte-budget gate. */
  inflightBytes: number;
  /** #503-fanout: the auto-derived (or overridden) budget ceiling. */
  maxInflightBytes: number;
  /** #503-fanout: which signal the budget was derived from. */
  budgetSource: string;
  /** #503-fanout: live multi-signal resource-pressure severity. */
  pressureSeverity: string;
  /** #503-fanout: false on a default deployment — proves the byte-budget
   * gate, not the legacy request-count cap, is what is actually binding. */
  countCapEnabled: boolean;
};

/**
 * WAL maintenance health summary (#12853) — the periodic TRUNCATE lifecycle
 * from walMaintenance.ts. Fixed low-cardinality shape, never raw-spread.
 */
export type WalMaintenanceSnapshot = Pick<
  WalMaintenanceState,
  "ticks" | "busyStreak" | "busyTotal" | "lastBusyAt" | "lastOkAt"
>;

/**
 * Explicit allowlisted projection of the WAL maintenance state.
 * Copies only the documented scalar fields — no timers, no internals.
 */
export function projectWalMaintenanceSummary(
  state: WalMaintenanceState | null | undefined
): WalMaintenanceSnapshot | null {
  if (!state || typeof state !== "object") return null;
  return {
    ticks: state.ticks,
    busyStreak: state.busyStreak,
    busyTotal: state.busyTotal,
    lastBusyAt: state.lastBusyAt,
    lastOkAt: state.lastOkAt,
  };
}

/**
 * Explicit allowlisted projection of the structural admission snapshot.
 * Never spreads the snapshot — only the documented low-cardinality fields pass.
 */
export function projectChatAdmissionSummary(
  snapshot: ChatAdmissionSnapshot | null | undefined
): ChatAdmissionHealthSummary | null {
  if (!snapshot || typeof snapshot !== "object") return null;
  return {
    activeHeavy: snapshot.activeHeavy,
    activeHealthyHeadroom: snapshot.activeHealthyHeadroom,
    waiting: snapshot.waiting,
    queuedBytes: snapshot.queuedBytes,
    shedTotal: snapshot.shedTotal,
    shedsByReason: { ...(snapshot.shedsByReason ?? {}) },
    lanes: (snapshot.lanes ?? []).map((lane) => ({ key: lane.key, waiting: lane.waiting })),
    inflightBytes: snapshot.inflightBytes,
    maxInflightBytes: snapshot.maxInflightBytes,
    budgetSource: snapshot.budgetSource,
    pressureSeverity: snapshot.pressureSeverity,
    countCapEnabled: snapshot.countCapEnabled,
  };
}

/** Low-card adaptive-admission health summary — no tenant/request/body/queue details. */
export type AdaptiveAdmissionHealthSummary = {
  mode: AdaptiveAdmissionPublicSnapshot["mode"];
  currentLimit: number;
  minLimit: number;
  maxLimit: number;
  activeCost: number;
  activeCount: number;
  queuedCost: number;
  queuedCount: number;
  admittedCount: number;
  rejectedCount: number;
  wouldAdmitCount: number;
  wouldQueueCount: number;
  wouldRejectCount: number;
  utilization: number;
  pressure: AdaptiveAdmissionPublicSnapshot["pressure"];
  resourceSeverity: AdaptiveAdmissionPublicSnapshot["resourceSeverity"];
  resourceReason: AdaptiveAdmissionPublicSnapshot["resourceReason"];
  resourceObservedAtMs: number;
  pressureGuardRejectCount: number;
  shutdown: boolean;
};

/**
 * Explicit allowlisted projection of the public adaptive-admission snapshot.
 * Never spreads the snapshot — extra keys (tenant, body, queue items, paths) are dropped.
 */
export function projectAdaptiveAdmissionSummary(
  snapshot: AdaptiveAdmissionPublicSnapshot | null | undefined
): AdaptiveAdmissionHealthSummary | null {
  if (!snapshot || typeof snapshot !== "object") return null;
  return {
    mode: snapshot.mode,
    currentLimit: snapshot.currentLimit,
    minLimit: snapshot.minLimit,
    maxLimit: snapshot.maxLimit,
    activeCost: snapshot.activeCost,
    activeCount: snapshot.activeCount,
    queuedCost: snapshot.queuedCost,
    queuedCount: snapshot.queuedCount,
    admittedCount: snapshot.admittedCount,
    rejectedCount: snapshot.rejectedCount,
    wouldAdmitCount: snapshot.wouldAdmitCount,
    wouldQueueCount: snapshot.wouldQueueCount,
    wouldRejectCount: snapshot.wouldRejectCount,
    utilization: snapshot.utilization,
    pressure: snapshot.pressure,
    resourceSeverity: snapshot.resourceSeverity,
    resourceReason: snapshot.resourceReason,
    resourceObservedAtMs: snapshot.resourceObservedAtMs,
    pressureGuardRejectCount: snapshot.pressureGuardRejectCount,
    shutdown: snapshot.shutdown,
  };
}

interface CircuitBreakerStatus {
  name: string;
  state: string;
  failureCount?: number;
  lastFailureTime?: number | string | null;
  retryAfterMs?: number;
}

interface SessionSnapshot {
  sessionId: string;
  createdAt: number;
  lastActive: number;
  requestCount: number;
  connectionId: string | null;
  ageMs: number;
}

interface QuotaMonitorSnapshot {
  sessionId: string;
  provider: string;
  accountId: string;
  status: "starting" | "idle" | "healthy" | "warning" | "exhausted" | "error";
  startedAt: string;
  lastPolledAt: string | null;
  lastSuccessAt: string | null;
  lastErrorAt: string | null;
  lastError: string | null;
  lastQuotaPercent: number | null;
  lastQuotaUsed: number | null;
  lastQuotaTotal: number | null;
  lastResetAt: string | null;
  lastAlertAt: string | null;
  nextPollDelayMs: number | null;
  nextPollAt: string | null;
  totalPolls: number;
  totalAlerts: number;
  consecutiveFailures: number;
}

interface QuotaMonitorSummary {
  active: number;
  alerting: number;
  exhausted: number;
  errors: number;
  statusCounts: Record<QuotaMonitorSnapshot["status"], number>;
  byProvider: Record<string, number>;
}

interface BuildSessionsSummaryOptions {
  activeSessions: SessionSnapshot[];
  activeSessionsByKey?: Record<string, number>;
}

interface BuildTelemetryPayloadOptions {
  summary: {
    count: number;
    avg?: number;
    p50: number;
    p95: number;
    p99: number;
    phaseBreakdown: JsonRecord;
  };
  quotaMonitorSummary: QuotaMonitorSummary;
  activeSessions: SessionSnapshot[];
}

/** Event-loop stall counters for the recorder started at boot. */
export type EventLoopStallSummary = {
  count: number;
  maxMs: number;
};

interface BuildHealthPayloadOptions {
  appVersion: string;
  /** #10427: git SHA the running artifact was built from, so a deploy is auditable over HTTP. */
  buildSha?: string | null;
  catalogCount?: number;
  settings: { setupComplete?: boolean } | null | undefined;
  connections: Array<{
    id?: string;
    provider?: string;
    isActive?: boolean | null;
    testStatus?: string | null;
    rateLimitedUntil?: unknown;
    providerSpecificData?: Readonly<Record<string, unknown>> | null;
  }>;
  circuitBreakers: CircuitBreakerStatus[];
  rateLimitStatus: JsonRecord;
  learnedLimits: JsonRecord;
  lockouts: JsonRecord;
  localProviders: JsonRecord;
  inflightRequests: number;
  quotaMonitorSummary: QuotaMonitorSummary;
  quotaMonitorMonitors: QuotaMonitorSnapshot[];
  activeSessions: SessionSnapshot[];
  activeSessionsByKey?: Record<string, number>;
  credentialHealth?: {
    total: number;
    healthy: number;
    failed: number;
    unknown: number;
    stale: number;
    failedConnections?: Array<{
      connectionId: string;
      status: "error";
      lastError?: string;
      lastErrorType?: string;
    }>;
    failedOmitted?: number;
  };
  /** Optional injected public adaptive-admission snapshot; projected, never raw-spread. */
  adaptiveAdmission?: AdaptiveAdmissionPublicSnapshot | null;
  /** #11244: optional structural chat-admission snapshot; projected, never raw-spread. */
  chatAdmission?: ChatAdmissionSnapshot | null;
  /** #12853: optional WAL maintenance snapshot; projected, never raw-spread. */
  walMaintenance?: WalMaintenanceSnapshot | null;
  /** Stall counters from the boot recorder (healthzLag); additive key, nothing moves. */
  eventLoopStall?: EventLoopStallSummary | null;
}

function limitMonitors(monitors: QuotaMonitorSnapshot[], maxItems = 8): QuotaMonitorSnapshot[] {
  return monitors.slice(0, maxItems);
}

/**
 * SQLite `test_status` values that stay sticky on active rows even when the
 * in-memory probe-cache gauge reports failed=0 (expired / quota / banned).
 */
const STICKY_DB_NON_OK_TEST_STATUS = new Set([
  "error",
  "expired",
  "credits_exhausted",
  "banned",
  "deactivated",
  "unavailable",
]);

/**
 * Count is_active=1 (or unset) rows whose persisted test_status is a known
 * non-ok. This is a cheap SQLite-layer signal and is not the probe-cache
 * `failed` gauge.
 */
export function countStaleDbNonOkConnections(
  connections: BuildHealthPayloadOptions["connections"]
): number {
  let count = 0;
  for (const connection of connections) {
    if (connection.isActive === false) continue;
    const status = (connection.testStatus ?? "").trim().toLowerCase();
    if (STICKY_DB_NON_OK_TEST_STATUS.has(status)) count += 1;
  }
  return count;
}

function projectCredentialHealth(
  credentialHealth: BuildHealthPayloadOptions["credentialHealth"],
  connections: BuildHealthPayloadOptions["connections"]
) {
  if (!credentialHealth) return undefined;
  return {
    ...credentialHealth,
    source: "probe-cache" as const,
    staleDbNonOkCount: countStaleDbNonOkConnections(connections),
  };
}

export function buildSessionsSummary({
  activeSessions,
  activeSessionsByKey = {},
}: BuildSessionsSummaryOptions) {
  const ordered = [...activeSessions].sort((left, right) => right.lastActive - left.lastActive);
  const stickyBoundCount = ordered.filter((entry) => entry.connectionId).length;

  return {
    activeCount: ordered.length,
    stickyBoundCount,
    byApiKey: activeSessionsByKey,
    top: ordered.slice(0, 8).map((entry) => ({
      sessionId: entry.sessionId,
      requestCount: entry.requestCount,
      connectionId: entry.connectionId,
      ageMs: entry.ageMs,
      idleMs: Math.max(0, Date.now() - entry.lastActive),
      createdAt: new Date(entry.createdAt).toISOString(),
      lastActiveAt: new Date(entry.lastActive).toISOString(),
    })),
  };
}

export function buildTelemetryPayload({
  summary,
  quotaMonitorSummary,
  activeSessions,
}: BuildTelemetryPayloadOptions) {
  const sessions = buildSessionsSummary({ activeSessions });
  return {
    ...summary,
    totalRequests: summary.count,
    avgLatencyMs: summary.avg ?? summary.p50,
    sessions: {
      activeCount: sessions.activeCount,
      stickyBoundCount: sessions.stickyBoundCount,
    },
    quotaMonitor: {
      active: quotaMonitorSummary.active,
      alerting: quotaMonitorSummary.alerting,
      exhausted: quotaMonitorSummary.exhausted,
      errors: quotaMonitorSummary.errors,
      statusCounts: quotaMonitorSummary.statusCounts,
    },
  };
}

/** Per-provider connection-cooldown summary, exposed as `connectionHealth[provider]`. */
export interface ConnectionCooldownSummary {
  /** Connections currently in cooldown (future `rateLimitedUntil`). Always > 0 when present. */
  coolingDown: number;
  /** Total connections configured for the provider. */
  total: number;
  /** Relative ms until the first cooling connection recovers (the soonest). */
  soonestRetryAfterMs: number;
}

/**
 * Parse a connection's `rateLimitedUntil` to an absolute epoch (ms). Mirrors the
 * canonical `cooldownUntilMs` (open-sse/services/accountFallback.ts, #3954) — kept
 * inline so this monitoring util stays decoupled from the heavy executor module.
 * Accepts ISO strings, Date objects, and numeric-epoch strings (the SQLite
 * TEXT-affinity case where `new Date(...)` would yield NaN).
 */
function parseCooldownUntilMs(value: unknown): number {
  if (value === null || value === undefined || value === "") return NaN;
  if (value instanceof Date) return value.getTime();
  if (typeof value === "number") return value;
  if (typeof value !== "string") return NaN;
  const raw = value.trim();
  if (/^\d+(\.\d+)?$/.test(raw)) return Number(raw);
  return new Date(raw).getTime();
}

/**
 * Aggregate per-connection cooldown state into a per-provider summary. Only providers
 * with at least one connection still cooling down (future `rateLimitedUntil`) appear in
 * the result — mirroring `providerHealth`, which only carries non-healthy breakers — so
 * the cascade overlay attaches a badge only when there is something to show.
 *
 * `nowMs` is injected (not read from the clock here) to keep the function pure/testable.
 */
export function summarizeConnectionCooldown(
  connections: Array<{ provider?: string; rateLimitedUntil?: unknown }>,
  nowMs: number
): Record<string, ConnectionCooldownSummary> {
  const byProvider: Record<string, { total: number; coolingDown: number; soonestUntil: number }> =
    {};
  for (const connection of connections) {
    const provider = connection?.provider;
    if (!provider) continue;
    const bucket = (byProvider[provider] ??= {
      total: 0,
      coolingDown: 0,
      soonestUntil: Infinity,
    });
    bucket.total += 1;
    const until = parseCooldownUntilMs(connection.rateLimitedUntil);
    if (Number.isFinite(until) && until > nowMs) {
      bucket.coolingDown += 1;
      if (until < bucket.soonestUntil) bucket.soonestUntil = until;
    }
  }

  const summary: Record<string, ConnectionCooldownSummary> = {};
  for (const [provider, bucket] of Object.entries(byProvider)) {
    if (bucket.coolingDown <= 0) continue;
    summary[provider] = {
      coolingDown: bucket.coolingDown,
      total: bucket.total,
      soonestRetryAfterMs:
        bucket.soonestUntil === Infinity ? 0 : Math.max(0, bucket.soonestUntil - nowMs),
    };
  }
  return summary;
}

export interface CodexAccountPoolsSummary {
  total: number;
  available: number;
  partiallyLimited: number;
  fullyLimited: number;
  quotaObserved: number;
  soonestRetryAfterMs: number;
}

export function summarizeCodexAccountPools(
  connections: BuildHealthPayloadOptions["connections"],
  nowMs: number
): CodexAccountPoolsSummary {
  const summary: CodexAccountPoolsSummary = {
    total: 0,
    available: 0,
    partiallyLimited: 0,
    fullyLimited: 0,
    quotaObserved: 0,
    soonestRetryAfterMs: 0,
  };
  for (const connection of connections) {
    if (connection.provider !== "codex" || !connection.id) continue;
    const diagnostic = getCodexParentAccountDiagnostic(
      createCodexAccountPool({
        id: connection.id,
        provider: connection.provider,
        providerSpecificData: connection.providerSpecificData ?? {},
      }),
      nowMs
    );
    summary.total += 1;
    if (diagnostic.status === "available") summary.available += 1;
    else if (diagnostic.status === "partially_limited") summary.partiallyLimited += 1;
    else summary.fullyLimited += 1;
    if (diagnostic.quota.observedScopeCount > 0) summary.quotaObserved += 1;
    if (
      diagnostic.cooldown.soonestRetryAfterMs > 0 &&
      (summary.soonestRetryAfterMs === 0 ||
        diagnostic.cooldown.soonestRetryAfterMs < summary.soonestRetryAfterMs)
    ) {
      summary.soonestRetryAfterMs = diagnostic.cooldown.soonestRetryAfterMs;
    }
  }
  return summary;
}

export function buildHealthPayload({
  appVersion,
  catalogCount = 0,
  settings,
  connections,
  circuitBreakers,
  rateLimitStatus,
  learnedLimits,
  lockouts,
  localProviders,
  inflightRequests,
  quotaMonitorSummary,
  quotaMonitorMonitors,
  activeSessions,
  activeSessionsByKey = {},
  credentialHealth,
  adaptiveAdmission = null,
  chatAdmission = null,
  walMaintenance = null,
  eventLoopStall = null,
  buildSha = null,
}: BuildHealthPayloadOptions) {
  const timestamp = new Date().toISOString();
  const system = {
    version: appVersion,
    // #10427: identifying a bad deploy previously required SSH + grepping compiled chunks.
    // Absent/empty when unknown (dev runs) — never a fabricated value.
    ...(buildSha ? { buildSha } : {}),
    nodeVersion: process.version,
    uptime: process.uptime(),
    memoryUsage: process.memoryUsage(),
    pid: process.pid,
    platform: process.platform,
  };

  const providerBreakers = circuitBreakers
    .filter((cb) => !cb.name.startsWith("test-") && !cb.name.startsWith("test_"))
    .map((cb) => {
      const lastFailure =
        typeof cb.lastFailureTime === "number" && Number.isFinite(cb.lastFailureTime)
          ? new Date(cb.lastFailureTime).toISOString()
          : typeof cb.lastFailureTime === "string"
            ? cb.lastFailureTime
            : null;
      return {
        provider: cb.name,
        state: cb.state,
        failureCount: cb.failureCount || 0,
        lastFailure,
        retryAfterMs: cb.retryAfterMs || 0,
      };
    });

  const providerHealth: Record<string, JsonRecord> = {};
  for (const breaker of providerBreakers) {
    providerHealth[breaker.provider] = {
      state: breaker.state,
      failures: breaker.failureCount,
      lastFailure: breaker.lastFailure,
      retryAfterMs: breaker.retryAfterMs,
    };
  }

  const nowMs = Date.now();
  const connectionHealth = summarizeConnectionCooldown(connections, nowMs);
  const codexAccountPools = summarizeCodexAccountPools(connections, nowMs);

  const configuredProviders = new Set(
    connections.map((connection) => connection.provider).filter(Boolean)
  );
  const activeProviders = new Set(
    connections
      .filter((connection) => connection.isActive !== false)
      .map((connection) => connection.provider)
      .filter(Boolean)
  );
  const breakerCounts = circuitBreakers.reduce(
    (acc, cb) => {
      if (cb.name.startsWith("test-") || cb.name.startsWith("test_")) return acc;
      if (cb.state === "OPEN") acc.open += 1;
      else if (cb.state === "HALF_OPEN") acc.halfOpen += 1;
      else if (cb.state === "DEGRADED") acc.degraded += 1;
      else acc.closed += 1;
      return acc;
    },
    { open: 0, halfOpen: 0, degraded: 0, closed: 0 }
  );

  return {
    status: "healthy",
    timestamp,
    system,
    version: system.version,
    uptime: system.uptime,
    memoryUsage: system.memoryUsage,
    activeConnections: connections.length,
    circuitBreakers: {
      ...breakerCounts,
      total:
        breakerCounts.open + breakerCounts.halfOpen + breakerCounts.degraded + breakerCounts.closed,
    },
    providerBreakers,
    providerHealth,
    connectionHealth,
    codexAccountPools,
    providerSummary: {
      catalogCount,
      configuredCount: configuredProviders.size,
      activeCount: activeProviders.size,
      monitoredCount: Object.keys(providerHealth).length,
    },
    localProviders,
    rateLimitStatus,
    learnedLimits,
    lockouts,
    quotaMonitor: {
      ...quotaMonitorSummary,
      monitors: limitMonitors(quotaMonitorMonitors),
    },
    sessions: buildSessionsSummary({ activeSessions, activeSessionsByKey }),
    credentialHealth: projectCredentialHealth(credentialHealth, connections),
    adaptiveAdmission: projectAdaptiveAdmissionSummary(adaptiveAdmission),
    // #11244: the STRUCTURAL gate (chatBodyAdmission.ts) next to the adaptive one —
    // distinct key so clients reading `adaptiveAdmission` are untouched.
    chatAdmission: projectChatAdmissionSummary(chatAdmission),
    // #12853: WAL maintenance next to the admission gates — additive key,
    // nothing existing moves.
    walMaintenance: projectWalMaintenanceSummary(walMaintenance),
    // Stall counters from the boot recorder — additive key, nothing moves.
    // A caller that never starts the recorder passes null and reads {0,0}.
    eventLoopStall: eventLoopStall ?? { count: 0, maxMs: 0 },
    dedup: {
      inflightRequests,
    },
    cryptography: {
      status:
        process.env.STORAGE_ENCRYPTION_KEY && process.env.STORAGE_ENCRYPTION_KEY.length >= 32
          ? "healthy"
          : "missing_or_invalid",
      provider: "aes-256-gcm",
    },
    setupComplete: settings?.setupComplete || false,
  };
}

/** Short cache window for the opt-in deep-health verdict (distinct from the 1s payload cache). */
export const DEEP_HEALTH_VERDICT_TTL_MS = 30_000;
/** Bounded probe budget: the deep check never holds a monitoring request hostage. */
export const DEEP_HEALTH_PROBE_TIMEOUT_MS = 3_000;

export interface DeepHealthVerdict {
  ok: boolean;
  /** Failover signal: true ONLY on 502/503. 4xx/timeout/network never trip it (fail-open). */
  failover: boolean;
  status: number | null;
  latencyMs: number;
  at: string;
}

/**
 * Minimal opt-in liveness probe against the completions surface: 1 token,
 * non-streaming, bounded timeout. Never throws — every failure mode returns
 * a verdict with failover:false except 502/503. Never logs bodies.
 */
export async function probeDeepHealth(
  url: string,
  opts: { timeoutMs?: number; token?: string; fetcher?: typeof fetch } = {}
): Promise<DeepHealthVerdict> {
  const timeoutMs = opts.timeoutMs ?? DEEP_HEALTH_PROBE_TIMEOUT_MS;
  const fetcher = opts.fetcher ?? fetch;
  const started = Date.now();
  const verdict = (ok: boolean, failover: boolean, status: number | null): DeepHealthVerdict => ({
    ok,
    failover,
    status,
    latencyMs: Date.now() - started,
    at: new Date().toISOString(),
  });
  try {
    const res = await fetcher(url, {
      method: "POST",
      headers: {
        "content-type": "application/json",
        ...(opts.token ? { authorization: `Bearer ${opts.token}` } : {}),
      },
      body: JSON.stringify({ max_tokens: 1, stream: false }),
      signal: AbortSignal.timeout(timeoutMs),
    });
    const status = res.status;
    if (status >= 200 && status < 300) return verdict(true, false, status);
    return verdict(false, status === 502 || status === 503, status);
  } catch {
    return verdict(false, false, null);
  }
}