@stanterprise/playwright-reporter 0.0.13 → 0.0.14

package/README.md

@@ -45,6 +45,8 @@ export default defineConfig({
         grpcAddress: "localhost:50051", // gRPC server address
         grpcEnabled: true, // Enable/disable gRPC reporting
         grpcTimeout: 1000, // Timeout for gRPC calls in milliseconds
+        grpcMaxMessageSize: 104857600, // Max message size (100MB default)
+        maxAttachmentSize: 10485760, // Max attachment size (10MB default)
         verbose: false, // Enable verbose logging
       },
     ],
@@ -66,6 +68,7 @@ You can also configure the reporter using environment variables:
 Any environment variable with the `STANTERPRISE_META_` prefix will be automatically included in the test run metadata. The prefix is stripped from the key name.
 
 For example:
+
 - `STANTERPRISE_META_BUILD_ID=12345` becomes `BUILD_ID: 12345` in metadata
 - `STANTERPRISE_META_BRANCH=main` becomes `BRANCH: main` in metadata
 - `STANTERPRISE_META_COMMIT_SHA=abc123` becomes `COMMIT_SHA: abc123` in metadata
@@ -81,12 +84,14 @@ npx playwright test
 
 ## Configuration Options
 
-| Option         | Type    | Default          | Description                               |
-| -------------- | ------- | ---------------- | ----------------------------------------- |
-| `grpcAddress`  | string  | `localhost:50051`| gRPC server address                       |
-| `grpcEnabled`  | boolean | `true`           | Enable/disable gRPC reporting             |
-| `grpcTimeout`  | number  | `1000`           | Timeout for gRPC calls in milliseconds    |
-| `verbose`      | boolean | `false`          | Enable verbose logging                    |
+| Option               | Type    | Default           | Description                                         |
+| -------------------- | ------- | ----------------- | --------------------------------------------------- |
+| `grpcAddress`        | string  | `localhost:50051` | gRPC server address                                 |
+| `grpcEnabled`        | boolean | `true`            | Enable/disable gRPC reporting                       |
+| `grpcTimeout`        | number  | `1000`            | Timeout for gRPC calls in milliseconds              |
+| `grpcMaxMessageSize` | number  | `104857600`       | Max message size in bytes (100MB default)           |
+| `maxAttachmentSize`  | number  | `10485760`        | Max attachment content size in bytes (10MB default) |
+| `verbose`            | boolean | `false`           | Enable verbose logging                              |
 
 ## What Gets Reported
 
@@ -104,6 +109,7 @@ npx playwright test
 ### Attachments
 
 The reporter automatically processes and sends:
+
 - Screenshots
 - Videos
 - Trace files
@@ -146,6 +152,8 @@ const reporter = new StanterpriseReporter({
   grpcAddress: "localhost:50051",
   grpcEnabled: true,
   grpcTimeout: 1000,
+  grpcMaxMessageSize: 104857600, // 100MB
+  maxAttachmentSize: 10485760, // 10MB
   verbose: false,
 });
 ```
@@ -200,6 +208,59 @@ The reporter is organized into several modules:
 
 ## Troubleshooting
 
+### gRPC Error 13 INTERNAL: failed to publish event
+
+This error typically occurs due to one of two issues:
+
+**1. Metadata Serialization (Most Common)**
+
+If you see this error with the stack trace mentioning "metadata is not iterable" or serialization issues, it was a bug in v0.0.13 and earlier versions. **Solution: Upgrade to v0.0.14 or later.**
+
+**2. Large Attachments**
+
+This error can also occur when test event payloads exceed the gRPC message size limit. Common causes:
+
+1. **Large attachments**: Tests with large screenshots, videos, or trace files
+2. **Default size limits**: gRPC has a default 4MB message size limit
+
+**Solutions:**
+
+1. **Increase message size limits** (recommended):
+
+   ```typescript
+   reporter: [
+     [
+       "stanterprise-playwright-reporter",
+       {
+         grpcMaxMessageSize: 104857600, // 100MB (default)
+         maxAttachmentSize: 10485760,   // 10MB (default)
+       },
+     ],
+   ],
+   ```
+
+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
+
+   ```typescript
+   use: {
+     screenshot: "only-on-failure",
+     video: "retain-on-failure",
+     trace: "retain-on-failure",
+   },
+   ```
+
+3. **Monitor payload sizes**: Enable verbose logging to see actual payload sizes:
+   ```typescript
+   reporter: [
+     ["stanterprise-playwright-reporter", { verbose: true }],
+   ],
+   ```
+
+The reporter will log warnings when attachments exceed the size limit and automatically skip their content while preserving metadata.
+
 ### Connection Issues
 
 If you see gRPC connection errors:
@@ -229,6 +290,7 @@ Contributions are welcome! Please feel free to submit a Pull Request.
 The repository uses GitHub Actions to automatically publish to NPM when a version tag is pushed:
 
 1. Update the version following [semantic versioning](https://semver.org/):
+
    ```bash
    npm version patch  # for bug fixes (1.0.0 → 1.0.1)
    npm version minor  # for new features (1.0.0 → 1.1.0)
@@ -236,6 +298,7 @@ The repository uses GitHub Actions to automatically publish to NPM when a versio
    ```
 
 2. Push the version tag to GitHub:
+
    ```bash
    git push --follow-tags
    ```
@@ -252,16 +315,19 @@ The repository uses GitHub Actions to automatically publish to NPM when a versio
 Alternatively, you can publish manually:
 
 1. Ensure all tests pass:
+
    ```bash
    npm test
    ```
 
 2. Update the version:
+
    ```bash
    npm version patch|minor|major
    ```
 
 3. Publish to NPM (prepublishOnly script will build automatically):
+
    ```bash
    npm publish
    ```
@@ -274,10 +340,12 @@ Alternatively, you can publish manually:
 ### What Gets Published
 
 The package includes:
+
 - `dist/` - Compiled JavaScript and TypeScript declarations
 - `README.md` - Documentation
 
 The following are excluded via `.npmignore`:
+
 - Source files (`src/`, `tests/`, `examples/`)
 - Development configuration files
 - Build artifacts and logs
@@ -289,4 +357,3 @@ ISC - See [LICENSE](LICENSE) file for details
 ## Support
 
 For issues and questions, please visit the [GitHub repository](https://github.com/stanterprise/stanterprise-playwright-reporter).
-

package/dist/client/grpcClient.js

@@ -38,7 +38,11 @@ exports.reportUnary = reportUnary;
 const grpc = __importStar(require("@grpc/grpc-js"));
 function getClient(options) {
     try {
-        return new grpc.Client(options.grpcAddress, grpc.credentials.createInsecure());
+        const maxMessageSize = options.grpcMaxMessageSize || 104857600; // 100MB default
+        return new grpc.Client(options.grpcAddress, grpc.credentials.createInsecure(), {
+            "grpc.max_send_message_length": maxMessageSize,
+            "grpc.max_receive_message_length": maxMessageSize,
+        });
     }
     catch (e) {
         console.error("Failed to create gRPC client", e);

package/dist/handlers/onBeginHandler.js

@@ -9,21 +9,22 @@ const common_1 = require("@stanterprise/protobuf/testsystem/v1/common");
 function handleOnBeginEvent(config, suite, name, runId, client, options) {
     // Report root suite and all child suites recursively
     // Convert all metadata values to strings for protobuf compatibility
-    const metadataMap = new Map(Object.entries(config.metadata || {}).map(([key, value]) => [
-        key,
-        String(value),
-    ]));
+    // Use plain object instead of Map - protobuf expects object literals
+    const metadata = {};
+    Object.entries(config.metadata || {}).forEach(([key, value]) => {
+        metadata[key] = String(value);
+    });
     const variables = (0, utils_1.getEnvVariables)();
     // Merge environment variables into metadata
     variables.forEach((value, key) => {
-        metadataMap.set(key, value);
+        metadata[key] = value;
     });
     const request = new events_1.ReportRunStartEventRequest({
         run_id: runId,
         name: name,
         test_suites: mapSuites(suite, runId),
         total_tests: suite.allTests().length,
-        metadata: metadataMap,
+        metadata: (0, utils_1.toMetadataMap)(metadata),
     });
     (0, grpcClient_1.reportUnary)(options, client, "/testsystem.v1.observer.TestEventCollector/ReportRunStart", request, options.grpcTimeout).catch((e) => {
         const details = e instanceof Error ? `${e.message}` : String(e);

package/dist/handlers/onStepBeginHandler.js

@@ -9,14 +9,7 @@ const utils_2 = require("../utils");
 const common_1 = require("@stanterprise/protobuf/testsystem/v1/common");
 function handleOnStepBeginEvent(test, result, step, runId, client, options) {
     // Build metadata from step annotations
-    const metadata = new Map();
-    metadata.set("category", step.category);
-    step.annotations.forEach((annotation, index) => {
-        metadata.set(`annotation_${index}_type`, annotation.type);
-        if (annotation.description) {
-            metadata.set(`annotation_${index}_description`, annotation.description);
-        }
-    });
+    const metadata = (0, utils_1.buildStepMetadata)(step);
     // Get parent step ID if this step has a parent
     const stepId = (0, utils_2.generateStepId)(step, test);
     // Build and send the StepBegin event
@@ -32,7 +25,7 @@ function handleOnStepBeginEvent(test, result, step, runId, client, options) {
             location: step.location
                 ? `${step.location.file}:${step.location.line}:${step.location.column}`
                 : undefined,
-            metadata: metadata,
+            metadata: (0, utils_1.toMetadataMap)(metadata),
             parent_step_id: step.parent
                 ? (0, utils_2.generateStepId)(step.parent, test)
                 : undefined,

package/dist/handlers/onStepEndHandler.js

@@ -10,14 +10,7 @@ function handleOnStepEndEvent(test, result, step, runId, client, options) {
     // Map step error to status
     const stepStatus = (0, utils_1.mapStepStatus)(!!step.error);
     // Build metadata from step annotations
-    const metadata = new Map();
-    metadata.set("category", step.category);
-    step.annotations.forEach((annotation, index) => {
-        metadata.set(`annotation_${index}_type`, annotation.type);
-        if (annotation.description) {
-            metadata.set(`annotation_${index}_description`, annotation.description);
-        }
-    });
+    const metadata = (0, utils_1.buildStepMetadata)(step);
     const stepId = (0, utils_2.generateStepId)(step, test);
     // Build and send the StepEnd event
     const request = new events_1.StepEndEventRequest({
@@ -35,7 +28,7 @@ function handleOnStepEndEvent(test, result, step, runId, client, options) {
             location: step.location
                 ? `${step.location.file}:${step.location.line}:${step.location.column}`
                 : "",
-            metadata: metadata,
+            metadata: (0, utils_1.toMetadataMap)(metadata),
             parent_step_id: step.parent
                 ? (0, utils_2.generateStepId)(step.parent, test)
                 : undefined,

package/dist/handlers/onTestEndHandler.js

@@ -6,29 +6,21 @@ const events_1 = require("@stanterprise/protobuf/testsystem/v1/events");
 const utils_1 = require("../utils");
 const grpcClient_1 = require("../client/grpcClient");
 const utils_2 = require("../utils");
+/**
+ * Constant for converting bytes to megabytes
+ */
+const BYTES_PER_MB = 1048576;
 function handleOnTestEndEvent(test, result, runId, client, options) {
     // Map Playwright test status to protobuf TestStatus
     const testStatus = (0, utils_1.mapTestStatus)(result.status);
     // Process attachments (screenshots, videos, etc.)
-    const attachments = (0, utils_1.processAttachments)(result);
+    const attachments = (0, utils_1.processAttachments)(result, options.maxAttachmentSize || 10485760);
     // Extract error information if the test failed
     const { errorMessage, stackTrace, errors } = (0, utils_1.extractErrorInfo)(result);
     // Get test suite run ID from parent suite if available, ensuring suite is reported
     const suiteId = (0, utils_2.generateSuiteId)(test.parent);
     // Build metadata from test annotations and result metadata
-    const metadata = new Map();
-    test.annotations.forEach((annotation, index) => {
-        metadata.set(`annotation_${index}_type`, annotation.type);
-        if (annotation.description) {
-            metadata.set(`annotation_${index}_description`, annotation.description);
-        }
-    });
-    result.annotations.forEach((annotation, index) => {
-        metadata.set(`result_annotation_${index}_type`, annotation.type);
-        if (annotation.description) {
-            metadata.set(`result_annotation_${index}_description`, annotation.description);
-        }
-    });
+    const metadata = (0, utils_1.buildTestMetadata)(test, result);
     // Build and send the TestEnd event
     const request = new events_1.TestEndEventRequest({
         test_case: new entities_1.TestCaseRun({
@@ -43,10 +35,15 @@ function handleOnTestEndEvent(test, result, runId, client, options) {
             error_message: errorMessage,
             stack_trace: stackTrace,
             errors: errors,
-            metadata: metadata,
+            metadata: (0, utils_1.toMetadataMap)(metadata),
             tags: test.tags,
         }),
     });
+    // Serialize once to capture payload size for potential error logging
+    const serializedPayload = request.serializeBinary();
+    const payloadSize = serializedPayload.length;
     // Fire-and-forget to avoid slowing tests
-    (0, grpcClient_1.reportUnary)(options, client, "/testsystem.v1.observer.TestEventCollector/ReportTestEnd", request, options.grpcTimeout).catch((e) => console.error("Failed to report test end", e));
+    (0, grpcClient_1.reportUnary)(options, client, "/testsystem.v1.observer.TestEventCollector/ReportTestEnd", request, options.grpcTimeout).catch((e) => {
+        console.error(`Failed to report test end for "${test.title}" (payload size: ${(payloadSize / BYTES_PER_MB).toFixed(2)}MB)`, e);
+    });
 }

package/dist/types.d.ts

@@ -20,6 +20,17 @@ export interface StanterpriseReporterOptions {
      * @default 1000
      */
     grpcTimeout?: number;
+    /**
+     * Maximum message size for gRPC calls in bytes
+     * @default 104857600 (100MB)
+     */
+    grpcMaxMessageSize?: number;
+    /**
+     * Maximum size for attachment content in bytes
+     * Attachments larger than this will only include the path reference
+     * @default 10485760 (10MB)
+     */
+    maxAttachmentSize?: number;
     /**
      * Whether to include verbose logging
      * @default false

package/dist/utils/attachmentProcessor.d.ts

@@ -6,8 +6,10 @@ import { common } from "@stanterprise/protobuf";
 declare const Attachment: typeof common.v1.common.Attachment;
 /**
  * Process Playwright test attachments into protobuf Attachment objects
+ * @param result Test result containing attachments
+ * @param maxAttachmentSize Maximum size for attachment content (default 10MB)
  */
-export declare function processAttachments(result: TestResult): InstanceType<typeof Attachment>[];
+export declare function processAttachments(result: TestResult, maxAttachmentSize?: number): InstanceType<typeof Attachment>[];
 /**
  * Extract error information from test results
  */

package/dist/utils/attachmentProcessor.js

@@ -4,10 +4,17 @@ exports.processAttachments = processAttachments;
 exports.extractErrorInfo = extractErrorInfo;
 const protobuf_1 = require("@stanterprise/protobuf");
 const Attachment = protobuf_1.common.v1.common.Attachment;
+/**
+ * Constant for converting bytes to megabytes
+ */
+const BYTES_PER_MB = 1048576;
 /**
  * Process Playwright test attachments into protobuf Attachment objects
+ * @param result Test result containing attachments
+ * @param maxAttachmentSize Maximum size for attachment content (default 10MB)
  */
-function processAttachments(result) {
+function processAttachments(result, maxAttachmentSize = 10485760 // 10MB default
+) {
     const attachments = [];
     if (!result.attachments || result.attachments.length === 0) {
         return attachments;
@@ -17,12 +24,22 @@ function processAttachments(result) {
             name: attachment.name,
             mime_type: attachment.contentType,
         });
-        // Use path as URI if available, otherwise use the body content
+        // Always prefer path if available to avoid large payloads
         if (attachment.path) {
             att.uri = attachment.path;
         }
         else if (attachment.body) {
-            att.content = attachment.body;
+            // Only include body content if it's within size limit
+            const bodySize = attachment.body.length;
+            if (bodySize <= maxAttachmentSize) {
+                att.content = attachment.body;
+            }
+            else {
+                // Skip large attachments without path - log warning
+                console.warn(`Attachment "${attachment.name}" (${(bodySize / BYTES_PER_MB).toFixed(2)}MB) exceeds max size ` +
+                    `(${(maxAttachmentSize / BYTES_PER_MB).toFixed(2)}MB) and has no path. Skipping content.`);
+                // Still add the attachment metadata without content
+            }
         }
         attachments.push(att);
     }

package/dist/utils/index.d.ts

@@ -6,3 +6,4 @@ export * from "./attachmentProcessor";
 export * from "./timeHelpers";
 export * from "./idGenerators";
 export * from "./envRetriever";
+export * from "./metadataHelpers";

package/dist/utils/index.js

@@ -22,3 +22,4 @@ __exportStar(require("./attachmentProcessor"), exports);
 __exportStar(require("./timeHelpers"), exports);
 __exportStar(require("./idGenerators"), exports);
 __exportStar(require("./envRetriever"), exports);
+__exportStar(require("./metadataHelpers"), exports);

package/dist/utils/metadataHelpers.d.ts

@@ -0,0 +1,35 @@
+/**
+ * Utility functions for building metadata objects
+ */
+import type { TestCase, TestResult, TestStep } from "@playwright/test/reporter";
+/**
+ * Build metadata from annotations array
+ * @param annotations Array of annotations with type and optional description
+ * @param prefix Prefix for metadata keys (e.g., "annotation", "result_annotation")
+ * @returns Record of metadata key-value pairs
+ */
+export declare function buildAnnotationsMetadata(annotations: Array<{
+    type: string;
+    description?: string;
+}>, prefix?: string): Record<string, string>;
+/**
+ * Build metadata from test case and result annotations
+ * Combines annotations from both the test case and the result
+ * @param test Test case containing annotations
+ * @param result Test result containing additional annotations
+ * @returns Record of metadata key-value pairs
+ */
+export declare function buildTestMetadata(test: TestCase, result: TestResult): Record<string, string>;
+/**
+ * Build metadata from step annotations and category
+ * @param step Test step containing annotations and category
+ * @returns Record of metadata key-value pairs
+ */
+export declare function buildStepMetadata(step: TestStep): Record<string, string>;
+/**
+ * Convert metadata object to Map for protobuf serialization
+ * Protobuf requires Map<string, string> for metadata fields
+ * @param metadata Record of metadata key-value pairs
+ * @returns Map ready for protobuf constructors
+ */
+export declare function toMetadataMap(metadata: Record<string, string>): Map<string, string>;

package/dist/utils/metadataHelpers.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildAnnotationsMetadata = buildAnnotationsMetadata;
+exports.buildTestMetadata = buildTestMetadata;
+exports.buildStepMetadata = buildStepMetadata;
+exports.toMetadataMap = toMetadataMap;
+/**
+ * Build metadata from annotations array
+ * @param annotations Array of annotations with type and optional description
+ * @param prefix Prefix for metadata keys (e.g., "annotation", "result_annotation")
+ * @returns Record of metadata key-value pairs
+ */
+function buildAnnotationsMetadata(annotations, prefix = "annotation") {
+    const metadata = {};
+    annotations.forEach((annotation, index) => {
+        metadata[`${prefix}_${index}_type`] = annotation.type;
+        if (annotation.description) {
+            metadata[`${prefix}_${index}_description`] = annotation.description;
+        }
+    });
+    return metadata;
+}
+/**
+ * Build metadata from test case and result annotations
+ * Combines annotations from both the test case and the result
+ * @param test Test case containing annotations
+ * @param result Test result containing additional annotations
+ * @returns Record of metadata key-value pairs
+ */
+function buildTestMetadata(test, result) {
+    return {
+        ...buildAnnotationsMetadata(test.annotations, "annotation"),
+        ...buildAnnotationsMetadata(result.annotations, "result_annotation"),
+    };
+}
+/**
+ * Build metadata from step annotations and category
+ * @param step Test step containing annotations and category
+ * @returns Record of metadata key-value pairs
+ */
+function buildStepMetadata(step) {
+    return {
+        category: step.category,
+        ...buildAnnotationsMetadata(step.annotations, "annotation"),
+    };
+}
+/**
+ * Convert metadata object to Map for protobuf serialization
+ * Protobuf requires Map<string, string> for metadata fields
+ * @param metadata Record of metadata key-value pairs
+ * @returns Map ready for protobuf constructors
+ */
+function toMetadataMap(metadata) {
+    return new Map(Object.entries(metadata));
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stanterprise/playwright-reporter",
-  "version": "0.0.13",
+  "version": "0.0.14",
   "description": "Custom Playwright test reporter that sends test results to Stanterprise via gRPC",
   "homepage": "https://github.com/stanterprise/stanterprise-playwright-reporter#readme",
   "bugs": {