@empiricalrun/test-run 0.4.2 → 0.4.4

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @empiricalrun/test-run
 
+## 0.4.4
+
+### Patch Changes
+
+- 92bb271: fix: add retry on dashboard fetch call inside test-run package
+
+## 0.4.3
+
+### Patch Changes
+
+- 19075b9: fix: expose --skip-teardown flag on test-run package
+
 ## 0.4.2
 
 ### Patch Changes

package/dist/bin/index.js

@@ -12,6 +12,7 @@ const utils_1 = require("../utils");
         .option("-n, --name <test-name>", "Name of the test to run")
         .option("-d, --dir <test-dir>", "Path to the test directory")
         .option("-p, --project <project-name...>", "Test projects to run")
+        .option("--skip-teardown", `This options skips running teardown tests`)
         .option("--forbid-only", `This options forbids the use of ".only" in the test files`)
         .allowUnknownOption();
     commander_1.program.parse(process.argv);
@@ -25,10 +26,12 @@ const utils_1 = require("../utils");
     const optionsToStrip = [
         "-n",
         "--name",
+        "--skip-teardown",
         "-d",
         "--dir",
         "-p",
         "--project",
+        options.skipTeardown,
         options.name,
         options.dir,
         ...options.project, // an array of comma separated project names/pattern matching globs *,premium-*,super-premium-*,safari
@@ -54,9 +57,13 @@ const utils_1 = require("../utils");
             filteringSets: [...options.project, ...environmentSpecificProjects],
         });
         pwOptions.push(...projectFilters);
+        const directory = options.dir || "tests";
+        if (options.skipTeardown) {
+            await (0, utils_1.handleTeardownSkipFlag)(directory);
+        }
         const { hasTestPassed } = await (0, __1.runTest)({
             name: options.name,
-            dir: options.dir || "tests",
+            dir: directory,
             pwOptions: pwOptions.join(" "),
             platform,
         });

package/dist/dashboard.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"dashboard.d.ts","sourceRoot":"","sources":["../src/dashboard.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAK7C,eAAO,MAAM,wBAAwB,QAAa,QAAQ;IACxD,WAAW,EAAE,WAAW,CAAC;IACzB,KAAK,EAAE,KAAK,CAAC;CACd,CA6BA,CAAC"}
+{"version":3,"file":"dashboard.d.ts","sourceRoot":"","sources":["../src/dashboard.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAK7C,eAAO,MAAM,wBAAwB,QAAa,QAAQ;IACxD,WAAW,EAAE,WAAW,CAAC;IACzB,KAAK,EAAE,KAAK,CAAC;CACd,CAyDA,CAAC"}

package/dist/dashboard.js

@@ -1,22 +1,44 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.fetchEnvironmentAndBuild = void 0;
+const async_retry_1 = __importDefault(require("async-retry"));
 const utils_1 = require("./utils");
 const DOMAIN = process.env.DASHBOARD_DOMAIN || "https://dash.empirical.run";
 const fetchEnvironmentAndBuild = async () => {
+    if (!process.env.PROJECT_NAME) {
+        throw new Error("PROJECT_NAME is required for fetching environment and latest build");
+    }
     const projectRepo = (0, utils_1.buildRepoName)(process.env.PROJECT_NAME);
     const environmentSlug = `${process.env.TEST_RUN_ENVIRONMENT}`;
-    const resp = await fetch(`${DOMAIN}/api/environments?project_repo_name=${projectRepo}&environment_slug=${environmentSlug}`, {
-        method: "GET",
-        headers: {
-            "Content-Type": "application/json",
-            Authorization: `weQPMWKT`,
-        },
+    const data = await (0, async_retry_1.default)(async (bail) => {
+        const resp = await fetch(`${DOMAIN}/api/environments?project_repo_name=${projectRepo}&environment_slug=${environmentSlug}`, {
+            method: "GET",
+            headers: {
+                "Content-Type": "application/json",
+                Authorization: `weQPMWKT`,
+            },
+        });
+        if (!resp.ok) {
+            if (resp.status === 400) {
+                const erroredResponse = await resp.json();
+                bail(new Error(erroredResponse?.error?.message));
+                return;
+            }
+            throw new Error(`Failed to fetch environment and latest build from dashboard for project: ${projectRepo} and env slug: ${environmentSlug}`);
+        }
+        return (await resp.json());
+    }, {
+        retries: 3,
+        minTimeout: 1000,
+        maxTimeout: 60000,
+        factor: 3,
     });
-    if (!resp.ok) {
-        throw new Error(`Failed to fetch environment from dashboard for project: ${projectRepo} and env slug: ${environmentSlug}. Use PROJECT_NAME and TEST_RUN_ENVIRONMENT env vars to set these values correctly.`);
+    if (!data?.data) {
+        throw new Error(`Failed to fetch environment and latest build from dashboard for project: ${projectRepo} and env slug: ${environmentSlug}.`);
     }
-    const data = (await resp.json());
     return data.data;
 };
 exports.fetchEnvironmentAndBuild = fetchEnvironmentAndBuild;

package/dist/types/index.d.ts

@@ -27,4 +27,9 @@ export declare enum TestFramework {
     PLAYWRIGHT = "playwright",
     APPWRIGHT = "appwright"
 }
+export type PlaywProjectConfig = {
+    name: string;
+    teardown?: string;
+    testMatch: string | RegExp;
+};
 //# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,iBAAiB,GAAG;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,QAAQ,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,mBAAmB,EAAE,MAAM,EAAE,CAAC;IAC9B,QAAQ,EAAE,QAAQ,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,KAAK,GAAG;IAClB,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACjC,CAAC;AAEF,oBAAY,QAAQ;IAClB,GAAG,QAAQ;IACX,OAAO,YAAY;IACnB,GAAG,QAAQ;CACZ;AAED,oBAAY,aAAa;IACvB,UAAU,eAAe;IACzB,SAAS,cAAc;CACxB"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,iBAAiB,GAAG;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,QAAQ,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,mBAAmB,EAAE,MAAM,EAAE,CAAC;IAC9B,QAAQ,EAAE,QAAQ,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,KAAK,GAAG;IAClB,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACjC,CAAC;AAEF,oBAAY,QAAQ;IAClB,GAAG,QAAQ;IACX,OAAO,YAAY;IACnB,GAAG,QAAQ;CACZ;AAED,oBAAY,aAAa;IACvB,UAAU,eAAe;IACzB,SAAS,cAAc;CACxB;AAED,MAAM,MAAM,kBAAkB,GAAG;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,GAAG,MAAM,CAAC;CAC5B,CAAC"}

package/dist/utils/index.d.ts

@@ -38,4 +38,5 @@ export declare const generateProjectFilters: ({ platform, filteringSets, }: {
 export declare function buildRepoName(projectName: string): string;
 export declare const downloadBuild: (buildUrl: string) => Promise<void>;
 export declare const getTestRunner: (platform: Platform) => TestFramework;
+export declare const handleTeardownSkipFlag: (directory: string) => Promise<void>;
 //# sourceMappingURL=index.d.ts.map

package/dist/utils/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,IAAI,EAAW,UAAU,EAAc,MAAM,UAAU,CAAC;AAGjE,OAAO,EAAsB,QAAQ,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAEvE,wBAAgB,GAAG,CACjB,OAAO,EAAE,MAAM,EAAE,EACjB,OAAO,EAAE;IAAE,GAAG,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAAE,GACxC,OAAO,CAAC,MAAM,CAAC,CA2BjB;AAED;;;;;GAKG;AACH,wBAAsB,eAAe,CACnC,aAAa,GAAE,MAAW,GACzB,OAAO,CAAC,MAAM,EAAE,CAAC,CAqBnB;AAED,wBAAsB,eAAe,CAAC,EACpC,QAAQ,EACR,YAAY,GACb,EAAE;IACD,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,CAAC;CACtB,GAAG,OAAO,CAAC;IAAE,YAAY,EAAE,IAAI,GAAG,SAAS,CAAC;IAAC,UAAU,EAAE,UAAU,CAAA;CAAE,CAAC,CAatE;AAED,wBAAsB,YAAY,CAAC,EACjC,QAAQ,EACR,YAAY,GACb,EAAE;IACD,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,CAAC;CACtB,GAAG,OAAO,CAAC,OAAO,CAAC,CAMnB;AAED,wBAAgB,4BAA4B,CAC1C,IAAI,EAAE,IAAI,GAAG,SAAS,GACrB,IAAI,GAAG,SAAS,CA2BlB;AAED,wBAAsB,0CAA0C,CAC9D,QAAQ,EAAE,MAAM,oBA+BjB;AAED,wBAAsB,cAAc,CAAC,EACnC,UAAU,EACV,kBAAkB,EAClB,YAAY,EACZ,QAAQ,GACT,EAAE;IACD,UAAU,EAAE,UAAU,CAAC;IACvB,kBAAkB,CAAC,EAAE,IAAI,GAAG,SAAS,CAAC;IACtC,YAAY,EAAE,IAAI,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;CAClB,iBAgBA;AAED,wBAAsB,+BAA+B,CAAC,QAAQ,EAAE,QAAQ,gBAevE;AAED,eAAO,MAAM,4BAA4B,UAEhC,MAAM,EAAE,mBAGE,MAAM,EAAE,EAAE,KAC1B,MAAM,EAUR,CAAC;AAEF,eAAO,MAAM,sBAAsB;cAIvB,QAAQ;mBACH,MAAM,EAAE;MACrB,QAAQ,MAAM,EAAE,CAmBnB,CAAC;AAEF,wBAAgB,aAAa,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,CAEzD;AAED,eAAO,MAAM,aAAa,aAAoB,MAAM,KAAG,QAAQ,IAAI,CAWlE,CAAC;AAEF,eAAO,MAAM,aAAa,aAAc,QAAQ,KAAG,aAIlD,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,IAAI,EAAW,UAAU,EAAc,MAAM,UAAU,CAAC;AAGjE,OAAO,EAEL,QAAQ,EAER,aAAa,EACd,MAAM,UAAU,CAAC;AAElB,wBAAgB,GAAG,CACjB,OAAO,EAAE,MAAM,EAAE,EACjB,OAAO,EAAE;IAAE,GAAG,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAAE,GACxC,OAAO,CAAC,MAAM,CAAC,CA2BjB;AAED;;;;;GAKG;AACH,wBAAsB,eAAe,CACnC,aAAa,GAAE,MAAW,GACzB,OAAO,CAAC,MAAM,EAAE,CAAC,CAqBnB;AAED,wBAAsB,eAAe,CAAC,EACpC,QAAQ,EACR,YAAY,GACb,EAAE;IACD,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,CAAC;CACtB,GAAG,OAAO,CAAC;IAAE,YAAY,EAAE,IAAI,GAAG,SAAS,CAAC;IAAC,UAAU,EAAE,UAAU,CAAA;CAAE,CAAC,CAatE;AAED,wBAAsB,YAAY,CAAC,EACjC,QAAQ,EACR,YAAY,GACb,EAAE;IACD,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,CAAC;CACtB,GAAG,OAAO,CAAC,OAAO,CAAC,CAMnB;AAED,wBAAgB,4BAA4B,CAC1C,IAAI,EAAE,IAAI,GAAG,SAAS,GACrB,IAAI,GAAG,SAAS,CA2BlB;AAED,wBAAsB,0CAA0C,CAC9D,QAAQ,EAAE,MAAM,oBA+BjB;AAED,wBAAsB,cAAc,CAAC,EACnC,UAAU,EACV,kBAAkB,EAClB,YAAY,EACZ,QAAQ,GACT,EAAE;IACD,UAAU,EAAE,UAAU,CAAC;IACvB,kBAAkB,CAAC,EAAE,IAAI,GAAG,SAAS,CAAC;IACtC,YAAY,EAAE,IAAI,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;CAClB,iBAgBA;AAED,wBAAsB,+BAA+B,CAAC,QAAQ,EAAE,QAAQ,gBAevE;AAED,eAAO,MAAM,4BAA4B,UAEhC,MAAM,EAAE,mBAGE,MAAM,EAAE,EAAE,KAC1B,MAAM,EAUR,CAAC;AAEF,eAAO,MAAM,sBAAsB;cAIvB,QAAQ;mBACH,MAAM,EAAE;MACrB,QAAQ,MAAM,EAAE,CAmBnB,CAAC;AAEF,wBAAgB,aAAa,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,CAEzD;AAED,eAAO,MAAM,aAAa,aAAoB,MAAM,KAAG,QAAQ,IAAI,CAWlE,CAAC;AAEF,eAAO,MAAM,aAAa,aAAc,QAAQ,KAAG,aAIlD,CAAC;AA4DF,eAAO,MAAM,sBAAsB,cAAqB,MAAM,kBAkB7D,CAAC"}

package/dist/utils/index.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getTestRunner = exports.downloadBuild = exports.buildRepoName = exports.generateProjectFilters = exports.filterArrayByGlobMatchersSet = exports.getProjectsFromPlaywrightConfig = exports.markTestAsOnly = exports.hasTopLevelDescribeConfigureWithSerialMode = exports.findFirstSerialDescribeBlock = exports.hasTestBlock = exports.getTestCaseNode = exports.getAllFilePaths = exports.cmd = void 0;
+exports.handleTeardownSkipFlag = exports.getTestRunner = exports.downloadBuild = exports.buildRepoName = exports.generateProjectFilters = exports.filterArrayByGlobMatchersSet = exports.getProjectsFromPlaywrightConfig = exports.markTestAsOnly = exports.hasTopLevelDescribeConfigureWithSerialMode = exports.findFirstSerialDescribeBlock = exports.hasTestBlock = exports.getTestCaseNode = exports.getAllFilePaths = exports.cmd = void 0;
 const child_process_1 = require("child_process");
 const fs_extra_1 = __importDefault(require("fs-extra"));
 const minimatch_1 = require("minimatch");
@@ -221,3 +221,67 @@ const getTestRunner = (platform) => {
         : types_1.TestFramework.APPWRIGHT;
 };
 exports.getTestRunner = getTestRunner;
+const getAllTeardownFiles = async (directory) => {
+    const teardownFileRegex = /.*\.teardown\.ts/;
+    const files = await getAllFilePaths(directory);
+    return files.filter((file) => teardownFileRegex.test(file));
+};
+const skipTeardownFile = async (filePath) => {
+    const project = new ts_morph_1.Project();
+    const sourceFile = project.addSourceFileAtPath(filePath);
+    sourceFile
+        .getDescendantsOfKind(ts_morph_1.SyntaxKind.CallExpression)
+        .forEach((callExpression) => {
+        const expression = callExpression.getExpression();
+        if (expression.getText() === "teardown") {
+            expression.replaceWithText("teardown.skip");
+        }
+        else if (expression.getText() === "test") {
+            expression.replaceWithText("test.skip");
+        }
+    });
+    // Save the modified file
+    sourceFile.save().catch((error) => {
+        console.error(`Error updating the file: ${filePath}`, error);
+    });
+};
+class TeardownManager {
+    directory;
+    constructor(directory) {
+        this.directory = directory;
+    }
+    teardownFiles = [];
+    teardownFileContents = [];
+    async skip() {
+        this.teardownFiles = await getAllTeardownFiles(this.directory);
+        this.teardownFileContents = await Promise.all(this.teardownFiles.map(async (filePath) => {
+            const content = await fs_extra_1.default.readFile(filePath, "utf-8");
+            return { filePath, content };
+        }));
+        await Promise.all(this.teardownFiles.map(async (filePath) => await skipTeardownFile(filePath)));
+    }
+    unskip() {
+        this.teardownFileContents.forEach(({ filePath, content }) => {
+            fs_extra_1.default.writeFileSync(filePath, content, "utf-8");
+        });
+    }
+}
+const handleTeardownSkipFlag = async (directory) => {
+    console.log("Skipping teardown tests ...");
+    const teardowns = new TeardownManager(directory);
+    await teardowns.skip();
+    // revert teardown changes on exit
+    process.on("beforeExit", () => {
+        teardowns.unskip();
+    });
+    process.on("exit", () => {
+        teardowns.unskip();
+    });
+    process.on("SIGINT", () => {
+        teardowns.unskip();
+    });
+    process.on("SIGTERM", () => {
+        teardowns.unskip();
+    });
+};
+exports.handleTeardownSkipFlag = handleTeardownSkipFlag;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@empiricalrun/test-run",
-  "version": "0.4.2",
+  "version": "0.4.4",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -15,6 +15,7 @@
   },
   "author": "Empirical Team <hey@empirical.run>",
   "dependencies": {
+    "async-retry": "^1.3.3",
     "commander": "^12.1.0",
     "fs-extra": "^11.2.0",
     "minimatch": "^10.0.1",
@@ -22,6 +23,7 @@
     "tsx": "^4.16.2"
   },
   "devDependencies": {
+    "@types/async-retry": "^1.4.8",
     "@types/fs-extra": "^11.0.4",
     "@types/node": "^22.5.5"
   },