@stanterprise/playwright-reporter 0.0.11 → 0.0.12

package/README.md

@@ -59,11 +59,24 @@ You can also configure the reporter using environment variables:
 
 - `STANTERPRISE_GRPC_ADDRESS`: gRPC server address (default: `localhost:50051`)
 - `STANTERPRISE_GRPC_ENABLED`: Enable/disable gRPC reporting (default: `true`)
+- `STANTERPRISE_META_*`: Custom metadata fields for test runs (prefix will be stripped)
+
+#### Custom Metadata
+
+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
 
 Example:
 
 ```bash
-STANTERPRISE_GRPC_ADDRESS=myserver.com:50051 npx playwright test
+STANTERPRISE_GRPC_ADDRESS=myserver.com:50051 \
+STANTERPRISE_META_BUILD_ID=12345 \
+STANTERPRISE_META_BRANCH=main \
+npx playwright test
 ```
 
 ## Configuration Options

package/dist/handlers/onBeginHandler.js

@@ -8,11 +8,18 @@ const utils_1 = require("../utils");
 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
+    const metadataMap = new Map(Object.entries(config.metadata || {}));
+    const variables = (0, utils_1.getEnvVariables)();
+    // Merge environment variables into metadata
+    variables.forEach((value, key) => {
+        metadataMap.set(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,
     });
     (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/utils/envRetriever.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Retrieves environment variables with the STANTERPRISE_META_ prefix
+ * and returns them as a Map with the prefix stripped from keys.
+ *
+ * For example, STANTERPRISE_META_BUILD_ID=123 becomes BUILD_ID=123 in the metadata.
+ *
+ * @returns Map of metadata key-value pairs with prefix removed
+ */
+export declare function getEnvVariables(): Map<string, string>;

package/dist/utils/envRetriever.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getEnvVariables = getEnvVariables;
+/**
+ * Retrieves environment variables with the STANTERPRISE_META_ prefix
+ * and returns them as a Map with the prefix stripped from keys.
+ *
+ * For example, STANTERPRISE_META_BUILD_ID=123 becomes BUILD_ID=123 in the metadata.
+ *
+ * @returns Map of metadata key-value pairs with prefix removed
+ */
+function getEnvVariables() {
+    const envValues = process.env;
+    const prefix = "STANTERPRISE_META_";
+    const filteredEntries = Object.entries(envValues)
+        .filter(([key]) => key.startsWith(prefix))
+        .map(([key, value]) => {
+        // Strip the STANTERPRISE_META_ prefix so metadata keys are cleaner
+        const strippedKey = key.substring(prefix.length);
+        return [strippedKey, value || ""];
+    });
+    return new Map(filteredEntries);
+}

package/dist/utils/index.d.ts

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

package/dist/utils/index.js

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

package/package.json

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