Fix for disabling unsupported languages in Auto File Scans. (#4428)

ashishrp-aws · web-flow · commit 8f2b7b0cbd02 · 2024-05-08T12:56:40.000-07:00
* Fix for Builder Id users Scan Popup.

* Comment change for Listener information.

* Changelog addition for bug fix.

* Fix for disallowing unsupported languages for auto scans.

* Added bugfix changelog for removing unsupported languages in auto-scans.

* Update CodeWhispererConstants.kt with comment change.

* Updated CodeWhispererConstants.kt to remove Tsx and Jsx

* Update CodeWhispererCodeScanManager.kt for Q connected check update

* Update CodeWhispererConstants.kt to comment change

* additions to programming language for File Scan support per language.

* Updated programming Language Tests.

* Renamed isFileScanSupported to isAutoFileScanSupported.

* Update bugfix-f113429f-6db6-4f09-aa89-a60ef5159691.json to correct changelog

* Added Test case for failure in case of unsupported language.
diff --git a/.changes/next-release/bugfix-f113429f-6db6-4f09-aa89-a60ef5159691.json b/.changes/next-release/bugfix-f113429f-6db6-4f09-aa89-a60ef5159691.json
@@ -0,0 +1,4 @@
+{
+  "type" : "bugfix",
+  "description" : "Amazon Q: Support disabling auto-scan for unsupported languages."
+}
diff --git a/plugins/toolkit/jetbrains-core/src/software/aws/toolkits/jetbrains/services/codewhisperer/codescan/CodeWhispererCodeScanManager.kt b/plugins/toolkit/jetbrains-core/src/software/aws/toolkits/jetbrains/services/codewhisperer/codescan/CodeWhispererCodeScanManager.kt
@@ -62,7 +62,6 @@ import software.aws.toolkits.jetbrains.services.codewhisperer.codescan.sessionco
 import software.aws.toolkits.jetbrains.services.codewhisperer.credentials.CodeWhispererClientAdaptor
 import software.aws.toolkits.jetbrains.services.codewhisperer.editor.CodeWhispererEditorUtil.overlaps
 import software.aws.toolkits.jetbrains.services.codewhisperer.explorer.CodeWhispererExplorerActionManager
-import software.aws.toolkits.jetbrains.services.codewhisperer.explorer.isCodeWhispererEnabled
 import software.aws.toolkits.jetbrains.services.codewhisperer.explorer.isUserBuilderId
 import software.aws.toolkits.jetbrains.services.codewhisperer.language.CodeWhispererProgrammingLanguage
 import software.aws.toolkits.jetbrains.services.codewhisperer.language.languages.CodeWhispererUnknownLanguage
@@ -74,9 +73,9 @@ import software.aws.toolkits.jetbrains.services.codewhisperer.util.CodeWhisperer
 import software.aws.toolkits.jetbrains.services.codewhisperer.util.CodeWhispererConstants.ISSUE_HIGHLIGHT_TEXT_ATTRIBUTES
 import software.aws.toolkits.jetbrains.services.codewhisperer.util.CodeWhispererUtil.promptReAuth
 import software.aws.toolkits.jetbrains.services.codewhisperer.util.runIfIdcConnectionOrTelemetryEnabled
+import software.aws.toolkits.jetbrains.utils.isQConnected
 import software.aws.toolkits.jetbrains.utils.isRunningOnRemoteBackend
 import software.aws.toolkits.resources.message
-import software.aws.toolkits.telemetry.CodewhispererLanguage
 import software.aws.toolkits.telemetry.Result
 import java.time.Duration
 import java.time.Instant
@@ -144,7 +143,7 @@ class CodeWhispererCodeScanManager(val project: Project) {
      * Triggers a code scan and displays results in the new tab in problems view panel.
      */
     fun runCodeScan(scope: CodeWhispererConstants.CodeAnalysisScope) {
-        if (!isCodeWhispererEnabled(project)) return
+        if (!isQConnected(project)) return
 
         // Return if a scan is already in progress.
         if (isProjectScanInProgress() && scope == CodeWhispererConstants.CodeAnalysisScope.PROJECT) return
@@ -227,7 +226,7 @@ class CodeWhispererCodeScanManager(val project: Project) {
             val codeScanSessionConfig = CodeScanSessionConfig.create(file, project, scope)
             language = codeScanSessionConfig.getSelectedFile().programmingLanguage()
             if (scope == CodeWhispererConstants.CodeAnalysisScope.FILE &&
-                (language == CodeWhispererUnknownLanguage.INSTANCE || language.toTelemetryType() == CodewhispererLanguage.Plaintext)
+                !language.isAutoFileScanSupported()
             ) {
                 LOG.debug { "Language is unknown or plaintext, skipping code scan." }
                 codeScanStatus = Result.Cancelled
diff --git a/plugins/toolkit/jetbrains-core/src/software/aws/toolkits/jetbrains/services/codewhisperer/language/CodeWhispererProgrammingLanguage.kt b/plugins/toolkit/jetbrains-core/src/software/aws/toolkits/jetbrains/services/codewhisperer/language/CodeWhispererProgrammingLanguage.kt
@@ -26,6 +26,8 @@ abstract class CodeWhispererProgrammingLanguage {
 
     open fun isCodeScanSupported(): Boolean = false
 
+    open fun isAutoFileScanSupported(): Boolean = false
+
     open fun isImportAdderSupported(): Boolean = false
 
     open fun isSupplementalContextSupported(): Boolean = false
diff --git a/plugins/toolkit/jetbrains-core/src/software/aws/toolkits/jetbrains/services/codewhisperer/language/languages/CodeWhispererC.kt b/plugins/toolkit/jetbrains-core/src/software/aws/toolkits/jetbrains/services/codewhisperer/language/languages/CodeWhispererC.kt
@@ -13,6 +13,10 @@ class CodeWhispererC private constructor() : CodeWhispererProgrammingLanguage()
 
     override fun isCodeCompletionSupported(): Boolean = true
 
+    override fun isCodeScanSupported(): Boolean = true
+
+    override fun isAutoFileScanSupported(): Boolean = true
+
     companion object {
         const val ID = "c"
 
diff --git a/plugins/toolkit/jetbrains-core/src/software/aws/toolkits/jetbrains/services/codewhisperer/language/languages/CodeWhispererCpp.kt b/plugins/toolkit/jetbrains-core/src/software/aws/toolkits/jetbrains/services/codewhisperer/language/languages/CodeWhispererCpp.kt
@@ -13,6 +13,10 @@ class CodeWhispererCpp private constructor() : CodeWhispererProgrammingLanguage(
 
     override fun isCodeCompletionSupported(): Boolean = true
 
+    override fun isCodeScanSupported(): Boolean = true
+
+    override fun isAutoFileScanSupported(): Boolean = true
+
     companion object {
         const val ID = "cpp"
 
diff --git a/plugins/toolkit/jetbrains-core/src/software/aws/toolkits/jetbrains/services/codewhisperer/language/languages/CodeWhispererCsharp.kt b/plugins/toolkit/jetbrains-core/src/software/aws/toolkits/jetbrains/services/codewhisperer/language/languages/CodeWhispererCsharp.kt
@@ -13,6 +13,10 @@ class CodeWhispererCsharp private constructor() : CodeWhispererProgrammingLangua
 
     override fun isCodeCompletionSupported(): Boolean = true
 
+    override fun isCodeScanSupported(): Boolean = true
+
+    override fun isAutoFileScanSupported(): Boolean = true
+
     companion object {
         const val ID = "csharp"
 
diff --git a/plugins/toolkit/jetbrains-core/src/software/aws/toolkits/jetbrains/services/codewhisperer/language/languages/CodeWhispererGo.kt b/plugins/toolkit/jetbrains-core/src/software/aws/toolkits/jetbrains/services/codewhisperer/language/languages/CodeWhispererGo.kt
@@ -13,6 +13,10 @@ class CodeWhispererGo private constructor() : CodeWhispererProgrammingLanguage()
 
     override fun isCodeCompletionSupported(): Boolean = true
 
+    override fun isCodeScanSupported(): Boolean = true
+
+    override fun isAutoFileScanSupported(): Boolean = true
+
     companion object {
         const val ID = "go"
 
diff --git a/plugins/toolkit/jetbrains-core/src/software/aws/toolkits/jetbrains/services/codewhisperer/language/languages/CodeWhispererJava.kt b/plugins/toolkit/jetbrains-core/src/software/aws/toolkits/jetbrains/services/codewhisperer/language/languages/CodeWhispererJava.kt
@@ -18,6 +18,8 @@ class CodeWhispererJava private constructor() : CodeWhispererProgrammingLanguage
 
     override fun isCodeScanSupported(): Boolean = true
 
+    override fun isAutoFileScanSupported(): Boolean = true
+
     override fun isImportAdderSupported(): Boolean = true
 
     override fun isSupplementalContextSupported() = true
diff --git a/plugins/toolkit/jetbrains-core/src/software/aws/toolkits/jetbrains/services/codewhisperer/language/languages/CodeWhispererJavaScript.kt b/plugins/toolkit/jetbrains-core/src/software/aws/toolkits/jetbrains/services/codewhisperer/language/languages/CodeWhispererJavaScript.kt
@@ -16,6 +16,10 @@ class CodeWhispererJavaScript private constructor() : CodeWhispererProgrammingLa
 
     override fun isCodeCompletionSupported(): Boolean = true
 
+    override fun isCodeScanSupported(): Boolean = true
+
+    override fun isAutoFileScanSupported(): Boolean = true
+
     override fun isImportAdderSupported(): Boolean = true
 
     override fun isSupplementalContextSupported() = true
diff --git a/plugins/toolkit/jetbrains-core/src/software/aws/toolkits/jetbrains/services/codewhisperer/language/languages/CodeWhispererJson.kt b/plugins/toolkit/jetbrains-core/src/software/aws/toolkits/jetbrains/services/codewhisperer/language/languages/CodeWhispererJson.kt
@@ -13,6 +13,10 @@ class CodeWhispererJson private constructor() : CodeWhispererProgrammingLanguage
 
     override fun isCodeCompletionSupported(): Boolean = true
 
+    override fun isCodeScanSupported(): Boolean = true
+
+    override fun isAutoFileScanSupported(): Boolean = true
+
     companion object {
         const val ID = "json"
 
diff --git a/plugins/toolkit/jetbrains-core/src/software/aws/toolkits/jetbrains/services/codewhisperer/language/languages/CodeWhispererPhp.kt b/plugins/toolkit/jetbrains-core/src/software/aws/toolkits/jetbrains/services/codewhisperer/language/languages/CodeWhispererPhp.kt
@@ -13,6 +13,10 @@ class CodeWhispererPhp private constructor() : CodeWhispererProgrammingLanguage(
 
     override fun isCodeCompletionSupported(): Boolean = true
 
+    override fun isCodeScanSupported(): Boolean = true
+
+    override fun isAutoFileScanSupported(): Boolean = true
+
     companion object {
         const val ID = "php"
 
diff --git a/plugins/toolkit/jetbrains-core/src/software/aws/toolkits/jetbrains/services/codewhisperer/language/languages/CodeWhispererPlainText.kt b/plugins/toolkit/jetbrains-core/src/software/aws/toolkits/jetbrains/services/codewhisperer/language/languages/CodeWhispererPlainText.kt
@@ -11,6 +11,10 @@ class CodeWhispererPlainText private constructor() : CodeWhispererProgrammingLan
 
     override fun toTelemetryType(): CodewhispererLanguage = CodewhispererLanguage.Plaintext
 
+    override fun isCodeScanSupported(): Boolean = true
+
+    override fun isAutoFileScanSupported(): Boolean = true
+
     companion object {
         const val ID = "plaintext"
 
diff --git a/plugins/toolkit/jetbrains-core/src/software/aws/toolkits/jetbrains/services/codewhisperer/language/languages/CodeWhispererPython.kt b/plugins/toolkit/jetbrains-core/src/software/aws/toolkits/jetbrains/services/codewhisperer/language/languages/CodeWhispererPython.kt
@@ -18,6 +18,8 @@ class CodeWhispererPython private constructor() : CodeWhispererProgrammingLangua
 
     override fun isCodeScanSupported(): Boolean = true
 
+    override fun isAutoFileScanSupported(): Boolean = true
+
     override fun isImportAdderSupported(): Boolean = true
 
     override fun isUTGSupported() = true
diff --git a/plugins/toolkit/jetbrains-core/src/software/aws/toolkits/jetbrains/services/codewhisperer/language/languages/CodeWhispererRuby.kt b/plugins/toolkit/jetbrains-core/src/software/aws/toolkits/jetbrains/services/codewhisperer/language/languages/CodeWhispererRuby.kt
@@ -13,6 +13,10 @@ class CodeWhispererRuby private constructor() : CodeWhispererProgrammingLanguage
 
     override fun isCodeCompletionSupported(): Boolean = true
 
+    override fun isCodeScanSupported(): Boolean = true
+
+    override fun isAutoFileScanSupported(): Boolean = true
+
     companion object {
         const val ID = "ruby"
 
diff --git a/plugins/toolkit/jetbrains-core/src/software/aws/toolkits/jetbrains/services/codewhisperer/language/languages/CodeWhispererTf.kt b/plugins/toolkit/jetbrains-core/src/software/aws/toolkits/jetbrains/services/codewhisperer/language/languages/CodeWhispererTf.kt
@@ -13,6 +13,10 @@ class CodeWhispererTf private constructor() : CodeWhispererProgrammingLanguage()
 
     override fun isCodeCompletionSupported(): Boolean = true
 
+    override fun isCodeScanSupported(): Boolean = true
+
+    override fun isAutoFileScanSupported(): Boolean = true
+
     companion object {
         const val ID = "tf"
 
diff --git a/plugins/toolkit/jetbrains-core/src/software/aws/toolkits/jetbrains/services/codewhisperer/language/languages/CodeWhispererTypeScript.kt b/plugins/toolkit/jetbrains-core/src/software/aws/toolkits/jetbrains/services/codewhisperer/language/languages/CodeWhispererTypeScript.kt
@@ -16,6 +16,10 @@ class CodeWhispererTypeScript private constructor() : CodeWhispererProgrammingLa
 
     override fun isCodeCompletionSupported(): Boolean = true
 
+    override fun isCodeScanSupported(): Boolean = true
+
+    override fun isAutoFileScanSupported(): Boolean = true
+
     override fun isSupplementalContextSupported() = true
 
     companion object {
diff --git a/plugins/toolkit/jetbrains-core/src/software/aws/toolkits/jetbrains/services/codewhisperer/language/languages/CodeWhispererYaml.kt b/plugins/toolkit/jetbrains-core/src/software/aws/toolkits/jetbrains/services/codewhisperer/language/languages/CodeWhispererYaml.kt
@@ -13,6 +13,10 @@ class CodeWhispererYaml private constructor() : CodeWhispererProgrammingLanguage
 
     override fun isCodeCompletionSupported(): Boolean = true
 
+    override fun isCodeScanSupported(): Boolean = true
+
+    override fun isAutoFileScanSupported(): Boolean = true
+
     companion object {
         const val ID = "yaml"
 
diff --git a/plugins/toolkit/jetbrains-core/tst/software/aws/toolkits/jetbrains/services/codewhisperer/CodeWhispererLanguageManagerTest.kt b/plugins/toolkit/jetbrains-core/tst/software/aws/toolkits/jetbrains/services/codewhisperer/CodeWhispererLanguageManagerTest.kt
@@ -137,6 +137,22 @@ class CodeWhispererProgrammingLanguageTest {
             val shouldSupportSecurityScan = when (telemetryType) {
                 CodewhispererLanguage.Java -> true
                 CodewhispererLanguage.Python -> true
+                CodewhispererLanguage.Javascript -> true
+                CodewhispererLanguage.Typescript -> true
+                CodewhispererLanguage.Kotlin -> true
+                CodewhispererLanguage.Go -> true
+                CodewhispererLanguage.Php -> true
+                CodewhispererLanguage.Ruby -> true
+                CodewhispererLanguage.C -> true
+                CodewhispererLanguage.Cpp -> true
+                CodewhispererLanguage.Csharp -> true
+                CodewhispererLanguage.Plaintext -> true
+                CodewhispererLanguage.Tf -> true
+                CodewhispererLanguage.Yaml -> true
+                CodewhispererLanguage.Yml -> true
+                CodewhispererLanguage.Hcl -> true
+                CodewhispererLanguage.Json -> true
+                CodewhispererLanguage.Jsonc -> true
                 else -> false
             }
 
diff --git a/plugins/toolkit/jetbrains-core/tst/software/aws/toolkits/jetbrains/services/codewhisperer/codescan/CodeWhispererCodeFileScanTest.kt b/plugins/toolkit/jetbrains-core/tst/software/aws/toolkits/jetbrains/services/codewhisperer/codescan/CodeWhispererCodeFileScanTest.kt
@@ -3,14 +3,22 @@
 
 package software.aws.toolkits.jetbrains.services.codewhisperer.codescan
 
+import com.intellij.openapi.fileEditor.FileEditor
+import com.intellij.openapi.fileEditor.FileEditorManager
+import com.intellij.openapi.vfs.VirtualFile
 import com.intellij.psi.PsiFile
+import com.intellij.testFramework.replaceService
 import kotlinx.coroutines.delay
 import kotlinx.coroutines.runBlocking
 import org.apache.commons.codec.digest.DigestUtils
 import org.assertj.core.api.Assertions.assertThat
 import org.junit.Before
 import org.junit.Test
 import org.mockito.ArgumentMatchers.anyString
+import org.mockito.Mockito
+import org.mockito.Mockito.mock
+import org.mockito.Mockito.times
+import org.mockito.Mockito.`when`
 import org.mockito.internal.verification.Times
 import org.mockito.kotlin.any
 import org.mockito.kotlin.argumentCaptor
@@ -43,9 +51,13 @@ import kotlin.test.assertNotNull
 class CodeWhispererCodeFileScanTest : CodeWhispererCodeScanTestBase(PythonCodeInsightTestFixtureRule()) {
     private lateinit var psifile: PsiFile
     private lateinit var psifile2: PsiFile
+    private lateinit var psifile3: PsiFile
     private lateinit var file: File
     private lateinit var file2: File
+    private lateinit var file3: File
+    private lateinit var virtualFile3: VirtualFile
     private lateinit var sessionConfigSpy: CodeScanSessionConfig
+    private lateinit var sessionConfigSpy2: CodeScanSessionConfig
     private val payloadContext = PayloadContext(CodewhispererLanguage.Python, 1, 1, 10, listOf(), 600, 200)
     private lateinit var codeScanSessionContext: CodeScanSessionContext
     private lateinit var codeScanSessionSpy: CodeWhispererCodeScanSession
@@ -84,13 +96,37 @@ class CodeWhispererCodeFileScanTest : CodeWhispererCodeScanTestBase(PythonCodeIn
         )
         file = psifile.virtualFile.toNioPath().toFile()
 
+        psifile3 = projectRule.fixture.addFileToProject(
+            "/test.kt",
+            // write simple addition function in kotlin
+            """
+                fun main() {
+                    val a = 1
+                    val b = 2
+                    val c = a + b
+                    println(c)
+                }
+            """.trimMargin()
+        )
+        virtualFile3 = psifile3.virtualFile
+        file3 = virtualFile3.toNioPath().toFile()
+
         sessionConfigSpy = spy(
             CodeScanSessionConfig.create(
                 psifile.virtualFile,
                 project,
                 CodeWhispererConstants.CodeAnalysisScope.FILE
             )
         )
+
+        sessionConfigSpy2 = spy(
+            CodeScanSessionConfig.create(
+                virtualFile3,
+                project,
+                CodeWhispererConstants.CodeAnalysisScope.FILE
+            )
+        )
+
         setupResponse(psifile.virtualFile.toNioPath().relativeTo(sessionConfigSpy.projectRoot.toNioPath()))
 
         sessionConfigSpy.stub {
@@ -173,6 +209,28 @@ class CodeWhispererCodeFileScanTest : CodeWhispererCodeScanTestBase(PythonCodeIn
         inOrder.verify(codeScanSessionSpy, Times(1)).listCodeScanFindings(eq("jobId"), eq(null))
     }
 
+    @Test
+    fun `unsupported languages file scan fail`() {
+        scanManagerSpy = Mockito.spy(CodeWhispererCodeScanManager.getInstance(projectRule.project))
+        projectRule.project.replaceService(CodeWhispererCodeScanManager::class.java, scanManagerSpy, disposableRule.disposable)
+
+        val fileEditorManager = mock(FileEditorManager::class.java)
+        val selectedEditor = mock(FileEditor::class.java)
+        val editorList: MutableList<FileEditor> = mutableListOf(selectedEditor)
+
+        `when`(fileEditorManager.selectedEditorWithRemotes).thenReturn(editorList)
+        `when`(fileEditorManager.selectedEditor).thenReturn(selectedEditor)
+        `when`(selectedEditor.file).thenReturn(virtualFile3)
+
+        runBlocking {
+            scanManagerSpy.runCodeScan(CodeWhispererConstants.CodeAnalysisScope.FILE)
+        }
+        // verify that function was run but none of the results/error handling methods were called.
+        verify(scanManagerSpy, times(0)).updateFileIssues(any(), any())
+        verify(scanManagerSpy, times(0)).handleError(any(), any(), any())
+        verify(scanManagerSpy, times(0)).handleException(any(), any(), any())
+    }
+
     @Test
     fun `test run() - file scans limit reached`() {
         assertNotNull(sessionConfigSpy)

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +{
 +  "type" : "bugfix",
 +  "description" : "Amazon Q: Support disabling auto-scan for unsupported languages."
 +}