fix(dev): various 🐰

Author: danielroe

capture/captures.config.ts

@@ -1,5 +1,5 @@
 import type { PtySession } from './lib/pty.ts'
-import { readFileSync, rmSync, symlinkSync, writeFileSync } from 'node:fs'
+import { lstatSync, readFileSync, renameSync, rmSync, symlinkSync, writeFileSync } from 'node:fs'
 import { dirname, join } from 'node:path'
 import process from 'node:process'
 import { fileURLToPath } from 'node:url'
@@ -140,9 +140,22 @@ export const captures: Capture[] = [
 
       // `installNuxtModule` runs the *project's* `@nuxt/cli` in-process, which
       // the fixture installed from the registry; the capture should show the
-      // build under test, so the project copy is pointed at it.
+      // build under test, so the project copy is pointed at it for the
+      // recording and put back afterwards. A symlink found here is residue of
+      // an interrupted run, with nothing behind it to preserve.
       const projectCli = join(cwd, 'node_modules/@nuxt/cli')
-      rmSync(projectCli, { recursive: true, force: true })
+      const savedCli = `${projectCli}.original`
+      if (lstatSync(savedCli, { throwIfNoEntry: false })) {
+        rmSync(projectCli, { recursive: true, force: true })
+        renameSync(savedCli, projectCli)
+      }
+      const installed = lstatSync(projectCli, { throwIfNoEntry: false })
+      if (installed?.isSymbolicLink()) {
+        rmSync(projectCli, { force: true })
+      }
+      else if (installed) {
+        renameSync(projectCli, savedCli)
+      }
       symlinkSync(dirname(dirname(bin)), projectCli, 'dir')
 
       try {
@@ -168,6 +181,10 @@ export const captures: Capture[] = [
           writeFileSync(file, text)
         }
         rmSync(join(cwd, 'node_modules/@nuxt/scripts'), { recursive: true, force: true })
+        rmSync(projectCli, { force: true })
+        if (lstatSync(savedCli, { throwIfNoEntry: false })) {
+          renameSync(savedCli, projectCli)
+        }
       }
     },
   },

capture/output/nuxt-dev-install-module.svg

@@ -1,8 +1,6 @@
-styles: 47b4eb73fea90d67
-   Local     http://localhost:3000/
-   Local     http://localhost:3000/ ⠋
-   Network   http://192.168.1.10:3000/
-   Network   http://192.168.1.10:3000/ ⠋
+styles: eba055abc05015cd
+   Local   http://localhost:3000/
+   Local   http://localhost:3000/ ⠋
    waiting for requests
    ━━━━━━━━━━━━━━━━━━━━ 0% · 42 ms
    ━━━━━━━━━━━━━━━━━━━━ 17% · 42 ms

capture/output/nuxt-dev-install-module.txt

@@ -1,8 +1,9 @@
-styles: 4eeca6108c97ac69
+styles: e92e0d98f3b543db
   press h + enter to see available shortcuts
   ➜ DevTools: press Shift + Alt + D in the browser (x.y.z)
   ➜ Local:    http://localhost:3000/
   ➜ Network:  use --host to expose
+ℹ Re-optimizing dependencies because vite config has changed
 ℹ Vite client warmed up in 42 ms
 ℹ Vite server warmed up in 42 ms
 │

capture/output/nuxt-dev-plain.svg

@@ -371,6 +371,9 @@ export function setupDevUI(context: ShortcutContext, options: DevUIOptions = {})
 
   let detach = attachKeys(onKey)
 
+  /** Set at teardown, so a borrow that outlives the session cannot restore it. */
+  let torn = false
+
   /**
    * Give borrowed work the terminal for as long as it needs it.
    *
@@ -387,8 +390,13 @@ export function setupDevUI(context: ShortcutContext, options: DevUIOptions = {})
     }
     finally {
       resume()
-      detach = attachKeys(onKey)
-      render()
+      // A session torn down mid-borrow (Ctrl-C answered a prompt) has already
+      // detached and given the terminal back; re-attaching would put stdin
+      // into raw mode with nothing listening and keep the process alive.
+      if (!torn) {
+        detach = attachKeys(onKey)
+        render()
+      }
     }
   }
 
@@ -475,6 +483,7 @@ export function setupDevUI(context: ShortcutContext, options: DevUIOptions = {})
     },
   })
   session.onTeardown(() => {
+    torn = true
     clearInterval(animation)
     clearTimeout(activityTimer)
     clearTimeout(noticeTimer)

capture/output/nuxt-dev-plain.txt

@@ -258,7 +258,7 @@ export function beginDevUI(options: DevUISupportOptions & { version?: string, cw
       transient = undefined
       return
     }
-    const stored = events.push({
+    const event: DevLogEvent = {
       time: Date.now(),
       level: 2,
       type: 'log',
@@ -268,8 +268,12 @@ export function beginDevUI(options: DevUISupportOptions & { version?: string, cw
       source: isServingRequest() ? 'runtime' : 'build',
       request: currentRequest()?.label,
       requestId: currentRequest()?.id,
-    })
-    transient = rewriting ? stored : undefined
+    }
+    const stored = events.push(event)
+    // Only an entry of this run's own may be rewritten by its later frames:
+    // `push` can merge into an existing structured event, whose message is a
+    // real log that has to survive.
+    transient = rewriting && stored === event ? stored : undefined
   }
 
   /**

capture/output/nuxt-init.svg

@@ -34,10 +34,15 @@ export async function withSpinner<T>(message: string, fn: (spinner: Spinner) =>
   if (host) {
     const task = host.startTask(message)
     try {
-      return await fn({ update: text => task.update(text), done: setDone })
-    }
-    finally {
+      const result = await fn({ update: text => task.update(text), done: setDone })
       task.stop(done, 'success')
+      return result
+    }
+    catch (error) {
+      // The message the work chose describes it succeeding; whoever threw
+      // reports the failure itself.
+      task.stop(undefined, 'failure')
+      throw error
     }
   }
 

packages/nuxt-cli/src/dev/tui/index.ts

@@ -2251,6 +2251,21 @@ describe('the terminal host on the panel', () => {
     })
   })
 
+  it('does not take stdin back when torn down during a borrow', async () => {
+    let finish!: () => void
+    let borrowed!: Promise<unknown>
+    await withPanel(async () => {
+      const host = useTerminalHost()!
+      borrowed = host.withTerminal(() => new Promise<void>((resolve) => {
+        finish = resolve
+      }))
+      await vi.waitFor(() => expect(process.stdin.listenerCount('keypress')).toBe(0))
+    })
+    finish()
+    await borrowed
+    expect(process.stdin.listenerCount('keypress')).toBe(0)
+  })
+
   it('holds a notification on the status line until it is dismissed', async () => {
     await withPanel(async (ui, settle) => {
       ui.setStatus('ready')
@@ -2263,11 +2278,13 @@ describe('the terminal host on the panel', () => {
       expect(frames).toContain('permission Request')
       expect(frames).toContain('Open http://localhost:3000/auth to approve.')
 
+      const seen = frames.length
       notice.dismiss()
       await notice.dismissed
+      // Dismissal restores the status badge, so the repaint carries it.
       frames = await settle()
-      expect(frames.split('permission Request').length - 1)
-        .toBe((await settle()).split('permission Request').length - 1)
+      expect(frames.slice(seen)).toContain('READY')
+      expect(frames.slice(seen)).not.toContain('permission Request')
     })
   })