Security Scans: Improving telemetry error messages

plugins/toolkit/jetbrains-core/src/software/aws/toolkits/jetbrains/services/codewhisperer/codescan/CodeWhispererCodeScanException.kt

@@ -7,7 +7,7 @@ import software.aws.toolkits.resources.message
 
 open class CodeWhispererCodeScanException(override val message: String?) : RuntimeException()
 
-open class UploadCodeScanException(override val message: String?) : Exception()
+open class CodeWhispererCodeScanServerException(override val message: String?) : RuntimeException()
 
 internal fun noFileOpenError(): Nothing =
     throw CodeWhispererCodeScanException(message("codewhisperer.codescan.no_file_open"))
@@ -27,8 +27,8 @@ internal fun fileFormatNotSupported(format: String): Nothing =
 internal fun fileTooLarge(): Nothing =
     throw CodeWhispererCodeScanException(message("codewhisperer.codescan.file_too_large"))
 
-internal fun uploadArtifactFailedError(errorMessage: String): Nothing =
-    throw UploadCodeScanException(errorMessage)
+internal fun codeScanServerException(errorMessage: String): Nothing =
+    throw CodeWhispererCodeScanServerException(errorMessage)
 
 internal fun invalidSourceZipError(): Nothing =
     throw CodeWhispererCodeScanException(message("codewhisperer.codescan.invalid_source_zip_telemetry"))

plugins/toolkit/jetbrains-core/src/software/aws/toolkits/jetbrains/services/codewhisperer/codescan/CodeWhispererCodeScanManager.kt

@@ -322,14 +322,26 @@ class CodeWhispererCodeScanManager(val project: Project) {
         return errorMessage
     }
 
+    private fun getCodeScanExceptionMessage(e: CodeWhispererCodeScanException): String? {
+        val message = e.message
+        return when {
+            message == message("codewhisperer.codescan.invalid_source_zip_telemetry") -> {
+                message("codewhisperer.codescan.run_scan_error")
+            }
+            message.isNullOrBlank() -> null
+            else -> message
+        }
+    }
+
+    private fun getCodeScanServerExceptionMessage(e: CodeWhispererCodeScanServerException): String? =
+        e.message?.takeIf { it.startsWith("UploadArtifactToS3Exception:") }
+            ?.let { message("codewhisperer.codescan.upload_to_s3_failed") }
+
     fun handleException(coroutineContext: CoroutineContext, e: Exception, scope: CodeWhispererConstants.CodeAnalysisScope): String {
         val errorMessage = when (e) {
             is CodeWhispererException -> e.awsErrorDetails().errorMessage() ?: message("codewhisperer.codescan.run_scan_error")
-            is CodeWhispererCodeScanException -> when (e.message) {
-                message("codewhisperer.codescan.invalid_source_zip_telemetry") -> message("codewhisperer.codescan.run_scan_error")
-                else -> e.message
-            }
-            is UploadCodeScanException -> message("codewhisperer.codescan.upload_to_s3_failed")
+            is CodeWhispererCodeScanException -> getCodeScanExceptionMessage(e)
+            is CodeWhispererCodeScanServerException -> getCodeScanServerExceptionMessage(e)
             is WaiterTimeoutException, is TimeoutCancellationException -> message("codewhisperer.codescan.scan_timed_out")
             is CancellationException -> message("codewhisperer.codescan.cancelled_by_user_exception")
             else -> null
@@ -371,10 +383,17 @@ class CodeWhispererCodeScanManager(val project: Project) {
                 message("codewhisperer.codescan.file_too_large") -> message("codewhisperer.codescan.file_too_large_telemetry")
                 else -> e.message
             }
-            is UploadCodeScanException -> e.message
+            is CodeWhispererCodeScanServerException -> e.message
             is WaiterTimeoutException, is TimeoutCancellationException -> message("codewhisperer.codescan.scan_timed_out")
             is CancellationException -> message("codewhisperer.codescan.cancelled_by_user_exception")
-            else -> e.message
+            else -> when {
+                /**
+                 * Error message has text with user details(like requestId) which is specific so sending a custom error message to calculate the occurence of this event.
+                 */
+                e.message?.startsWith("codewhisperer.codescan.run_scan_throttling_error_telemetry") == true ->
+                    message("codewhisperer.codescan.run_scan_throttling_error_telemetry")
+                else -> e.message
+            }
         } ?: message("codewhisperer.codescan.run_scan_error_telemetry")
 
         return telemetryErrorMessage

plugins/toolkit/jetbrains-core/src/software/aws/toolkits/jetbrains/services/codewhisperer/codescan/CodeWhispererCodeScanSession.kt

@@ -285,7 +285,8 @@ class CodeWhispererCodeScanSession(val sessionContext: CodeScanSessionContext) {
                 .build()
         )
     } catch (e: Exception) {
-        throw e
+        LOG.debug { "Create Upload URL failed: ${e.message}" }
+        throw codeScanServerException("CreateUploadUrlException: " + e.message?.let { it } ?: message("codewhisperer.codescan.run_scan_error_telemetry"))
     }
 
     private fun getUploadIntent(scope: CodeWhispererConstants.CodeAnalysisScope): UploadIntent = when (scope) {
@@ -317,8 +318,8 @@ class CodeWhispererCodeScanSession(val sessionContext: CodeScanSessionContext) {
                 IoUtils.copy(fileToUpload.inputStream(), connection.outputStream)
             }
         } catch (e: Exception) {
-            val errorMessage = e.message?.let { it } ?: message("codewhisperer.codescan.run_scan_error_telemetry")
-            throw uploadArtifactFailedError(errorMessage)
+            LOG.debug { "Artifact failed to upload in the S3 bucket: ${e.message}" }
+            throw codeScanServerException("UploadArtifactToS3Exception: " + e.message?.let { it } ?: message("codewhisperer.codescan.run_scan_error_telemetry"))
         }
     }
 
@@ -340,7 +341,7 @@ class CodeWhispererCodeScanSession(val sessionContext: CodeScanSessionContext) {
             )
         } catch (e: Exception) {
             LOG.debug { "Creating security scan failed: ${e.message}" }
-            throw e
+            throw codeScanServerException("CreateCodeScanException: " + e.message?.let { it } ?: message("codewhisperer.codescan.run_scan_error_telemetry"))
         }
     }
 
@@ -352,7 +353,7 @@ class CodeWhispererCodeScanSession(val sessionContext: CodeScanSessionContext) {
         )
     } catch (e: Exception) {
         LOG.debug { "Getting security scan failed: ${e.message}" }
-        throw e
+        throw codeScanServerException("GetCodeScanException: " + e.message?.let { it } ?: message("codewhisperer.codescan.run_scan_error_telemetry"))
     }
 
     fun listCodeScanFindings(jobId: String, nextToken: String?): ListCodeScanFindingsResponse = try {
@@ -365,7 +366,7 @@ class CodeWhispererCodeScanSession(val sessionContext: CodeScanSessionContext) {
         )
     } catch (e: Exception) {
         LOG.debug { "Listing security scan failed: ${e.message}" }
-        throw e
+        throw codeScanServerException("ListCodeScanFindingsException: " + e.message?.let { it } ?: message("codewhisperer.codescan.run_scan_error_telemetry"))
     }
 
     fun mapToCodeScanIssues(recommendations: List<String>): List<CodeWhispererCodeScanIssue> {

plugins/toolkit/jetbrains-core/tst/software/aws/toolkits/jetbrains/services/codewhisperer/codescan/CodeWhispererCodeFileScanTest.kt

@@ -311,14 +311,14 @@ class CodeWhispererCodeFileScanTest : CodeWhispererCodeScanTestBase(PythonCodeIn
     @Test
     fun `test run() - createCodeScan error`() {
         mockClient.stub {
-            onGeneric { createCodeScan(any(), any()) }.thenThrow(CodeWhispererCodeScanException::class.java)
+            onGeneric { createCodeScan(any(), any()) }.thenThrow(CodeWhispererCodeScanServerException::class.java)
         }
 
         runBlocking {
             val codeScanResponse = codeScanSessionSpy.run()
             assertThat(codeScanResponse).isInstanceOf<CodeScanResponse.Failure>()
             assertThat(codeScanResponse.responseContext.payloadContext).isEqualTo(payloadContext)
-            assertThat((codeScanResponse as CodeScanResponse.Failure).failureReason).isInstanceOf<CodeWhispererCodeScanException>()
+            assertThat((codeScanResponse as CodeScanResponse.Failure).failureReason).isInstanceOf<CodeWhispererCodeScanServerException>()
         }
     }
 
@@ -361,28 +361,28 @@ class CodeWhispererCodeFileScanTest : CodeWhispererCodeScanTestBase(PythonCodeIn
     @Test
     fun `test run() - getCodeScan error`() {
         mockClient.stub {
-            onGeneric { getCodeScan(any(), any()) }.thenThrow(CodeWhispererException::class.java)
+            onGeneric { getCodeScan(any(), any()) }.thenThrow(CodeWhispererCodeScanServerException::class.java)
         }
 
         runBlocking {
             val codeScanResponse = codeScanSessionSpy.run()
             assertThat(codeScanResponse).isInstanceOf<CodeScanResponse.Failure>()
             assertThat(codeScanResponse.responseContext.payloadContext).isEqualTo(payloadContext)
-            assertThat((codeScanResponse as CodeScanResponse.Failure).failureReason).isInstanceOf<CodeWhispererException>()
+            assertThat((codeScanResponse as CodeScanResponse.Failure).failureReason).isInstanceOf<CodeWhispererCodeScanServerException>()
         }
     }
 
     @Test
     fun `test run() - listCodeScanFindings error`() {
         mockClient.stub {
-            onGeneric { listCodeScanFindings(any(), any()) }.thenThrow(CodeWhispererException::class.java)
+            onGeneric { listCodeScanFindings(any(), any()) }.thenThrow(CodeWhispererCodeScanServerException::class.java)
         }
 
         runBlocking {
             val codeScanResponse = codeScanSessionSpy.run()
             assertThat(codeScanResponse).isInstanceOf<CodeScanResponse.Failure>()
             assertThat(codeScanResponse.responseContext.payloadContext).isEqualTo(payloadContext)
-            assertThat((codeScanResponse as CodeScanResponse.Failure).failureReason).isInstanceOf<CodeWhispererException>()
+            assertThat((codeScanResponse as CodeScanResponse.Failure).failureReason).isInstanceOf<CodeWhispererCodeScanServerException>()
         }
     }
 

plugins/toolkit/jetbrains-core/tst/software/aws/toolkits/jetbrains/services/codewhisperer/codescan/CodeWhispererCodeScanTest.kt

@@ -222,14 +222,14 @@ class CodeWhispererCodeScanTest : CodeWhispererCodeScanTestBase(PythonCodeInsigh
     @Test
     fun `test run() - createCodeScan error`() {
         mockClient.stub {
-            onGeneric { createCodeScan(any(), any()) }.thenThrow(CodeWhispererCodeScanException::class.java)
+            onGeneric { createCodeScan(any(), any()) }.thenThrow(CodeWhispererCodeScanServerException::class.java)
         }
 
         runBlocking {
             val codeScanResponse = codeScanSessionSpy.run()
             assertThat(codeScanResponse).isInstanceOf<CodeScanResponse.Failure>()
             assertThat(codeScanResponse.responseContext.payloadContext).isEqualTo(payloadContext)
-            assertThat((codeScanResponse as CodeScanResponse.Failure).failureReason).isInstanceOf<CodeWhispererCodeScanException>()
+            assertThat((codeScanResponse as CodeScanResponse.Failure).failureReason).isInstanceOf<CodeWhispererCodeScanServerException>()
         }
     }
 
@@ -272,28 +272,28 @@ class CodeWhispererCodeScanTest : CodeWhispererCodeScanTestBase(PythonCodeInsigh
     @Test
     fun `test run() - getCodeScan error`() {
         mockClient.stub {
-            onGeneric { getCodeScan(any(), any()) }.thenThrow(CodeWhispererException::class.java)
+            onGeneric { getCodeScan(any(), any()) }.thenThrow(CodeWhispererCodeScanServerException::class.java)
         }
 
         runBlocking {
             val codeScanResponse = codeScanSessionSpy.run()
             assertThat(codeScanResponse).isInstanceOf<CodeScanResponse.Failure>()
             assertThat(codeScanResponse.responseContext.payloadContext).isEqualTo(payloadContext)
-            assertThat((codeScanResponse as CodeScanResponse.Failure).failureReason).isInstanceOf<CodeWhispererException>()
+            assertThat((codeScanResponse as CodeScanResponse.Failure).failureReason).isInstanceOf<CodeWhispererCodeScanServerException>()
         }
     }
 
     @Test
     fun `test run() - listCodeScanFindings error`() {
         mockClient.stub {
-            onGeneric { listCodeScanFindings(any(), any()) }.thenThrow(CodeWhispererException::class.java)
+            onGeneric { listCodeScanFindings(any(), any()) }.thenThrow(CodeWhispererCodeScanServerException::class.java)
         }
 
         runBlocking {
             val codeScanResponse = codeScanSessionSpy.run()
             assertThat(codeScanResponse).isInstanceOf<CodeScanResponse.Failure>()
             assertThat(codeScanResponse.responseContext.payloadContext).isEqualTo(payloadContext)
-            assertThat((codeScanResponse as CodeScanResponse.Failure).failureReason).isInstanceOf<CodeWhispererException>()
+            assertThat((codeScanResponse as CodeScanResponse.Failure).failureReason).isInstanceOf<CodeWhispererCodeScanServerException>()
         }
     }
 

plugins/toolkit/resources/resources/software/aws/toolkits/resources/MessagesBundle.properties

@@ -761,6 +761,7 @@ codewhisperer.codescan.run_scan_complete=<html><body> Security Scan completed fo
 codewhisperer.codescan.run_scan_error=Amazon Q encountered an error while scanning for security issues. Please try again later.
 codewhisperer.codescan.run_scan_error_telemetry=Security scan failed.
 codewhisperer.codescan.run_scan_info=Select 'Run' in toolbar to scan this package for security issues.
+codewhisperer.codescan.run_scan_throttling_error_telemetry= Too many requests, please wait before trying again.
 codewhisperer.codescan.scan_display=Amazon Q Security Issues
 codewhisperer.codescan.scan_display_with_issues=<html><body>Amazon Q Security Issues <font color="{1}"> {0} </font></body></html>
 codewhisperer.codescan.scan_in_progress=Scanning active project and its dependencies...