@testrigor/testrigor-cli 1.0.0 → 2.0.0

package/dist/util/trtc.js

@@ -1,14 +1,17 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.download = void 0;
-const Fs = require("@supercharge/fs");
-const fs = require("fs");
-const node_fetch_commonjs_1 = require("node-fetch-commonjs");
-const os = require("os");
-const path = require("path");
-const tar = require("tar-stream");
-const unzip = require("unzip-stream");
-const zlib = require("zlib");
+exports.extractZip = extractZip;
+exports.extractTar = extractTar;
+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 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"));
 const core_1 = require("@oclif/core");
 const FILE_EXTENSION = {
     darwin: "tar.gz",
@@ -56,39 +59,77 @@ function getUrl() {
     }
     throw new Error(`Unsupported platform ${platform} or architecture ${architecture}`);
 }
+const DOWNLOAD_ATTEMPTS = 3;
+const DOWNLOAD_STALL_TIMEOUT_MS = 20000;
+function errorMessage(error) {
+    return error instanceof Error ? error.message : String(error);
+}
+// Writes an archive entry to a temp file next to its destination and renames it over the
+// destination once fully flushed, so on any OS the binary is never spawned half-written. It also
+// replaces an existing binary with a new file instead of truncating and rewriting it in place,
+// which an OS may refuse or penalise while that binary is running or cached from a previous run.
+function writeEntry(entryPath, entry, mode) {
+    return new Promise((resolve, reject) => {
+        const tmpPath = `${entryPath}.${process.pid}.tmp`;
+        const writeStream = fs.createWriteStream(tmpPath);
+        writeStream.on("error", reject);
+        writeStream.on("close", () => {
+            if (mode !== undefined) {
+                try {
+                    fs.chmodSync(tmpPath, mode);
+                }
+                catch (error) {
+                    core_1.ux.warn(`Could not set permissions for ${entryPath}: ${errorMessage(error)}`);
+                }
+            }
+            try {
+                fs.renameSync(tmpPath, entryPath);
+            }
+            catch (error) {
+                reject(error);
+                return;
+            }
+            resolve();
+        });
+        entry.pipe(writeStream);
+    });
+}
 async function extractZip(dir, stream) {
+    const parser = unzip.Parse();
+    const writes = [];
     return new Promise((resolve, reject) => {
-        stream
-            .pipe(unzip.Extract({ path: dir }))
-            .on("close", () => resolve(getBinaryPath(dir)))
-            .on("error", reject);
+        stream.on("error", reject);
+        parser.on("error", reject);
+        parser.on("entry", (entry) => {
+            const entryPath = path.join(dir, entry.path);
+            if (entry.type === "Directory") {
+                fs.mkdirSync(entryPath, { recursive: true });
+                entry.autodrain();
+                return;
+            }
+            fs.mkdirSync(path.dirname(entryPath), { recursive: true });
+            writes.push(writeEntry(entryPath, entry));
+        });
+        parser.on("finish", () => Promise.all(writes).then(() => resolve(getBinaryPath(dir)), reject));
+        stream.pipe(parser);
     });
 }
 async function extractTar(dir, stream) {
     const extract = tar.extract();
     return new Promise((resolve, reject) => {
+        stream.on("error", reject);
         extract.on("error", reject);
         extract.on("entry", (header, stream, next) => {
             const entryPath = path.join(dir, header.name);
             const opts = { mode: header.mode };
             switch (header.type) {
                 case "directory":
-                    Fs.ensureDir(entryPath, opts);
+                    fs_1.default.ensureDir(entryPath, opts);
                     next();
                     break;
-                case "file": {
-                    const writeStream = fs.createWriteStream(entryPath);
-                    stream.pipe(writeStream);
-                    writeStream.on("close", () => {
-                        try {
-                            fs.chmodSync(entryPath, header.mode || 0o644);
-                        }
-                        catch (error) {
-                            core_1.ux.warn(`Could not set permissions for ${entryPath}: ${error instanceof Error ? error.message : String(error)}`);
-                        }
-                    });
-                    break;
-                }
+                case "file":
+                    writeEntry(entryPath, stream, header.mode || 0o644).then(() => next(), reject);
+                    return;
                 case "symlink":
                     // ignore symlinks since they will not work on windows
                     next();
@@ -103,18 +144,46 @@ async function extractTar(dir, stream) {
         stream.pipe(zlib.createGunzip()).pipe(extract);
     });
 }
-async function download(dir) {
-    const response = await (0, node_fetch_commonjs_1.default)(getUrl());
-    if (!response.ok) {
-        throw new Error(`unexpected response ${response.statusText}`);
+// Aborts the download when no data arrives for DOWNLOAD_STALL_TIMEOUT_MS, since a stalled
+// connection would otherwise never settle.
+async function downloadOnce(dir) {
+    const controller = new AbortController();
+    let stallTimer;
+    const armStallTimer = () => {
+        clearTimeout(stallTimer);
+        stallTimer = setTimeout(() => controller.abort(), DOWNLOAD_STALL_TIMEOUT_MS);
+    };
+    armStallTimer();
+    try {
+        const response = await fetch(getUrl(), { signal: controller.signal });
+        if (!response.ok) {
+            throw new Error(`unexpected response ${response.statusText}`);
+        }
+        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);
+        // Attached after the extractor has piped the body, so no chunk is consumed before it.
+        stream.on("data", armStallTimer);
+        return await extraction;
     }
-    const stream = response.body;
-    if (stream == null) {
-        throw new Error("unexpected null response body");
+    finally {
+        clearTimeout(stallTimer);
     }
-    if (os.platform() === WIN32_PLATFORM) {
-        return extractZip(dir, stream);
+}
+async function download(dir) {
+    let lastError;
+    for (let attempt = 1; attempt <= DOWNLOAD_ATTEMPTS; attempt++) {
+        try {
+            // eslint-disable-next-line no-await-in-loop
+            return await downloadOnce(dir);
+        }
+        catch (error) {
+            lastError = error;
+        }
     }
-    return extractTar(dir, stream);
+    throw new Error(`Could not download the trtc binary after ${DOWNLOAD_ATTEMPTS} attempts: ${errorMessage(lastError)}`);
 }
-exports.download = download;

package/dist/util/tunnel.js

@@ -1,8 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const Fs = require("@supercharge/fs");
-const childProcess = require("child_process");
-const path = require("path");
+const tslib_1 = require("tslib");
+const fs_1 = tslib_1.__importDefault(require("@supercharge/fs"));
+const childProcess = tslib_1.__importStar(require("child_process"));
+const path = tslib_1.__importStar(require("path"));
 const trtc_1 = require("./trtc");
 const utils_1 = require("./utils");
 function randomPort(min, max) {
@@ -17,12 +18,12 @@ type = "tcp"
 remotePort = ${port}
 [proxies.plugin]
 type = "http_proxy"`;
-    await Fs.writeFile(configPath, newConfigContent);
+    await fs_1.default.writeFile(configPath, newConfigContent);
     return configPath;
 }
 async function startTrtc(trtc, configPath) {
     return new Promise((resolve, reject) => {
-        if (!Fs.pathExistsSync(trtc)) {
+        if (!fs_1.default.pathExistsSync(trtc)) {
             reject(new Error(`Binary not found at ${trtc}`));
             return;
         }
@@ -97,5 +98,5 @@ class Tunnel {
         return this.port;
     }
 }
-exports.default = Tunnel;
 Tunnel.BINARY_DIRECTORY = "trtc";
+exports.default = Tunnel;

package/dist/util/type-guards.js

@@ -1,15 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isCertificateUploadApi2Response = exports.isSignedUrlApi2Response = exports.isPlainObject = void 0;
+exports.isPlainObject = isPlainObject;
+exports.isSignedUrlApi2Response = isSignedUrlApi2Response;
+exports.isCertificateUploadApi2Response = isCertificateUploadApi2Response;
 function isPlainObject(value) {
     return typeof value === "object" && value !== null && !Array.isArray(value);
 }
-exports.isPlainObject = isPlainObject;
 function isSignedUrlApi2Response(value) {
     return isPlainObject(value) && "status" in value;
 }
-exports.isSignedUrlApi2Response = isSignedUrlApi2Response;
 function isCertificateUploadApi2Response(value) {
     return isPlainObject(value) && "status" in value;
 }
-exports.isCertificateUploadApi2Response = isCertificateUploadApi2Response;

package/dist/util/utils.d.ts

@@ -3,13 +3,13 @@ export declare const UPLOAD_TIMEOUT_MS: number;
 export declare function createDirectory(name: string): Promise<string>;
 export declare function getHomeDir(): string;
 export declare function pathExists(name: string | undefined): Promise<boolean>;
-export declare function isRunningOnCi(): any;
-export declare function rendererToUse(): "default" | "verbose";
+export declare function isRunningOnCi(): boolean;
+export declare function rendererToUse(): "verbose" | "default";
 export declare function isYamlFile(fileName: string): boolean;
 export declare function isTextFile(fileName: string): boolean;
 export declare function isJsonFile(fileName: string): boolean;
 export declare function isValidFileExtensionToUpload(fileName: string): boolean;
-export declare function getExtensionLength(fileName: string): 0 | 4 | 5;
+export declare function getExtensionLength(fileName: string): 5 | 4 | 0;
 export declare function removeExtension(fileName: string): string;
 export declare function extractUrlWithoutQueryParams(urlString: string): string;
 export declare function extractRunIdFromDetailsUrl(detailsUrl: string | undefined): string;

package/dist/util/utils.js

@@ -1,61 +1,66 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isValidUrl = exports.extractRunIdFromDetailsUrl = exports.extractUrlWithoutQueryParams = exports.removeExtension = exports.getExtensionLength = exports.isValidFileExtensionToUpload = exports.isJsonFile = exports.isTextFile = exports.isYamlFile = exports.rendererToUse = exports.isRunningOnCi = exports.pathExists = exports.getHomeDir = exports.createDirectory = exports.UPLOAD_TIMEOUT_MS = exports.MAX_FILE_SIZE_100_MB = void 0;
-const Fs = require("@supercharge/fs");
-const path = require("path");
-// eslint-disable-next-line @typescript-eslint/no-var-requires, no-undef
-const isCi = require("is-ci");
+exports.UPLOAD_TIMEOUT_MS = exports.MAX_FILE_SIZE_100_MB = void 0;
+exports.createDirectory = createDirectory;
+exports.getHomeDir = getHomeDir;
+exports.pathExists = pathExists;
+exports.isRunningOnCi = isRunningOnCi;
+exports.rendererToUse = rendererToUse;
+exports.isYamlFile = isYamlFile;
+exports.isTextFile = isTextFile;
+exports.isJsonFile = isJsonFile;
+exports.isValidFileExtensionToUpload = isValidFileExtensionToUpload;
+exports.getExtensionLength = getExtensionLength;
+exports.removeExtension = removeExtension;
+exports.extractUrlWithoutQueryParams = extractUrlWithoutQueryParams;
+exports.extractRunIdFromDetailsUrl = extractRunIdFromDetailsUrl;
+exports.isValidUrl = isValidUrl;
+const tslib_1 = require("tslib");
+const fs_1 = tslib_1.__importDefault(require("@supercharge/fs"));
+const path = tslib_1.__importStar(require("path"));
+const is_ci_1 = tslib_1.__importDefault(require("is-ci"));
 const YAML_EXTENSION = ".yaml";
 const YML_EXTENSION = ".yml";
 const TXT_EXTENSION = ".txt";
 const JSON_EXTENSION = ".json";
 const FILE_UPLOAD_EXTENSIONS = [".zip", ".exe", ".msi", ".apk", ".aab", ".ipa"];
 const DIRECTORY_NAME = ".testrigor";
-const TESTRIGOR_CLI_HOME = process.env.TESTRIGOR_CLI_HOME || path.join(Fs.homeDir(), DIRECTORY_NAME);
+const TESTRIGOR_CLI_HOME = process.env.TESTRIGOR_CLI_HOME || path.join(fs_1.default.homeDir(), DIRECTORY_NAME);
 const NOT_AVAILABLE_TEST_SUITE_RUN = "not-available";
 exports.MAX_FILE_SIZE_100_MB = 100 * 1024 * 1024;
 exports.UPLOAD_TIMEOUT_MS = 10 * 60 * 1000; // 10 minutes for large file uploads
 async function createDirectory(name) {
     const directoryPath = path.join(TESTRIGOR_CLI_HOME, name);
-    await Fs.ensureDir(directoryPath);
+    await fs_1.default.ensureDir(directoryPath);
     return directoryPath;
 }
-exports.createDirectory = createDirectory;
 function getHomeDir() {
     return TESTRIGOR_CLI_HOME;
 }
-exports.getHomeDir = getHomeDir;
 async function pathExists(name) {
     if (!name) {
         return false;
     }
-    return Fs.pathExists(path.join(TESTRIGOR_CLI_HOME, name));
+    return fs_1.default.pathExists(path.join(TESTRIGOR_CLI_HOME, name));
 }
-exports.pathExists = pathExists;
 function isRunningOnCi() {
-    return isCi;
+    return is_ci_1.default;
 }
-exports.isRunningOnCi = isRunningOnCi;
 function rendererToUse() {
     return isRunningOnCi() ? "verbose" : "default";
 }
-exports.rendererToUse = rendererToUse;
 function isYamlFile(fileName) {
     return fileName.endsWith(YAML_EXTENSION) || fileName.endsWith(YML_EXTENSION);
 }
-exports.isYamlFile = isYamlFile;
 function isTextFile(fileName) {
     return fileName.endsWith(TXT_EXTENSION);
 }
-exports.isTextFile = isTextFile;
 function isJsonFile(fileName) {
     return fileName.endsWith(JSON_EXTENSION);
 }
-exports.isJsonFile = isJsonFile;
 function isValidFileExtensionToUpload(fileName) {
     return FILE_UPLOAD_EXTENSIONS.some((ext) => fileName.endsWith(ext));
 }
-exports.isValidFileExtensionToUpload = isValidFileExtensionToUpload;
 function getExtensionLength(fileName) {
     if (fileName.endsWith(YAML_EXTENSION)) {
         return 5;
@@ -65,17 +70,14 @@ function getExtensionLength(fileName) {
     }
     return 0;
 }
-exports.getExtensionLength = getExtensionLength;
 function removeExtension(fileName) {
     return fileName.slice(0, -getExtensionLength(fileName));
 }
-exports.removeExtension = removeExtension;
 function extractUrlWithoutQueryParams(urlString) {
     const url = new URL(urlString);
     url.search = "";
     return url.toString();
 }
-exports.extractUrlWithoutQueryParams = extractUrlWithoutQueryParams;
 function extractRunIdFromDetailsUrl(detailsUrl) {
     if (!detailsUrl) {
         return NOT_AVAILABLE_TEST_SUITE_RUN;
@@ -83,7 +85,6 @@ function extractRunIdFromDetailsUrl(detailsUrl) {
     const parts = detailsUrl.split("/");
     return parts[parts.length - 1];
 }
-exports.extractRunIdFromDetailsUrl = extractRunIdFromDetailsUrl;
 function isValidUrl(url) {
     try {
         // Basic URL validation - accepts http, https, localhost, self, and supports ports
@@ -94,4 +95,3 @@ function isValidUrl(url) {
         return false;
     }
 }
-exports.isValidUrl = isValidUrl;

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

@@ -1,15 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.uploadVariableFile = void 0;
-const Fs = require("@supercharge/fs");
-const path = require("path");
-const node_fetch_commonjs_1 = require("node-fetch-commonjs");
+exports.uploadVariableFile = uploadVariableFile;
+const tslib_1 = require("tslib");
+const fs_1 = require("fs");
+const path = tslib_1.__importStar(require("path"));
 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.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: {
@@ -27,17 +26,12 @@ 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.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}`);
     }
     return (0, utils_1.extractUrlWithoutQueryParams)(presignedJson.data.url);
 }
-exports.uploadVariableFile = uploadVariableFile;

package/dist/util/variables-path-parser.js

@@ -1,8 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseVariablesJson = void 0;
-const fs = require("fs");
-const path = require("path");
+exports.parseVariablesJson = parseVariablesJson;
+const tslib_1 = require("tslib");
+const fs = tslib_1.__importStar(require("fs"));
+const path = tslib_1.__importStar(require("path"));
 const type_guards_1 = require("./type-guards");
 const MAX_FILE_SIZE_BYTES = 100 * 1024 * 1024;
 const MAX_COMBINED_SIZE_BYTES = 100 * 1024 * 1024;
@@ -123,4 +124,3 @@ function parseVariablesJson(parsed) {
     }
     return { textValues, fileInputs, certInputs };
 }
-exports.parseVariablesJson = parseVariablesJson;