openclaw/extensions/voice-call/doctor-contract-api.ts

// Voice Call API module exposes the plugin public contract.
import fs from "node:fs/promises";
import os from "node:os";
import path from "node:path";
// Doctor enumeration cold-loads this closure; the state-DB helpers stay behind a
// lazy doctor-repair-runtime import so enumeration never pulls the kysely/state-db graph.
import type { OpenClawStateDatabaseSchemaMigration } from "openclaw/plugin-sdk/doctor-repair-runtime";
import type { OpenClawConfig } from "openclaw/plugin-sdk/plugin-entry";
import { normalizeAgentId } from "openclaw/plugin-sdk/routing";
import {
  archiveLegacyStateSource,
  type PluginDoctorStateMigration,
  type PluginStateKeyedStore,
} from "openclaw/plugin-sdk/runtime-doctor-migrations";
import { asOptionalRecord } from "openclaw/plugin-sdk/string-coerce-runtime";
import {
  buildVoiceCallLegacyJsonlEventKey,
  CALL_RECORD_CHUNK_MAX_ENTRIES,
  CALL_RECORD_EVENT_CHUNKS_NAMESPACE,
  CALL_RECORD_EVENT_META_MAX_ENTRIES,
  CALL_RECORD_EVENTS_NAMESPACE,
  MAX_CALL_RECORD_EVENTS,
  MAX_CHUNKS_PER_CALL_RECORD_EVENT,
  prepareVoiceCallRecordForStorage,
  parseVoiceCallRecordLine,
  RAW_CALL_RECORD_CHUNK_BYTES,
  resolveVoiceCallLegacyCallLogPath,
} from "./src/manager/store.js";
import { resolveDefaultVoiceCallStoreDir } from "./src/store-path.js";
import type { CallRecord } from "./src/types.js";

// Doctor state migration for Voice Call legacy JSONL call logs.

/** Plugin state metadata row for one migrated call record event. */
type CallRecordEventMeta = {
  chunkCount: number;
  byteLength: number;
  persistedAt?: number;
  sequence?: number;
};

/** Plugin state chunk row for one migrated call record event. */
type CallRecordEventChunk = {
  index: number;
  dataBase64: string;
};

/** Prepared legacy JSONL call record ready for plugin state import. */
type PreparedLegacyCallRecord = {
  eventKey: string;
  lineNumber: number;
  chunks: CallRecordEventChunk[];
  meta: CallRecordEventMeta;
};

/** Resolve home from doctor env with OS fallback. */
function resolveHome(env: NodeJS.ProcessEnv): string {
  return env.HOME?.trim() || os.homedir();
}

/** Resolve config paths, including "~", against the doctor env home. */
function resolveUserPath(input: string, env: NodeJS.ProcessEnv): string {
  const trimmed = input.trim();
  if (!trimmed) {
    return trimmed;
  }
  if (trimmed.startsWith("~")) {
    return path.resolve(trimmed.replace(/^~(?=$|[\\/])/, resolveHome(env)));
  }
  return path.resolve(trimmed);
}

/** Read the configured voice-call store path from either package id. */
function getVoiceCallConfigStore(config: PluginDoctorStateMigrationParams["config"]): string {
  for (const pluginId of ["voice-call", "@openclaw/voice-call"]) {
    const rawConfig = config.plugins?.entries?.[pluginId]?.config;
    if (!rawConfig || typeof rawConfig !== "object" || Array.isArray(rawConfig)) {
      continue;
    }
    const store = (rawConfig as { store?: unknown }).store;
    if (typeof store === "string" && store.trim()) {
      return store.trim();
    }
  }
  return "";
}

type PluginDoctorStateMigrationParams = Parameters<
  PluginDoctorStateMigration["detectLegacyState"]
>[0];

/** Return Voice Call agents whose templated core session stores need migration. */
export function resolveSessionStoreAgentIds(params: { cfg: OpenClawConfig }): string[] {
  const agentIds = new Set<string>();
  for (const pluginId of ["voice-call", "@openclaw/voice-call"]) {
    const entry = params.cfg.plugins?.entries?.[pluginId];
    if (!entry) {
      continue;
    }
    const config = entry.config === undefined ? {} : asOptionalRecord(entry.config);
    if (!config) {
      continue;
    }
    agentIds.add(normalizeAgentId(typeof config.agentId === "string" ? config.agentId : undefined));
    const numbers = asOptionalRecord(config.numbers);
    for (const route of Object.values(numbers ?? {})) {
      const agentId = asOptionalRecord(route)?.agentId;
      if (typeof agentId === "string") {
        agentIds.add(normalizeAgentId(agentId));
      }
    }
  }
  return [...agentIds].toSorted();
}

/** Resolve the voice-call store path used by legacy and plugin-state call records. */
function resolveVoiceCallStorePath(params: {
  config: PluginDoctorStateMigrationParams["config"];
  env: NodeJS.ProcessEnv;
}): string {
  const configuredStore = getVoiceCallConfigStore(params.config);
  if (configuredStore) {
    return resolveUserPath(configuredStore, params.env);
  }
  return resolveDefaultVoiceCallStoreDir(params.env);
}

function resolveVoiceCallStateDatabaseEnv(
  params: PluginDoctorStateMigrationParams,
): NodeJS.ProcessEnv {
  return {
    ...params.env,
    OPENCLAW_STATE_DIR: resolveVoiceCallStorePath(params),
  };
}

function describeVoiceCallSchemaMigration(migration: OpenClawStateDatabaseSchemaMigration): string {
  switch (migration.kind) {
    case "agent-databases-composite-primary-key":
      return "agent database registry primary key -> agent_id,path";
    case "agent-databases-relative-paths-v9":
      return "agent database registry paths -> state-relative paths";
    case "audit-events-v2":
      return "audit event ledger -> versioned message lifecycle schema";
    case "commitments-retirement-v7":
      return "retired commitments storage -> removed table and indexes";
    case "worker-placement-execution-mode-v8":
      return "cloud worker placements -> execution-mode claims";
    case "operator-approvals-system-agent":
      return "operator approvals -> OpenClaw system changes";
    case "session-watch-cursor-provenance-v4":
      return "session watch cursors -> provenance column";
    case "strict-tables-v3":
      return "tables -> SQLite STRICT typing";
  }
  return migration.kind satisfies never;
}

/** Return true when a path exists and is a file. */

/** Build the plugin state key for one migrated event chunk. */
function buildChunkKey(eventKey: string, index: number): string {
  return `${eventKey}:chunk:${String(index).padStart(4, "0")}`;
}

/** Chunk a prepared call record into bounded plugin state rows. */
function prepareChunks(call: CallRecord): {
  chunks: CallRecordEventChunk[];
  meta: CallRecordEventMeta;
} {
  const serialized = JSON.stringify(prepareVoiceCallRecordForStorage(call));
  const buffer = Buffer.from(serialized, "utf8");
  const chunkCount = Math.max(1, Math.ceil(buffer.byteLength / RAW_CALL_RECORD_CHUNK_BYTES));
  if (chunkCount > MAX_CHUNKS_PER_CALL_RECORD_EVENT) {
    throw new Error(
      `voice-call record exceeds SQLite chunk limit (${chunkCount}/${MAX_CHUNKS_PER_CALL_RECORD_EVENT})`,
    );
  }
  const chunks: CallRecordEventChunk[] = [];
  for (let index = 0; index < chunkCount; index += 1) {
    const chunk = buffer.subarray(
      index * RAW_CALL_RECORD_CHUNK_BYTES,
      (index + 1) * RAW_CALL_RECORD_CHUNK_BYTES,
    );
    chunks.push({ index, dataBase64: chunk.toString("base64") });
  }
  return {
    chunks,
    meta: {
      chunkCount,
      byteLength: buffer.byteLength,
    },
  };
}

/** Read and prepare legacy JSONL call records, collecting line-level warnings. */
async function readLegacyCallRecords(filePath: string): Promise<{
  entries: PreparedLegacyCallRecord[];
  warnings: string[];
}> {
  let content;
  try {
    content = await fs.readFile(filePath, "utf8");
  } catch {
    return { entries: [], warnings: [] };
  }
  const entries: PreparedLegacyCallRecord[] = [];
  const warnings: string[] = [];
  let index = 0;
  for (const line of content.split("\n")) {
    const parsed = parseVoiceCallRecordLine(line, index);
    if (!parsed) {
      if (line.trim()) {
        warnings.push(`Skipped malformed Voice Call call-log line ${index + 1}`);
      }
      index += 1;
      continue;
    }
    try {
      const prepared = prepareChunks(parsed.call);
      entries.push({
        eventKey: buildVoiceCallLegacyJsonlEventKey(line, index),
        lineNumber: index + 1,
        chunks: prepared.chunks,
        meta: {
          ...prepared.meta,
          persistedAt: parsed.persistedAt,
          sequence: parsed.sequence,
        },
      });
    } catch (err) {
      warnings.push(`Skipped Voice Call call-log line ${index + 1}: ${String(err)}`);
    }
    index += 1;
  }
  return { entries, warnings };
}

/** Archive the legacy JSONL source after a complete migration. */

/** Select newest missing records that fit remaining plugin state capacity. */
async function selectEntriesForImport(params: {
  entries: PreparedLegacyCallRecord[];
  eventStore: PluginStateKeyedStore<CallRecordEventMeta>;
  chunkStore: PluginStateKeyedStore<CallRecordEventChunk>;
  warnings: string[];
}): Promise<{ existingEventKeys: Set<string>; entries: PreparedLegacyCallRecord[] }> {
  const existingEventKeys = new Set((await params.eventStore.entries()).map((entry) => entry.key));
  const missingEntries = params.entries.filter((entry) => !existingEventKeys.has(entry.eventKey));
  const existingChunks = await params.chunkStore.entries();
  let eventRoom = Math.max(0, MAX_CALL_RECORD_EVENTS - existingEventKeys.size);
  let chunkRoom = Math.max(0, CALL_RECORD_CHUNK_MAX_ENTRIES - existingChunks.length);
  const selected: PreparedLegacyCallRecord[] = [];
  let pruned = 0;
  for (const entry of missingEntries.toReversed()) {
    if (eventRoom <= 0 || entry.chunks.length > chunkRoom) {
      pruned++;
      continue;
    }
    selected.push(entry);
    eventRoom--;
    chunkRoom -= entry.chunks.length;
  }
  if (pruned > 0) {
    params.warnings.push(
      `Pruned ${pruned} older Voice Call call-log ${pruned === 1 ? "record" : "records"} during migration because plugin state keeps the newest ${MAX_CALL_RECORD_EVENTS} records`,
    );
  }
  return { existingEventKeys, entries: selected.toReversed() };
}

/** Import prepared legacy call records into plugin state. */
async function importLegacyCallRecords(params: {
  entries: PreparedLegacyCallRecord[];
  eventStore: PluginStateKeyedStore<CallRecordEventMeta>;
  chunkStore: PluginStateKeyedStore<CallRecordEventChunk>;
  warnings: string[];
}): Promise<number> {
  const selected = await selectEntriesForImport(params);
  let imported = 0;
  for (const entry of selected.entries) {
    if (selected.existingEventKeys.has(entry.eventKey)) {
      continue;
    }
    try {
      for (const chunk of entry.chunks) {
        await params.chunkStore.register(buildChunkKey(entry.eventKey, chunk.index), chunk);
      }
      await params.eventStore.register(entry.eventKey, entry.meta);
      selected.existingEventKeys.add(entry.eventKey);
      imported++;
    } catch (err) {
      params.warnings.push(
        `Failed migrating Voice Call call-log line ${entry.lineNumber}: ${String(err)}`,
      );
    }
  }
  return imported;
}

/** Doctor migrations owned by the voice-call plugin. */
export const stateMigrations: PluginDoctorStateMigration[] = [
  {
    id: "voice-call-calls-jsonl-to-plugin-state",
    label: "Voice Call call log",
    async detectLegacyState(params) {
      const { detectOpenClawStateDatabaseSchemaMigrations } =
        await import("openclaw/plugin-sdk/doctor-repair-runtime");
      const storePath = resolveVoiceCallStorePath(params);
      const filePath = resolveVoiceCallLegacyCallLogPath(storePath);
      const { entries } = await readLegacyCallRecords(filePath);
      const schemaMigrations = detectOpenClawStateDatabaseSchemaMigrations({
        env: resolveVoiceCallStateDatabaseEnv(params),
      });
      if (entries.length === 0 && schemaMigrations.length === 0) {
        return null;
      }
      return {
        preview: [
          ...schemaMigrations.map(
            (migration) =>
              `- Voice Call SQLite schema: ${describeVoiceCallSchemaMigration(migration)}`,
          ),
          ...(entries.length > 0
            ? [
                `- Voice Call call log: ${entries.length} ${entries.length === 1 ? "record" : "records"} -> plugin state (${CALL_RECORD_EVENTS_NAMESPACE})`,
              ]
            : []),
        ],
      };
    },
    async migrateLegacyState(params) {
      const { detectOpenClawStateDatabaseSchemaMigrations, repairOpenClawStateDatabaseSchema } =
        await import("openclaw/plugin-sdk/doctor-repair-runtime");
      const changes: string[] = [];
      const warnings: string[] = [];
      const storePath = resolveVoiceCallStorePath(params);
      const filePath = resolveVoiceCallLegacyCallLogPath(storePath);
      const { entries, warnings: readWarnings } = await readLegacyCallRecords(filePath);
      warnings.push(...readWarnings);
      const stateDatabaseEnv = resolveVoiceCallStateDatabaseEnv(params);
      const schemaMigrations = detectOpenClawStateDatabaseSchemaMigrations({
        env: stateDatabaseEnv,
      });
      if (schemaMigrations.length > 0) {
        const repaired = repairOpenClawStateDatabaseSchema({ env: stateDatabaseEnv });
        warnings.push(...repaired.warnings);
        if (repaired.warnings.length > 0) {
          return { changes, warnings };
        }
        changes.push(
          ...repaired.changes.map((change) =>
            change
              .replace(/^Migrated shared state /, "Migrated Voice Call SQLite ")
              .replaceAll("→", "->"),
          ),
        );
      }
      if (entries.length === 0) {
        return { changes, warnings };
      }
      const env = stateDatabaseEnv;
      const eventStore = params.context.openPluginStateKeyedStore<CallRecordEventMeta>({
        namespace: CALL_RECORD_EVENTS_NAMESPACE,
        maxEntries: CALL_RECORD_EVENT_META_MAX_ENTRIES,
        env,
      });
      const chunkStore = params.context.openPluginStateKeyedStore<CallRecordEventChunk>({
        namespace: CALL_RECORD_EVENT_CHUNKS_NAMESPACE,
        maxEntries: CALL_RECORD_CHUNK_MAX_ENTRIES,
        env,
      });
      const imported = await importLegacyCallRecords({
        entries,
        eventStore,
        chunkStore,
        warnings,
      });
      if (imported > 0) {
        changes.push(
          `Migrated ${imported} Voice Call call-log ${imported === 1 ? "record" : "records"} -> plugin state`,
        );
      }
      if (
        warnings.some(
          (warning) =>
            warning.startsWith("Failed migrating Voice Call") ||
            warning.startsWith("Skipped malformed Voice Call call-log line") ||
            warning.startsWith("Skipped Voice Call call-log line") ||
            warning.startsWith("Skipped Voice Call call-log migration"),
        )
      ) {
        warnings.push("Left Voice Call call-log source in place because migration was incomplete");
        return { changes, warnings };
      }
      await archiveLegacyStateSource({ filePath, label: "Voice Call call-log", changes, warnings });
      return { changes, warnings };
    },
  },
];