@deeeed/metamask-harness 0.5.1 → 0.6.0

package/src/doctor.ts

@@ -1,215 +0,0 @@
-import fs from 'node:fs';
-import path from 'node:path';
-
-import { color } from './cli-color.ts';
-import { readRuntimeContextField, resolveRuntimeContextPath } from './harness.ts';
-import { manifestPath, readJson, recipeHarnessRoot, recipeRuntimeDir, runnerDir } from './paths.ts';
-import type {
-  MetaMaskDoctorReport,
-  MetaMaskRecipeAdapter,
-  MetaMaskRuntimeContextField,
-  MetaMaskRuntimeContextReport,
-} from './types.ts';
-
-export function repoShape(target: string): Record<string, unknown> {
-  const exists = (rel) => fs.existsSync(path.join(target, rel));
-  const packageInfo = readPackageInfo(target);
-  const extensionProject =
-    packageInfo.name === 'metamask-crx' ||
-    (exists('app/manifest') && exists('app/scripts') && exists('ui'));
-  const mobileProject =
-    packageInfo.name === 'metamask' && exists('app/core') && (exists('ios') || exists('android'));
-  return {
-    packageName: packageInfo.name,
-    packageJsonStatus: packageInfo.status,
-    packageJsonError: packageInfo.error,
-    extensionProject,
-    mobileProject,
-    agenticService: exists('app/dev-tools/AgenticService/AgenticService.ts'),
-    mobileProductHarness: false,
-    mobileBridgeScript: true,
-    extensionRuntime: exists(`${recipeHarnessRoot()}/extension`),
-    injectedHarness: exists(`${recipeHarnessRoot()}/mobile`) || exists(`${recipeHarnessRoot()}/extension`),
-    walletFixture:
-      exists(`${recipeRuntimeDir()}/wallet-fixture.json`),
-  };
-}
-
-export function compatibilityMode(adapter: MetaMaskRecipeAdapter, target: string) {
-  const shape = repoShape(target);
-  if (adapter === 'core') {
-    return fs.existsSync(path.join(target, 'packages/perps-controller/src/index.ts'))
-      ? 'headless controller (no bridge)'
-      : 'unsupported/no bridge';
-  }
-  if (adapter === 'mobile') {
-    if (shape.injectedHarness && shape.agenticService) return 'runner bridge with injected app bridge';
-    if (shape.agenticService) return 'runner bridge with app bridge';
-    return 'runner bridge available; app bridge not installed';
-  }
-  if (!shape.extensionProject) return 'unsupported/no bridge';
-  if (shape.extensionRuntime || shape.injectedHarness) return 'bridge present';
-  return 'bridge injectable';
-}
-
-function readPackageInfo(target: string) {
-  const packageJsonPath = path.join(target, 'package.json');
-  if (!fs.existsSync(packageJsonPath)) {
-    return { status: 'missing', name: null, error: null };
-  }
-  try {
-    const data = readJsonObject(packageJsonPath);
-    return {
-      status: 'valid',
-      name: typeof data.name === 'string' ? data.name : null,
-      error: null,
-    };
-  } catch (error) {
-    return {
-      status: 'invalid',
-      name: null,
-      error: error instanceof Error ? error.message : String(error),
-    };
-  }
-}
-
-export function fixtureSummary(target: string): Record<string, unknown> {
-  const candidates = [
-    `${recipeRuntimeDir()}/wallet-fixture.json`,
-  ];
-  const rel = candidates.find((candidate) => fs.existsSync(path.join(target, candidate)));
-  if (!rel) return { status: 'missing', path: null };
-  try {
-    const data = readJsonObject(path.join(target, rel));
-    return {
-      status: Array.isArray(data.accounts) && data.accounts.length > 0 ? 'ready' : 'incomplete',
-      path: rel,
-      accountCount: Array.isArray(data.accounts) ? data.accounts.length : 0,
-      hasPassword: typeof data.password === 'string' && data.password.length > 0,
-    };
-  } catch (error) {
-    return { status: 'invalid', path: rel, error: error instanceof Error ? error.message : String(error) };
-  }
-}
-
-// The runtime-context fields the harness hydrates from agentic-runtime.json,
-// each paired with the env var(s) that override the file value and the one-line
-// customize hint. `envVars` lists the harness precedence (first set wins); `envVar`
-// is the canonical name reported. Order matches the contract table (CLI-SPEC.md).
-const RUNTIME_CONTEXT_FIELDS: ReadonlyArray<{
-  key: string;
-  envVars: readonly string[];
-  envVar: string | null;
-  customize: string;
-  adapters: readonly MetaMaskRecipeAdapter[];
-}> = [
-  { key: 'slotId', envVars: ['RECIPE_SLOT_ID'], envVar: 'RECIPE_SLOT_ID', customize: 'farmslot dispatch writes this', adapters: ['mobile', 'extension', 'core'] },
-  { key: 'extensionId', envVars: ['RECIPE_HARNESS_EXTENSION_ID'], envVar: 'RECIPE_HARNESS_EXTENSION_ID', customize: 'auto-resolved; edit file to pin', adapters: ['extension'] },
-  { key: 'cdpPort', envVars: ['RECIPE_CDP_PORT', 'CDP_PORT'], envVar: 'CDP_PORT', customize: 'edit file or pass --cdp-port', adapters: ['extension'] },
-  { key: 'runtimeStart.approved', envVars: ['RECIPE_RUNTIME_START_APPROVED'], envVar: 'RECIPE_RUNTIME_START_APPROVED', customize: 'edit file (true/false)', adapters: ['mobile', 'extension'] },
-  { key: 'runtimeStart.command', envVars: [], envVar: null, customize: 'edit file', adapters: ['mobile', 'extension'] },
-  { key: 'runtimeStart.readyUrl', envVars: ['RECIPE_RUNTIME_READY_URL'], envVar: 'RECIPE_RUNTIME_READY_URL', customize: 'edit file', adapters: ['mobile', 'extension'] },
-];
-
-// Report every runtime-context field with its current value and where it came from
-// (live env override > file > unset default), reusing the harness's own file reader
-// so doctor and dispatch agree on resolution. Absent file → fileExists:false and
-// every field falls back to env or default; the path shows where it WOULD live.
-// An adapter scopes the report to that platform's fields — an extension-only row
-// (cdpPort, extensionId) is noise on a mobile or core slot.
-export function runtimeContextSummary(target: string, adapter?: MetaMaskRecipeAdapter): MetaMaskRuntimeContextReport {
-  const contextPath = resolveRuntimeContextPath(target);
-  const envOverride = process.env.RECIPE_RUNTIME_CONTEXT ?? null;
-  const fileExists = fs.existsSync(contextPath);
-  const file = envOverride ?? path.relative(target, contextPath);
-  const fields: Record<string, MetaMaskRuntimeContextField> = {};
-  const specs = adapter
-    ? RUNTIME_CONTEXT_FIELDS.filter((spec) => spec.adapters.includes(adapter))
-    : RUNTIME_CONTEXT_FIELDS;
-  for (const spec of specs) {
-    const envValue = spec.envVars
-      .map((name) => process.env[name])
-      .find((value) => value !== undefined && value !== '');
-    if (envValue !== undefined) {
-      fields[spec.key] = { value: envValue, source: 'env', envVar: spec.envVar, customize: spec.customize };
-      continue;
-    }
-    const fileValue = fileExists ? readRuntimeContextField(contextPath, spec.key) : undefined;
-    fields[spec.key] = fileValue !== undefined
-      ? { value: fileValue, source: 'file', envVar: spec.envVar, customize: spec.customize }
-      : { value: null, source: 'default', envVar: spec.envVar, customize: spec.customize };
-  }
-  return { file, fileExists, envOverride, fields };
-}
-
-// Human-readable runtime-context section for `doctor` without --json.
-export function renderRuntimeContext(runtimeContext: MetaMaskRuntimeContextReport): string {
-  // Human render: set values read bright with their provenance highlighted;
-  // unset defaults read dim so the eye lands on what is actually configured.
-  const out = (style: string, text: string) => color(style, text, { stream: process.stdout });
-  const lines: string[] = [];
-  lines.push(
-    runtimeContext.fileExists
-      ? `${out('label', 'runtime-context:')} ${runtimeContext.file} ${out('ok', '(present)')}`
-      : `${out('label', 'runtime-context:')} ${runtimeContext.file} ${out('dim', '(absent — written by farmslot prepare/dispatch)')}`,
-  );
-  for (const [key, field] of Object.entries(runtimeContext.fields)) {
-    const isSet = field.value !== undefined && field.value !== null && field.value !== '';
-    const value = isSet ? out('ok', String(field.value)) : out('dim', '(unset)');
-    const origin = field.source === 'env' && field.envVar ? `env ${field.envVar}` : field.source;
-    const originTag = isSet ? out('accent', `[${origin}]`) : out('dim', `[${origin}]`);
-    lines.push(`  ${key.padEnd(22)} ${value}  ${originTag} ${out('dim', `— ${field.customize}`)}`);
-  }
-  return lines.join('\n');
-}
-
-export function createDoctorReport(
-  adapter: MetaMaskRecipeAdapter,
-  target: string,
-  manifestValidation: { summary?: { errors?: number } & Record<string, unknown> },
-  actionManifestPath = manifestPath(adapter),
-): MetaMaskDoctorReport {
-  const mode = compatibilityMode(adapter, target);
-  const manifestErrors = Number(manifestValidation.summary?.errors ?? 0);
-  const status = manifestErrors > 0 ? 'fail' : 'pass';
-  const checks = [
-    {
-      id: 'manifest',
-      status: manifestErrors === 0 ? 'pass' : 'fail',
-      message: manifestErrors === 0 ? 'Action manifest is valid Recipe v1.' : `Action manifest has ${manifestErrors} validation error(s).`,
-    },
-    {
-      id: 'bridge',
-      status: mode === 'unsupported/no bridge' ? 'fail' : 'pass',
-      message: mode === 'unsupported/no bridge' ? `No ${adapter} bridge is available for this checkout.` : `${adapter} compatibility mode: ${mode}.`,
-    },
-  ] as const;
-  return {
-    schemaVersion: 1,
-    protocolVersion: 'v1',
-    runner_protocol_version: 1,
-    status,
-    checks: [...checks],
-    adapter,
-    target,
-    runner: {
-      name: '@metamask/recipe-runner',
-      runnerDir,
-      actionManifestPath,
-      harnessPackage: '@farmslot/recipe-harness',
-    },
-    compatibilityMode: mode,
-    shape: repoShape(target),
-    fixture: fixtureSummary(target),
-    runtimeContext: runtimeContextSummary(target, adapter),
-    manifestValidation: manifestValidation.summary,
-  };
-}
-
-function readJsonObject(file: string): Record<string, unknown> {
-  const value = readJson(file);
-  if (!value || typeof value !== 'object' || Array.isArray(value)) {
-    throw new Error(`Expected JSON object in ${file}`);
-  }
-  return value as Record<string, unknown>;
-}