@checkly/playwright-reporter 1.0.0 → 1.0.2

package/CHANGELOG.md

@@ -0,0 +1,55 @@
+# Changelog
+
+All notable changes to `@checkly/playwright-reporter` will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
+
+## 1.0.2 (2026-01-19)
+
+### Fixed
+
+- Test session creation is now properly awaited before uploading results, fixing intermittent upload failures in CI environments.
+
+## 1.0.1 (2026-01-19)
+
+### Fixed
+
+- Sharded test execution now works correctly when using `playwright merge-reports` command. Due to a Playwright limitation, `config.projects` is empty after merging blob reports - the reporter now reconstructs project information from the test suite structure.
+- Default projects (when no explicit projects are defined in playwright.config.ts) now preserve their empty name correctly instead of being renamed to "default".
+
+## 1.0.0 (2025-01-19)
+
+First stable release of the rewritten Playwright reporter with extension-based architecture.
+
+### Added
+
+- **Extension-based architecture** - Modular design allows for composable functionality
+- **Broad Playwright support** - Compatible with Playwright versions 1.40 through 1.57+
+- **Drop-in JSON replacement** - Fully compatible with Playwright's native JSON reporter output format
+- **Trace extraction** - Automatically extracts console messages and network requests from Playwright trace files
+- **Checkly integration** - Automatic upload to Checkly Test Sessions when credentials are configured
+- **New `createChecklyReporter()` function** - Better intellisense support in `playwright.config.ts`
+- **Unified `outputDir` option** - Single option for all output files (JSON report, ZIP assets)
+- **Verbose logging** - Debug mode for troubleshooting report generation
+
+### Changed
+
+- `outputFile` option is deprecated - use `outputDir` instead (JSON written to `{outputDir}/checkly-report.json`)
+- `testResultsDir` option is deprecated - use `outputDir` instead
+- `outputPath` option is deprecated - ZIP written to `{outputDir}/checkly-report.zip`
+
+### Migration from 0.x
+
+```diff
+// playwright.config.ts
++import { createChecklyReporter } from '@checkly/playwright-reporter'
+
+export default defineConfig({
+  reporter: [
+-   ['@checkly/playwright-reporter', { outputFile: 'results/report.json' }],
++   createChecklyReporter({ outputDir: 'results' }),
+  ],
+})
+```
+
+The legacy 0.x reporter remains available via `npm install @checkly/playwright-reporter@legacy`.

package/dist/index.d.ts

@@ -247,6 +247,7 @@ declare class BaseReporter implements Reporter {
     private _report;
     private extensions;
     private summaryLines;
+    private reconstructedProjects;
     constructor(options?: BaseReporterOptions);
     protected use(extension: Extension$1): this;
     private log;
@@ -264,6 +265,17 @@ declare class BaseReporter implements Reporter {
     printsToStdio(): boolean;
     getReport(): JSONReport;
     private buildReport;
+    /**
+     * Reconstructs projects from the suite structure when config.projects is empty.
+     * This handles the merge-reports scenario where Playwright doesn't populate
+     * config.projects but still provides project information via suite.project().
+     */
+    private reconstructProjectsIfNeeded;
+    /**
+     * Recursively collects project information from test cases in the suite.
+     * Fallback for when suite.project() doesn't provide project info.
+     */
+    private collectProjectsFromTests;
     private serializeConfig;
     private serializeProject;
     /**
@@ -289,6 +301,11 @@ declare class BaseReporter implements Reporter {
      */
     private extractTags;
     private serializeTest;
+    /**
+     * Get the project name for a test case, handling merge-reports scenarios
+     * where project() may not be available in the expected way.
+     */
+    private getProjectName;
     private serializeTestResult;
     private serializeStep;
     private serializeError;

package/dist/index.js

@@ -1598,6 +1598,7 @@ function checklyUpload(options = {}) {
   }
   let api;
   let testSession;
+  let sessionCreationPromise;
   let startTime;
   let resolvedOutputDir;
   let assetCollector;
@@ -1616,6 +1617,26 @@ function checklyUpload(options = {}) {
     if (typeof sessionName === "string") return sessionName;
     return `Playwright Test Session: ${ctx.directoryName}`;
   }
+  async function createSession(config, suite, log) {
+    if (!api) return;
+    try {
+      const directoryName = getDirectoryName();
+      const sessionName = resolveSessionName({ directoryName, config, suite });
+      const repoInfo = getGitHubRepoInfo();
+      log("\u{1F517} Creating test session", { name: sessionName, environment });
+      testSession = await api.testSessions.create({
+        name: sessionName,
+        environment: process.env.NODE_ENV || "test",
+        repoInfo,
+        startedAt: startTime.getTime(),
+        testResults: [{ name: directoryName }],
+        provider: "PW_REPORTER"
+      });
+      log("\u2705 Session created", { id: testSession.testSessionId });
+    } catch (err2) {
+      console.error("[Checkly] Failed to create test session:", err2);
+    }
+  }
   function checkTraceAttachment(test, result) {
     const key = `${test.id}:${result.retry}`;
     const traceAttachment = result.attachments?.find((a) => a.name === "trace" || a.contentType === "application/zip");
@@ -1740,7 +1761,7 @@ function checklyUpload(options = {}) {
   }
   return {
     name: "checkly-upload",
-    onBegin: async ({ config, suite, log }) => {
+    onBegin: ({ config, suite, log }) => {
       startTime = /* @__PURE__ */ new Date();
       resolvedOutputDir = options.outputDir ?? options.testResultsDir ?? config.projects[0]?.outputDir ?? "test-results";
       const zipPath = options.outputPath ?? path3.join(resolvedOutputDir, "checkly-report.zip");
@@ -1752,23 +1773,7 @@ function checklyUpload(options = {}) {
         }
         return;
       }
-      try {
-        const directoryName = getDirectoryName();
-        const sessionName = resolveSessionName({ directoryName, config, suite });
-        const repoInfo = getGitHubRepoInfo();
-        log("\u{1F517} Creating test session", { name: sessionName, environment });
-        testSession = await api.testSessions.create({
-          name: sessionName,
-          environment: process.env.NODE_ENV || "test",
-          repoInfo,
-          startedAt: startTime.getTime(),
-          testResults: [{ name: directoryName }],
-          provider: "PW_REPORTER"
-        });
-        log("\u2705 Session created", { id: testSession.testSessionId });
-      } catch (err2) {
-        console.error("[Checkly] Failed to create test session:", err2);
-      }
+      sessionCreationPromise = createSession(config, suite, log);
     },
     onTestEnd: ({ test, result }) => {
       checkTraceAttachment(test, result);
@@ -1786,6 +1791,9 @@ function checklyUpload(options = {}) {
     },
     onEnd: async ({ report, log, addSummaryLine }) => {
       try {
+        if (sessionCreationPromise) {
+          await sessionCreationPromise;
+        }
         await extractDataFromTraces(log);
         injectDataIntoReport(report);
         fs4.mkdirSync(resolvedOutputDir, { recursive: true });
@@ -1855,6 +1863,8 @@ var BaseReporter = class {
   _report = null;
   extensions = [];
   summaryLines = [];
+  // Reconstructed projects for merge-reports scenarios
+  reconstructedProjects = /* @__PURE__ */ new Map();
   constructor(options = {}) {
     this.options = options;
     this.verbose = options.verbose ?? process.env.CHECKLY_REPORTER_VERBOSE === "true";
@@ -1889,8 +1899,10 @@ var BaseReporter = class {
     this.flakyCount = 0;
     this.skippedCount = 0;
     this._report = null;
+    this.reconstructedProjects.clear();
+    this.reconstructProjectsIfNeeded();
     const testCount = this.countTests(suite);
-    const projectNames = config.projects.map((p) => p.name).join(", ");
+    const projectNames = config.projects.length > 0 ? config.projects.map((p) => p.name).join(", ") : Array.from(this.reconstructedProjects.keys()).join(", ") || "default";
     this.log(`\u{1F3AC} Starting test run`, { tests: testCount, projects: projectNames, workers: config.workers });
     for (const ext of this.extensions) {
       ext.onBegin?.({ config, suite, log: this.createExtensionLogger(ext.name) });
@@ -2022,8 +2034,86 @@ var BaseReporter = class {
       }
     };
   }
+  /**
+   * Reconstructs projects from the suite structure when config.projects is empty.
+   * This handles the merge-reports scenario where Playwright doesn't populate
+   * config.projects but still provides project information via suite.project().
+   */
+  reconstructProjectsIfNeeded() {
+    if (this.config.projects.length > 0) {
+      return;
+    }
+    this.log("\u{1F504} Detected merge-reports scenario (empty config.projects), reconstructing projects");
+    for (const projectSuite of this.suite.suites) {
+      const project = projectSuite.project();
+      if (project) {
+        const name = project.name || "default";
+        if (!this.reconstructedProjects.has(name)) {
+          this.reconstructedProjects.set(name, {
+            id: name,
+            name,
+            testDir: project.testDir,
+            outputDir: project.outputDir,
+            timeout: project.timeout,
+            retries: project.retries,
+            repeatEach: project.repeatEach,
+            metadata: project.metadata ?? {},
+            testMatch: Array.isArray(project.testMatch) ? project.testMatch.map(String) : [String(project.testMatch)],
+            testIgnore: Array.isArray(project.testIgnore) ? project.testIgnore.map(String) : [String(project.testIgnore)]
+          });
+        }
+      }
+    }
+    if (this.reconstructedProjects.size === 0) {
+      this.collectProjectsFromTests(this.suite);
+    }
+    this.log("\u{1F504} Reconstructed projects", {
+      count: this.reconstructedProjects.size,
+      names: Array.from(this.reconstructedProjects.keys())
+    });
+  }
+  /**
+   * Recursively collects project information from test cases in the suite.
+   * Fallback for when suite.project() doesn't provide project info.
+   */
+  collectProjectsFromTests(suite) {
+    for (const test of suite.allTests()) {
+      const project = test.parent.project();
+      const projectName = project?.name || "default";
+      if (!this.reconstructedProjects.has(projectName)) {
+        if (project) {
+          this.reconstructedProjects.set(projectName, {
+            id: projectName,
+            name: projectName,
+            testDir: project.testDir,
+            outputDir: project.outputDir,
+            timeout: project.timeout,
+            retries: project.retries,
+            repeatEach: project.repeatEach,
+            metadata: project.metadata ?? {},
+            testMatch: Array.isArray(project.testMatch) ? project.testMatch.map(String) : [String(project.testMatch)],
+            testIgnore: Array.isArray(project.testIgnore) ? project.testIgnore.map(String) : [String(project.testIgnore)]
+          });
+        } else {
+          this.reconstructedProjects.set(projectName, {
+            id: projectName,
+            name: projectName,
+            testDir: "",
+            outputDir: "",
+            timeout: 0,
+            retries: 0,
+            repeatEach: 1,
+            metadata: {},
+            testMatch: [],
+            testIgnore: []
+          });
+        }
+      }
+    }
+  }
   serializeConfig() {
     const c = this.config;
+    const projects = c.projects.length > 0 ? c.projects.map((p) => this.serializeProject(p)) : Array.from(this.reconstructedProjects.values());
     return {
       rootDir: c.rootDir,
       configFile: c.configFile ?? void 0,
@@ -2034,7 +2124,7 @@ var BaseReporter = class {
       globalTimeout: c.globalTimeout,
       maxFailures: c.maxFailures,
       metadata: c.metadata ?? {},
-      projects: c.projects.map((p) => this.serializeProject(p)),
+      projects,
       shard: c.shard ?? null,
       tags: c.tags ?? [],
       updateSourceMethod: c.updateSourceMethod,
@@ -2162,9 +2252,10 @@ var BaseReporter = class {
   }
   serializeTest(data) {
     const { testCase, results } = data;
+    const projectName = this.getProjectName(testCase);
     return {
-      projectId: testCase.parent.project()?.name ?? "default",
-      projectName: testCase.parent.project()?.name ?? "default",
+      projectId: projectName,
+      projectName,
       timeout: testCase.timeout,
       expectedStatus: testCase.expectedStatus,
       annotations: this.serializeAnnotations(testCase.annotations),
@@ -2172,6 +2263,25 @@ var BaseReporter = class {
       status: this.mapOutcome(testCase.outcome())
     };
   }
+  /**
+   * Get the project name for a test case, handling merge-reports scenarios
+   * where project() may not be available in the expected way.
+   */
+  getProjectName(testCase) {
+    const project = testCase.parent.project();
+    if (project && typeof project.name === "string") {
+      return project.name;
+    }
+    let current = testCase.parent;
+    while (current) {
+      const suiteProject = current.project();
+      if (suiteProject && typeof suiteProject.name === "string") {
+        return suiteProject.name;
+      }
+      current = current.parent;
+    }
+    return "default";
+  }
   serializeTestResult(r) {
     return {
       workerIndex: r.workerIndex,
@@ -2255,9 +2365,9 @@ var BaseReporter = class {
   printSummary() {
     const pkgVersion = getPackageVersion();
     const playwrightVersion = this.config.version;
-    const projects = this.config.projects;
-    const projectNames = projects.map((p) => p.name).join(", ");
-    const rule = pluralRules.select(projects.length);
+    const projectNames = this.config.projects.length > 0 ? this.config.projects.map((p) => p.name).join(", ") : Array.from(this.reconstructedProjects.keys()).join(", ") || "default";
+    const projectCount = this.config.projects.length > 0 ? this.config.projects.length : this.reconstructedProjects.size || 1;
+    const rule = pluralRules.select(projectCount);
     console.log("\n======================================================\n");
     console.log(`\u{1F99D} Checkly reporter: ${pkgVersion}`);
     console.log(`\u{1F3AD} Playwright: ${playwrightVersion}`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@checkly/playwright-reporter",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Standalone Playwright reporter for Checkly - compatible with Playwright 1.40-1.57+",
   "type": "module",
   "main": "dist/index.js",
@@ -8,6 +8,7 @@
   "files": [
     "dist",
     "README.md",
+    "CHANGELOG.md",
     "LICENSE"
   ],
   "keywords": [
@@ -35,7 +36,7 @@
     "tsup": "8.5.1",
     "tsx": "4.19.0",
     "typescript": "5.9.3",
-    "@checkly/reporter-utils": "1.0.0"
+    "@checkly/reporter-utils": "1.0.2"
   },
   "scripts": {
     "build": "tsup",