@netlify/build 18.8.0 → 18.9.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@netlify/build",
-  "version": "18.8.0",
+  "version": "18.9.0",
   "description": "Netlify build module",
   "main": "src/core/main.js",
   "bin": {

package/src/core/feature_flags.js

@@ -18,7 +18,7 @@ const getFeatureFlag = function (name) {
 // Default values for feature flags
 const DEFAULT_FEATURE_FLAGS = {
   zisiEsbuildDynamicImports: env.NETLIFY_EXPERIMENTAL_PROCESS_DYNAMIC_IMPORTS === 'true',
-  buildbot_build_plugins_system_node_version: false,
+  netlify_build_warning_missing_headers: false,
 }
 
 module.exports = { normalizeCliFeatureFlags, DEFAULT_FEATURE_FLAGS }

package/src/core/main.js

@@ -24,6 +24,7 @@ const { getConfigOpts, loadConfig } = require('./config')
 const { getConstants } = require('./constants')
 const { doDryRun } = require('./dry')
 const { warnOnLingeringProcesses } = require('./lingering')
+const { warnOnMissingSideFiles } = require('./missing_side_file')
 const { normalizeFlags } = require('./normalize_flags')
 const { getSeverity } = require('./severity')
 
@@ -528,7 +529,10 @@ const initAndRunBuild = async function ({
       featureFlags,
     })
 
-    await warnOnLingeringProcesses({ mode, logs, testOpts })
+    await Promise.all([
+      warnOnMissingSideFiles({ buildDir, netlifyConfig: netlifyConfigA, logs, featureFlags }),
+      warnOnLingeringProcesses({ mode, logs, testOpts }),
+    ])
 
     return {
       commandsCount,

package/src/core/missing_side_file.js

@@ -0,0 +1,38 @@
+'use strict'
+
+const { relative } = require('path')
+
+const pathExists = require('path-exists')
+
+const { logMissingSideFile } = require('../log/messages/core')
+
+// Some files like `_headers` and `_redirects` must be copied to the publish
+// directory to be used in production. When those are present in the repository
+// but not in the publish directory, this most likely indicates that the build
+// command accidentally forgot to copy those. We then print a warning message.
+const warnOnMissingSideFiles = async function ({
+  buildDir,
+  netlifyConfig: {
+    build: { publish },
+  },
+  logs,
+  featureFlags,
+}) {
+  if (!featureFlags.netlify_build_warning_missing_headers) {
+    return
+  }
+
+  await Promise.all(SIDE_FILES.map((sideFile) => warnOnMissingSideFile({ logs, sideFile, buildDir, publish })))
+}
+
+const SIDE_FILES = ['_headers', '_redirects']
+
+const warnOnMissingSideFile = async function ({ logs, sideFile, buildDir, publish }) {
+  if (!(await pathExists(`${buildDir}/${sideFile}`)) || (await pathExists(`${publish}/${sideFile}`))) {
+    return
+  }
+
+  logMissingSideFile(logs, sideFile, relative(buildDir, publish))
+}
+
+module.exports = { warnOnMissingSideFiles }

package/src/log/messages/core.js

@@ -42,6 +42,14 @@ const logTimer = function (logs, durationNs, timerName) {
   log(logs, THEME.dimWords(`(${timerName} completed in ${duration})`))
 }
 
+const logMissingSideFile = function (logs, sideFile, publish) {
+  logWarning(
+    logs,
+    `
+A "${sideFile}" file is present in the repository but is missing in the publish directory "${publish}".`,
+  )
+}
+
 // @todo use `terminal-link` (https://github.com/sindresorhus/terminal-link)
 // instead of `ansi-escapes` once
 // https://github.com/jamestalmage/supports-hyperlinks/pull/12 is fixed
@@ -68,5 +76,6 @@ module.exports = {
   logBuildError,
   logBuildSuccess,
   logTimer,
+  logMissingSideFile,
   logLingeringProcesses,
 }