@netlify/build 28.0.0-beta → 29.0.0-rc

package/src/log/logger.js

@@ -1,3 +1,5 @@
+import { createWriteStream } from 'fs'
+
 import figures from 'figures'
 import indentString from 'indent-string'
 
@@ -105,3 +107,55 @@ export const logErrorSubHeader = function (logs, string, opts) {
 export const logWarningSubHeader = function (logs, string, opts) {
   logSubHeader(logs, string, { color: THEME.warningSubHeader, ...opts })
 }
+
+// Combines an array of elements into a single string, separated by a space,
+// and with basic serialization of non-string types
+const reduceLogLines = function (lines) {
+  return lines
+    .map((input) => {
+      if (input instanceof Error) {
+        return `${input.message} ${input.stack}`
+      }
+
+      if (typeof input === 'object') {
+        try {
+          return JSON.stringify(input)
+        } catch {
+          // Value could not be serialized to JSON, so we return the string
+          // representation.
+          return String(input)
+        }
+      }
+
+      return String(input)
+    })
+    .join(' ')
+}
+
+// Builds a function for logging data to the system logger (i.e. hidden from
+// the user-facing build logs)
+export const getSystemLogger = function (logs, debug, systemLogFile) {
+  // If the `debug` flag is used, we return a function that pipes system logs
+  // to the regular logger, as the intention is for them to end up in stdout.
+  if (debug) {
+    return (...args) => log(logs, reduceLogLines(args))
+  }
+
+  // If there's not a file descriptor configured for system logs and `debug`
+  // is not set, we return a no-op function that will swallow the errors.
+  if (!systemLogFile) {
+    return () => {
+      // no-op
+    }
+  }
+
+  // Return a function that writes to the file descriptor configured for system
+  // logs.
+  const fileDescriptor = createWriteStream(null, { fd: systemLogFile })
+
+  fileDescriptor.on('error', () => {
+    logError(logs, 'Could not write to system log file')
+  })
+
+  return (...args) => fileDescriptor.write(`${reduceLogLines(args)}\n`)
+}

package/src/log/messages/config.js

@@ -52,6 +52,8 @@ const INTERNAL_FLAGS = [
   'mode',
   'apiHost',
   'cacheDir',
+  'systemLogFile',
+  'timeline',
 ]
 const HIDDEN_FLAGS = [...SECURE_FLAGS, ...TEST_FLAGS, ...INTERNAL_FLAGS]
 const HIDDEN_DEBUG_FLAGS = [...SECURE_FLAGS, ...TEST_FLAGS]

package/src/plugins/child/status.js

@@ -6,18 +6,19 @@ import { addErrorInfo } from '../../error/info.js'
 // Report status information to the UI
 export const show = function (runState, showArgs) {
   validateShowArgs(showArgs)
-  const { title, summary, text } = removeEmptyStrings(showArgs)
-  runState.status = { state: 'success', title, summary, text }
+  const { title, summary, text, extraData } = removeEmptyStrings(showArgs)
+  runState.status = { state: 'success', title, summary, text, extraData }
 }
 
 // Validate arguments of `utils.status.show()`
 const validateShowArgs = function (showArgs) {
   try {
     validateShowArgsObject(showArgs)
-    const { title, summary, text, ...otherArgs } = showArgs
+    const { title, summary, text, extraData, ...otherArgs } = showArgs
     validateShowArgsKeys(otherArgs)
     Object.entries({ title, summary, text }).forEach(validateStringArg)
     validateShowArgsSummary(summary)
+    validateShowArgsExtraData(extraData)
   } catch (error) {
     error.message = `utils.status.show() ${error.message}`
     addErrorInfo(error, { type: 'pluginValidation' })
@@ -54,6 +55,12 @@ const validateShowArgsSummary = function (summary) {
   }
 }
 
+const validateShowArgsExtraData = function (extraData) {
+  if (extraData !== undefined && Array.isArray(extraData) === false) {
+    throw new TypeError('provided extra data must be an array')
+  }
+}
+
 const removeEmptyStrings = function (showArgs) {
   return mapObj(showArgs, removeEmptyString)
 }

package/src/plugins/child/validate.js

@@ -1,6 +1,6 @@
 import { addErrorInfo } from '../../error/info.js'
 import { serializeArray } from '../../log/serialize.js'
-import { EVENTS } from '../events.js'
+import { DEV_EVENTS, EVENTS } from '../events.js'
 
 // Validate the shape of a plugin return value
 export const validatePlugin = function (logic) {
@@ -22,7 +22,7 @@ export const validatePlugin = function (logic) {
 
 // All other properties are event handlers
 const validateEventHandler = function (value, propName) {
-  if (!EVENTS.includes(propName)) {
+  if (!EVENTS.includes(propName) && !DEV_EVENTS.includes(propName)) {
     throw new Error(`Invalid event '${propName}'.
 Please use a valid event name. One of:
 ${serializeArray(EVENTS)}`)

package/src/plugins/events.js

@@ -1,4 +1,4 @@
-export { EVENTS } from '@netlify/config'
+export { DEV_EVENTS, EVENTS } from '@netlify/config'
 
 const isAmongEvents = function (events, event) {
   return events.includes(event)

package/src/plugins_core/edge_functions/index.js

@@ -6,12 +6,15 @@ import { pathExists } from 'path-exists'
 
 import { logFunctionsToBundle } from '../../log/messages/core_steps.js'
 
+import { tagBundlingError } from './lib/error.js'
 import { parseManifest } from './lib/internal_manifest.js'
+import { validateEdgeFunctionsManifest } from './validate_manifest/validate_edge_functions_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'
 
+// eslint-disable-next-line complexity, max-statements
 const coreStep = async function ({
   buildDir,
   constants: {
@@ -21,6 +24,7 @@ const coreStep = async function ({
     IS_LOCAL: isRunningLocally,
   },
   debug,
+  systemLog,
   featureFlags,
   logs,
   netlifyConfig,
@@ -45,13 +49,25 @@ const coreStep = async function ({
   // Edge Bundler expects the dist directory to exist.
   await fs.mkdir(distPath, { recursive: true })
 
-  await bundle(sourcePaths, distPath, declarations, {
-    cacheDirectory,
-    debug,
-    distImportMapPath,
-    featureFlags,
-    importMaps: [importMap].filter(Boolean),
-  })
+  try {
+    const { manifest } = await bundle(sourcePaths, distPath, declarations, {
+      basePath: buildDir,
+      cacheDirectory,
+      debug,
+      distImportMapPath,
+      featureFlags,
+      importMaps: [importMap].filter(Boolean),
+      systemLogger: featureFlags.edge_functions_system_logger ? systemLog : undefined,
+    })
+
+    systemLog('Edge Functions manifest:', manifest)
+  } catch (error) {
+    tagBundlingError(error)
+
+    throw error
+  }
+
+  await validateEdgeFunctionsManifest({ buildDir, constants: { EDGE_FUNCTIONS_DIST: distDirectory } })
 
   return {}
 }

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

@@ -0,0 +1,21 @@
+import { CUSTOM_ERROR_KEY, getErrorInfo, isBuildError } from '../../../error/info.js'
+
+// If we have a custom error tagged with `functionsBundling` (which happens if
+// there is an issue with user code), we tag it as coming from an edge function
+// so that we can adjust the downstream error messages accordingly.
+export const tagBundlingError = (error) => {
+  if (!isBuildError(error)) {
+    return
+  }
+
+  const [errorInfo = {}] = getErrorInfo(error)
+
+  if (errorInfo.type !== 'functionsBundling') {
+    return
+  }
+
+  error[CUSTOM_ERROR_KEY].location = {
+    ...error[CUSTOM_ERROR_KEY].location,
+    functionType: 'edge',
+  }
+}

package/src/plugins_core/edge_functions/validate_manifest/validate_edge_functions_manifest.js

@@ -0,0 +1,89 @@
+import { promises as fs } from 'fs'
+import { join, resolve } from 'path'
+
+import Ajv from 'ajv'
+import ajvErrors from 'ajv-errors'
+
+import { addErrorInfo } from '../../../error/info.js'
+
+const ajv = new Ajv({ allErrors: true })
+ajvErrors(ajv)
+
+// regex pattern for manifest route pattern
+// checks if the pattern string starts with ^ and ends with $
+// we define this format in edge-bundler:
+// https://github.com/netlify/edge-bundler/blob/main/src/manifest.ts#L66
+const normalizedPatternRegex = /^\^.*\$$/
+ajv.addFormat('regexPattern', {
+  async: true,
+  validate: (data) => normalizedPatternRegex.test(data),
+})
+
+const bundlesSchema = {
+  $async: true,
+  type: 'object',
+  required: ['asset', 'format'],
+  properties: {
+    asset: { type: 'string' },
+    format: { type: 'string' },
+  },
+  additionalProperties: false,
+}
+
+const routesSchema = {
+  $async: true,
+  type: 'object',
+  required: ['function', 'pattern'],
+  properties: {
+    function: { type: 'string' },
+    pattern: { type: 'string', format: 'regexPattern', errorMessage: `must match format ${normalizedPatternRegex}` },
+  },
+  additionalProperties: false,
+}
+
+const edgeManifestSchema = {
+  $async: true,
+  type: 'object',
+  required: ['bundles', 'routes', 'bundler_version'],
+  properties: {
+    bundles: {
+      type: 'array',
+      items: bundlesSchema,
+    },
+    routes: {
+      type: 'array',
+      items: routesSchema,
+    },
+    bundler_version: { type: 'string' },
+  },
+  additionalProperties: false,
+  errorMessage: "Couldn't validate Edge Functions manifest.json",
+}
+
+const validateManifest = async (manifestData) => {
+  const validate = ajv.compile(edgeManifestSchema)
+
+  await validate(manifestData)
+}
+
+export const validateEdgeFunctionsManifest = async function ({
+  buildDir,
+  constants: { EDGE_FUNCTIONS_DIST: distDirectory },
+}) {
+  try {
+    const edgeFunctionsDistPath = resolve(buildDir, distDirectory)
+    const manifestPath = join(edgeFunctionsDistPath, 'manifest.json')
+    const data = await fs.readFile(manifestPath)
+    const manifestData = JSON.parse(data)
+
+    await validateManifest(manifestData)
+  } catch (error) {
+    const isValidationErr = error instanceof Ajv.ValidationError
+    const parsedErr = isValidationErr ? error.errors : error
+
+    addErrorInfo(parsedErr, { type: 'coreStep' })
+    throw new Error(isValidationErr ? JSON.stringify(parsedErr, null, 2) : parsedErr)
+  }
+
+  return {}
+}

package/src/status/report.js

@@ -104,7 +104,7 @@ const sendApiStatuses = async function ({
 
 const sendApiStatus = async function ({
   api,
-  status: { packageName, version, state, event, title, summary, text },
+  status: { packageName, version, state, event, title, summary, text, extraData },
   childEnv,
   mode,
   netlifyConfig,
@@ -117,7 +117,16 @@ const sendApiStatus = async function ({
   try {
     await api.createPluginRun({
       deploy_id: deployId,
-      body: { package: packageName, version, state, reporting_event: event, title, summary, text },
+      body: {
+        package: packageName,
+        version,
+        state,
+        reporting_event: event,
+        title,
+        summary,
+        text,
+        extra_data: extraData,
+      },
     })
     // Bitballoon API randomly fails with 502.
     // Builds should be successful when this API call fails, but we still want

package/src/steps/core_step.js

@@ -27,6 +27,7 @@ export const fireCoreStep = async function ({
   redirectsPath,
   featureFlags,
   debug,
+  systemLog,
   saveConfig,
 }) {
   try {
@@ -54,6 +55,7 @@ export const fireCoreStep = async function ({
       redirectsPath,
       featureFlags,
       debug,
+      systemLog,
       saveConfig,
     })
     const {

package/src/steps/get.js

@@ -1,4 +1,4 @@
-import { EVENTS } from '../plugins/events.js'
+import { DEV_EVENTS, 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'
@@ -7,18 +7,37 @@ import { bundleFunctions } from '../plugins_core/functions/index.js'
 // Get all build steps
 export const getSteps = function (steps) {
   const stepsA = addCoreSteps(steps)
-  const stepsB = sortSteps(stepsA)
+  const stepsB = sortSteps(stepsA, EVENTS)
   const events = getEvents(stepsB)
   return { steps: stepsB, events }
 }
 
+// Get all dev steps
+export const getDevSteps = function (command, steps) {
+  const devCommandStep = {
+    event: 'onDev',
+    coreStep: async () => {
+      await command()
+
+      return {}
+    },
+    coreStepId: 'dev_command',
+    coreStepName: 'dev.command',
+    coreStepDescription: () => 'Run command for local development',
+  }
+  const sortedSteps = sortSteps([...steps, devCommandStep], DEV_EVENTS)
+  const events = getEvents(sortedSteps)
+
+  return { steps: sortedSteps, events }
+}
+
 const addCoreSteps = function (steps) {
   return [buildCommandCore, ...steps, bundleFunctions, bundleEdgeFunctions, deploySite]
 }
 
 // Sort plugin steps by event order.
-const sortSteps = function (steps) {
-  return EVENTS.flatMap((event) => steps.filter((step) => step.event === event))
+const sortSteps = function (steps, events) {
+  return events.flatMap((event) => steps.filter((step) => step.event === event))
 }
 
 // Retrieve list of unique events

package/src/steps/run_core_steps.js

@@ -5,7 +5,7 @@ import { getSeverity } from '../core/severity.js'
 import { handleBuildError } from '../error/handle.js'
 import { getErrorInfo } from '../error/info.js'
 import { startErrorMonitor } from '../error/monitor/start.js'
-import { getBufferLogs } from '../log/logger.js'
+import { getBufferLogs, getSystemLogger } from '../log/logger.js'
 import { logBuildStart } from '../log/messages/core.js'
 import { reportStatuses } from '../status/report.js'
 
@@ -39,6 +39,7 @@ import { runSteps } from './run_steps.js'
 export const runCoreSteps = async (buildSteps, flags = {}) => {
   const { errorMonitor, mode, logs, debug, ...flagsA } = startBuild(flags)
   const errorParams = { errorMonitor, mode, logs, debug }
+  const systemLog = getSystemLogger(logs, debug)
 
   try {
     const { netlifyConfig: netlifyConfigA, configMutations } = await executeBuildStep({
@@ -49,6 +50,7 @@ export const runCoreSteps = async (buildSteps, flags = {}) => {
       debug,
       errorParams,
       buildSteps,
+      systemLog,
     })
     const { success, severityCode } = getSeverity('success')
 
@@ -93,6 +95,7 @@ const executeBuildStep = async function ({
   featureFlags,
   buildSteps,
   repositoryRoot,
+  systemLog,
 }) {
   const configOpts = getConfigOpts({
     config,
@@ -140,6 +143,7 @@ const executeBuildStep = async function ({
       childEnv,
       buildSteps,
       repositoryRoot: repositoryRootA,
+      systemLog,
     })
 
     return {
@@ -175,6 +179,7 @@ const runBuildStep = async function ({
   childEnv,
   buildSteps,
   repositoryRoot,
+  systemLog,
 }) {
   const { netlifyConfig: netlifyConfigA, configMutations } = await runSteps({
     steps: getBuildSteps(buildSteps),
@@ -188,6 +193,7 @@ const runBuildStep = async function ({
     featureFlags,
     childEnv,
     repositoryRoot,
+    systemLog,
   })
 
   return { netlifyConfig: netlifyConfigA, configMutations }

package/src/steps/run_step.js

@@ -1,4 +1,3 @@
-/* eslint-disable max-lines */
 import { addMutableConstants } from '../core/constants.js'
 import { logStepStart } from '../log/messages/steps.js'
 import { runsAlsoOnBuildFailure, runsOnlyOnBuildFailure } from '../plugins/events.js'
@@ -48,6 +47,7 @@ export const runStep = async function ({
   redirectsPath,
   logs,
   debug,
+  systemLog,
   verbose,
   saveConfig,
   timers,
@@ -109,6 +109,7 @@ export const runStep = async function ({
     error,
     logs,
     debug,
+    systemLog,
     verbose,
     saveConfig,
     timers,
@@ -140,6 +141,7 @@ export const runStep = async function ({
     redirectsPath: redirectsPathA,
     logs,
     debug,
+    systemLog,
     timers: timersA,
     durationNs,
     testOpts,
@@ -237,6 +239,7 @@ const tFireStep = function ({
   error,
   logs,
   debug,
+  systemLog,
   verbose,
   saveConfig,
   errorParams,
@@ -271,6 +274,7 @@ const tFireStep = function ({
       redirectsPath,
       featureFlags,
       debug,
+      systemLog,
       saveConfig,
     })
   }
@@ -294,7 +298,7 @@ const tFireStep = function ({
     error,
     logs,
     debug,
+    systemLog,
     verbose,
   })
 }
-/* eslint-enable max-lines */

package/src/steps/run_steps.js

@@ -1,4 +1,3 @@
-/* eslint-disable max-lines */
 import pReduce from 'p-reduce'
 
 import { addErrorInfo } from '../error/info.js'
@@ -34,6 +33,7 @@ export const runSteps = async function ({
   configOpts,
   logs,
   debug,
+  systemLog,
   verbose,
   saveConfig,
   timers,
@@ -127,6 +127,7 @@ export const runSteps = async function ({
         redirectsPath: redirectsPathA,
         logs,
         debug,
+        systemLog,
         verbose,
         saveConfig,
         timers: timersA,
@@ -176,4 +177,3 @@ export const runSteps = async function ({
     configMutations: configMutationsB,
   }
 }
-/* eslint-enable max-lines */