Revert: Security scans - Improving telemetry error messages (#4653)

laileni-aws · web-flow · commit e67a5bc40985 · 2024-07-10T10:38:35.000-07:00
* Revert "Security scans: Improving telemetry error messages (#4600)"
diff --git a/plugins/amazonq/codewhisperer/jetbrains-community/src/software/aws/toolkits/jetbrains/services/codewhisperer/codescan/CodeWhispererCodeScanException.kt b/plugins/amazonq/codewhisperer/jetbrains-community/src/software/aws/toolkits/jetbrains/services/codewhisperer/codescan/CodeWhispererCodeScanException.kt
@@ -5,35 +5,33 @@ package software.aws.toolkits.jetbrains.services.codewhisperer.codescan
 
 import software.aws.toolkits.resources.message
 
-open class CodeScanException(override val message: String, open val code: String?) : RuntimeException(message)
+open class CodeWhispererCodeScanException(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)
+open class CodeWhispererCodeScanServerException(override val message: String?) : RuntimeException()
 
 internal fun noFileOpenError(): Nothing =
-    throw CodeWhispererCodeScanException(message("codewhisperer.codescan.no_file_open"), "NoSourceFilesError")
+    throw CodeWhispererCodeScanException(message("codewhisperer.codescan.no_file_open"))
 
-internal fun codeScanFailed(errorMessage: String, code: String?): Nothing =
-    throw CodeScanException(errorMessage, code)
+internal fun codeScanFailed(errorMessage: String): Nothing =
+    throw Exception(errorMessage)
 
 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"), "NoSourceFilesError")
+    throw CodeWhispererCodeScanException(message("codewhisperer.codescan.build_artifacts_not_found"))
 
 internal fun fileFormatNotSupported(format: String): Nothing =
-    throw CodeWhispererCodeScanException(message("codewhisperer.codescan.file_ext_not_supported", format), "FileFormatNotSupportedError")
+    throw CodeWhispererCodeScanException(message("codewhisperer.codescan.file_ext_not_supported", format))
 
 internal fun fileTooLarge(): Nothing =
-    throw CodeWhispererCodeScanException(message("codewhisperer.codescan.file_too_large"), "ProjectSizeExceeded")
+    throw CodeWhispererCodeScanException(message("codewhisperer.codescan.file_too_large"))
 
-internal fun codeScanServerException(errorMessage: String, code: String?): Nothing =
-    throw CodeWhispererCodeScanServerException(errorMessage, code)
+internal fun codeScanServerException(errorMessage: String): Nothing =
+    throw CodeWhispererCodeScanServerException(errorMessage)
 
 internal fun invalidSourceZipError(): Nothing =
-    throw CodeWhispererCodeScanException(message("codewhisperer.codescan.invalid_source_zip_telemetry"), "InvalidSourceZip")
+    throw CodeWhispererCodeScanException(message("codewhisperer.codescan.invalid_source_zip_telemetry"))
 
 internal fun noSupportedFilesError(): Nothing =
-    throw CodeWhispererCodeScanException(message("codewhisperer.codescan.unsupported_language_error"), "NoSourceFilesError")
+    throw CodeWhispererCodeScanException(message("codewhisperer.codescan.unsupported_language_error"))
diff --git a/plugins/amazonq/codewhisperer/jetbrains-community/src/software/aws/toolkits/jetbrains/services/codewhisperer/codescan/CodeWhispererCodeScanManager.kt b/plugins/amazonq/codewhisperer/jetbrains-community/src/software/aws/toolkits/jetbrains/services/codewhisperer/codescan/CodeWhispererCodeScanManager.kt
@@ -282,14 +282,13 @@ class CodeWhispererCodeScanManager(val project: Project) {
                 isProjectScanInProgress.set(false)
             }
             val errorMessage = handleError(coroutineContext, e, scope)
-            codeScanResponseContext = codeScanResponseContext.copy(reasonDesc = errorMessage)
-            codeScanResponseContext = codeScanResponseContext.copy(reason = "DefaultError")
-        } catch (e: CodeScanException) {
+            codeScanResponseContext = codeScanResponseContext.copy(reason = errorMessage)
+        } catch (e: Exception) {
             if (scope == CodeWhispererConstants.CodeAnalysisScope.PROJECT) {
                 isProjectScanInProgress.set(false)
             }
-            codeScanResponseContext = codeScanResponseContext.copy(reasonDesc = handleException(coroutineContext, e, scope))
-            codeScanResponseContext = codeScanResponseContext.copy(reason = e.code ?: "DefaultError")
+            val errorMessage = handleException(coroutineContext, e, scope)
+            codeScanResponseContext = codeScanResponseContext.copy(reason = errorMessage)
         } finally {
             // After code scan
             afterCodeScan(scope)
@@ -338,7 +337,7 @@ class CodeWhispererCodeScanManager(val project: Project) {
     private fun getCodeScanExceptionMessage(e: CodeWhispererCodeScanException): String? {
         val message = e.message
         return when {
-            message.isBlank() -> null
+            message.isNullOrBlank() -> null
             message == message("codewhisperer.codescan.invalid_source_zip_telemetry") -> {
                 message("codewhisperer.codescan.run_scan_error")
             }
@@ -347,12 +346,8 @@ class CodeWhispererCodeScanManager(val project: Project) {
     }
 
     private fun getCodeScanServerExceptionMessage(e: CodeWhispererCodeScanServerException): String? =
-        e.code?.let {
-            when (it) {
-                "UploadArtifactToS3Error" -> message("codewhisperer.codescan.upload_to_s3_failed")
-                else -> null
-            }
-        }
+        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) {
diff --git a/plugins/amazonq/codewhisperer/jetbrains-community/src/software/aws/toolkits/jetbrains/services/codewhisperer/codescan/CodeWhispererCodeScanSession.kt b/plugins/amazonq/codewhisperer/jetbrains-community/src/software/aws/toolkits/jetbrains/services/codewhisperer/codescan/CodeWhispererCodeScanSession.kt
@@ -152,7 +152,7 @@ class CodeWhispererCodeScanSession(val sessionContext: CodeScanSessionContext) {
                     }
                 }
                 val errorMessage = createCodeScanResponse.errorMessage()?.let { it } ?: message("codewhisperer.codescan.run_scan_error_telemetry")
-                codeScanFailed(errorMessage, "CreateCodeScanFailedError")
+                codeScanFailed(errorMessage)
             }
             val jobId = createCodeScanResponse.jobId()
             codeScanResponseContext = codeScanResponseContext.copy(codeScanJobId = jobId)
@@ -189,7 +189,7 @@ class CodeWhispererCodeScanSession(val sessionContext: CodeScanSessionContext) {
                         }
                     }
                     val errorMessage = getCodeScanResponse.errorMessage()?.let { it } ?: message("codewhisperer.codescan.run_scan_error_telemetry")
-                    codeScanFailed(errorMessage, "DefaultError")
+                    codeScanFailed(errorMessage)
                 }
             }
 
@@ -285,7 +285,7 @@ class CodeWhispererCodeScanSession(val sessionContext: CodeScanSessionContext) {
     } catch (e: Exception) {
         LOG.debug { "Create Upload URL failed: ${e.message}" }
         val errorMessage = getTelemetryErrorMessage(e)
-        throw codeScanServerException(errorMessage, "CreateUploadUrlError")
+        throw codeScanServerException("CreateUploadUrlException: $errorMessage")
     }
 
     private fun getUploadIntent(scope: CodeWhispererConstants.CodeAnalysisScope): UploadIntent = when (scope) {
@@ -319,7 +319,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(errorMessage, "UploadArtifactToS3Error")
+            throw codeScanServerException("UploadArtifactToS3Exception: $errorMessage")
         }
     }
 
@@ -342,7 +342,7 @@ class CodeWhispererCodeScanSession(val sessionContext: CodeScanSessionContext) {
         } catch (e: Exception) {
             LOG.debug { "Creating security scan failed: ${e.message}" }
             val errorMessage = getTelemetryErrorMessage(e)
-            throw codeScanServerException(errorMessage, "CreateCodeScanError")
+            throw codeScanServerException("CreateCodeScanException: $errorMessage")
         }
     }
 
@@ -355,7 +355,7 @@ class CodeWhispererCodeScanSession(val sessionContext: CodeScanSessionContext) {
     } catch (e: Exception) {
         LOG.debug { "Getting security scan failed: ${e.message}" }
         val errorMessage = getTelemetryErrorMessage(e)
-        throw codeScanServerException(errorMessage, "GetCodeScanError")
+        throw codeScanServerException("GetCodeScanException: $errorMessage")
     }
 
     fun listCodeScanFindings(jobId: String, nextToken: String?): ListCodeScanFindingsResponse = try {
@@ -369,7 +369,7 @@ class CodeWhispererCodeScanSession(val sessionContext: CodeScanSessionContext) {
     } catch (e: Exception) {
         LOG.debug { "Listing security scan failed: ${e.message}" }
         val errorMessage = getTelemetryErrorMessage(e)
-        throw codeScanServerException(errorMessage, "ListCodeScanFindingsError")
+        throw codeScanServerException("ListCodeScanFindingsException: $errorMessage")
     }
 
     fun mapToCodeScanIssues(recommendations: List<String>): List<CodeWhispererCodeScanIssue> {
diff --git a/plugins/amazonq/codewhisperer/jetbrains-community/src/software/aws/toolkits/jetbrains/services/codewhisperer/model/CodeWhispererModel.kt b/plugins/amazonq/codewhisperer/jetbrains-community/src/software/aws/toolkits/jetbrains/services/codewhisperer/model/CodeWhispererModel.kt
@@ -155,8 +155,7 @@ data class CodeScanResponseContext(
     val codeScanJobId: String? = null,
     val codeScanTotalIssues: Int = 0,
     val codeScanIssuesWithFixes: Int = 0,
-    val reason: String? = null,
-    val reasonDesc: String? = null
+    val reason: String? = null
 )
 
 data class LatencyContext(

Original file line number	Diff line number	Diff line change
`@@ -152,7 +152,7 @@ class CodeWhispererCodeScanSession(val sessionContext: CodeScanSessionContext) {`
`152`	`152`	`}`
`153`	`153`	`}`
`154`	`154`	`val errorMessage = createCodeScanResponse.errorMessage()?.let { it } ?: message("codewhisperer.codescan.run_scan_error_telemetry")`
`155`		`- codeScanFailed(errorMessage, "CreateCodeScanFailedError")`
	`155`	`+ codeScanFailed(errorMessage)`
`156`	`156`	`}`
`157`	`157`	`val jobId = createCodeScanResponse.jobId()`
`158`	`158`	`codeScanResponseContext = codeScanResponseContext.copy(codeScanJobId = jobId)`
`@@ -189,7 +189,7 @@ class CodeWhispererCodeScanSession(val sessionContext: CodeScanSessionContext) {`
`189`	`189`	`}`
`190`	`190`	`}`
`191`	`191`	`val errorMessage = getCodeScanResponse.errorMessage()?.let { it } ?: message("codewhisperer.codescan.run_scan_error_telemetry")`
`192`		`- codeScanFailed(errorMessage, "DefaultError")`
	`192`	`+ codeScanFailed(errorMessage)`
`193`	`193`	`}`
`194`	`194`	`}`
`195`	`195`
`@@ -285,7 +285,7 @@ class CodeWhispererCodeScanSession(val sessionContext: CodeScanSessionContext) {`
`285`	`285`	`} catch (e: Exception) {`
`286`	`286`	`LOG.debug { "Create Upload URL failed: ${e.message}" }`
`287`	`287`	`val errorMessage = getTelemetryErrorMessage(e)`
`288`		`- throw codeScanServerException(errorMessage, "CreateUploadUrlError")`
	`288`	`+ throw codeScanServerException("CreateUploadUrlException: $errorMessage")`
`289`	`289`	`}`
`290`	`290`
`291`	`291`	`private fun getUploadIntent(scope: CodeWhispererConstants.CodeAnalysisScope): UploadIntent = when (scope) {`
`@@ -319,7 +319,7 @@ class CodeWhispererCodeScanSession(val sessionContext: CodeScanSessionContext) {`
`319`	`319`	`} catch (e: Exception) {`
`320`	`320`	`LOG.debug { "Artifact failed to upload in the S3 bucket: ${e.message}" }`
`321`	`321`	`val errorMessage = getTelemetryErrorMessage(e)`
`322`		`- throw codeScanServerException(errorMessage, "UploadArtifactToS3Error")`
	`322`	`+ throw codeScanServerException("UploadArtifactToS3Exception: $errorMessage")`
`323`	`323`	`}`
`324`	`324`	`}`
`325`	`325`
`@@ -342,7 +342,7 @@ class CodeWhispererCodeScanSession(val sessionContext: CodeScanSessionContext) {`
`342`	`342`	`} catch (e: Exception) {`
`343`	`343`	`LOG.debug { "Creating security scan failed: ${e.message}" }`
`344`	`344`	`val errorMessage = getTelemetryErrorMessage(e)`
`345`		`- throw codeScanServerException(errorMessage, "CreateCodeScanError")`
	`345`	`+ throw codeScanServerException("CreateCodeScanException: $errorMessage")`
`346`	`346`	`}`
`347`	`347`	`}`
`348`	`348`
`@@ -355,7 +355,7 @@ class CodeWhispererCodeScanSession(val sessionContext: CodeScanSessionContext) {`
`355`	`355`	`} catch (e: Exception) {`
`356`	`356`	`LOG.debug { "Getting security scan failed: ${e.message}" }`
`357`	`357`	`val errorMessage = getTelemetryErrorMessage(e)`
`358`		`- throw codeScanServerException(errorMessage, "GetCodeScanError")`
	`358`	`+ throw codeScanServerException("GetCodeScanException: $errorMessage")`
`359`	`359`	`}`
`360`	`360`
`361`	`361`	`fun listCodeScanFindings(jobId: String, nextToken: String?): ListCodeScanFindingsResponse = try {`
`@@ -369,7 +369,7 @@ class CodeWhispererCodeScanSession(val sessionContext: CodeScanSessionContext) {`
`369`	`369`	`} catch (e: Exception) {`
`370`	`370`	`LOG.debug { "Listing security scan failed: ${e.message}" }`
`371`	`371`	`val errorMessage = getTelemetryErrorMessage(e)`
`372`		`- throw codeScanServerException(errorMessage, "ListCodeScanFindingsError")`
	`372`	`+ throw codeScanServerException("ListCodeScanFindingsException: $errorMessage")`
`373`	`373`	`}`
`374`	`374`
`375`	`375`	`fun mapToCodeScanIssues(recommendations: List<String>): List<CodeWhispererCodeScanIssue> {`
Original file line number	Diff line number	Diff line change
`@@ -155,8 +155,7 @@ data class CodeScanResponseContext(`
`155`	`155`	`val codeScanJobId: String? = null,`
`156`	`156`	`val codeScanTotalIssues: Int = 0,`
`157`	`157`	`val codeScanIssuesWithFixes: Int = 0,`
`158`		`- val reason: String? = null,`
`159`		`- val reasonDesc: String? = null`
	`158`	`+ val reason: String? = null`
`160`	`159`	`)`
`161`	`160`
`162`	`161`	`data class LatencyContext(`