doc-detective 4.23.0 → 4.25.0

package/dist/core/tests.js

@@ -13,7 +13,7 @@ import { requiredBrowserAssets, ensureBrowserInstalled, } from "../runtime/brows
 // Single source of truth for browser/driver-requiring step keys.
 import { BROWSER_STEP_KEYS as driverActions } from "../runtime/browserStepKeys.js";
 import os from "node:os";
-import { log, replaceEnvs, selectSpecsForRun, findFreePort, runConcurrent, runResourceAware, createResourceRegistry, rollUpResults, createAppiumPool, getRunOutputDir, runArchivesArtifacts, sanitizeFilesystemName, evaluateContextRequirements, } from "./utils.js";
+import { log, replaceEnvs, selectSpecsForRun, findFreePort, runConcurrent, runResourceAware, createResourceRegistry, rollUpResults, createAppiumPool, getRunOutputDir, runArchivesArtifacts, sanitizeFilesystemName, evaluateContextRequirements, isRetryableSessionError, } from "./utils.js";
 import axios from "axios";
 import { instantiateCursor } from "./tests/moveTo.js";
 import { goTo } from "./tests/goTo.js";
@@ -21,11 +21,12 @@ import { findElement } from "./tests/findElement.js";
 import { runShell } from "./tests/runShell.js";
 import { checkLink } from "./tests/checkLink.js";
 import { typeKeys } from "./tests/typeKeys.js";
+import { swipeSurface } from "./tests/swipe.js";
 import { wait } from "./tests/wait.js";
 import { saveScreenshot } from "./tests/saveScreenshot.js";
 import { startRecording } from "./tests/startRecording.js";
 import { stopRecording } from "./tests/stopRecording.js";
-import { browserCaptureTitle, browserDownloadDir, coerceRecordContextBrowser, jobIsFfmpegRecording, computeEffectiveConcurrency, jobExclusiveResources, checkSystemBinary, xvfbDisplay, startXvfb, XVFB_SCREEN_SIZE, isRecordingActive, recordStepName, detectRecordingNameConflict, } from "./tests/ffmpegRecorder.js";
+import { browserCaptureTitle, browserDownloadDir, coerceRecordContextBrowser, jobIsFfmpegRecording, computeEffectiveConcurrency, jobExclusiveResources, checkSystemBinary, xvfbDisplay, startXvfb, XVFB_SCREEN_SIZE, isRecordingActive, recordStepName, detectRecordingNameConflict, getFfmpegPath, ffmpegPathEnv, } from "./tests/ffmpegRecorder.js";
 import { loadVariables } from "./tests/loadVariables.js";
 import { saveCookie } from "./tests/saveCookie.js";
 import { loadCookie } from "./tests/loadCookie.js";
@@ -2306,7 +2307,16 @@ function buildAutoRecordStep({ config, spec, test, context, }) {
     const contextSegment = capPathSegment(sanitizeFilesystemName(String(context.contextId ?? ""), "context"));
     const recordPath = path.join(runDir, "specs", capPathSegment(sanitizeFilesystemName(String(spec.specId ?? ""), "spec")), "tests", capPathSegment(sanitizeFilesystemName(String(test.testId ?? ""), "test")), "contexts", contextSegment, "recordings", `${contextSegment}.mp4`);
     return {
-        record: { path: recordPath, overwrite: "true", engine: "ffmpeg" },
+        // Mobile-target contexts record the device screen through the app driver
+        // (the internal device plan, resolved from the platform) — pinning ffmpeg
+        // there would host-capture the emulator window, or nothing when headless.
+        record: {
+            path: recordPath,
+            overwrite: "true",
+            ...(isMobileTargetPlatform(context?.platform)
+                ? {}
+                : { engine: "ffmpeg" }),
+        },
         description: "Automatic full-context recording",
         stepId: `${sanitizeFilesystemName(String(test.testId ?? ""), "test")}~autorecord`,
         // Internal marker — the runStep record dispatch flags the started handle as
@@ -3621,6 +3631,7 @@ async function runStep({ config = {}, context = {}, step, driver, metaValues = {
             step: step,
             driver: driver,
             recordingHost,
+            appSession,
         });
         // Push the started recording onto the per-context stack so several can
         // overlap. Carry the step's `id`/`name` so a later stopRecord can target
@@ -3648,11 +3659,16 @@ async function runStep({ config = {}, context = {}, step, driver, metaValues = {
             handle.name = handle.name ?? recordStepName(step.record);
             if (step.__autoRecord) {
                 handle.synthetic = true;
-                // App-only context: no window exists yet to crop to. Mark the handle
-                // so the first app surface to open late-binds its window rect as the
-                // crop (startAppSurface), scoping the capture to the app under test.
-                if (!driver && appSession)
+                // Desktop app-only context: no window exists yet to crop to. Mark the
+                // handle so the first app surface to open late-binds its window rect
+                // as the crop (startAppSurface), scoping the capture to the app under
+                // test. Mobile contexts don't crop — their pending handles late-START
+                // the device recording instead (appium-pending).
+                if (!driver &&
+                    appSession &&
+                    !isMobileTargetPlatform(context?.platform)) {
                     handle.pendingAppWindowCrop = true;
+                }
             }
             recordingHost.state.recordings.push(handle);
         }
@@ -3699,6 +3715,24 @@ async function runStep({ config = {}, context = {}, step, driver, metaValues = {
                             env.ANDROID_HOME = appSession.androidSdkRoot;
                             env.ANDROID_SDK_ROOT = appSession.androidSdkRoot;
                         }
+                        // iOS device recording: the XCUITest driver's
+                        // startRecordingScreen shells out to a bare `ffmpeg` on the
+                        // server's PATH for encoding, and hosted runners don't reliably
+                        // ship one. Put the bundled @ffmpeg-installer binary's directory
+                        // first. Best-effort — the session must start even when the
+                        // ffmpeg install isn't available (recording then SKIPs with
+                        // guidance).
+                        if (isMobileTargetPlatform(context?.platform) === "ios") {
+                            try {
+                                const ffmpegPath = await getFfmpegPath({
+                                    cacheDir: config?.cacheDir,
+                                });
+                                Object.assign(env, ffmpegPathEnv(ffmpegPath));
+                            }
+                            catch {
+                                /* best-effort */
+                            }
+                        }
                         const server = await startAppiumServer(appiumEntry, config, undefined, env);
                         return { port: server.port, process: server.process };
                     },
@@ -3737,6 +3771,14 @@ async function runStep({ config = {}, context = {}, step, driver, metaValues = {
             appSession,
         });
     }
+    else if (typeof step.swipe !== "undefined") {
+        actionResult = await swipeSurface({
+            config: config,
+            step: step,
+            driver: driver,
+            appSession,
+        });
+    }
     else if (typeof step.type !== "undefined") {
         actionResult = await typeKeys({
             config: config,
@@ -3869,20 +3911,11 @@ async function appiumIsReady(port, timeoutMs = 120000) {
 }
 // Start the Appium driver specified in `capabilities`.
 async function driverStart(capabilities, port, maxAttempts = 4, ctx = {}) {
-    // Two families of transient, retryable session-creation failures, both worse
-    // under concurrency (the TRANSIENT regex below enumerates the specific
-    // patterns):
-    //   1. POST /session races a just-spawned-or-still-dying Appium (Windows):
-    //      /status returns 200 from the outgoing process while /session no longer
-    //      accepts, or Appium's proxy to chromedriver drops the socket ->
-    //      ECONNREFUSED / ECONNRESET / "socket hang up" / "could not proxy command".
-    //   2. Several Chromes launching at once briefly starve resources and
-    //      ChromeDriver "crashed during startup" / "cannot connect to" /
-    //      "DevToolsActivePort" / "session not created". A staggered retry lets
-    //      the contention clear; it recovers on the next attempt in practice.
-    // Retry these with linear backoff; any other error is a real session-
-    // creation failure and propagates immediately.
-    const TRANSIENT = /ECONNREFUSED|ECONNRESET|socket hang up|could not proxy command|crashed during startup|cannot connect to|DevToolsActivePort|session not created/i;
+    // Retryable session-creation failures (transient races/contention, plus the
+    // client-side timeout abort for slow-startup native sessions) are enumerated
+    // by isRetryableSessionError in ./utils.js. Retry those with linear backoff;
+    // any other error is a real session-creation failure and propagates
+    // immediately.
     const wdio = await loadHeavyDep("webdriverio", { ctx });
     // The wdio client aborts the POST /session request after connectionRetryTimeout.
     // A cold native session can take far longer to create than the 2-minute
@@ -3917,7 +3950,7 @@ async function driverStart(capabilities, port, maxAttempts = 4, ctx = {}) {
         }
         catch (err) {
             lastError = err;
-            if (!TRANSIENT.test(String(err && err.message)))
+            if (!isRetryableSessionError(String(err && err.message), startupCeiling))
                 throw err;
             if (attempt < maxAttempts) {
                 await new Promise((r) => setTimeout(r, 500 * attempt));