@stanterprise/playwright-reporter 0.0.21 → 0.1.1

package/README.md

@@ -49,7 +49,7 @@ export default defineConfig({
         grpcMaxMessageSize: 104857600, // Max message size (100MB default)
         maxAttachmentSize: 10485760, // Max attachment size (10MB default)
         verbose: false, // Enable verbose logging
-        debug: false,          // Enable debug mode (writes gRPC messages to JSONL file)
+        debug: false, // Enable debug mode (writes gRPC messages to JSONL file)
         debugFile: "stanterprise-debug.jsonl", // Path for debug JSONL output
       },
     ],
@@ -63,6 +63,7 @@ export default defineConfig({
 You can also configure the reporter using environment variables:
 
 - `STANTERPRISE_GRPC_ADDRESS`: gRPC server address (default: `localhost:50051`)
+- `STANTERPRISE_GRPC_HOST`: gRPC server host
 - `STANTERPRISE_GRPC_ENABLED`: Enable/disable gRPC reporting (default: `true`)
 - `STANTERPRISE_META_*`: Custom metadata fields for test runs (prefix will be stripped)
 - `STANTERPRISE_DEBUG`: Enable debug mode — captures outgoing gRPC messages to a JSONL file (default: `false`; case-insensitive: `"true"`, `"TRUE"`, `"True"` all work)
@@ -89,18 +90,20 @@ 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              |
-| `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                              |
-| `grpcMaxRetries`     | number  | `3`               | Maximum number of retry attempts for failed gRPC calls  |
-| `grpcRetryDelay`     | number  | `100`             | Initial delay for retries in ms (uses exponential backoff) |
-| `debug`              | boolean | `false`           | Enable debug mode — writes all outgoing gRPC messages to a JSONL file. **Warning:** output may include sensitive request payloads and grow very large. Use only in controlled environments. |
-| `debugFile`          | string  | `stanterprise-debug.jsonl` | File path for debug JSONL output. Parent directories are created automatically if they do not exist. |
+| Option               | Type    | Default                    | Description                                                                                                                                                                                 |
+| -------------------- | ------- | -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `grpcAddress`        | string  | `localhost:50051`          | Full gRPC server address. Takes precedence over `grpcHost` and `grpcPort`.                                                                                                                  |
+| `grpcHost`           | string  |                            | gRPC server host. Used when `grpcAddress` is not provided. Combined with `grpcPort` to form the address.                                                                                    |
+| `grpcPort`           | number  | `50051`                    | gRPC server port. Used when `grpcAddress` is not provided. Combined with `grpcHost` to form the 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                                                                                                                                                                      |
+| `grpcMaxRetries`     | number  | `3`                        | Maximum number of retry attempts for failed gRPC calls                                                                                                                                      |
+| `grpcRetryDelay`     | number  | `100`                      | Initial delay for retries in ms (uses exponential backoff)                                                                                                                                  |
+| `debug`              | boolean | `false`                    | Enable debug mode — writes all outgoing gRPC messages to a JSONL file. **Warning:** output may include sensitive request payloads and grow very large. Use only in controlled environments. |
+| `debugFile`          | string  | `stanterprise-debug.jsonl` | File path for debug JSONL output. Parent directories are created automatically if they do not exist.                                                                                        |
 
 ### Retry Configuration
 
@@ -112,10 +115,11 @@ The reporter automatically retries failed gRPC calls for transient errors using
 **Exponential backoff formula**: `grpcRetryDelay * (2 ^ attemptNumber)`
 
 Example with default settings (`grpcRetryDelay: 100`, `grpcMaxRetries: 3`):
+
 - Initial attempt: Immediate
-- Retry 1: Wait 100ms (100 * 2^0)
-- Retry 2: Wait 200ms (100 * 2^1)
-- Retry 3: Wait 400ms (100 * 2^2)
+- Retry 1: Wait 100ms (100 \* 2^0)
+- Retry 2: Wait 200ms (100 \* 2^1)
+- Retry 3: Wait 400ms (100 \* 2^2)
 
 ```typescript
 export default defineConfig({
@@ -123,9 +127,9 @@ export default defineConfig({
     [
       "stanterprise-playwright-reporter",
       {
-        grpcMaxRetries: 5,        // Try up to 5 times
-        grpcRetryDelay: 200,      // Start with 200ms delay
-        verbose: true,            // Log retry attempts
+        grpcMaxRetries: 5, // Try up to 5 times
+        grpcRetryDelay: 200, // Start with 200ms delay
+        verbose: true, // Log retry attempts
       },
     ],
   ],
@@ -136,7 +140,7 @@ To disable retries:
 
 ```typescript
 {
-  grpcMaxRetries: 0  // No retries, fail fast
+  grpcMaxRetries: 0; // No retries, fail fast
 }
 ```
 

package/dist/handlers/onEndHandler.d.ts

@@ -2,4 +2,4 @@ import { FullResult } from "@playwright/test/reporter";
 import { StanterpriseReporterOptions } from "../types";
 import * as grpc from "@grpc/grpc-js";
 import { MessageQueue } from "../client/messageQueue";
-export declare function handleOnEndEvent(result: FullResult, runId: string, client: grpc.Client, options: StanterpriseReporterOptions, queue?: MessageQueue): void;
+export declare function handleOnEndEvent(result: FullResult, runId: string, client: grpc.Client, options: StanterpriseReporterOptions, queue?: MessageQueue, metadata?: Record<string, string>): void;

package/dist/handlers/onEndHandler.js

@@ -19,7 +19,7 @@ function mapTestStatus(status) {
             return common_1.TestStatus.UNKNOWN;
     }
 }
-function handleOnEndEvent(result, runId, client, options, queue) {
+function handleOnEndEvent(result, runId, client, options, queue, metadata) {
     // Validate and sanitize inputs to prevent serialization failures
     const startTimeMs = result.startTime?.getTime();
     const duration = result.duration;
@@ -35,6 +35,7 @@ function handleOnEndEvent(result, runId, client, options, queue) {
         final_status: mapTestStatus(result.status),
         start_time: (0, utils_1.createTimestampFromMs)(validStartTimeMs),
         duration: (0, utils_1.createDuration)(validDuration),
+        metadata: (0, utils_1.toMetadataMap)(metadata || {}),
     });
     (0, grpcClient_1.reportUnary)(options, client, "/testsystem.v1.observer.TestEventCollector/ReportRunEnd", request, options.grpcTimeout, queue).catch((error) => {
         if (error instanceof Error) {

package/dist/reporter.d.ts

@@ -6,6 +6,7 @@ export default class StanterpriseReporter implements Reporter {
     private runId;
     private runStartTime;
     private messageQueue;
+    private metadata;
     constructor(options?: StanterpriseReporterOptions);
     onBegin(config: FullConfig, suite: Suite): void;
     onExit(): Promise<void>;

package/dist/reporter.js

@@ -19,6 +19,7 @@ class StanterpriseReporter {
         this.runStartTime = new Date();
         // Sequential message queue – guarantees ordered delivery to the server
         this.messageQueue = new messageQueue_1.MessageQueue();
+        this.metadata = {};
         this.options = (0, optionsMapper_1.default)(options);
         if (this.options.verbose) {
             console.log("Stanterprise Reporter: Initialized with options:", {
@@ -34,6 +35,10 @@ class StanterpriseReporter {
         (0, debugLogger_1.initDebugFile)(this.options);
     }
     onBegin(config, suite) {
+        if (config.shard) {
+            this.metadata["shard.current"] = String(config.shard.current);
+            this.metadata["shard.total"] = String(config.shard.total);
+        }
         // Lazily create the client if enabled.
         if (this.options.grpcEnabled) {
             this.grpcClient = (0, grpcClient_1.default)(this.options);
@@ -81,7 +86,7 @@ class StanterpriseReporter {
             console.log(`Playwright start time: ${result.startTime.toISOString()}`);
         }
         if (this.options.grpcEnabled) {
-            (0, handlers_1.handleOnEndEvent)(result, this.runId, this.grpcClient, this.options, this.messageQueue);
+            (0, handlers_1.handleOnEndEvent)(result, this.runId, this.grpcClient, this.options, this.messageQueue, this.metadata);
         }
         return Promise.resolve();
     }

package/dist/types.d.ts

@@ -10,6 +10,19 @@ export interface StanterpriseReporterOptions {
      * @default "localhost:50051" or process.env.STANTERPRISE_GRPC_ADDRESS
      */
     grpcAddress?: string;
+    /**
+     * Optional separate host for gRPC when `grpcAddress` is not provided.
+     * This allows specifying gRPC connection details separately from other potential uses of `grpcAddress`.
+     * If `grpcAddress` is provided, it takes precedence over this field.
+     */
+    grpcHost?: string;
+    /**
+     * Optional separate port for gRPC when `grpcAddress` is not provided.
+     * This allows specifying gRPC connection details separately from other potential uses of `grpcAddress`.
+     * If `grpcAddress` is provided, it takes precedence over this field.
+     * @default 50051
+     */
+    grpcPort?: number;
     /**
      * Whether gRPC reporting is enabled
      * @default true or process.env.STANTERPRISE_GRPC_ENABLED !== "false"

package/dist/utils/optionsMapper.js

@@ -8,19 +8,16 @@ exports.default = defineOptions;
  */
 function defineOptions(providedOptions) {
     const result = {};
-    result.grpcAddress =
-        providedOptions.grpcAddress ||
-            process.env.STANTERPRISE_GRPC_ADDRESS ||
-            "localhost:50051";
+    result.grpcAddress = identifyAddress(providedOptions);
     result.grpcEnabled =
         providedOptions.grpcEnabled ??
             (process.env.STANTERPRISE_GRPC_ENABLED || "true").toLowerCase() !== "false";
-    result.grpcTimeout = providedOptions.grpcTimeout || 1000;
-    result.grpcMaxMessageSize = providedOptions.grpcMaxMessageSize || 104857600;
-    result.maxAttachmentSize = providedOptions.maxAttachmentSize || 10485760;
-    result.verbose = providedOptions.verbose || false;
+    result.grpcTimeout = providedOptions.grpcTimeout ?? 1000;
+    result.grpcMaxMessageSize = providedOptions.grpcMaxMessageSize ?? 104857600;
+    result.maxAttachmentSize = providedOptions.maxAttachmentSize ?? 10485760;
+    result.verbose = providedOptions.verbose ?? false;
     result.grpcMaxRetries = providedOptions.grpcMaxRetries ?? 3;
-    result.grpcRetryDelay = providedOptions.grpcRetryDelay || 100;
+    result.grpcRetryDelay = providedOptions.grpcRetryDelay ?? 100;
     result.debug =
         providedOptions.debug ??
             (process.env.STANTERPRISE_DEBUG || "").toLowerCase() === "true";
@@ -30,3 +27,22 @@ function defineOptions(providedOptions) {
             "stanterprise-debug.jsonl";
     return result;
 }
+function identifyAddress(providedOptions) {
+    if (providedOptions.grpcAddress) {
+        return providedOptions.grpcAddress;
+    }
+    if (process.env.STANTERPRISE_GRPC_ADDRESS) {
+        return process.env.STANTERPRISE_GRPC_ADDRESS;
+    }
+    if (process.env.STANTERPRISE_GRPC_HOST) {
+        const host = process.env.STANTERPRISE_GRPC_HOST;
+        const port = process.env.STANTERPRISE_GRPC_PORT || "50051";
+        return `${host}:${port}`;
+    }
+    if (providedOptions.grpcHost) {
+        const host = providedOptions.grpcHost;
+        const port = providedOptions.grpcPort ?? 50051;
+        return `${host}:${port}`;
+    }
+    return "localhost:50051";
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stanterprise/playwright-reporter",
-  "version": "0.0.21",
+  "version": "0.1.1",
   "description": "Custom Playwright test reporter that sends test results to Stanterprise via gRPC",
   "homepage": "https://github.com/stanterprise/stanterprise-playwright-reporter#readme",
   "bugs": {
@@ -53,6 +53,6 @@
     "@grpc/grpc-js": "^1.14.1",
     "@protobuf-ts/grpc-transport": "^2.11.1",
     "@protobuf-ts/grpcweb-transport": "^2.11.1",
-    "@stanterprise/protobuf": "^0.0.21"
+    "@stanterprise/protobuf": "^0.1.1"
   }
 }