refactor and extract util

vercel · Jul 15, 2024 · 06110c7 · 06110c7
1 parent e296664
commit 06110c7
Show file tree

Hide file tree

Showing 7 changed files with 32 additions and 51 deletions.
diff --git a/packages/next/src/build/webpack/loaders/next-edge-ssr-loader/render.ts b/packages/next/src/build/webpack/loaders/next-edge-ssr-loader/render.ts
@@ -20,6 +20,7 @@ import { internal_getCurrentFunctionWaitUntil } from '../../../../server/web/int
 import type { PAGE_TYPES } from '../../../../lib/page-types'
 import type { NextRequestHint } from '../../../../server/web/adapter'
 import type { DeepReadonly } from '../../../../shared/lib/deep-readonly'
+import { getEdgePreviewProps } from '../../../../server/web/get-edge-preview-props'
 
 export function getRender({
   dev,
@@ -91,16 +92,7 @@ export function getRender({
       prerenderManifest: prerenderManifest
         ? {
             ...prerenderManifest,
-            preview: {
-              previewModeId:
-                process.env.NODE_ENV === 'production'
-                  ? process.env.__NEXT_PREVIEW_MODE_ID!
-                  : 'development-id',
-              previewModeSigningKey:
-                process.env.__NEXT_PREVIEW_MODE_SIGNING_KEY!,
-              previewModeEncryptionKey:
-                process.env.__NEXT_PREVIEW_MODE_ENCRYPTION_KEY!,
-            },
+            preview: getEdgePreviewProps(),
           }
         : undefined,
       interceptionRouteRewrites,

diff --git a/packages/next/src/server/async-storage/draft-mode-provider.ts b/packages/next/src/server/async-storage/draft-mode-provider.ts
@@ -42,6 +42,7 @@ export class DraftModeProvider {
         cookieValue &&
         previewProps &&
         (cookieValue === previewProps.previewModeId ||
+          // In dev mode, the cookie can be actual hash value preview id but the preview props can still be `development-id`.
           (process.env.NODE_ENV !== 'production' &&
             previewProps.previewModeId === 'development-id'))
     )

diff --git a/packages/next/src/server/web-server.ts b/packages/next/src/server/web-server.ts
@@ -36,6 +36,7 @@ import { UNDERSCORE_NOT_FOUND_ROUTE } from '../api/constants'
 import type { DeepReadonly } from '../shared/lib/deep-readonly'
 import { getEdgeInstrumentationModule } from './web/globals'
 import type { ServerOnInstrumentationRequestError } from './app-render/types'
+import { getEdgePreviewProps } from './web/get-edge-preview-props'
 
 interface WebServerOptions extends Options {
   webServerConfig: {
@@ -146,16 +147,7 @@ export default class NextWebServer extends BaseServer<
         routes: {},
         dynamicRoutes: {},
         notFoundRoutes: [],
-        preview: {
-          previewModeId:
-            process.env.NODE_ENV === 'production'
-              ? process.env.__NEXT_PREVIEW_MODE_ID!
-              : 'development-id',
-          previewModeSigningKey:
-            process.env.__NEXT_PREVIEW_MODE_SIGNING_KEY || '',
-          previewModeEncryptionKey:
-            process.env.__NEXT_PREVIEW_MODE_ENCRYPTION_KEY || '',
-        } as any, // `preview` is special case read in next-dev-server
+        preview: getEdgePreviewProps(),
       }
     }
     return prerenderManifest

diff --git a/packages/next/src/server/web/adapter.ts b/packages/next/src/server/web/adapter.ts
@@ -21,6 +21,7 @@ import { getTracer } from '../lib/trace/tracer'
 import type { TextMapGetter } from 'next/dist/compiled/@opentelemetry/api'
 import { MiddlewareSpan } from '../lib/trace/constants'
 import { CloseController } from './web-on-close'
+import { getEdgePreviewProps } from './get-edge-preview-props'
 
 export class NextRequestHint extends NextRequest {
   sourcePage: string
@@ -191,16 +192,7 @@ export async function adapter(
           routes: {},
           dynamicRoutes: {},
           notFoundRoutes: [],
-          preview: {
-            previewModeId:
-              process.env.NODE_ENV === 'production'
-                ? process.env.__NEXT_PREVIEW_MODE_ID!
-                : 'development-id',
-            previewModeSigningKey:
-              process.env.__NEXT_PREVIEW_MODE_SIGNING_KEY || '',
-            previewModeEncryptionKey:
-              process.env.__NEXT_PREVIEW_MODE_ENCRYPTION_KEY || '',
-          } as any, // `preview` is special case read in next-dev-server
+          preview: getEdgePreviewProps(),
         }
       },
     })
@@ -242,17 +234,7 @@ export async function adapter(
         },
         async () => {
           try {
-            // For edge runtime, preview props are injected through the environment variables
-            const previewProps = {
-              previewModeId:
-                process.env.NODE_ENV === 'production'
-                  ? process.env.__NEXT_PREVIEW_MODE_ID!
-                  : 'development-id',
-              previewModeSigningKey:
-                process.env.__NEXT_PREVIEW_MODE_SIGNING_KEY || '',
-              previewModeEncryptionKey:
-                process.env.__NEXT_PREVIEW_MODE_ENCRYPTION_KEY || '',
-            }
+            const previewProps = getEdgePreviewProps()
 
             return await withRequestStore(
               requestAsyncStorage,

diff --git a/packages/next/src/server/web/edge-route-module-wrapper.ts b/packages/next/src/server/web/edge-route-module-wrapper.ts
@@ -15,6 +15,7 @@ import { getUtils } from '../server-utils'
 import { searchParamsToUrlQuery } from '../../shared/lib/router/utils/querystring'
 import type { RequestLifecycleOpts } from '../base-server'
 import { CloseController, trackStreamConsumed } from './web-on-close'
+import { getEdgePreviewProps } from './get-edge-preview-props'
 
 type WrapOptions = Partial<Pick<AdapterOptions, 'page'>>
 
@@ -93,15 +94,7 @@ export class EdgeRouteModuleWrapper {
       closeController = new CloseController()
     }
 
-    const previewProps = {
-      previewModeId:
-        process.env.NODE_ENV === 'production'
-          ? process.env.__NEXT_PREVIEW_MODE_ID!
-          : 'development-id',
-      previewModeSigningKey: process.env.__NEXT_PREVIEW_MODE_SIGNING_KEY || '',
-      previewModeEncryptionKey:
-        process.env.__NEXT_PREVIEW_MODE_ENCRYPTION_KEY || '',
-    }
+    const previewProps = getEdgePreviewProps()
 
     // Create the context for the handler. This contains the params from the
     // match (if any).

diff --git a/packages/next/src/server/web/get-edge-preview-props.ts b/packages/next/src/server/web/get-edge-preview-props.ts
@@ -0,0 +1,16 @@
+/**
+ * In edge runtime, these props directly accessed from environment variables.
+ *   - local: env vars will be injected through edge-runtime as runtime env vars
+ *   - deployment: env vars will be replaced by edge build pipeline
+ */
+export function getEdgePreviewProps() {
+  return {
+    previewModeId:
+      process.env.NODE_ENV === 'production'
+        ? process.env.__NEXT_PREVIEW_MODE_ID!
+        : 'development-id',
+    previewModeSigningKey: process.env.__NEXT_PREVIEW_MODE_SIGNING_KEY || '',
+    previewModeEncryptionKey:
+      process.env.__NEXT_PREVIEW_MODE_ENCRYPTION_KEY || '',
+  }
+}
diff --git a/test/e2e/app-dir/draft-mode-middleware/draft-mode-middleware.test.ts b/test/e2e/app-dir/draft-mode-middleware/draft-mode-middleware.test.ts
@@ -2,10 +2,15 @@ import { nextTestSetup } from 'e2e-utils'
 import { retry } from 'next-test-utils'
 
 describe('app-dir - draft-mode-middleware', () => {
-  const { next } = nextTestSetup({
+  const { next, skipped } = nextTestSetup({
     files: __dirname,
+    skipDeployment: true,
   })
 
+  if (skipped) {
+    return
+  }
+
   it('should be able to enable draft mode with middleware present', async () => {
     const browser = await next.browser(
       '/api/draft?secret=secret-token&slug=preview-page'