@netlify/plugin-nextjs 4.41.3 → 5.0.0-beta.1

package/src/templates/edge/middleware-runtime.ts

@@ -1,62 +0,0 @@
-import type { Context } from 'https://edge.netlify.com'
-// Available at build time
-import matchers from './matchers.json' assert { type: 'json' }
-import edgeFunction from './bundle.js'
-import { buildNextRequest, buildResponse } from '../edge-shared/utils.ts'
-import { getMiddlewareRouteMatcher, MiddlewareRouteMatch, searchParamsToUrlQuery } from '../edge-shared/next-utils.ts'
-import nextConfig from '../edge-shared/nextConfig.json' assert { type: 'json' }
-
-const matchesMiddleware: MiddlewareRouteMatch = getMiddlewareRouteMatcher(matchers || [])
-
-export interface RequestContext {
-  request: Request
-  context: Context
-}
-
-declare global {
-  // deno-lint-ignore no-var
-  var NFRequestContextMap: Map<string, RequestContext>
-}
-
-globalThis.NFRequestContextMap ||= new Map()
-
-const handler = async (req: Request, context: Context) => {
-  if (Deno.env.get('NETLIFY_DEV')) {
-    // Don't run in dev
-    return
-  }
-
-  const url = new URL(req.url)
-
-  // While we have already checked the path when mapping to the edge function,
-  // Next.js supports extra rules that we need to check here too.
-  if (!matchesMiddleware(url.pathname, req, searchParamsToUrlQuery(url.searchParams))) {
-    return
-  }
-
-  const requestId = req.headers.get('x-nf-request-id')
-  if (!requestId) {
-    console.error('Missing x-nf-request-id header')
-  } else {
-    globalThis.NFRequestContextMap.set(requestId, {
-      request: req,
-      context,
-    })
-  }
-
-  const request = buildNextRequest(req, context, nextConfig)
-
-  try {
-    const result = await edgeFunction({ request })
-    return buildResponse({ result, request: req, context })
-  } catch (error) {
-    console.error(error)
-    return new Response(error.message, { status: 500 })
-  } finally {
-    if (requestId) {
-      globalThis.NFRequestContextMap.delete(requestId)
-    }
-  }
-}
-
-export default handler

package/src/templates/edge/next-dev.js

@@ -1,104 +0,0 @@
-import { NextRequest } from '../vendor/esm.sh/v91/next@12.2.5/deno/dist/server/web/spec-extension/request.js'
-import { NextResponse } from '../vendor/esm.sh/v91/next@12.2.5/deno/dist/server/web/spec-extension/response.js'
-import { fromFileUrl } from '../vendor/deno.land/std@0.175.0/path/mod.ts'
-import { buildResponse, isFunction } from '../edge-shared/utils.ts'
-
-globalThis.NFRequestContextMap ||= new Map()
-globalThis.__dirname = fromFileUrl(new URL('./', import.meta.url)).slice(0, -1)
-globalThis.process ||= { env: Deno.env.toObject() }
-
-// Next.js uses this extension to the Headers API implemented by Cloudflare workerd
-if (!('getAll' in Headers.prototype)) {
-  Headers.prototype.getAll = function getAll(name) {
-    name = name.toLowerCase()
-    if (name !== 'set-cookie') {
-      throw new Error('Headers.getAll is only supported for Set-Cookie')
-    }
-    return [...this.entries()].filter(([key]) => key === name).map(([, value]) => value)
-  }
-}
-
-let idx = 0
-
-const handler = async (req, context) => {
-  if (!Deno.env.get('NETLIFY_DEV')) {
-    // Only run in dev
-    return
-  }
-
-  let middleware
-  // Dynamic imports and FS operations aren't allowed when deployed,
-  // but that's fine because this is only ever used locally.
-  // We don't want to just try importing and use that to test,
-  // because that would also throw if there's an error in the middleware,
-  // which we would want to surface not ignore.
-  try {
-    // We need to cache-bust the import because otherwise it will claim it
-    // doesn't exist if the user creates it after the server starts
-    const nextMiddleware = await import(`../../middleware.js#${++idx}`)
-
-    // The middleware file can export a named `middleware` export or a `default` export
-    middleware = isFunction(nextMiddleware.middleware)
-      ? nextMiddleware.middleware
-      : isFunction(nextMiddleware.default)
-      ? nextMiddleware.default
-      : undefined
-
-    if (!middleware) {
-      throw new Error('The middleware must export a `middleware` or a `default` function')
-    }
-  } catch (importError) {
-    if (importError.code === 'ERR_MODULE_NOT_FOUND' && importError.message.includes(`middleware.js`)) {
-      //  No middleware, so we silently return
-      return
-    }
-
-    throw importError
-  }
-
-  //  This is the format expected by Next.js along with the timezone which we support.
-  const geo = {
-    country: context.geo.country?.code,
-    region: context.geo.subdivision?.code,
-    city: context.geo.city,
-    latitude: context.geo.latitude?.toString(),
-    longitude: context.geo.longitude?.toString(),
-    timezone: context.geo.timezone,
-  }
-
-  // A default request id is fine locally
-  const requestId = req.headers.get('x-nf-request-id') || 'request-id'
-
-  globalThis.NFRequestContextMap.set(requestId, {
-    request: req,
-    context,
-  })
-
-  const request = {
-    headers: Object.fromEntries(req.headers.entries()),
-    geo,
-    method: req.method,
-    ip: context.ip,
-    body: req.body || undefined,
-  }
-
-  const nextRequest = new NextRequest(req, request)
-
-  try {
-    const response = await middleware(nextRequest)
-    return buildResponse({
-      result: { response: response || NextResponse.next(), waitUntil: Promise.resolve() },
-      request: req,
-      context,
-    })
-  } catch (error) {
-    console.error(error)
-    return new Response(error.message, { status: 500 })
-  } finally {
-    if (requestId) {
-      globalThis.NFRequestContextMap.delete(requestId)
-    }
-  }
-}
-
-export default handler

package/src/templates/edge/rsc-data.ts

@@ -1,5 +0,0 @@
-import prerenderManifest from '../edge-shared/prerender-manifest.json' assert { type: 'json' }
-import { getRscDataRouter, PrerenderManifest } from '../edge-shared/rsc-data.ts'
-
-const handler = getRscDataRouter(prerenderManifest as PrerenderManifest)
-export default handler

package/src/templates/edge/shims.js

@@ -1,77 +0,0 @@
-// @ts-check
-// deno-lint-ignore-file prefer-const no-unused-vars
-import { decode as _base64Decode } from '../vendor/deno.land/std@0.175.0/encoding/base64.ts'
-import BufferCompat from '../vendor/deno.land/std@0.175.0/node/buffer.ts'
-import EventsCompat from '../vendor/deno.land/std@0.175.0/node/events.ts'
-import AsyncHooksCompat from '../vendor/deno.land/std@0.175.0/node/async_hooks.ts'
-import AssertCompat from '../vendor/deno.land/std@0.175.0/node/assert.ts'
-import UtilCompat from '../vendor/deno.land/std@0.175.0/node/util.ts'
-
-/**
- * These are the shims, polyfills and other kludges to make Next.js work in standards-compliant runtime.
- * This file isn't imported, but is instead inlined along with other chunks into the edge bundle.
- */
-
-// Deno defines "window", but naughty libraries think this means it's a browser
-// @ts-ignore
-delete globalThis.window
-globalThis.process = {
-  env: { ...Deno.env.toObject(), NEXT_RUNTIME: 'edge', NEXT_PRIVATE_MINIMAL_MODE: '1' },
-}
-globalThis.EdgeRuntime = 'netlify-edge'
-let _ENTRIES = {}
-
-// Next.js expects this as a global
-globalThis.AsyncLocalStorage = AsyncHooksCompat.AsyncLocalStorage
-
-// Next.js uses this extension to the Headers API implemented by Cloudflare workerd
-if (!('getAll' in Headers.prototype)) {
-  // @ts-ignore
-  Headers.prototype.getAll = function getAll(name) {
-    name = name.toLowerCase()
-    if (name !== 'set-cookie') {
-      throw new Error('Headers.getAll is only supported for Set-Cookie')
-    }
-    return [...this.entries()].filter(([key]) => key === name).map(([, value]) => value)
-  }
-}
-//  Next uses blob: urls to refer to local assets, so we need to intercept these
-const _fetch = globalThis.fetch
-const fetch /* type {typeof globalThis.fetch} */ = async (url, init) => {
-  try {
-    if (url instanceof URL && url.href?.startsWith('blob:')) {
-      const key = url.href.slice(5)
-      if (key in _ASSETS) {
-        return new Response(_base64Decode(_ASSETS[key]))
-      }
-    }
-    return await _fetch(url, init)
-  } catch (error) {
-    console.error(error)
-    throw error
-  }
-}
-
-// Shim native modules that Vercel makes available
-if (typeof require === 'undefined') {
-  globalThis.require = (name) => {
-    switch (name.replace(/^node:/, '')) {
-      case 'buffer':
-        return BufferCompat
-      case 'events':
-        return EventsCompat
-      case 'async_hooks':
-        return AsyncHooksCompat
-      case 'assert':
-        return AssertCompat
-      case 'util':
-        return UtilCompat
-      default:
-        throw new ReferenceError(`Native module not found: ${name}`)
-    }
-  }
-}
-
-// Next edge runtime uses "self" as a function-scoped global-like object, but some of the older polyfills expect it to equal globalThis
-// See https://nextjs.org/docs/basic-features/supported-browsers-features#polyfills
-const self = { ...globalThis, fetch }

package/src/templates/edge-shared/nextConfig.json

@@ -1,3 +0,0 @@
-{
-  "trailingSlash": true
-}

package/src/templates/edge-shared/prerender-manifest.json

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "routes": {},
-  "dynamicRoutes": {},
-  "notFoundRoutes": [],
-  "preview": {}
-}

package/src/templates/edge-shared/rsc-data.ts

@@ -1,78 +0,0 @@
-import type { EdgeFunction } from 'https://edge.netlify.com'
-
-// These are copied from next/dist/build. This file gets copied as part of the next
-// runtime build and can't reference the next package directly.
-//
-// Latest types at https://github.com/vercel/next.js/blob/4a2df3c3752aeddc50fd5ab053440eccf71ae50b/packages/next/src/build/index.ts#L140
-export declare type SsgRoute = {
-  initialRevalidateSeconds: number | false
-  srcRoute: string | null
-  dataRoute: string | null
-}
-export declare type DynamicSsgRoute = {
-  routeRegex: string
-  fallback: string | null | false
-  dataRoute: string | null
-  dataRouteRegex: string
-}
-export declare type PrerenderManifest = {
-  version: 3
-  routes: {
-    [route: string]: SsgRoute
-  }
-  dynamicRoutes: {
-    [route: string]: DynamicSsgRoute
-  }
-  notFoundRoutes: string[]
-}
-
-const noop = () => {}
-
-// Ensure that routes with and without a trailing slash map to different ODB paths
-const rscifyPath = (route: string) => {
-  if (route.endsWith('/')) {
-    return route.slice(0, -1) + '.rsc/'
-  }
-  return route + '.rsc'
-}
-
-export const getRscDataRouter = ({ routes: staticRoutes, dynamicRoutes }: PrerenderManifest): EdgeFunction => {
-  const staticRouteSet = new Set(
-    Object.entries(staticRoutes)
-      .filter(([, { dataRoute }]) => dataRoute?.endsWith('.rsc'))
-      .map(([route]) => route),
-  )
-
-  const dynamicRouteMatcher = Object.values(dynamicRoutes)
-    .filter(({ dataRoute }) => dataRoute?.endsWith('.rsc'))
-    .map(({ routeRegex }) => new RegExp(routeRegex))
-
-  const matchesDynamicRscDataRoute = (pathname: string) => {
-    return dynamicRouteMatcher.some((matcher) => matcher.test(pathname))
-  }
-
-  const matchesStaticRscDataRoute = (pathname: string) => {
-    const key = pathname.endsWith('/') ? pathname.slice(0, -1) : pathname
-    return staticRouteSet.has(key)
-  }
-
-  const matchesRscRoute = (pathname: string) => {
-    return matchesStaticRscDataRoute(pathname) || matchesDynamicRscDataRoute(pathname)
-  }
-
-  return (request, context) => {
-    const debug = request.headers.has('x-next-debug-logging')
-    const log = debug ? (...args: unknown[]) => console.log(...args) : noop
-    const url = new URL(request.url)
-    // If this is a static RSC request, rewrite to the data route
-    if (request.headers.get('rsc') === '1') {
-      log('Is rsc request')
-      if (matchesRscRoute(url.pathname)) {
-        request.headers.set('x-rsc-route', url.pathname)
-        const target = rscifyPath(url.pathname)
-        log('Rewriting to', target)
-        return context.rewrite(target)
-      }
-    }
-  }
-}

package/src/templates/edge-shared/utils.test.ts

@@ -1,114 +0,0 @@
-import { assertEquals } from 'https://deno.land/std@0.167.0/testing/asserts.ts'
-import { beforeEach, describe, it } from 'https://deno.land/std@0.167.0/testing/bdd.ts'
-import { redirectTrailingSlash, updateModifiedHeaders } from './utils.ts'
-
-describe('updateModifiedHeaders', () => {
-  it("does not modify the headers if 'x-middleware-override-headers' is not found", () => {
-    const mockHeaders = new Headers()
-    // There shouldn't be a case where x-middleware-override-headers is not set and a header has
-    // been modified with 'x-middleware-request' added to it, this is more to confirm the test case
-    mockHeaders.set('x-middleware-request-foo', 'bar')
-
-    const mockResponse = {
-      headers: mockHeaders,
-    }
-
-    const mockRequest = {
-      headers: new Headers(),
-    }
-
-    updateModifiedHeaders(mockRequest.headers, mockResponse.headers)
-
-    assertEquals(mockRequest.headers.get('x-middleware-request-foo'), null)
-  })
-
-  describe("when the 'x-middleware-override-headers' headers is present", () => {
-    let mockHeaders
-    let mockRequest: { headers: Headers }
-    let mockResponse: { headers: Headers }
-
-    beforeEach(() => {
-      mockHeaders = new Headers()
-      mockHeaders.set('foo', 'bar')
-      mockHeaders.set('x-middleware-request-hello', 'world')
-      mockHeaders.set('x-middleware-request-test', '123')
-      mockHeaders.set('x-middleware-override-headers', 'hello,test')
-
-      mockRequest = {
-        headers: new Headers(),
-      }
-
-      mockResponse = {
-        headers: mockHeaders,
-      }
-
-      updateModifiedHeaders(mockRequest.headers, mockResponse.headers)
-    })
-
-    it("does not modify or add headers that are missing 'x-middleware-request' in the name", () => {
-      assertEquals(mockRequest.headers.get('foo'), null)
-    })
-
-    it("removes 'x-middleware-request-' from headers", () => {
-      assertEquals(mockRequest.headers.get('x-middleware-request-hello'), null)
-      assertEquals(mockRequest.headers.get('x-middleware-request-test'), null)
-
-      assertEquals(mockRequest.headers.get('hello'), 'world')
-      assertEquals(mockRequest.headers.get('test'), '123')
-    })
-
-    it("removes 'x-middleware-override-headers' after cleaning headers", () => {
-      assertEquals(mockRequest.headers.get('x-middleware-override-headers'), null)
-    })
-  })
-})
-
-describe('trailing slash redirects', () => {
-  it('adds a trailing slash to the pathn if trailingSlash is enabled', () => {
-    const url = new URL('https://example.com/foo')
-    const result = redirectTrailingSlash(url, true)
-    assertEquals(result?.status, 308)
-    assertEquals(result?.headers.get('location'), 'https://example.com/foo/')
-  })
-
-  it("doesn't add a trailing slash if trailingSlash is false", () => {
-    const url = new URL('https://example.com/foo')
-    const result = redirectTrailingSlash(url, false)
-    assertEquals(result, undefined)
-  })
-
-  it("doesn't add a trailing slash if the path is a file", () => {
-    const url = new URL('https://example.com/foo.txt')
-    const result = redirectTrailingSlash(url, true)
-    assertEquals(result, undefined)
-  })
-  it('adds a trailing slash if there is a dot in the path', () => {
-    const url = new URL('https://example.com/foo.bar/baz')
-    const result = redirectTrailingSlash(url, true)
-    assertEquals(result?.status, 308)
-    assertEquals(result?.headers.get('location'), 'https://example.com/foo.bar/baz/')
-  })
-  it("doesn't add a trailing slash if the path is /", () => {
-    const url = new URL('https://example.com/')
-    const result = redirectTrailingSlash(url, true)
-    assertEquals(result, undefined)
-  })
-  it('removes a trailing slash from the path if trailingSlash is false', () => {
-    const url = new URL('https://example.com/foo/')
-    const result = redirectTrailingSlash(url, false)
-    assertEquals(result?.status, 308)
-    assertEquals(result?.headers.get('location'), 'https://example.com/foo')
-  })
-  it("doesn't remove a trailing slash if trailingSlash is true", () => {
-    const url = new URL('https://example.com/foo/')
-    const result = redirectTrailingSlash(url, true)
-    assertEquals(result, undefined)
-  })
-
-  it('removes a trailing slash from the path if the path is a file', () => {
-    const url = new URL('https://example.com/foo.txt/')
-    const result = redirectTrailingSlash(url, false)
-    assertEquals(result?.status, 308)
-    assertEquals(result?.headers.get('location'), 'https://example.com/foo.txt')
-  })
-})