@netlify/build 29.33.6 → 29.34.0

package/lib/core/dry.js

@@ -8,6 +8,9 @@ export const doDryRun = async function ({ buildDir, steps, netlifyConfig, consta
     const stepsCount = successSteps.length;
     logDryRunStart({ logs, eventWidth, stepsCount });
     successSteps.forEach((step, index) => {
+        if (step.quiet) {
+            return;
+        }
         logDryRunStep({ logs, step, index, netlifyConfig, eventWidth, stepsCount });
     });
     logDryRunEnd(logs);

package/lib/plugins_core/deploy_config/index.d.ts

@@ -0,0 +1,2 @@
+import { CoreStep } from '../types.js';
+export declare const applyDeployConfig: CoreStep;

package/lib/plugins_core/deploy_config/index.js

@@ -0,0 +1,70 @@
+import { promises as fs } from 'fs';
+import { resolve } from 'path';
+import { mergeConfigs } from '@netlify/config';
+import { filterConfig } from './util.js';
+// The properties that can be set using this API. Each element represents a
+// path using dot-notation — e.g. `["build", "functions"]` represents the
+// `build.functions` property.
+const ALLOWED_PROPERTIES = [
+    ['build', 'edge_functions'],
+    ['build', 'functions'],
+    ['build', 'publish'],
+    ['functions', '*'],
+    ['functions', '*', '*'],
+    ['headers'],
+    ['images', 'remote_images'],
+    ['redirects'],
+];
+// For array properties, any values set in this API will be merged with the
+// main configuration file in such a way that user-defined values always take
+// precedence. The exception are these properties that let frameworks set
+// values that should be evaluated before any user-defined values. They use
+// a special notation where `headers!` represents "forced headers", etc.
+const OVERRIDE_PROPERTIES = new Set(['headers!', 'redirects!']);
+const coreStep = async function ({ buildDir, netlifyConfig, systemLog = () => {
+    // no-op
+}, }) {
+    const configPath = resolve(buildDir, '.netlify/deploy/v1/config.json');
+    let config = {};
+    try {
+        const data = await fs.readFile(configPath, 'utf8');
+        config = JSON.parse(data);
+    }
+    catch (err) {
+        // If the file doesn't exist, this is a non-error.
+        if (err.code === 'ENOENT') {
+            return {};
+        }
+        systemLog(`Failed to read Deploy Configuration API: ${err.message}`);
+        throw new Error('An error occured while processing the platform configurarion defined by your framework');
+    }
+    const configOverrides = {};
+    for (const key in config) {
+        // If the key uses the special notation for defining mutations that should
+        // take precedence over user-defined properties, extract the canonical
+        // property, set it on a different object, and delete it from the main one.
+        if (OVERRIDE_PROPERTIES.has(key)) {
+            const canonicalKey = key.slice(0, -1);
+            configOverrides[canonicalKey] = config[key];
+            delete config[key];
+        }
+    }
+    // Filtering out any properties that can't be mutated using this API.
+    config = filterConfig(config, [], ALLOWED_PROPERTIES, systemLog);
+    // Merging the different configuration sources. The order here is important.
+    // Leftmost elements of the array take precedence.
+    const newConfig = mergeConfigs([config, netlifyConfig, configOverrides], { concatenateArrays: true });
+    for (const key in newConfig) {
+        netlifyConfig[key] = newConfig[key];
+    }
+    return {};
+};
+export const applyDeployConfig = {
+    event: 'onBuild',
+    coreStep,
+    coreStepId: 'deploy_config',
+    coreStepName: 'Applying Deploy Configuration',
+    coreStepDescription: () => '',
+    condition: ({ featureFlags }) => featureFlags?.netlify_build_deploy_configuration_api,
+    quiet: true,
+};

package/lib/plugins_core/deploy_config/util.d.ts

@@ -0,0 +1,12 @@
+import { SystemLogger } from '../types.js';
+/**
+ * Checks whether a property can be defined using the Deploy Configuration API.
+ */
+export declare const isAllowedProperty: (property: string[], allowedProperties: string[][]) => boolean;
+/**
+ * Takes a candidate configuration object and returns a normalized version that
+ * includes only the properties that are present in an allow-list. It does so
+ * recursively, so `allowedProperties` can contain the full list of properties
+ * that the Deploy Configuration API can interact with.
+ */
+export declare const filterConfig: (obj: Record<string, unknown>, path: string[], allowedProperties: string[][], systemLog: SystemLogger) => Record<string, unknown>;

package/lib/plugins_core/deploy_config/util.js

@@ -0,0 +1,32 @@
+import isPlainObject from 'is-plain-obj';
+import mapObject, { mapObjectSkip } from 'map-obj';
+/**
+ * Checks whether a property matches a template that may contain wildcards.
+ * Both the property and the template use a dot-notation represented as an
+ * array of strings.
+ * For example, the property `["build", "command"]` matches the templates
+ * `["build", "command"]` and `["build", "*"]`, but not `["functions"]`.
+ */
+const propertyMatchesTemplate = (property, template) => property.every((node, index) => template[index] === node || template[index] === '*');
+/**
+ * Checks whether a property can be defined using the Deploy Configuration API.
+ */
+export const isAllowedProperty = (property, allowedProperties) => allowedProperties.some((template) => propertyMatchesTemplate(property, template));
+/**
+ * Takes a candidate configuration object and returns a normalized version that
+ * includes only the properties that are present in an allow-list. It does so
+ * recursively, so `allowedProperties` can contain the full list of properties
+ * that the Deploy Configuration API can interact with.
+ */
+export const filterConfig = (obj, path, allowedProperties, systemLog) => mapObject(obj, (key, value) => {
+    const keyPath = [...path, key];
+    if (!isAllowedProperty(keyPath, allowedProperties)) {
+        systemLog(`Discarding property that is not supported by the Deploy Configuration API: ${keyPath.join('.')}`);
+        return mapObjectSkip;
+    }
+    if (!isPlainObject(value)) {
+        systemLog(`Loading property from Deploy Configuration API: ${keyPath.join('.')}`);
+        return [key, value];
+    }
+    return [key, filterConfig(value, keyPath, allowedProperties, systemLog)];
+});

package/lib/plugins_core/types.d.ts

@@ -28,13 +28,15 @@ export type CoreStepFunctionArgs = {
 };
 export type CoreStepFunction = (args: CoreStepFunctionArgs) => Promise<object>;
 export type CoreStepCondition = (args: CoreStepFunctionArgs) => Promise<boolean> | boolean;
-type Event = 'onPreBuild' | 'onBuild' | 'onPostBuild' | 'onPreDev' | 'onDev' | 'onPostDev';
+export type Event = 'onPreBuild' | 'onBuild' | 'onPostBuild' | 'onPreDev' | 'onDev' | 'onPostDev';
 export type CoreStep = {
     event: Event;
     coreStep: CoreStepFunction;
     coreStepId: string;
     coreStepName: string;
     coreStepDescription: () => string;
-    condition: CoreStepCondition;
+    condition?: CoreStepCondition;
+    quiet?: boolean;
 };
+export type SystemLogger = (...args: any[]) => void;
 export {};

package/lib/steps/get.d.ts

@@ -1,8 +1,9 @@
+import { CoreStep } from '../plugins_core/types.js';
 export declare const getSteps: (steps: any, eventHandlers?: any[]) => {
-    steps: any;
+    steps: CoreStep[];
     events: unknown[];
 };
 export declare const getDevSteps: (command: any, steps: any, eventHandlers?: any[]) => {
-    steps: any;
+    steps: CoreStep[];
     events: unknown[];
 };

package/lib/steps/get.js

@@ -3,6 +3,7 @@ import { DEV_EVENTS, EVENTS } from '../plugins/events.js';
 import { uploadBlobs } from '../plugins_core/blobs_upload/index.js';
 import { buildCommandCore } from '../plugins_core/build_command.js';
 import { deploySite } from '../plugins_core/deploy/index.js';
+import { applyDeployConfig } from '../plugins_core/deploy_config/index.js';
 import { bundleEdgeFunctions } from '../plugins_core/edge_functions/index.js';
 import { bundleFunctions } from '../plugins_core/functions/index.js';
 import { preCleanup } from '../plugins_core/pre_cleanup/index.js';
@@ -44,7 +45,7 @@ const getEventSteps = function (eventHandlers) {
             handler = eventHandler.handler;
         }
         return {
-            event,
+            event: event,
             coreStep: (args) => {
                 const { constants, event } = args;
                 const utils = getUtils({ event, constants, runState: {} });
@@ -60,6 +61,7 @@ const addCoreSteps = function (steps) {
     return [
         preCleanup,
         buildCommandCore,
+        applyDeployConfig,
         ...steps,
         bundleFunctions,
         bundleEdgeFunctions,

package/lib/steps/run_step.d.ts

@@ -1,4 +1,4 @@
-export declare const runStep: ({ event, childProcess, packageName, coreStep, coreStepId, coreStepName, coreStepDescription, pluginPackageJson, loadedFrom, origin, condition, configPath, outputConfigPath, buildDir, packagePath, repositoryRoot, nodePath, index, childEnv, context, branch, envChanges, constants, steps, buildbotServerSocket, events, mode, api, errorMonitor, deployId, errorParams, error, failedPlugins, configOpts, netlifyConfig, configMutations, headersPath, redirectsPath, logs, debug, systemLog, verbose, saveConfig, timers, testOpts, featureFlags, quiet, userNodeVersion, explicitSecretKeys, edgeFunctionsBootstrapURL, }: {
+export declare const runStep: ({ event, childProcess, packageName, coreStep, coreStepId, coreStepName, coreStepDescription, coreStepQuiet, pluginPackageJson, loadedFrom, origin, condition, configPath, outputConfigPath, buildDir, packagePath, repositoryRoot, nodePath, index, childEnv, context, branch, envChanges, constants, steps, buildbotServerSocket, events, mode, api, errorMonitor, deployId, errorParams, error, failedPlugins, configOpts, netlifyConfig, configMutations, headersPath, redirectsPath, logs, debug, systemLog, verbose, saveConfig, timers, testOpts, featureFlags, quiet, userNodeVersion, explicitSecretKeys, edgeFunctionsBootstrapURL, }: {
     event: any;
     childProcess: any;
     packageName: any;
@@ -6,6 +6,7 @@ export declare const runStep: ({ event, childProcess, packageName, coreStep, cor
     coreStepId: any;
     coreStepName: any;
     coreStepDescription: any;
+    coreStepQuiet: any;
     pluginPackageJson: any;
     loadedFrom: any;
     origin: any;

package/lib/steps/run_step.js

@@ -10,7 +10,7 @@ import { firePluginStep } from './plugin.js';
 import { getStepReturn } from './return.js';
 const tracer = trace.getTracer('steps');
 // Run a step (core, build command or plugin)
-export const runStep = async function ({ event, childProcess, packageName, coreStep, coreStepId, coreStepName, coreStepDescription, pluginPackageJson, loadedFrom, origin, condition, configPath, outputConfigPath, buildDir, packagePath, repositoryRoot, nodePath, index, childEnv, context, branch, envChanges, constants, steps, buildbotServerSocket, events, mode, api, errorMonitor, deployId, errorParams, error, failedPlugins, configOpts, netlifyConfig, configMutations, headersPath, redirectsPath, logs, debug, systemLog, verbose, saveConfig, timers, testOpts, featureFlags, quiet, userNodeVersion, explicitSecretKeys, edgeFunctionsBootstrapURL, }) {
+export const runStep = async function ({ event, childProcess, packageName, coreStep, coreStepId, coreStepName, coreStepDescription, coreStepQuiet, pluginPackageJson, loadedFrom, origin, condition, configPath, outputConfigPath, buildDir, packagePath, repositoryRoot, nodePath, index, childEnv, context, branch, envChanges, constants, steps, buildbotServerSocket, events, mode, api, errorMonitor, deployId, errorParams, error, failedPlugins, configOpts, netlifyConfig, configMutations, headersPath, redirectsPath, logs, debug, systemLog, verbose, saveConfig, timers, testOpts, featureFlags, quiet, userNodeVersion, explicitSecretKeys, edgeFunctionsBootstrapURL, }) {
     // Add relevant attributes to the upcoming span context
     const attributes = {
         'build.execution.step.name': coreStepName,
@@ -41,13 +41,14 @@ export const runStep = async function ({ event, childProcess, packageName, coreS
             saveConfig,
             explicitSecretKeys,
             deployId,
+            featureFlags,
         });
         span.setAttribute('build.execution.step.should_run', shouldRun);
         if (!shouldRun) {
             span.end();
             return {};
         }
-        if (!quiet) {
+        if (!quiet && !coreStepQuiet) {
             logStepStart({ logs, event, packageName, coreStepDescription, error, netlifyConfig });
         }
         const fireStep = getFireStep(packageName, coreStepId, event);
@@ -118,7 +119,7 @@ export const runStep = async function ({ event, childProcess, packageName, coreS
             durationNs,
             testOpts,
             systemLog,
-            quiet,
+            quiet: quiet || coreStepQuiet,
             metrics,
         });
         span.end();
@@ -156,7 +157,7 @@ export const runStep = async function ({ event, childProcess, packageName, coreS
 // 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.
-const shouldRunStep = async function ({ event, packageName, error, packagePath, failedPlugins, netlifyConfig, condition, constants, buildbotServerSocket, buildDir, saveConfig, explicitSecretKeys, deployId, }) {
+const shouldRunStep = async function ({ event, packageName, error, packagePath, failedPlugins, netlifyConfig, condition, constants, buildbotServerSocket, buildDir, saveConfig, explicitSecretKeys, deployId, featureFlags = {}, }) {
     if (failedPlugins.includes(packageName) ||
         (condition !== undefined &&
             !(await condition({
@@ -168,6 +169,7 @@ const shouldRunStep = async function ({ event, packageName, error, packagePath,
                 saveConfig,
                 explicitSecretKeys,
                 deployId,
+                featureFlags,
             })))) {
         return false;
     }

package/lib/steps/run_steps.js

@@ -8,7 +8,7 @@ import { runStep } from './run_step.js';
 // If an error arises, runs `onError` events.
 // Runs `onEnd` events at the end, whether an error was thrown or not.
 export const runSteps = async function ({ steps, buildbotServerSocket, events, configPath, outputConfigPath, headersPath, redirectsPath, buildDir, packagePath, repositoryRoot, nodePath, childEnv, context, branch, constants, mode, api, errorMonitor, deployId, errorParams, netlifyConfig, configOpts, logs, debug, systemLog, verbose, saveConfig, timers, testOpts, featureFlags, quiet, userNodeVersion, explicitSecretKeys, edgeFunctionsBootstrapURL, }) {
-    const { index: stepsCount, error: errorA, netlifyConfig: netlifyConfigC, statuses: statusesB, failedPlugins: failedPluginsA, timers: timersC, configMutations: configMutationsB, metrics: metricsC, } = await pReduce(steps, async ({ index, error, failedPlugins, envChanges, netlifyConfig: netlifyConfigA, configMutations, headersPath: headersPathA, redirectsPath: redirectsPathA, statuses, timers: timersA, metrics: metricsA, }, { event, childProcess, packageName, coreStep, coreStepId, coreStepName, coreStepDescription, pluginPackageJson, loadedFrom, origin, condition, }) => {
+    const { index: stepsCount, error: errorA, netlifyConfig: netlifyConfigC, statuses: statusesB, failedPlugins: failedPluginsA, timers: timersC, configMutations: configMutationsB, metrics: metricsC, } = await pReduce(steps, async ({ index, error, failedPlugins, envChanges, netlifyConfig: netlifyConfigA, configMutations, headersPath: headersPathA, redirectsPath: redirectsPathA, statuses, timers: timersA, metrics: metricsA, }, { event, childProcess, packageName, coreStep, coreStepId, coreStepName, coreStepDescription, pluginPackageJson, loadedFrom, origin, condition, quiet: coreStepQuiet, }) => {
         const { newIndex = index, newError = error, failedPlugin = [], newEnvChanges = {}, netlifyConfig: netlifyConfigB = netlifyConfigA, configMutations: configMutationsA = configMutations, headersPath: headersPathB = headersPathA, redirectsPath: redirectsPathB = redirectsPathA, newStatus, timers: timersB = timersA, metrics: metricsB = [], } = await runStep({
             event,
             childProcess,
@@ -17,6 +17,7 @@ export const runSteps = async function ({ steps, buildbotServerSocket, events, c
             coreStepId,
             coreStepName,
             coreStepDescription,
+            coreStepQuiet,
             pluginPackageJson,
             loadedFrom,
             origin,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@netlify/build",
-  "version": "29.33.6",
+  "version": "29.34.0",
   "description": "Netlify build module",
   "type": "module",
   "exports": "./lib/index.js",
@@ -70,7 +70,7 @@
     "@bugsnag/js": "^7.0.0",
     "@netlify/blobs": "^6.5.0",
     "@netlify/cache-utils": "^5.1.5",
-    "@netlify/config": "^20.11.0",
+    "@netlify/config": "^20.12.0",
     "@netlify/edge-bundler": "11.2.2",
     "@netlify/framework-info": "^9.8.10",
     "@netlify/functions-utils": "^5.2.50",
@@ -130,7 +130,7 @@
     "@netlify/nock-udp": "^3.1.2",
     "@opentelemetry/sdk-trace-base": "^1.18.1",
     "@types/node": "^14.18.53",
-    "@vitest/coverage-c8": "^0.30.1",
+    "@vitest/coverage-c8": "^0.33.0",
     "atob": "^2.1.2",
     "ava": "^4.0.0",
     "c8": "^7.12.0",
@@ -148,8 +148,8 @@
     "process-exists": "^5.0.0",
     "sinon": "^13.0.0",
     "tmp-promise": "^3.0.2",
-    "tsd": "^0.29.0",
-    "vitest": "^0.30.1",
+    "tsd": "^0.30.0",
+    "vitest": "^0.34.0",
     "yarn": "^1.22.4"
   },
   "peerDependencies": {
@@ -163,5 +163,5 @@
   "engines": {
     "node": "^14.16.0 || >=16.0.0"
   },
-  "gitHead": "596d7c147206802efeddc523e26cf0dfe399cf84"
+  "gitHead": "24f130e0d2e27091cd5998cb23f19718e3785824"
 }