@unrulysystems/rn-playwright-driver-runner 0.1.0 → 0.2.0

package/dist/index.d.mts

@@ -90,6 +90,8 @@ interface AndroidConfig {
     packageName: string;
     /** Launch activity, e.g. `.MainActivity`. */
     activity: string;
+    /** App URL scheme used for Expo dev-client deep links, e.g. `myapp`. */
+    scheme?: string;
     /** Gradle tasks that build the app + androidTest APKs. */
     gradleTasks?: string[];
     /** Built app APK path. Defaults to the standard debug output path. */
@@ -194,6 +196,13 @@ type StepAction = {
         readonly command: CommandSpec;
         readonly max: number;
     };
+    /**
+     * Terminal failure substrings to watch for in the backing process's captured log. If one
+     * appears, the readiness wait aborts EARLY (the build/test failed and will never become
+     * ready) instead of burning the full timeout. Set by the planner on the companion-ready step
+     * (see COMPANION_FAILURE_MARKERS); the executor pairs them with the process's log path.
+     */
+    readonly failureMarkers?: readonly string[];
 };
 /** The lifecycle stage a step belongs to. A failure is attributed to its stage. */
 type Stage = 'config' | 'metro' | 'device' | 'build' | 'companion' | 'app-launch' | 'hermes-target' | 'playwright' | 'cleanup';

package/dist/index.d.ts

@@ -90,6 +90,8 @@ interface AndroidConfig {
     packageName: string;
     /** Launch activity, e.g. `.MainActivity`. */
     activity: string;
+    /** App URL scheme used for Expo dev-client deep links, e.g. `myapp`. */
+    scheme?: string;
     /** Gradle tasks that build the app + androidTest APKs. */
     gradleTasks?: string[];
     /** Built app APK path. Defaults to the standard debug output path. */
@@ -194,6 +196,13 @@ type StepAction = {
         readonly command: CommandSpec;
         readonly max: number;
     };
+    /**
+     * Terminal failure substrings to watch for in the backing process's captured log. If one
+     * appears, the readiness wait aborts EARLY (the build/test failed and will never become
+     * ready) instead of burning the full timeout. Set by the planner on the companion-ready step
+     * (see COMPANION_FAILURE_MARKERS); the executor pairs them with the process's log path.
+     */
+    readonly failureMarkers?: readonly string[];
 };
 /** The lifecycle stage a step belongs to. A failure is attributed to its stage. */
 type Stage = 'config' | 'metro' | 'device' | 'build' | 'companion' | 'app-launch' | 'hermes-target' | 'playwright' | 'cleanup';

package/dist/index.js

@@ -42,6 +42,10 @@ var DEFAULTS = {
   androidTokenFileName: "rn-driver-touch-token"
 };
 var SECRET_PLACEHOLDER = "<token-file>";
+var COMPANION_FAILURE_MARKERS = {
+  ios: ["** BUILD FAILED **", "** TEST FAILED **"],
+  android: ["INSTRUMENTATION_FAILED", "Process crashed"]
+};
 
 // src/plan/env.ts
 function buildIosDriverEnv(resolved, metro, timeoutMs) {
@@ -204,9 +208,10 @@ function planAndroid(input) {
       }
     }
   });
-  const launchCommand = launchCommandFor(android, serial);
-  push(launchStep("android.launch-1", android, serial));
-  push(hermesStep("android.hermes-1", android, metro, resolved, hermesDeviceName, launchCommand));
+  const launch1Command = launchCommandFor(android, resolved, serial, { forceStopBefore: true });
+  const launch2Command = launchCommandFor(android, resolved, serial, { forceStopBefore: false });
+  push(launchStep("android.launch-1", android, launch1Command));
+  push(hermesStep("android.hermes-1", android, metro, resolved, hermesDeviceName, launch1Command));
   push({
     id: "android.forward-clean",
     stage: "companion",
@@ -260,11 +265,14 @@ function planAndroid(input) {
         port: resolved.touchPort,
         tokenFile: resolved.tokenFile,
         timeoutMs: resolved.companionReadyTimeoutMs
-      }
+      },
+      // Abort early if `am instrument` reports the companion failed to start (crash / missing
+      // androidTest target) instead of waiting out the readiness budget.
+      failureMarkers: COMPANION_FAILURE_MARKERS.android
     }
   });
-  push(launchStep("android.launch-2", android, serial));
-  push(hermesStep("android.hermes-2", android, metro, resolved, hermesDeviceName, launchCommand));
+  push(launchStep("android.launch-2", android, launch2Command));
+  push(hermesStep("android.hermes-2", android, metro, resolved, hermesDeviceName, launch2Command));
   const cleanup = [
     {
       type: "kill-process",
@@ -319,22 +327,34 @@ function planAndroid(input) {
     playwright: playwrightCommand(playwright, specs, passthrough)
   };
 }
-function launchCommandFor(android, serial) {
-  return adb(serial, [
-    "shell",
-    "am",
-    "start",
-    "-W",
-    "-n",
-    `${android.packageName}/${android.activity}`
-  ]);
+function launchCommandFor(android, resolved, serial, opts) {
+  if (android.launch.kind === "plain") {
+    return adb(serial, [
+      "shell",
+      "am",
+      "start",
+      "-W",
+      "-n",
+      `${android.packageName}/${android.activity}`
+    ]);
+  }
+  if (!android.scheme) {
+    throw new Error('android.scheme is required when android.launch.kind is "expo-dev-client"');
+  }
+  const launchScript = `am start -a android.intent.action.VIEW -d ${shellSingleQuote(
+    devClientUrl(android.scheme, resolved.initialUrl)
+  )}`;
+  return adbShellScript(
+    serial,
+    opts.forceStopBefore ? `am force-stop ${android.packageName} && ${launchScript}` : launchScript
+  );
 }
-function launchStep(id, android, serial) {
+function launchStep(id, android, command) {
   return {
     id,
     stage: "app-launch",
     description: `Launch ${android.packageName}/${android.activity}`,
-    action: { type: "command", command: launchCommandFor(android, serial) }
+    action: { type: "command", command }
   };
 }
 function hermesStep(id, android, metro, resolved, deviceNameMatch, launchCommand) {
@@ -368,6 +388,12 @@ function debugHostXml(host) {
 function adb(serial, args) {
   return { command: "adb", args: ["-s", serial, ...args] };
 }
+function devClientUrl(scheme, initialUrl) {
+  return `${scheme}://expo-development-client/?url=${initialUrl}`;
+}
+function shellSingleQuote(value) {
+  return `'${value.replaceAll("'", "'\\''")}'`;
+}
 function adbShellScript(serial, remote) {
   return { command: "adb", args: ["-s", serial, "shell", remote] };
 }
@@ -413,8 +439,7 @@ function planIos(input) {
       // Pass the resolved UI-test scheme so a custom `ios.uitestScheme` scaffolds
       // the SAME target that companion startup later builds (default is
       // `${appScheme}UITests`).
-      command: npx([
-        "rn-driver-xctest-scaffold",
+      command: cmd("node_modules/.bin/rn-driver-xctest-scaffold", [
         "--ios-dir",
         "ios",
         "--project-name",
@@ -574,7 +599,10 @@ function planIos(input) {
         port: resolved.touchPort,
         tokenFile: resolved.tokenFile,
         timeoutMs: resolved.companionReadyTimeoutMs
-      }
+      },
+      // Abort early if `xcodebuild test` reports a build/test failure (it lingers "alive" after, so
+      // the 300s readiness budget would otherwise be burnt waiting for a companion that cannot bind).
+      failureMarkers: COMPANION_FAILURE_MARKERS.ios
     }
   });
   if (isDevClient) {
@@ -708,7 +736,7 @@ function placeholderIos(ios, metro) {
     initialUrl: ios.launch.initialUrl ?? metro.url
   };
 }
-function placeholderAndroid(android, _metro) {
+function placeholderAndroid(android, metro) {
   return {
     serial: "<android-serial>",
     touchPort: android.companion?.port ?? DEFAULTS.companionPort,
@@ -716,7 +744,8 @@ function placeholderAndroid(android, _metro) {
     hermesTimeoutMs: DEFAULTS.hermesTargetTimeoutMs,
     tokenFile: SECRET_PLACEHOLDER,
     deviceTokenFileName: DEFAULTS.androidTokenFileName,
-    instrumentationTarget: instrumentationTarget(android)
+    instrumentationTarget: instrumentationTarget(android),
+    initialUrl: android.launch.initialUrl ?? metro.url
   };
 }
 
@@ -743,7 +772,7 @@ function buildDryRunPlan(config, platform, opts = {}) {
   return planAndroid({
     android,
     metro,
-    resolved: placeholderAndroid(android),
+    resolved: placeholderAndroid(android, metro),
     playwright: config.playwright,
     timeoutMs: config.timeoutMs,
     specs,
@@ -785,8 +814,10 @@ function renderAction(action) {
       return `write ${action.path}${action.mode ? ` (mode ${action.mode.toString(8)})` : ""}`;
     case "free-port":
       return `free-port ${action.port}`;
-    case "probe":
-      return `probe ${renderProbe(action.probe)}`;
+    case "probe": {
+      const fastFail = action.failureMarkers?.length ? ` [fast-fail on: ${action.failureMarkers.join(", ")}]` : "";
+      return `probe ${renderProbe(action.probe)}${fastFail}`;
+    }
     default: {
       const _exhaustive = action;
       throw new Error(`unhandled action: ${JSON.stringify(_exhaustive)}`);
@@ -852,6 +883,7 @@ var IOS_KEYS = /* @__PURE__ */ new Set([
 var ANDROID_KEYS = /* @__PURE__ */ new Set([
   "packageName",
   "activity",
+  "scheme",
   "gradleTasks",
   "appApkPath",
   "testApkPath",
@@ -953,6 +985,8 @@ function validateAndroid(android, errors) {
   reportUnknownKeys("config.android", android, ANDROID_KEYS, errors);
   requireAndroidPackage("config.android.packageName", android.packageName, errors);
   requireAndroidActivity("config.android.activity", android.activity, errors);
+  if (android.scheme !== void 0)
+    requireAppScheme("config.android.scheme", android.scheme, errors);
   optionalString("config.android.appApkPath", android.appApkPath, errors);
   optionalString("config.android.testApkPath", android.testApkPath, errors);
   if (android.instrumentationTarget !== void 0)
@@ -965,7 +999,10 @@ function validateAndroid(android, errors) {
     errors.push("config.android.gradleTasks: expected an array of strings");
   }
   validateCompanion("config.android.companion", android.companion, errors);
-  validateLaunch("config.android.launch", android.launch, errors);
+  const launch = validateLaunch("config.android.launch", android.launch, errors);
+  if (launch?.kind === "expo-dev-client" && android.scheme === void 0) {
+    errors.push('config.android.scheme: required when android.launch.kind is "expo-dev-client"');
+  }
 }
 function validateCompanion(path, companion, errors) {
   if (companion === void 0) return;
@@ -1011,6 +1048,7 @@ function requireString(path, value, errors) {
 }
 var ANDROID_PACKAGE_RE = /^[A-Za-z][A-Za-z0-9_]*(\.[A-Za-z][A-Za-z0-9_]*)+$/;
 var ANDROID_ACTIVITY_RE = /^\.?[A-Za-z][A-Za-z0-9_]*(\.[A-Za-z][A-Za-z0-9_]*)*$/;
+var APP_SCHEME_RE = /^[a-z][a-z0-9+.-]*$/;
 function requireAndroidPackage(path, value, errors) {
   if (typeof value !== "string" || value.trim() === "") {
     errors.push(`${path}: required non-empty string`);
@@ -1027,6 +1065,17 @@ function requireAndroidActivity(path, value, errors) {
   if (!ANDROID_ACTIVITY_RE.test(value))
     errors.push(`${path}: expected an activity name (e.g. .MainActivity)`);
 }
+function requireAppScheme(path, value, errors) {
+  if (typeof value !== "string" || value.trim() === "") {
+    errors.push(`${path}: required non-empty string`);
+    return;
+  }
+  if (!APP_SCHEME_RE.test(value)) {
+    errors.push(
+      `${path}: expected a valid URL scheme (lowercase letter, then lowercase letters, digits, +, ., or -)`
+    );
+  }
+}
 var ANDROID_INSTRUMENTATION_RE = /^[A-Za-z][A-Za-z0-9_]*(\.[A-Za-z][A-Za-z0-9_]*)*\/[A-Za-z][A-Za-z0-9_]*(\.[A-Za-z][A-Za-z0-9_]*)*$/;
 function requireInstrumentationTarget(path, value, errors) {
   if (typeof value !== "string" || value.trim() === "") {