Adding reasonDesc param to telemetry error messages

Author: laileni-aws

plugins/amazonq/codewhisperer/jetbrains-community/src/software/aws/toolkits/jetbrains/services/codewhisperer/codescan/CodeWhispererCodeScanException.kt

@@ -5,33 +5,35 @@ package software.aws.toolkits.jetbrains.services.codewhisperer.codescan
 
 import software.aws.toolkits.resources.message
 
-open class CodeWhispererCodeScanException(override val message: String?) : RuntimeException()
+open class CodeScanException(override val message: String, open val code: String?) : RuntimeException(message)
 
-open class CodeWhispererCodeScanServerException(override val message: String?) : RuntimeException()
+open class CodeWhispererCodeScanException(override val message: String, override val code: String?) : CodeScanException(message, code)
+
+open class CodeWhispererCodeScanServerException(override val message: String, override val code: String?) : CodeScanException(message, code)
 
 internal fun noFileOpenError(): Nothing =
-    throw CodeWhispererCodeScanException(message("codewhisperer.codescan.no_file_open"))
+    throw CodeWhispererCodeScanException(message("codewhisperer.codescan.no_file_open"), "NoSourceFilesError")
 
-internal fun codeScanFailed(errorMessage: String): Nothing =
-    throw Exception(errorMessage)
+internal fun codeScanFailed(errorMessage: String, code: String?): Nothing =
+    throw CodeScanException(errorMessage, code)
 
 internal fun cannotFindFile(errorMessage: String, filepath: String): Nothing =
     error(message("codewhisperer.codescan.file_not_found", filepath, errorMessage))
 
 internal fun cannotFindBuildArtifacts(): Nothing =
-    throw CodeWhispererCodeScanException(message("codewhisperer.codescan.build_artifacts_not_found"))
+    throw CodeWhispererCodeScanException(message("codewhisperer.codescan.build_artifacts_not_found"), "NoSourceFilesError")
 
 internal fun fileFormatNotSupported(format: String): Nothing =
-    throw CodeWhispererCodeScanException(message("codewhisperer.codescan.file_ext_not_supported", format))
+    throw CodeWhispererCodeScanException(message("codewhisperer.codescan.file_ext_not_supported", format), "FileFormatNotSupportedError")
 
 internal fun fileTooLarge(): Nothing =
-    throw CodeWhispererCodeScanException(message("codewhisperer.codescan.file_too_large"))
+    throw CodeWhispererCodeScanException(message("codewhisperer.codescan.file_too_large"), "ProjectSizeExceeded")
 
-internal fun codeScanServerException(errorMessage: String): Nothing =
-    throw CodeWhispererCodeScanServerException(errorMessage)
+internal fun codeScanServerException(errorMessage: String, code: String?): Nothing =
+    throw CodeWhispererCodeScanServerException(errorMessage, code)
 
 internal fun invalidSourceZipError(): Nothing =
-    throw CodeWhispererCodeScanException(message("codewhisperer.codescan.invalid_source_zip_telemetry"))
+    throw CodeWhispererCodeScanException(message("codewhisperer.codescan.invalid_source_zip_telemetry"), "InvalidSourceZip")
 
 internal fun noSupportedFilesError(): Nothing =
-    throw CodeWhispererCodeScanException(message("codewhisperer.codescan.unsupported_language_error"))
+    throw CodeWhispererCodeScanException(message("codewhisperer.codescan.unsupported_language_error"), "NoSourceFilesError")

plugins/amazonq/codewhisperer/jetbrains-community/src/software/aws/toolkits/jetbrains/services/codewhisperer/codescan/CodeWhispererCodeScanManager.kt

@@ -282,13 +282,14 @@ class CodeWhispererCodeScanManager(val project: Project) {
                 isProjectScanInProgress.set(false)
             }
             val errorMessage = handleError(coroutineContext, e, scope)
-            codeScanResponseContext = codeScanResponseContext.copy(reason = errorMessage)
-        } catch (e: Exception) {
+            codeScanResponseContext = codeScanResponseContext.copy(reasonDesc = errorMessage)
+            codeScanResponseContext = codeScanResponseContext.copy(reason = "DefaultError")
+        } catch (e: CodeScanException) {
             if (scope == CodeWhispererConstants.CodeAnalysisScope.PROJECT) {
                 isProjectScanInProgress.set(false)
             }
-            val errorMessage = handleException(coroutineContext, e, scope)
-            codeScanResponseContext = codeScanResponseContext.copy(reason = errorMessage)
+            codeScanResponseContext = codeScanResponseContext.copy(reasonDesc = handleException(coroutineContext, e, scope))
+            codeScanResponseContext = codeScanResponseContext.copy(reason = e.code ?: "DefaultError")
         } finally {
             // After code scan
             afterCodeScan(scope)
@@ -346,8 +347,12 @@ class CodeWhispererCodeScanManager(val project: Project) {
     }
 
     private fun getCodeScanServerExceptionMessage(e: CodeWhispererCodeScanServerException): String? =
-        e.message?.takeIf { it.startsWith("UploadArtifactToS3Exception:") }
-            ?.let { message("codewhisperer.codescan.upload_to_s3_failed") }
+        e.code?.let {
+            when (it) {
+                "UploadArtifactToS3Error" -> message("codewhisperer.codescan.upload_to_s3_failed")
+                else -> null
+            }
+        }
 
     fun handleException(coroutineContext: CoroutineContext, e: Exception, scope: CodeWhispererConstants.CodeAnalysisScope): String {
         val errorMessage = when (e) {

plugins/amazonq/codewhisperer/jetbrains-community/src/software/aws/toolkits/jetbrains/services/codewhisperer/codescan/CodeWhispererCodeScanSession.kt

@@ -154,7 +154,7 @@ class CodeWhispererCodeScanSession(val sessionContext: CodeScanSessionContext) {
                     }
                 }
                 val errorMessage = createCodeScanResponse.errorMessage()?.let { it } ?: message("codewhisperer.codescan.run_scan_error_telemetry")
-                codeScanFailed(errorMessage)
+                codeScanFailed(errorMessage, "CreateCodeScanFailedError")
             }
             val jobId = createCodeScanResponse.jobId()
             codeScanResponseContext = codeScanResponseContext.copy(codeScanJobId = jobId)
@@ -191,7 +191,7 @@ class CodeWhispererCodeScanSession(val sessionContext: CodeScanSessionContext) {
                         }
                     }
                     val errorMessage = getCodeScanResponse.errorMessage()?.let { it } ?: message("codewhisperer.codescan.run_scan_error_telemetry")
-                    codeScanFailed(errorMessage)
+                    codeScanFailed(errorMessage, "DefaultError")
                 }
             }
 
@@ -287,7 +287,7 @@ class CodeWhispererCodeScanSession(val sessionContext: CodeScanSessionContext) {
     } catch (e: Exception) {
         LOG.debug { "Create Upload URL failed: ${e.message}" }
         val errorMessage = getTelemetryErrorMessage(e)
-        throw codeScanServerException("CreateUploadUrlException: $errorMessage")
+        throw codeScanServerException(errorMessage, "CreateUploadUrlError")
     }
 
     private fun getUploadIntent(scope: CodeWhispererConstants.CodeAnalysisScope): UploadIntent = when (scope) {
@@ -321,7 +321,7 @@ class CodeWhispererCodeScanSession(val sessionContext: CodeScanSessionContext) {
         } catch (e: Exception) {
             LOG.debug { "Artifact failed to upload in the S3 bucket: ${e.message}" }
             val errorMessage = getTelemetryErrorMessage(e)
-            throw codeScanServerException("UploadArtifactToS3Exception: $errorMessage")
+            throw codeScanServerException(errorMessage, "UploadArtifactToS3Error")
         }
     }
 
@@ -344,7 +344,7 @@ class CodeWhispererCodeScanSession(val sessionContext: CodeScanSessionContext) {
         } catch (e: Exception) {
             LOG.debug { "Creating security scan failed: ${e.message}" }
             val errorMessage = getTelemetryErrorMessage(e)
-            throw codeScanServerException("CreateCodeScanException: $errorMessage")
+            throw codeScanServerException(errorMessage, "CreateCodeScanError")
         }
     }
 
@@ -357,7 +357,7 @@ class CodeWhispererCodeScanSession(val sessionContext: CodeScanSessionContext) {
     } catch (e: Exception) {
         LOG.debug { "Getting security scan failed: ${e.message}" }
         val errorMessage = getTelemetryErrorMessage(e)
-        throw codeScanServerException("GetCodeScanException: $errorMessage")
+        throw codeScanServerException(errorMessage, "GetCodeScanError")
     }
 
     fun listCodeScanFindings(jobId: String, nextToken: String?): ListCodeScanFindingsResponse = try {
@@ -371,7 +371,7 @@ class CodeWhispererCodeScanSession(val sessionContext: CodeScanSessionContext) {
     } catch (e: Exception) {
         LOG.debug { "Listing security scan failed: ${e.message}" }
         val errorMessage = getTelemetryErrorMessage(e)
-        throw codeScanServerException("ListCodeScanFindingsException: $errorMessage")
+        throw codeScanServerException(errorMessage, "ListCodeScanFindingsError")
     }
 
     fun mapToCodeScanIssues(recommendations: List<String>): List<CodeWhispererCodeScanIssue> {

plugins/amazonq/codewhisperer/jetbrains-community/src/software/aws/toolkits/jetbrains/services/codewhisperer/model/CodeWhispererModel.kt

@@ -155,7 +155,8 @@ data class CodeScanResponseContext(
     val codeScanJobId: String? = null,
     val codeScanTotalIssues: Int = 0,
     val codeScanIssuesWithFixes: Int = 0,
-    val reason: String? = null
+    val reason: String? = null,
+    val reasonDesc: String? = null
 )
 
 data class LatencyContext(