Report plugin load errors as statuses (#1286)

Author: ehmicky

packages/build/src/core/main.js

@@ -63,7 +63,7 @@ const build = async function(flags) {
     } = await loadConfig(flagsA)
 
     try {
-      const pluginsOptions = await getPluginsOptions({ netlifyConfig, buildDir, constants, mode })
+      const pluginsOptions = await getPluginsOptions({ netlifyConfig, buildDir, constants, mode, api })
       await installLocalPluginsDependencies({ pluginsOptions, buildDir, mode })
 
       const { commandsCount, error, statuses } = await buildRun({
@@ -79,6 +79,7 @@ const build = async function(flags) {
         context,
         branch,
         mode,
+        api,
         errorMonitor,
       })
 
@@ -122,6 +123,7 @@ const buildRun = async function({
   context,
   branch,
   mode,
+  api,
   errorMonitor,
 }) {
   const utilsData = await startUtils(buildDir)
@@ -141,6 +143,8 @@ const buildRun = async function({
       token,
       dry,
       constants,
+      mode,
+      api,
       errorMonitor,
     })
   } finally {
@@ -160,6 +164,8 @@ const executeCommands = async function({
   token,
   dry,
   constants,
+  mode,
+  api,
   errorMonitor,
 }) {
   const pluginsCommands = await loadPlugins({
@@ -169,6 +175,8 @@ const executeCommands = async function({
     utilsData,
     token,
     constants,
+    mode,
+    api,
   })
 
   const { commands, commandsCount } = getCommands(pluginsCommands, netlifyConfig)

packages/build/src/core/status.js

@@ -1,5 +1,6 @@
 const { env } = require('process')
 
+const { serializeErrorStatus } = require('../error/parse/serialize_status')
 const { logStatuses } = require('../log/main')
 
 // The last event handler of a plugin (except for `onError` and `onEnd`)
@@ -57,6 +58,13 @@ const canOverrideStatus = function(formerStatus, newStatus) {
   return formerStatus.state === 'success' || newStatus.state !== 'success'
 }
 
+// Errors that happen during plugin loads should be reported as error statuses
+const reportPluginLoadError = async function({ error, api, mode, event, package, version }) {
+  const errorStatus = serializeErrorStatus(error)
+  const statuses = [{ ...errorStatus, event, package, version }]
+  await reportStatuses(statuses, api, mode)
+}
+
 const reportStatuses = async function(statuses, api, mode) {
   printStatuses(statuses, mode)
   await sendStatuses(statuses, api, mode)
@@ -98,4 +106,4 @@ const sendStatus = async function(api, { package, version, state, event, title,
   })
 }
 
-module.exports = { getSuccessStatus, addStatus, reportStatuses }
+module.exports = { getSuccessStatus, addStatus, reportPluginLoadError, reportStatuses }

packages/build/src/plugins/load.js

@@ -1,8 +1,19 @@
+const { reportPluginLoadError } = require('../core/status')
+
 const { callChild } = require('./ipc')
 
 // Retrieve all plugins commands
 // Can use either a module name or a file path to the plugin.
-const loadPlugins = async function({ pluginsOptions, childProcesses, netlifyConfig, utilsData, token, constants }) {
+const loadPlugins = async function({
+  pluginsOptions,
+  childProcesses,
+  netlifyConfig,
+  utilsData,
+  token,
+  constants,
+  mode,
+  api,
+}) {
   const pluginsCommands = await Promise.all(
     pluginsOptions.map((pluginOptions, index) =>
       loadPlugin(pluginOptions, {
@@ -12,6 +23,8 @@ const loadPlugins = async function({ pluginsOptions, childProcesses, netlifyConf
         utilsData,
         token,
         constants,
+        mode,
+        api,
       }),
     ),
   )
@@ -22,26 +35,32 @@ const loadPlugins = async function({ pluginsOptions, childProcesses, netlifyConf
 // Retrieve plugin commands for one plugin.
 // Do it by executing the plugin `load` event handler.
 const loadPlugin = async function(
-  { package, packageJson, pluginPath, manifest, inputs, local, core },
-  { childProcesses, index, netlifyConfig, utilsData, token, constants },
+  { package, packageJson, packageJson: { version } = {}, pluginPath, manifest, inputs, local, core },
+  { childProcesses, index, netlifyConfig, utilsData, token, constants, mode, api },
 ) {
   const { childProcess } = childProcesses[index]
+  const event = 'load'
 
-  const { pluginCommands } = await callChild(
-    childProcess,
-    'load',
-    { pluginPath, manifest, inputs, netlifyConfig, utilsData, token, constants },
-    { plugin: { package, packageJson }, location: { event: 'load', package, local } },
-  )
-  const pluginCommandsA = pluginCommands.map(({ event }) => ({
-    event,
-    package,
-    local,
-    core,
-    packageJson,
-    childProcess,
-  }))
-  return pluginCommandsA
+  try {
+    const { pluginCommands } = await callChild(
+      childProcess,
+      'load',
+      { pluginPath, manifest, inputs, netlifyConfig, utilsData, token, constants },
+      { plugin: { package, packageJson }, location: { event, package, local } },
+    )
+    const pluginCommandsA = pluginCommands.map(({ event }) => ({
+      event,
+      package,
+      local,
+      core,
+      packageJson,
+      childProcess,
+    }))
+    return pluginCommandsA
+  } catch (error) {
+    await reportPluginLoadError({ error, api, mode, event, package, version })
+    throw error
+  }
 }
 
 module.exports = { loadPlugins }

packages/build/src/plugins/manifest/main.js

@@ -1,18 +1,28 @@
+const { reportPluginLoadError } = require('../../core/status')
+
 const { checkInputs } = require('./check')
 const { loadManifest } = require('./load')
 const { getManifestPath } = require('./path')
 
 // Load plugin's `manifest.yml`
-const useManifest = async function({ package, local, inputs }, { pluginDir, packageDir, packageJson }) {
+const useManifest = async function(
+  { package, local, inputs },
+  { pluginDir, packageDir, packageJson, packageJson: { version }, mode, api },
+) {
   const manifestPath = await getManifestPath(pluginDir, packageDir)
 
   if (manifestPath === undefined) {
     return { manifest: {}, inputs }
   }
 
-  const manifest = await loadManifest({ manifestPath, package, packageJson, local })
-  const inputsA = checkInputs({ inputs, manifest, package, packageJson, local })
-  return { manifest, inputs: inputsA }
+  try {
+    const manifest = await loadManifest({ manifestPath, package, packageJson, local })
+    const inputsA = checkInputs({ inputs, manifest, package, packageJson, local })
+    return { manifest, inputs: inputsA }
+  } catch (error) {
+    await reportPluginLoadError({ error, api, mode, event: 'load', package, version })
+    throw error
+  }
 }
 
 module.exports = { useManifest }

packages/build/src/plugins/options.js

@@ -11,15 +11,21 @@ const { getPackageJson } = require('./package')
 
 // Load plugin options (specified by user in `config.plugins`)
 // Do not allow user override of core plugins
-const getPluginsOptions = async function({ netlifyConfig: { plugins }, buildDir, constants: { FUNCTIONS_SRC }, mode }) {
+const getPluginsOptions = async function({
+  netlifyConfig: { plugins },
+  buildDir,
+  constants: { FUNCTIONS_SRC },
+  mode,
+  api,
+}) {
   const corePlugins = getCorePlugins(FUNCTIONS_SRC)
   const allCorePlugins = corePlugins.filter(corePlugin => !isOptionalCore(corePlugin, plugins))
   const userPlugins = plugins.filter(({ package }) => !CORE_PLUGINS.includes(package))
   const pluginsOptions = [...allCorePlugins, ...userPlugins].map(normalizePluginOptions)
   await installMissingPlugins({ pluginsOptions, buildDir, mode })
   await checkDeprecatedFunctionsInstall(plugins, FUNCTIONS_SRC, buildDir)
   const pluginsOptionsA = await Promise.all(
-    pluginsOptions.map(pluginOptions => loadPluginFiles({ pluginOptions, buildDir })),
+    pluginsOptions.map(pluginOptions => loadPluginFiles({ pluginOptions, buildDir, mode, api })),
   )
   return pluginsOptionsA
 }
@@ -36,11 +42,17 @@ const normalizePluginOptions = function({ package, location = package, core = fa
 
 // Retrieve plugin's main file path.
 // Then load plugin's `package.json` and `manifest.yml`.
-const loadPluginFiles = async function({ pluginOptions, pluginOptions: { location }, buildDir }) {
+const loadPluginFiles = async function({ pluginOptions, pluginOptions: { location }, buildDir, mode, api }) {
   const pluginPath = await resolveLocation(location, buildDir)
   const pluginDir = dirname(pluginPath)
   const { packageDir, packageJson } = await getPackageJson({ pluginDir })
-  const { manifest, inputs: inputsA } = await useManifest(pluginOptions, { pluginDir, packageDir, packageJson })
+  const { manifest, inputs: inputsA } = await useManifest(pluginOptions, {
+    pluginDir,
+    packageDir,
+    packageJson,
+    mode,
+    api,
+  })
   return { ...pluginOptions, pluginPath, packageDir, packageJson, manifest, inputs: inputsA }
 }
 

packages/build/tests/plugins/status/fixtures/error_inputs_validation/manifest.yml

@@ -0,0 +1,2 @@
+name: plugin
+inputs: []

packages/build/tests/plugins/status/fixtures/error_inputs_validation/netlify.toml

@@ -0,0 +1,5 @@
+[[plugins]]
+package = "./plugin.js"
+
+  [plugins.inputs]
+  test = true

packages/build/tests/plugins/status/fixtures/error_inputs_validation/plugin.js

@@ -0,0 +1 @@
+module.exports = {}

packages/build/tests/plugins/status/fixtures/error_load_uncaught/netlify.toml

@@ -0,0 +1,2 @@
+[[plugins]]
+package = "./plugin.js"

packages/build/tests/plugins/status/fixtures/error_load_uncaught/plugin.js

@@ -0,0 +1,5 @@
+const throwError = function() {
+  throw new Error('test')
+}
+
+throwError()

packages/build/tests/plugins/status/fixtures/error_plugin_shape/netlify.toml

@@ -0,0 +1,5 @@
+[[plugins]]
+package = "./plugin.js"
+
+  [plugins.inputs]
+  test = true

packages/build/tests/plugins/status/fixtures/error_plugin_shape/plugin.js

@@ -0,0 +1 @@
+module.exports = false