miravo 0.6.0 → 0.6.1

package/src/lib/admin-responses.ts

@@ -1,211 +0,0 @@
-/**
- * Response helpers and health-check utilities for the Miravo admin server.
- *
- * Pure functions — no side effects, no server state.
- */
-
-import type { EngineCoreMetrics } from "@miravo/core";
-import type { EngineCommand } from "@miravo/shared";
-import { EngineCommandSchema } from "@miravo/shared";
-
-// ---------------------------------------------------------------------------
-// Interfaces
-// ---------------------------------------------------------------------------
-
-export interface HealthResponseBody {
-  readonly status: "ok" | "fail";
-  readonly simulationState: EngineCoreMetrics["state"];
-  readonly tickCount: number;
-  readonly mqttEnabled: boolean;
-  readonly mqttConnected: boolean | null;
-  readonly opcuaEnabled: boolean;
-  readonly opcuaConnected: boolean | null;
-  readonly stalled: boolean;
-  readonly reason?: string;
-  readonly simulationName?: string;
-  readonly runId?: string;
-}
-
-interface AdminErrorResponse {
-  readonly message: string;
-  readonly error: string;
-}
-
-interface AdminServerStatus {
-  readonly status: "ok" | "fail";
-  readonly reason?: string;
-}
-
-// ---------------------------------------------------------------------------
-// Low-level response builders
-// ---------------------------------------------------------------------------
-
-export function jsonResponse(body: unknown, status: number): Response {
-  return new Response(JSON.stringify(body), {
-    status,
-    headers: {
-      "content-type": "application/json; charset=utf-8",
-      "cache-control": "no-store",
-    },
-  });
-}
-
-export function yamlResponse(body: string, status: number): Response {
-  return new Response(body, {
-    status,
-    headers: {
-      "content-type": "text/yaml; charset=utf-8",
-      "cache-control": "no-store",
-    },
-  });
-}
-
-export function plainResponse(body: string, status: number, allow?: string): Response {
-  return new Response(body, {
-    status,
-    headers: {
-      "content-type": "text/plain; charset=utf-8",
-      "cache-control": "no-store",
-      ...(allow ? { allow } : {}),
-    },
-  });
-}
-
-/** Require Content-Type: application/json. Returns an error Response or null. */
-export function checkContentType(request: Request): Response | null {
-  const ct = request.headers.get("content-type");
-  if (ct && ct.split(";")[0]?.trim() === "application/json") return null;
-  return jsonResponse(
-    {
-      message: "Unsupported Media Type.",
-      error: "Content-Type must be application/json.",
-    },
-    415,
-  );
-}
-
-// ---------------------------------------------------------------------------
-// Health / readiness status helpers
-// ---------------------------------------------------------------------------
-
-export function livenessStatus(input: {
-  readonly core: EngineCoreMetrics;
-  readonly stalled: boolean;
-}): AdminServerStatus {
-  if (input.core.state === "stopped") {
-    return { status: "fail", reason: 'engine state is "stopped"' };
-  }
-  if (input.stalled) {
-    return { status: "fail", reason: "tick loop stalled" };
-  }
-  return { status: "ok" };
-}
-
-export function readinessStatus(input: {
-  readonly core: EngineCoreMetrics;
-  readonly stalled: boolean;
-  readonly mqttEnabled: boolean;
-  readonly mqttConnected: boolean;
-  readonly opcuaEnabled: boolean;
-  readonly opcuaConnected: boolean;
-}): AdminServerStatus {
-  if (input.core.state !== "running") {
-    return { status: "fail", reason: `engine state is "${input.core.state}"` };
-  }
-  if (input.stalled) {
-    return { status: "fail", reason: "tick loop stalled" };
-  }
-  if (input.mqttEnabled && !input.mqttConnected) {
-    return { status: "fail", reason: "mqtt disconnected" };
-  }
-  if (input.opcuaEnabled && !input.opcuaConnected) {
-    return { status: "fail", reason: "opcua disconnected" };
-  }
-  return { status: "ok" };
-}
-
-export function buildHealthBody(input: {
-  readonly metrics: { readonly core: EngineCoreMetrics };
-  readonly stalled: boolean;
-  readonly mqttEnabled: boolean;
-  readonly mqttConnected: boolean;
-  readonly opcuaEnabled: boolean;
-  readonly opcuaConnected: boolean;
-}): Omit<HealthResponseBody, "status" | "reason"> {
-  return {
-    simulationState: input.metrics.core.state,
-    tickCount: input.metrics.core.tickCount,
-    mqttEnabled: input.mqttEnabled,
-    mqttConnected: input.mqttEnabled ? input.mqttConnected : null,
-    opcuaEnabled: input.opcuaEnabled,
-    opcuaConnected: input.opcuaEnabled ? input.opcuaConnected : null,
-    stalled: input.stalled,
-  };
-}
-
-// ---------------------------------------------------------------------------
-// Command parsing helpers
-// ---------------------------------------------------------------------------
-
-function extractCorrelationId(payload: unknown): string | undefined {
-  if (typeof payload !== "object" || payload === null) {
-    return undefined;
-  }
-  const maybeCorrelationId = (payload as Record<string, unknown>)["correlationId"];
-  return typeof maybeCorrelationId === "string" ? maybeCorrelationId : undefined;
-}
-
-function extractCommandType(payload: unknown): string {
-  if (typeof payload !== "object" || payload === null) {
-    return "unknown";
-  }
-  const maybeType = (payload as Record<string, unknown>)["type"];
-  return typeof maybeType === "string" ? maybeType : "unknown";
-}
-
-function commandValidationErrorResponse(
-  commandType: string,
-  correlationId: string | undefined,
-  issues: string,
-): Response {
-  return jsonResponse(
-    {
-      success: false,
-      command: commandType,
-      correlationId,
-      message: `Command validation failed: ${issues}`,
-      error:
-        "Check the command shape. Required: { type, ...fields }. See documentation for valid command types.",
-    },
-    400,
-  );
-}
-
-export async function parseCommandRequest(request: Request): Promise<Response | EngineCommand> {
-  let payload: unknown;
-  try {
-    payload = await request.json();
-  } catch {
-    return jsonResponse(
-      {
-        message: "Invalid JSON in command request body.",
-        error: 'Send a valid JSON object. Example: {"type":"pause"}',
-      } satisfies AdminErrorResponse,
-      400,
-    );
-  }
-
-  const validation = EngineCommandSchema.safeParse(payload);
-  if (!validation.success) {
-    const issues = validation.error.issues
-      .map((issue) => `${issue.path.join(".")}: ${issue.message}`)
-      .join("; ");
-    return commandValidationErrorResponse(
-      extractCommandType(payload),
-      extractCorrelationId(payload),
-      issues,
-    );
-  }
-
-  return validation.data;
-}