@justinmiehle/reporter-vitest 0.0.6 → 0.0.7

package/dist/index.d.ts

@@ -16,5 +16,13 @@ export default class PanoptesReporter implements Reporter {
     onTestCaseResult(test: any): void;
     onTestRunEnd(): Promise<void>;
     private mapStatus;
+    private readCodeSnippet;
+    private getDiagnostic;
+    private getArtifacts;
+    /**
+     * Read Istanbul-style coverage from coverage/coverage-final.json (or PANOPTES_COVERAGE_PATH).
+     * Enable coverage in Vitest (e.g. coverage: { provider: 'v8', reporter: ['json'] }) for LOC to be sent.
+     */
+    private readCoverage;
 }
 export {};

package/dist/index.js

@@ -6,6 +6,10 @@ var __require = /* @__PURE__ */ ((x) => typeof require !== "undefined" ? require
 });
 
 // src/index.ts
+import * as fs from "node:fs";
+import * as path from "node:path";
+var CODE_SNIPPET_CONTEXT_LINES = 10;
+var DEFAULT_COVERAGE_PATH = "coverage/coverage-final.json";
 function getCommitSha() {
   if (process.env.GITHUB_SHA) {
     return process.env.GITHUB_SHA;
@@ -45,11 +49,22 @@ var PanoptesReporter = class {
   }
   // biome-ignore lint/suspicious/noExplicitAny: Vitest reporter interface doesn't provide strict types
   onTestCaseResult(test) {
+    const filePath = test.file?.name || test.filepath || "unknown";
+    const line = test.file?.line ?? test.location?.line;
+    const codeSnippet = this.readCodeSnippet(filePath, line);
+    const diagnostic = this.getDiagnostic(test);
+    const artifactsList = this.getArtifacts(test);
+    const metadata = {
+      type: test.type,
+      mode: test.mode,
+      ...diagnostic && { diagnostic },
+      ...artifactsList && artifactsList.length > 0 && { artifacts: artifactsList }
+    };
     const testResult = {
       name: test.name || test.title || "Unknown test",
-      file: test.file?.name || test.filepath || "unknown",
-      line: test.file?.line,
-      column: test.file?.column,
+      file: filePath,
+      line,
+      column: test.file?.column ?? test.location?.column,
       status: this.mapStatus(test.status),
       duration: test.duration || 0,
       error: test.error?.message,
@@ -57,10 +72,8 @@ var PanoptesReporter = class {
       retries: test.retryCount,
       suite: test.suite?.name,
       tags: test.meta?.tags,
-      metadata: {
-        type: test.type,
-        mode: test.mode
-      }
+      codeSnippet,
+      metadata
     };
     this.tests.push(testResult);
     if (test.suite) {
@@ -98,6 +111,7 @@ var PanoptesReporter = class {
         skippedTests: skipped
       };
     });
+    const coverage = this.readCoverage();
     const testRun = {
       projectName: this.options.projectName,
       framework: "vitest",
@@ -114,7 +128,8 @@ var PanoptesReporter = class {
       ci: this.options.ci,
       commitSha: getCommitSha(),
       tests: this.tests,
-      suites: suiteData
+      suites: suiteData,
+      ...coverage && { coverage }
     };
     if (!this.options.convexUrl) {
       console.warn("[Panoptes] CONVEX_URL not set. Test results will not be sent.");
@@ -154,6 +169,125 @@ var PanoptesReporter = class {
         return "running";
     }
   }
+  readCodeSnippet(filePath, line) {
+    if (line == null) return void 0;
+    let absPath;
+    try {
+      absPath = path.isAbsolute(filePath) ? filePath : path.resolve(process.cwd(), filePath);
+      if (!fs.existsSync(absPath)) return void 0;
+    } catch {
+      return void 0;
+    }
+    try {
+      const content = fs.readFileSync(absPath, "utf-8");
+      const lines = content.split("\n");
+      const start = Math.max(0, line - 1 - CODE_SNIPPET_CONTEXT_LINES);
+      const end = Math.min(lines.length, line + CODE_SNIPPET_CONTEXT_LINES);
+      const slice = lines.slice(start, end).join("\n");
+      const ext = path.extname(filePath).toLowerCase();
+      const language = ext === ".ts" || ext === ".tsx" ? "typescript" : ext === ".js" || ext === ".jsx" ? "javascript" : void 0;
+      return {
+        startLine: start + 1,
+        endLine: end,
+        content: slice,
+        language
+      };
+    } catch {
+      return void 0;
+    }
+  }
+  // biome-ignore lint/suspicious/noExplicitAny: Vitest reporter interface
+  getDiagnostic(test) {
+    try {
+      if (typeof test.diagnostic !== "function") return void 0;
+      const d = test.diagnostic();
+      if (!d) return void 0;
+      return {
+        duration: d.duration,
+        slow: d.slow,
+        flaky: d.flaky,
+        retryCount: d.retryCount,
+        repeatCount: d.repeatCount,
+        heap: d.heap,
+        startTime: d.startTime
+      };
+    } catch {
+      return void 0;
+    }
+  }
+  // biome-ignore lint/suspicious/noExplicitAny: Vitest reporter interface; artifacts() is experimental
+  getArtifacts(test) {
+    try {
+      if (typeof test.artifacts !== "function") return void 0;
+      const list = test.artifacts();
+      if (!Array.isArray(list) || list.length === 0) return void 0;
+      return list.map((a) => ({ type: a?.type ?? "unknown" }));
+    } catch {
+      return void 0;
+    }
+  }
+  /**
+   * Read Istanbul-style coverage from coverage/coverage-final.json (or PANOPTES_COVERAGE_PATH).
+   * Enable coverage in Vitest (e.g. coverage: { provider: 'v8', reporter: ['json'] }) for LOC to be sent.
+   */
+  readCoverage() {
+    const coveragePath = process.env.PANOPTES_COVERAGE_PATH ?? path.resolve(process.cwd(), DEFAULT_COVERAGE_PATH);
+    try {
+      if (!fs.existsSync(coveragePath)) return void 0;
+      const raw = fs.readFileSync(coveragePath, "utf-8");
+      const data = JSON.parse(raw);
+      const files = {};
+      let totalLines = 0;
+      let coveredLines = 0;
+      for (const [filePath, entry] of Object.entries(data)) {
+        if (!entry || typeof entry !== "object") continue;
+        const statementCounts = entry.s ?? {};
+        const statementMap = entry.statementMap;
+        let linesTotal = 0;
+        let linesCovered = 0;
+        if (statementMap && typeof statementMap === "object") {
+          const lineHits = /* @__PURE__ */ new Map();
+          for (const [id, loc] of Object.entries(statementMap)) {
+            if (!loc?.start?.line) continue;
+            const count = statementCounts[id] ?? 0;
+            const line = loc.start.line;
+            lineHits.set(line, (lineHits.get(line) ?? 0) + count);
+          }
+          linesTotal = lineHits.size;
+          for (const hits of Array.from(lineHits.values())) {
+            if (hits > 0) linesCovered += 1;
+          }
+        }
+        const statementsTotal = Object.keys(statementCounts).length;
+        const statementsCovered = Object.values(statementCounts).filter(
+          (c) => typeof c === "number" && c > 0
+        ).length;
+        if (statementsTotal > 0 && linesTotal === 0) {
+          linesTotal = statementsTotal;
+          linesCovered = statementsCovered;
+        }
+        totalLines += linesTotal;
+        coveredLines += linesCovered;
+        const relPath = path.isAbsolute(filePath) ? path.relative(process.cwd(), filePath) : filePath;
+        files[relPath] = {
+          linesCovered,
+          linesTotal: linesTotal || 1,
+          statementsCovered: statementsTotal > 0 ? statementsCovered : void 0,
+          statementsTotal: statementsTotal > 0 ? statementsTotal : void 0
+        };
+      }
+      if (Object.keys(files).length === 0) return void 0;
+      return {
+        summary: {
+          lines: { total: totalLines, covered: coveredLines },
+          statements: { total: totalLines, covered: coveredLines }
+        },
+        files
+      };
+    } catch {
+      return void 0;
+    }
+  }
 };
 export {
   PanoptesReporter as default

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@justinmiehle/reporter-vitest",
-	"version": "0.0.6",
+	"version": "0.0.7",
 	"description": "Panoptes reporter for Vitest test results",
 	"type": "module",
 	"main": "./dist/index.js",
@@ -26,7 +26,7 @@
 		"access": "public"
 	},
 	"dependencies": {
-		"@justinmiehle/shared": "0.0.2"
+		"@justinmiehle/shared": "workspace:*"
 	},
 	"devDependencies": {
 		"@types/node": "^20.10.0",

package/src/index.ts

@@ -1,6 +1,12 @@
-import type { TestResult, TestRunIngest } from "@justinmiehle/shared";
+import * as fs from "node:fs";
+import * as os from "node:os";
+import * as path from "node:path";
+import type { CoverageIngest, FileCoverage, TestResult, TestRunIngest } from "@justinmiehle/shared";
 import type { Reporter } from "vitest/reporters";
 
+const CODE_SNIPPET_CONTEXT_LINES = 10;
+const DEFAULT_COVERAGE_PATH = "coverage/coverage-final.json";
+
 interface PanoptesReporterOptions {
 	convexUrl?: string;
 	projectName?: string;
@@ -30,6 +36,20 @@ function getCommitSha(): string | undefined {
 	}
 }
 
+function getTriggeredBy(): string | undefined {
+	// CI: use provider's actor/username
+	if (process.env.GITHUB_ACTOR) return process.env.GITHUB_ACTOR;
+	if (process.env.CIRCLE_USERNAME) return process.env.CIRCLE_USERNAME;
+	if (process.env.GITLAB_USER_LOGIN) return process.env.GITLAB_USER_LOGIN;
+	// Local: machine username
+	if (process.env.USER) return process.env.USER;
+	try {
+		return os.userInfo().username;
+	} catch {
+		return undefined;
+	}
+}
+
 export default class PanoptesReporter implements Reporter {
 	private options: Required<PanoptesReporterOptions>;
 	private startTime = 0;
@@ -56,11 +76,23 @@ export default class PanoptesReporter implements Reporter {
 
 	// biome-ignore lint/suspicious/noExplicitAny: Vitest reporter interface doesn't provide strict types
 	onTestCaseResult(test: any) {
+		const filePath = test.file?.name || test.filepath || "unknown";
+		const line = test.file?.line ?? test.location?.line;
+		const codeSnippet = this.readCodeSnippet(filePath, line);
+		const diagnostic = this.getDiagnostic(test);
+		const artifactsList = this.getArtifacts(test);
+		const metadata: Record<string, unknown> = {
+			type: test.type,
+			mode: test.mode,
+			...(diagnostic && { diagnostic: diagnostic }),
+			...(artifactsList && artifactsList.length > 0 && { artifacts: artifactsList }),
+		};
+
 		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,
+			file: filePath,
+			line,
+			column: test.file?.column ?? test.location?.column,
 			status: this.mapStatus(test.status),
 			duration: test.duration || 0,
 			error: test.error?.message,
@@ -68,10 +100,8 @@ export default class PanoptesReporter implements Reporter {
 			retries: test.retryCount,
 			suite: test.suite?.name,
 			tags: test.meta?.tags,
-			metadata: {
-				type: test.type,
-				mode: test.mode,
-			},
+			codeSnippet,
+			metadata,
 		};
 
 		this.tests.push(testResult);
@@ -119,6 +149,8 @@ export default class PanoptesReporter implements Reporter {
 			};
 		});
 
+		const coverage = this.readCoverage();
+
 		const testRun: TestRunIngest = {
 			projectName: this.options.projectName,
 			framework: "vitest",
@@ -135,6 +167,7 @@ export default class PanoptesReporter implements Reporter {
 			commitSha: getCommitSha(),
 			tests: this.tests,
 			suites: suiteData,
+			...(coverage && { coverage }),
 		};
 
 		if (!this.options.convexUrl) {
@@ -178,4 +211,151 @@ export default class PanoptesReporter implements Reporter {
 				return "running";
 		}
 	}
+
+	private readCodeSnippet(filePath: string, line: number | undefined): TestResult["codeSnippet"] {
+		if (line == null) return undefined;
+		let absPath: string;
+		try {
+			absPath = path.isAbsolute(filePath) ? filePath : path.resolve(process.cwd(), filePath);
+			if (!fs.existsSync(absPath)) return undefined;
+		} catch {
+			return undefined;
+		}
+		try {
+			const content = fs.readFileSync(absPath, "utf-8");
+			const lines = content.split("\n");
+			const start = Math.max(0, line - 1 - CODE_SNIPPET_CONTEXT_LINES);
+			const end = Math.min(lines.length, line + CODE_SNIPPET_CONTEXT_LINES);
+			const slice = lines.slice(start, end).join("\n");
+			const ext = path.extname(filePath).toLowerCase();
+			const language =
+				ext === ".ts" || ext === ".tsx"
+					? "typescript"
+					: ext === ".js" || ext === ".jsx"
+						? "javascript"
+						: undefined;
+			return {
+				startLine: start + 1,
+				endLine: end,
+				content: slice,
+				language,
+			};
+		} catch {
+			return undefined;
+		}
+	}
+
+	// biome-ignore lint/suspicious/noExplicitAny: Vitest reporter interface
+	private getDiagnostic(test: any): Record<string, unknown> | undefined {
+		try {
+			if (typeof test.diagnostic !== "function") return undefined;
+			const d = test.diagnostic();
+			if (!d) return undefined;
+			return {
+				duration: d.duration,
+				slow: d.slow,
+				flaky: d.flaky,
+				retryCount: d.retryCount,
+				repeatCount: d.repeatCount,
+				heap: d.heap,
+				startTime: d.startTime,
+			};
+		} catch {
+			return undefined;
+		}
+	}
+
+	// biome-ignore lint/suspicious/noExplicitAny: Vitest reporter interface; artifacts() is experimental
+	private getArtifacts(test: any): Array<{ type: string }> | undefined {
+		try {
+			if (typeof test.artifacts !== "function") return undefined;
+			const list = test.artifacts();
+			if (!Array.isArray(list) || list.length === 0) return undefined;
+			return list.map((a: { type?: string }) => ({ type: a?.type ?? "unknown" }));
+		} catch {
+			return undefined;
+		}
+	}
+
+	/**
+	 * Read Istanbul-style coverage from coverage/coverage-final.json (or PANOPTES_COVERAGE_PATH).
+	 * Enable coverage in Vitest (e.g. coverage: { provider: 'v8', reporter: ['json'] }) for LOC to be sent.
+	 */
+	private readCoverage(): CoverageIngest | undefined {
+		const coveragePath =
+			process.env.PANOPTES_COVERAGE_PATH ?? path.resolve(process.cwd(), DEFAULT_COVERAGE_PATH);
+		try {
+			if (!fs.existsSync(coveragePath)) return undefined;
+			const raw = fs.readFileSync(coveragePath, "utf-8");
+			const data = JSON.parse(raw) as Record<
+				string,
+				{
+					s?: Record<string, number>;
+					b?: Record<string, number[]>;
+					f?: Record<string, number>;
+					statementMap?: Record<string, unknown>;
+					branchMap?: Record<string, unknown>;
+					fnMap?: Record<string, unknown>;
+				}
+			>;
+			const files: Record<string, FileCoverage> = {};
+			let totalLines = 0;
+			let coveredLines = 0;
+			for (const [filePath, entry] of Object.entries(data)) {
+				if (!entry || typeof entry !== "object") continue;
+				// Istanbul does not always have 'l' (line counts); derive from statementMap + s if needed
+				const statementCounts = entry.s ?? {};
+				const statementMap = (
+					entry as {
+						statementMap?: Record<string, { start: { line: number }; end: { line: number } }>;
+					}
+				).statementMap;
+				let linesTotal = 0;
+				let linesCovered = 0;
+				if (statementMap && typeof statementMap === "object") {
+					const lineHits = new Map<number, number>();
+					for (const [id, loc] of Object.entries(statementMap)) {
+						if (!loc?.start?.line) continue;
+						const count = statementCounts[id] ?? 0;
+						const line = loc.start.line;
+						lineHits.set(line, (lineHits.get(line) ?? 0) + count);
+					}
+					linesTotal = lineHits.size;
+					for (const hits of Array.from(lineHits.values())) {
+						if (hits > 0) linesCovered += 1;
+					}
+				}
+				const statementsTotal = Object.keys(statementCounts).length;
+				const statementsCovered = Object.values(statementCounts).filter(
+					(c) => typeof c === "number" && c > 0
+				).length;
+				if (statementsTotal > 0 && linesTotal === 0) {
+					linesTotal = statementsTotal;
+					linesCovered = statementsCovered;
+				}
+				totalLines += linesTotal;
+				coveredLines += linesCovered;
+				// Use relative path for consistency
+				const relPath = path.isAbsolute(filePath)
+					? path.relative(process.cwd(), filePath)
+					: filePath;
+				files[relPath] = {
+					linesCovered,
+					linesTotal: linesTotal || 1,
+					statementsCovered: statementsTotal > 0 ? statementsCovered : undefined,
+					statementsTotal: statementsTotal > 0 ? statementsTotal : undefined,
+				};
+			}
+			if (Object.keys(files).length === 0) return undefined;
+			return {
+				summary: {
+					lines: { total: totalLines, covered: coveredLines },
+					statements: { total: totalLines, covered: coveredLines },
+				},
+				files,
+			};
+		} catch {
+			return undefined;
+		}
+	}
 }