Unverified Commit 62eb16b6 authored by Gal Schlezinger's avatar Gal Schlezinger Committed by GitHub

Upgrade edge-runtime + make EdgeRuntime value overridable with an env var on compilation (#38331)

This PR introduces an environment variable that allows to modify the `EdgeRuntime` value on compilation time.
This is done to allow cloud providers like Vercel to have a different value, and enable user code and 3rd party libraries to have different code paths depending on the Edge Functions provider.

## Related

- Related to #30739

## Bug

- [x] Related issues linked using `fixes #number`
- [x] Integration tests added
- [ ] Errors have helpful link attached, see `contributing.md`
parent 3ae15e16
......@@ -55,7 +55,7 @@
"@babel/plugin-proposal-object-rest-spread": "7.14.7",
"@babel/preset-flow": "7.14.5",
"@babel/preset-react": "7.14.5",
"@edge-runtime/jest-environment": "1.1.0-beta.10",
"@edge-runtime/jest-environment": "1.1.0-beta.11",
"@fullhuman/postcss-purgecss": "1.3.0",
"@mdx-js/loader": "0.18.0",
"@next/bundle-analyzer": "workspace:*",
......
......@@ -1497,7 +1497,14 @@ export default async function getBaseWebpackConfig(
...(compilerType !== 'edge-server'
? {}
: {
EdgeRuntime: JSON.stringify('edge-runtime'),
EdgeRuntime: JSON.stringify(
/**
* Cloud providers can set this environment variable to allow users
* and library authors to have different implementations based on
* the runtime they are running with, if it's not using `edge-runtime`
*/
process.env.NEXT_EDGE_RUNTIME_PROVIDER || 'edge-runtime'
),
}),
// TODO: enforce `NODE_ENV` on `process.env`, and add a test:
'process.env.NODE_ENV': JSON.stringify(
......
{"name":"@edge-runtime/primitives","version":"1.1.0-beta.10","main":"./index.js","license":"MPLv2"}
{"name":"@edge-runtime/primitives","version":"1.1.0-beta.11","main":"./index.js","license":"MPLv2"}
......@@ -118,7 +118,7 @@
"@babel/runtime": "7.15.4",
"@babel/traverse": "7.18.0",
"@babel/types": "7.18.0",
"@edge-runtime/primitives": "1.1.0-beta.10",
"@edge-runtime/primitives": "1.1.0-beta.11",
"@hapi/accept": "5.0.2",
"@napi-rs/cli": "2.4.4",
"@napi-rs/triples": "1.1.0",
......@@ -195,7 +195,7 @@
"debug": "4.1.1",
"devalue": "2.0.1",
"domain-browser": "4.19.0",
"edge-runtime": "1.1.0-beta.10",
"edge-runtime": "1.1.0-beta.11",
"etag": "1.8.1",
"events": "3.3.0",
"find-cache-dir": "3.3.1",
......
......@@ -19,7 +19,7 @@ importers:
'@babel/plugin-proposal-object-rest-spread': 7.14.7
'@babel/preset-flow': 7.14.5
'@babel/preset-react': 7.14.5
'@edge-runtime/jest-environment': 1.1.0-beta.10
'@edge-runtime/jest-environment': 1.1.0-beta.11
'@fullhuman/postcss-purgecss': 1.3.0
'@mdx-js/loader': 0.18.0
'@next/bundle-analyzer': workspace:*
......@@ -173,7 +173,7 @@ importers:
'@babel/plugin-proposal-object-rest-spread': 7.14.7_@babel+core@7.18.0
'@babel/preset-flow': 7.14.5_@babel+core@7.18.0
'@babel/preset-react': 7.14.5_@babel+core@7.18.0
'@edge-runtime/jest-environment': 1.1.0-beta.10
'@edge-runtime/jest-environment': 1.1.0-beta.11
'@fullhuman/postcss-purgecss': 1.3.0
'@mdx-js/loader': 0.18.0_uuaxwgga6hqycsez5ok7v2wg4i
'@next/bundle-analyzer': link:packages/next-bundle-analyzer
......@@ -416,7 +416,7 @@ importers:
'@babel/runtime': 7.15.4
'@babel/traverse': 7.18.0
'@babel/types': 7.18.0
'@edge-runtime/primitives': 1.1.0-beta.10
'@edge-runtime/primitives': 1.1.0-beta.11
'@hapi/accept': 5.0.2
'@napi-rs/cli': 2.4.4
'@napi-rs/triples': 1.1.0
......@@ -496,7 +496,7 @@ importers:
debug: 4.1.1
devalue: 2.0.1
domain-browser: 4.19.0
edge-runtime: 1.1.0-beta.10
edge-runtime: 1.1.0-beta.11
etag: 1.8.1
events: 3.3.0
find-cache-dir: 3.3.1
......@@ -610,7 +610,7 @@ importers:
'@babel/runtime': 7.15.4
'@babel/traverse': 7.18.0
'@babel/types': 7.18.0
'@edge-runtime/primitives': 1.1.0-beta.10
'@edge-runtime/primitives': 1.1.0-beta.11
'@hapi/accept': 5.0.2
'@napi-rs/cli': 2.4.4
'@napi-rs/triples': 1.1.0
......@@ -687,7 +687,7 @@ importers:
debug: 4.1.1
devalue: 2.0.1
domain-browser: 4.19.0
edge-runtime: 1.1.0-beta.10
edge-runtime: 1.1.0-beta.11
etag: 1.8.1
events: 3.3.0
find-cache-dir: 3.3.1
......@@ -3215,29 +3215,29 @@ packages:
protobufjs: 6.11.2
dev: true
/@edge-runtime/format/1.0.0:
resolution: {integrity: sha512-mxi0n00nJwnjaXUQIfTS7l64yvwGXs435gEjuDhzTHZyrmnCYdELXdJr3Q+6v4DO1mmmtNTYFHUvIlpCmMUC6g==}
/@edge-runtime/format/1.1.0-beta.11:
resolution: {integrity: sha512-RecFoPVDjTHbRvvbTSivTZM1Ia9v4hHDYeDpsCiuFstfpyJBUNK3StImPAsm89pfW1H9awqx4bVbYflm8ZzdOg==}
dev: true
/@edge-runtime/jest-environment/1.1.0-beta.10:
resolution: {integrity: sha512-RXZwWyra3yxs7TWGVy+8sDD2m2MAaTho92BBpaxcHWCEErJKzJIQT3UsA7rmvozcdr4vwbuTaFy/aL3AhsffdQ==}
/@edge-runtime/jest-environment/1.1.0-beta.11:
resolution: {integrity: sha512-BZiQBMrirKo2hbT9Imp1Krf/BlPPttFfqZ8K80R1jUDenlx9OEob0GHi9EkhGmf7uzO24Y+E7VXBHFcUR1IeGA==}
dependencies:
'@edge-runtime/vm': 1.1.0-beta.10
'@jest/environment': 28.1.1
'@jest/fake-timers': 28.1.1
'@edge-runtime/vm': 1.1.0-beta.11
'@jest/environment': 28.1.2
'@jest/fake-timers': 28.1.2
'@jest/types': 28.1.1
jest-mock: 28.1.1
jest-util: 28.1.1
dev: true
/@edge-runtime/primitives/1.1.0-beta.10:
resolution: {integrity: sha512-hv0i2ce35yspqlnmcSKV/GEKfk8WyB9aTSOk0ZMK6gOR6ZvBDCzDpdacIcGuktaTuDinwon2DLxXRhiAS2PjUg==}
/@edge-runtime/primitives/1.1.0-beta.11:
resolution: {integrity: sha512-E+EA8chHgBEC+hc8u0a8mGPAYovLGPdNbayD6GUS1boJpd8ivd5f4q59Jg/NM4TCS38QtEZnx9z7TIWUM0XqhQ==}
dev: true
/@edge-runtime/vm/1.1.0-beta.10:
resolution: {integrity: sha512-AHeIdWp1OUf4kvA4to56shXZzM66bR84LMNTbYGY7G3+BBr+VkUcvU+hWr8JYCOj/iAHi/fuE9r1TyrMm2pQaw==}
/@edge-runtime/vm/1.1.0-beta.11:
resolution: {integrity: sha512-1kgoF2TLbkSa3gHjJmCh/OvUOF8/wJ6mtihHWbB6XGQvSbIRgSQopWsWHRwwV5nOSSi7EbCGudrm3NYSuRR5/A==}
dependencies:
'@edge-runtime/primitives': 1.1.0-beta.10
'@edge-runtime/primitives': 1.1.0-beta.11
dev: true
/@emotion/is-prop-valid/0.8.8:
......@@ -3684,11 +3684,11 @@ packages:
jest-mock: 27.0.6
dev: true
/@jest/environment/28.1.1:
resolution: {integrity: sha512-9auVQ2GzQ7nrU+lAr8KyY838YahElTX9HVjbQPPS2XjlxQ+na18G113OoBhyBGBtD6ZnO/SrUy5WR8EzOj1/Uw==}
/@jest/environment/28.1.2:
resolution: {integrity: sha512-I0CR1RUMmOzd0tRpz10oUfaChBWs+/Hrvn5xYhMEF/ZqrDaaeHwS8yDBqEWCrEnkH2g+WE/6g90oBv3nKpcm8Q==}
engines: {node: ^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0}
dependencies:
'@jest/fake-timers': 28.1.1
'@jest/fake-timers': 28.1.2
'@jest/types': 28.1.1
'@types/node': 17.0.21
jest-mock: 28.1.1
......@@ -3706,8 +3706,8 @@ packages:
jest-util: 27.0.6
dev: true
/@jest/fake-timers/28.1.1:
resolution: {integrity: sha512-BY/3+TyLs5+q87rGWrGUY5f8e8uC3LsVHS9Diz8+FV3ARXL4sNnkLlIB8dvDvRrp+LUCGM+DLqlsYubizGUjIA==}
/@jest/fake-timers/28.1.2:
resolution: {integrity: sha512-xSYEI7Y0D5FbZN2LsCUj/EKRR1zfQYmGuAUVh6xTqhx7V5JhjgMcK5Pa0iR6WIk0GXiHDe0Ke4A+yERKE9saqg==}
engines: {node: ^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0}
dependencies:
'@jest/types': 28.1.1
......@@ -9985,12 +9985,12 @@ packages:
safe-buffer: 5.2.0
dev: true
/edge-runtime/1.1.0-beta.10:
resolution: {integrity: sha512-dFjK7DawBZl5OxGhfWR9JkFadF7dNkcZ2PxSgBQhF4L9S8Q1mj5Jt0Tng2Q7vwOEpRiNC4Xr3q1uvmLsgNc9eg==}
/edge-runtime/1.1.0-beta.11:
resolution: {integrity: sha512-2orDSNtEj46Vtj1DocDZe0grFDzZUnqjNYTuVuq04jIUB3GA2C+UlR2xELXj9FXvvz7tL88i/qr9rQo3PiqIrw==}
hasBin: true
dependencies:
'@edge-runtime/format': 1.0.0
'@edge-runtime/vm': 1.1.0-beta.10
'@edge-runtime/format': 1.1.0-beta.11
'@edge-runtime/vm': 1.1.0-beta.11
exit-hook: 2.2.1
http-status: 1.5.2
mri: 1.2.0
......
......@@ -4,35 +4,42 @@ import { fetchViaHTTP } from 'next-test-utils'
import fs from 'fs-extra'
import path from 'path'
const files = {
'pages/index.js': `
export default function Page() {
return <p>hello world</p>
}
`,
'middleware.js': `
import { NextResponse } from 'next/server'
if (typeof EdgeRuntime === 'undefined') {
console.log("EdgeRuntime is undefined");
} else {
console.log("EdgeRuntime is defined");
}
export default (req) => {
return NextResponse.next({
headers: {
'x-runtime-version': EdgeRuntime,
'x-runtime-version-dynamic': getDynamicRuntimeVersion(self)
}
})
}
function getDynamicRuntimeVersion(from) {
return from.EdgeRuntime;
}
`,
}
describe('Edge Runtime is addressable', () => {
let next: NextInstance
beforeAll(async () => {
next = await createNext({
files: {
'pages/index.js': `
export default function Page() {
return <p>hello world</p>
}
`,
'middleware.js': `
import { NextResponse } from 'next/server'
if (typeof EdgeRuntime === 'undefined') {
console.log("EdgeRuntime is undefined");
} else {
console.log("EdgeRuntime is defined");
}
export default (req) => {
return NextResponse.next({
headers: {
'x-runtime-version': EdgeRuntime
}
})
}
`,
},
files,
dependencies: {},
})
})
......@@ -43,6 +50,7 @@ describe('Edge Runtime is addressable', () => {
expect(await resp.text()).toContain('hello world')
expect(Object.fromEntries(resp.headers)).toMatchObject({
'x-runtime-version': 'edge-runtime',
'x-runtime-version-dynamic': 'edge-runtime',
})
})
......@@ -56,3 +64,29 @@ describe('Edge Runtime is addressable', () => {
expect(compiledMiddlewareFile).not.toContain('EdgeRuntime is undefined')
})
})
describe('Edge Runtime can be set to the production provider', () => {
let next: NextInstance
beforeAll(async () => {
next = await createNext({
files,
dependencies: {},
env: {
NEXT_EDGE_RUNTIME_PROVIDER: 'vercel',
},
})
})
afterAll(() => next.destroy())
test('EdgeRuntime evaluates to a string', async () => {
const resp = await fetchViaHTTP(next.url, '/')
expect(await resp.text()).toContain('hello world')
expect(Object.fromEntries(resp.headers)).toMatchObject({
'x-runtime-version': 'vercel',
// We don't test for x-runtime-version-dynamic here
// because the tests are using edge-runtime and not Vercel
// as the provider.
})
})
})
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment