@supatest/playwright-reporter 0.0.1 → 0.0.2

package/README.md

@@ -1,33 +1,65 @@
-# @supatest/playwright-reporter (logging prototype)
+# @supatest/playwright-reporter
 
-Minimal Playwright reporter that serializes run/test/result/attachment metadata and logs the payload to stdout. API upload is not wired yet.
+Playwright reporter that streams test results to Supatest in real-time. Captures comprehensive test data including steps, errors, attachments, and CI/Git context.
 
 ## Install
 ```bash
 pnpm add -D @supatest/playwright-reporter
 ```
 
-## Usage
+## Configuration
+
+Add to your `playwright.config.ts`:
+
 ```ts
-// playwright.config.ts
 import { defineConfig } from '@playwright/test';
 
 export default defineConfig({
   reporter: [
     ['@supatest/playwright-reporter', {
-      projectId: process.env.SUPATEST_PROJECT_ID, // optional metadata
-      outputFile: process.env.SUPATEST_REPORT_PATH // optional JSON output
+      apiKey: process.env.SUPATEST_API_KEY,
+      projectId: process.env.SUPATEST_PROJECT_ID,
+      apiUrl: process.env.SUPATEST_API_URL, // optional, defaults to https://api.supatest.dev
+      uploadAssets: true, // optional, default true
+      maxConcurrentUploads: 5, // optional
+      retryAttempts: 3, // optional
+      timeoutMs: 30000, // optional
+      dryRun: false, // optional, for testing
     }]
   ]
 });
 ```
 
-## What it does now
-- Collects run metadata and every test result (including attachments and steps where available).
-- Prints a single JSON payload at the end of the run; optionally writes it to `outputFile`.
-- Generates stable IDs per run/test/result using deterministic hashes.
+## Environment Variables
+
+```bash
+SUPATEST_API_KEY=sk_live_...        # Required: API authentication key
+SUPATEST_PROJECT_ID=proj_123        # Required: Project identifier
+SUPATEST_API_URL=https://api.supatest.dev  # Optional: Custom API endpoint
+SUPATEST_DRY_RUN=true               # Optional: Test mode (no actual uploads)
+```
+
+## Features
+
+### Test Data Collection
+- **Test Results**: Status, duration, retry info, flaky detection
+- **Test Steps**: Nested step hierarchy with timing and status
+- **Errors**: Source location, stack traces, and failure details
+- **Console Output**: stdout/stderr captured during test execution
+- **Attachments**: Screenshots, videos, and traces metadata
+
+### Environment & Context
+- **OS Info**: Platform, release, architecture, CPU count, RAM
+- **Node.js Version**: Runtime environment details
+- **Playwright Config**: Version, workers, retry strategy, parallel mode
+- **Browser Projects**: Browser type, viewport, locale, timezone per project
+- **Sharding Info**: Current shard and total shards
+- **CI Provider Detection**: GitHub Actions, GitLab, Jenkins, CircleCI, Travis, Buildkite, Azure
+- **Git Context**: Branch, commit, message, repository, author
 
-## Next steps (not implemented yet)
-- Send payload and assets to Supatest ingestion APIs.
-- Add signed-URL asset uploads and retry/backoff behavior.
-- Add richer CI/Git metadata capture.
+### Performance & Reliability
+- **Non-Blocking Uploads**: Test execution continues while uploads happen in background
+- **Concurrent Uploads**: Configurable concurrency control (default: 5 parallel)
+- **Retry Logic**: Exponential backoff with configurable attempts
+- **Error Handling**: Graceful degradation—reporting failures don't block tests
+- **Signed URL Uploads**: Direct S3 uploads via signed URLs from API

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@supatest/playwright-reporter",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Supatest Playwright reporter - stream test results to Supatest dashboard",
   "type": "module",
   "main": "dist/index.js",