catalyst-core 1.1.0 → 1.2.0-canary.2

package/dist/native/setupEmulatorIos.js

@@ -1,315 +1,98 @@
 "use strict";
 
-var _child_process = require("child_process");
 var _fs = _interopRequireDefault(require("fs"));
+var _path = _interopRequireDefault(require("path"));
 var _utils = require("./utils.js");
+var _iosToolchain = require("./iosToolchain.js");
+var _localState = require("./localState.js");
 var _terminalProgress = _interopRequireDefault(require("./terminalProgress.js"));
+var _diagnostic = require("../cli/diagnostic.js");
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-const configPath = `${process.env.PWD}/config/config.json`;
-const {
-  setupServer
-} = require("./setupServer.js");
-const ITEMS_PER_PAGE = 10;
+// `catalyst setupEmulator:ios`: install what an iOS debug build needs on this
+// Mac (Xcode's licence and first-launch components, a simulator runtime, the
+// simulator) and nothing else. It reads ios.simulatorName from config.json
+// but never writes config.json, and starts no server. buildApp:ios runs the
+// same checks itself, so this is only for setting a machine up ahead of time.
+
 const steps = {
   platform: "Check platform compatibility",
-  config: "Initialize configuration",
-  simulator: "Configure iOS simulator",
-  launch: "Launch iOS simulator",
-  saveConfig: "Save configuration",
-  setupServer: "Set up server"
+  xcode: "Check Xcode",
+  runtime: "Check iOS simulator runtime",
+  simulator: "Check iOS simulator"
 };
 const progress = new _terminalProgress.default(steps, "catalyst setupEmulator", {
   subject: "ios"
 });
-async function initializeConfig() {
-  const configFile = _fs.default.readFileSync(configPath, "utf8");
-  const config = JSON.parse(configFile);
-  const {
-    WEBVIEW_CONFIG
-  } = config;
-  if (!WEBVIEW_CONFIG || Object.keys(WEBVIEW_CONFIG).length === 0) {
-    progress.log("WebView Config missing in " + configPath, "error");
-    process.exit(1);
-  }
-  if (!WEBVIEW_CONFIG.ios) {
-    WEBVIEW_CONFIG.ios = {};
-  }
-  return {
-    WEBVIEW_CONFIG
-  };
-}
-async function saveConfig(newConfig) {
-  try {
-    // Read the existing config
-    const existingConfigFile = _fs.default.readFileSync(configPath, "utf8");
-    const existingConfig = JSON.parse(existingConfigFile);
-
-    // Merge the new WEBVIEW_CONFIG with existing config
-    const updatedConfig = {
-      ...existingConfig,
-      // Preserve all existing keys
-      WEBVIEW_CONFIG: {
-        ...existingConfig.WEBVIEW_CONFIG,
-        ios: newConfig.WEBVIEW_CONFIG.ios
-      } // Update only WEBVIEW_CONFIG
-    };
+const log = (message, type = "info") => progress.log(message, type);
 
-    // Save the merged config
-    _fs.default.writeFileSync(configPath, JSON.stringify(updatedConfig, null, 2));
-    progress.log("Configuration saved successfully", "success");
+/** ios.simulatorName from config/config.json, when the app sets one. */
+function configuredSimulatorName(cwd = process.cwd()) {
+  try {
+    // nosemgrep: javascript.lang.security.audit.path-traversal.path-join-resolve-traversal.path-join-resolve-traversal - cwd is the app root; the file name is fixed.
+    const config = JSON.parse(_fs.default.readFileSync(_path.default.join(cwd, "config", "config.json"), "utf8"));
+    const name = config?.WEBVIEW_CONFIG?.ios?.simulatorName;
+    return typeof name === "string" && name.trim() ? name.trim() : null;
   } catch (error) {
-    progress.log("Failed to save configuration: " + error.message, "error");
-    process.exit(1);
+    return null;
   }
 }
 async function setupIOSEnvironment() {
   try {
+    const flags = (0, _utils.parseNativeArgs)(process.argv.slice(2));
     progress.start("platform");
     if (process.platform !== "darwin") {
       progress.log("iOS Simulator is only available on macOS.", "error");
       process.exit(1);
     }
     progress.complete("platform");
-    progress.start("config");
-    const {
-      WEBVIEW_CONFIG
-    } = await initializeConfig();
-    progress.complete("config");
+    progress.start("xcode");
+    const developerDir = await (0, _iosToolchain.ensureXcodeReady)({
+      flags,
+      log
+    });
+    progress.log(`Using ${developerDir}`, "info");
+    progress.complete("xcode");
+    progress.start("runtime");
+    const runtime = await (0, _iosToolchain.ensureIosRuntime)({
+      flags,
+      log
+    });
+    progress.log(`Runtime ${runtime.name}`, "info");
+    progress.complete("runtime");
     progress.start("simulator");
-    await configureSimulator(WEBVIEW_CONFIG);
+    const simulator = await (0, _iosToolchain.ensureSimulator)({
+      runtime,
+      name: configuredSimulatorName() || undefined,
+      last: (0, _localState.getLastTarget)("ios"),
+      flags,
+      log
+    });
+    if (!simulator.created) progress.log(`Simulator "${simulator.name}" is ready`, "info");
     progress.complete("simulator");
-    progress.start("launch");
-    await launchIOSSimulator(WEBVIEW_CONFIG.ios.simulatorName);
-    progress.complete("launch");
-    progress.start("saveConfig");
-    const config = await (0, _utils.validateAndCompleteConfig)("ios", configPath);
-    progress.complete("saveConfig");
-    progress.start("setupServer");
-    await setupServer(configPath, message => progress.log(message, "info"));
-    progress.complete("setupServer");
-    const iosCfg = config.ios || {};
-    progress.printTreeContent("Config  config/config.json", [{
-      text: `port            ${config.port ?? ""}`,
+    progress.printTreeContent("iOS", [{
+      text: `xcode       ${developerDir}`,
       color: "gray"
     }, {
-      text: `appBundleId     ${iosCfg.appBundleId ?? ""}`,
+      text: `runtime     ${runtime.name}`,
       color: "gray"
     }, {
-      text: `simulatorName   ${iosCfg.simulatorName ?? ""}`,
+      text: `simulator   ${simulator.name}`,
       color: "gray"
     }]);
-    progress.summary("Ready", "Run catalyst buildApp:ios to install the app");
+    progress.summary("Ready", "Run catalyst buildApp:ios to build and install the app");
     process.exit(0);
   } catch (error) {
+    // A coded error (IOS-003, NATIVE-005, ...) gets the full diagnostic:
+    // code, hint and doc link. Anything else keeps the one-line failure.
+    const coded = /^[A-Z]+-\d{3}$/.test(String(error?.code || ""));
     if (progress.currentStep) {
-      progress.fail(progress.currentStep.id, error.message);
-    }
-    progress.hint(error.hint);
-    process.exit(1);
-  }
-}
-async function displayPaginatedList(items, startIndex) {
-  const endIndex = Math.min(startIndex + ITEMS_PER_PAGE, items.length);
-  for (let i = startIndex; i < endIndex; i++) {
-    console.log(`${i + 1}. ${items[i]}`);
-  }
-  if (endIndex < items.length) {
-    console.log(`\nShowing ${startIndex + 1}-${endIndex} of ${items.length} items`);
-    console.log('Type "more" to see more items, or enter your selection: ');
-    return true;
-  }
-  return false;
-}
-async function getRuntime() {
-  const runtimesOutput = (0, _child_process.execSync)("xcrun simctl list runtimes -j").toString();
-  const parsedRuntimes = JSON.parse(runtimesOutput).runtimes;
-  const availableRuntime = parsedRuntimes.find(runtime => runtime.isAvailable || runtime.availability === "(available)" || runtime.availability === "available");
-  if (!availableRuntime) {
-    const runningSimulators = (0, _child_process.execSync)("xcrun simctl list devices booted").toString();
-    if (runningSimulators.includes("(Booted)") && parsedRuntimes.length > 0) {
-      progress.status(`runtime ${parsedRuntimes[0].name}`);
-      return parsedRuntimes[0];
+      progress.fail(progress.currentStep.id, coded ? undefined : error.message);
     }
-    progress.log("No available iOS runtime found. Install one through Xcode.", "error");
-    process.exit(1);
-  }
-  progress.status(`runtime ${availableRuntime.name}`);
-  return availableRuntime;
-}
-async function configureSimulator(config) {
-  // If a simulator is already configured, skip the interactive picker
-  if (config.ios.simulatorName) {
-    progress.log(`Using configured simulator: ${config.ios.simulatorName}`);
-    return;
-  }
-  progress.pause();
-
-  // Get the current runtime first
-  const runtime = await getRuntime();
-
-  // Get simulators specifically for this runtime
-  const simulatorsJson = JSON.parse((0, _child_process.execSync)("xcrun simctl list devices -j").toString());
-  const runtimeSimulators = simulatorsJson.devices[runtime.identifier] || [];
-
-  // Filter for available simulators only
-  const availableSimulators = runtimeSimulators.filter(sim => sim.availability === "(available)" || sim.isAvailable).map(sim => `${sim.name} (${sim.udid})`);
-  if (availableSimulators.length === 0) {
-    progress.log(`No available simulators found for runtime: ${runtime.name}`, "error");
-    progress.resume();
+    if (coded) process.stderr.write((0, _diagnostic.buildFailure)({
+      error,
+      stage: "iOS setup"
+    }));else progress.hint(error.hint);
     process.exit(1);
-    return;
   }
-  let startIndex = 0;
-  console.log(`\nAvailable simulators for ${runtime.name} (or type 'new' to create a new one):`);
-
-  // eslint-disable-next-line no-constant-condition
-  while (true) {
-    const hasMore = await displayPaginatedList(availableSimulators, startIndex);
-    const simulatorChoice = await (0, _utils.promptUser)(hasMore ? "" : "\nEnter selection: ");
-    if (simulatorChoice.toLowerCase() === "more" && hasMore) {
-      startIndex += ITEMS_PER_PAGE;
-      continue;
-    }
-    if (simulatorChoice.toLowerCase() === "new") {
-      const deviceTypes = JSON.parse((0, _child_process.execSync)("xcrun simctl list devicetypes --json").toString()).devicetypes;
-      const simulatorName = await (0, _utils.promptUser)("Enter a name for the new simulator: ");
-
-      // Use iPhone 15 Pro as default device type
-      const defaultDevice = deviceTypes.find(dt => dt.name.includes("iPhone 15 Pro")) || deviceTypes[0];
-      try {
-        (0, _utils.runCommand)(`xcrun simctl create "${simulatorName}" "${defaultDevice.identifier}" "${runtime.identifier}"`);
-        console.log(`Simulator "${simulatorName}" created successfully.`);
-        config.ios.simulatorName = simulatorName;
-      } catch (error) {
-        console.log(`Failed to create simulator "${simulatorName}". Error: ${error.message}`);
-        process.exit(1);
-      }
-      break;
-    } else {
-      const index = parseInt(simulatorChoice) - 1;
-      if (index >= 0 && index < availableSimulators.length) {
-        const selectedSimulator = availableSimulators[index];
-        // Extract only the simulator name without ID and state
-        const simulatorName = selectedSimulator.split(" (")[0];
-        config.ios.simulatorName = simulatorName;
-        break;
-      } else {
-        console.log("Invalid selection. Please try again.");
-      }
-    }
-  }
-  progress.resume();
-  await saveConfig({
-    WEBVIEW_CONFIG: config
-  });
-}
-
-// async function createDefaultSimulator(config, runtime) {
-//     const deviceTypes = JSON.parse(execSync("xcrun simctl list devicetypes --json").toString()).devicetypes
-//     const defaultDevice = deviceTypes.find((dt) => dt.name.includes("iPhone 15 Pro")) || deviceTypes[0]
-//     const simulatorName = `Default ${defaultDevice.name.split(" (")[0]}`
-
-//     try {
-//         runCommand(
-//             `xcrun simctl create "${simulatorName}" "${defaultDevice.identifier}" "${runtime.identifier}"`
-//         )
-//         console.log(`Default simulator "${simulatorName}" created successfully.`)
-//         config.ios.simulatorName = simulatorName
-//         await saveConfig({ WEBVIEW_CONFIG: config })
-//     } catch (error) {
-//         console.log(`Failed to create default simulator. Error: ${error.message}`)
-//         process.exit(1)
-//     }
-// }
-
-// Xcode 27 replaced the standalone Simulator.app (com.apple.iphonesimulator)
-// with DeviceHub.app (com.apple.dt.Devices); older Xcode installs still ship
-// the former. Resolve whichever is actually installed instead of hardcoding
-// the app name, which no longer resolves via `open -a` on either app.
-function resolveSimulatorAppBundleId() {
-  const candidates = ["com.apple.dt.Devices", "com.apple.iphonesimulator"];
-  for (const bundleId of candidates) {
-    try {
-      (0, _child_process.execSync)(`osascript -e 'id of app id "${bundleId}"'`, {
-        stdio: "ignore"
-      });
-      return bundleId;
-    } catch {
-      // Not installed under this bundle id; try the next candidate.
-    }
-  }
-  return null;
-}
-
-// Text mirrors errors/registry.js ERROR_DEFINITIONS[IOS-001] (see
-// errors/IOS/IOS-001.md) — this CJS subtree can't import the ESM error
-// registry (see native/buildErrorFormat.js), so the message is duplicated
-// here rather than imported. This condition is recoverable (the simulator
-// can still boot headlessly via simctl) so callers log it as a warning
-// instead of throwing.
-const SIMULATOR_APP_NOT_FOUND_WARNING = "[IOS-001] Could not find an installed iOS Simulator app (checked DeviceHub.app and the legacy Simulator.app). " + "The simulator is booted but its window may not be visible. Suggested action: confirm a full Xcode.app is installed and selected via xcode-select -p, then open it once from Spotlight.";
-async function launchIOSSimulator(simulatorName) {
-  progress.status("launching simulator");
-  try {
-    // Get all simulators including both available and booted ones
-    const allSimulatorInfo = (0, _child_process.execSync)("xcrun simctl list devices -j").toString();
-    const simulatorsJson = JSON.parse(allSimulatorInfo);
-    const runtimesOutput = (0, _child_process.execSync)("xcrun simctl list runtimes -j").toString();
-    const availableRuntimeIds = new Set(JSON.parse(runtimesOutput).runtimes.filter(r => r.isAvailable || r.availability === "(available)" || r.availability === "available").map(r => r.identifier));
-
-    // Search through all runtimes and their devices
-    let foundSimulator = null;
-    let foundSimulatorId = null;
-    let isBooted = false;
-
-    // Prefer devices under an available runtime; fall back to already-booted ones
-    Object.entries(simulatorsJson.devices).forEach(([runtimeId, devices]) => {
-      const isAvailableRuntime = availableRuntimeIds.has(runtimeId);
-      devices.forEach(device => {
-        if (device.name === simulatorName) {
-          const alreadyBooted = device.state === "Booted";
-          // Take this match if: no match yet, or this runtime is available and current isn't, or device is already booted
-          if (!foundSimulator || isAvailableRuntime && !foundSimulator._fromAvailableRuntime || alreadyBooted) {
-            foundSimulator = {
-              ...device,
-              _fromAvailableRuntime: isAvailableRuntime
-            };
-            foundSimulatorId = device.udid;
-            isBooted = alreadyBooted;
-          }
-        }
-      });
-    });
-    if (!foundSimulator) {
-      progress.log(`Configured simulator "${simulatorName}" not found`, "warning");
-      return;
-    }
-    if (!isBooted) {
-      progress.status(`booting ${simulatorName}`);
-      (0, _utils.runCommand)(`xcrun simctl boot ${foundSimulatorId}`);
-    } else {
-      progress.status("already booted");
-    }
-
-    // Open the simulator UI (DeviceHub on Xcode 27+, Simulator.app on older Xcode) and focus it
-    const simulatorAppBundleId = resolveSimulatorAppBundleId();
-    if (simulatorAppBundleId) {
-      progress.status("opening simulator");
-      (0, _utils.runCommand)(`open -b ${simulatorAppBundleId}`);
-
-      // Give the simulator a moment to open/focus
-      await new Promise(resolve => setTimeout(resolve, 1000));
-
-      // Activate the simulator UI window to bring it to front
-      (0, _utils.runCommand)(`osascript -e 'tell application id "${simulatorAppBundleId}" to activate'`);
-    } else {
-      progress.log(SIMULATOR_APP_NOT_FOUND_WARNING, "warning");
-    }
-  } catch (error) {
-    progress.log(`Failed to launch iOS Simulator: ${error.message}`, "error");
-  }
-  // process.exit(0);
 }
-
-// Execute the main setup
 setupIOSEnvironment();