feat: support edge runtime key (#2036)

sarahetter · web-flow · commit b7b939210661 · 2023-04-12T18:07:24.000Z
* feat: add support for edge key

* feat: refactor

* feat: switch demos to edge

* fix: add helper function
diff --git a/demos/default/pages/api/og.tsx b/demos/default/pages/api/og.tsx
@@ -2,7 +2,7 @@ import { ImageResponse } from '@vercel/og'
 import { NextRequest } from 'next/server'
 
 export const config = {
-  runtime: 'experimental-edge',
+  runtime: 'edge',
 }
 
 export default async function handler(req: NextRequest) {
diff --git a/demos/middleware/pages/api/edge.ts b/demos/middleware/pages/api/edge.ts
@@ -1,5 +1,5 @@
 export const config = {
-  runtime: 'experimental-edge',
+  runtime: 'edge',
 }
 
 export default (req) => new Response('Hello world!')
diff --git a/packages/runtime/src/helpers/analysis.ts b/packages/runtime/src/helpers/analysis.ts
@@ -11,7 +11,7 @@ export const enum ApiRouteType {
 
 export interface ApiStandardConfig {
   type?: never
-  runtime?: 'nodejs' | 'experimental-edge'
+  runtime?: 'nodejs' | 'experimental-edge' | 'edge'
   schedule?: never
 }
 
@@ -29,6 +29,8 @@ export interface ApiBackgroundConfig {
 
 export type ApiConfig = ApiStandardConfig | ApiScheduledConfig | ApiBackgroundConfig
 
+export const isEdgeConfig = (config: string) => ['experimental-edge', 'edge'].includes(config)
+
 export const validateConfigValue = (config: ApiConfig, apiFilePath: string): config is ApiConfig => {
   if (config.type === ApiRouteType.SCHEDULED) {
     if (!config.schedule) {
@@ -39,7 +41,7 @@ export const validateConfigValue = (config: ApiConfig, apiFilePath: string): con
       )
       return false
     }
-    if ((config as ApiConfig).runtime === 'experimental-edge') {
+    if (isEdgeConfig((config as ApiConfig).runtime)) {
       console.error(
         `Invalid config value in ${relative(
           process.cwd(),
@@ -60,7 +62,7 @@ export const validateConfigValue = (config: ApiConfig, apiFilePath: string): con
       )
       return false
     }
-    if (config.type && (config as ApiConfig).runtime === 'experimental-edge') {
+    if (config.type && isEdgeConfig((config as ApiConfig).runtime)) {
       console.error(
         `Invalid config value in ${relative(
           process.cwd(),
diff --git a/packages/runtime/src/helpers/functions.ts b/packages/runtime/src/helpers/functions.ts
@@ -20,7 +20,7 @@ import { getApiHandler } from '../templates/getApiHandler'
 import { getHandler } from '../templates/getHandler'
 import { getResolverForPages, getResolverForSourceFiles } from '../templates/getPageResolver'
 
-import { ApiConfig, ApiRouteType, extractConfigFromFile } from './analysis'
+import { ApiConfig, ApiRouteType, extractConfigFromFile, isEdgeConfig } from './analysis'
 import { getSourceFileForPage } from './files'
 import { writeFunctionConfiguration } from './functionsMetaData'
 import { getFunctionNameForPage } from './utils'
@@ -43,7 +43,7 @@ export const generateFunctions = async (
 
   for (const { route, config, compiled } of apiRoutes) {
     // Don't write a lambda if the runtime is edge
-    if (config.runtime === 'experimental-edge') {
+    if (isEdgeConfig(config.runtime)) {
       continue
     }
     const apiHandlerSource = await getApiHandler({
diff --git a/test/e2e/app-dir/app-edge-global/next.config.js b/test/e2e/app-dir/app-edge-global/next.config.js
@@ -1,6 +1,6 @@
 module.exports = {
   experimental: {
     appDir: true,
-    runtime: 'experimental-edge',
+    runtime: 'edge',
   },
 }
diff --git a/test/e2e/app-dir/app-edge/app/app-edge/page.tsx b/test/e2e/app-dir/app-edge/app/app-edge/page.tsx
@@ -5,4 +5,4 @@ export default function Page() {
   return <p>Node!</p>
 }
 
-export const runtime = 'experimental-edge'
+export const runtime = 'edge'
diff --git a/test/e2e/app-dir/app-edge/pages/pages-edge.tsx b/test/e2e/app-dir/app-edge/pages/pages-edge.tsx
@@ -2,4 +2,4 @@ export default function Page() {
   return <p>pages-edge-ssr</p>
 }
 
-export const config = { runtime: 'experimental-edge' }
+export const config = { runtime: 'edge' }
diff --git a/test/e2e/app-dir/app-middleware/pages/api/dump-headers-edge.js b/test/e2e/app-dir/app-middleware/pages/api/dump-headers-edge.js
@@ -1,5 +1,5 @@
 export const config = {
-  runtime: 'experimental-edge',
+  runtime: 'edge',
 }
 
 export default (req) => {
diff --git a/test/e2e/app-dir/app/app/(rootonly)/dashboard/hello/page.js b/test/e2e/app-dir/app/app/(rootonly)/dashboard/hello/page.js
@@ -6,4 +6,4 @@ export default function HelloPage(props) {
   )
 }
 
-export const runtime = 'experimental-edge'
+export const runtime = 'edge'
diff --git a/test/e2e/app-dir/app/app/dashboard/page.js b/test/e2e/app-dir/app/app/dashboard/page.js
@@ -13,4 +13,4 @@ export default function DashboardPage(props) {
   )
 }
 
-export const runtime = 'experimental-edge'
+export const runtime = 'edge'
diff --git a/test/e2e/app-dir/app/app/edge-apis/cookies/page.js b/test/e2e/app-dir/app/app/edge-apis/cookies/page.js
@@ -1,6 +1,6 @@
 import { cookies } from 'next/headers'
 
-export const runtime = 'experimental-edge'
+export const runtime = 'edge'
 
 export default function Page() {
   cookies()
diff --git a/test/e2e/app-dir/app/app/slow-page-no-loading/page.js b/test/e2e/app-dir/app/app/slow-page-no-loading/page.js
@@ -13,4 +13,4 @@ export default function SlowPage(props) {
   return <h1 id="slow-page-message">{data.message}</h1>
 }
 
-export const runtime = 'experimental-edge'
+export const runtime = 'edge'
diff --git a/test/e2e/app-dir/app/app/slow-page-with-loading/page.js b/test/e2e/app-dir/app/app/slow-page-with-loading/page.js
@@ -13,4 +13,4 @@ export default function SlowPage(props) {
   return <h1 id="slow-page-message">{data.message}</h1>
 }
 
-export const runtime = 'experimental-edge'
+export const runtime = 'edge'
diff --git a/test/e2e/app-dir/app/pages/api/hello.js b/test/e2e/app-dir/app/pages/api/hello.js
@@ -3,5 +3,5 @@ export default function api(req) {
 }
 
 export const config = {
-  runtime: 'experimental-edge',
+  runtime: 'edge',
 }
diff --git a/test/e2e/app-dir/next-font/app/page.js b/test/e2e/app-dir/next-font/app/page.js
@@ -13,4 +13,4 @@ export default function HomePage() {
   )
 }
 
-export const runtime = 'experimental-edge'
+export const runtime = 'edge'
diff --git a/test/e2e/app-dir/next-image/app/page.js b/test/e2e/app-dir/next-image/app/page.js
@@ -12,4 +12,4 @@ export default function Page() {
   )
 }
 
-export const runtime = 'experimental-edge'
+export const runtime = 'edge'
diff --git a/test/e2e/app-dir/rsc-basic/app/edge/dynamic/[id]/page.js b/test/e2e/app-dir/rsc-basic/app/edge/dynamic/[id]/page.js
@@ -2,4 +2,4 @@ export default function page() {
   return 'dynamic route [id] page'
 }
 
-export const runtime = 'experimental-edge'
+export const runtime = 'edge'
diff --git a/test/e2e/app-dir/rsc-basic/app/edge/dynamic/page.js b/test/e2e/app-dir/rsc-basic/app/edge/dynamic/page.js
@@ -2,4 +2,4 @@ export default function page() {
   return 'dynamic route index page'
 }
 
-export const runtime = 'experimental-edge'
+export const runtime = 'edge'
diff --git a/test/e2e/disabled-tests/edge-render-getserversideprops/app/pages/[id].js b/test/e2e/disabled-tests/edge-render-getserversideprops/app/pages/[id].js
@@ -1,5 +1,5 @@
 export const config = {
-  runtime: 'experimental-edge',
+  runtime: 'edge',
 }
 
 export default function Page(props) {
diff --git a/test/e2e/disabled-tests/edge-render-getserversideprops/app/pages/index.js b/test/e2e/disabled-tests/edge-render-getserversideprops/app/pages/index.js
@@ -1,5 +1,5 @@
 export const config = {
-  runtime: 'experimental-edge',
+  runtime: 'edge',
 }
 
 export default function Page(props) {
diff --git a/test/e2e/disabled-tests/middleware-request-header-overrides/app/pages/api/dump-headers-edge.js b/test/e2e/disabled-tests/middleware-request-header-overrides/app/pages/api/dump-headers-edge.js
@@ -1,5 +1,5 @@
 export const config = {
-  runtime: 'experimental-edge',
+  runtime: 'edge',
 }
 
 export default (req) => {
diff --git a/test/e2e/modified-tests/edge-can-use-wasm-files/index.test.ts b/test/e2e/modified-tests/edge-can-use-wasm-files/index.test.ts
@@ -49,7 +49,7 @@ describe('edge api endpoints can use wasm files', () => {
             const value = await increment(input);
             return new Response(null, { headers: { data: JSON.stringify({ input, value }) } });
           }
-          export const config = { runtime: 'experimental-edge' };
+          export const config = { runtime: 'edge' };
         `,
         'src/add.wasm': new FileRef(path.join(__dirname, './add.wasm')),
         'src/add.js': `
diff --git a/test/e2e/modified-tests/edge-compiler-can-import-blob-assets/app/pages/api/edge.js b/test/e2e/modified-tests/edge-compiler-can-import-blob-assets/app/pages/api/edge.js
@@ -1,4 +1,4 @@
-export const config = { runtime: 'experimental-edge' }
+export const config = { runtime: 'edge' }
 
 /**
  * @param {import('next/server').NextRequest} req
diff --git a/test/e2e/modified-tests/middleware-general/app/pages/api/edge-search-params.js b/test/e2e/modified-tests/middleware-general/app/pages/api/edge-search-params.js
@@ -1,6 +1,6 @@
 import { NextResponse } from 'next/server'
 
-export const config = { runtime: 'experimental-edge', regions: 'default' }
+export const config = { runtime: 'edge', regions: 'default' }
 
 /**
  * @param {import('next/server').NextRequest}
diff --git a/test/e2e/modified-tests/skip-trailing-slash-redirect/app/pages/api/test-cookie-edge.js b/test/e2e/modified-tests/skip-trailing-slash-redirect/app/pages/api/test-cookie-edge.js
@@ -1,7 +1,7 @@
 import { NextResponse } from 'next/server'
 
 export const config = {
-  runtime: 'experimental-edge',
+  runtime: 'edge',
 }
 
 export default function handler(req) {
diff --git a/test/e2e/modified-tests/streaming-ssr/streaming-ssr/pages/api/user/[id].js b/test/e2e/modified-tests/streaming-ssr/streaming-ssr/pages/api/user/[id].js
@@ -3,5 +3,5 @@ export default async function handler() {
 }
 
 export const config = {
-  runtime: 'experimental-edge',
+  runtime: 'edge',
 }
diff --git a/test/e2e/modified-tests/streaming-ssr/streaming-ssr/pages/hello.js b/test/e2e/modified-tests/streaming-ssr/streaming-ssr/pages/hello.js
@@ -9,4 +9,4 @@ export default function Page() {
   )
 }
 
-export const config = { runtime: 'experimental-edge' }
+export const config = { runtime: 'edge' }
diff --git a/test/e2e/modified-tests/streaming-ssr/streaming-ssr/pages/index.js b/test/e2e/modified-tests/streaming-ssr/streaming-ssr/pages/index.js
@@ -11,4 +11,4 @@ export default function Page() {
   )
 }
 
-export const config = { runtime: 'experimental-edge' }
+export const config = { runtime: 'edge' }
diff --git a/test/e2e/modified-tests/streaming-ssr/streaming-ssr/pages/multi-byte.js b/test/e2e/modified-tests/streaming-ssr/streaming-ssr/pages/multi-byte.js
@@ -6,4 +6,4 @@ export default function Page() {
   )
 }
 
-export const config = { runtime: 'experimental-edge' }
+export const config = { runtime: 'edge' }
diff --git a/test/e2e/modified-tests/streaming-ssr/streaming-ssr/pages/router.js b/test/e2e/modified-tests/streaming-ssr/streaming-ssr/pages/router.js
@@ -7,5 +7,5 @@ export default () => {
 }
 
 export const config = {
-  runtime: 'experimental-edge',
+  runtime: 'edge',
 }
diff --git a/test/e2e/tests/edge-api-endpoints-can-receive-body/app/pages/api/edge.js b/test/e2e/tests/edge-api-endpoints-can-receive-body/app/pages/api/edge.js
@@ -7,5 +7,5 @@ export default async (req) => {
 }
 
 export const config = {
-  runtime: 'experimental-edge',
+  runtime: 'edge',
 }
diff --git a/test/e2e/tests/edge-api-endpoints-can-receive-body/app/pages/api/index.js b/test/e2e/tests/edge-api-endpoints-can-receive-body/app/pages/api/index.js
@@ -7,5 +7,5 @@ export default async (req) => {
 }
 
 export const config = {
-  runtime: 'experimental-edge',
+  runtime: 'edge',
 }
diff --git a/test/e2e/tests/og-api/app/pages/api/og.js b/test/e2e/tests/og-api/app/pages/api/og.js
@@ -2,7 +2,7 @@
 import { ImageResponse } from '@vercel/og'
 
 export const config = {
-  runtime: 'experimental-edge',
+  runtime: 'edge',
 }
 
 export default function () {
@@ -21,6 +21,6 @@ export default function () {
       >
         Hello!
       </div>
-    )
+    ),
   )
 }
diff --git a/test/fixtures/analysis/background-edge.ts b/test/fixtures/analysis/background-edge.ts
@@ -6,5 +6,5 @@ export default (req, res) => {
 
 export const config = {
   type: 'experimental-background',
-  runtime: 'experimental-edge',
+  runtime: 'edge',
 }
diff --git a/test/fixtures/analysis/scheduled-edge.ts b/test/fixtures/analysis/scheduled-edge.ts
@@ -7,5 +7,5 @@ export default (req, res) => {
 export const config = {
   type: 'experimental-scheduled',
   schedule: '@daily',
-  runtime: 'experimental-edge',
+  runtime: 'edge',
 }

Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@ import { ImageResponse } from '@vercel/og'`
`2`	`2`	`import { NextRequest } from 'next/server'`
`3`	`3`
`4`	`4`	`export const config = {`
`5`		`- runtime: 'experimental-edge',`
	`5`	`+ runtime: 'edge',`
`6`	`6`	`}`
`7`	`7`
`8`	`8`	`export default async function handler(req: NextRequest) {`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`export const config = {`
`2`		`- runtime: 'experimental-edge',`
	`2`	`+ runtime: 'edge',`
`3`	`3`	`}`
`4`	`4`
`5`	`5`	`export default (req) => new Response('Hello world!')`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ export const enum ApiRouteType {`
`11`	`11`
`12`	`12`	`export interface ApiStandardConfig {`
`13`	`13`	`type?: never`
`14`		`- runtime?: 'nodejs' \| 'experimental-edge'`
	`14`	`+ runtime?: 'nodejs' \| 'experimental-edge' \| 'edge'`
`15`	`15`	`schedule?: never`
`16`	`16`	`}`
`17`	`17`
`@@ -29,6 +29,8 @@ export interface ApiBackgroundConfig {`
`29`	`29`
`30`	`30`	`export type ApiConfig = ApiStandardConfig \| ApiScheduledConfig \| ApiBackgroundConfig`
`31`	`31`
	`32`	`+export const isEdgeConfig = (config: string) => ['experimental-edge', 'edge'].includes(config)`
	`33`	`+`
`32`	`34`	`export const validateConfigValue = (config: ApiConfig, apiFilePath: string): config is ApiConfig => {`
`33`	`35`	`if (config.type === ApiRouteType.SCHEDULED) {`
`34`	`36`	`if (!config.schedule) {`
`@@ -39,7 +41,7 @@ export const validateConfigValue = (config: ApiConfig, apiFilePath: string): con`
`39`	`41`	`)`
`40`	`42`	`return false`
`41`	`43`	`}`
`42`		`- if ((config as ApiConfig).runtime === 'experimental-edge') {`
	`44`	`+ if (isEdgeConfig((config as ApiConfig).runtime)) {`
`43`	`45`	`console.error(`
`44`	`46`	`Invalid config value in ${relative(
`45`	`47`	`process.cwd(),`
`@@ -60,7 +62,7 @@ export const validateConfigValue = (config: ApiConfig, apiFilePath: string): con`
`60`	`62`	`)`
`61`	`63`	`return false`
`62`	`64`	`}`
`63`		`- if (config.type && (config as ApiConfig).runtime === 'experimental-edge') {`
	`65`	`+ if (config.type && isEdgeConfig((config as ApiConfig).runtime)) {`
`64`	`66`	`console.error(`
`65`	`67`	`Invalid config value in ${relative(
`66`	`68`	`process.cwd(),`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`module.exports = {`
`2`	`2`	`experimental: {`
`3`	`3`	`appDir: true,`
`4`		`- runtime: 'experimental-edge',`
	`4`	`+ runtime: 'edge',`
`5`	`5`	`},`
`6`	`6`	`}`
Original file line number	Diff line number	Diff line change
`@@ -5,4 +5,4 @@ export default function Page() {`
`5`	`5`	`return <p>Node!</p>`
`6`	`6`	`}`
`7`	`7`
`8`		`-export const runtime = 'experimental-edge'`
	`8`	`+export const runtime = 'edge'`
Original file line number	Diff line number	Diff line change
`@@ -2,4 +2,4 @@ export default function Page() {`
`2`	`2`	`return <p>pages-edge-ssr</p>`
`3`	`3`	`}`
`4`	`4`
`5`		`-export const config = { runtime: 'experimental-edge' }`
	`5`	`+export const config = { runtime: 'edge' }`
Original file line number	Diff line number	Diff line change
`@@ -6,4 +6,4 @@ export default function HelloPage(props) {`
`6`	`6`	`)`
`7`	`7`	`}`
`8`	`8`
`9`		`-export const runtime = 'experimental-edge'`
	`9`	`+export const runtime = 'edge'`
Original file line number	Diff line number	Diff line change
`@@ -13,4 +13,4 @@ export default function DashboardPage(props) {`
`13`	`13`	`)`
`14`	`14`	`}`
`15`	`15`
`16`		`-export const runtime = 'experimental-edge'`
	`16`	`+export const runtime = 'edge'`