@netlify/build 26.5.3 → 27.0.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@netlify/build",
-  "version": "26.5.3",
+  "version": "27.0.1",
   "description": "Netlify build module",
   "type": "module",
   "exports": "./src/core/main.js",
@@ -56,11 +56,11 @@
   "license": "MIT",
   "dependencies": {
     "@bugsnag/js": "^7.0.0",
+    "@netlify/edge-bundler": "^0.12.0",
     "@netlify/cache-utils": "^4.0.0",
-    "@netlify/config": "^17.0.0",
+    "@netlify/config": "^18.0.0",
     "@netlify/functions-utils": "^4.0.0",
     "@netlify/git-utils": "^4.0.0",
-    "@netlify/plugin-edge-handlers": "^3.0.7",
     "@netlify/plugins-list": "^6.19.0",
     "@netlify/run-utils": "^4.0.0",
     "@netlify/zip-it-and-ship-it": "5.9.0",

package/src/core/constants.js

@@ -11,7 +11,7 @@ export const getConstants = async function ({
   configPath,
   buildDir,
   functionsDistDir,
-  edgeHandlersDistDir,
+  edgeFunctionsDistDir,
   cacheDir,
   netlifyConfig,
   siteInfo: { id: siteId },
@@ -27,8 +27,8 @@ export const getConstants = async function ({
     CONFIG_PATH: configPath,
     // The directory where built serverless functions are placed before deployment
     FUNCTIONS_DIST: functionsDistDir,
-    // The directory where built Edge Handlers are placed before deployment
-    EDGE_HANDLERS_DIST: edgeHandlersDistDir,
+    // The directory where built Edge Functions are placed before deployment
+    EDGE_FUNCTIONS_DIST: edgeFunctionsDistDir,
     // Path to the Netlify build cache folder
     CACHE_DIR: normalizedCacheDir,
     // Boolean indicating whether the build was run locally (Netlify CLI) or in the production CI
@@ -44,15 +44,15 @@ export const getConstants = async function ({
     // The directory where internal functions (i.e. generated programmatically
     // via plugins or others) live
     INTERNAL_FUNCTIONS_SRC: `${buildDir}/${INTERNAL_FUNCTIONS_SRC}`,
-    // The directory where internal Edge Handlers (i.e. generated programmatically
+    // The directory where internal Edge Functions (i.e. generated programmatically
     // via plugins or others) live
-    INTERNAL_EDGE_HANDLERS_SRC: `${buildDir}/${INTERNAL_EDGE_HANDLERS_SRC}`,
+    INTERNAL_EDGE_FUNCTIONS_SRC: `${buildDir}/${INTERNAL_EDGE_FUNCTIONS_SRC}`,
   }
   const constantsA = await addMutableConstants({ constants, buildDir, netlifyConfig })
   return constantsA
 }
 
-const INTERNAL_EDGE_HANDLERS_SRC = '.netlify/edge-handlers'
+const INTERNAL_EDGE_FUNCTIONS_SRC = '.netlify/edge-functions'
 const INTERNAL_FUNCTIONS_SRC = '.netlify/functions-internal'
 
 // Retrieve constants which might change during the build if a plugin modifies
@@ -62,7 +62,7 @@ export const addMutableConstants = async function ({
   constants,
   buildDir,
   netlifyConfig: {
-    build: { publish, edge_handlers: edgeHandlers },
+    build: { publish, edge_functions: edgeFunctions },
     functionsDirectory,
   },
 }) {
@@ -72,8 +72,8 @@ export const addMutableConstants = async function ({
     PUBLISH_DIR: publish,
     // The directory where function source code lives
     FUNCTIONS_SRC: functionsDirectory,
-    // The directory where edge handlers source code lives
-    EDGE_HANDLERS_SRC: edgeHandlers,
+    // The directory where Edge Functions source code lives
+    EDGE_FUNCTIONS_SRC: edgeFunctions,
   }
   const constantsB = await addDefaultConstants(constantsA, buildDir)
   const constantsC = normalizeConstantsPaths(constantsB, buildDir)
@@ -100,7 +100,7 @@ const DEFAULT_PATHS = [
   // @todo Remove once we drop support for the legacy default functions directory.
   { constantName: 'FUNCTIONS_SRC', defaultPath: 'netlify-automatic-functions' },
   { constantName: 'FUNCTIONS_SRC', defaultPath: 'netlify/functions' },
-  { constantName: 'EDGE_HANDLERS_SRC', defaultPath: 'netlify/edge-handlers' },
+  { constantName: 'EDGE_FUNCTIONS_SRC', defaultPath: 'netlify/edge-functions' },
 ]
 
 const addDefaultConstant = async function ({ constants, constantName, defaultPath, buildDir }) {
@@ -148,9 +148,9 @@ const CONSTANT_PATHS = new Set([
   'PUBLISH_DIR',
   'FUNCTIONS_SRC',
   'FUNCTIONS_DIST',
-  'INTERNAL_EDGE_HANDLERS_SRC',
+  'INTERNAL_EDGE_FUNCTIONS_SRC',
   'INTERNAL_FUNCTIONS_SRC',
-  'EDGE_HANDLERS_DIST',
-  'EDGE_HANDLERS_SRC',
+  'EDGE_FUNCTIONS_DIST',
+  'EDGE_FUNCTIONS_SRC',
   'CACHE_DIR',
 ])

package/src/core/feature_flags.js

@@ -17,5 +17,7 @@ export const DEFAULT_FEATURE_FLAGS = {
   buildbot_es_modules_esbuild: false,
   buildbot_zisi_trace_nft: false,
   buildbot_zisi_esbuild_parser: false,
+  edge_functions_cache_cli: false,
+  edge_functions_produce_eszip: false,
   zisi_parse_isc: false,
 }

package/src/core/flags.js

@@ -110,9 +110,9 @@ Default: Current Node.js binary`,
 Default: automatically guessed`,
     hidden: true,
   },
-  edgeHandlersDistDir: {
+  edgeFunctionsDistDir: {
     string: true,
-    describe: `Path to the directory where packaged Edge Handlers are kept.
+    describe: `Path to the directory where packaged Edge Functions are kept.
 Default: automatically guessed`,
     hidden: true,
   },

package/src/core/main.js

@@ -164,7 +164,7 @@ const tExecBuild = async function ({
   verbose,
   nodePath,
   functionsDistDir,
-  edgeHandlersDistDir,
+  edgeFunctionsDistDir,
   cacheDir,
   dry,
   mode,
@@ -230,7 +230,7 @@ const tExecBuild = async function ({
     configPath,
     buildDir,
     functionsDistDir,
-    edgeHandlersDistDir,
+    edgeFunctionsDistDir,
     cacheDir,
     netlifyConfig,
     siteInfo,

package/src/core/normalize_flags.js

@@ -41,7 +41,7 @@ const getDefaultFlags = function ({ env: envOpt = {} }, combinedEnv) {
     telemetry: false,
     verbose: Boolean(combinedEnv.NETLIFY_BUILD_DEBUG),
     functionsDistDir: DEFAULT_FUNCTIONS_DIST,
-    edgeHandlersDistDir: DEFAULT_EDGE_HANDLERS_DIST,
+    edgeFunctionsDistDir: DEFAULT_EDGE_FUNCTIONS_DIST,
     cacheDir: DEFAULT_CACHE_DIR,
     deployId: combinedEnv.DEPLOY_ID,
     buildId: combinedEnv.BUILD_ID,
@@ -63,7 +63,7 @@ const computeTelemetry = function (flags, envOpts) {
 }
 
 const REQUIRE_MODE = 'require'
-const DEFAULT_EDGE_HANDLERS_DIST = '.netlify/edge-handlers-dist/'
+const DEFAULT_EDGE_FUNCTIONS_DIST = '.netlify/edge-functions-dist/'
 const DEFAULT_FUNCTIONS_DIST = '.netlify/functions/'
 const DEFAULT_CACHE_DIR = '.netlify/cache/'
 const DEFAULT_STATSD_PORT = 8125

package/src/log/messages/config.js

@@ -34,7 +34,7 @@ const TEST_FLAGS = ['buffer', 'telemetry']
 const INTERNAL_FLAGS = [
   'nodePath',
   'functionsDistDir',
-  'edgeHandlersDistDir',
+  'edgeFunctionsDistDir',
   'defaultConfig',
   'cachedConfigPath',
   'sendStatus',

package/src/log/messages/core_steps.js

@@ -59,9 +59,10 @@ export const logFunctionsToBundle = function ({
   userFunctionsSrcExists,
   internalFunctions,
   internalFunctionsSrc,
+  type = 'Functions',
 }) {
   if (internalFunctions.length !== 0) {
-    log(logs, `Packaging Functions from ${THEME.highlightWords(internalFunctionsSrc)} directory:`)
+    log(logs, `Packaging ${type} from ${THEME.highlightWords(internalFunctionsSrc)} directory:`)
     logArray(logs, internalFunctions, { indent: false })
   }
 
@@ -70,7 +71,7 @@ export const logFunctionsToBundle = function ({
   }
 
   if (userFunctions.length === 0) {
-    log(logs, `No Functions were found in ${THEME.highlightWords(userFunctionsSrc)} directory`)
+    log(logs, `No ${type} were found in ${THEME.highlightWords(userFunctionsSrc)} directory`)
 
     return
   }
@@ -79,7 +80,7 @@ export const logFunctionsToBundle = function ({
     log(logs, '')
   }
 
-  log(logs, `Packaging Functions from ${THEME.highlightWords(userFunctionsSrc)} directory:`)
+  log(logs, `Packaging ${type} from ${THEME.highlightWords(userFunctionsSrc)} directory:`)
   logArray(logs, userFunctions, { indent: false })
 }
 

package/src/plugins_core/edge_functions/index.js

@@ -0,0 +1,103 @@
+import { dirname, join, resolve } from 'path'
+
+import { bundle, find } from '@netlify/edge-bundler'
+import { pathExists } from 'path-exists'
+
+import { logFunctionsToBundle } from '../../log/messages/core_steps.js'
+
+import { parseManifest } from './lib/internal_manifest.js'
+
+// TODO: Replace this with a custom cache directory.
+const DENO_CLI_CACHE_DIRECTORY = '.netlify/plugins/deno-cli'
+const IMPORT_MAP_FILENAME = 'edge-functions-import-map.json'
+
+const coreStep = async function ({
+  buildDir,
+  constants: {
+    EDGE_FUNCTIONS_DIST: distDirectory,
+    EDGE_FUNCTIONS_SRC: srcDirectory,
+    INTERNAL_EDGE_FUNCTIONS_SRC: internalSrcDirectory,
+    IS_LOCAL: isRunningLocally,
+  },
+  debug,
+  featureFlags,
+  logs,
+  netlifyConfig,
+}) {
+  const { edge_functions: configDeclarations = [] } = netlifyConfig
+  const distPath = resolve(buildDir, distDirectory)
+  const internalSrcPath = resolve(buildDir, internalSrcDirectory)
+  const distImportMapPath = join(dirname(internalSrcPath), IMPORT_MAP_FILENAME)
+  const srcPath = srcDirectory ? resolve(buildDir, srcDirectory) : undefined
+  const sourcePaths = [internalSrcPath, srcPath].filter(Boolean)
+
+  logFunctions({ internalSrcDirectory, internalSrcPath, logs, srcDirectory, srcPath })
+
+  const { declarations: internalDeclarations, importMap } = await parseManifest(internalSrcPath)
+  const declarations = [...configDeclarations, ...internalDeclarations]
+
+  // If we're running in buildbot and the feature flag is enabled, we set the
+  // Deno cache dir to a directory that is persisted between builds.
+  const cacheDirectory =
+    !isRunningLocally && featureFlags.edge_functions_cache_cli ? resolve(buildDir, DENO_CLI_CACHE_DIRECTORY) : undefined
+
+  await bundle(sourcePaths, distPath, declarations, {
+    cacheDirectory,
+    debug,
+    distImportMapPath,
+    featureFlags,
+    importMaps: [importMap].filter(Boolean),
+  })
+
+  return {}
+}
+
+// We run this core step if at least one of the functions directories (the
+// one configured by the user or the internal one) exists. We use a dynamic
+// `condition` because the directories might be created by the build command
+// or plugins.
+const hasEdgeFunctionsDirectories = async function ({
+  buildDir,
+  constants: { INTERNAL_EDGE_FUNCTIONS_SRC, EDGE_FUNCTIONS_SRC },
+}) {
+  const hasFunctionsSrc = EDGE_FUNCTIONS_SRC !== undefined && EDGE_FUNCTIONS_SRC !== ''
+
+  if (hasFunctionsSrc) {
+    return true
+  }
+
+  const internalFunctionsSrc = resolve(buildDir, INTERNAL_EDGE_FUNCTIONS_SRC)
+
+  return await pathExists(internalFunctionsSrc)
+}
+
+const logFunctions = async ({
+  internalSrcDirectory,
+  internalSrcPath,
+  logs,
+  srcDirectory: userFunctionsSrc,
+  srcPath,
+}) => {
+  const [userFunctions, internalFunctions] = await Promise.all([find([srcPath]), find([internalSrcPath])])
+  const userFunctionsSrcExists = await pathExists(srcPath)
+  const internalFunctionsSrc = internalSrcDirectory
+
+  logFunctionsToBundle({
+    logs,
+    userFunctions: userFunctions.map(({ name }) => name),
+    userFunctionsSrc,
+    userFunctionsSrcExists,
+    internalFunctions: internalFunctions.map(({ name }) => name),
+    internalFunctionsSrc,
+    type: 'Edge Functions',
+  })
+}
+
+export const bundleEdgeFunctions = {
+  event: 'onBuild',
+  coreStep,
+  coreStepId: 'edge_functions_bundling',
+  coreStepName: 'Edge Functions bundling',
+  coreStepDescription: () => 'Edge Functions bundling',
+  condition: hasEdgeFunctionsDirectories,
+}

package/src/plugins_core/edge_functions/lib/internal_manifest.js

@@ -0,0 +1,54 @@
+import { promises as fs } from 'fs'
+import { dirname, join, resolve } from 'path'
+
+const parseManifest = async (internalSourceDirectory) => {
+  const manifestPath = join(internalSourceDirectory, 'manifest.json')
+
+  try {
+    const data = await fs.readFile(manifestPath)
+    const manifest = JSON.parse(data)
+
+    if (manifest.version !== 1) {
+      throw new Error('Unsupported manifest version')
+    }
+
+    const result = {
+      declarations: manifest.functions,
+    }
+
+    if (manifest.import_map) {
+      const importMapPath = resolve(dirname(manifestPath), manifest.import_map)
+      const importMap = await readImportMap(importMapPath)
+
+      return {
+        ...result,
+        importMap,
+      }
+    }
+
+    return result
+  } catch {
+    // no-op
+  }
+
+  return {
+    declarations: [],
+  }
+}
+
+const readImportMap = async (path) => {
+  try {
+    const data = await fs.readFile(path)
+    const importMap = JSON.parse(data)
+
+    return importMap
+  } catch {
+    // no-op
+  }
+
+  return {
+    imports: {},
+  }
+}
+
+export { parseManifest }

package/src/plugins_core/list.js

@@ -1,26 +1,17 @@
-import { createRequire } from 'module'
 import { fileURLToPath } from 'url'
 
 import { LOCAL_INSTALL_PLUGIN_NAME } from '../install/local.js'
 
-// TODO: use `import.resolve()` once it is available without any experimental
-// flags
-const require = createRequire(import.meta.url)
-
 const FUNCTIONS_INSTALL_PLUGIN = fileURLToPath(new URL('functions_install/index.js', import.meta.url))
 
 // List of core plugin names
 const FUNCTIONS_INSTALL_PLUGIN_NAME = '@netlify/plugin-functions-install-core'
-const EDGE_HANDLERS_PLUGIN_NAME = '@netlify/plugin-edge-handlers'
-const CORE_PLUGINS = new Set([FUNCTIONS_INSTALL_PLUGIN_NAME, LOCAL_INSTALL_PLUGIN_NAME, EDGE_HANDLERS_PLUGIN_NAME])
-
-const EDGE_HANDLERS_PLUGIN_PATH = require.resolve(EDGE_HANDLERS_PLUGIN_NAME)
+const CORE_PLUGINS = new Set([FUNCTIONS_INSTALL_PLUGIN_NAME, LOCAL_INSTALL_PLUGIN_NAME])
 
 // Plugins that are installed and enabled by default
-export const listCorePlugins = function ({ FUNCTIONS_SRC, EDGE_HANDLERS_SRC }) {
+export const listCorePlugins = function ({ FUNCTIONS_SRC }) {
   const functionsInstallPlugin = getFunctionsInstallPlugin(FUNCTIONS_SRC)
-  const edgeHandlersPlugin = getEdgeHandlersPlugin(EDGE_HANDLERS_SRC)
-  return [functionsInstallPlugin, edgeHandlersPlugin].filter(Boolean)
+  return [functionsInstallPlugin].filter(Boolean)
 }
 
 const getFunctionsInstallPlugin = function (FUNCTIONS_SRC) {
@@ -31,18 +22,6 @@ const getFunctionsInstallPlugin = function (FUNCTIONS_SRC) {
   return { package: FUNCTIONS_INSTALL_PLUGIN_NAME, pluginPath: FUNCTIONS_INSTALL_PLUGIN, optional: true }
 }
 
-// To enable Edge handlers, create a `netlify/edge-handlers` directory in the build
-// directory.
-// The location can be overridden using the `build.edge_handlers` property in
-// `netlify.toml`.
-const getEdgeHandlersPlugin = function (EDGE_HANDLERS_SRC) {
-  if (EDGE_HANDLERS_SRC === undefined) {
-    return
-  }
-
-  return { package: EDGE_HANDLERS_PLUGIN_NAME, pluginPath: EDGE_HANDLERS_PLUGIN_PATH }
-}
-
 export const isCorePlugin = function (packageName) {
   return CORE_PLUGINS.has(packageName)
 }

package/src/steps/get.js

@@ -1,6 +1,7 @@
 import { EVENTS } from '../plugins/events.js'
 import { buildCommandCore } from '../plugins_core/build_command.js'
 import { deploySite } from '../plugins_core/deploy/index.js'
+import { bundleEdgeFunctions } from '../plugins_core/edge_functions/index.js'
 import { bundleFunctions } from '../plugins_core/functions/index.js'
 
 // Get all build steps
@@ -12,7 +13,7 @@ export const getSteps = function (steps) {
 }
 
 const addCoreSteps = function (steps) {
-  return [buildCommandCore, ...steps, bundleFunctions, deploySite]
+  return [buildCommandCore, ...steps, bundleFunctions, bundleEdgeFunctions, deploySite]
 }
 
 // Sort plugin steps by event order.

package/src/steps/run_step.js

@@ -159,7 +159,7 @@ export const runStep = async function ({
 //
 // Otherwise, most failures will make the build fail. This includes:
 //   - the build command failed
-//   - Functions or Edge handlers bundling failed
+//   - Functions or Edge Functions bundling failed
 //   - the deploy failed (deploying files to our CDN)
 //   - a plugin `onPreBuild`, `onBuild` or `onPostBuild` event handler failed.
 //     This includes uncaught exceptions and using `utils.build.failBuild()`
@@ -173,8 +173,8 @@ export const runStep = async function ({
 //
 // Finally, some plugins (only core plugins for the moment) might be enabled or
 // not depending on whether a specific action is happening during the build,
-// such as creating a file. For example, the Functions and Edge handlers core
-// plugins are disabled if no Functions or Edge handlers directory is specified
+// such as creating a file. For example, the Functions and Edge Functions core
+// plugins are disabled if no Functions or Edge Functions directory is specified
 // or available. However, one might be created by a build plugin, in which case,
 // those core plugins should be triggered. We use a dynamic `condition()` to
 // model this behavior.