From b117e87562bd2391fd7f34e8589d0b5e6c03c305 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Joaqu=C3=ADn=20S=C3=A1nchez?= <userquin@gmail.com>
Date: Thu, 6 Jun 2024 15:39:44 +0200
Subject: [PATCH] feat(ui): load module graph on tab selection (#5844)

---
 packages/ui/client/components/FileDetails.vue | 80 ++++++++++++++-----
 packages/ui/client/components/Navigation.vue  | 12 +--
 packages/ui/client/components/ProgressBar.vue |  4 +-
 .../components/dashboard/DashboardEntry.vue   |  2 +-
 .../components/dashboard/ErrorEntry.vue       |  8 +-
 .../components/dashboard/TestFilesEntry.vue   |  4 +-
 .../components/dashboard/TestsEntry.vue       |  2 +-
 .../ui/client/components/views/ViewEditor.vue |  2 +-
 .../components/views/ViewReportError.vue      |  2 +-
 packages/ui/client/pages/index.vue            |  8 +-
 10 files changed, 82 insertions(+), 42 deletions(-)

diff --git a/packages/ui/client/components/FileDetails.vue b/packages/ui/client/components/FileDetails.vue
index 7cfd5f016067..8257db40f405 100644
--- a/packages/ui/client/components/FileDetails.vue
+++ b/packages/ui/client/components/FileDetails.vue
@@ -1,28 +1,27 @@
 <script setup lang="ts">
-import type { ModuleGraphData } from 'vitest'
 import { client, current, currentLogs, isReport, browserState, config } from '~/composables/client'
 import type { Params } from '~/composables/params'
 import { viewMode } from '~/composables/params'
 import type { ModuleGraph } from '~/composables/module-graph'
 import { getModuleGraph } from '~/composables/module-graph'
-import { getProjectNameColor } from '~/utils/task';
+import { getProjectNameColor } from '~/utils/task'
 
-const data = ref<ModuleGraphData>({ externalized: [], graph: {}, inlined: [] })
 const graph = ref<ModuleGraph>({ nodes: [], links: [] })
 const draft = ref(false)
 const hasGraphBeenDisplayed = ref(false)
+const loadingModuleGraph = ref(false)
+const currentFilepath = ref<string | undefined>(undefined)
 
-debouncedWatch(
-  current,
-  async (c, o) => {
-    if (c && c.filepath !== o?.filepath) {
-      const project = c.file.projectName || ''
-      data.value = await client.rpc.getModuleGraph(project, c.filepath, !!browserState)
-      graph.value = getModuleGraph(data.value, c.filepath)
-    }
-  },
-  { debounce: 100, immediate: true },
-)
+const graphData = computed(() => {
+  const c = current.value
+  if (!c || !c.filepath)
+    return
+
+  return {
+    filepath: c.filepath,
+    projectName: c.file.projectName || '',
+  }
+})
 
 function open() {
   const filePath = current.value?.filepath
@@ -44,12 +43,42 @@ function onDraft(value: boolean) {
   draft.value = value
 }
 
-function relativeToRoot(path?: string) {
-  if (!path) return ''
-  if (path.startsWith(config.root))
-    return path.slice(config.root.length)
-  return path
+async function loadModuleGraph() {
+  if (loadingModuleGraph.value || graphData.value?.filepath === currentFilepath.value)
+    return
+
+  loadingModuleGraph.value = true
+
+  await nextTick()
+
+  try {
+    const gd = graphData.value
+    if (!gd)
+      return
+
+    if (!currentFilepath.value || gd.filepath !== currentFilepath.value || (!graph.value.nodes.length && !graph.value.links.length)) {
+      graph.value = getModuleGraph(
+        await client.rpc.getModuleGraph(gd.projectName, gd.filepath, !!browserState),
+        gd.filepath,
+      )
+      currentFilepath.value = gd.filepath
+    }
+    changeViewMode('graph')
+  }
+  finally {
+    await new Promise(resolve => setTimeout(resolve, 100))
+    loadingModuleGraph.value = false
+  }
 }
+
+debouncedWatch(
+  () => [graphData.value, viewMode.value] as const,
+  ([, vm]) => {
+    if (vm === 'graph')
+      loadModuleGraph()
+  },
+  { debounce: 100, immediate: true },
+)
 </script>
 
 <template>
@@ -61,7 +90,7 @@ function relativeToRoot(path?: string) {
           [{{ current?.file.projectName || '' }}]
         </div>
         <div flex-1 font-light op-50 ws-nowrap truncate text-sm>
-          {{ relativeToRoot(current?.filepath) }}
+          {{ current?.name }}
         </div>
         <div class="flex text-lg">
           <IconButton
@@ -77,35 +106,44 @@ function relativeToRoot(path?: string) {
       <div flex="~" items-center bg-header border="b-2 base" text-sm h-41px>
         <button
           tab-button
+          class="flex items-center gap-2"
           :class="{ 'tab-button-active': viewMode == null }"
           data-testid="btn-report"
           @click="changeViewMode(null)"
         >
+          <span class="block  w-1.4em h-1.4em i-carbon:report"></span>
           Report
         </button>
         <button
           tab-button
           data-testid="btn-graph"
+          class="flex items-center gap-2"
           :class="{ 'tab-button-active': viewMode === 'graph' }"
           @click="changeViewMode('graph')"
         >
+          <span v-if="loadingModuleGraph" class="block w-1.4em h-1.4em i-carbon:circle-dash animate-spin animate-2s"></span>
+          <span v-else class="block  w-1.4em h-1.4em i-carbon:chart-relationship"></span>
           Module Graph
         </button>
         <button
           v-if="!isReport"
           tab-button
           data-testid="btn-code"
+          class="flex items-center gap-2"
           :class="{ 'tab-button-active': viewMode === 'editor' }"
           @click="changeViewMode('editor')"
         >
+          <span class="block w-1.4em h-1.4em i-carbon:code"></span>
           {{ draft ? '*&#160;' : '' }}Code
         </button>
         <button
           tab-button
           data-testid="btn-console"
+          class="flex items-center gap-2"
           :class="{ 'tab-button-active': viewMode === 'console', 'op20': viewMode !== 'console' && consoleCount === 0 }"
           @click="changeViewMode('console')"
         >
+          <span class="block w-1.4em h-1.4em i-carbon:terminal-3270"></span>
           Console ({{ consoleCount }})
         </button>
       </div>
@@ -113,7 +151,7 @@ function relativeToRoot(path?: string) {
 
     <div flex flex-col flex-1 overflow="hidden">
       <div v-if="hasGraphBeenDisplayed" :flex-1="viewMode === 'graph' && ''">
-        <ViewModuleGraph v-show="viewMode === 'graph'" :graph="graph" data-testid="graph" :project-name="current.file.projectName || ''" />
+        <ViewModuleGraph v-show="viewMode === 'graph' && !loadingModuleGraph" :graph="graph" data-testid="graph" :project-name="current.file.projectName || ''" />
       </div>
       <ViewEditor v-if="viewMode === 'editor'" :key="current.filepath" :file="current" data-testid="editor" @draft="onDraft" />
       <ViewConsoleOutput v-else-if="viewMode === 'console'" :file="current" data-testid="console" />
diff --git a/packages/ui/client/components/Navigation.vue b/packages/ui/client/components/Navigation.vue
index 95070726a8ec..6fe2a8ee1af4 100644
--- a/packages/ui/client/components/Navigation.vue
+++ b/packages/ui/client/components/Navigation.vue
@@ -11,8 +11,8 @@ import {
   disableCoverage,
   showCoverage,
   showDashboard,
-} from '../composables/navigation'
-import { client, findById } from '../composables/client'
+} from '~/composables/navigation'
+import { client, findById } from '~/composables/client'
 import { isDark, toggleDark } from '~/composables'
 import { files, isReport, runAll } from '~/composables/client'
 import { activeFileId } from '~/composables/params'
@@ -63,18 +63,18 @@ function expandTests() {
       <img w-6 h-6 src="/favicon.svg" alt="Vitest logo">
       <span font-light text-sm flex-1>Vitest</span>
       <div class="flex text-lg">
-        <IconButton 
+        <IconButton
           v-show="openedTreeItems.length > 0"
           v-tooltip.bottom="'Collapse tests'"
           title="Collapse tests"
-          icon="i-carbon:collapse-all" 
+          icon="i-carbon:collapse-all"
           @click="collapseTests()"
         />
-        <IconButton 
+        <IconButton
           v-show="openedTreeItems.length === 0"
           v-tooltip.bottom="'Expand tests'"
           title="Expand tests"
-          icon="i-carbon:expand-all" 
+          icon="i-carbon:expand-all"
           @click="expandTests()"
         />
         <IconButton
diff --git a/packages/ui/client/components/ProgressBar.vue b/packages/ui/client/components/ProgressBar.vue
index fa8e0a5a75cd..032db4dd5f3a 100644
--- a/packages/ui/client/components/ProgressBar.vue
+++ b/packages/ui/client/components/ProgressBar.vue
@@ -1,6 +1,6 @@
 <script setup lang="ts">
-import { files } from '../composables/client'
-import { filesFailed, filesSuccess, finished } from '../composables/summary'
+import { files } from '~/composables/client'
+import { filesFailed, filesSuccess, finished } from '~/composables/summary'
 
 const { width } = useWindowSize()
 const classes = computed(() => {
diff --git a/packages/ui/client/components/dashboard/DashboardEntry.vue b/packages/ui/client/components/dashboard/DashboardEntry.vue
index 1fd4adae8ed7..e672bed07c27 100644
--- a/packages/ui/client/components/dashboard/DashboardEntry.vue
+++ b/packages/ui/client/components/dashboard/DashboardEntry.vue
@@ -1,5 +1,5 @@
 <script setup lang="ts">
-withDefaults(defineProps<{ tail?: boolean }>(), { tail: false })
+// const { tail = false } = defineProps<{ tail?: boolean }>()
 </script>
 
 <template>
diff --git a/packages/ui/client/components/dashboard/ErrorEntry.vue b/packages/ui/client/components/dashboard/ErrorEntry.vue
index 59cf0340b6b6..e9a0815c3d7e 100644
--- a/packages/ui/client/components/dashboard/ErrorEntry.vue
+++ b/packages/ui/client/components/dashboard/ErrorEntry.vue
@@ -1,7 +1,9 @@
 <script setup lang="ts">
-  const props = defineProps<{
-    error: ErrorWithDiff
-  }>()
+import type { ErrorWithDiff } from '@vitest/utils'
+
+defineProps<{
+  error: ErrorWithDiff
+}>()
 </script>
 
 <template>
diff --git a/packages/ui/client/components/dashboard/TestFilesEntry.vue b/packages/ui/client/components/dashboard/TestFilesEntry.vue
index 27774b14151d..1c371883cba9 100644
--- a/packages/ui/client/components/dashboard/TestFilesEntry.vue
+++ b/packages/ui/client/components/dashboard/TestFilesEntry.vue
@@ -1,6 +1,6 @@
 <script setup lang="ts">
-import { files, unhandledErrors } from '../../composables/client'
-import { filesFailed, filesSnapshotFailed, filesSuccess, time } from '../../composables/summary'
+import { files, unhandledErrors } from '~/composables/client'
+import { filesFailed, filesSnapshotFailed, filesSuccess, time } from '~/composables/summary'
 </script>
 
 <template>
diff --git a/packages/ui/client/components/dashboard/TestsEntry.vue b/packages/ui/client/components/dashboard/TestsEntry.vue
index 1be97d0a004c..f2362cfb8a8a 100644
--- a/packages/ui/client/components/dashboard/TestsEntry.vue
+++ b/packages/ui/client/components/dashboard/TestsEntry.vue
@@ -1,5 +1,5 @@
 <script setup lang="ts">
-import { tests, testsFailed, testsSkipped, testsSuccess, testsTodo } from '../../composables/summary'
+import { tests, testsFailed, testsSkipped, testsSuccess, testsTodo } from '~/composables/summary'
 
 const total = computed(() => tests.value.length)
 const pass = computed(() => testsSuccess.value.length)
diff --git a/packages/ui/client/components/views/ViewEditor.vue b/packages/ui/client/components/views/ViewEditor.vue
index b0dcffe7ea0f..564c520f6ca2 100644
--- a/packages/ui/client/components/views/ViewEditor.vue
+++ b/packages/ui/client/components/views/ViewEditor.vue
@@ -3,7 +3,7 @@
 import type CodeMirror from 'codemirror'
 import type { ErrorWithDiff, File } from 'vitest'
 import { createTooltip, destroyTooltip } from 'floating-vue'
-import { openInEditor } from '../../composables/error'
+import { openInEditor } from '~/composables/error'
 import { client } from '~/composables/client'
 
 const props = defineProps<{
diff --git a/packages/ui/client/components/views/ViewReportError.vue b/packages/ui/client/components/views/ViewReportError.vue
index 5a1de0a9fe2c..645637b71458 100644
--- a/packages/ui/client/components/views/ViewReportError.vue
+++ b/packages/ui/client/components/views/ViewReportError.vue
@@ -1,7 +1,7 @@
 <script setup lang="ts">
 import type { ErrorWithDiff } from 'vitest'
 import { openInEditor, shouldOpenInEditor } from '~/composables/error'
-import { escapeHtml } from '~/utils/escape';
+import { escapeHtml } from '~/utils/escape'
 
 const props = defineProps<{
   root: string
diff --git a/packages/ui/client/pages/index.vue b/packages/ui/client/pages/index.vue
index 8a4f5f52fdba..7f48ef3440e9 100644
--- a/packages/ui/client/pages/index.vue
+++ b/packages/ui/client/pages/index.vue
@@ -39,19 +39,19 @@ function resizeMain() {
         <Navigation />
       </Pane>
       <Pane :size="mainSizes[1]">
-        <transition v-if="!browserState">
+        <transition v-if="!browserState" key="ui-detail">
           <Dashboard v-if="dashboardVisible" key="summary" />
           <Coverage v-else-if="coverageVisible" key="coverage" :src="coverageUrl" />
-          <FileDetails v-else />
+          <FileDetails v-else key="details" />
         </transition>
-        <Splitpanes v-else key="detail" id="details-splitpanes" @resize="onBrowserPanelResizing(true)" @resized="onModuleResized">
+        <Splitpanes v-else key="browser-detail" id="details-splitpanes" @resize="onBrowserPanelResizing(true)" @resized="onModuleResized">
           <Pane :size="detailSizes[0]" min-size="10">
             <BrowserIframe v-once />
           </Pane>
           <Pane :size="detailSizes[1]" min-size="5">
             <Dashboard v-if="dashboardVisible" key="summary" />
             <Coverage v-else-if="coverageVisible" key="coverage" :src="coverageUrl" />
-            <FileDetails v-else />
+            <FileDetails v-else key="details" />
           </Pane>
         </Splitpanes>
       </Pane>