refactor(dev): directly emit address (+ type server)

Author: danielroe

packages/nuxi/src/commands/dev.ts

@@ -143,7 +143,7 @@ const command = defineCommand({
       },
     })
 
-    onReady(port => devProxy.setAddress(`http://127.0.0.1:${port}`))
+    onReady(address => devProxy.setAddress(address))
 
     // ... then fall back to pre-warmed fork if a hard restart is required
     const fork = startSubprocess(cwd, ctx.args, ctx.rawArgs, listenOptions)
@@ -310,7 +310,7 @@ async function startSubprocess(cwd: string, args: { logLevel: string, clear: boo
           resolve()
         }
         else if (message.type === 'nuxt:internal:dev:ready') {
-          devProxy.setAddress(`http://127.0.0.1:${message.port}`)
+          devProxy.setAddress(message.address)
           if (startTime) {
             logger.debug(`Dev server ready for connections in ${Date.now() - startTime}ms`)
           }
@@ -357,7 +357,7 @@ async function startSubprocess(cwd: string, args: { logLevel: string, clear: boo
 }
 
 function resolveListenOptions(
-  nuxtOptions: NuxtOptions,
+  nuxtOptions: { devServer: NuxtOptions['devServer'], app: NuxtOptions['app'] },
   args: ParsedArgs<ArgsT>,
 ): Partial<ListenOptions> {
   const _port = args.port

packages/nuxi/src/dev/index.ts

@@ -65,7 +65,7 @@ export async function initialize(devContext: NuxtDevContext, ctx: InitializeOpti
     devContext,
   }, listenOptions)
 
-  let port: number
+  let address: string
 
   if (ipc.enabled) {
     devServer.on('loading:error', (_error) => {
@@ -75,7 +75,7 @@ export async function initialize(devContext: NuxtDevContext, ctx: InitializeOpti
           message: _error.message,
           stack: _error.stack,
           name: _error.name,
-          code: _error.code,
+          code: 'code' in _error ? _error.code : undefined,
         },
       })
     })
@@ -86,12 +86,12 @@ export async function initialize(devContext: NuxtDevContext, ctx: InitializeOpti
       ipc.send({ type: 'nuxt:internal:dev:restart' })
     })
     devServer.on('ready', (payload) => {
-      ipc.send({ type: 'nuxt:internal:dev:ready', port: payload.port })
+      ipc.send({ type: 'nuxt:internal:dev:ready', address: payload })
     })
   }
   else {
     devServer.on('ready', (payload) => {
-      port = payload.port
+      address = payload
     })
   }
 
@@ -106,12 +106,12 @@ export async function initialize(devContext: NuxtDevContext, ctx: InitializeOpti
   return {
     listener: devServer.listener,
     close: () => devServer.close(),
-    onReady: (callback: (port: number) => void) => {
-      if (port) {
-        callback(port)
+    onReady: (callback: (address: string) => void) => {
+      if (address) {
+        callback(address)
       }
       else {
-        devServer.once('ready', payload => callback(payload.port))
+        devServer.once('ready', payload => callback(payload))
       }
     },
     onRestart: (callback: (devServer: NuxtDevServer) => void) => {

packages/nuxi/src/dev/utils.ts

@@ -29,7 +29,7 @@ export type NuxtParentIPCMessage
 
 export type NuxtDevIPCMessage
   = | { type: 'nuxt:internal:dev:fork-ready' }
-    | { type: 'nuxt:internal:dev:ready', port: number }
+    | { type: 'nuxt:internal:dev:ready', address: string }
     | { type: 'nuxt:internal:dev:loading', message: string }
     | { type: 'nuxt:internal:dev:restart' }
     | { type: 'nuxt:internal:dev:rejection', message: string }
@@ -81,7 +81,6 @@ export async function createNuxtDevServer(options: NuxtDevServerOptions, listenO
   )
 
   // Merge interface with public context
-  // @ts-expect-error private property
   devServer.listener._url = devServer.listener.url
   if (options.devContext.proxy?.url) {
     devServer.listener.url = options.devContext.proxy.url
@@ -99,7 +98,14 @@ const RESTART_RE = /^(?:nuxt\.config\.[a-z0-9]+|\.nuxtignore|\.nuxtrc|\.config\/
 
 type NuxtWithServer = Omit<Nuxt, 'server'> & { server?: NitroDevServer }
 
-export class NuxtDevServer extends EventEmitter {
+interface DevServerEventMap {
+  'loading:error': [error: Error]
+  'loading': [loadingMessage: string]
+  'ready': [address: string]
+  'restart': []
+}
+
+export class NuxtDevServer extends EventEmitter<DevServerEventMap> {
   private _handler?: RequestListener
   private _distWatcher?: FSWatcher
   private _currentNuxt?: NuxtWithServer
@@ -109,7 +115,10 @@ export class NuxtDevServer extends EventEmitter {
 
   loadDebounced: (reload?: boolean, reason?: string) => void
   handler: RequestListener
-  listener: Listener
+  listener: Pick<Listener, 'server' | 'getURLs' | 'https' | 'url' | 'close'> & {
+    _url?: string
+    address: AddressInfo & { socketPath?: string }
+  }
 
   constructor(private options: NuxtDevServerOptions) {
     super()
@@ -184,7 +193,7 @@ export class NuxtDevServer extends EventEmitter {
       this._handler = undefined
       this._loadingError = error as Error
       this._loadingMessage = 'Error while loading Nuxt. Please check console and fix errors.'
-      this.emit('loading:error', error)
+      this.emit('loading:error', error as Error)
     }
   }
 
@@ -334,7 +343,7 @@ export class NuxtDevServer extends EventEmitter {
     })
 
     this._handler = toNodeListener(this._currentNuxt.server.app)
-    this.emit('ready', addr)
+    this.emit('ready', `http://127.0.0.1:${addr.port}`)
   }
 
   async _watchConfig() {