@testrigor/testrigor-cli 1.0.1 → 2.0.1

package/dist/util/appium.js

@@ -15,21 +15,25 @@ const util = tslib_1.__importStar(require("util"));
 const path = tslib_1.__importStar(require("path"));
 const os = tslib_1.__importStar(require("os"));
 const fs_1 = tslib_1.__importDefault(require("@supercharge/fs"));
+const utils_1 = require("./utils");
 const execFile = util.promisify(childProcess.execFile);
 const PROJECT_ROOT = path.resolve(__dirname, "..", "..");
-const APPIUM_HOME = path.join(PROJECT_ROOT, ".appium");
 const DEFAULT_PORT = 4723;
 exports.DEFAULT_PORT = DEFAULT_PORT;
 const DEFAULT_BASE_PATH = "/wd/hub";
 exports.DEFAULT_BASE_PATH = DEFAULT_BASE_PATH;
-const PID_DIR = path.join(os.homedir(), ".testrigor");
+const PID_DIR = (0, utils_1.getHomeDir)();
 exports.PID_DIR = PID_DIR;
 const PID_FILE = path.join(PID_DIR, "appium.pid");
 exports.PID_FILE = PID_FILE;
 const LOG_FILE = path.join(os.tmpdir(), "testrigor-appium.log");
+// Appium writes its drivers here (hundreds of MB). It must live under the
+// user's home, not the install directory: a global install is often
+// root-owned, and `npm update -g` would wipe the drivers on every upgrade.
+const APPIUM_HOME = process.env.APPIUM_HOME || path.join((0, utils_1.getHomeDir)(), "appium-home");
 const REQUIRED_DRIVERS = [
     { name: "uiautomator2", version: "4.2.3" },
-    { name: "xcuitest", version: "9.2.4" },
+    { name: "xcuitest", version: "10.43.1" },
 ];
 exports.REQUIRED_DRIVERS = REQUIRED_DRIVERS;
 function getAppiumBin() {
@@ -42,16 +46,34 @@ function getAppiumEnv() {
         CHROMELABS_URL: "https://googlechromelabs.github.io",
     };
 }
+/**
+ * Appium refuses to start unless APPIUM_HOME already exists, so create it
+ * before any invocation and surface a permission problem as itself rather
+ * than as a generic "appium is broken".
+ */
+async function ensureAppiumHome() {
+    try {
+        await fs_1.default.ensureDir(APPIUM_HOME);
+    }
+    catch (error) {
+        throw new Error(`Cannot create the mobile server directory at ${APPIUM_HOME}: ` +
+            `${error instanceof Error ? error.message : String(error)}\n` +
+            "Check that you own that directory, or point APPIUM_HOME at a writable one.");
+    }
+}
 async function checkAppiumInstalled() {
     const appiumBin = getAppiumBin();
     if (!(await fs_1.default.exists(appiumBin))) {
-        throw new Error(`Appium binary not found at ${appiumBin}. Try reinstalling testrigor-cli.`);
+        throw new Error(`Appium binary not found at ${appiumBin}. ` +
+            "Reinstall the CLI with: npm install -g @testrigor/testrigor-cli");
     }
+    await ensureAppiumHome();
     try {
         await execFile(appiumBin, ["--version"], { env: getAppiumEnv() });
     }
-    catch {
-        throw new Error(`Appium binary at ${appiumBin} is not working. Try reinstalling testrigor-cli.`);
+    catch (error) {
+        const detail = error instanceof Error ? error.message : String(error);
+        throw new Error(`Appium binary at ${appiumBin} failed to run (APPIUM_HOME=${APPIUM_HOME}).\n${detail}`);
     }
 }
 async function getDriverStatus(driverName, requiredVersion) {
@@ -92,10 +114,7 @@ async function ensureDriver(driverName, requiredVersion) {
     }
     catch (error) {
         const raw = error instanceof Error ? error.message : String(error);
-        return raw
-            .split("\n")[0]
-            .replace(/^Command failed:.*?Error:\s*/, "")
-            .trim();
+        return raw.replace(/^Command failed:.*?Error:\s*/, "").trim();
     }
 }
 function isProcessRunning(pid) {
@@ -123,7 +142,36 @@ async function getRunningAppiumPid() {
     await fs_1.default.removeFile(PID_FILE);
     return null;
 }
-async function healthCheck(port, retries = 15, interval = 2000) {
+/**
+ * Last lines of the Appium log, so a server that dies on startup reports the
+ * reason instead of just a health-check timeout. The log is shared across
+ * invocations, so only bytes written after `fromOffset` are considered.
+ */
+function readLogTail(fromOffset, lines = 20) {
+    let fd;
+    try {
+        fd = fs.openSync(LOG_FILE, "r");
+        const size = fs.fstatSync(fd).size;
+        if (size <= fromOffset)
+            return "";
+        const maxTailBytes = 64 * 1024;
+        const start = Math.max(fromOffset, size - maxTailBytes);
+        const buffer = Buffer.alloc(size - start);
+        fs.readSync(fd, buffer, 0, buffer.length, start);
+        const content = buffer.toString("utf8").trimEnd();
+        if (!content)
+            return "";
+        return content.split("\n").slice(-lines).join("\n");
+    }
+    catch {
+        return "";
+    }
+    finally {
+        if (fd !== undefined)
+            fs.closeSync(fd);
+    }
+}
+async function healthCheck(port, logOffset, retries = 15, interval = 2000) {
     const url = `http://127.0.0.1:${port}/wd/hub/status`;
     let lastError = "";
     for (let i = 0; i < retries; i++) {
@@ -139,7 +187,11 @@ async function healthCheck(port, retries = 15, interval = 2000) {
         }
         await new Promise((r) => setTimeout(r, interval));
     }
-    throw new Error(`Mobile server not ready after ${retries} attempts: ${lastError}`);
+    const tail = readLogTail(logOffset);
+    throw new Error(`Mobile server not ready after ${retries} attempts: ${lastError}` +
+        (tail
+            ? `\nLast lines of ${LOG_FILE}:\n${tail}`
+            : `\nSee ${LOG_FILE} for details.`));
 }
 async function startAppium(port = DEFAULT_PORT, logLevel = "debug") {
     const existingPid = await getRunningAppiumPid();
@@ -147,7 +199,9 @@ async function startAppium(port = DEFAULT_PORT, logLevel = "debug") {
         return { pid: existingPid, alreadyRunning: true };
     }
     const appiumBin = getAppiumBin();
+    await ensureAppiumHome();
     const logStream = fs.openSync(LOG_FILE, "a");
+    const logOffset = fs.fstatSync(logStream).size;
     const appiumProcess = childProcess.spawn(appiumBin, [
         "--port",
         String(port),
@@ -170,7 +224,7 @@ async function startAppium(port = DEFAULT_PORT, logLevel = "debug") {
     await fs_1.default.ensureDir(PID_DIR);
     await fs_1.default.writeFile(PID_FILE, String(pid));
     try {
-        await healthCheck(port);
+        await healthCheck(port, logOffset);
     }
     catch (err) {
         killSafe(pid);

package/dist/util/certificate-uploader.js

@@ -4,12 +4,11 @@ exports.uploadClientCertificate = uploadClientCertificate;
 const tslib_1 = require("tslib");
 const fs = tslib_1.__importStar(require("fs"));
 const path = tslib_1.__importStar(require("path"));
-const node_fetch_commonjs_1 = tslib_1.__importDefault(require("node-fetch-commonjs"));
 const type_guards_1 = require("./type-guards");
 async function uploadClientCertificate(api2BaseUrl, testSuiteId, token, localFilePath, password) {
     const fileName = path.basename(localFilePath);
     const certBase64 = fs.readFileSync(localFilePath).toString("base64");
-    const response = await (0, node_fetch_commonjs_1.default)(`${api2BaseUrl}/apps/${testSuiteId}/test_data/global_variables/client_certificate`, {
+    const response = await fetch(`${api2BaseUrl}/apps/${testSuiteId}/test_data/global_variables/client_certificate`, {
         method: "POST",
         body: JSON.stringify({ fileName, certBase64, password }),
         headers: {

package/dist/util/request-builder.d.ts

@@ -1,11 +1,5 @@
-import FormData from "form-data";
 import { ChromeExtensionInput } from "../types";
-export interface ChromeExtensionFormDataResult {
-    form: FormData;
-    cleanup: () => void;
-}
 /**
- * Converts ChromeExtensionInput[] -> ChromeExtensionOverridesRequest -> FormData
- * Returns both the FormData and a cleanup function to close streams.
+ * Builds the multipart body for the chrome extension overrides of a retest.
  */
-export declare function buildChromeExtensionFormData(chromeExtensions: ChromeExtensionInput[]): ChromeExtensionFormDataResult;
+export declare function buildChromeExtensionFormData(chromeExtensions: ChromeExtensionInput[]): Promise<FormData>;

package/dist/util/request-builder.js

@@ -2,48 +2,25 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.buildChromeExtensionFormData = buildChromeExtensionFormData;
 const tslib_1 = require("tslib");
-const form_data_1 = tslib_1.__importDefault(require("form-data"));
-const fs_1 = tslib_1.__importDefault(require("@supercharge/fs"));
+const fs_1 = require("fs");
 const path = tslib_1.__importStar(require("path"));
-function toChromeExtensionOverrideItem(input) {
+async function readChromeExtension(input) {
     try {
-        return {
-            name: input.name,
-            file: fs_1.default.createReadStream(input.file),
-        };
+        return await (0, fs_1.openAsBlob)(input.file);
     }
     catch (error) {
         throw new Error(`Failed to read chrome extension file "${input.file}": ${error instanceof Error ? error.message : String(error)}`);
     }
 }
-function toChromeExtensionOverridesRequest(extensionInputs) {
-    const chromeExtensions = extensionInputs.map(toChromeExtensionOverrideItem);
-    const streams = chromeExtensions.map((item) => item.file);
-    return {
-        request: { chromeExtensions },
-        streams,
-    };
-}
 /**
- * Converts ChromeExtensionInput[] -> ChromeExtensionOverridesRequest -> FormData
- * Returns both the FormData and a cleanup function to close streams.
+ * Builds the multipart body for the chrome extension overrides of a retest.
  */
-function buildChromeExtensionFormData(chromeExtensions) {
-    const { request, streams } = toChromeExtensionOverridesRequest(chromeExtensions);
-    const form = new form_data_1.default();
-    request.chromeExtensions.forEach((ext, index) => {
+async function buildChromeExtensionFormData(chromeExtensions) {
+    const files = await Promise.all(chromeExtensions.map(readChromeExtension));
+    const form = new FormData();
+    chromeExtensions.forEach((ext, index) => {
         form.append(`chromeExtensions[${index}].name`, ext.name);
-        const fileName = path.basename(chromeExtensions[index].file);
-        form.append(`chromeExtensions[${index}].file`, ext.file, {
-            filename: fileName,
-        });
+        form.append(`chromeExtensions[${index}].file`, files[index], path.basename(ext.file));
     });
-    const cleanup = () => {
-        streams.forEach((stream) => {
-            if (!stream.destroyed) {
-                stream.destroy();
-            }
-        });
-    };
-    return { form, cleanup };
+    return form;
 }

package/dist/util/trtc.js

@@ -6,9 +6,9 @@ exports.download = download;
 const tslib_1 = require("tslib");
 const fs_1 = tslib_1.__importDefault(require("@supercharge/fs"));
 const fs = tslib_1.__importStar(require("fs"));
-const node_fetch_commonjs_1 = tslib_1.__importDefault(require("node-fetch-commonjs"));
 const os = tslib_1.__importStar(require("os"));
 const path = tslib_1.__importStar(require("path"));
+const stream_1 = require("stream");
 const tar = tslib_1.__importStar(require("tar-stream"));
 const unzip = tslib_1.__importStar(require("unzip-stream"));
 const zlib = tslib_1.__importStar(require("zlib"));
@@ -155,14 +155,14 @@ async function downloadOnce(dir) {
     };
     armStallTimer();
     try {
-        const response = await (0, node_fetch_commonjs_1.default)(getUrl(), { signal: controller.signal });
+        const response = await fetch(getUrl(), { signal: controller.signal });
         if (!response.ok) {
             throw new Error(`unexpected response ${response.statusText}`);
         }
-        const stream = response.body;
-        if (stream == null) {
+        if (response.body == null) {
             throw new Error("unexpected null response body");
         }
+        const stream = stream_1.Readable.fromWeb(response.body);
         const extraction = os.platform() === WIN32_PLATFORM
             ? extractZip(dir, stream)
             : extractTar(dir, stream);

package/dist/util/variable-file-uploader.js

@@ -2,15 +2,13 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.uploadVariableFile = uploadVariableFile;
 const tslib_1 = require("tslib");
-const fs_1 = tslib_1.__importDefault(require("@supercharge/fs"));
+const fs_1 = require("fs");
 const path = tslib_1.__importStar(require("path"));
-const node_fetch_commonjs_1 = tslib_1.__importDefault(require("node-fetch-commonjs"));
 const utils_1 = require("./utils");
 const type_guards_1 = require("./type-guards");
 async function uploadVariableFile(api2BaseUrl, testSuiteId, token, localFilePath) {
     const fileName = path.basename(localFilePath);
-    const fileSize = fs_1.default.statSync(localFilePath).size;
-    const presignedResp = await (0, node_fetch_commonjs_1.default)(`${api2BaseUrl}/apps/${testSuiteId}/test_data/global_variables/file/pre_signed_url`, {
+    const presignedResp = await fetch(`${api2BaseUrl}/apps/${testSuiteId}/test_data/global_variables/file/pre_signed_url`, {
         method: "POST",
         body: JSON.stringify({ fileName }),
         headers: {
@@ -28,13 +26,9 @@ async function uploadVariableFile(api2BaseUrl, testSuiteId, token, localFilePath
         !presignedJson.data) {
         throw new Error(`Failed to request presigned URL for variable file '${fileName}': ${presignedJson.message}`);
     }
-    const fileStream = fs_1.default.createReadStream(localFilePath);
-    const putResp = await (0, node_fetch_commonjs_1.default)(presignedJson.data.url, {
+    const putResp = await fetch(presignedJson.data.url, {
         method: "PUT",
-        body: fileStream,
-        headers: {
-            "Content-length": `${fileSize}`,
-        },
+        body: await (0, fs_1.openAsBlob)(localFilePath),
     });
     if (!putResp.ok) {
         throw new Error(`Failed to upload variable file '${fileName}' to S3: ${putResp.statusText}`);