test: cover shortcut error paths

Author: danielroe

packages/nuxt-cli/test/unit/shortcuts.spec.ts

@@ -15,7 +15,16 @@ const { copyURL, openBrowser, printQRCode } = vi.hoisted(() => ({
 
 vi.mock('../../src/dev/listen',()=>({ copyURL, openBrowser, printQRCode }))
 
-vi.mock('std-env',()=>({isCI: false,isTest: false}))
+constenvironment=vi.hoisted(()=>({isCI: false,isTest: false}))
+
+vi.mock('std-env',()=>({
+getisCI(){
+returnenvironment.isCI
+},
+getisTest(){
+returnenvironment.isTest
+},
+}))
 
 describe('setupShortcuts',()=>{
 constrestores: Array<()=>void>=[]
@@ -24,7 +33,9 @@ describe('setupShortcuts', () => {
 for(constrestoreofrestores.splice(0)){
 restore()
 }
+Object.assign(environment,{isCI: false,isTest: false})
 vi.restoreAllMocks()
+vi.clearAllMocks()
 })
 
 functionsetup(context: Partial<ShortcutContext>={},{ isTTY =true}={}){
@@ -35,8 +46,7 @@ describe('setupShortcuts', () => {
 Object.defineProperty(process,'stdin',{value: stdin,configurable: true})
 restores.push(()=>Object.defineProperty(process,'stdin',{value: original,configurable: true}))
 
-constlogs: string[]=[]
-vi.spyOn(console,'log').mockImplementation(message=>voidlogs.push(String(message)))
+vi.spyOn(console,'log').mockImplementation(()=>{})
 
 constlistener={
 url: 'http://localhost:3000/',
@@ -53,45 +63,29 @@ describe('setupShortcuts', () => {
 
 setupShortcuts(resolved)
 
-constpress=async(input: string)=>{
-stdin.write(`${input}\n`)
-awaitnewPromise(resolve=>setImmediate(resolve))
+return{
+context: resolved,
+ listener,
+ stdin,
+press: async(input: string)=>{
+stdin.write(`${input}\n`)
+awaitnewPromise(resolve=>setImmediate(resolve))
+},
 }
-
-return{context: resolved, listener, logs, press, stdin }
 }
 
-it('should do nothing when stdin is not a TTY',()=>{
-const{ logs, stdin }=setup({},{isTTY: false})
-
-expect(logs).toHaveLength(0)
-expect(stdin.listenerCount('line')).toBe(0)
-})
-
-it('should hint at the help shortcut once ready',()=>{
-const{ logs }=setup()
+it('should not read stdin when it is not a TTY',()=>{
+const{ stdin }=setup({},{isTTY: false})
 
-expect(logs.join('\n')).toContain('h + enter')
+expect(stdin.listenerCount('data')).toBe(0)
 })
 
-it('should open the browser and show urls',async()=>{
-const{ listener, press }=setup()
-
-awaitpress('o')
-awaitvi.waitFor(()=>expect(openBrowser).toHaveBeenCalledWith('http://localhost:3000/'))
-
-awaitpress('urls')
-expect(listener.showURLs).toHaveBeenCalled()
-})
-
-it('should reprint the urls after clearing the console',async()=>{
-const{ listener, press }=setup()
-constwrite=vi.spyOn(process.stdout,'write').mockImplementation(()=>true)
-
-awaitpress('clear')
+it('should not read stdin in CI or under test',()=>{
+environment.isCI=true
+expect(setup().stdin.listenerCount('data')).toBe(0)
 
-expect(write).toHaveBeenCalledWith('\u001B[2J\u001B[3J\u001B[H')
-expect(listener.showURLs).toHaveBeenCalled()
+Object.assign(environment,{isCI: false,isTest: true})
+expect(setup().stdin.listenerCount('data')).toBe(0)
 })
 
 it('should distinguish `q` from `qr`',async()=>{
@@ -108,10 +102,11 @@ describe('setupShortcuts', () => {
 expect(exit).toHaveBeenCalled()
 })
 
-it('should prefer a network url for sharing',async()=>{
+it('should share the most reachable url',async()=>{
 constlistener={
 url: 'http://localhost:3000/',
 qrURL: 'http://192.168.1.20:3000/',
+publicURL: 'https://example.com/',
 getURLs: ()=>[],
 showURLs: vi.fn(),
 }asunknownasListener
@@ -121,22 +116,79 @@ describe('setupShortcuts', () => {
 awaitvi.waitFor(()=>expect(copyURL).toHaveBeenCalledWith('http://192.168.1.20:3000/'))
 })
 
+it('should fall back to a network url when sharing',async()=>{
+constlistener={
+url: 'http://localhost:3000/',
+getURLs: ()=>[
+{url: 'http://localhost:3000/',type: 'local'},
+{url: 'http://192.168.1.20:3000/',type: 'network'},
+],
+showURLs: vi.fn(),
+}asunknownasListener
+const{ press }=setup({ listener })
+
+awaitpress('copy')
+awaitvi.waitFor(()=>expect(copyURL).toHaveBeenCalledWith('http://192.168.1.20:3000/'))
+})
+
 it('should restart when a restart handler is available',async()=>{
 constrestart=vi.fn()
-const{ press, logs}=setup({ restart })
+const{ press }=setup({ restart })
 
 awaitpress('r')
-expect(restart).toHaveBeenCalled()
+awaitvi.waitFor(()=>expect(restart).toHaveBeenCalled())
+})
 
-awaitpress('h')
-expect(logs.join('\n')).toContain('restart the dev server')
+it('should ignore the restart shortcut when no handler is available',async()=>{
+const{ press, listener }=setup()
+
+awaitpress('r')
+
+expect(listener.showURLs).not.toHaveBeenCalled()
+expect(openBrowser).not.toHaveBeenCalled()
+})
+
+it('should report a failure to quit and exit non-zero',async()=>{
+constexitCode=process.exitCode
+restores.push(()=>{
+process.exitCode=exitCode
+})
+
+constclose=vi.fn().mockRejectedValue(newError('could not close'))
+constexit=vi.spyOn(process,'exit').mockImplementation(()=>undefinedasnever)
+consterror=vi.spyOn(console,'error').mockImplementation(()=>{})
+const{ press }=setup({ close })
+
+awaitpress('q')
+awaitvi.waitFor(()=>expect(exit).toHaveBeenCalled())
+
+expect(error).toHaveBeenCalledWith(expect.objectContaining({message: 'could not close'}))
+expect(process.exitCode).toBe(1)
 })
 
-it('should hide the restart shortcut when unavailable',async()=>{
-const{ press, logs }=setup()
+it('should report a failing shortcut without exiting',async()=>{
+constlistener={
+url: 'http://localhost:3000/',
+getURLs: ()=>[],
+showURLs: vi.fn(()=>{
+thrownewError('boom')
+}),
+}asunknownasListener
+consterror=vi.spyOn(console,'error').mockImplementation(()=>{})
+const{ press }=setup({ listener })
+
+awaitpress('urls')
+
+awaitvi.waitFor(()=>expect(error).toHaveBeenCalledWith(expect.objectContaining({message: 'boom'})))
+})
+
+it('should ignore unknown input',async()=>{
+const{ press, listener }=setup()
+
+awaitpress('nonsense')
 
-awaitpress('h')
-expect(logs.join('\n')).not.toContain('restart the dev server')
-expect(logs.join('\n')).toContain('quit')
+expect(listener.showURLs).not.toHaveBeenCalled()
+expect(openBrowser).not.toHaveBeenCalled()
+expect(copyURL).not.toHaveBeenCalled()
 })
 })

packages/nuxt-cli/test/unit/terminal-output.spec.ts

@@ -30,7 +30,7 @@ function screen(renderer: Renderer): string {
 }
 
 /** Pretend to be a Linux desktop running `browser`, or a headless one. */
-functionstubDisplay({ browser}: {browser?: string}={}): ()=>void{
+functionstubDisplay({ browser, browserArgs }: {browser?: string,browserArgs?: string}={}): ()=>void{
 constplatform=process.platform
 constenv={ ...process.env}
 Object.defineProperty(process,'platform',{value: 'linux',configurable: true})
@@ -40,6 +40,7 @@ function stubDisplay({ browser }: { browser?: string } = {}): () => void {
 WAYLAND_DISPLAY: undefined,
 WSL_DISTRO_NAME: undefined,
 BROWSER: browser,
+BROWSER_ARGS: browserArgs,
 }
 return()=>{
 Object.defineProperty(process,'platform',{value: platform,configurable: true})
@@ -61,12 +62,12 @@ describe('dev server terminal output', () => {
 returnlistener
 }
 
-asyncfunctionwithShortcuts(context: Partial<ShortcutContext>={}){
+asyncfunctionwithShortcuts(context: Partial<ShortcutContext>={},options: Parameters<typeoflisten>[1]={}){
 conststdin=newPassThrough()asunknownastypeofprocess.stdin
 Object.assign(stdin,{isTTY: true})
 vi.spyOn(process,'stdin','get').mockReturnValue(stdin)
 
-constlistener=awaitstart({showURL: false})
+constlistener=awaitstart({showURL: false, ...options})
 setupShortcuts({
  listener,
 close: async()=>{},
@@ -118,6 +119,12 @@ describe('dev server terminal output', () => {
 })
 
 describe('shortcuts',()=>{
+it('should hint at the help shortcut once the server is ready',async()=>{
+constrenderer=awaitrender(()=>withShortcuts())
+
+expect(screen(renderer)).toContain('press h + enter to see available shortcuts')
+})
+
 it('should caption a standalone qr code with its url',async()=>{
 constrenderer=awaitrender(()=>printQRCode('http://192.168.1.20:3000/',{showURL: true}))
 constlines=screen(renderer).split('\n').filter(Boolean)
@@ -143,6 +150,24 @@ describe('dev server terminal output', () => {
 expect(renderer.frames.at(-1)).not.toContain('noise from a previous build')
 })
 
+it('should point a requested qr code at the public url',async()=>{
+const{ press }=awaitwithShortcuts({},{publicURL: 'https://example.com/'})
+
+constrenderer=awaitrender(()=>press('qr'))
+
+expect(screen(renderer).split('\n').filter(Boolean).at(-1)).toContain('https://example.com/')
+})
+
+it('should say so when there is no clipboard to copy to',async()=>{
+constrestore=stubDisplay()
+const{ press }=awaitwithShortcuts()
+
+constrenderer=awaitrender(()=>press('copy'))
+restore()
+
+expect(screen(renderer)).toContain('No clipboard is available in this environment.')
+})
+
 it('should list the available shortcuts',async()=>{
 const{ press }=awaitwithShortcuts()
 
@@ -182,7 +207,8 @@ describe('dev server terminal output', () => {
 })
 
 it('should say so when the browser launcher exits with an error',async()=>{
-constrestore=stubDisplay({browser: 'false'})
+// A launcher that fails, without depending on a platform-specific binary.
+constrestore=stubDisplay({browser: process.execPath,browserArgs: '-e process.exit(1)'})
 
 constrenderer=awaitrender(async({ waitForOutput })=>{
 openBrowser('http://localhost:3000/')