@alwaysmeticulous/remote-replay-launcher 2.117.0

package/LICENSE

@@ -0,0 +1,15 @@
+ISC License
+
+Copyright (c) 2022, Meticulous Contributors
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.

package/README.md

@@ -0,0 +1,5 @@
+# Remote Replay Launcher
+
+Exposes a simple API for launching remote(running in Meticulous' cloud) test runs 
+against an app hosted locally, and exposed via the Meticulous secure tunnels service.
+([see @alwaysmeticulous/tunnel-client](../tunnel-client))

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+import { ExecuteRemoteTestRunOptions, ExecuteRemoteTestRunResult } from "./types";
+export declare const executeRemoteTestRun: ({ apiToken: apiToken_, appUrl, commitSha, onTunnelCreated, onTestRunCreated, onProgressUpdate, environment, }: ExecuteRemoteTestRunOptions) => Promise<ExecuteRemoteTestRunResult>;

package/dist/index.js

@@ -0,0 +1,80 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.executeRemoteTestRun = void 0;
+const client_1 = require("@alwaysmeticulous/client");
+const common_1 = require("@alwaysmeticulous/common");
+const tunnels_client_1 = require("@alwaysmeticulous/tunnels-client");
+const loglevel_1 = __importDefault(require("loglevel"));
+const PROGRESS_UPDATE_INTERVAL_MS = 5000; // 5 seconds
+const executeRemoteTestRun = async ({ apiToken: apiToken_, appUrl, commitSha, onTunnelCreated, onTestRunCreated, onProgressUpdate, environment, }) => {
+    const logger = loglevel_1.default.getLogger(common_1.METICULOUS_LOGGER_NAME);
+    const apiToken = (0, client_1.getApiToken)(apiToken_);
+    if (!apiToken) {
+        logger.error("You must provide an API token by using the --apiToken parameter");
+        process.exit(1);
+    }
+    const client = (0, client_1.createClient)({ apiToken });
+    let url;
+    try {
+        url = new URL(appUrl);
+    }
+    catch (error) {
+        throw new Error(`Invalid app URL: ${appUrl}`);
+    }
+    const tunnel = await (0, tunnels_client_1.localtunnel)({
+        logger,
+        apiToken,
+        localHost: url.hostname,
+        port: parseInt(url.port, 10),
+        localHttps: false,
+        allowInvalidCert: false,
+    });
+    logger.debug(`Creating test run`);
+    if (!tunnel.url || !tunnel.basicAuthUser || !tunnel.basicAuthPassword) {
+        throw new Error("Either Tunnel URL, basic auth user or basic auth password were not set");
+    }
+    onTunnelCreated === null || onTunnelCreated === void 0 ? void 0 : onTunnelCreated({
+        url: tunnel.url,
+        basicAuthUser: tunnel.basicAuthUser,
+        basicAuthPassword: tunnel.basicAuthPassword,
+    });
+    const testRun = await (0, client_1.executeSecureTunnelTestRun)({
+        client,
+        headSha: commitSha,
+        tunnelUrl: tunnel.url,
+        basicAuthUser: tunnel.basicAuthUser,
+        basicAuthPassword: tunnel.basicAuthPassword,
+        environment,
+    });
+    if (!testRun) {
+        throw new Error("Test run was not created");
+    }
+    onTestRunCreated === null || onTestRunCreated === void 0 ? void 0 : onTestRunCreated(testRun);
+    const testRunCompleted = (0, common_1.defer)();
+    let progressUpdateInterval = undefined;
+    const onTestRunCompleted = (completedTestRun) => {
+        if (progressUpdateInterval) {
+            clearInterval(progressUpdateInterval);
+        }
+        tunnel.close();
+        testRunCompleted.resolve(completedTestRun);
+    };
+    // Poll every few seconds for progress updates and exit when the test run is completed
+    progressUpdateInterval = setInterval(async () => {
+        const updatedTestRun = await (0, client_1.getTestRun)({ client, testRunId: testRun.id });
+        if (!client_1.IN_PROGRESS_TEST_RUN_STATUS.includes(updatedTestRun.status)) {
+            onTestRunCompleted(updatedTestRun);
+            return;
+        }
+        onProgressUpdate === null || onProgressUpdate === void 0 ? void 0 : onProgressUpdate(updatedTestRun);
+    }, PROGRESS_UPDATE_INTERVAL_MS);
+    const completedTestRun = await testRunCompleted.promise;
+    return {
+        testRun: completedTestRun,
+    };
+};
+exports.executeRemoteTestRun = executeRemoteTestRun;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;AAAA,qDAOkC;AAClC,qDAAyE;AACzE,qEAA+D;AAC/D,wDAA2B;AAM3B,MAAM,2BAA2B,GAAG,IAAK,CAAC,CAAC,YAAY;AAEhD,MAAM,oBAAoB,GAAG,KAAK,EAAE,EACzC,QAAQ,EAAE,SAAS,EACnB,MAAM,EACN,SAAS,EACT,eAAe,EACf,gBAAgB,EAChB,gBAAgB,EAChB,WAAW,GACiB,EAAuC,EAAE;IACrE,MAAM,MAAM,GAAG,kBAAG,CAAC,SAAS,CAAC,+BAAsB,CAAC,CAAC;IAErD,MAAM,QAAQ,GAAG,IAAA,oBAAW,EAAC,SAAS,CAAC,CAAC;IACxC,IAAI,CAAC,QAAQ,EAAE;QACb,MAAM,CAAC,KAAK,CACV,iEAAiE,CAClE,CAAC;QACF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACjB;IAED,MAAM,MAAM,GAAG,IAAA,qBAAY,EAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;IAE1C,IAAI,GAAQ,CAAC;IACb,IAAI;QACF,GAAG,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,CAAC;KACvB;IAAC,OAAO,KAAK,EAAE;QACd,MAAM,IAAI,KAAK,CAAC,oBAAoB,MAAM,EAAE,CAAC,CAAC;KAC/C;IAED,MAAM,MAAM,GAAG,MAAM,IAAA,4BAAW,EAAC;QAC/B,MAAM;QACN,QAAQ;QACR,SAAS,EAAE,GAAG,CAAC,QAAQ;QACvB,IAAI,EAAE,QAAQ,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC;QAC5B,UAAU,EAAE,KAAK;QACjB,gBAAgB,EAAE,KAAK;KACxB,CAAC,CAAC;IAEH,MAAM,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAC;IAElC,IAAI,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,aAAa,IAAI,CAAC,MAAM,CAAC,iBAAiB,EAAE;QACrE,MAAM,IAAI,KAAK,CACb,wEAAwE,CACzE,CAAC;KACH;IAED,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAG;QAChB,GAAG,EAAE,MAAM,CAAC,GAAG;QACf,aAAa,EAAE,MAAM,CAAC,aAAa;QACnC,iBAAiB,EAAE,MAAM,CAAC,iBAAiB;KAC5C,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,MAAM,IAAA,mCAA0B,EAAC;QAC/C,MAAM;QACN,OAAO,EAAE,SAAS;QAClB,SAAS,EAAE,MAAM,CAAC,GAAG;QACrB,aAAa,EAAE,MAAM,CAAC,aAAa;QACnC,iBAAiB,EAAE,MAAM,CAAC,iBAAiB;QAC3C,WAAW;KACZ,CAAC,CAAC;IAEH,IAAI,CAAC,OAAO,EAAE;QACZ,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;KAC7C;IAED,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAG,OAAO,CAAC,CAAC;IAE5B,MAAM,gBAAgB,GAAG,IAAA,cAAK,GAAW,CAAC;IAE1C,IAAI,sBAAsB,GAA+B,SAAS,CAAC;IAEnE,MAAM,kBAAkB,GAAG,CAAC,gBAAyB,EAAE,EAAE;QACvD,IAAI,sBAAsB,EAAE;YAC1B,aAAa,CAAC,sBAAsB,CAAC,CAAC;SACvC;QAED,MAAM,CAAC,KAAK,EAAE,CAAC;QAEf,gBAAgB,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAC7C,CAAC,CAAC;IAEF,sFAAsF;IACtF,sBAAsB,GAAG,WAAW,CAAC,KAAK,IAAI,EAAE;QAC9C,MAAM,cAAc,GAAG,MAAM,IAAA,mBAAU,EAAC,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,CAAC,EAAE,EAAE,CAAC,CAAC;QAE3E,IAAI,CAAC,oCAA2B,CAAC,QAAQ,CAAC,cAAc,CAAC,MAAM,CAAC,EAAE;YAChE,kBAAkB,CAAC,cAAc,CAAC,CAAC;YAEnC,OAAO;SACR;QAED,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAG,cAAc,CAAC,CAAC;IACrC,CAAC,EAAE,2BAA2B,CAAC,CAAC;IAEhC,MAAM,gBAAgB,GAAG,MAAM,gBAAgB,CAAC,OAAO,CAAC;IAExD,OAAO;QACL,OAAO,EAAE,gBAAgB;KAC1B,CAAC;AACJ,CAAC,CAAC;AAlGW,QAAA,oBAAoB,wBAkG/B"}

package/dist/types.d.ts

@@ -0,0 +1,19 @@
+import { TestRun } from "@alwaysmeticulous/client";
+interface TunnelData {
+    url: string;
+    basicAuthUser: string;
+    basicAuthPassword: string;
+}
+export interface ExecuteRemoteTestRunOptions {
+    apiToken: string | null | undefined;
+    appUrl: string;
+    commitSha: string;
+    onTunnelCreated?: (data: TunnelData) => void;
+    onTestRunCreated?: (testRun: TestRun) => void;
+    onProgressUpdate?: (testRun: TestRun) => void;
+    environment: string;
+}
+export interface ExecuteRemoteTestRunResult {
+    testRun: TestRun;
+}
+export {};

package/dist/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@alwaysmeticulous/remote-replay-launcher",
+  "version": "2.117.0",
+  "description": "Executes a remote replay on Meticulous' infrastructure",
+  "license": "ISC",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "clean": "rimraf dist tsconfig.tsbuildinfo",
+    "build": "tsc --build tsconfig.json",
+    "dev": "tsc --build tsconfig.json --watch",
+    "format": "prettier --write src",
+    "lint": "eslint src --ext=ts,tsx,js --cache",
+    "lint:commit": "eslint --cache $(git diff --relative --name-only --diff-filter=ACMRTUXB master | grep  -E \"(.js$|.ts$|.tsx$)\")",
+    "lint:fix": "eslint src --ext=ts,tsx,js --cache --fix",
+    "depcheck": "depcheck --ignore-patterns=dist"
+  },
+  "dependencies": {
+    "@alwaysmeticulous/client": "^2.116.0",
+    "@alwaysmeticulous/common": "^2.116.0",
+    "@alwaysmeticulous/tunnels-client": "^2.115.0",
+    "loglevel": "^1.8.0"
+  },
+  "author": {
+    "name": "The Meticulous Team",
+    "email": "eng@meticulous.ai",
+    "url": "https://meticulous.ai"
+  },
+  "engines": {
+    "node": ">= 12"
+  },
+  "homepage": "https://github.com/alwaysmeticulous/meticulous-sdk",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/alwaysmeticulous/meticulous-sdk.git",
+    "directory": "packages/replay-orchestrator-launcher"
+  },
+  "bugs": {
+    "url": "https://github.com/alwaysmeticulous/meticulous-sdk/issues"
+  },
+  "gitHead": "0f86f5f6dd5f2a6009b5d478c47664ca42c76e73"
+}