test: add test for intentional deploy failure when C++ addons / .node modules are attempted in node middleware

Author: pieh

src/build/functions/edge.ts

@@ -218,7 +218,7 @@ const copyHandlerDependenciesForNodeMiddleware = async (ctx: PluginContext) => {
   // files are relative to location of middleware entrypoint
   // we need to capture all of them
   // they might be going to parent directories, so first we check how many directories we need to go up
-  const { maxParentDirectoriesPath } = files.reduce(
+  const { maxParentDirectoriesPath, unsupportedDotNodeModules } = files.reduce(
     (acc, file) => {
       let dirsUp = 0
       let parentDirectoriesPath = ''
@@ -231,18 +231,30 @@ const copyHandlerDependenciesForNodeMiddleware = async (ctx: PluginContext) => {
         }
       }
 
+      if (file.endsWith('.node')) {
+        // C++ addons are not supported
+        acc.unsupportedDotNodeModules.push(join(srcDir, file))
+      }
+
       if (dirsUp > acc.maxDirsUp) {
         return {
+          ...acc,
           maxDirsUp: dirsUp,
           maxParentDirectoriesPath: parentDirectoriesPath,
         }
       }
 
       return acc
     },
-    { maxDirsUp: 0, maxParentDirectoriesPath: '' },
+    { maxDirsUp: 0, maxParentDirectoriesPath: '', unsupportedDotNodeModules: [] as string[] },
   )
 
+  if (unsupportedDotNodeModules.length !== 0) {
+    throw new Error(
+      `Usage of unsupported C++ Addon(s) found in Node.js Middleware:\n${unsupportedDotNodeModules.map((file) => `- ${file}`).join('\n')}\n\nCheck https://docs.netlify.com/build/frameworks/framework-setup-guides/nextjs/overview/#limitations for more information.`,
+    )
+  }
+
   const commonPrefix = relative(join(srcDir, maxParentDirectoriesPath), srcDir)
 
   parts.push(`const virtualModules = new Map();`)

tests/integration/middleware.test.ts

@@ -698,39 +698,25 @@ for (const {
 
     if (isNodeMiddleware) {
       describe('Node.js Middleware specific', () => {
-        test.only<FixtureTestContext>('should fail to deploy when using unsupported C++ Addons with meaningful message about limitation', async (ctx) => {
+        test<FixtureTestContext>('should fail to deploy when using unsupported C++ Addons with meaningful message about limitation', async (ctx) => {
           await createFixture('middleware-node-unsupported-cpp-addons', ctx)
 
           const runPluginPromise = runPlugin(ctx)
-          await runPluginPromise
-
-          const origin = await LocalServer.run(async (req, res) => {
-            res.write(
-              JSON.stringify({
-                url: req.url,
-                headers: req.headers,
-              }),
-            )
-            res.end()
-          })
-          ctx.cleanup?.push(() => origin.stop())
-          const response = await invokeEdgeFunction(ctx, {
-            functions: [edgeFunctionNameRoot],
-            origin,
-            url: `/json`,
-          })
-          console.log(response)
-
-          // await expect(runPluginPromise).rejects.toThrow('Node.js middleware is not yet supported.')
-          // await expect(runPluginPromise).rejects.toThrow(
-          //   'Future @netlify/plugin-nextjs release will support node middleware with following limitations:',
-          // )
-          // await expect(runPluginPromise).rejects.toThrow(
-          //   ' - usage of C++ Addons (https://nodejs.org/api/addons.html) not supported (for example `bcrypt` npm module will not be supported, but `bcryptjs` will be supported)',
-          // )
-          // await expect(runPluginPromise).rejects.toThrow(
-          //   ' - usage of Filesystem (https://nodejs.org/api/fs.html) not supported',
-          // )
+
+          await expect(
+            runPluginPromise,
+            'error message should describe error cause',
+          ).rejects.toThrow('Usage of unsupported C++ Addon(s) found in Node.js Middleware')
+          await expect(
+            runPluginPromise,
+            'error message should mention c++ addons (.node) file names to help finding the package(s) that contain them',
+          ).rejects.toThrow('bcrypt.node')
+          await expect(
+            runPluginPromise,
+            'link to documentation should be provided',
+          ).rejects.toThrow(
+            'https://docs.netlify.com/build/frameworks/framework-setup-guides/nextjs/overview/#limitations',
+          )
         })
       })
     }