feat: expose deploy context to functions and edge functions (#6747)

Author: eduardoboucas

package-lock.json

@@ -77,7 +77,7 @@
     "@netlify/build-info": "7.14.0",
     "@netlify/config": "20.16.0",
     "@netlify/edge-bundler": "12.2.0",
-    "@netlify/edge-functions": "2.8.1",
+    "@netlify/edge-functions": "2.9.0",
     "@netlify/local-functions-proxy": "1.1.1",
     "@netlify/zip-it-and-ship-it": "9.37.5",
     "@octokit/rest": "20.1.1",

package.json

@@ -3,6 +3,7 @@ import { Buffer } from 'buffer'
 export const headers = {
   BlobsInfo: 'x-nf-blobs-info',
   DeployID: 'x-nf-deploy-id',
+  DeployContext: 'x-nf-deploy-context',
   FeatureFlags: 'x-nf-feature-flags',
   ForwardedHost: 'x-forwarded-host',
   ForwardedProtocol: 'x-forwarded-proto',

src/lib/edge-functions/headers.ts

@@ -151,6 +151,7 @@ export const initializeProxy = async ({
     // Setting header with geolocation and site info.
     req.headers[headers.Geo] = Buffer.from(JSON.stringify(geoLocation)).toString('base64')
     req.headers[headers.DeployID] = '0'
+    req.headers[headers.DeployContext] = 'dev'
     req.headers[headers.Site] = createSiteInfoHeader(siteInfo, `${protocol}://localhost:${mainPort}`)
     req.headers[headers.Account] = createAccountInfoHeader({ id: accountId })
 

src/lib/edge-functions/proxy.ts

@@ -238,19 +238,29 @@ describe.concurrent('commands/dev-miscellaneous', () => {
           },
         ])
         .withEdgeFunction({
-          handler: (req) => new Response(req.headers.get('x-nf-request-id')),
+          handler: (req, context) =>
+            Response.json({
+              requestID: req.headers.get('x-nf-request-id'),
+              deploy: context.deploy,
+            }),
           name: 'hello',
         })
 
       await builder.build()
 
       await withDevServer({ cwd: builder.directory }, async (server) => {
         const response = await fetch(`${server.url}/edge-function`)
-        const responseBody = await response.text()
+        const responseBody = await response.json()
 
         t.expect(response.status).toBe(200)
-        t.expect(responseBody.length).toBe(26)
-        t.expect(responseBody).toEqual(response.headers.get('x-nf-request-id'))
+        t.expect(responseBody).toEqual({
+          requestID: response.headers.get('x-nf-request-id'),
+          deploy: {
+            context: 'dev',
+            id: '0',
+            published: false,
+          },
+        })
       })
     })
   })
@@ -423,7 +433,7 @@ describe.concurrent('commands/dev-miscellaneous', () => {
 
             t.expect(response.status).toBe(200)
             t.expect(JSON.parse(await response.text())).toStrictEqual({
-              deploy: { id: '0' },
+              deploy: { context: 'dev', id: '0', published: false },
               site: { id: 'site_id', name: 'site-name', url: server.url },
             })
           },

tests/integration/commands/dev/dev-miscellaneous.test.js

@@ -77,7 +77,7 @@ describe.skipIf(isWindows)('edge functions', () => {
         const { deploy, geo, ip, params, requestId, server, site } = await response.json()
         expect(geo.city).toEqual('Mock City')
         expect(geo.country.code).toEqual('DE')
-        expect(deploy).toEqual({ id: '0' })
+        expect(deploy).toEqual({ context: 'dev', id: '0', published: false })
         expectTypeOf(ip).toBeString()
         expect(params).toEqual({})
         expectTypeOf(requestId).toBeString()

tests/integration/commands/dev/edge-functions.test.ts

@@ -68,10 +68,11 @@ describe.runIf(gte(version, '18.13.0')).concurrent('v2 api', () => {
       expect(context.server.region).toEqual('dev')
       expect(context.ip).toEqual('::1')
       expect(context.geo.city).toEqual('Mock City')
-
       expect(context.cookies).toEqual({ foo: 'bar' })
-
       expect(context.account.id).toEqual('mock-account-id')
+      expect(context.deploy.context).toEqual('dev')
+      expect(context.deploy.id).toEqual('0')
+      expect(context.deploy.published).toEqual(false)
     })
 
     test<FixtureTestContext>('logging works', async ({ devServer }) => {