fix(dev): harden listener edge cases

Author: danielroe

packages/nuxt-cli/src/commands/dev.ts

@@ -15,7 +15,7 @@ import { satisfies } from 'verkit'
 import{initialize}from'../dev'
 
 import{closeInspector,openInspector,resolveInspectOptions}from'../dev/inspect'
-import{isReusePortSupported}from'../dev/listen'
+import{isReusePortSupported,parsePort}from'../dev/listen'
 import{ForkPool}from'../dev/pool'
 import{formatRestartReason}from'../dev/reason'
 import{setupShortcuts}from'../dev/shortcuts'
@@ -158,7 +158,7 @@ const command = defineCommand({
 constlistenOverrides=resolveListenOverrides(ctx.args)
 
 consttakeover=awaittakeOverDevServer(resolveDevBuildDir(cwd),{
-requestedPort: parseRequestedPort(listenOverrides.port),
+requestedPort: parsePort(listenOverrides.port),
 takeover: ctx.args.takeover,
 })
 if(takeover.action==='refused'){
@@ -408,11 +408,6 @@ function resolveDevBuildDir(cwd: string): string {
 returnresolve(cwd,'.nuxt')
 }
 
-functionparseRequestedPort(port: string|number|undefined): number|undefined{
-constparsed=Number(port)
-returnport===undefined||port===''||!Number.isInteger(parsed)||parsed<=0 ? undefined : parsed
-}
-
 functionresolveForkPoolSize(): number|undefined{
 constraw=process.env.NUXT_DEV_FORK_POOL_SIZE
 if(!raw){

packages/nuxt-cli/src/dev/listen.ts

@@ -155,7 +155,7 @@ export async function listen(handler: RequestListener, options: ListenOptions =
 constisolatedEnvironment=options.hostname===undefined&&!options.public&&detectIsolatedEnvironment()
 consthostname=validateHostname(options.hostname,options.public)??(options.public||isolatedEnvironment ? '' : 'localhost')
 
-constrequestedPort=options.port===undefined||options.port==='' ? undefined : Number(options.port)
+constrequestedPort=parsePort(options.port)
 constport=options.handover&&requestedPort
  ? requestedPort
  : awaitresolvePort(requestedPort,hostname,options.strictPort)
@@ -191,15 +191,16 @@ export async function listen(handler: RequestListener, options: ListenOptions =
 tunnel=awaitstartTunnel(`${protocol}://localhost:${address.port}`,!!certificate)
 }
 
+consttunnelURL=tunnel?.url&&tunnel.url+baseURL
 constportless=resolvePortlessURLs()
 constportlessURL=portless.url&&portless.url+baseURL
 constportlessShareURL=portless.shareURL&&portless.shareURL+baseURL
 conststackblitzURL=resolveStackblitzURL()
 
 functiongetURLs(): ListenURL[]{
 consturls: ListenURL[]=[]
-if(tunnel){
-urls.push({url: tunnel.url,type: 'tunnel'})
+if(tunnelURL){
+urls.push({url: tunnelURL,type: 'tunnel'})
 }
 for(constportlessURLofportless.all){
 urls.push({url: portlessURL+baseURL,type: 'public'})
@@ -221,7 +222,7 @@ export async function listen(handler: RequestListener, options: ListenOptions =
 
 // The StackBlitz URL points at the editor rather than at a host another
 // device can open, so it is not a QR code candidate.
-constshareableURL=options.publicURL||tunnel?.url||portlessShareURL||portlessURL
+constshareableURL=options.publicURL||tunnelURL||portlessShareURL||portlessURL
 constpublicURL=shareableURL||stackblitzURL
 
 constqrURL=options.qr===false
@@ -278,31 +279,35 @@ export async function listen(handler: RequestListener, options: ListenOptions =
 https: certificate,
  getURLs,
  showURLs,
-close: async()=>{
-awaittunnel?.close()
-returnnewPromise<void>((resolve,reject)=>{
-letforceClose: NodeJS.Timeout|undefined
-server.close((error)=>{
-if(forceClose){
-clearTimeout(forceClose)
-}
-if(error){
-reject(error)
-}
-else{
-resolve()
-}
-})
-// Sockets waiting on keep-alive are closed at once, so shutdown is only
-// delayed while a request is actually being served.
-server.closeIdleConnections?.()
-forceClose=setTimeout(()=>server.closeAllConnections?.(),CONNECTION_DRAIN_TIMEOUT_MS)
-forceClose.unref()
-})
-},
+close: ()=>Promise.all([
+tunnel?.close(),
+closeServer(server),
+]).then(()=>{}),
 }
 }
 
+functioncloseServer(server: HttpServer): Promise<void>{
+returnnewPromise<void>((resolve,reject)=>{
+letforceClose: NodeJS.Timeout|undefined
+server.close((error)=>{
+if(forceClose){
+clearTimeout(forceClose)
+}
+if(error){
+reject(error)
+}
+else{
+resolve()
+}
+})
+// Sockets waiting on keep-alive are closed at once, so shutdown is only
+// delayed while a request is actually being served.
+server.closeIdleConnections?.()
+forceClose=setTimeout(()=>server.closeAllConnections?.(),CONNECTION_DRAIN_TIMEOUT_MS)
+forceClose.unref()
+})
+}
+
 functionbindServer(server: HttpServer,port: number,hostname: string,reusePort: boolean): Promise<void>{
 returnnewPromise<void>((resolve,reject)=>{
 constonError=(error: NodeJS.ErrnoException)=>{
@@ -372,6 +377,17 @@ export function isReusePortSupported(): Promise<boolean> {
 returnreusePortSupport
 }
 
+exportfunctionparsePort(value: string|number|undefined): number|undefined{
+if(value===undefined||value===''){
+returnundefined
+}
+constport=Number(value)
+if(!Number.isInteger(port)||port<0||port>65_535){
+thrownewError(`Invalid port \`${value}\`; expected an integer between 0 and 65535.`)
+}
+returnport
+}
+
 asyncfunctionresolvePort(requestedPort: number|undefined,hostname: string,strictPort?: boolean): Promise<number>{
 if(requestedPort===0){
 returngetPort({random: true,host: hostname||undefined})

packages/nuxt-cli/src/dev/utils.ts

@@ -899,8 +899,8 @@ function createConfigDirWatcher(cwd: string, onReload: (path: string) => void) {
 
 fileWatcher.prime(configDir)
 constconfigDirWatcher=watch(configDir)
-configDirWatcher.on('change',(_event,file: string)=>{
-if(!fileWatcher.shouldEmitChange(resolve(configDir,file))){
+configDirWatcher.on('change',(_event,file: string|null)=>{
+if(!file||!fileWatcher.shouldEmitChange(resolve(configDir,file))){
 return
 }
 

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

@@ -5,7 +5,7 @@ import { networkInterfaces } from 'node:os'
 
 import{afterEach,beforeEach,describe,expect,it,vi}from'vitest'
 
-import{copyURL,formatDisplayURL,getNetworkAddresses,isReusePortSupported,listen,openBrowser,resolveOpenCommand,validateHostname}from'../../src/dev/listen'
+import{copyURL,formatDisplayURL,getNetworkAddresses,isReusePortSupported,listen,openBrowser,parsePort,resolveOpenCommand,validateHostname}from'../../src/dev/listen'
 
 constwriteText=vi.hoisted(()=>vi.fn())
 constisolatedEnvironment=vi.hoisted(()=>({current: undefinedasstring|undefined}))
@@ -115,6 +115,22 @@ describe('validateHostname', () => {
 })
 })
 
+describe('parsePort',()=>{
+it.each([
+['0',0],
+['3000',3000],
+[65_535,65_535],
+['',undefined],
+[undefined,undefined],
+])('should parse %j as %j',(value,expected)=>{
+expect(parsePort(value)).toBe(expected)
+})
+
+it.each(['nope','-1','1.5','65536','Infinity'])('should reject %s',(value)=>{
+expect(()=>parsePort(value)).toThrow(`Invalid port \`${value}\``)
+})
+})
+
 describe('resolveOpenCommand',()=>{
 consturl='http://localhost:3000/'
 
@@ -180,6 +196,10 @@ describe('listen', () => {
 expect(listener.url).toBe(`http://localhost:${listener.address.port}/`)
 })
 
+it('should reject an invalid port before binding',async()=>{
+awaitexpect(start({port: 'nope'})).rejects.toThrow('Invalid port `nope`; expected an integer between 0 and 65535.')
+})
+
 it('should fall back to another port by default',async()=>{
 constfirst=awaitstart({port: 0})
 constsecond=awaitstart({port: first.address.port})
@@ -242,6 +262,29 @@ describe('listen', () => {
 })
 
 describe('listener.close',()=>{
+it('should close the listener while a tunnel is still shutting down',async()=>{
+letcloseTunnel: (()=>void)|undefined
+vi.doMock('../../src/dev/tunnel',()=>({
+startTunnel: async()=>({
+url: 'https://example.test',
+close: ()=>newPromise<void>((resolve)=>{
+closeTunnel=resolve
+}),
+}),
+}))
+
+constlistener=awaitlisten((_req,res)=>res.end('ok'),{port: 0,hostname: '127.0.0.1',baseURL: '/dashboard/',showURL: false,tunnel: true})
+expect(listener.publicURL).toBe('https://example.test/dashboard/')
+expect(listener.getURLs()).toContainEqual({url: 'https://example.test/dashboard/',type: 'tunnel'})
+
+constclosed=listener.close()
+
+awaitvi.waitFor(()=>expect(listener.server.listening).toBe(false))
+closeTunnel!()
+awaitclosed
+vi.doUnmock('../../src/dev/tunnel')
+})
+
 it('should let an in-flight request finish',async()=>{
 letrespond: (()=>void)|undefined
 constlistener=awaitlisten((_req,res)=>{