Add meaningful error codes for telemetry

Author: mbfreder

packages/core/src/shared/sam/build.ts

@@ -236,6 +236,7 @@ export async function runBuild(arg?: TreeNode): Promise<SamBuildResult> {
     } catch (error) {
         throw ToolkitError.chain(error, 'Failed to build SAM template', {
             details: { ...resolveBuildArgConflict(buildFlags) },
+            code: error instanceof ToolkitError ? error.code : undefined,
         })
     }
 }

packages/core/src/shared/sam/deploy.ts

@@ -392,7 +392,10 @@ export async function runDeploy(arg: any, wizardParams?: DeployParams): Promise<
                 throw error
             }
         } catch (error) {
-            throw ToolkitError.chain(error, 'Failed to deploy SAM template', { details: { ...deployFlags } })
+            throw ToolkitError.chain(error, 'Failed to deploy SAM template', {
+                details: { ...deployFlags },
+                code: error instanceof ToolkitError ? error.code : undefined,
+            })
         }
         return {
             isSuccess: true,

packages/core/src/shared/sam/processTerminal.ts

@@ -12,18 +12,29 @@ import { CancellationError } from '../utilities/timeoutUtils'
 import { getLogger } from '../logger'
 import { removeAnsi } from '../utilities/textUtilities'
 import { isAutomation } from '../vscode/env'
+import { getSamCliErrorMessage, SamCliErrorTypes } from './utils'
 
 let oldTerminal: ProcessTerminal | undefined
 export async function runInTerminal(proc: ChildProcess, cmd: string) {
     const handleResult = (result?: ChildProcessResult) => {
         if (result && result.exitCode !== 0) {
-            const message = `sam ${cmd} exited with a non-zero exit code: ${result.exitCode}`
+            const defaultMessage = `sam ${cmd} exited with a non-zero exit code: ${result.exitCode}`
             if (result.stderr.includes('is up to date')) {
-                throw ToolkitError.chain(result.error, message, {
+                throw ToolkitError.chain(result.error, defaultMessage, {
                     code: 'NoUpdateExitCode',
                 })
             }
-            throw ToolkitError.chain(result.error, message, {
+            for (const errorType in SamCliErrorTypes) {
+                const errorMessage = getSamCliErrorMessage(result.stderr)
+                if (errorMessage.includes(SamCliErrorTypes[errorType as keyof typeof SamCliErrorTypes])) {
+                    throw ToolkitError.chain(result.error, errorMessage, {
+                        code: errorType,
+                    })
+                }
+            }
+
+            // If no specific error matched, throw the default non-zero exit code error.
+            throw ToolkitError.chain(result.error, defaultMessage, {
                 code: 'NonZeroExitCode',
             })
         }

packages/core/src/shared/sam/sync.ts

@@ -661,7 +661,10 @@ export async function runSync(
                 isSuccess: true,
             }
         } catch (err) {
-            throw ToolkitError.chain(err, 'Failed to sync SAM application', { details: { ...params } })
+            throw ToolkitError.chain(err, 'Failed to sync SAM application', {
+                details: { ...params },
+                code: err instanceof ToolkitError ? err.code : undefined,
+            })
         }
     })
 }

packages/core/src/shared/sam/utils.ts

@@ -83,3 +83,22 @@ export async function getSamCliPathAndVersion() {
 
     return { path: samCliPath, parsedVersion }
 }
+
+export function getSamCliErrorMessage(stderr: string): string {
+    // Split the stderr string by newline, filter out empty lines, and get the last line
+    const lines = stderr
+        .trim()
+        .split('\n')
+        .filter((line) => line.trim() !== '')
+    return lines[lines.length - 1]
+}
+
+export enum SamCliErrorTypes {
+    DockerUnreachable = 'Docker is unreachable.',
+    ResolveS3AndS3Set = 'Cannot use both --resolve-s3 and --s3-bucket parameters in non-guided deployments.',
+    DeployStackStatusMissing = 'Was not able to find a stack with the name:',
+    DeployStackOutPutFailed = 'Failed to get outputs from stack',
+    DeployBucketRequired = 'Templates with a size greater than 51,200 bytes must be deployed via an S3 Bucket.',
+    NoUpdate = 'is up to date',
+    ChangeSetEmpty = 'No changes to deploy. Stack is up to date',
+}

packages/core/src/test/shared/sam/utils.test.ts

@@ -6,7 +6,13 @@
 import * as vscode from 'vscode'
 import assert from 'assert'
 import sinon from 'sinon'
-import { getProjectRootUri, getProjectRoot, getSource, isDotnetRuntime } from '../../../shared/sam/utils'
+import {
+    getProjectRootUri,
+    getProjectRoot,
+    getSource,
+    isDotnetRuntime,
+    getSamCliErrorMessage,
+} from '../../../shared/sam/utils'
 import { TemplateItem } from '../../../shared/sam/sync'
 import { RegionNode } from '../../../awsexplorer/regionNode'
 import { Region } from '../../../shared/regions/endpoints'
@@ -148,4 +154,16 @@ describe('SAM utils', async function () {
             })
         })
     })
+
+    describe('gets the SAM CLI error from stderr', async function () {
+        it('returns the error message', async function () {
+            const stderr =
+                'Starting Build use cache\nStarting Build inside a container\nCache is invalid, running build and copying resources for following functions (ResizerFunction)\nBuilding codeuri: /Users/mbfreder/TestApp/JavaSamApp/serverless-patterns/s3lambda-resizing-python/src runtime: python3.12 metadata: {} architecture: x86_64 functions: ResizerFunction\nError: Docker is unreachable. Docker needs to be running to build inside a container.'
+            const response = getSamCliErrorMessage(stderr)
+            assert.deepStrictEqual(
+                response,
+                'Error: Docker is unreachable. Docker needs to be running to build inside a container.'
+            )
+        })
+    })
 })