feat(build): Add trace attribute to track builds failing from Netlify maintained extensions (#5914)

* feat(build): track netlify owned extensions * feat: add if plugin is maintained by netlify * fix: move adding new plugin attribute to where the others are set * fix: update netlify maintained extension names * chore: cleanup * chore: remove unused trace attribute * chore: add debug logs * update console.log * chore: log integrations * fix: fix debug log * chore: add extension author to trace * fix: add auth and slug to trace correctly * chore: add slug and author to trace * chore: add debug logs * chore: add extensionMetadata to attributes * chore: clean up * fix: fix unused var error * chore: add types for extension metadata * chore: remove debug log * chore: update test --------- Co-authored-by: NikAiyer <nick.aiyer@gmail.com>

Author: YujohnNattrass

packages/build/src/error/types.ts

@@ -81,6 +81,14 @@ type PluginInfo = {
  pluginPackageJson: {
  version?: string
  }
+ extensionMetadata?: {
+ slug: string
+ name: string
+ version: string
+ has_build: boolean
+ has_connector: boolean
+ author?: string
+ }
 }
 
 export type BuildCommandLocation = {
@@ -201,9 +209,12 @@ const errorLocationToTracingAttributes = function (location: ErrorLocation): Att
 const pluginDataToTracingAttributes = function (pluginInfo?: PluginInfo): Attributes {
  const pluginAttributePrefix = `${buildErrorAttributePrefix}.plugin`
  if (typeof pluginInfo === 'undefined') return {}
+
  return {
  [`${pluginAttributePrefix}.name`]: pluginInfo?.packageName,
  [`${pluginAttributePrefix}.version`]: pluginInfo?.pluginPackageJson?.version,
+ [`${pluginAttributePrefix}.extensionAuthor`]: pluginInfo?.extensionMetadata?.author,
+ [`${pluginAttributePrefix}.extensionSlug`]: pluginInfo?.extensionMetadata?.slug,
  }
 }
 

packages/build/src/plugins/load.js

@@ -75,7 +75,16 @@ const loadAllPlugins = measureDuration(tLoadAllPlugins, 'load_plugins')
 // Retrieve plugin steps for one plugin.
 // Do it by executing the plugin `load` event handler.
 const loadPlugin = async function (
- { packageName, pluginPackageJson, pluginPackageJson: { version } = {}, pluginPath, inputs, loadedFrom, origin },
+ {
+ packageName,
+ pluginPackageJson,
+ pluginPackageJson: { version } = {},
+ pluginPath,
+ inputs,
+ loadedFrom,
+ origin,
+ integration,
+ },
  { childProcesses, index, packageJson, logs, debug, verbose, netlifyConfig, featureFlags, systemLog },
 ) {
  const { childProcess } = childProcesses[index]
@@ -97,6 +106,7 @@ const loadPlugin = async function (
  origin,
  pluginPackageJson,
  childProcess,
+ extensionMetadata: integration,
  }))
  return pluginSteps
  } catch (error) {
@@ -106,7 +116,11 @@ const loadPlugin = async function (
  }
 
  addErrorInfo(error, {
- plugin: { packageName, pluginPackageJson },
+ plugin: {
+ packageName,
+ pluginPackageJson,
+ extensionMetadata: integration,
+ },
  location: { event: loadEvent, packageName, loadedFrom, origin },
  })
  addPluginLoadErrorStatus({ error, packageName, version, debug })

packages/build/src/steps/plugin.js

@@ -39,6 +39,7 @@ export const firePluginStep = async function ({
  featureFlags,
  debug,
  verbose,
+ extensionMetadata,
 }) {
  const standardStreams = getStandardStreams(outputFlusher)
  const listeners = pipePluginOutput(childProcess, logs, standardStreams)
@@ -103,7 +104,7 @@ export const firePluginStep = async function ({
  const errorType = getPluginErrorType(newError, loadedFrom, packageName)
  addErrorInfo(newError, {
  ...errorType,
- plugin: { pluginPackageJson, packageName },
+ plugin: { pluginPackageJson, packageName, extensionMetadata },
  location: { event, packageName, loadedFrom, origin },
  })
  return { newError }

packages/build/src/steps/run_step.ts

@@ -69,6 +69,7 @@ export const runStep = async function ({
  userNodeVersion,
  explicitSecretKeys,
  edgeFunctionsBootstrapURL,
+ extensionMetadata,
 }) {
  // Add relevant attributes to the upcoming span context
  const attributes: StepExecutionAttributes = {
@@ -144,6 +145,7 @@ export const runStep = async function ({
  durationNs,
  metrics,
  } = await fireStep({
+ extensionMetadata,
  defaultConfig,
  event,
  childProcess,
@@ -349,6 +351,7 @@ const tFireStep = function ({
  explicitSecretKeys,
  edgeFunctionsBootstrapURL,
  deployId,
+ extensionMetadata,
 }) {
  if (coreStep !== undefined) {
  return fireCoreStep({
@@ -414,5 +417,6 @@ const tFireStep = function ({
  featureFlags,
  debug,
  verbose,
+ extensionMetadata,
  })
 }

packages/build/src/steps/run_steps.js

@@ -76,6 +76,7 @@ export const runSteps = async function ({
  event,
  childProcess,
  packageName,
+ extensionMetadata,
  coreStep,
  coreStepId,
  coreStepName,
@@ -103,6 +104,7 @@ export const runSteps = async function ({
  event,
  childProcess,
  packageName,
+ extensionMetadata,
  coreStep,
  coreStepId,
  coreStepName,

packages/build/tests/error/tests.js

@@ -145,6 +145,10 @@ const testMatrixAttributeTracing = [
  pluginPackageJson: {
  version: '1.2.1',
  },
+ extensionMetadata: {
+ slug: 'test-extension-slug',
+ author: 'test-extension-author',
+ },
  },
  },
  severity: 'error',
@@ -159,6 +163,8 @@ const testMatrixAttributeTracing = [
  'build.error.location.plugin.package_name': 'test-package',
  'build.error.location.plugin.loaded_from': 'test-loaded-from',
  'build.error.location.plugin.origin': 'test-origin',
+ 'build.error.plugin.extensionAuthor': 'test-extension-author',
+ 'build.error.plugin.extensionSlug': 'test-extension-slug',
  'build.error.plugin.name': 'test-package',
  'build.error.plugin.version': '1.2.1',
  },

packages/config/src/types/integrations.ts

@@ -5,4 +5,5 @@ export type Integration = {
  dev?: {
  path: string
  }
+ author?: string
 }