@flakiness/vitest 1.5.0 → 1.7.0

package/README.md

@@ -96,6 +96,8 @@ npx flakiness show ./flakiness-report
 
 ## Features
 
+See [features.md](./features.md) for this reporter's status against the [Flakiness Report spec](https://github.com/flakiness/flakiness-report/blob/main/features.md).
+
 ### Test Location Tracking
 
 When `includeTaskLocation: true` is set in your Vitest config, the reporter records the exact file, line, and column for each test. This enables precise navigation from the Flakiness.io dashboard back to your source code.

package/lib/reporter.js

@@ -4,11 +4,13 @@ import crypto from "crypto";
 import assert from "node:assert";
 import path from "node:path";
 import * as nodeUtil from "node:util";
+import pkg from "../package.json" with { type: "json" };
 const styleText = (format, text) => nodeUtil.styleText?.(format, text) ?? text;
 class FKVitestReporter {
   constructor(_options) {
     this._options = _options;
   }
+  _options;
   _impl;
   _vitest;
   _logger = {
@@ -27,7 +29,7 @@ class FKVitestReporter {
   }
   onTestRunStart() {
     assert(this._vitest, "onInit must be called before onTestRunStart");
-    this._impl = ReporterImpl.create(this._vitest.config.root, this._vitest.projects, this._options, this._logger, this._vitest.config.config);
+    this._impl = ReporterImpl.create(this._vitest.config.root, this._vitest.projects, this._options, this._logger, this._vitest.version, this._vitest.config.config);
   }
   async onTestRunEnd(testModules, unhandledErrors, reason) {
     await this._impl?.onTestRunEnd(testModules, unhandledErrors, reason);
@@ -36,11 +38,12 @@ class FKVitestReporter {
 }
 const gTestToTestCaseId = /* @__PURE__ */ new WeakMap();
 class ReporterImpl {
-  constructor(_worktree, projects, _commitId, _options, _logger, _configPath) {
+  constructor(_worktree, projects, _commitId, _options, _logger, _vitestVersion, _configPath) {
     this._worktree = _worktree;
     this._commitId = _commitId;
     this._options = _options;
     this._logger = _logger;
+    this._vitestVersion = _vitestVersion;
     this._configPath = _configPath;
     this._environments = projects.map((project) => ReportUtils.createEnvironment({
       name: this._envName(project)
@@ -48,24 +51,26 @@ class ReporterImpl {
     this._sampleSystem = this._sampleSystem.bind(this);
     this._sampleSystem();
   }
+  _worktree;
+  _commitId;
+  _options;
+  _logger;
+  _vitestVersion;
+  _configPath;
   _telemetryTimer;
   _cpuUtilization = new CPUUtilization({ precision: 10 });
   _ramUtilization = new RAMUtilization({ precision: 10 });
   _startTimestamp = Date.now();
   _stdio = /* @__PURE__ */ new Map();
   _environments = [];
-  static create(rootPath, projects, options, logger, config) {
-    let commitId;
-    let worktree;
-    try {
-      worktree = GitWorktree.create(rootPath);
-      commitId = worktree.headCommitId();
-      return new ReporterImpl(worktree, projects, commitId, options, logger, config);
-    } catch (e) {
-      logger.warn(`[flakiness.io] Failed to fetch commit info - is this a git repo?`);
+  static create(rootPath, projects, options, logger, vitestVersion, config) {
+    const result = GitWorktree.initialize(rootPath);
+    if (!result.ok) {
+      logger.warn(`[flakiness.io] Failed to fetch commit info - is this a git repo? (${result.error})`);
       logger.error(`[flakiness.io] Report is NOT generated.`);
       return;
     }
+    return new ReporterImpl(result.worktree, projects, result.commitId, options, logger, vitestVersion, config);
   }
   _sampleSystem() {
     this._cpuUtilization.sample();
@@ -116,6 +121,7 @@ class ReporterImpl {
     const fkTest = {
       attempts: [],
       title: testCase.name,
+      tags: testCase.tags?.length ? [...testCase.tags] : void 0,
       location: testCase.location ? {
         file: this._worktree.gitPath(testCase.module.moduleId),
         column: testCase.location.column,
@@ -181,6 +187,7 @@ class ReporterImpl {
         expectedStatus,
         // TODO: ideally, we can differentiate STDIO between attempts.
         // However, vitest doesn't let us do so easily.
+        // See https://github.com/vitest-dev/vitest/issues/10303
         // We slice these arrays just to be safe: if someone downstream from us
         // decides to push a new annotation, then they can do it per-attempt safely.
         stdio: stdio.slice(),
@@ -196,6 +203,7 @@ class ReporterImpl {
       expectedStatus,
       // TODO: ideally, we can differentiate STDIO between attempts.
       // However, vitest doesn't let us do so easily.
+      // See https://github.com/vitest-dev/vitest/issues/10303
       stdio,
       errors,
       annotations
@@ -328,6 +336,9 @@ class ReporterImpl {
       category: "vitest",
       configPath: this._configPath ? this._worktree.gitPath(this._configPath) : void 0,
       commitId: this._commitId,
+      generatedBy: { name: pkg.name, version: pkg.version },
+      testRunner: { name: "vitest", version: this._vitestVersion },
+      runtime: ReportUtils.detectRuntime(),
       environments: this._environments,
       startTimestamp: this._startTimestamp,
       duration,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flakiness/vitest",
-  "version": "1.5.0",
+  "version": "1.7.0",
   "description": "",
   "main": "lib/reporter.js",
   "keywords": [],
@@ -11,19 +11,22 @@
     "url": "https://github.com/flakiness/vitest"
   },
   "type": "module",
+  "engines": {
+    "node": "^20.17.0 || >=22.9.0"
+  },
   "devDependencies": {
-    "@flakiness/vitest": "1.4.0",
-    "@types/node": "^25.3.3",
-    "@vitest/utils": "^4.0.18",
-    "esbuild": "^0.27.3",
+    "@flakiness/vitest": "1.6.0",
+    "@types/node": "^25.6.2",
+    "@vitest/utils": "^4.1.5",
+    "esbuild": "^0.27.7",
     "kubik": "^0.24.0",
     "tsx": "^4.21.0",
     "typescript": "^5.9.3",
-    "vitest": "^4.0.18"
+    "vitest": "^4.1.5"
   },
   "dependencies": {
-    "@flakiness/flakiness-report": "^0.29.0",
-    "@flakiness/sdk": "^2.6.0"
+    "@flakiness/flakiness-report": "^0.34.0",
+    "@flakiness/sdk": "^3.2.0"
   },
   "scripts": {
     "build": "kubik build.mts",

package/types/src/reporter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"reporter.d.ts","sourceRoot":"","sources":["../../src/reporter.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,eAAe,EAAY,UAAU,EAAe,gBAAgB,EAAa,MAAM,EAAE,MAAM,aAAa,CAAC;AAC3H,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAIjD,UAAU,cAAc;IACtB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,IAAI,EAAE,QAAQ,GAAG,QAAQ,CAAC;IAC1B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,MAAM,uBAAuB,GAAG;IACpC,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,GAAC,QAAQ,CAAC;IAC7B,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAA;AAED,MAAM,WAAW,cAAc;IAC7B,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,IAAI,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAMD,MAAM,CAAC,OAAO,OAAO,gBAAiB,YAAW,QAAQ;IAS3C,OAAO,CAAC,QAAQ;IAR5B,OAAO,CAAC,KAAK,CAAC,CAAe;IAC7B,OAAO,CAAC,OAAO,CAAC,CAAS;IACzB,OAAO,CAAC,OAAO,CAId;gBAEmB,QAAQ,EAAE,uBAAuB;IAGrD,gBAAgB,CAAC,MAAM,EAAE,cAAc;IAIjC,gBAAgB,CAAC,GAAG,EAAE,cAAc;IAI1C,MAAM,CAAC,MAAM,EAAE,MAAM;IAIrB,cAAc;IAOR,YAAY,CAAC,WAAW,EAAE,aAAa,CAAC,UAAU,CAAC,EAAE,eAAe,EAAE,aAAa,CAAC,eAAe,CAAC,EAAE,MAAM,EAAE,gBAAgB;CAIrI"}
+{"version":3,"file":"reporter.d.ts","sourceRoot":"","sources":["../../src/reporter.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,eAAe,EAAY,UAAU,EAAe,gBAAgB,EAAa,MAAM,EAAE,MAAM,aAAa,CAAC;AAC3H,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAMjD,UAAU,cAAc;IACtB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,IAAI,EAAE,QAAQ,GAAG,QAAQ,CAAC;IAC1B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,MAAM,uBAAuB,GAAG;IACpC,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,GAAC,QAAQ,CAAC;IAC7B,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAA;AAED,MAAM,WAAW,cAAc;IAC7B,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,IAAI,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAMD,MAAM,CAAC,OAAO,OAAO,gBAAiB,YAAW,QAAQ;IAS3C,OAAO,CAAC,QAAQ;IAR5B,OAAO,CAAC,KAAK,CAAC,CAAe;IAC7B,OAAO,CAAC,OAAO,CAAC,CAAS;IACzB,OAAO,CAAC,OAAO,CAId;gBAEmB,QAAQ,EAAE,uBAAuB;IAGrD,gBAAgB,CAAC,MAAM,EAAE,cAAc;IAIjC,gBAAgB,CAAC,GAAG,EAAE,cAAc;IAI1C,MAAM,CAAC,MAAM,EAAE,MAAM;IAIrB,cAAc;IAOR,YAAY,CAAC,WAAW,EAAE,aAAa,CAAC,UAAU,CAAC,EAAE,eAAe,EAAE,aAAa,CAAC,eAAe,CAAC,EAAE,MAAM,EAAE,gBAAgB;CAIrI"}