@deeeed/metamask-harness 0.5.1 → 0.6.0

package/src/commands/debug.ts

@@ -1,65 +0,0 @@
-// debug — open the debug console by composing open-debug.mjs directly:
-// extension `debug` (--worker → service-worker target); mobile `debug`
-// (--dev-menu → developer menu). Cross-platform flag misuse teaches (exit 2).
-
-import path from 'node:path';
-
-import { runnerDir } from '../paths.ts';
-import { getAdapterSurface } from '../adapters/surface.ts';
-import { ADAPTER_DETECT_NEXT, EXIT, flag, parseFlags, resolveAdapter, spawnScript, targetOf, usageOut } from './shared.ts';
-
-const DEBUG_BOOLEANS = new Set(['worker', 'devMenu', 'json']);
-
-export async function handleDebug(argv: string[]): Promise<number> {
-  const { options } = parseFlags(argv, DEBUG_BOOLEANS);
-  const json = flag(options, 'json');
-  const target = targetOf(options);
-  const adapter = resolveAdapter(options, target);
-
-  if (!adapter) return usageOut(json, 'debug', `could not detect the MetaMask repo type for ${target}`, ADAPTER_DETECT_NEXT);
-  const surface = getAdapterSurface(adapter);
-  if (surface.headless) return usageOut(json, 'debug', 'core is headless; there is no debug console.', surface.hints.relaunch);
-
-  const worker = flag(options, 'worker');
-  const devMenu = flag(options, 'devMenu');
-  if (adapter === 'mobile' && worker) {
-    return usageOut(
-      json,
-      'debug',
-      '--worker is extension-only (service-worker DevTools). Use --dev-menu on mobile.',
-      'mm-harness debug --dev-menu',
-    );
-  }
-  if (adapter === 'extension' && devMenu) {
-    return usageOut(
-      json,
-      'debug',
-      '--dev-menu is mobile-only (RN developer menu). Use --worker on the extension.',
-      'mm-harness debug --worker',
-    );
-  }
-
-  const openDebug = path.join(runnerDir, 'adapters/shared/open-debug.mjs');
-  const debugArgs: string[] = ['--adapter', adapter];
-
-  if (adapter === 'extension') {
-    if (process.env.CDP_PORT) debugArgs.push('--cdp-port', process.env.CDP_PORT);
-    debugArgs.push('--target', worker ? 'worker' : 'page');
-  } else {
-    if (process.env.WATCHER_PORT) debugArgs.push('--port', process.env.WATCHER_PORT);
-    debugArgs.push('--action', devMenu ? 'dev-menu' : 'debug');
-  }
-  if (json) debugArgs.push('--json');
-
-  const result = spawnScript(process.execPath, [openDebug, ...debugArgs], target, json);
-  if (json) {
-    console.log(
-      JSON.stringify(
-        { schemaVersion: 1, command: 'debug', adapter, mode: worker ? 'worker' : devMenu ? 'dev-menu' : 'default', exitCode: result.status === 0 ? EXIT.ok : EXIT.runtime },
-        null,
-        2,
-      ),
-    );
-  }
-  return result.status === 0 ? EXIT.ok : EXIT.runtime;
-}

package/src/commands/fixtures.ts

@@ -1,198 +0,0 @@
-// fixtures <sync|set> — manage wallet DATA (never overlay/runtime state). `sync`
-// re-renders the wallet fixture files; `set` applies THE canonical fixture (SRP/
-// password read FROM the fixture, never typed) and always teaches the edit path.
-
-import fs from 'node:fs';
-import path from 'node:path';
-
-import { runnerDir, walletFixturePath } from '../paths.ts';
-import { getAdapterSurface } from '../adapters/surface.ts';
-import type { MetaMaskRecipeAdapter } from '../types.ts';
-import { ADAPTER_DETECT_NEXT, EXIT, flag, parseFlags, resolveAdapter, spawnScript, str, targetOf, usageOut } from './shared.ts';
-
-// One node injected from cli.ts so `fixtures set` can reuse the real engine path
-// (`call`'s one-node machinery) without a circular import.
-export interface CommandDeps {
-  runOneNode: (
-    adapter: MetaMaskRecipeAdapter,
-    action: string,
-    args: Record<string, string>,
-    target: string,
-    actionManifest: string | undefined,
-  ) => Promise<{ status: 'pass' | 'fail' }>;
-}
-
-const FIXTURES_BOOLEANS = new Set(['json']);
-
-// Patterns indicating setup-wallet failed due to a Metro/bridge issue (not a bad
-// fixture). A clean Metro restart + relaunch is likely to resolve these.
-// Mirrors baseline mm-recipe:820-824 setup_wallet_failure_recoverable patterns.
-const RECOVERABLE_SETUP_WALLET_PATTERNS = [
-  'CDP not reachable',
-  'CDP bridge',
-  'is not installed',
-  'Engine.context.KeyringController not available',
-  'Engine does not exist',
-  "Cannot read property 'transactions'",
-  'bridge-not-ready',
-  'debug-target-missing',
-  'CDP eval failed',
-  'CDP eval-async failed',
-];
-
-function isRecoverableSetupWalletFailure(output: string): boolean {
-  return RECOVERABLE_SETUP_WALLET_PATTERNS.some((p) => output.includes(p));
-}
-
-export async function handleFixtures(argv: string[], deps: CommandDeps): Promise<number> {
-  const { positional, options } = parseFlags(argv, FIXTURES_BOOLEANS);
-  const json = flag(options, 'json');
-  const sub = positional[0];
-  if (sub !== 'sync' && sub !== 'set') {
-    return usageOut(json, 'fixtures', 'fixtures requires a subcommand: mm-harness fixtures <sync|set>', 'mm-harness fixtures sync   or   mm-harness fixtures set');
-  }
-  const target = targetOf(options);
-  const adapter = resolveAdapter(options, target);
-  if (!adapter) {
-    return usageOut(json, 'fixtures', `could not detect the MetaMask repo type for ${target}`, ADAPTER_DETECT_NEXT);
-  }
-  const surface = getAdapterSurface(adapter);
-  if (surface.headless) return usageOut(json, 'fixtures', 'core is headless; it has no wallet fixture.', surface.hints.launch);
-
-  const canonicalFixture = walletFixturePath(target);
-  // Platform-phrased retry hint on a setup-wallet failure: the surface owns the
-  // (re)build/relaunch command; this command never spells out another platform's.
-  const retryHint = `${surface.hints.relaunch}   # relaunch, then retry: mm-harness fixtures set`;
-
-  if (sub === 'sync') {
-    const exitCode = fixturesSync(adapter, target, json);
-    if (json) {
-      console.log(
-        JSON.stringify(
-          { schemaVersion: 1, command: 'fixtures', action: 'sync', adapter, fixture: canonicalFixture, exitCode },
-          null,
-          2,
-        ),
-      );
-    }
-    return exitCode;
-  }
-
-  // set — apply THE canonical wallet fixture (password read FROM the fixture).
-  // Env-gap resolution (docs/CLI-SPEC.md Part 4): flag > env RECIPE_WALLET_FIXTURE
-  // > the slot's canonical fixture.
-  const fixturePath = path.resolve(str(options, 'fixture') ?? process.env.RECIPE_WALLET_FIXTURE ?? canonicalFixture);
-  let status: 'pass' | 'fail';
-  if (adapter === 'mobile') {
-    // Compose setup-wallet.sh directly (requires bridge to be live).
-    const setupWalletSh = path.join(runnerDir, 'adapters/mobile/bridge-runtime/setup-wallet.sh');
-    const previousAppRoot = process.env.APP_ROOT;
-    process.env.APP_ROOT = target;
-    try {
-      let result = spawnScript(setupWalletSh, ['--fixture', fixturePath], target, json);
-      // One clean-Metro auto-retry on recoverable failures (CDP unreachable, bridge
-      // not installed). RECIPE_SETUP_WALLET_RETRIED guards against infinite loops.
-      if (result.status !== 0 && isRecoverableSetupWalletFailure(result.output) && !process.env['RECIPE_SETUP_WALLET_RETRIED']) {
-        process.env['RECIPE_SETUP_WALLET_RETRIED'] = '1';
-        if (!json) process.stderr.write('  setup-wallet: recoverable failure — restarting Metro and retrying\n  Next: wait for relaunch, then wallet setup will retry automatically\n');
-        const { prepareMobile } = await import('../adapters/mobile/prepare.ts');
-        const platform = str(options, 'platform') ?? process.env['MOBILE_PLATFORM'] ?? 'ios';
-        const relaunchResult = await prepareMobile(target, { platform, json, preflightMode: 'auto', clearMetro: true });
-        if (relaunchResult.status === 0) {
-          result = spawnScript(setupWalletSh, ['--fixture', fixturePath], target, json);
-        }
-      }
-      status = result.status === 0 ? 'pass' : 'fail';
-    } finally {
-      delete process.env['RECIPE_SETUP_WALLET_RETRIED'];
-      if (previousAppRoot === undefined) delete process.env.APP_ROOT;
-      else process.env.APP_ROOT = previousAppRoot;
-    }
-    if (!json && status === 'fail') {
-      console.error(`  Next: ${retryHint}`);
-    }
-  } else {
-    // Extension has no standalone set arm — reuse call's one-node machinery via
-    // the real engine path (metamask.wallet.setup in the manifest).
-    if (!fs.existsSync(fixturePath)) {
-      return usageOut(
-        json,
-        'fixtures',
-        `no wallet fixture at ${fixturePath}.`,
-        'create it (or pass --fixture <path>), then re-run: mm-harness fixtures set',
-      );
-    }
-    const previousFixtureEnv = process.env.RECIPE_WALLET_FIXTURE;
-    process.env.RECIPE_WALLET_FIXTURE = fixturePath;
-    try {
-      const result = await deps.runOneNode('extension', 'metamask.wallet.setup', {}, target, str(options, 'actionManifest'));
-      status = result.status;
-    } finally {
-      if (previousFixtureEnv === undefined) delete process.env.RECIPE_WALLET_FIXTURE;
-      else process.env.RECIPE_WALLET_FIXTURE = previousFixtureEnv;
-    }
-    if (!json && status === 'fail') {
-      console.error(`  Next: ${retryHint}`);
-    }
-  }
-
-  // Always teach where to customize the wallet.
-  const teaching = `Wallet fixture applied.  Want different accounts? Edit: ${canonicalFixture}`;
-  if (json) {
-    console.log(
-      JSON.stringify(
-        {
-          schemaVersion: 1,
-          command: 'fixtures',
-          action: 'set',
-          adapter,
-          fixture: fixturePath,
-          canonicalFixture,
-          status,
-          exitCode: status === 'pass' ? EXIT.ok : EXIT.runtime,
-          message: teaching,
-          error: status === 'fail' ? {
-            code: 'SETUP_WALLET_FAILED',
-            message: 'wallet fixture setup failed',
-            userAction: retryHint,
-          } : null,
-        },
-        null,
-        2,
-      ),
-    );
-  } else {
-    console.error(teaching);
-  }
-  return status === 'pass' ? EXIT.ok : EXIT.runtime;
-}
-
-// Sync the overlay installation + wallet fixture for the checkout.
-// Re-runs the adapter inject to refresh patched files, then copies the wallet
-// fixture to the canonical runtime location via sync-wallet-fixture.sh. Reached
-// only for device adapters (headless core returns earlier); the adapter is
-// forwarded verbatim to `install`.
-function fixturesSync(adapter: MetaMaskRecipeAdapter, target: string, json: boolean): number {
-  const mmHarnessBin = path.join(runnerDir, 'bin/mm-harness');
-  const installResult = spawnScript(
-    mmHarnessBin,
-    ['install', '--adapter', adapter, '--target', target],
-    target,
-    json,
-  );
-  if (installResult.status !== 0) {
-    if (!json) {
-      console.error(`✗ mm-harness fixtures sync: overlay reinstall failed.\n  Next: mm-harness install --target ${target}   # diagnose the install failure`);
-    }
-    return EXIT.runtime;
-  }
-
-  const syncFixtureSh = path.join(runnerDir, 'adapters/shared/sync-wallet-fixture.sh');
-  const syncArgs = ['--target', target];
-  if (process.env.CDP_PORT) syncArgs.push('--cdp-port', process.env.CDP_PORT);
-  if (process.env.RECIPE_SLOT_ID) syncArgs.push('--slot-id', process.env.RECIPE_SLOT_ID);
-  spawnScript(syncFixtureSh, syncArgs, target, json);
-  // Non-zero from sync-wallet-fixture.sh is informational (no fixture source);
-  // the install succeeded so the overlay is fresh.
-  return EXIT.ok;
-}