test: add e2e test for pre-frameworks api

Author: pieh

src/build/plugin-context.ts

@@ -180,7 +180,7 @@ export class PluginContext {
   #useFrameworksAPI: typeof this.useFrameworksAPI | null = null
   get useFrameworksAPI(): boolean {
     if (this.#useFrameworksAPI === null) {
-      // Defining RegExp pattern in edge function inline config is only supported since 29.50.5
+      // Defining RegExp pattern in edge function inline config is only supported since Build 29.50.5 / CLI 17.32.1
       const REQUIRED_BUILD_VERSION = '>=29.50.5'
       this.#useFrameworksAPI = satisfies(this.buildVersion, REQUIRED_BUILD_VERSION, {
         includePrerelease: true,

tests/e2e/cli-before-frameworks-api-support.test.ts

@@ -0,0 +1,28 @@
+import { expect } from '@playwright/test'
+import { test } from '../utils/playwright-helpers.js'
+
+test('should serve 404 page when requesting non existing page (no matching route) if site is deployed with CLI not supporting frameworks API', async ({
+  page,
+  cliBeforeFrameworksAPISupport,
+}) => {
+  // 404 page is built and uploaded to blobs at build time
+  // when Next.js serves 404 it will try to fetch it from the blob store
+  // if request handler function is unable to get from blob store it will
+  // fail request handling and serve 500 error.
+  // This implicitly tests that request handler function is able to read blobs
+  // that are uploaded as part of site deploy.
+  // This also tests if edge middleware is working.
+
+  const response = await page.goto(new URL('non-existing', cliBeforeFrameworksAPISupport.url).href)
+  const headers = response?.headers() || {}
+  expect(response?.status()).toBe(404)
+
+  expect(await page.textContent('h1')).toBe('404')
+
+  expect(headers['netlify-cdn-cache-control']).toBe(
+    'no-cache, no-store, max-age=0, must-revalidate',
+  )
+  expect(headers['cache-control']).toBe('no-cache,no-store,max-age=0,must-revalidate')
+
+  expect(headers['x-hello-from-middleware']).toBe('hello')
+})

tests/fixtures/cli-before-frameworks-api-support/middleware.ts

@@ -0,0 +1,9 @@
+import { NextResponse } from 'next/server'
+
+export function middleware() {
+  const response: NextResponse = NextResponse.next()
+
+  response.headers.set('x-hello-from-middleware', 'hello')
+
+  return response
+}

tests/fixtures/cli-before-frameworks-api-support/next.config.js

@@ -0,0 +1,8 @@
+/** @type {import('next').NextConfig} */
+const nextConfig = {
+  eslint: {
+    ignoreDuringBuilds: true,
+  },
+}
+
+module.exports = nextConfig

tests/fixtures/cli-before-frameworks-api-support/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "old-cli",
+  "version": "0.1.0",
+  "private": true,
+  "scripts": {
+    "postinstall": "next build",
+    "dev": "next dev",
+    "build": "next build"
+  },
+  "dependencies": {
+    "next": "latest",
+    "netlify-cli": "17.32.0",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0"
+  }
+}

tests/fixtures/cli-before-frameworks-api-support/pages/index.js

@@ -0,0 +1,15 @@
+export default function Home({ ssr }) {
+  return (
+    <main>
+      <div data-testid="smoke">SSR: {ssr ? 'yes' : 'no'}</div>
+    </main>
+  )
+}
+
+export const getServerSideProps = async () => {
+  return {
+    props: {
+      ssr: true,
+    },
+  }
+}

tests/utils/create-e2e-fixture.ts

@@ -358,6 +358,10 @@ export const fixtureFactories = {
     createE2EFixture('cli-before-regional-blobs-support', {
       expectedCliVersion: '17.21.1',
     }),
+  cliBeforeFrameworksAPISupport: () =>
+    createE2EFixture('cli-before-frameworks-api-support', {
+      expectedCliVersion: '17.32.0',
+    }),
   yarnMonorepoWithPnpmLinker: () =>
     createE2EFixture('yarn-monorepo-with-pnpm-linker', {
       packageManger: 'berry',