fix(ui): auto reload coverage iframe after test run (#5242)

hi-ogawa · web-flow · commit 5376d5be3e43 · 2024-02-20T14:05:16.000+01:00
diff --git a/packages/ui/client/composables/client/index.ts b/packages/ui/client/composables/client/index.ts
@@ -29,6 +29,12 @@ export const client = (function createVitestClient() {
           testRunState.value = 'idle'
           unhandledErrors.value = (errors || []).map(parseError)
         },
+        onFinishedReportCoverage() {
+          // reload coverage iframe
+          const iframe = document.querySelector('iframe#vitest-ui-coverage')
+          if (iframe instanceof HTMLIFrameElement && iframe.contentWindow)
+            iframe.contentWindow.location.reload()
+        },
       },
     })
   }
diff --git a/packages/vitest/src/api/setup.ts b/packages/vitest/src/api/setup.ts
@@ -162,7 +162,7 @@ export function setup(vitestOrWorkspace: Vitest | WorkspaceProject, _server?: Vi
       {
         post: msg => ws.send(msg),
         on: fn => ws.on('message', fn),
-        eventNames: ['onUserConsoleLog', 'onFinished', 'onCollected', 'onCancel'],
+        eventNames: ['onUserConsoleLog', 'onFinished', 'onFinishedReportCoverage', 'onCollected', 'onCancel'],
         serialize: (data: any) => stringify(data, stringifyReplace),
         deserialize: parse,
         onTimeoutError(functionName) {
@@ -183,7 +183,7 @@ export function setup(vitestOrWorkspace: Vitest | WorkspaceProject, _server?: Vi
   ctx.reporters.push(new WebSocketReporter(ctx, wss, clients))
 }
 
-class WebSocketReporter implements Reporter {
+export class WebSocketReporter implements Reporter {
   constructor(
     public ctx: Vitest,
     public wss: WebSocketServer,
@@ -226,6 +226,12 @@ class WebSocketReporter implements Reporter {
     })
   }
 
+  onFinishedReportCoverage() {
+    this.clients.forEach((client) => {
+      client.onFinishedReportCoverage?.()
+    })
+  }
+
   onUserConsoleLog(log: UserConsoleLog) {
     this.clients.forEach((client) => {
       client.onUserConsoleLog?.(log)
diff --git a/packages/vitest/src/api/types.ts b/packages/vitest/src/api/types.ts
@@ -39,4 +39,5 @@ export interface WebSocketHandlers {
 
 export interface WebSocketEvents extends Pick<Reporter, 'onCollected' | 'onFinished' | 'onTaskUpdate' | 'onUserConsoleLog' | 'onPathsCollected'> {
   onCancel: (reason: CancelReason) => void
+  onFinishedReportCoverage: () => void
 }
diff --git a/packages/vitest/src/node/core.ts b/packages/vitest/src/node/core.ts
@@ -16,6 +16,7 @@ import { getCoverageProvider } from '../integrations/coverage'
 import type { BrowserProvider } from '../types/browser'
 import { CONFIG_NAMES, configFiles, workspacesFiles as workspaceFiles } from '../constants'
 import { rootDir } from '../paths'
+import { WebSocketReporter } from '../api/setup'
 import { createPool } from './pool'
 import type { ProcessPool, WorkspaceSpec } from './pool'
 import { createBenchmarkReporters, createReporters } from './reporters/utils'
@@ -800,8 +801,14 @@ export class Vitest {
     if (!this.config.coverage.reportOnFailure && this.state.getCountOfFailedTests() > 0)
       return
 
-    if (this.coverageProvider)
+    if (this.coverageProvider) {
       await this.coverageProvider.reportCoverage({ allTestsRun })
+      // notify coverage iframe reload
+      for (const reporter of this.reporters) {
+        if (reporter instanceof WebSocketReporter)
+          reporter.onFinishedReportCoverage()
+      }
+    }
   }
 
   async close() {
diff --git a/packages/ws-client/src/index.ts b/packages/ws-client/src/index.ts
@@ -70,6 +70,9 @@ export function createClient(url: string, options: VitestClientOptions = {}) {
     onFinished(files, errors) {
       handlers.onFinished?.(files, errors)
     },
+    onFinishedReportCoverage() {
+      handlers.onFinishedReportCoverage?.()
+    },
     onCancel(reason: CancelReason) {
       handlers.onCancel?.(reason)
     },

Original file line number	Diff line number	Diff line change
`@@ -39,4 +39,5 @@ export interface WebSocketHandlers {`
`39`	`39`
`40`	`40`	`export interface WebSocketEvents extends Pick<Reporter, 'onCollected' \| 'onFinished' \| 'onTaskUpdate' \| 'onUserConsoleLog' \| 'onPathsCollected'> {`
`41`	`41`	`onCancel: (reason: CancelReason) => void`
	`42`	`+ onFinishedReportCoverage: () => void`
`42`	`43`	`}`