Merge branch 'main' into renovate/npm-next-vulnerability

Author: pieh

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "5.9.2"
+  ".": "5.9.3"
 }

CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [5.9.3](https://github.com/opennextjs/opennextjs-netlify/compare/v5.9.2...v5.9.3) (2025-01-07)
+
+
+### Bug Fixes
+
+* adjust middleware json data rewrite to work with recent next@canary ([#2734](https://github.com/opennextjs/opennextjs-netlify/issues/2734)) ([5a602c3](https://github.com/opennextjs/opennextjs-netlify/commit/5a602c30af16a3d91272f03ebb53b3a49c57f728))
+
 ## [5.9.2](https://github.com/opennextjs/opennextjs-netlify/compare/v5.9.1...v5.9.2) (2024-12-20)
 
 

edge-runtime/lib/response.ts

@@ -14,6 +14,8 @@ import {
   normalizeLocalePath,
   normalizeTrailingSlash,
   relativizeURL,
+  removeBasePath,
+  rewriteDataPath,
 } from './util.ts'
 
 export interface FetchEventResult {
@@ -180,14 +182,16 @@ export const buildResponse = async ({
     }
 
     if (isDataReq) {
-      // The rewrite target is a data request, but a middleware rewrite target is always for the page route,
-      // so we need to tell the server this is a data request. Setting the `x-nextjs-data` header is not enough. 🤷
-      rewriteUrl.searchParams.set('__nextDataReq', '1')
+      rewriteUrl.pathname = rewriteDataPath({
+        dataUrl: new URL(request.url).pathname,
+        newRoute: removeBasePath(rewriteUrl.pathname, nextConfig?.basePath),
+        basePath: nextConfig?.basePath,
+      })
+    } else {
+      // respect trailing slash rules to prevent 308s
+      rewriteUrl.pathname = normalizeTrailingSlash(rewriteUrl.pathname, nextConfig?.trailingSlash)
     }
 
-    // respect trailing slash rules to prevent 308s
-    rewriteUrl.pathname = normalizeTrailingSlash(rewriteUrl.pathname, nextConfig?.trailingSlash)
-
     const target = normalizeLocalizedTarget({ target: rewriteUrl.toString(), request, nextConfig })
     if (target === request.url) {
       logger.withFields({ rewrite_url: rewrite }).debug('Rewrite url is same as original url')

edge-runtime/vendor.ts

@@ -2,7 +2,6 @@
 // It acts as a seed that populates the `vendor/` directory and should not be
 // imported directly.
 
-import 'https://deno.land/[email protected]/encoding/base64.ts'
 import 'https://deno.land/[email protected]/http/cookie.ts'
 import 'https://deno.land/[email protected]/node/buffer.ts'
 import 'https://deno.land/[email protected]/node/events.ts'

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@netlify/plugin-nextjs",
-  "version": "5.9.2",
+  "version": "5.9.3",
   "description": "Run Next.js seamlessly on Netlify",
   "main": "./dist/index.js",
   "type": "module",

package.json

@@ -1,6 +1,5 @@
 import { cp, mkdir, readFile, rm, writeFile } from 'node:fs/promises'
-import { dirname, join, relative, sep } from 'node:path'
-import { sep as posixSep } from 'node:path/posix'
+import { dirname, join } from 'node:path'
 
 import type { Manifest, ManifestFunction } from '@netlify/edge-functions'
 import { glob } from 'fast-glob'
@@ -9,8 +8,6 @@ import { pathToRegexp } from 'path-to-regexp'
 
 import { EDGE_HANDLER_NAME, PluginContext } from '../plugin-context.js'
 
-const toPosixPath = (path: string) => path.split(sep).join(posixSep)
-
 const writeEdgeManifest = async (ctx: PluginContext, manifest: Manifest) => {
   await mkdir(ctx.edgeFunctionsDir, { recursive: true })
   await writeFile(join(ctx.edgeFunctionsDir, 'manifest.json'), JSON.stringify(manifest, null, 2))
@@ -97,14 +94,13 @@ const writeHandlerFile = async (ctx: PluginContext, { matchers, name }: NextDefi
   await writeFile(
     join(handlerDirectory, `${handlerName}.js`),
     `
-    import { decode as _base64Decode } from './edge-runtime/vendor/deno.land/[email protected]/encoding/base64.ts';
     import { init as htmlRewriterInit } from './edge-runtime/vendor/deno.land/x/[email protected]/src/index.ts'
-    import {handleMiddleware} from './edge-runtime/middleware.ts';
+    import { handleMiddleware } from './edge-runtime/middleware.ts';
     import handler from './server/${name}.js';
 
-    await htmlRewriterInit({ module_or_path: _base64Decode(${JSON.stringify(
-      htmlRewriterWasm.toString('base64'),
-    )}).buffer });
+    await htmlRewriterInit({ module_or_path: Uint8Array.from(${JSON.stringify([
+      ...htmlRewriterWasm,
+    ])}) });
 
     export default (req, context) => handleMiddleware(req, context, handler);
     `,
@@ -127,23 +123,9 @@ const copyHandlerDependencies = async (
   const outputFile = join(destDir, `server/${name}.js`)
 
   if (wasm?.length) {
-    const base64ModulePath = join(
-      destDir,
-      'edge-runtime/vendor/deno.land/[email protected]/encoding/base64.ts',
-    )
-
-    const base64ModulePathRelativeToOutputFile = toPosixPath(
-      relative(dirname(outputFile), base64ModulePath),
-    )
-
-    parts.push(`import { decode as _base64Decode } from "${base64ModulePathRelativeToOutputFile}";`)
     for (const wasmChunk of wasm ?? []) {
       const data = await readFile(join(srcDir, wasmChunk.filePath))
-      parts.push(
-        `const ${wasmChunk.name} = _base64Decode(${JSON.stringify(
-          data.toString('base64'),
-        )}).buffer`,
-      )
+      parts.push(`const ${wasmChunk.name} = Uint8Array.from(${JSON.stringify([...data])})`)
     }
   }
 

src/build/functions/edge.ts

@@ -52,3 +52,20 @@ test('it should render OpenGraph image meta tag correctly', async ({ page, middl
   const size = await getImageSize(Buffer.from(imageBuffer), 'png')
   expect([size.width, size.height]).toEqual([1200, 630])
 })
+
+test('json data rewrite works', async ({ middlewarePages }) => {
+  const response = await fetch(`${middlewarePages.url}/_next/data/build-id/sha.json`, {
+    headers: {
+      'x-nextjs-data': '1',
+    },
+  })
+
+  expect(response.ok).toBe(true)
+  const body = await response.text()
+
+  expect(body).toMatch(/^{"pageProps":/)
+
+  const data = JSON.parse(body)
+
+  expect(data.pageProps.message).toBeDefined()
+})

tests/e2e/edge-middleware.test.ts

@@ -2,4 +2,4 @@
 /// <reference types="next/image-types/global" />
 
 // NOTE: This file should not be edited
-// see https://nextjs.org/docs/basic-features/typescript for more information.
+// see https://nextjs.org/docs/pages/api-reference/config/typescript for more information.

tests/fixtures/middleware-pages/next-env.d.ts

@@ -21,6 +21,7 @@ if (platform === 'win32') {
   }
 }
 
+/** @type {import('next').NextConfig} */
 module.exports = {
   trailingSlash: true,
   output: 'standalone',

tests/fixtures/middleware-pages/next.config.js

@@ -13,6 +13,8 @@
     "react-dom": "18.2.0"
   },
   "devDependencies": {
-    "@types/react": "18.2.47"
+    "@types/node": "^20.10.6",
+    "@types/react": "18.2.47",
+    "typescript": "^5.3.3"
   }
 }

tests/fixtures/middleware-pages/package.json

@@ -11,7 +11,8 @@
     "moduleResolution": "node",
     "resolveJsonModule": true,
     "isolatedModules": true,
-    "jsx": "preserve"
+    "jsx": "preserve",
+    "target": "ES2017"
   },
   "include": ["next-env.d.ts", "**/*.ts", "**/*.tsx"],
   "exclude": ["node_modules"]

tests/fixtures/middleware-pages/tsconfig.json

@@ -387,8 +387,7 @@ describe('page router', () => {
     })
     const res = await response.json()
     const url = new URL(res.url, 'http://n/')
-    expect(url.pathname).toBe('/ssr-page-2/')
-    expect(url.searchParams.get('__nextDataReq')).toBe('1')
+    expect(url.pathname).toBe('/_next/data/build-id/ssr-page-2.json')
     expect(res.headers['x-nextjs-data']).toBe('1')
     expect(response.headers.get('x-nextjs-rewrite')).toBe('/ssr-page-2/')
     expect(response.status).toBe(200)
@@ -420,7 +419,7 @@ describe('page router', () => {
     expect(response.status).toBe(200)
   })
 
-  test<FixtureTestContext>('should rewrite un-rewritten data requests to page route', async (ctx) => {
+  test<FixtureTestContext>('should NOT rewrite un-rewritten data requests to page route', async (ctx) => {
     await createFixture('middleware-pages', ctx)
     await runPlugin(ctx)
     const origin = await LocalServer.run(async (req, res) => {
@@ -443,8 +442,7 @@ describe('page router', () => {
     })
     const res = await response.json()
     const url = new URL(res.url, 'http://n/')
-    expect(url.pathname).toBe('/ssg/hello/')
-    expect(url.searchParams.get('__nextDataReq')).toBe('1')
+    expect(url.pathname).toBe('/_next/data/build-id/ssg/hello.json')
     expect(res.headers['x-nextjs-data']).toBe('1')
     expect(response.status).toBe(200)
   })
@@ -472,8 +470,7 @@ describe('page router', () => {
     })
     const res = await response.json()
     const url = new URL(res.url, 'http://n/')
-    expect(url.pathname).toBe('/blog/first/')
-    expect(url.searchParams.get('__nextDataReq')).toBe('1')
+    expect(url.pathname).toBe('/_next/data/build-id/blog/first.json')
     expect(url.searchParams.get('slug')).toBe('first')
     expect(res.headers['x-nextjs-data']).toBe('1')
     expect(response.status).toBe(200)

tests/integration/edge-handler.test.ts

@@ -95,22 +95,6 @@ test<FixtureTestContext>('Should revalidate path with On-demand Revalidation', a
   expect(dateCacheInitial).not.toBe(dateCacheRevalidated)
 })
 
-test<FixtureTestContext>('Should return JSON for data req to page route', async (ctx) => {
-  await createFixture('page-router', ctx)
-  await runPlugin(ctx)
-
-  const response = await invokeFunction(ctx, {
-    url: '/static/revalidate-manual?__nextDataReq=1',
-    headers: { 'x-nextjs-data': '1' },
-  })
-
-  expect(response.body).toMatch(/^{"pageProps":/)
-
-  const data = JSON.parse(response.body)
-
-  expect(data.pageProps.show).toBeDefined()
-})
-
 test.skipIf(platform === 'win32')<FixtureTestContext>(
   'Should set permanent "netlify-cdn-cache-control" header on fully static pages"',
   async (ctx) => {

tests/integration/page-router.test.ts

@@ -325,6 +325,7 @@ export const fixtureFactories = {
   bun: () => createE2EFixture('simple', { packageManger: 'bun' }),
   middleware: () => createE2EFixture('middleware'),
   middlewareOg: () => createE2EFixture('middleware-og'),
+  middlewarePages: () => createE2EFixture('middleware-pages'),
   pageRouter: () => createE2EFixture('page-router'),
   pageRouterBasePathI18n: () => createE2EFixture('page-router-base-path-i18n'),
   turborepo: () =>