@stanterprise/playwright-reporter 0.0.16 → 0.0.18

package/README.md

@@ -93,6 +93,80 @@ npx playwright test
 | `maxAttachmentSize`  | number  | `10485760`        | Max attachment content size in bytes (10MB default) |
 | `verbose`            | boolean | `false`           | Enable verbose logging                              |
 
+## Sharding Support
+
+The reporter automatically detects and reports when tests are running in sharded mode. When sharding is configured, the reporter includes the following metadata in test run events:
+
+- `shard.current`: The current shard number (1-based)
+- `shard.total`: The total number of shards
+
+### Configuring Sharding
+
+In your `playwright.config.ts`:
+
+```typescript
+import { defineConfig } from "@playwright/test";
+
+export default defineConfig({
+  shard: { total: 5, current: 1 },
+  reporter: [["stanterprise-playwright-reporter"]],
+});
+```
+
+Or via CLI:
+
+```bash
+npx playwright test --shard=1/5
+npx playwright test --shard=2/5
+# ... etc
+```
+
+### Aggregating Results Across Shards
+
+**Important:** To have a complete set of tests accumulated in the observability server, you must specify the same `STANTERPRISE_RUN_ID` environment variable for all shards. This ensures that results from all shards are associated with the same test run.
+
+```bash
+# Set the same run ID for all shards
+export STANTERPRISE_RUN_ID="my-test-run-123"
+
+# Run all shards with the same run ID
+npx playwright test --shard=1/5
+npx playwright test --shard=2/5
+npx playwright test --shard=3/5
+npx playwright test --shard=4/5
+npx playwright test --shard=5/5
+```
+
+In CI/CD environments, you can use a unique identifier from your CI system:
+
+```bash
+# GitHub Actions example
+STANTERPRISE_RUN_ID="${GITHUB_RUN_ID}" npx playwright test --shard=1/5
+
+# GitLab CI example
+STANTERPRISE_RUN_ID="${CI_PIPELINE_ID}" npx playwright test --shard=1/5
+
+# Jenkins example
+STANTERPRISE_RUN_ID="${BUILD_ID}" npx playwright test --shard=1/5
+```
+
+Without a shared `STANTERPRISE_RUN_ID`, each shard will generate its own unique run ID, and the results will be reported as separate test runs rather than a single aggregated run.
+
+The shard information is automatically included in the metadata sent to the server, allowing you to:
+
+- Track which tests ran on which shard
+- Aggregate results from multiple shards
+- Debug shard-specific issues
+
+When verbose logging is enabled, you'll see shard information in the console output:
+
+```
+Stanterprise Reporter: Test run started with ID: 123e4567-e89b-12d3-a456-426614174000
+Number of tests: 42
+Run started at: 2026-01-25T10:30:00.000Z
+Shard: 1 of 5
+```
+
 ## What Gets Reported
 
 ### Test Events
@@ -240,7 +314,6 @@ This error can also occur when test event payloads exceed the gRPC message size
    ```
 
 2. **Reduce attachment sizes**:
-
    - Configure Playwright to save attachments to disk instead of embedding them
    - The reporter automatically uses file paths when available instead of content
 

package/dist/handlers/onBeginHandler.js

@@ -19,6 +19,11 @@ function handleOnBeginEvent(config, suite, name, runId, client, options) {
     variables.forEach((value, key) => {
         metadata[key] = value;
     });
+    // Add shard information if present
+    if (config.shard) {
+        metadata["shard.current"] = String(config.shard.current);
+        metadata["shard.total"] = String(config.shard.total);
+    }
     const request = new events_1.ReportRunStartEventRequest({
         run_id: runId,
         name: name,

package/dist/handlers/onStepEndHandler.js

@@ -12,6 +12,24 @@ function handleOnStepEndEvent(test, result, step, runId, client, options) {
     // Build metadata from step annotations
     const metadata = (0, utils_1.buildStepMetadata)(step);
     const stepId = (0, utils_2.generateStepId)(step, test);
+    // Extract comprehensive error details if present
+    const errorMessage = step.error?.message || "";
+    const errorStack = step.error?.stack || "";
+    const errorValue = step.error?.value || "";
+    const errorSnippet = step.error?.snippet || "";
+    const errorLocation = step.error?.location
+        ? `${step.error.location.file}:${step.error.location.line}:${step.error.location.column}`
+        : "";
+    // Combine all error information into metadata for comprehensive error tracking
+    const errorMetadata = {};
+    if (errorStack)
+        errorMetadata.error_stack = (0, utils_1.truncateValue)(errorStack);
+    if (errorValue)
+        errorMetadata.error_value = (0, utils_1.truncateValue)(errorValue);
+    if (errorSnippet)
+        errorMetadata.error_snippet = (0, utils_1.truncateValue)(errorSnippet);
+    if (errorLocation)
+        errorMetadata.error_location = (0, utils_1.truncateValue)(errorLocation);
     // Build and send the StepEnd event
     const request = new events_1.StepEndEventRequest({
         step: new entities_1.StepRun({
@@ -23,12 +41,12 @@ function handleOnStepEndEvent(test, result, step, runId, client, options) {
             start_time: (0, utils_1.createTimestamp)(step.startTime),
             duration: (0, utils_1.createDuration)(step.duration),
             status: stepStatus,
-            error: step.error ? step.error.message || "" : "",
-            errors: step.error ? [step.error.message || ""] : [],
+            error: errorMessage,
+            errors: errorMessage ? [errorMessage] : [],
             location: step.location
                 ? `${step.location.file}:${step.location.line}:${step.location.column}`
                 : "",
-            metadata: (0, utils_1.toMetadataMap)(metadata),
+            metadata: (0, utils_1.toMetadataMap)({ ...metadata, ...errorMetadata }),
             parent_step_id: step.parent
                 ? (0, utils_2.generateStepId)(step.parent, test)
                 : undefined,

package/dist/reporter.js

@@ -45,6 +45,9 @@ class StanterpriseReporter {
             console.log(`Stanterprise Reporter: Test run started with ID: ${this.runId}`);
             console.log(`Number of tests: ${suite.allTests().length}`);
             console.log(`Run started at: ${this.runStartTime.toISOString()}`);
+            if (config.shard) {
+                console.log(`Shard: ${config.shard.current} of ${config.shard.total}`);
+            }
         }
         if (this.options.grpcEnabled) {
             (0, handlers_1.handleOnBeginEvent)(config, suite, process.env.STANTERPRISE_TEST_RUN_NAME || "Playwright Test Run", this.runId, this.grpcClient, this.options);

package/dist/utils/metadataHelpers.d.ts

@@ -2,6 +2,13 @@
  * Utility functions for building metadata objects
  */
 import type { TestCase, TestResult, TestStep } from "@playwright/test/reporter";
+/**
+ * Truncate a string to a maximum length with ellipsis indicator
+ * @param value String value to truncate
+ * @param maxLength Maximum length (default 100KB)
+ * @returns Truncated string with warning suffix if truncated
+ */
+export declare function truncateValue(value: string, maxLength?: number): string;
 /**
  * Build metadata from annotations array
  * @param annotations Array of annotations with type and optional description

package/dist/utils/metadataHelpers.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.truncateValue = truncateValue;
 exports.buildAnnotationsMetadata = buildAnnotationsMetadata;
 exports.buildTestMetadata = buildTestMetadata;
 exports.buildStepMetadata = buildStepMetadata;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stanterprise/playwright-reporter",
-  "version": "0.0.16",
+  "version": "0.0.18",
   "description": "Custom Playwright test reporter that sends test results to Stanterprise via gRPC",
   "homepage": "https://github.com/stanterprise/stanterprise-playwright-reporter#readme",
   "bugs": {
@@ -44,7 +44,7 @@
   "devDependencies": {
     "@playwright/test": "^1.52.0",
     "@types/jest": "^29.5.14",
-    "@types/node": "^22.15.29",
+    "@types/node": "^22.19.7",
     "jest": "^29.7.0",
     "ts-jest": "^29.4.5",
     "typescript": "^5.9.3"