Don't start the dev session if there are build errors

Author: isaacroldan

packages/app/src/cli/services/dev/processes/dev-session.test.ts

@@ -7,6 +7,7 @@ import {
   testAppAccessConfigExtension,
   testAppLinked,
   testDeveloperPlatformClient,
+  testFunctionExtension,
   testUIExtension,
   testWebhookExtensions,
 } from '../../../models/app/app.test-data.js'
@@ -205,4 +206,21 @@ describe('pushUpdatesForDevSession', () => {
     expect(developerPlatformClient.refreshToken).toHaveBeenCalledOnce()
     expect(developerPlatformClient.devSessionUpdate).toHaveBeenCalledTimes(2)
   })
+
+  test('prints build errors', async () => {
+    // Given
+    const extension = await testFunctionExtension()
+    const event = {app, extensionEvents: [{type: 'updated', extension, buildResult: {status: 'error'}}]}
+
+    // When
+    try {
+      await pushUpdatesForDevSession({stderr, stdout, abortSignal: abortController.signal}, options)
+      appWatcher.emit('ready', event)
+      await flushPromises()
+      // eslint-disable-next-line no-catch-all/no-catch-all
+    } catch (error: any) {
+      expect(error.message).toBe('Dev session aborted, build errors detected in extensions')
+    }
+    expect(developerPlatformClient.devSessionCreate).not.toHaveBeenCalled()
+  })
 })

packages/app/src/cli/services/dev/processes/dev-session.ts

@@ -147,6 +147,15 @@ export const pushUpdatesForDevSession: DevProcessFunction<DevSessionOptions> = a
       )
     })
     .onStart(async (event) => {
+      const buildErrors = event.extensionEvents.filter((eve) => eve.buildResult?.status === 'error')
+      if (buildErrors.length) {
+        const errors = buildErrors.map((error) => ({
+          error: 'Build error. Please review your code and try again.',
+          prefix: error.extension.handle,
+        }))
+        await printMultipleErrors(errors, processOptions.stdout)
+        throw new AbortError('Dev session aborted, build errors detected in extensions.')
+      }
       const result = await bundleExtensionsAndUpload({...processOptions, app: event.app})
       await handleDevSessionResult(result, {...processOptions, app: event.app})
     })
@@ -335,6 +344,16 @@ async function printError(message: string, stdout: Writable, prefix?: string) {
   await printLogMessage(outputContent`${content}`.value, stdout, prefix)
 }
 
+async function printMultipleErrors(errors: {error: string; prefix: string}[], stdout: Writable) {
+  const header = outputToken.errorText(`❌ Error`)
+  await printLogMessage(outputContent`${header}`.value, stdout, 'dev-session')
+  const messages = errors.map((error) => {
+    const content = outputToken.errorText(`└  ${error.error}`)
+    return printLogMessage(outputContent`${content}`.value, stdout, error.prefix)
+  })
+  await Promise.all(messages)
+}
+
 async function printSuccess(message: string, stdout: Writable) {
   await printLogMessage(outputContent`${outputToken.green(message)}`.value, stdout)
 }