@justinmiehle/reporter-vitest 0.0.6

package/README.md

@@ -0,0 +1,90 @@
+# Panoptes Vitest Reporter
+
+Custom reporter for Vitest that sends test results directly to Convex.
+
+Published as **@justinmiehle/reporter-vitest** on [GitHub Packages](https://github.com/JustinMiehle?tab=packages).
+
+## Installation
+
+### Within the Panoptes Monorepo
+
+If you're using this reporter in another package within the Panoptes monorepo, use the workspace protocol:
+
+```bash
+bun add -d @justinmiehle/reporter-vitest@workspace:*
+```
+
+This will reference the local package directly without needing to publish or use a local registry.
+
+### Outside the Monorepo (GitHub Packages)
+
+Install from GitHub Packages. You need to point the `@justinmiehle` scope at GitHub's registry and authenticate.
+
+**In a GitHub Action** (other repo), add a step before installing dependencies:
+
+```yaml
+- uses: actions/setup-node@v4
+  with:
+    node-version: '20'
+    registry-url: 'https://npm.pkg.github.com'
+    scope: '@justinmiehle'
+- run: bun install  # or npm ci
+  env:
+    NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+```
+
+Create an `.npmrc` in that repo (or inject it in CI):
+
+```
+@justinmiehle:registry=https://npm.pkg.github.com
+```
+
+Then install:
+
+```bash
+bun add -d @justinmiehle/reporter-vitest
+```
+
+**Local / other CI:** Use a [Personal Access Token](https://github.com/settings/tokens) with `read:packages` and set `NODE_AUTH_TOKEN` or use `npm login` against `https://npm.pkg.github.com`.
+
+## Configuration
+
+Add the reporter to your `vitest.config.ts`:
+
+```typescript
+import { defineConfig } from 'vitest/config'
+import PanoptesReporter from '@justinmiehle/reporter-vitest'
+
+export default defineConfig({
+  test: {
+    reporters: [
+      'default',
+      new PanoptesReporter({
+        convexUrl: process.env.CONVEX_URL,
+        projectName: process.env.PANOPTES_PROJECT_NAME || 'my-project',
+        environment: process.env.NODE_ENV || 'development',
+        ci: process.env.CI === 'true',
+      }),
+    ],
+  },
+})
+```
+
+**Important:** Do not add `@justinmiehle/reporter-vitest` or `@justinmiehle/shared` to `ssr.noExternal` in your Vite/Vitest config. The packages are designed to be treated as external dependencies and will be loaded from their compiled JavaScript files in the `dist/` directory.
+
+## Environment Variables
+
+- `CONVEX_URL` - Convex deployment URL (required, e.g., `https://xxx.convex.cloud`)
+- `PANOPTES_PROJECT_NAME` - Project name (default: `default-project`)
+- `NODE_ENV` - Environment name
+- `CI` - Set to `true` if running in CI
+
+## Usage
+
+Run your tests as usual:
+
+```bash
+vitest run
+```
+
+The reporter will automatically send test results to Convex. Make sure `CONVEX_URL` is set in your environment.

package/dist/index.d.ts

@@ -0,0 +1,20 @@
+import type { Reporter } from "vitest/reporters";
+interface PanoptesReporterOptions {
+    convexUrl?: string;
+    projectName?: string;
+    environment?: string;
+    ci?: boolean;
+}
+export default class PanoptesReporter implements Reporter {
+    private options;
+    private startTime;
+    private tests;
+    private suites;
+    constructor(options?: PanoptesReporterOptions);
+    onInit(): void;
+    onTestRunStart(): void;
+    onTestCaseResult(test: any): void;
+    onTestRunEnd(): Promise<void>;
+    private mapStatus;
+}
+export {};

package/dist/index.js

@@ -0,0 +1,160 @@
+var __require = /* @__PURE__ */ ((x) => typeof require !== "undefined" ? require : typeof Proxy !== "undefined" ? new Proxy(x, {
+  get: (a, b) => (typeof require !== "undefined" ? require : a)[b]
+}) : x)(function(x) {
+  if (typeof require !== "undefined") return require.apply(this, arguments);
+  throw Error('Dynamic require of "' + x + '" is not supported');
+});
+
+// src/index.ts
+function getCommitSha() {
+  if (process.env.GITHUB_SHA) {
+    return process.env.GITHUB_SHA;
+  }
+  if (process.env.CIRCLE_SHA1) {
+    return process.env.CIRCLE_SHA1;
+  }
+  if (process.env.GITLAB_CI_COMMIT_SHA) {
+    return process.env.GITLAB_CI_COMMIT_SHA;
+  }
+  try {
+    const { execSync } = __require("node:child_process");
+    return execSync("git rev-parse HEAD", { encoding: "utf-8" }).trim();
+  } catch {
+    return void 0;
+  }
+}
+var PanoptesReporter = class {
+  options;
+  startTime = 0;
+  tests = [];
+  suites = /* @__PURE__ */ new Map();
+  constructor(options = {}) {
+    this.options = {
+      convexUrl: options.convexUrl || process.env.CONVEX_URL || "",
+      projectName: options.projectName || process.env.PANOPTES_PROJECT_NAME || "default-project",
+      environment: options.environment || process.env.NODE_ENV || "development",
+      ci: options.ci ?? process.env.CI === "true"
+    };
+  }
+  onInit() {
+    this.startTime = Date.now();
+  }
+  onTestRunStart() {
+    this.tests = [];
+    this.suites.clear();
+  }
+  // biome-ignore lint/suspicious/noExplicitAny: Vitest reporter interface doesn't provide strict types
+  onTestCaseResult(test) {
+    const testResult = {
+      name: test.name || test.title || "Unknown test",
+      file: test.file?.name || test.filepath || "unknown",
+      line: test.file?.line,
+      column: test.file?.column,
+      status: this.mapStatus(test.status),
+      duration: test.duration || 0,
+      error: test.error?.message,
+      errorDetails: test.error?.stack,
+      retries: test.retryCount,
+      suite: test.suite?.name,
+      tags: test.meta?.tags,
+      metadata: {
+        type: test.type,
+        mode: test.mode
+      }
+    };
+    this.tests.push(testResult);
+    if (test.suite) {
+      const suiteKey = test.suite.name || test.file?.name || "unknown";
+      if (!this.suites.has(suiteKey)) {
+        this.suites.set(suiteKey, {
+          name: test.suite.name || suiteKey,
+          file: test.file?.name || test.filepath || "unknown",
+          tests: []
+        });
+      }
+      this.suites.get(suiteKey)?.tests.push(testResult);
+    }
+  }
+  async onTestRunEnd() {
+    const endTime = Date.now();
+    const duration = endTime - this.startTime;
+    const passedTests = this.tests.filter((t) => t.status === "passed").length;
+    const failedTests = this.tests.filter((t) => t.status === "failed").length;
+    const skippedTests = this.tests.filter((t) => t.status === "skipped").length;
+    const suiteData = Array.from(this.suites.values()).map((suite) => {
+      const suiteTests = suite.tests;
+      const passed = suiteTests.filter((t) => t.status === "passed").length;
+      const failed = suiteTests.filter((t) => t.status === "failed").length;
+      const skipped = suiteTests.filter((t) => t.status === "skipped").length;
+      const status = failed > 0 ? "failed" : skipped === suiteTests.length ? "skipped" : "passed";
+      return {
+        name: suite.name,
+        file: suite.file,
+        status,
+        duration: suiteTests.reduce((sum, t) => sum + t.duration, 0),
+        totalTests: suiteTests.length,
+        passedTests: passed,
+        failedTests: failed,
+        skippedTests: skipped
+      };
+    });
+    const testRun = {
+      projectName: this.options.projectName,
+      framework: "vitest",
+      testType: "unit",
+      // Vitest is typically unit tests, but could be configured
+      startedAt: this.startTime,
+      completedAt: endTime,
+      duration,
+      totalTests: this.tests.length,
+      passedTests,
+      failedTests,
+      skippedTests,
+      environment: this.options.environment,
+      ci: this.options.ci,
+      commitSha: getCommitSha(),
+      tests: this.tests,
+      suites: suiteData
+    };
+    if (!this.options.convexUrl) {
+      console.warn("[Panoptes] CONVEX_URL not set. Test results will not be sent.");
+      return;
+    }
+    try {
+      const response = await fetch(`${this.options.convexUrl}/http/ingestTestRunHttp`, {
+        method: "POST",
+        headers: {
+          "Content-Type": "application/json"
+        },
+        body: JSON.stringify(testRun)
+      });
+      if (!response.ok) {
+        const error = await response.text();
+        console.error(`[Panoptes] Failed to send test results: ${error}`);
+      } else {
+        const result = await response.json();
+        console.log(`[Panoptes] Test results sent successfully. Test Run ID: ${result.testRunId}`);
+      }
+    } catch (error) {
+      console.error("[Panoptes] Error sending test results:", error);
+    }
+  }
+  mapStatus(status) {
+    switch (status) {
+      case "passed":
+      case "pass":
+        return "passed";
+      case "failed":
+      case "fail":
+        return "failed";
+      case "skipped":
+      case "skip":
+        return "skipped";
+      default:
+        return "running";
+    }
+  }
+};
+export {
+  PanoptesReporter as default
+};

package/package.json

@@ -0,0 +1,39 @@
+{
+	"name": "@justinmiehle/reporter-vitest",
+	"version": "0.0.6",
+	"description": "Panoptes reporter for Vitest test results",
+	"type": "module",
+	"main": "./dist/index.js",
+	"types": "./dist/index.d.ts",
+	"exports": {
+		".": {
+			"types": "./dist/index.d.ts",
+			"import": "./dist/index.js",
+			"require": "./dist/index.js"
+		}
+	},
+	"files": ["dist", "src"],
+	"scripts": {
+		"build": "bunx esbuild src/index.ts --bundle --platform=node --format=esm --outfile=dist/index.js --external:@justinmiehle/shared --external:vitest && bunx tsc --emitDeclarationOnly --declaration --outDir dist --skipLibCheck src/index.ts"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/JustinMiehle/panoptes.git",
+		"directory": "packages/reporters/vitest"
+	},
+	"publishConfig": {
+		"registry": "https://npm.pkg.github.com",
+		"access": "public"
+	},
+	"dependencies": {
+		"@justinmiehle/shared": "0.0.2"
+	},
+	"devDependencies": {
+		"@types/node": "^20.10.0",
+		"typescript": "^5.3.3",
+		"vitest": "^1.0.0"
+	},
+	"peerDependencies": {
+		"vitest": "^1.0.0"
+	}
+}

package/src/index.ts

@@ -0,0 +1,181 @@
+import type { TestResult, TestRunIngest } from "@justinmiehle/shared";
+import type { Reporter } from "vitest/reporters";
+
+interface PanoptesReporterOptions {
+	convexUrl?: string;
+	projectName?: string;
+	environment?: string;
+	ci?: boolean;
+}
+
+function getCommitSha(): string | undefined {
+	// Check CI environment first (GitHub Actions, etc.)
+	if (process.env.GITHUB_SHA) {
+		return process.env.GITHUB_SHA;
+	}
+	if (process.env.CIRCLE_SHA1) {
+		return process.env.CIRCLE_SHA1;
+	}
+	if (process.env.GITLAB_CI_COMMIT_SHA) {
+		return process.env.GITLAB_CI_COMMIT_SHA;
+	}
+	// Try to get from git in local environment
+	// Note: This requires git to be available and may fail silently
+	try {
+		const { execSync } = require("node:child_process");
+		return execSync("git rev-parse HEAD", { encoding: "utf-8" }).trim();
+	} catch {
+		// Git not available or not in a git repo
+		return undefined;
+	}
+}
+
+export default class PanoptesReporter implements Reporter {
+	private options: Required<PanoptesReporterOptions>;
+	private startTime = 0;
+	private tests: TestResult[] = [];
+	private suites: Map<string, { name: string; file: string; tests: TestResult[] }> = new Map();
+
+	constructor(options: PanoptesReporterOptions = {}) {
+		this.options = {
+			convexUrl: options.convexUrl || process.env.CONVEX_URL || "",
+			projectName: options.projectName || process.env.PANOPTES_PROJECT_NAME || "default-project",
+			environment: options.environment || process.env.NODE_ENV || "development",
+			ci: options.ci ?? process.env.CI === "true",
+		};
+	}
+
+	onInit() {
+		this.startTime = Date.now();
+	}
+
+	onTestRunStart() {
+		this.tests = [];
+		this.suites.clear();
+	}
+
+	// biome-ignore lint/suspicious/noExplicitAny: Vitest reporter interface doesn't provide strict types
+	onTestCaseResult(test: any) {
+		const testResult: TestResult = {
+			name: test.name || test.title || "Unknown test",
+			file: test.file?.name || test.filepath || "unknown",
+			line: test.file?.line,
+			column: test.file?.column,
+			status: this.mapStatus(test.status),
+			duration: test.duration || 0,
+			error: test.error?.message,
+			errorDetails: test.error?.stack,
+			retries: test.retryCount,
+			suite: test.suite?.name,
+			tags: test.meta?.tags,
+			metadata: {
+				type: test.type,
+				mode: test.mode,
+			},
+		};
+
+		this.tests.push(testResult);
+
+		// Track suites
+		if (test.suite) {
+			const suiteKey = test.suite.name || test.file?.name || "unknown";
+			if (!this.suites.has(suiteKey)) {
+				this.suites.set(suiteKey, {
+					name: test.suite.name || suiteKey,
+					file: test.file?.name || test.filepath || "unknown",
+					tests: [],
+				});
+			}
+			this.suites.get(suiteKey)?.tests.push(testResult);
+		}
+	}
+
+	async onTestRunEnd() {
+		const endTime = Date.now();
+		const duration = endTime - this.startTime;
+
+		const passedTests = this.tests.filter((t) => t.status === "passed").length;
+		const failedTests = this.tests.filter((t) => t.status === "failed").length;
+		const skippedTests = this.tests.filter((t) => t.status === "skipped").length;
+
+		// Build suite data
+		const suiteData = Array.from(this.suites.values()).map((suite) => {
+			const suiteTests = suite.tests;
+			const passed = suiteTests.filter((t) => t.status === "passed").length;
+			const failed = suiteTests.filter((t) => t.status === "failed").length;
+			const skipped = suiteTests.filter((t) => t.status === "skipped").length;
+
+			const status: "passed" | "failed" | "skipped" =
+				failed > 0 ? "failed" : skipped === suiteTests.length ? "skipped" : "passed";
+			return {
+				name: suite.name,
+				file: suite.file,
+				status,
+				duration: suiteTests.reduce((sum, t) => sum + t.duration, 0),
+				totalTests: suiteTests.length,
+				passedTests: passed,
+				failedTests: failed,
+				skippedTests: skipped,
+			};
+		});
+
+		const testRun: TestRunIngest = {
+			projectName: this.options.projectName,
+			framework: "vitest",
+			testType: "unit", // Vitest is typically unit tests, but could be configured
+			startedAt: this.startTime,
+			completedAt: endTime,
+			duration,
+			totalTests: this.tests.length,
+			passedTests,
+			failedTests,
+			skippedTests,
+			environment: this.options.environment,
+			ci: this.options.ci,
+			commitSha: getCommitSha(),
+			tests: this.tests,
+			suites: suiteData,
+		};
+
+		if (!this.options.convexUrl) {
+			console.warn("[Panoptes] CONVEX_URL not set. Test results will not be sent.");
+			return;
+		}
+
+		try {
+			const response = await fetch(`${this.options.convexUrl}/http/ingestTestRunHttp`, {
+				method: "POST",
+				headers: {
+					"Content-Type": "application/json",
+				},
+				body: JSON.stringify(testRun),
+			});
+
+			if (!response.ok) {
+				const error = await response.text();
+				console.error(`[Panoptes] Failed to send test results: ${error}`);
+			} else {
+				const result = (await response.json()) as { testRunId?: string };
+				console.log(`[Panoptes] Test results sent successfully. Test Run ID: ${result.testRunId}`);
+			}
+		} catch (error) {
+			console.error("[Panoptes] Error sending test results:", error);
+		}
+	}
+
+	private mapStatus(status: string): "passed" | "failed" | "skipped" | "running" {
+		switch (status) {
+			case "passed":
+			case "pass":
+				return "passed";
+			case "failed":
+			case "fail":
+				return "failed";
+			case "skipped":
+			case "skip":
+				return "skipped";
+			default:
+				return "running";
+		}
+	}
+}