From 1bf27f0dde6b8ea867d3343338f38b0e0a7c4ebb Mon Sep 17 00:00:00 2001
From: Jacob Erdman <56931564+jacoberdman2147@users.noreply.github.com>
Date: Mon, 9 Dec 2024 02:28:04 -0800
Subject: [PATCH] feat(ui): Make clicking on a test in the UI open the report
 section and scroll to the test failure if applicable (#6900)

---
 packages/ui/client/auto-imports.d.ts          |  2 ++
 packages/ui/client/components/Navigation.vue  |  4 +--
 .../components/explorer/ExplorerItem.vue      |  1 +
 .../ui/client/components/views/ViewReport.vue | 15 +++++++++-
 packages/ui/client/composables/codemirror.ts  |  7 ++++-
 packages/ui/client/composables/navigation.ts  | 29 +++++++++++--------
 packages/ui/client/composables/params.ts      |  3 ++
 7 files changed, 45 insertions(+), 16 deletions(-)

diff --git a/packages/ui/client/auto-imports.d.ts b/packages/ui/client/auto-imports.d.ts
index 620c0ef2bd39..e5a11a01d5a7 100644
--- a/packages/ui/client/auto-imports.d.ts
+++ b/packages/ui/client/auto-imports.d.ts
@@ -118,6 +118,7 @@ declare global {
   const resolveComponent: typeof import('vue')['resolveComponent']
   const resolveRef: typeof import('@vueuse/core')['resolveRef']
   const resolveUnref: typeof import('@vueuse/core')['resolveUnref']
+  const selectedTest: typeof import('./composables/params')['selectedTest']
   const setIframeViewport: typeof import('./composables/api')['setIframeViewport']
   const shallowReactive: typeof import('vue')['shallowReactive']
   const shallowReadonly: typeof import('vue')['shallowReadonly']
@@ -127,6 +128,7 @@ declare global {
   const showDashboard: typeof import('./composables/navigation')['showDashboard']
   const showLine: typeof import('./composables/codemirror')['showLine']
   const showNavigationPanel: typeof import('./composables/navigation')['showNavigationPanel']
+  const showReport: typeof import('./composables/navigation')['showReport']
   const showRightPanel: typeof import('./composables/navigation')['showRightPanel']
   const showSource: typeof import('./composables/codemirror')['showSource']
   const syncRef: typeof import('@vueuse/core')['syncRef']
diff --git a/packages/ui/client/components/Navigation.vue b/packages/ui/client/components/Navigation.vue
index 8bb8af54fd96..1c4abd735ba7 100644
--- a/packages/ui/client/components/Navigation.vue
+++ b/packages/ui/client/components/Navigation.vue
@@ -11,9 +11,9 @@ import {
   coverageVisible,
   dashboardVisible,
   disableCoverage,
-  navigateTo,
   showCoverage,
   showDashboard,
+  showReport,
 } from '~/composables/navigation'
 
 function updateSnapshot() {
@@ -50,7 +50,7 @@ function expandTests() {
 
 <template>
   <!-- TODO: have test tree so the folders are also nested: test -> filename -> suite -> test -->
-  <Explorer border="r base" :on-item-click="navigateTo" :nested="true" @run="onRunAll">
+  <Explorer border="r base" :on-item-click="showReport" :nested="true" @run="onRunAll">
     <template #header="{ filteredFiles }">
       <img w-6 h-6 src="/favicon.svg" alt="Vitest logo">
       <span font-light text-sm flex-1>Vitest</span>
diff --git a/packages/ui/client/components/explorer/ExplorerItem.vue b/packages/ui/client/components/explorer/ExplorerItem.vue
index 7a35f10b4e22..455f05506bd5 100644
--- a/packages/ui/client/components/explorer/ExplorerItem.vue
+++ b/packages/ui/client/components/explorer/ExplorerItem.vue
@@ -57,6 +57,7 @@ const failedSnapshot = computed(() => {
 
 function toggleOpen() {
   if (!expandable) {
+    onItemClick?.(task.value!)
     return
   }
 
diff --git a/packages/ui/client/components/views/ViewReport.vue b/packages/ui/client/components/views/ViewReport.vue
index d3fdc802bdea..60f1db5e0f7e 100644
--- a/packages/ui/client/components/views/ViewReport.vue
+++ b/packages/ui/client/components/views/ViewReport.vue
@@ -4,6 +4,7 @@ import type { ErrorWithDiff, File, Suite, Task } from 'vitest'
 import { browserState, config } from '~/composables/client'
 import { isDark } from '~/composables/dark'
 import { createAnsiToHtmlFilter } from '~/composables/error'
+import { selectedTest } from '~/composables/params'
 import { escapeHtml } from '~/utils/escape'
 
 const props = defineProps<{
@@ -127,12 +128,24 @@ function showScreenshotModal(task: Task) {
   timestamp.value = Date.now()
   showScreenshot.value = true
 }
+
+watch(() => [selectedTest.value] as const, ([test]) => {
+  if (test != null) {
+    // Have to wrap the selector in [id=''] since #{test} will produce an invalid selector because the test ID is a number
+    const testElement = document.querySelector(`[id='${test}'`)
+    if (testElement != null) {
+      nextTick(() => {
+        testElement.scrollIntoView()
+      })
+    }
+  }
+}, { flush: 'post' })
 </script>
 
 <template>
   <div h-full class="scrolls">
     <template v-if="failed.length">
-      <div v-for="task of failed" :key="task.id">
+      <div v-for="task of failed" :id="task.id" :key="task.id">
         <div
           bg="red-500/10"
           text="red-500 sm"
diff --git a/packages/ui/client/composables/codemirror.ts b/packages/ui/client/composables/codemirror.ts
index 46c9ad1a3ef5..2c3386e9078e 100644
--- a/packages/ui/client/composables/codemirror.ts
+++ b/packages/ui/client/composables/codemirror.ts
@@ -62,5 +62,10 @@ export function useCodeMirror(
 }
 
 export async function showSource(task: Task) {
-  navigateTo(task, task.location?.line ?? 0)
+  navigateTo({
+    file: task.file.id,
+    line: task.location?.line ?? 0,
+    view: 'editor',
+    test: null,
+  })
 }
diff --git a/packages/ui/client/composables/navigation.ts b/packages/ui/client/composables/navigation.ts
index 3b2fb233e937..dfc17a5627a7 100644
--- a/packages/ui/client/composables/navigation.ts
+++ b/packages/ui/client/composables/navigation.ts
@@ -1,7 +1,8 @@
 import type { File, Task } from '@vitest/runner'
+import type { Params } from './params'
 import { client, config, findById } from './client'
 import { testRunState } from './client/state'
-import { activeFileId, lineNumber, viewMode } from './params'
+import { activeFileId, lineNumber, selectedTest, viewMode } from './params'
 
 export const currentModule = ref<File>()
 export const dashboardVisible = ref(true)
@@ -99,20 +100,24 @@ export function showDashboard(show: boolean) {
   }
 }
 
-export function navigateTo(task: Task, line: number | null = null) {
-  activeFileId.value = task.file.id
-  // reset line number
-  lineNumber.value = null
-  if (line != null) {
-    nextTick(() => {
-      lineNumber.value = line
-    })
-    viewMode.value = 'editor'
-  }
-  currentModule.value = findById(task.file.id)
+export function navigateTo({ file, line, view, test }: Params) {
+  activeFileId.value = file
+  lineNumber.value = line
+  viewMode.value = view
+  selectedTest.value = test
+  currentModule.value = findById(file)
   showDashboard(false)
 }
 
+export function showReport(task: Task) {
+  navigateTo({
+    file: task.file.id,
+    test: task.type === 'test' ? task.id : null,
+    line: null,
+    view: null,
+  })
+}
+
 export function showCoverage() {
   coverageVisible.value = true
   dashboardVisible.value = false
diff --git a/packages/ui/client/composables/params.ts b/packages/ui/client/composables/params.ts
index 07218439a374..ceaecb9f93e0 100644
--- a/packages/ui/client/composables/params.ts
+++ b/packages/ui/client/composables/params.ts
@@ -2,6 +2,7 @@ export interface Params {
   file: string
   view: null | 'graph' | 'editor' | 'console'
   line: null | number
+  test: null | string
 }
 
 export const params = useUrlSearchParams<Params>('hash', {
@@ -9,9 +10,11 @@ export const params = useUrlSearchParams<Params>('hash', {
     file: '',
     view: null,
     line: null,
+    test: null,
   },
 })
 
 export const activeFileId = toRef(params, 'file')
 export const viewMode = toRef(params, 'view')
 export const lineNumber = toRef(params, 'line')
+export const selectedTest = toRef(params, 'test')