@netlify/edge-bundler 7.0.1 → 8.0.0

package/deno/config.ts

@@ -19,22 +19,12 @@ if (func.config === undefined) {
   Deno.exit(exitCodes.NoConfig)
 }
 
-if (typeof func.config !== 'function') {
+if (typeof func.config !== 'object') {
   Deno.exit(exitCodes.InvalidExport)
 }
 
-let config
-
-try {
-  config = await func.config()
-} catch (error) {
-  console.error(error)
-
-  Deno.exit(exitCodes.RuntimeError)
-}
-
 try {
-  const result = JSON.stringify(config)
+  const result = JSON.stringify(func.config)
 
   await Deno.writeTextFile(new URL(collectorURL), result)
 } catch (error) {

package/dist/node/bundler.test.js

@@ -110,7 +110,28 @@ test('Prints a nice error message when user tries importing NPM module', async (
     }
     catch (error) {
         expect(error).toBeInstanceOf(BundleError);
-        expect(error.message).toEqual(`It seems like you're trying to import an npm module. This is only supported in Deno via CDNs like esm.sh. Have you tried 'import mod from "https://esm.sh/p-retry"'?`);
+        expect(error.message).toEqual(`It seems like you're trying to import an npm module. This is only supported via CDNs like esm.sh. Have you tried 'import mod from "https://esm.sh/p-retry"'?`);
+    }
+    finally {
+        await cleanup();
+    }
+});
+test('Prints a nice error message when user tries importing NPM module with npm: scheme', async () => {
+    expect.assertions(2);
+    const { basePath, cleanup, distPath } = await useFixture('imports_npm_module_scheme');
+    const sourceDirectory = join(basePath, 'functions');
+    const declarations = [
+        {
+            function: 'func1',
+            path: '/func1',
+        },
+    ];
+    try {
+        await bundle([sourceDirectory], distPath, declarations, { basePath });
+    }
+    catch (error) {
+        expect(error).toBeInstanceOf(BundleError);
+        expect(error.message).toEqual(`It seems like you're trying to import an npm module. This is only supported via CDNs like esm.sh. Have you tried 'import mod from "https://esm.sh/p-retry"'?`);
     }
     finally {
         await cleanup();
@@ -278,10 +299,12 @@ test('Loads declarations and import maps from the deploy configuration', async (
     expect(generatedFiles.length).toBe(2);
     const manifestFile = await fs.readFile(resolve(distPath, 'manifest.json'), 'utf8');
     const manifest = JSON.parse(manifestFile);
-    const { bundles } = manifest;
+    const { bundles, routes } = manifest;
     expect(bundles.length).toBe(1);
     expect(bundles[0].format).toBe('eszip2');
     expect(generatedFiles.includes(bundles[0].asset)).toBe(true);
+    // respects excludedPath from deploy config
+    expect(routes[1].excluded_pattern).toEqual('^/func2/skip/?$');
     await cleanup();
 });
 test("Ignores entries in `importMapPaths` that don't point to an existing import map file", async () => {

package/dist/node/config.js

@@ -11,9 +11,8 @@ var ConfigExitCode;
     ConfigExitCode[ConfigExitCode["ImportError"] = 2] = "ImportError";
     ConfigExitCode[ConfigExitCode["NoConfig"] = 3] = "NoConfig";
     ConfigExitCode[ConfigExitCode["InvalidExport"] = 4] = "InvalidExport";
-    ConfigExitCode[ConfigExitCode["RuntimeError"] = 5] = "RuntimeError";
-    ConfigExitCode[ConfigExitCode["SerializationError"] = 6] = "SerializationError";
-    ConfigExitCode[ConfigExitCode["InvalidDefaultExport"] = 7] = "InvalidDefaultExport";
+    ConfigExitCode[ConfigExitCode["SerializationError"] = 5] = "SerializationError";
+    ConfigExitCode[ConfigExitCode["InvalidDefaultExport"] = 6] = "InvalidDefaultExport";
 })(ConfigExitCode || (ConfigExitCode = {}));
 const getConfigExtractor = () => {
     const packagePath = getPackagePath();
@@ -75,14 +74,10 @@ const logConfigError = (func, exitCode, stderr, log) => {
             log.system(`No in-source config found for edge function at '${func.path}'`);
             break;
         case ConfigExitCode.InvalidExport:
-            log.user(`'config' export in edge function at '${func.path}' must be a function`);
-            break;
-        case ConfigExitCode.RuntimeError:
-            log.user(`Error while running 'config' function in edge function at '${func.path}'`);
-            log.user(stderr);
+            log.user(`'config' export in edge function at '${func.path}' must be an object`);
             break;
         case ConfigExitCode.SerializationError:
-            log.user(`'config' function in edge function at '${func.path}' must return an object with primitive values only`);
+            log.user(`'config' object in edge function at '${func.path}' must contain primitive values only`);
             break;
         case ConfigExitCode.InvalidDefaultExport:
             throw new BundleError(new Error(`Default export in '${func.path}' must be a function. More on the Edge Functions API at https://ntl.fyi/edge-api.`));

package/dist/node/config.test.js

@@ -35,7 +35,7 @@ test('`getFunctionConfig` extracts configuration properties from function file',
             source: `
         export default async () => new Response("Hello from function two")
 
-        export const config = () => ({})
+        export const config = {}
       `,
         },
         // Config with the wrong type
@@ -45,9 +45,9 @@ test('`getFunctionConfig` extracts configuration properties from function file',
             source: `
       export default async () => new Response("Hello from function two")
 
-      export const config = {}
+      export const config = () => ({})
     `,
-            userLog: /^'config' export in edge function at '(.*)' must be a function$/,
+            userLog: /^'config' export in edge function at '(.*)' must be an object$/,
         },
         // Config with a syntax error
         {
@@ -60,19 +60,6 @@ test('`getFunctionConfig` extracts configuration properties from function file',
     `,
             userLog: /^Could not load edge function at '(.*)'$/,
         },
-        // Config that throws
-        {
-            expectedConfig: {},
-            name: 'func5',
-            source: `
-          export default async () => new Response("Hello from function two")
-
-          export const config = () => {
-            throw new Error('uh-oh')
-          }
-        `,
-            userLog: /^Error while running 'config' function in edge function at '(.*)'$/,
-        },
         // Config with `path`
         {
             expectedConfig: { path: '/home' },
@@ -80,23 +67,8 @@ test('`getFunctionConfig` extracts configuration properties from function file',
             source: `
         export default async () => new Response("Hello from function three")
 
-        export const config = () => ({ path: "/home" })
-      `,
-        },
-        // Config that prints to stdout
-        {
-            expectedConfig: { path: '/home' },
-            name: 'func7',
-            source: `
-        export default async () => new Response("Hello from function three")
-
-        export const config = () => {
-          console.log("Hello from config!")
-
-          return { path: "/home" }
-        }
+        export const config = { path: "/home" }
       `,
-            userLog: /^Hello from config!$/,
         },
     ];
     for (const func of functions) {

package/dist/node/declaration.d.ts

@@ -7,9 +7,11 @@ interface BaseDeclaration {
 }
 type DeclarationWithPath = BaseDeclaration & {
     path: string;
+    excludedPath?: string;
 };
 type DeclarationWithPattern = BaseDeclaration & {
     pattern: string;
+    excludedPattern?: string;
 };
 type Declaration = DeclarationWithPath | DeclarationWithPattern;
 export declare const getDeclarationsFromConfig: (tomlDeclarations: Declaration[], functionsConfig: Record<string, FunctionConfig>, deployConfig: DeployConfig) => Declaration[];

package/dist/node/declaration.test.js

@@ -92,3 +92,10 @@ test('In-source config works if path property is an empty array with cache value
     const expectedDeclarations = [{ function: 'json', path: '/json-toml', cache: 'manual' }];
     expect(getDeclarationsFromConfig(tomlConfig, funcConfig, deployConfig)).toEqual(expectedDeclarations);
 });
+test('netlify.toml-defined excludedPath are respected', () => {
+    const tomlConfig = [{ function: 'geolocation', path: '/geo/*', excludedPath: '/geo/exclude' }];
+    const funcConfig = {};
+    const expectedDeclarations = [{ function: 'geolocation', path: '/geo/*', excludedPath: '/geo/exclude' }];
+    const declarations = getDeclarationsFromConfig(tomlConfig, funcConfig, deployConfig);
+    expect(declarations).toEqual(expectedDeclarations);
+});

package/dist/node/manifest.d.ts

@@ -9,6 +9,12 @@ interface GenerateManifestOptions {
     importMap?: string;
     layers?: Layer[];
 }
+interface Route {
+    function: string;
+    name?: string;
+    pattern: string;
+    excluded_pattern?: string;
+}
 interface Manifest {
     bundler_version: string;
     bundles: {
@@ -20,16 +26,13 @@ interface Manifest {
         name: string;
         flag: string;
     }[];
-    routes: {
-        function: string;
-        name?: string;
-        pattern: string;
-    }[];
-    post_cache_routes: {
-        function: string;
-        name?: string;
-        pattern: string;
-    }[];
+    routes: Route[];
+    post_cache_routes: Route[];
+}
+interface Route {
+    function: string;
+    name?: string;
+    pattern: string;
 }
 declare const generateManifest: ({ bundles, declarations, functions, importMap, layers, }: GenerateManifestOptions) => Manifest;
 interface WriteManifestOptions {

package/dist/node/manifest.js

@@ -3,6 +3,7 @@ import { join } from 'path';
 import globToRegExp from 'glob-to-regexp';
 import { getPackageVersion } from './package_json.js';
 import { nonNullable } from './utils/non_nullable.js';
+const serializePattern = (regex) => regex.source.replace(/\\\//g, '/');
 const generateManifest = ({ bundles = [], declarations = [], functions, importMap, layers = [], }) => {
     const preCacheRoutes = [];
     const postCacheRoutes = [];
@@ -12,12 +13,15 @@ const generateManifest = ({ bundles = [], declarations = [], functions, importMa
             return;
         }
         const pattern = getRegularExpression(declaration);
-        const serializablePattern = pattern.source.replace(/\\\//g, '/');
         const route = {
             function: func.name,
             name: declaration.name,
-            pattern: serializablePattern,
+            pattern: serializePattern(pattern),
         };
+        const excludedPattern = getExcludedRegularExpression(declaration);
+        if (excludedPattern) {
+            route.excluded_pattern = serializePattern(excludedPattern);
+        }
         if (declaration.cache === "manual" /* Cache.Manual */) {
             postCacheRoutes.push(route);
         }
@@ -39,19 +43,30 @@ const generateManifest = ({ bundles = [], declarations = [], functions, importMa
     };
     return manifest;
 };
-const getRegularExpression = (declaration) => {
-    if ('pattern' in declaration) {
-        return new RegExp(declaration.pattern);
-    }
+const pathToRegularExpression = (path) => {
     // We use the global flag so that `globToRegExp` will not wrap the expression
     // with `^` and `$`. We'll do that ourselves.
-    const regularExpression = globToRegExp(declaration.path, { flags: 'g' });
+    const regularExpression = globToRegExp(path, { flags: 'g' });
     // Wrapping the expression source with `^` and `$`. Also, adding an optional
     // trailing slash, so that a declaration of `path: "/foo"` matches requests
     // for both `/foo` and `/foo/`.
     const normalizedSource = `^${regularExpression.source}\\/?$`;
     return new RegExp(normalizedSource);
 };
+const getRegularExpression = (declaration) => {
+    if ('pattern' in declaration) {
+        return new RegExp(declaration.pattern);
+    }
+    return pathToRegularExpression(declaration.path);
+};
+const getExcludedRegularExpression = (declaration) => {
+    if ('pattern' in declaration && declaration.excludedPattern) {
+        return new RegExp(declaration.excludedPattern);
+    }
+    if ('path' in declaration && declaration.excludedPath) {
+        return pathToRegularExpression(declaration.excludedPath);
+    }
+};
 const writeManifest = async ({ bundles, declarations = [], distDirectory, functions, importMap, layers, }) => {
     const manifest = generateManifest({ bundles, declarations, functions, importMap, layers });
     const manifestPath = join(distDirectory, 'manifest.json');

package/dist/node/manifest.test.js

@@ -42,6 +42,23 @@ test('Generates a manifest with display names', () => {
     expect(manifest.routes).toEqual(expectedRoutes);
     expect(manifest.bundler_version).toBe(env.npm_package_version);
 });
+test('Generates a manifest with excluded paths and patterns', () => {
+    const functions = [
+        { name: 'func-1', path: '/path/to/func-1.ts' },
+        { name: 'func-2', path: '/path/to/func-2.ts' },
+    ];
+    const declarations = [
+        { function: 'func-1', name: 'Display Name', path: '/f1/*', excludedPath: '/f1/exclude' },
+        { function: 'func-2', pattern: '^/f2/.*/?$', excludedPattern: '^/f2/exclude$' },
+    ];
+    const manifest = generateManifest({ bundles: [], declarations, functions });
+    const expectedRoutes = [
+        { function: 'func-1', name: 'Display Name', pattern: '^/f1/.*/?$', excluded_pattern: '^/f1/exclude/?$' },
+        { function: 'func-2', pattern: '^/f2/.*/?$', excluded_pattern: '^/f2/exclude$' },
+    ];
+    expect(manifest.routes).toEqual(expectedRoutes);
+    expect(manifest.bundler_version).toBe(env.npm_package_version);
+});
 test('Excludes functions for which there are function files but no matching config declarations', () => {
     const bundle1 = {
         extension: '.ext2',

package/dist/node/npm_import_error.js

@@ -1,6 +1,6 @@
 class NPMImportError extends Error {
     constructor(originalError, moduleName) {
-        super(`It seems like you're trying to import an npm module. This is only supported in Deno via CDNs like esm.sh. Have you tried 'import mod from "https://esm.sh/${moduleName}"'?`);
+        super(`It seems like you're trying to import an npm module. This is only supported via CDNs like esm.sh. Have you tried 'import mod from "https://esm.sh/${moduleName}"'?`);
         this.name = 'NPMImportError';
         this.stack = originalError.stack;
         // https://github.com/microsoft/TypeScript-wiki/blob/8a66ecaf77118de456f7cd9c56848a40fe29b9b4/Breaking-Changes.md#implicit-any-error-raised-for-un-annotated-callback-arguments-with-no-matching-overload-arguments
@@ -14,6 +14,11 @@ const wrapNpmImportError = (input) => {
             const [, moduleName] = match;
             return new NPMImportError(input, moduleName);
         }
+        const schemeMatch = input.message.match(/Error: Module not found "npm:(.*)"/);
+        if (schemeMatch !== null) {
+            const [, moduleName] = schemeMatch;
+            return new NPMImportError(input, moduleName);
+        }
     }
     return input;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@netlify/edge-bundler",
-  "version": "7.0.1",
+  "version": "8.0.0",
   "description": "Intelligently prepare Netlify Edge Functions for deployment",
   "type": "module",
   "main": "./dist/node/index.js",