fix: show deploy errors when --json is used (#7649)

Author: eduardoboucas

src/commands/deploy/deploy.ts

@@ -687,10 +687,12 @@ const handleBuild = async ({
  currentDir,
  deployHandler,
  })
- const { configMutations, exitCode, newConfig } = await runBuild(resolvedOptions)
+ const { configMutations, exitCode, newConfig, logs } = await runBuild(resolvedOptions)
  // Without this, the deploy command fails silently
  if (options.json && exitCode !== 0) {
- logAndThrowError('Error while running build')
+ const message = logs?.stderr.length ? `: ${logs.stderr.join('')}` : ''
+
+ logAndThrowError(`Error while running build${message}`)
  }
  if (exitCode !== 0) {
  exit(exitCode)

src/lib/build.ts

@@ -194,7 +194,14 @@ export const getRunBuildOptions = async ({
  }
 }
 
-export const runBuild = async (options: RunBuildOptions) => {
+export const runBuild = async (
+ options: RunBuildOptions,
+): Promise<{
+ exitCode: number
+ newConfig: NetlifyConfig
+ configMutations: Record<string, string>
+ logs?: { stdout: string[]; stderr: string[] }
+}> => {
  // If netlify NETLIFY_API_URL is set we need to pass this information to @netlify/build
  // TODO don't use testOpts, but add real properties to do this.
  if (process.env.NETLIFY_API_URL) {
@@ -212,7 +219,8 @@ export const runBuild = async (options: RunBuildOptions) => {
  configMutations,
  netlifyConfig: newConfig,
  severityCode: exitCode,
+ logs,
  // TODO(serhalp): Upstream the type fixes above into @netlify/build and remove this type assertion
  } = await (build as unknown as (opts: RunBuildOptions) => Promise<ReturnType<typeof build>>)(options)
- return { exitCode, newConfig, configMutations }
+ return { exitCode, newConfig, configMutations, logs }
 }

tests/integration/commands/deploy/deploy.test.ts

@@ -452,6 +452,33 @@ describe.skipIf(process.env.NETLIFY_TEST_DISABLE_LIVE === 'true').concurrent('co
  })
 
  test('should throw error when build fails with --json option', async (t) => {
+ await withSiteBuilder(t, async (builder) => {
+ builder
+ .withContentFile({
+ path: 'public/index.html',
+ content: '<h1>Test content</h1>',
+ })
+ .withNetlifyToml({
+ config: {
+ build: {
+ publish: 'public',
+ command: 'echo "Build failed with custom error" >&2 && exit 1',
+ },
+ },
+ })
+
+ await builder.build()
+
+ await expect(
+ callCli(['deploy', '--json'], {
+ cwd: builder.directory,
+ env: { NETLIFY_SITE_ID: context.siteId },
+ }),
+ ).rejects.toThrow(/Error while running build.*Build failed with custom error/)
+ })
+ })
+
+ test('should throw error without stderr details when build fails with --json option and no stderr output', async (t) => {
  await withSiteBuilder(t, async (builder) => {
  builder
  .withContentFile({