@testchimp/playwright 0.1.0 → 0.1.2

package/dist/runtime.d.ts

@@ -1,6 +1,15 @@
 /**
  * TrueCoverage runtime: injects CITestInfo into the browser so @testchimp/rum-js can
  * send the ci-test-info header on RUM ingest requests.
+ *
+ * Prefer `installTrueCoverage(mergedTest)` on the same `test` object your specs use
+ * (e.g. `mergeTests` output from `fixtures/index.js`). The side-effect
+ * `import '@testchimp/playwright/runtime'` still registers on the root `@playwright/test`
+ * instance for backward compatibility.
  */
-export {};
+/**
+ * Register TrueCoverage CI metadata injection on the given Playwright `test` object
+ * (including `mergeTests(...)` output). Returns the same instance for chaining.
+ */
+export declare function installTrueCoverage(test: any): any;
 //# sourceMappingURL=runtime.d.ts.map

package/dist/runtime.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"runtime.d.ts","sourceRoot":"","sources":["../src/runtime.ts"],"names":[],"mappings":"AAAA;;;GAGG"}
+{"version":3,"file":"runtime.d.ts","sourceRoot":"","sources":["../src/runtime.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAqBH;;;GAGG;AAEH,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,GAAG,GAAG,GAAG,CAiDlD"}

package/dist/runtime.js

@@ -2,6 +2,11 @@
 /**
  * TrueCoverage runtime: injects CITestInfo into the browser so @testchimp/rum-js can
  * send the ci-test-info header on RUM ingest requests.
+ *
+ * Prefer `installTrueCoverage(mergedTest)` on the same `test` object your specs use
+ * (e.g. `mergeTests` output from `fixtures/index.js`). The side-effect
+ * `import '@testchimp/playwright/runtime'` still registers on the root `@playwright/test`
+ * instance for backward compatibility.
  */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
@@ -37,6 +42,7 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.installTrueCoverage = installTrueCoverage;
 const fs = __importStar(require("fs"));
 const path = __importStar(require("path"));
 const module_1 = require("module");
@@ -46,8 +52,7 @@ function readBatchInvocationId(projectRootDir) {
     const fromEnv = process.env.TESTCHIMP_BATCH_INVOCATION_ID;
     if (fromEnv)
         return fromEnv;
-    const filePath = process.env.TESTCHIMP_BATCH_ID_FILE ||
-        path.join(projectRootDir, BATCH_ID_FILENAME);
+    const filePath = process.env.TESTCHIMP_BATCH_ID_FILE || path.join(projectRootDir, BATCH_ID_FILENAME);
     try {
         return fs.readFileSync(filePath, 'utf8').trim() || undefined;
     }
@@ -55,40 +60,57 @@ function readBatchInvocationId(projectRootDir) {
         return undefined;
     }
 }
+/**
+ * Register TrueCoverage CI metadata injection on the given Playwright `test` object
+ * (including `mergeTests(...)` output). Returns the same instance for chaining.
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+function installTrueCoverage(test) {
+    test.beforeEach(async ({ page }, testInfo) => {
+        const project = testInfo.project;
+        const projectRootDir = project.rootDir ?? process.cwd();
+        const testsFolder = (0, utils_1.deriveTestsFolder)(projectRootDir);
+        const paths = (0, utils_1.derivePathsFromTestInfo)(testInfo, testsFolder, projectRootDir, false);
+        const ciTestInfo = {
+            folderPath: paths.folderPath,
+            fileName: paths.fileName,
+            suitePath: paths.suitePath,
+            testName: paths.testName,
+        };
+        const branchName = (0, utils_1.getBranchName)();
+        if (branchName)
+            ciTestInfo.branchName = branchName;
+        const env = process.env.TESTCHIMP_ENV || process.env.CI_ENVIRONMENT_NAME || process.env.NODE_ENV;
+        if (env)
+            ciTestInfo.environment = env;
+        const release = process.env.TESTCHIMP_RELEASE;
+        if (release)
+            ciTestInfo.release = release;
+        const batchInvocationId = readBatchInvocationId(projectRootDir);
+        if (batchInvocationId)
+            ciTestInfo.batchInvocationId = batchInvocationId;
+        const jsonString = JSON.stringify(ciTestInfo);
+        await page.addInitScript((info) => {
+            // Browser main thread: globalThis is window.
+            globalThis.__TC_CI_TEST_INFO = info;
+        }, jsonString);
+        // Also set on the currently loaded page (if any). `addInitScript` only affects future documents,
+        // so without this, apps that initialize RUM on the first loaded document can emit events before
+        // the init script ever runs.
+        try {
+            await page.evaluate((info) => {
+                globalThis.__TC_CI_TEST_INFO = info;
+            }, jsonString);
+        }
+        catch {
+            // Ignore: page may be closed or not ready yet.
+        }
+    });
+    return test;
+}
 // IMPORTANT: resolve @playwright/test from the *consumer* project, not from this package.
-// This avoids "Requiring @playwright/test second time" when developing via `file:`/linked installs.
 const pwRequire = (0, module_1.createRequire)(path.join(process.cwd(), 'package.json'));
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
-const { test } = pwRequire('@playwright/test');
-test.beforeEach(async ({ page }, testInfo) => {
-    const project = testInfo.project;
-    const projectRootDir = project.rootDir ?? process.cwd();
-    const testsFolder = (0, utils_1.deriveTestsFolder)(projectRootDir);
-    const paths = (0, utils_1.derivePathsFromTestInfo)(testInfo, testsFolder, projectRootDir, false);
-    const ciTestInfo = {
-        folderPath: paths.folderPath,
-        fileName: paths.fileName,
-        suitePath: paths.suitePath,
-        testName: paths.testName,
-    };
-    const branchName = (0, utils_1.getBranchName)();
-    if (branchName)
-        ciTestInfo.branchName = branchName;
-    const env = process.env.TESTCHIMP_ENV ||
-        process.env.CI_ENVIRONMENT_NAME ||
-        process.env.NODE_ENV;
-    if (env)
-        ciTestInfo.environment = env;
-    const release = process.env.TESTCHIMP_RELEASE;
-    if (release)
-        ciTestInfo.release = release;
-    const batchInvocationId = readBatchInvocationId(projectRootDir);
-    if (batchInvocationId)
-        ciTestInfo.batchInvocationId = batchInvocationId;
-    const jsonString = JSON.stringify(ciTestInfo);
-    await page.addInitScript((info) => {
-        globalThis.__TC_CI_TEST_INFO =
-            info;
-    }, jsonString);
-});
+const { test: rootTest } = pwRequire('@playwright/test');
+installTrueCoverage(rootTest);
 //# sourceMappingURL=runtime.js.map

package/dist/runtime.js.map

@@ -1 +1 @@
-{"version":3,"file":"runtime.js","sourceRoot":"","sources":["../src/runtime.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,uCAAyB;AACzB,2CAA6B;AAC7B,mCAAuC;AACvC,mCAAoF;AACpF,MAAM,iBAAiB,GAAG,gCAAgC,CAAC;AAE3D,SAAS,qBAAqB,CAAC,cAAsB;IACnD,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,6BAA6B,CAAC;IAC1D,IAAI,OAAO;QAAE,OAAO,OAAO,CAAC;IAC5B,MAAM,QAAQ,GACZ,OAAO,CAAC,GAAG,CAAC,uBAAuB;QACnC,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,iBAAiB,CAAC,CAAC;IAC/C,IAAI,CAAC;QACH,OAAO,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,IAAI,EAAE,IAAI,SAAS,CAAC;IAC/D,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC;AAED,0FAA0F;AAC1F,oGAAoG;AACpG,MAAM,SAAS,GAAG,IAAA,sBAAa,EAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,cAAc,CAAC,CAAC,CAAC;AAC1E,8DAA8D;AAC9D,MAAM,EAAE,IAAI,EAAE,GAAG,SAAS,CAAC,kBAAkB,CAAQ,CAAC;AAEtD,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,EAAE,IAAI,EAAiB,EAAE,QAAa,EAAE,EAAE;IAC/D,MAAM,OAAO,GAAG,QAAQ,CAAC,OAA+B,CAAC;IACzD,MAAM,cAAc,GAAG,OAAO,CAAC,OAAO,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;IACxD,MAAM,WAAW,GAAG,IAAA,yBAAiB,EAAC,cAAc,CAAC,CAAC;IACtD,MAAM,KAAK,GAAG,IAAA,+BAAuB,EACnC,QAAoE,EACpE,WAAW,EACX,cAAc,EACd,KAAK,CACN,CAAC;IAEF,MAAM,UAAU,GAA4B;QAC1C,UAAU,EAAE,KAAK,CAAC,UAAU;QAC5B,QAAQ,EAAE,KAAK,CAAC,QAAQ;QACxB,SAAS,EAAE,KAAK,CAAC,SAAS;QAC1B,QAAQ,EAAE,KAAK,CAAC,QAAQ;KACzB,CAAC;IACF,MAAM,UAAU,GAAG,IAAA,qBAAa,GAAE,CAAC;IACnC,IAAI,UAAU;QAAE,UAAU,CAAC,UAAU,GAAG,UAAU,CAAC;IACnD,MAAM,GAAG,GACP,OAAO,CAAC,GAAG,CAAC,aAAa;QACzB,OAAO,CAAC,GAAG,CAAC,mBAAmB;QAC/B,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC;IACvB,IAAI,GAAG;QAAE,UAAU,CAAC,WAAW,GAAG,GAAG,CAAC;IACtC,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC;IAC9C,IAAI,OAAO;QAAE,UAAU,CAAC,OAAO,GAAG,OAAO,CAAC;IAC1C,MAAM,iBAAiB,GAAG,qBAAqB,CAAC,cAAc,CAAC,CAAC;IAChE,IAAI,iBAAiB;QAAE,UAAU,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;IAExE,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;IAC9C,MAAM,IAAI,CAAC,aAAa,CACtB,CAAC,IAAY,EAAE,EAAE;QACd,UAAwD,CAAC,iBAAiB;YACzE,IAAI,CAAC;IACT,CAAC,EACD,UAAU,CACX,CAAC;AACJ,CAAC,CAAC,CAAC"}
+{"version":3,"file":"runtime.js","sourceRoot":"","sources":["../src/runtime.ts"],"names":[],"mappings":";AAAA;;;;;;;;GAQG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0BH,kDAiDC;AAzED,uCAAyB;AACzB,2CAA6B;AAC7B,mCAAuC;AACvC,mCAAoF;AAEpF,MAAM,iBAAiB,GAAG,gCAAgC,CAAC;AAE3D,SAAS,qBAAqB,CAAC,cAAsB;IACnD,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,6BAA6B,CAAC;IAC1D,IAAI,OAAO;QAAE,OAAO,OAAO,CAAC;IAC5B,MAAM,QAAQ,GACZ,OAAO,CAAC,GAAG,CAAC,uBAAuB,IAAI,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,iBAAiB,CAAC,CAAC;IACtF,IAAI,CAAC;QACH,OAAO,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,IAAI,EAAE,IAAI,SAAS,CAAC;IAC/D,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,8DAA8D;AAC9D,SAAgB,mBAAmB,CAAC,IAAS;IAC3C,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,EAAE,IAAI,EAAiB,EAAE,QAAa,EAAE,EAAE;QAC/D,MAAM,OAAO,GAAG,QAAQ,CAAC,OAA+B,CAAC;QACzD,MAAM,cAAc,GAAG,OAAO,CAAC,OAAO,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;QACxD,MAAM,WAAW,GAAG,IAAA,yBAAiB,EAAC,cAAc,CAAC,CAAC;QACtD,MAAM,KAAK,GAAG,IAAA,+BAAuB,EACnC,QAAoE,EACpE,WAAW,EACX,cAAc,EACd,KAAK,CACN,CAAC;QAEF,MAAM,UAAU,GAA4B;YAC1C,UAAU,EAAE,KAAK,CAAC,UAAU;YAC5B,QAAQ,EAAE,KAAK,CAAC,QAAQ;YACxB,SAAS,EAAE,KAAK,CAAC,SAAS;YAC1B,QAAQ,EAAE,KAAK,CAAC,QAAQ;SACzB,CAAC;QACF,MAAM,UAAU,GAAG,IAAA,qBAAa,GAAE,CAAC;QACnC,IAAI,UAAU;YAAE,UAAU,CAAC,UAAU,GAAG,UAAU,CAAC;QACnD,MAAM,GAAG,GACP,OAAO,CAAC,GAAG,CAAC,aAAa,IAAI,OAAO,CAAC,GAAG,CAAC,mBAAmB,IAAI,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC;QACvF,IAAI,GAAG;YAAE,UAAU,CAAC,WAAW,GAAG,GAAG,CAAC;QACtC,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC;QAC9C,IAAI,OAAO;YAAE,UAAU,CAAC,OAAO,GAAG,OAAO,CAAC;QAC1C,MAAM,iBAAiB,GAAG,qBAAqB,CAAC,cAAc,CAAC,CAAC;QAChE,IAAI,iBAAiB;YAAE,UAAU,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;QAExE,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;QAC9C,MAAM,IAAI,CAAC,aAAa,CACtB,CAAC,IAAY,EAAE,EAAE;YACf,6CAA6C;YAC5C,UAAwD,CAAC,iBAAiB,GAAG,IAAI,CAAC;QACrF,CAAC,EACD,UAAU,CACX,CAAC;QAEF,iGAAiG;QACjG,gGAAgG;QAChG,6BAA6B;QAC7B,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,QAAQ,CAAC,CAAC,IAAY,EAAE,EAAE;gBAClC,UAAwD,CAAC,iBAAiB,GAAG,IAAI,CAAC;YACrF,CAAC,EAAE,UAAU,CAAC,CAAC;QACjB,CAAC;QAAC,MAAM,CAAC;YACP,+CAA+C;QACjD,CAAC;IACH,CAAC,CAAC,CAAC;IACH,OAAO,IAAI,CAAC;AACd,CAAC;AAED,0FAA0F;AAC1F,MAAM,SAAS,GAAG,IAAA,sBAAa,EAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,cAAc,CAAC,CAAC,CAAC;AAC1E,8DAA8D;AAC9D,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,SAAS,CAAC,kBAAkB,CAAQ,CAAC;AAEhE,mBAAmB,CAAC,QAAQ,CAAC,CAAC"}

package/dist/runtime.mjs

@@ -1,10 +1,10 @@
 import { createRequire } from 'module';
 
-// Importing runtime has side-effects (Playwright hooks). Keep behavior identical to CJS runtime.js,
-// but allow ESM consumers to `import 'playwright-testchimp/runtime'`.
+// Copied to `dist/runtime.mjs` after `tsc`. Loads `./runtime.js` (CJS) for side effects + named exports.
 const require = createRequire(import.meta.url);
 const cjs = require('./runtime.js');
 
+export const installTrueCoverage = cjs.installTrueCoverage;
+
 export * from './worldstate.mjs';
 export default cjs;
-

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@testchimp/playwright",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Playwright reporter for TestChimp test execution tracking and coverage reporting",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -27,7 +27,7 @@
     "dist/"
   ],
   "scripts": {
-    "build": "tsc",
+    "build": "tsc && cp esm/runtime-entry.mjs dist/runtime.mjs",
     "watch": "tsc --watch",
     "clean": "rm -rf dist",
     "test": "npm run build && node --test test/*.test.js"