@netlify/build 18.23.0 → 18.23.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@netlify/build",
-  "version": "18.23.0",
+  "version": "18.23.1",
   "description": "Netlify build module",
   "main": "src/core/main.js",
   "types": "types/index.d.ts",
@@ -61,7 +61,7 @@
     "@netlify/plugin-edge-handlers": "^1.11.22",
     "@netlify/plugins-list": "^4.2.0",
     "@netlify/run-utils": "^2.0.0",
-    "@netlify/zip-it-and-ship-it": "^4.29.4",
+    "@netlify/zip-it-and-ship-it": "^4.29.5",
     "@sindresorhus/slugify": "^1.1.0",
     "@ungap/from-entries": "^0.2.1",
     "ansi-escapes": "^4.3.2",

package/src/log/messages/core_steps.js

@@ -2,7 +2,7 @@
 
 const path = require('path')
 
-const { log, logArray, logErrorSubHeader, logWarningSubHeader, logMessage } = require('../logger')
+const { log, logArray, logErrorSubHeader, logWarningSubHeader } = require('../logger')
 const { THEME } = require('../theme')
 
 const logBundleResultFunctions = ({ functions, headerMessage, logs, error }) => {
@@ -17,24 +17,6 @@ const logBundleResultFunctions = ({ functions, headerMessage, logs, error }) =>
   logArray(logs, functionNames)
 }
 
-const MAX_AWS_ZIP_SIZE = 50000000
-
-const logSizeWarnings = ({ results, logs }) => {
-  const oversizedFunctions = results.filter(({ size }) => size > MAX_AWS_ZIP_SIZE)
-  oversizedFunctions.forEach(({ name, bundler }) => {
-    logErrorSubHeader(logs, `Function ${name} exceeds size limit of 50mb`)
-
-    if (bundler === 'zisi') {
-      logMessage(logs, `You're using the default bundler, and could benefit from esbuild: https://ntl.fyi/try-esbuild`)
-    } else {
-      logMessage(
-        logs,
-        `To debug, run \`$ netlify build\` locally and examine the contents of .netlify/functions/${name}.zip`,
-      )
-    }
-  })
-}
-
 const logBundleResults = ({ logs, results = [] }) => {
   const resultsWithErrors = results.filter(({ bundlerErrors }) => bundlerErrors && bundlerErrors.length !== 0)
   const resultsWithWarnings = results.filter(
@@ -65,8 +47,6 @@ const logBundleResults = ({ logs, results = [] }) => {
   if (modulesWithDynamicImports.length !== 0) {
     logModulesWithDynamicImports({ logs, modulesWithDynamicImports })
   }
-
-  logSizeWarnings({ results, logs })
 }
 
 const logFunctionsNonExistingDir = function (logs, relativeFunctionsSrc) {

package/src/log/messages/mutations.js

@@ -9,12 +9,23 @@ const { log, logMessage, logSubHeader } = require('../logger')
 
 const pReadFile = promisify(readFile)
 
-const logConfigMutations = function (logs, newConfigMutations) {
-  newConfigMutations.forEach(({ keysString, value }) => {
+const logConfigMutations = function (logs, newConfigMutations, debug) {
+  const configMutationsToLog = debug ? newConfigMutations : newConfigMutations.filter(shouldLogConfigMutation)
+  configMutationsToLog.forEach(({ keysString, value }) => {
     logConfigMutation(logs, keysString, value)
   })
 }
 
+// Some configuration mutations are only logged in debug mode
+const shouldLogConfigMutation = function ({ keysString }) {
+  return !HIDDEN_PROPS.some((hiddenProp) => keysString.startsWith(hiddenProp))
+}
+
+// `functions` is an object which can have thousands of properties, one per
+// function file. This can be very verbose, especially for plugins which create
+// many function files like Essential Next.js
+const HIDDEN_PROPS = ['functions']
+
 const logConfigMutation = function (logs, keysString, value) {
   const newValue = shouldHideConfigValue(keysString) ? '' : ` to ${inspect(value, { colors: false })}`
   log(logs, `Netlify configuration property "${keysString}" value changed${newValue}.`)

package/src/steps/update_config.js

@@ -29,7 +29,7 @@ const updateNetlifyConfig = async function ({
   }
 
   validateConfigMutations(newConfigMutations)
-  logConfigMutations(logs, newConfigMutations)
+  logConfigMutations(logs, newConfigMutations, debug)
   const configMutationsA = [...configMutations, ...newConfigMutations]
   const {
     config: netlifyConfigA,

package/types/config/inputs.d.ts

@@ -1,3 +1,7 @@
 import { JSONValue } from '../utils/json_value'
 
-export type PluginInputs = Partial<Record<string, JSONValue>>
+// Helper type to be used as a workaround for the fact that `interface`s don't have implicit
+// index signatures: https://github.com/microsoft/TypeScript/issues/15300
+export type StringKeys<TObject extends object> = keyof TObject & string
+
+export type PluginInputs<Keys extends string = string> = Partial<Record<Keys, JSONValue>>

package/types/netlify_event_handler.d.ts

@@ -1,19 +1,29 @@
-import { PluginInputs } from './config/inputs'
+import { PluginInputs, StringKeys } from './config/inputs'
 import { NetlifyPluginOptions } from './netlify_plugin_options'
 
 interface NetlifyEventHandler<PluginOptions extends NetlifyPluginOptions = NetlifyPluginOptions> {
   (options: PluginOptions): void | Promise<void>
 }
 
-export type OnPreBuild<TInputs extends PluginInputs = PluginInputs> = NetlifyEventHandler<NetlifyPluginOptions<TInputs>>
-export type OnBuild<TInputs extends PluginInputs = PluginInputs> = NetlifyEventHandler<NetlifyPluginOptions<TInputs>>
-export type OnPostBuild<TInputs extends PluginInputs = PluginInputs> = NetlifyEventHandler<
+// To allow interfaces to be used as generics, since they lack implicit index signatures, we have to do some type shenanigans
+// to get TypeScript to behave as we want - only letting the keys of `TInputs` through, and thus not requiring a full index
+// signature on `TInputs`.
+// Related issues: https://github.com/microsoft/TypeScript/issues/15300, https://github.com/netlify/build/issues/3838
+export type OnPreBuild<TInputs extends PluginInputs<StringKeys<TInputs>> = PluginInputs> = NetlifyEventHandler<
   NetlifyPluginOptions<TInputs>
 >
-export type OnError<TInputs extends PluginInputs = PluginInputs> = NetlifyEventHandler<
+export type OnBuild<TInputs extends PluginInputs<StringKeys<TInputs>> = PluginInputs> = NetlifyEventHandler<
+  NetlifyPluginOptions<TInputs>
+>
+export type OnPostBuild<TInputs extends PluginInputs<StringKeys<TInputs>> = PluginInputs> = NetlifyEventHandler<
+  NetlifyPluginOptions<TInputs>
+>
+export type OnError<TInputs extends PluginInputs<StringKeys<TInputs>> = PluginInputs> = NetlifyEventHandler<
   NetlifyPluginOptions<TInputs> & { error: Error }
 >
-export type OnSuccess<TInputs extends PluginInputs = PluginInputs> = NetlifyEventHandler<NetlifyPluginOptions<TInputs>>
-export type OnEnd<TInputs extends PluginInputs = PluginInputs> = NetlifyEventHandler<
+export type OnSuccess<TInputs extends PluginInputs<StringKeys<TInputs>> = PluginInputs> = NetlifyEventHandler<
+  NetlifyPluginOptions<TInputs>
+>
+export type OnEnd<TInputs extends PluginInputs<StringKeys<TInputs>> = PluginInputs> = NetlifyEventHandler<
   NetlifyPluginOptions<TInputs> & { error?: Error }
 >

package/types/netlify_plugin_options.d.ts

@@ -1,10 +1,10 @@
-import { PluginInputs } from './config/inputs'
+import { PluginInputs, StringKeys } from './config/inputs'
 import { NetlifyConfig } from './config/netlify_config'
 import { NetlifyPluginConstants } from './netlify_plugin_constants'
 import { NetlifyPluginUtils } from './options/netlify_plugin_utils'
 import { JSONValue } from './utils/json_value'
 
-export interface NetlifyPluginOptions<TInputs extends PluginInputs = PluginInputs> {
+export interface NetlifyPluginOptions<TInputs extends PluginInputs<StringKeys<TInputs>> = PluginInputs> {
   /**
    * If your plugin requires additional values from the user, you can specify these requirements in an `inputs` array in the plugin’s [`manifest.yml` file](https://docs.netlify.com/configure-builds/build-plugins/create-plugins/#anatomy-of-a-plugin).
    */