test: add forms workaround test

orinokai · orinokai · commit a964c7a5e7cf · 2024-07-02T14:08:08.000+01:00
diff --git a/tests/fixtures/netlify-forms-workaround/app/layout.js b/tests/fixtures/netlify-forms-workaround/app/layout.js
@@ -0,0 +1,12 @@
+export const metadata = {
+  title: 'Netlify Forms',
+  description: 'Test for verifying Netlify Forms',
+}
+
+export default function RootLayout({ children }) {
+  return (
+    <html lang="en">
+      <body>{children}</body>
+    </html>
+  )
+}
diff --git a/tests/fixtures/netlify-forms-workaround/app/page.js b/tests/fixtures/netlify-forms-workaround/app/page.js
@@ -0,0 +1,7 @@
+export default function Page() {
+  return (
+    <form data-netlify="true">
+      <button type="submit">Send</button>
+    </form>
+  )
+}
diff --git a/tests/fixtures/netlify-forms-workaround/next.config.js b/tests/fixtures/netlify-forms-workaround/next.config.js
@@ -0,0 +1,10 @@
+/** @type {import('next').NextConfig} */
+const nextConfig = {
+  output: 'standalone',
+  eslint: {
+    ignoreDuringBuilds: true,
+  },
+  generateBuildId: () => 'build-id',
+}
+
+module.exports = nextConfig
diff --git a/tests/fixtures/netlify-forms-workaround/package.json b/tests/fixtures/netlify-forms-workaround/package.json
@@ -0,0 +1,19 @@
+{
+  "name": "netlify-forms",
+  "version": "0.1.0",
+  "private": true,
+  "scripts": {
+    "postinstall": "next build",
+    "dev": "next dev",
+    "build": "next build"
+  },
+  "dependencies": {
+    "@netlify/functions": "^2.7.0",
+    "next": "latest",
+    "react": "18.2.0",
+    "react-dom": "18.2.0"
+  },
+  "devDependencies": {
+    "@types/react": "18.2.75"
+  }
+}
diff --git a/tests/fixtures/netlify-forms-workaround/public/form.html b/tests/fixtures/netlify-forms-workaround/public/form.html
@@ -0,0 +1 @@
+<form name="contact" netlify></form>
diff --git a/tests/fixtures/netlify-forms-workaround/tsconfig.json b/tests/fixtures/netlify-forms-workaround/tsconfig.json
@@ -0,0 +1,23 @@
+{
+  "compilerOptions": {
+    "lib": ["dom", "dom.iterable", "esnext"],
+    "allowJs": true,
+    "skipLibCheck": true,
+    "strict": false,
+    "noEmit": true,
+    "incremental": true,
+    "esModuleInterop": true,
+    "module": "esnext",
+    "moduleResolution": "node",
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "jsx": "preserve",
+    "plugins": [
+      {
+        "name": "next"
+      }
+    ]
+  },
+  "include": ["next-env.d.ts", "**/*.ts", "**/*.tsx", ".next/types/**/*.ts"],
+  "exclude": ["node_modules"]
+}
diff --git a/tests/integration/netlify-forms.test.ts b/tests/integration/netlify-forms.test.ts
@@ -14,19 +14,29 @@ beforeEach<FixtureTestContext>(async (ctx) => {
   vi.stubEnv('SITE_ID', ctx.siteID)
   vi.stubEnv('DEPLOY_ID', ctx.deployID)
   vi.stubEnv('NETLIFY_PURGE_API_TOKEN', 'fake-token')
-  // hide debug logs in tests
-  // vi.spyOn(console, 'debug').mockImplementation(() => {})
+  vi.resetModules()
 
   await startMockBlobStore(ctx)
 })
 
-// test skipped until we actually start failing builds - right now we are just showing a warning
-it.skip<FixtureTestContext>('should fail build when netlify forms are used', async (ctx) => {
+it<FixtureTestContext>('should warn when netlify forms are used', async (ctx) => {
+  const warn = vi.spyOn(console, 'warn').mockImplementation(() => {})
+
   await createFixture('netlify-forms', ctx)
 
-  const runPluginPromise = runPlugin(ctx)
+  const runPluginPromise = await runPlugin(ctx)
 
-  await expect(runPluginPromise).rejects.toThrow(
-    '@netlify/plugin-next@5 does not support Netlify Forms',
+  expect(warn).toBeCalledWith(
+    '@netlify/plugin-next@5 does not support Netlify Forms. Refer to https://ntl.fyi/next-runtime-forms-migration for migration example.',
   )
 })
+
+it<FixtureTestContext>('should not warn when netlify forms are used with workaround', async (ctx) => {
+  const warn = vi.spyOn(console, 'warn').mockImplementation(() => {})
+
+  await createFixture('netlify-forms-workaround', ctx)
+
+  const runPluginPromise = await runPlugin(ctx)
+
+  expect(warn).not.toBeCalled()
+})
