fix: backport fix from 2f24fb1 to @netlify/remix-edge-adapter

Turns out we had the same problem here as well.

Author: serhalp

packages/remix-edge-adapter/README.md

@@ -16,12 +16,31 @@ However, if you are using **Remix Vite**, you can instead deploy your existing s
 
 ```js
 // vite.config.js
-import { vitePlugin as remix } from "@remix-run/dev";
-import { netlifyPlugin } from "@netlify/remix-edge-adapter/plugin";
+import { vitePlugin as remix } from '@remix-run/dev'
+import { netlifyPlugin } from '@netlify/remix-edge-adapter/plugin'
 
 export default defineConfig({
-  plugins: [remix(), netlifyPlugin(),
-});
+  plugins: [remix(), netlifyPlugin()],
+})
+```
+
+If you have your own Netlify Functions (typically in `netlify/functions`) for which you've configured a `path`, you must
+exclude those paths to avoid conflicts with the generated Remix SSR handler, which would otherwise run on all dynamic
+paths:
+
+```js
+// vite.config.js
+import { vitePlugin as remix } from '@remix-run/dev'
+import { netlifyPlugin } from '@netlify/remix-edge-adapter/plugin'
+
+export default defineConfig({
+  plugins: [
+    remix(),
+    netlifyPlugin({
+      excludedPaths: ['/ping', '/api/*', '/webhooks/*'],
+    }),
+  ],
+})
 ```
 
 3. Add an `app/entry.jsx` (.tsx if using TypeScript) with these contents:

packages/remix-edge-adapter/src/vite/plugin.ts

@@ -85,7 +85,7 @@ export default createRequestHandler({
 
 // This is written to the edge functions directory. It just re-exports
 // the compiled entrypoint, along with the Netlify function config.
-function generateEdgeFunction(handlerPath: string, exclude: Array<string> = []) {
+function generateEdgeFunction(handlerPath: string, excludedPath: Array<string>) {
   return /* js */ `
     export { default } from "${handlerPath}";
 
@@ -94,7 +94,7 @@ function generateEdgeFunction(handlerPath: string, exclude: Array<string> = [])
       generator: "${name}@${version}",
       cache: "manual",
       path: "/*",
-      excludedPath: ${JSON.stringify(exclude)},
+      excludedPath: ${JSON.stringify(excludedPath)},
     };`
 }
 
@@ -125,7 +125,21 @@ const getEdgeFunctionHandlerModuleId = async (root: string, isHydrogenSite: bool
   return findUserEdgeFunctionHandlerFile(root)
 }
 
-export function netlifyPlugin(): Plugin {
+export interface NetlifyPluginOptions {
+  /**
+   * Paths to exclude from being handled by the Remix handler.
+   *
+   * @IMPORTANT If you have your own Netlify Functions running on custom `path`s, you
+   * must exclude those paths here to avoid conflicts.
+   *
+   * @type {string[]}
+   * @default []
+   */
+  excludedPaths?: string[]
+}
+
+export function netlifyPlugin(options: NetlifyPluginOptions = {}): Plugin {
+  const additionalExcludedPaths = options.excludedPaths ?? []
   let resolvedConfig: ResolvedConfig
   let currentCommand: string
   let isSsr: boolean | undefined
@@ -264,23 +278,25 @@ export function netlifyPlugin(): Plugin {
     async writeBundle() {
       // Write the server entrypoint to the Netlify functions directory
       if (currentCommand === 'build' && isSsr) {
-        const exclude: Array<string> = ['/.netlify/*']
+        const excludedPath: Array<string> = ['/.netlify/*']
         try {
           // Get the client files so we can skip them in the edge function
           const clientDirectory = join(resolvedConfig.build.outDir, '..', 'client')
           const entries = await readdir(clientDirectory, { withFileTypes: true })
           for (const entry of entries) {
             // With directories we don't bother to recurse into it and just skip the whole thing.
             if (entry.isDirectory()) {
-              exclude.push(`/${entry.name}/*`)
+              excludedPath.push(`/${entry.name}/*`)
             } else if (entry.isFile()) {
-              exclude.push(`/${entry.name}`)
+              excludedPath.push(`/${entry.name}`)
             }
           }
         } catch {
           // Ignore if it doesn't exist
         }
 
+        excludedPath.push(...additionalExcludedPaths)
+
         const edgeFunctionsDirectory = join(resolvedConfig.root, NETLIFY_EDGE_FUNCTIONS_DIR)
 
         await mkdir(edgeFunctionsDirectory, { recursive: true })
@@ -290,7 +306,7 @@ export function netlifyPlugin(): Plugin {
 
         await writeFile(
           join(edgeFunctionsDirectory, EDGE_FUNCTION_FILENAME),
-          generateEdgeFunction(relativeHandlerPath, exclude),
+          generateEdgeFunction(relativeHandlerPath, excludedPath),
         )
       }
     },

tests/e2e/fixtures/edge-site/vite.config.ts

@@ -4,5 +4,9 @@ import tsconfigPaths from "vite-tsconfig-paths";
 import { netlifyPlugin } from "@netlify/remix-edge-adapter/plugin";
 
 export default defineConfig({
-  plugins: [remix(), netlifyPlugin(), tsconfigPaths()],
+  plugins: [
+    remix(),
+    netlifyPlugin({ excludedPaths: ["/please-blorble", "/purge-cdn"] }),
+    tsconfigPaths(),
+  ],
 });