feat: read import map from functions.deno_import_map config property (#4782)

renovate[bot] · eduardoboucas · web-flow · commit f1d8ebc03b95 · 2022-12-20T10:53:56.000Z
* fix(deps): update dependency @netlify/edge-bundler to v7

* chore: update test snapshots

* feat: load user-defined import map

* chore: update snapshots

* refactor: rename config property

* chore: update snapshot

Co-authored-by: renovate[bot] &lt;29139614+renovate[bot]@users.noreply.github.com&gt;
Co-authored-by: Eduardo Bouças &lt;mail@eduardoboucas.com&gt;
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/build/package.json b/packages/build/package.json
@@ -66,7 +66,7 @@
     "@bugsnag/js": "^7.0.0",
     "@netlify/cache-utils": "^5.1.0",
     "@netlify/config": "^20.1.0",
-    "@netlify/edge-bundler": "6.1.0",
+    "@netlify/edge-bundler": "7.0.1",
     "@netlify/functions-utils": "^5.1.1",
     "@netlify/git-utils": "^5.1.0",
     "@netlify/plugins-list": "^6.59.0",
diff --git a/packages/build/src/plugins_core/edge_functions/index.js b/packages/build/src/plugins_core/edge_functions/index.js
@@ -28,6 +28,7 @@ const coreStep = async function ({
   netlifyConfig,
 }) {
   const { edge_functions: declarations = [] } = netlifyConfig
+  const { deno_import_map: userDefinedImportMap } = netlifyConfig.functions['*']
   const distPath = resolve(buildDir, distDirectory)
   const internalSrcPath = resolve(buildDir, internalSrcDirectory)
   const distImportMapPath = join(dirname(internalSrcPath), IMPORT_MAP_FILENAME)
@@ -61,6 +62,7 @@ const coreStep = async function ({
       debug,
       distImportMapPath,
       featureFlags,
+      importMapPaths: [userDefinedImportMap],
       systemLogger: featureFlags.edge_functions_system_logger ? systemLog : undefined,
     })
 
diff --git a/packages/build/tests/edge_functions/fixtures/functions_user/netlify.toml b/packages/build/tests/edge_functions/fixtures/functions_user/netlify.toml
@@ -1,3 +1,6 @@
+[functions]
+deno_import_map = "netlify/edge-functions/import-map.json"
+
 [[edge_functions]]
 function = "function-1"
 path = "/one"
diff --git a/packages/build/tests/edge_functions/fixtures/functions_user/netlify/edge-functions/function-1.ts b/packages/build/tests/edge_functions/fixtures/functions_user/netlify/edge-functions/function-1.ts
@@ -1 +1,3 @@
-export default async () => new Response('Hello world')
+import { greet } from 'util/misc.ts'
+
+export default async () => new Response(greet('friend'))
diff --git a/packages/build/tests/edge_functions/fixtures/functions_user/netlify/edge-functions/import-map.json b/packages/build/tests/edge_functions/fixtures/functions_user/netlify/edge-functions/import-map.json
@@ -0,0 +1,5 @@
+{
+  "imports": {
+    "util/": "../../util/"
+  }
+}
diff --git a/packages/build/tests/edge_functions/fixtures/functions_user/util/misc.ts b/packages/build/tests/edge_functions/fixtures/functions_user/util/misc.ts
@@ -0,0 +1 @@
+export const greet = (name: string) => `Hello, ${name}!`
diff --git a/packages/build/tests/edge_functions/snapshots/tests.js.md b/packages/build/tests/edge_functions/snapshots/tests.js.md
@@ -500,7 +500,7 @@ Generated by [AVA](https://avajs.dev).
     ────────────────────────────────────────────────────────────────␊
     ␊
       Error message␊
-      Command failed with exit code 1: deno run --allow-all --no-config --import-map=/node_module/path --quiet /node_module/path {"basePath":"packages/build/tests/edge_functions/fixtures/functions_invalid","destPath":"packages/build/tests/edge_functions/fixtures/functions_invalid/.netlify/edge-functions-dist/HEXADECIMAL_ID.eszip","externals":[],"functions":[{"name":"functions-1","path":"packages/build/tests/edge_functions/fixtures/functions_invalid/netlify/edge-functions/functions-1.ts"}],"importMapData":"{/"imports/":{/"netlify:edge/":/"https://edge.netlify.com/v1.0.0/index.ts/"}}"}␊
+      Command failed with exit code 1: deno run --allow-all --no-config --import-map=/node_module/path --quiet /node_module/path {"basePath":"packages/build/tests/edge_functions/fixtures/functions_invalid","destPath":"packages/build/tests/edge_functions/fixtures/functions_invalid/.netlify/edge-functions-dist/HEXADECIMAL_ID.eszip","externals":[],"functions":[{"name":"functions-1","path":"packages/build/tests/edge_functions/fixtures/functions_invalid/netlify/edge-functions/functions-1.ts"}],"importMapData":"{/"imports/":{/"netlify:edge/":/"https://edge.netlify.com/v1.0.0/index.ts/"},/"scopes/":{}}"}␊
       error: Uncaught (in promise) Error: The module's source code could not be parsed: Expected '{', got 'async' at /external/path␊
             const ret = new Error(getStringFromWasm0(arg0, arg1));␊
                         ^␊
@@ -585,6 +585,9 @@ Generated by [AVA](https://avajs.dev).
         edge_functions: packages/build/tests/edge_functions/fixtures/functions_user/netlify/edge-functions␊
         publish: packages/build/tests/edge_functions/fixtures/functions_user␊
         publishOrigin: default␊
+      functions:␊
+        '*':␊
+          deno_import_map: packages/build/tests/edge_functions/fixtures/functions_user/netlify/edge-functions/import-map.json␊
     ␊
     > Context␊
       production␊
diff --git a/packages/build/tests/edge_functions/snapshots/tests.js.snap b/packages/build/tests/edge_functions/snapshots/tests.js.snap
diff --git a/packages/build/tests/monitor/snapshots/tests.js.md b/packages/build/tests/monitor/snapshots/tests.js.md
@@ -1761,7 +1761,7 @@ Generated by [AVA](https://avajs.dev).
     ────────────────────────────────────────────────────────────────␊
     ␊
       Error message␊
-      Command failed with exit code 1: deno run --allow-all --no-config --import-map=/node_module/path --quiet /node_module/path {"basePath":"packages/build/tests/monitor/fixtures/edge_function_error","destPath":"packages/build/tests/monitor/fixtures/edge_function_error/.netlify/edge-functions-dist/HEXADECIMAL_ID.eszip","externals":[],"functions":[{"name":"trouble","path":"packages/build/tests/monitor/fixtures/edge_function_error/netlify/edge-functions/trouble.ts"}],"importMapData":"{/"imports/":{/"netlify:edge/":/"https://edge.netlify.com/v1.0.0/index.ts/"}}"}␊
+      Command failed with exit code 1: deno run --allow-all --no-config --import-map=/node_module/path --quiet /node_module/path {"basePath":"packages/build/tests/monitor/fixtures/edge_function_error","destPath":"packages/build/tests/monitor/fixtures/edge_function_error/.netlify/edge-functions-dist/HEXADECIMAL_ID.eszip","externals":[],"functions":[{"name":"trouble","path":"packages/build/tests/monitor/fixtures/edge_function_error/netlify/edge-functions/trouble.ts"}],"importMapData":"{/"imports/":{/"netlify:edge/":/"https://edge.netlify.com/v1.0.0/index.ts/"},/"scopes/":{}}"}␊
       error: Uncaught (in promise) Error: Error: Could not find file: packages/build/tests/monitor/fixtures/edge_function_error/netlify/edge-functions/file.ts␊
             const ret = new Error(getStringFromWasm0(arg0, arg1));␊
                         ^␊
@@ -1779,9 +1779,9 @@ Generated by [AVA](https://avajs.dev).
     Error monitoring payload:␊
     {␊
       "errorClass": "functionsBundling",␊
-      "errorMessage": "Command failed with exit code 1: deno run --allow-all --no-config --import-map=/node_module/path --quiet /node_module/path {/"basePath/":/"packages/build/tests/monitor/fixtures/edge_function_error",/"destPath/":/"packages/build/tests/monitor/fixtures/edge_function_error/.netlify/edge-functions-dist/HEXADECIMAL_ID.eszip",/"externals/":[],/"functions/":[{/"name/":/"trouble/",/"path/":/"packages/build/tests/monitor/fixtures/edge_function_error/netlify/edge-functions/trouble.ts"}],/"importMapData/":/"{//"imports//":{//"netlify:edge//"://"https://edge.netlify.com/v1.0.0/index.ts//"}}/"}/nerror: Uncaught (in promise) Error: Error: Could not find file: packages/build/tests/monitor/fixtures/edge_function_error/netlify/edge-functions/file.ts/n      const ret = new Error(getStringFromWasm0(arg0, arg1));/n                  ^/n    at __wbg_new_HEXADECIMAL_ID (/node_module/path)/n    at <anonymous> (wasm://wasm/HEXADECIMAL_ID:1:80)/n    at <anonymous> (wasm://wasm/HEXADECIMAL_ID:1:80)/n    at <anonymous> (wasm://wasm/HEXADECIMAL_ID:1:80)/n    at __wbg_adapter_18 (/node_module/path)/n    at real (/node_module/path)",␊
+      "errorMessage": "Command failed with exit code 1: deno run --allow-all --no-config --import-map=/node_module/path --quiet /node_module/path {/"basePath/":/"packages/build/tests/monitor/fixtures/edge_function_error",/"destPath/":/"packages/build/tests/monitor/fixtures/edge_function_error/.netlify/edge-functions-dist/HEXADECIMAL_ID.eszip",/"externals/":[],/"functions/":[{/"name/":/"trouble/",/"path/":/"packages/build/tests/monitor/fixtures/edge_function_error/netlify/edge-functions/trouble.ts"}],/"importMapData/":/"{//"imports//":{//"netlify:edge//"://"https://edge.netlify.com/v1.0.0/index.ts//"},//"scopes//":{}}/"}/nerror: Uncaught (in promise) Error: Error: Could not find file: packages/build/tests/monitor/fixtures/edge_function_error/netlify/edge-functions/file.ts/n      const ret = new Error(getStringFromWasm0(arg0, arg1));/n                  ^/n    at __wbg_new_HEXADECIMAL_ID (/node_module/path)/n    at <anonymous> (wasm://wasm/HEXADECIMAL_ID:1:80)/n    at <anonymous> (wasm://wasm/HEXADECIMAL_ID:1:80)/n    at <anonymous> (wasm://wasm/HEXADECIMAL_ID:1:80)/n    at __wbg_adapter_18 (/node_module/path)/n    at real (/node_module/path)",␊
       "context": "Bundling of edge function failed",␊
-      "groupingHash": "Bundling of edge function failed/nCommand failed with exit code 0: deno run --allow-all --no-config /external/path --quiet /external/path {/"/":/"/",/"/":/"/",/"/":[],/"/":[{/"/":/"/",/"/":/"/"}],/"/":/"/"/external/path"/"/external/path"/"/external/path"/"}/nerror: Uncaught (in promise) Error: Error: Could not find file: /external/path      const ret = new Error(getStringFromWasm0(arg0, arg0));/n                  ^/n    at __wbg_new_hex /external/path    at <anonymous> /external/path    at <anonymous> /external/path    at <anonymous> /external/path    at __wbg_adapter_0 /external/path    at real /external/path",␊
+      "groupingHash": "Bundling of edge function failed/nCommand failed with exit code 0: deno run --allow-all --no-config /external/path --quiet /external/path {/"/":/"/",/"/":/"/",/"/":[],/"/":[{/"/":/"/",/"/":/"/"}],/"/":/"/"/external/path"/"/external/path"/"/external/path"/"/external/path"/"}/nerror: Uncaught (in promise) Error: Error: Could not find file: /external/path      const ret = new Error(getStringFromWasm0(arg0, arg0));/n                  ^/n    at __wbg_new_hex /external/path    at <anonymous> /external/path    at <anonymous> /external/path    at <anonymous> /external/path    at __wbg_adapter_0 /external/path    at real /external/path",␊
       "severity": "info",␊
       "unhandled": false,␊
       "location": {␊
@@ -1792,7 +1792,7 @@ Generated by [AVA](https://avajs.dev).
       "pluginPackageJson": false,␊
       "BUILD_ID": "0",␊
       "other": {␊
-        "groupingHash": "Bundling of edge function failed/nCommand failed with exit code 0: deno run --allow-all --no-config /external/path --quiet /external/path {/"/":/"/",/"/":/"/",/"/":[],/"/":[{/"/":/"/",/"/":/"/"}],/"/":/"/"/external/path"/"/external/path"/"/external/path"/"}/nerror: Uncaught (in promise) Error: Error: Could not find file: /external/path      const ret = new Error(getStringFromWasm0(arg0, arg0));/n                  ^/n    at __wbg_new_hex /external/path    at <anonymous> /external/path    at <anonymous> /external/path    at <anonymous> /external/path    at __wbg_adapter_0 /external/path    at real /external/path"␊
+        "groupingHash": "Bundling of edge function failed/nCommand failed with exit code 0: deno run --allow-all --no-config /external/path --quiet /external/path {/"/":/"/",/"/":/"/",/"/":[],/"/":[{/"/":/"/",/"/":/"/"}],/"/":/"/"/external/path"/"/external/path"/"/external/path"/"/external/path"/"}/nerror: Uncaught (in promise) Error: Error: Could not find file: /external/path      const ret = new Error(getStringFromWasm0(arg0, arg0));/n                  ^/n    at __wbg_new_hex /external/path    at <anonymous> /external/path    at <anonymous> /external/path    at <anonymous> /external/path    at __wbg_adapter_0 /external/path    at real /external/path"␊
       }␊
     }`
 
diff --git a/packages/build/tests/monitor/snapshots/tests.js.snap b/packages/build/tests/monitor/snapshots/tests.js.snap
diff --git a/packages/config/src/files.js b/packages/config/src/files.js
@@ -18,7 +18,12 @@ export const resolveConfigPaths = async function ({ config, repositoryRoot, buil
 
 // All file paths in the configuration file are are relative to `buildDir`
 // (if `baseRelDir` is `true`).
-const FILE_PATH_CONFIG_PROPS = ['functionsDirectory', 'build.publish', 'build.edge_functions']
+const FILE_PATH_CONFIG_PROPS = [
+  'functionsDirectory',
+  'functions.*.deno_import_map',
+  'build.publish',
+  'build.edge_functions',
+]
 
 const resolvePaths = function (config, propNames, baseRel, repositoryRoot) {
   return propNames.reduce((configA, propName) => resolvePathProp(configA, propName, baseRel, repositoryRoot), config)
diff --git a/packages/config/src/functions_config.js b/packages/config/src/functions_config.js
@@ -48,6 +48,7 @@ const isConfigLeaf = (functionConfig) =>
 const isConfigProperty = (propName) => FUNCTION_CONFIG_PROPERTIES.has(propName)
 
 export const FUNCTION_CONFIG_PROPERTIES = new Set([
+  'deno_import_map',
   'directory',
   'external_node_modules',
   'ignored_node_modules',
diff --git a/packages/config/src/validate/validations.js b/packages/config/src/validate/validations.js
@@ -187,14 +187,6 @@ export const POST_NORMALIZE_VALIDATIONS = [
     message: 'must be a string.',
     example: () => ({ build: { edge_functions: 'edge-functions' } }),
   },
-  {
-    property: 'build.edge_functions_import_map',
-    check: isString,
-    message: 'must be a string.',
-    example: () => ({
-      build: { edge_functions_import_map: 'path/to/import_map.json' },
-    }),
-  },
   {
     property: 'functions.*',
     check: isPlainObj,
@@ -203,6 +195,14 @@ export const POST_NORMALIZE_VALIDATIONS = [
       functions: { [prevPath[1]]: { external_node_modules: ['module-one', 'module-two'] } },
     }),
   },
+  {
+    property: 'functions.*.deno_import_map',
+    check: isString,
+    message: 'must be a string.',
+    example: (value, key, prevPath) => ({
+      functions: { [prevPath[1]]: { deno_import_map: 'path/to/import_map.json' } },
+    }),
+  },
   {
     property: 'functions.*.external_node_modules',
     check: isArrayOfStrings,
diff --git a/packages/config/tests/validate/fixtures/build_edge_functions_import_map/netlify.toml b/packages/config/tests/validate/fixtures/build_edge_functions_import_map/netlify.toml
diff --git a/packages/config/tests/validate/fixtures/functions_deno_import_map/netlify.toml b/packages/config/tests/validate/fixtures/functions_deno_import_map/netlify.toml
@@ -0,0 +1,2 @@
+[functions]
+deno_import_map = ["not", "a", "string"]
diff --git a/packages/config/tests/validate/snapshots/tests.js.md b/packages/config/tests/validate/snapshots/tests.js.md
@@ -476,27 +476,6 @@ Generated by [AVA](https://avajs.dev).
     `When resolving config file packages/config/tests/validate/fixtures/build_edge_functions_parent/netlify.toml:␊
     Configuration property "build.edge_functions" "edge_functions_dir" must be inside the repository root directory.`
 
-## build.edge_functions_import_map: string
-
-> Snapshot 1
-
-    `When resolving config file packages/config/tests/validate/fixtures/build_edge_functions_import_map/netlify.toml:␊
-    Configuration property build.edge_functions_import_map must be a string.␊
-    ␊
-    Invalid syntax␊
-    ␊
-      [build]␊
-      edge_functions_import_map = [␊
-        "not",␊
-        "a",␊
-        "string"␊
-      ]␊
-    ␊
-    Valid syntax␊
-    ␊
-      [build]␊
-      edge_functions_import_map = "path/to/import_map.json"`
-
 ## build.base: string
 
 > Snapshot 1
@@ -1418,6 +1397,31 @@ Generated by [AVA](https://avajs.dev).
       [functions]␊
       directory = "my-functions"`
 
+## functions.deno_import_map: string
+
+> Snapshot 1
+
+    `When resolving config file packages/config/tests/validate/fixtures/functions_deno_import_map/netlify.toml:␊
+    Configuration property functions.*.deno_import_map must be a string.␊
+    ␊
+    Invalid syntax␊
+    ␊
+      [functions]␊
+    ␊
+        [functions."*"]␊
+        deno_import_map = [␊
+          "not",␊
+          "a",␊
+          "string"␊
+        ]␊
+    ␊
+    Valid syntax␊
+    ␊
+      [functions]␊
+    ␊
+        [functions."*"]␊
+        deno_import_map = "path/to/import_map.json"`
+
 ## Validates defaultConfig
 
 > Snapshot 1
diff --git a/packages/config/tests/validate/snapshots/tests.js.snap b/packages/config/tests/validate/snapshots/tests.js.snap
diff --git a/packages/config/tests/validate/tests.js b/packages/config/tests/validate/tests.js
@@ -113,11 +113,6 @@ test('build.edge_functions: parent directory', async (t) => {
   t.snapshot(normalizeOutput(output))
 })
 
-test('build.edge_functions_import_map: string', async (t) => {
-  const output = await new Fixture('./fixtures/build_edge_functions_import_map').runWithConfig()
-  t.snapshot(normalizeOutput(output))
-})
-
 test('build.base: string', async (t) => {
   const output = await new Fixture('./fixtures/build_base_string').runWithConfig()
   t.snapshot(normalizeOutput(output))
@@ -247,6 +242,11 @@ test('functions.directory: defined on the main functions object', async (t) => {
   t.snapshot(normalizeOutput(output))
 })
 
+test('functions.deno_import_map: string', async (t) => {
+  const output = await new Fixture('./fixtures/functions_deno_import_map').runWithConfig()
+  t.snapshot(normalizeOutput(output))
+})
+
 test('Validates defaultConfig', async (t) => {
   const output = await new Fixture('./fixtures/empty')
     .withFlags({ defaultConfig: { build: { command: false } } })

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +{
 +  "imports": {
 +    "util/": "../../util/"
 +  }
 +}
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	+export const greet = (name: string) => `Hello, ${name}!`