Skip to content

Commit 90bb11b

Browse files
lukasholzerlukasholzer
authored
tests: add test setup for edge functions (#84)
* tests: add test setup for edge functions chore: update * chore: update * chore: install deno on CI * chore: install specific deno version to match edge-bundler * chore: update test sharding * chore: update path * chore: update * chore: increase timings * chore: fight flakyness with more hardware * chore: fix sharding * chore: increase timeout
1 parent a31816e commit 90bb11b

File tree

26 files changed

+985
-59
lines changed

26 files changed

+985
-59
lines changed

‎.github/workflows/run-tests.yml

+6-1
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ jobs:
5050
runs-on: ubuntu-latest
5151
strategy:
5252
matrix:
53-
shard: [1/3, 2/3, 3/3]
53+
shard: [1/5, 2/5, 3/5, 4/5, 5/5]
5454
steps:
5555
- uses: actions/checkout@v4
5656
- name: 'Install Node'
@@ -59,6 +59,11 @@ jobs:
5959
node-version: '18.x'
6060
cache: 'npm'
6161
cache-dependency-path: '**/package-lock.json'
62+
- name: Install Deno
63+
uses: denoland/setup-deno@v1
64+
with:
65+
# Should match the `DENO_VERSION_RANGE` from https://github.com/netlify/edge-bundler/blob/e55f825bd985d3c92e21d1b765d71e70d5628fba/node/bridge.ts#L17
66+
deno-version: v1.37.0
6267
- name: 'Install dependencies'
6368
run: npm ci
6469
- name: 'Build'

‎.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,5 @@ dist/
88
/playwright-report/
99
/blob-report/
1010
/playwright/.cache/
11+
12+
deno.lock

‎.vscode/settings.json

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"deno.enablePaths": ["tools/deno", "edge-runtime"],
3+
"deno.unstable": true
4+
}

‎deno.json

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"lint": {
3+
"files": {
4+
"include": ["edge-runtime/middleware.ts"]
5+
}
6+
}
7+
}

‎edge-runtime/middleware.ts

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
import type { Config, Context } from '@netlify/edge-functions'
2+
3+
// import nextConfig from '../edge-shared/nextConfig.json' assert { type: 'json' }
4+
5+
export async function handleMiddleware(req: Request, context: Context, nextHandler: () => any) {
6+
// Don't run in dev
7+
if (Deno.env.get('NETLIFY_DEV')) {
8+
return
9+
}
10+
11+
const url = new URL(req.url)
12+
console.log('from handleMiddleware', url)
13+
// const req = new IncomingMessage(internalEvent);
14+
// const res = new ServerlessResponse({
15+
// method: req.method ?? "GET",
16+
// headers: {},
17+
// });
18+
//
19+
// const request = buildNextRequest(req, context, nextConfig)
20+
21+
return Response.json({ success: true })
22+
}

‎package-lock.json

+13
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎package.json

+2
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
"type": "module",
77
"files": [
88
"dist",
9+
"edge-runtime",
910
"manifest.yml"
1011
],
1112
"engines": {
@@ -50,6 +51,7 @@
5051
"p-limit": "^4.0.0"
5152
},
5253
"devDependencies": {
54+
"@netlify/edge-functions": "^2.2.0",
5355
"@netlify/eslint-config-node": "^7.0.1",
5456
"@netlify/serverless-functions-api": "^1.10.1",
5557
"@netlify/zip-it-and-ship-it": "^9.25.5",

‎src/build/config.ts

+8
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
import type { NetlifyPluginConstants, NetlifyPluginOptions } from '@netlify/build'
22
import type { PrerenderManifest } from 'next/dist/build/index.js'
3+
import { MiddlewareManifest } from 'next/dist/build/webpack/plugins/middleware-plugin.js'
34
import { readFile } from 'node:fs/promises'
45
import { resolve } from 'node:path'
56
import { SERVER_HANDLER_NAME } from './constants.js'
@@ -10,6 +11,13 @@ export const getPrerenderManifest = async ({
1011
return JSON.parse(await readFile(resolve(PUBLISH_DIR, 'prerender-manifest.json'), 'utf-8'))
1112
}
1213

14+
/**
15+
* Get Next.js middleware config from the build output
16+
*/
17+
export const getMiddlewareManifest = async (): Promise<MiddlewareManifest> => {
18+
return JSON.parse(await readFile(resolve('.next/server/middleware-manifest.json'), 'utf-8'))
19+
}
20+
1321
/**
1422
* Enable Next.js standalone mode at build time
1523
*/

‎src/build/functions/edge.ts

+143-11
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,144 @@
1-
import { mkdir, rm } from 'node:fs/promises'
2-
import { join } from 'node:path'
3-
import { EDGE_HANDLER_DIR } from '../constants.js'
4-
5-
/**
6-
* Create a Netlify edge function to run the Next.js server
7-
*/
8-
export const createEdgeHandler = async () => {
9-
// reset the handler directory
10-
await rm(join(process.cwd(), EDGE_HANDLER_DIR), { recursive: true, force: true })
11-
await mkdir(join(process.cwd(), EDGE_HANDLER_DIR), { recursive: true })
1+
import type { EdgeFunctionDefinition as NextDefinition } from 'next/dist/build/webpack/plugins/middleware-plugin.js'
2+
import { cp, mkdir, readFile, rm, writeFile } from 'node:fs/promises'
3+
import { dirname, join, relative, resolve } from 'node:path'
4+
import { getMiddlewareManifest } from '../config.js'
5+
import {
6+
EDGE_FUNCTIONS_DIR,
7+
EDGE_HANDLER_NAME,
8+
PLUGIN_DIR,
9+
PLUGIN_NAME,
10+
PLUGIN_VERSION,
11+
} from '../constants.js'
12+
13+
interface NetlifyManifest {
14+
version: 1
15+
functions: NetlifyDefinition[]
16+
}
17+
18+
type NetlifyDefinition =
19+
| {
20+
function: string
21+
name?: string
22+
path: string
23+
cache?: 'manual'
24+
generator: string
25+
}
26+
| {
27+
function: string
28+
name?: string
29+
pattern: string
30+
cache?: 'manual'
31+
generator: string
32+
}
33+
34+
const getHandlerName = ({ name }: NextDefinition) =>
35+
EDGE_HANDLER_NAME.replace('{{name}}', name.replace(/\W/g, '-'))
36+
37+
const buildHandlerDefinitions = (
38+
{ name: definitionName, matchers, page }: NextDefinition,
39+
handlerName: string,
40+
): NetlifyDefinition[] => {
41+
return definitionName === 'middleware'
42+
? [
43+
{
44+
function: handlerName,
45+
name: 'Next.js Middleware Handler',
46+
path: '/*',
47+
generator: `${PLUGIN_NAME}@${PLUGIN_VERSION}`,
48+
} as any,
49+
]
50+
: matchers.map((matcher) => ({
51+
function: handlerName,
52+
name: `Next.js Edge Handler: ${page}`,
53+
pattern: matcher.regexp,
54+
cache: 'manual',
55+
generator: `${PLUGIN_NAME}@${PLUGIN_VERSION}`,
56+
}))
57+
}
58+
59+
const copyHandlerDependencies = async (
60+
{ name: definitionName, files }: NextDefinition,
61+
handlerName: string,
62+
) => {
63+
await Promise.all(
64+
files.map(async (file) => {
65+
const srcDir = join(process.cwd(), '.next/standalone/.next')
66+
const destDir = join(process.cwd(), EDGE_FUNCTIONS_DIR, handlerName)
67+
68+
if (file === `server/${definitionName}.js`) {
69+
const entrypoint = await readFile(join(srcDir, file), 'utf8')
70+
// const exports = ``
71+
const exports = `
72+
export default _ENTRIES["middleware_${definitionName}"].default;
73+
// export default () => {
74+
75+
// console.log('here', _ENTRIES)
76+
// }
77+
`
78+
await mkdir(dirname(join(destDir, file)), { recursive: true })
79+
await writeFile(
80+
join(destDir, file),
81+
`
82+
import './edge-runtime-webpack.js';
83+
84+
85+
var _ENTRIES = {};\n`.concat(entrypoint, '\n', exports),
86+
)
87+
return
88+
}
89+
90+
await cp(join(srcDir, file), join(destDir, file))
91+
}),
92+
)
93+
}
94+
95+
const writeHandlerFile = async ({ name: definitionName }: NextDefinition, handlerName: string) => {
96+
const handlerFile = resolve(EDGE_FUNCTIONS_DIR, handlerName, `${handlerName}.js`)
97+
const rel = relative(handlerFile, join(PLUGIN_DIR, 'dist/run/handlers/middleware.js'))
98+
await cp(
99+
join(PLUGIN_DIR, 'edge-runtime'),
100+
resolve(EDGE_FUNCTIONS_DIR, handlerName, 'edge-runtime'),
101+
{
102+
recursive: true,
103+
},
104+
)
105+
await writeFile(
106+
resolve(EDGE_FUNCTIONS_DIR, handlerName, `${handlerName}.js`),
107+
`import {handleMiddleware} from './edge-runtime/middleware.ts';
108+
import handler from './server/${definitionName}.js';
109+
export default (req, context) => handleMiddleware(req, context, handler);
110+
export const config = {path: "/*"}`,
111+
)
112+
}
113+
114+
const writeEdgeManifest = async (manifest: NetlifyManifest) => {
115+
await mkdir(resolve(EDGE_FUNCTIONS_DIR), { recursive: true })
116+
await writeFile(resolve(EDGE_FUNCTIONS_DIR, 'manifest.json'), JSON.stringify(manifest, null, 2))
117+
}
118+
119+
export const createEdgeHandlers = async () => {
120+
await rm(EDGE_FUNCTIONS_DIR, { recursive: true, force: true })
121+
122+
const nextManifest = await getMiddlewareManifest()
123+
const nextDefinitions = [
124+
...Object.values(nextManifest.middleware),
125+
// ...Object.values(nextManifest.functions)
126+
]
127+
const netlifyManifest: NetlifyManifest = {
128+
version: 1,
129+
functions: await nextDefinitions.reduce(
130+
async (netlifyDefinitions: Promise<NetlifyDefinition[]>, nextDefinition: NextDefinition) => {
131+
const handlerName = getHandlerName(nextDefinition)
132+
await copyHandlerDependencies(nextDefinition, handlerName)
133+
await writeHandlerFile(nextDefinition, handlerName)
134+
return [
135+
...(await netlifyDefinitions),
136+
...buildHandlerDefinitions(nextDefinition, handlerName),
137+
]
138+
},
139+
Promise.resolve([]),
140+
),
141+
}
142+
143+
await writeEdgeManifest(netlifyManifest)
12144
}

‎src/index.ts

+2-1
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ import {
99
uploadStaticContent,
1010
} from './build/content/static.js'
1111
import { createServerHandler } from './build/functions/server.js'
12+
import { createEdgeHandlers } from './build/functions/edge.js'
1213

1314
export const onPreBuild = async ({ constants, utils }: NetlifyPluginOptions) => {
1415
setPreBuildConfig()
@@ -23,7 +24,7 @@ export const onBuild = async ({ constants, utils }: NetlifyPluginOptions) => {
2324
uploadStaticContent({ constants }),
2425
uploadPrerenderedContent({ constants }),
2526
createServerHandler({ constants }),
26-
// createEdgeHandler(),
27+
createEdgeHandlers(),
2728
])
2829
}
2930

‎tests/fixtures/middleware/app/layout.js

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
export const metadata = {
2+
title: 'Simple Next App',
3+
description: 'Description for Simple Next App',
4+
}
5+
6+
export default function RootLayout({ children }) {
7+
return (
8+
<html lang="en">
9+
<body>{children}</body>
10+
</html>
11+
)
12+
}

‎tests/fixtures/middleware/app/other/page.js

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
export default function Home() {
2+
return (
3+
<main>
4+
<h1>Other</h1>
5+
</main>
6+
)
7+
}

‎tests/fixtures/middleware/app/page.js

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
export default function Home() {
2+
return (
3+
<main>
4+
<h1>Home</h1>
5+
</main>
6+
)
7+
}

‎tests/fixtures/middleware/middleware.ts

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
import { NextResponse } from 'next/server'
2+
import type { NextRequest } from 'next/server'
3+
4+
export function middleware(request: NextRequest) {
5+
return NextResponse.redirect(new URL('/other', request.url))
6+
}
7+
8+
export const config = {
9+
matcher: '/test',
10+
}

‎tests/fixtures/middleware/next.config.js

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
/** @type {import('next').NextConfig} */
2+
const nextConfig = {
3+
output: 'standalone',
4+
eslint: {
5+
ignoreDuringBuilds: true,
6+
},
7+
}
8+
9+
module.exports = nextConfig

0 commit comments

Comments
 (0)