Update id env prefix (#51588)

Removes `__` prefix and ensures it's available on client/server as expected. x-ref: [slack thread](https://vercel.slack.com/archives/C04TNLL0LSK/p1687197571572119)
vercel · Jun 20, 2023 · f6998e3 · f6998e3
1 parent 2d2180f
commit f6998e3
Show file tree

Hide file tree

Showing 16 changed files with 46 additions and 13 deletions.
diff --git a/packages/next/src/build/webpack-config.ts b/packages/next/src/build/webpack-config.ts
@@ -264,7 +264,7 @@ export function getDefineEnv({
     'process.env.__NEXT_ACTIONS_DEPLOYMENT_ID': JSON.stringify(
       config.experimental.useDeploymentIdServerActions
     ),
-    'process.env.__NEXT_DEPLOYMENT_ID': JSON.stringify(
+    'process.env.NEXT_DEPLOYMENT_ID': JSON.stringify(
       config.experimental.deploymentId
     ),
     'process.env.__NEXT_FETCH_CACHE_KEY_PREFIX':

diff --git a/packages/next/src/client/app-index.tsx b/packages/next/src/client/app-index.tsx
@@ -44,8 +44,8 @@ const addChunkSuffix =
     return (
       getOriginalChunk(chunkId) +
       `${
-        process.env.__NEXT_DEPLOYMENT_ID
-          ? `?dpl=${process.env.__NEXT_DEPLOYMENT_ID}`
+        process.env.NEXT_DEPLOYMENT_ID
+          ? `?dpl=${process.env.NEXT_DEPLOYMENT_ID}`
           : ''
       }`
     )

diff --git a/packages/next/src/client/components/router-reducer/reducers/server-action-reducer.ts b/packages/next/src/client/components/router-reducer/reducers/server-action-reducer.ts
@@ -50,9 +50,9 @@ async function fetchServerAction(
       'Next-Action': actionId,
       [NEXT_ROUTER_STATE_TREE]: JSON.stringify(state.tree),
       ...(process.env.__NEXT_ACTIONS_DEPLOYMENT_ID &&
-      process.env.__NEXT_DEPLOYMENT_ID
+      process.env.NEXT_DEPLOYMENT_ID
         ? {
-            'x-deployment-id': process.env.__NEXT_DEPLOYMENT_ID,
+            'x-deployment-id': process.env.NEXT_DEPLOYMENT_ID,
           }
         : {}),
       ...(state.nextUrl

diff --git a/packages/next/src/client/index.tsx b/packages/next/src/client/index.tsx
@@ -68,8 +68,8 @@ const addChunkSuffix =
     return (
       getOriginalChunk(chunkId) +
       `${
-        process.env.__NEXT_DEPLOYMENT_ID
-          ? `?dpl=${process.env.__NEXT_DEPLOYMENT_ID}`
+        process.env.NEXT_DEPLOYMENT_ID
+          ? `?dpl=${process.env.NEXT_DEPLOYMENT_ID}`
           : ''
       }`
     )

diff --git a/packages/next/src/client/route-loader.ts b/packages/next/src/client/route-loader.ts
@@ -107,8 +107,8 @@ function hasPrefetch(link?: HTMLLinkElement): boolean {
 const canPrefetch: boolean = hasPrefetch()
 
 const getAssetQueryString = () => {
-  return process.env.__NEXT_DEPLOYMENT_ID
-    ? `?dpl=${process.env.__NEXT_DEPLOYMENT_ID}`
+  return process.env.NEXT_DEPLOYMENT_ID
+    ? `?dpl=${process.env.NEXT_DEPLOYMENT_ID}`
     : ''
 }
 

diff --git a/packages/next/src/export/worker.ts b/packages/next/src/export/worker.ts
@@ -157,7 +157,7 @@ export default async function exportPage({
 
     try {
       if (renderOpts.deploymentId) {
-        process.env.__NEXT_DEPLOYMENT_ID = renderOpts.deploymentId
+        process.env.NEXT_DEPLOYMENT_ID = renderOpts.deploymentId
       }
       const { query: originalQuery = {} } = pathMap
       const { page } = pathMap

diff --git a/packages/next/src/server/base-server.ts b/packages/next/src/server/base-server.ts
@@ -419,7 +419,7 @@ export default abstract class Server<ServerOptions extends Options = Options> {
 
     if (process.env.NEXT_RUNTIME !== 'edge') {
       if (this.nextConfig.experimental.deploymentId) {
-        process.env.__NEXT_DEPLOYMENT_ID =
+        process.env.NEXT_DEPLOYMENT_ID =
           this.nextConfig.experimental.deploymentId
       }
     }

diff --git a/packages/next/src/server/next-server.ts b/packages/next/src/server/next-server.ts
@@ -236,6 +236,10 @@ export default class NextNodeServer extends BaseServer {
       this.compression = require('next/dist/compiled/compression')()
     }
 
+    if (this.nextConfig.experimental.deploymentId) {
+      process.env.NEXT_DEPLOYMENT_ID = this.nextConfig.experimental.deploymentId
+    }
+
     if (!this.minimalMode) {
       this.imageResponseCache = new ResponseCache(this.minimalMode)
     }

diff --git a/packages/next/src/shared/lib/image-loader.ts b/packages/next/src/shared/lib/image-loader.ts
@@ -60,8 +60,8 @@ function defaultLoader({
   return `${config.path}?url=${encodeURIComponent(src)}&w=${width}&q=${
     quality || 75
   }${
-    process.env.__NEXT_DEPLOYMENT_ID
-      ? `&dpl=${process.env.__NEXT_DEPLOYMENT_ID}`
+    process.env.NEXT_DEPLOYMENT_ID
+      ? `&dpl=${process.env.NEXT_DEPLOYMENT_ID}`
       : ''
   }`
 }

diff --git a/test/production/deployment-id-handling/app/app/api/hello-app/route.ts b/test/production/deployment-id-handling/app/app/api/hello-app/route.ts
@@ -0,0 +1,9 @@
+import { NextResponse } from 'next/server'
+
+export const dynamic = 'force-dynamic'
+
+export function GET(req) {
+  return NextResponse.json({
+    deploymentId: process.env.NEXT_DEPLOYMENT_ID,
+  })
+}
diff --git a/test/production/deployment-id-handling/app/app/from-app/edge/page.tsx b/test/production/deployment-id-handling/app/app/from-app/edge/page.tsx
@@ -7,6 +7,7 @@ export default function Page() {
     <>
       <p>hello app edge</p>
       <Image src={testImage} alt="test" />
+      <p id="deploymentId">{process.env.NEXT_DEPLOYMENT_ID}</p>
 
       <button
         onClick={() => {

diff --git a/test/production/deployment-id-handling/app/app/from-app/page.tsx b/test/production/deployment-id-handling/app/app/from-app/page.tsx
@@ -7,6 +7,7 @@ export default function Page() {
     <>
       <p>hello app</p>
       <Image src={testImage} alt="test" />
+      <p id="deploymentId">{process.env.NEXT_DEPLOYMENT_ID}</p>
 
       <button
         onClick={() => {

diff --git a/test/production/deployment-id-handling/app/pages/api/hello.ts b/test/production/deployment-id-handling/app/pages/api/hello.ts
@@ -0,0 +1,3 @@
+export default function handler(_req, res) {
+  res.json({ deploymentId: process.env.NEXT_DEPLOYMENT_ID })
+}
diff --git a/test/production/deployment-id-handling/app/pages/index.tsx b/test/production/deployment-id-handling/app/pages/index.tsx
@@ -6,6 +6,7 @@ export default function Page() {
   return (
     <>
       <p className={styles.template}>hello pages</p>
+      <p id="deploymentId">{process.env.NEXT_DEPLOYMENT_ID}</p>
       <Image src={testImage} alt="test image" />
 
       <button

diff --git a/test/production/deployment-id-handling/app/pages/pages-edge.tsx b/test/production/deployment-id-handling/app/pages/pages-edge.tsx
@@ -6,6 +6,7 @@ export default function Page() {
     <>
       <p>hello pages edge</p>
       <Image src={testImage} alt="test image" />
+      <p id="deploymentId">{process.env.NEXT_DEPLOYMENT_ID}</p>
 
       <button
         onClick={() => {

diff --git a/test/production/deployment-id-handling/deployment-id-handling.test.ts b/test/production/deployment-id-handling/deployment-id-handling.test.ts
@@ -23,6 +23,8 @@ createNextDescribe(
       async ({ urlPath }) => {
         const $ = await next.render$(urlPath)
 
+        expect($('#deploymentId').text()).toBe(deploymentId)
+
         const scripts = Array.from($('script'))
         expect(scripts.length).toBeGreaterThan(0)
 
@@ -64,5 +66,16 @@ createNextDescribe(
         }
       }
     )
+
+    it.each([{ pathname: '/api/hello' }, { pathname: '/api/hello-app' }])(
+      'should have deployment id env available',
+      async ({ pathname }) => {
+        const res = await next.fetch(pathname)
+
+        expect(await res.json()).toEqual({
+          deploymentId,
+        })
+      }
+    )
   }
 )