Fix the vitest reporter being written in cjs and tests

Author: leeyi45

eslint.config.js

@@ -455,6 +455,7 @@ export default tseslint.config(
     files: [
       'lib/buildtools/**/*.ts',
       'lib/repotools/**/*.ts',
+      'lib/vitest-reporter/**/*.ts',
       '.github/actions/**/*.ts',
       '**/vitest.config.js'
     ],

lib/tsconfig.json

@@ -1,6 +1,7 @@
 // Lib tsconfig.json
 {
   "compilerOptions": {
+    "allowSyntheticDefaultImports": true,
     "esModuleInterop": true,
     "forceConsistentCasingInFileNames": true,
     "module": "ESNext",

lib/vitest-reporter/build/coverage-reporter.cjs

@@ -1 +1 @@
-"use strict";var m=require("fs"),{ReportBase:p}=require("istanbul-lib-report");function h(s){return s.statements.pct===100&&s.branches.pct===100&&s.functions.pct===100&&s.lines.pct===100}function f(s){if(s.isSummary())return[];let e=s.getCoverageSummary(!1),t=e.isEmpty()?0:e.lines.pct,r,c=s.getFileCoverage();if(t===100){let i=c.getBranchCoverageByLine();r=Object.entries(i).map(([a,{coverage:l}])=>[a,l===100])}else r=Object.entries(c.getLineCoverage());let o=!0;return r.reduce((i,[a,l])=>{if(l)o=!0;else{let u=parseInt(a);o?(i.push([u]),o=!1):i[i.length-1][1]=u}return i},[])}var w=["Statements","Branches","Functions","Lines"];module.exports=class extends p{skipEmpty;skipFull;results={};cw=null;watermarks=null;constructor(e){super(e),this.skipEmpty=!!e.skipEmpty,this.skipFull=!!e.skipFull}onStart(e,n){if(!process.env.GITHUB_STEP_SUMMARY){console.log("Reporter not being executed in Github Actions environment");return}this.cw=m.createWriteStream(process.env.GITHUB_STEP_SUMMARY,{encoding:"utf-8",flags:"a"}),this.watermarks=n.watermarks,this.cw.write("<h2>Test Coverage</h2>"),this.cw.write("<table><thead><tr>");for(let t of["File",...w,"Uncovered Lines"])this.cw.write(`<th>${t}</th>`);this.cw.write("</tr></thead><tbody>")}onSummary(e){let n=e.getRelativeName()||"All Files",t=e.getCoverageSummary(!1),r=t.isEmpty();this.skipEmpty&&r||this.skipFull&&h(t)||(this.results[n]={statements:r?0:t.statements.pct,branches:r?0:t.branches.pct,functions:r?0:t.functions.pct,lines:r?0:t.lines.pct,uncoveredLines:f(e)})}onDetail(e){return this.onSummary(e)}formatter(e,n){if(!this.watermarks)return`<td>${e}%</td>`;let[t,r]=this.watermarks[n];return e<t?`<td><p style="color:red">${e}%</p></td>`:e>r?`<td><p style="color:green">${e}%</p></td>`:`<td><p style="color:yellow">${e}%</p></td>`}onEnd(){if(!this.cw)return;let e=Object.keys(this.results).sort();for(let n of e){let t=this.results[n];if(this.cw.write(`<tr><td><code>${n}</code></td>`),this.cw.write(this.formatter(t.statements,"statements")),this.cw.write(this.formatter(t.branches,"branches")),this.cw.write(this.formatter(t.functions,"functions")),this.cw.write(this.formatter(t.lines,"lines")),t.uncoveredLines.length>0){this.cw.write("<td><details><summary>Expand</summary><ul>");for(let r of t.uncoveredLines)r.length===1?this.cw.write(`<li>${r[0]}</li>`):this.cw.write(`<li>${r[0]}-${r[1]}</li>`);this.cw.write("</ul></details></td>")}else this.cw.write("<td></td>");this.cw.write("</tr>")}this.cw.write("</tbody></table>"),this.cw.close()}};
+"use strict";var b=Object.create;var o=Object.defineProperty;var g=Object.getOwnPropertyDescriptor;var y=Object.getOwnPropertyNames;var v=Object.getPrototypeOf,k=Object.prototype.hasOwnProperty;var S=(t,e)=>{for(var n in e)o(t,n,{get:e[n],enumerable:!0})},p=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let s of y(e))!k.call(t,s)&&s!==n&&o(t,s,{get:()=>e[s],enumerable:!(r=g(e,s))||r.enumerable});return t};var f=(t,e,n)=>(n=t!=null?b(v(t)):{},p(e||!t||!t.__esModule?o(n,"default",{value:t,enumerable:!0}):n,t)),E=t=>p(o({},"__esModule",{value:!0}),t);var F={};S(F,{default:()=>a});module.exports=E(F);var d=f(require("fs"),1),w=f(require("istanbul-lib-report"),1);function R(t){return t.statements.pct===100&&t.branches.pct===100&&t.functions.pct===100&&t.lines.pct===100}function L(t){if(t.isSummary())return[];let e=t.getCoverageSummary(!1),r=e.isEmpty()?0:e.lines.pct,s,m=t.getFileCoverage();if(r===100){let i=m.getBranchCoverageByLine();s=Object.entries(i).map(([c,{coverage:u}])=>[c,u===100])}else s=Object.entries(m.getLineCoverage());let l=!0;return s.reduce((i,[c,u])=>{if(u)l=!0;else{let h=parseInt(c);l?(i.push([h]),l=!1):i[i.length-1][1]=h}return i},[])}var C=["Statements","Branches","Functions","Lines"],a=class extends w.ReportBase{skipEmpty;skipFull;results={};cw=null;watermarks=null;constructor(e){super(e),this.skipEmpty=!!e.skipEmpty,this.skipFull=!!e.skipFull}onStart(e,n){if(!process.env.GITHUB_STEP_SUMMARY){console.log("Reporter not being executed in Github Actions environment");return}this.cw=d.default.createWriteStream(process.env.GITHUB_STEP_SUMMARY,{encoding:"utf-8",flags:"a"}),this.watermarks=n.watermarks,this.cw.write("<h2>Test Coverage</h2>"),this.cw.write("<table><thead><tr>");for(let r of["File",...C,"Uncovered Lines"])this.cw.write(`<th>${r}</th>`);this.cw.write("</tr></thead><tbody>")}onSummary(e){let n=e.getRelativeName()||"All Files",r=e.getCoverageSummary(!1),s=r.isEmpty();this.skipEmpty&&s||this.skipFull&&R(r)||(this.results[n]={statements:s?0:r.statements.pct,branches:s?0:r.branches.pct,functions:s?0:r.functions.pct,lines:s?0:r.lines.pct,uncoveredLines:L(e)})}onDetail(e){return this.onSummary(e)}formatter(e,n){if(!this.watermarks||this.watermarks[n]===void 0)return`<td>${e}%</td>`;let[r,s]=this.watermarks[n];return e<r?`<td><p style="color:red">${e}%</p></td>`:e>s?`<td><p style="color:green">${e}%</p></td>`:`<td><p style="color:yellow">${e}%</p></td>`}onEnd(){if(!this.cw)return;let e=Object.keys(this.results).sort();for(let n of e){let r=this.results[n];if(this.cw.write(`<tr><td><code>${n}</code></td>`),this.cw.write(this.formatter(r.statements,"statements")),this.cw.write(this.formatter(r.branches,"branches")),this.cw.write(this.formatter(r.functions,"functions")),this.cw.write(this.formatter(r.lines,"lines")),r.uncoveredLines.length>0){this.cw.write("<td><details><summary>Expand</summary><ul>");for(let s of r.uncoveredLines)s.length===1?this.cw.write(`<li>${s[0]}</li>`):this.cw.write(`<li>${s[0]}-${s[1]}</li>`);this.cw.write("</ul></details></td>")}else this.cw.write("<td></td>");this.cw.write("</tr>")}this.cw.write("</tbody></table>"),this.cw.close()}};

lib/vitest-reporter/build/test-reporter.js

@@ -19,7 +19,8 @@
   },
   "scripts": {
     "build": "yarn build:coverage-reporter && yarn build:test-reporter",
-    "build:coverage-reporter": "esbuild --outfile=./build/coverage-reporter.cjs --format=cjs --bundle=true --minify --external:\"istanbul-lib-report\" --platform=node src/coverage-reporter.cts",
-    "build:test-reporter": "esbuild --outfile=./build/test-reporter.js --format=esm --bundle=true  --minify --external:\"vitest*\" --platform=node src/test-reporter.ts"
+    "build:coverage-reporter": "esbuild --outfile=./build/coverage-reporter.cjs --format=cjs --bundle=true --minify --external:\"istanbul-lib-report\" --platform=node src/coverage-reporter.ts",
+    "build:test-reporter": "esbuild --outfile=./build/test-reporter.js --format=esm --bundle=true  --minify --external:\"vitest*\" --platform=node src/test-reporter.ts",
+    "test": "vitest"
   }
 }

lib/vitest-reporter/package.json

@@ -0,0 +1,36 @@
+import fs from 'fs';
+import { describe, expect, it as baseIt, vi } from 'vitest';
+import CoverageReporter from '../coverage-reporter.js';
+
+vi.spyOn(fs, 'createWriteStream').mockReturnValue({
+  write: () => true,
+  close: () => {}
+} as any);
+
+describe(CoverageReporter, () => {
+  const it = baseIt.extend<{ reporter: CoverageReporter }>({
+    reporter: new CoverageReporter({})
+  });
+
+  it('opens the GITHUB_STEP_SUMMARY file in append mode', ({ reporter }) => {
+    try {
+      vi.stubEnv('GITHUB_STEP_SUMMARY', 'oh no');
+      reporter.onStart({} as any, { watermarks: {} } as any);
+
+      expect(fs.createWriteStream).toHaveBeenCalledExactlyOnceWith(
+        'oh no',
+        {
+          encoding: 'utf-8',
+          flags: 'a'
+        }
+      );
+    } finally {
+      vi.unstubAllEnvs();
+    }
+  });
+
+  it('doesn\'t open the summary file if GITHUB_STEP_SUMMARY isn\'t defined', ({ reporter }) => {
+    reporter.onStart({} as any, { watermarks: {} } as any);
+    expect(fs.createWriteStream).not.toHaveBeenCalled();
+  });
+});

lib/vitest-reporter/src/__tests__/coverage.test.ts

@@ -0,0 +1,33 @@
+import fs from 'fs';
+import { describe, expect, it as baseIt, vi } from 'vitest';
+import TestReporter from '../test-reporter.js';
+
+vi.spyOn(fs, 'createWriteStream').mockImplementation(() => ({
+  write: () => {},
+  close: () => {}
+} as any));
+
+describe(TestReporter, () => {
+  const it = baseIt.extend<{ reporter: TestReporter }>({
+    reporter: new TestReporter()
+  });
+
+  it('opens the summary file in append mode', ({ reporter }) => {
+    try {
+      vi.stubEnv('GITHUB_STEP_SUMMARY', 'oh no');
+      reporter.onInit();
+
+      expect(fs.createWriteStream).toHaveBeenCalledExactlyOnceWith(
+        'oh no',
+        { encoding: 'utf-8', flags: 'a' }
+      );
+    } finally {
+      vi.unstubAllEnvs();
+    }
+  });
+
+  it('doesn\'t open the summary file if GITHUB_STEP_SUMMARY isn\'t defined', ({ reporter }) => {
+    reporter.onInit();
+    expect(fs.createWriteStream).not.toHaveBeenCalled();
+  });
+});

lib/vitest-reporter/src/__tests__/test-reporter.test.ts

@@ -1,15 +1,12 @@
 /**
- * For whatever reason, this reporter doesn't really work if its written in ESM,
- * so its written in and compiled to CJS
+ * For whatever reason, this reporter doesn't really work if its compiled to ESM
+ * so its compiled to CJS
  *
  * Heavily based on the default text reporter
  */
-import type fslib from 'fs';
+import fs from 'fs';
 import type { CoverageSummary } from 'istanbul-lib-coverage';
-import type * as report from 'istanbul-lib-report';
-
-const fs: typeof fslib = require('fs');
-const { ReportBase }: typeof report = require('istanbul-lib-report');
+import * as report from 'istanbul-lib-report';
 
 /**
  * Determines if the coverage summary has full coverage
@@ -62,30 +59,30 @@ function getUncoveredLines(node: report.ReportNode) {
     }
 
     return acum;
-  }, [])
+  }, []);
 
-  return ranges
+  return ranges;
 }
 
-const headers = ['Statements', 'Branches', 'Functions', 'Lines']
+const headers = ['Statements', 'Branches', 'Functions', 'Lines'];
 
 interface ResultObject {
-  branches: number
-  functions: number
-  lines: number
-  statements: number
-  uncoveredLines: ([number] | [number, number])[]
+  branches: number;
+  functions: number;
+  lines: number;
+  statements: number;
+  uncoveredLines: ([number] | [number, number])[];
 }
 
 /**
  * A Vitest coverage reporter that writes to the Github Actions summary
  */
-module.exports = class GithubActionsCoverageReporter extends ReportBase {
+export default class GithubActionsCoverageReporter extends report.ReportBase {
   private readonly skipEmpty: boolean;
   private readonly skipFull: boolean;
   private readonly results: Record<string, ResultObject> = {};
-  private cw: fslib.WriteStream | null = null;
-  private watermarks: report.Watermarks | null = null;
+  private cw: fs.WriteStream | null = null;
+  private watermarks: Partial<report.Watermarks> | null = null;
 
   constructor(opts: any) {
     super(opts);
@@ -94,16 +91,16 @@ module.exports = class GithubActionsCoverageReporter extends ReportBase {
     this.skipFull = Boolean(opts.skipFull);
   }
 
-  onStart(_node: any, context: report.Context) {
+  onStart(_node: any, context: report.ContextOptions) {
     if (!process.env.GITHUB_STEP_SUMMARY) {
-      console.log('Reporter not being executed in Github Actions environment')
+      console.log('Reporter not being executed in Github Actions environment');
       return;
     }
 
-    this.cw = fs.createWriteStream(process.env.GITHUB_STEP_SUMMARY, { encoding: 'utf-8', flags: 'a' })
+    this.cw = fs.createWriteStream(process.env.GITHUB_STEP_SUMMARY, { encoding: 'utf-8', flags: 'a' });
 
     this.watermarks = context.watermarks;
-    this.cw.write('<h2>Test Coverage</h2>')
+    this.cw.write('<h2>Test Coverage</h2>');
     this.cw.write('<table><thead><tr>');
     for (const heading of ['File', ...headers, 'Uncovered Lines']) {
       this.cw.write(`<th>${heading}</th>`);
@@ -129,26 +126,26 @@ module.exports = class GithubActionsCoverageReporter extends ReportBase {
       functions: isEmpty ? 0 : rawMetrics.functions.pct,
       lines: isEmpty ? 0 : rawMetrics.lines.pct,
       uncoveredLines: getUncoveredLines(node),
-    }
+    };
   }
 
   onDetail(node: report.ReportNode) {
     return this.onSummary(node);
   }
 
   private formatter(pct: number, watermark: keyof report.Watermarks) {
-    if (!this.watermarks) return `<td>${pct}%</td>`
+    if (!this.watermarks || this.watermarks[watermark] === undefined) return `<td>${pct}%</td>`;
     const [low, high] = this.watermarks[watermark];
 
     if (pct < low) {
-      return `<td><p style="color:red">${pct}%</p></td>`
+      return `<td><p style="color:red">${pct}%</p></td>`;
     }
 
     if (pct > high) {
-      return `<td><p style="color:green">${pct}%</p></td>`
+      return `<td><p style="color:green">${pct}%</p></td>`;
     }
 
-    return `<td><p style="color:yellow">${pct}%</p></td>`
+    return `<td><p style="color:yellow">${pct}%</p></td>`;
   }
 
   onEnd() {
@@ -168,9 +165,9 @@ module.exports = class GithubActionsCoverageReporter extends ReportBase {
         this.cw.write('<td><details><summary>Expand</summary><ul>');
         for (const range of metrics.uncoveredLines) {
           if (range.length === 1) {
-            this.cw.write(`<li>${range[0]}</li>`)
+            this.cw.write(`<li>${range[0]}</li>`);
           } else {
-            this.cw.write(`<li>${range[0]}-${range[1]}</li>`)
+            this.cw.write(`<li>${range[0]}-${range[1]}</li>`);
           }
         }
         this.cw.write('</ul></details></td>');

lib/vitest-reporter/src/coverage-reporter.cts renamed to lib/vitest-reporter/src/coverage-reporter.ts

@@ -35,6 +35,10 @@ function* formatTestSuite(suite: TestSuite): Generator<string> {
   yield '</ul>\n';
 }
 
+function getIcon(passed: boolean) {
+  return passed ? '✅' : '❌';
+}
+
 function formatRow(...items: string[]) {
   const tds = items.map(item => `<td>${item}</td>`);
   return `<tr>${tds.join('')}</tr>\n`;
@@ -86,7 +90,7 @@ export default class GithubActionsSummaryReporter implements Reporter {
       const [passCount, failCount] = getTestCount(testModule);
       const testCount = passCount + failCount;
 
-      this.writeStream.write(`<h3>${passed ? '✅' : '❌'} <code>${relpath}</code> (${testCount} test${testCount === 1 ? '' : 's'})</h3>\n`);
+      this.writeStream.write(`<h3>${getIcon(passed)} <code>${relpath}</code> (${testCount} test${testCount === 1 ? '' : 's'})</h3>\n`);
 
       this.writeStream.write('<ul>');
       for (const child of testModule.children) {

lib/vitest-reporter/src/test-reporter.ts

@@ -0,0 +1,18 @@
+// @ts-check
+// vitest-reporter vitest config
+import { defineConfig } from 'vitest/config';
+import rootConfig from '../../vitest.config.js';
+
+export default defineConfig({
+  optimizeDeps: {
+    include: ['istanbul-lib-report'],
+  },
+  test: {
+    ...rootConfig.test,
+    projects: undefined,
+
+    name: 'Vitest Reporters',
+    root: import.meta.dirname,
+    include: ['src/**/__tests__/*.test.{ts,tsx}'],
+  }
+});