feat: add serverAddress to request handler (#308)

* feat: add `serverAddress` to request handler

* refactor: move property to upper interface

* fix: set server address

* refactor: revert logging change

* refactor: simplify `getServerAddress` method

Author: eduardoboucas

packages/dev/src/main.ts

@@ -82,12 +82,6 @@ export interface Features {
     enabled?: boolean
   }
 
-  /**
-   * If your local development setup has its own HTTP server (e.g. Vite), set
-   * its address here.
-   */
-  serverAddress?: string
-
   /**
    * Configuration options for serving static files.
    */
@@ -107,6 +101,12 @@ interface NetlifyDevOptions extends Features {
   apiToken?: string
   logger?: Logger
   projectRoot?: string
+
+  /**
+   * If your local development setup has its own HTTP server (e.g. Vite), set
+   * its address here.
+   */
+  serverAddress?: string | null
 }
 
 const notFoundHandler = async () => new Response('Not found', { status: 404 })
@@ -121,6 +121,13 @@ interface HandleOptions {
    * {@link} https://docs.netlify.com/routing/headers/
    */
   headersCollector?: HeadersCollector
+
+  /**
+   * If your local development setup has its own HTTP server (e.g. Vite), you
+   * can supply its address here. It will override any value defined in the
+   * top-level `serverAddress` setting.
+   */
+  serverAddress?: string
 }
 
 export type ResponseType = 'edge-function' | 'function' | 'image' | 'redirect' | 'static'
@@ -149,7 +156,7 @@ export class NetlifyDev {
   #logger: Logger
   #projectRoot: string
   #redirectsHandler?: RedirectsHandler
-  #server?: string | HTTPServer
+  #serverAddress?: string | null
   #siteID?: string
   #staticHandler?: StaticHandler
   #staticHandlerAdditionalDirectories: string[]
@@ -178,11 +185,23 @@ export class NetlifyDev {
     }
     this.#functionsServePath = path.join(projectRoot, '.netlify', 'functions-serve')
     this.#logger = options.logger ?? globalThis.console
-    this.#server = options.serverAddress
+    this.#serverAddress = options.serverAddress
     this.#projectRoot = projectRoot
     this.#staticHandlerAdditionalDirectories = options.staticFiles?.directories ?? []
   }
 
+  private getServerAddress(requestServerAddress?: string) {
+    if (requestServerAddress) {
+      return requestServerAddress
+    }
+
+    if (typeof this.#serverAddress === 'string') {
+      return this.#serverAddress
+    }
+
+    throw new Error('Server address is not defined')
+  }
+
   /**
    * Runs a request through the Netlify request chain and returns a `Response`
    * if there's a match. We must not disturb the incoming request unless we
@@ -202,6 +221,8 @@ export class NetlifyDev {
     destPath: string,
     options: HandleOptions = {},
   ): Promise<{ response: Response; type: ResponseType } | undefined> {
+    const serverAddress = this.getServerAddress(options.serverAddress)
+
     // Try to match the request against the different steps in our request chain.
     //
     // https://docs.netlify.com/platform/request-chain/
@@ -211,15 +232,15 @@ export class NetlifyDev {
     const edgeFunctionMatch = await this.#edgeFunctionsHandler?.match(readRequest)
     if (edgeFunctionMatch) {
       return {
-        response: await edgeFunctionMatch.handle(getWriteRequest()),
+        response: await edgeFunctionMatch.handle(getWriteRequest(), serverAddress),
         type: 'edge-function',
       }
     }
 
     // 2. Check if the request matches an image.
     const imageMatch = this.#imageHandler?.match(readRequest)
     if (imageMatch) {
-      const response = await imageMatch.handle()
+      const response = await imageMatch.handle(serverAddress)
       return { response, type: 'image' }
     }
 
@@ -251,7 +272,7 @@ export class NetlifyDev {
       // If the redirect rule matches Image CDN, we'll serve it.
       const imageMatch = this.#imageHandler?.match(redirectRequest)
       if (imageMatch) {
-        const response = await imageMatch.handle()
+        const response = await imageMatch.handle(serverAddress)
         return { response, type: 'image' }
       }
 
@@ -403,9 +424,9 @@ export class NetlifyDev {
     // If a custom server has been provided, use it. If not, we must stand up
     // a new one, since it's required for communication with edge functions
     // and local images support for Image CDN.
-    if (typeof this.#server === 'string') {
-      serverAddress = this.#server
-    } else if (this.#features.edgeFunctions || this.#features.images) {
+    if (typeof this.#serverAddress === 'string') {
+      serverAddress = this.#serverAddress
+    } else if (this.#serverAddress !== null && (this.#features.edgeFunctions || this.#features.images)) {
       const passthroughServer = new HTTPServer(async (req) => {
         const res = await this.handle(req)
 
@@ -415,6 +436,7 @@ export class NetlifyDev {
       this.#cleanupJobs.push(() => passthroughServer.stop())
 
       serverAddress = await passthroughServer.start()
+      this.#serverAddress = serverAddress
     }
 
     let envVariables: Record<string, InjectedEnvironmentVariable> = {}
@@ -430,7 +452,7 @@ export class NetlifyDev {
       })
     }
 
-    if (this.#features.edgeFunctions && serverAddress !== undefined) {
+    if (this.#features.edgeFunctions) {
       const env = Object.entries(envVariables).reduce<Record<string, string>>((acc, [key, variable]) => {
         if (
           variable.usedSource === 'account' ||
@@ -454,7 +476,6 @@ export class NetlifyDev {
         env,
         geolocation: mockLocation,
         logger: this.#logger,
-        originServerAddress: serverAddress,
         siteID,
         siteName: config?.siteInfo.name,
       })
@@ -511,7 +532,6 @@ export class NetlifyDev {
       this.#imageHandler = new ImageHandler({
         imagesConfig: this.#config?.config.images,
         logger: this.#logger,
-        originServerAddress: serverAddress,
       })
     }
 

packages/edge-functions/dev/node/main.test.ts

@@ -64,7 +64,6 @@ describe('`EdgeFunctionsHandler`', () => {
       },
       geolocation,
       logger: console,
-      originServerAddress: serverAddress,
       siteID: '123',
       siteName: 'test',
     })
@@ -75,7 +74,7 @@ describe('`EdgeFunctionsHandler`', () => {
     const match = await handler.match(req)
     expect(match).toBeTruthy()
 
-    const res = await match?.handle(req)
+    const res = await match?.handle(req, serverAddress)
 
     expect(await res?.json()).toStrictEqual({
       env: { VAR_1: 'value1', VAR_2: 'value2' },
@@ -126,7 +125,6 @@ describe('`EdgeFunctionsHandler`', () => {
       },
       geolocation,
       logger: console,
-      originServerAddress: serverAddress,
       siteID: '123',
       siteName: 'test',
     })
@@ -137,7 +135,7 @@ describe('`EdgeFunctionsHandler`', () => {
     const match = await handler.match(req)
     expect(match).toBeTruthy()
 
-    const res = await match?.handle(req)
+    const res = await match?.handle(req, serverAddress)
 
     expect(await res?.text()).toStrictEqual('FROM ORIGIN')
 
@@ -179,7 +177,6 @@ describe('`EdgeFunctionsHandler`', () => {
       },
       geolocation,
       logger: console,
-      originServerAddress: serverAddress,
       siteID: '123',
       siteName: 'test',
     })
@@ -190,7 +187,7 @@ describe('`EdgeFunctionsHandler`', () => {
     const match = await handler.match(req)
     expect(match).toBeTruthy()
 
-    const res = await match?.handle(req)
+    const res = await match?.handle(req, serverAddress)
 
     expect(await res?.json()).toStrictEqual({
       slug: 'hello-world',
@@ -223,7 +220,6 @@ describe('`EdgeFunctionsHandler`', () => {
       geolocation,
       logger: console,
       requestTimeout: 1_000,
-      originServerAddress: serverAddress,
       siteID: '123',
       siteName: 'test',
     })
@@ -234,7 +230,7 @@ describe('`EdgeFunctionsHandler`', () => {
     const match = await handler.match(req)
     expect(match).toBeTruthy()
 
-    const res = await match?.handle(req)
+    const res = await match?.handle(req, serverAddress)
 
     expect(res?.status).toBe(500)
     expect(await res?.text()).toContain('Failed to parse edge function `unparseable`')
@@ -269,7 +265,6 @@ describe('`EdgeFunctionsHandler`', () => {
       geolocation,
       logger: console,
       requestTimeout: 1_000,
-      originServerAddress: serverAddress,
       siteID: '123',
       siteName: 'test',
     })
@@ -280,7 +275,7 @@ describe('`EdgeFunctionsHandler`', () => {
     const match = await handler.match(req)
     expect(match).toBeTruthy()
 
-    const res = await match?.handle(req)
+    const res = await match?.handle(req, serverAddress)
 
     expect(res?.status).toBe(500)
     expect(await res?.text()).toContain('An edge function took too long to produce a response')

packages/edge-functions/dev/node/main.ts

@@ -23,7 +23,6 @@ interface EdgeFunctionsHandlerOptions {
   env: Record<string, string>
   geolocation: Geolocation
   logger: Logger
-  originServerAddress: string
   requestTimeout?: number
   siteID?: string
   siteName?: string
@@ -52,7 +51,6 @@ export class EdgeFunctionsHandler {
   private initialization: ReturnType<typeof this.initialize>
   private initialized: boolean
   private logger: Logger
-  private originServerAddress: string
   private requestTimeout: number
   private siteID?: string
   private siteName?: string
@@ -67,7 +65,6 @@ export class EdgeFunctionsHandler {
     })
     this.initialized = false
     this.logger = options.logger
-    this.originServerAddress = options.originServerAddress
     this.requestTimeout = options.requestTimeout ?? REQUEST_TIMEOUT
     this.siteID = options.siteID
     this.siteName = options.siteName
@@ -211,8 +208,8 @@ export class EdgeFunctionsHandler {
     }
 
     return {
-      handle: async (request: Request) => {
-        const originURL = new URL(this.originServerAddress)
+      handle: async (request: Request, originServerAddress: string) => {
+        const originURL = new URL(originServerAddress)
 
         const url = new URL(request.url)
         url.hostname = LOCAL_HOST
@@ -236,7 +233,7 @@ export class EdgeFunctionsHandler {
         const site = {
           id: this.siteID,
           name: this.siteName,
-          url: this.originServerAddress,
+          url: originServerAddress,
         }
 
         request.headers.set(headers.Site, base64Encode(site))