CM-44180 - Add proper support for disabled modules (#85)

MarshalX · web-flow · commit 77b0f91b1edb · 2025-02-03T13:13:58.000+01:00
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -89,7 +89,7 @@ jobs:
           echo "filename=${FILENAME:0:-4}" >> $GITHUB_OUTPUT
 
       - name: Upload artifact
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: ${{ steps.artifact.outputs.filename }}
           path: ./build/distributions/content/*/*
@@ -125,7 +125,7 @@ jobs:
       #
       #      - name: Collect Tests Result
       #        if: ${{ failure() }}
-      #        uses: actions/upload-artifact@v3
+      #        uses: actions/upload-artifact@v4
       #        with:
       #          name: tests-result
       #          path: ${{ github.workspace }}/build/reports/tests
@@ -205,7 +205,7 @@ jobs:
 
       - name: Collect Plugin Verifier Result
         if: ${{ always() }}
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: pluginVerifier-result
           path: ${{ github.workspace }}/build/reports/pluginVerifier
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,8 @@
 
 ## [Unreleased]
 
+- Add proper support for disabled modules
+
 ## [2.4.1] - 2025-01-29
 
 - Fix usage of internal API in 2025.1
diff --git a/src/main/kotlin/com/cycode/plugin/annotators/annotationAppliers/IacApplier.kt b/src/main/kotlin/com/cycode/plugin/annotators/annotationAppliers/IacApplier.kt
@@ -21,7 +21,7 @@ class IacApplier(private val scanResults: ScanResultsService) : AnnotationApplie
     }
 
     override fun apply(psiFile: PsiFile, holder: AnnotationHolder) {
-        val latestScanResult = scanResults.getIacResults()
+        val latestScanResult = scanResults.iacResults
         if (latestScanResult !is CliResult.Success) {
             return
         }
diff --git a/src/main/kotlin/com/cycode/plugin/annotators/annotationAppliers/SastApplier.kt b/src/main/kotlin/com/cycode/plugin/annotators/annotationAppliers/SastApplier.kt
@@ -20,7 +20,7 @@ class SastApplier(private val scanResults: ScanResultsService) : AnnotationAppli
     }
 
     override fun apply(psiFile: PsiFile, holder: AnnotationHolder) {
-        val latestScanResult = scanResults.getSastResults()
+        val latestScanResult = scanResults.sastResults
         if (latestScanResult !is CliResult.Success) {
             return
         }
diff --git a/src/main/kotlin/com/cycode/plugin/annotators/annotationAppliers/ScaApplier.kt b/src/main/kotlin/com/cycode/plugin/annotators/annotationAppliers/ScaApplier.kt
@@ -31,7 +31,7 @@ class ScaApplier(private val scanResults: ScanResultsService) : AnnotationApplie
     }
 
     override fun apply(psiFile: PsiFile, holder: AnnotationHolder) {
-        val latestScanResult = scanResults.getScaResults()
+        val latestScanResult = scanResults.scaResults
         if (latestScanResult !is CliResult.Success) {
             return
         }
diff --git a/src/main/kotlin/com/cycode/plugin/annotators/annotationAppliers/SecretApplier.kt b/src/main/kotlin/com/cycode/plugin/annotators/annotationAppliers/SecretApplier.kt
@@ -31,7 +31,7 @@ class SecretApplier(private val scanResults: ScanResultsService) : AnnotationApp
     }
 
     override fun apply(psiFile: PsiFile, holder: AnnotationHolder) {
-        val latestScanResult = scanResults.getSecretResults()
+        val latestScanResult = scanResults.secretResults
         if (latestScanResult !is CliResult.Success) {
             return
         }
diff --git a/src/main/kotlin/com/cycode/plugin/cli/models/StatusResult.kt b/src/main/kotlin/com/cycode/plugin/cli/models/StatusResult.kt
@@ -1,7 +1,6 @@
 package com.cycode.plugin.cli.models
 
 data class SupportedModulesStatus(
-    // TODO(MarshalX): respect enabled/disabled scanning modules
     val secretScanning: Boolean,
     val scaScanning: Boolean,
     val iacScanning: Boolean,
diff --git a/src/main/kotlin/com/cycode/plugin/components/toolWindow/CycodeToolWindowFactory.kt b/src/main/kotlin/com/cycode/plugin/components/toolWindow/CycodeToolWindowFactory.kt
@@ -7,7 +7,7 @@ import com.cycode.plugin.components.toolWindow.components.loadingContentTab.Load
 import com.cycode.plugin.components.toolWindow.components.scanContentTab.ScanContentTab
 import com.cycode.plugin.icons.PluginIcons
 import com.cycode.plugin.services.cycode
-import com.cycode.plugin.services.pluginState
+import com.cycode.plugin.services.pluginLocalState
 import com.intellij.openapi.application.ApplicationManager
 import com.intellij.openapi.application.WriteAction
 import com.intellij.openapi.project.DumbAware
@@ -75,21 +75,21 @@ private fun createToolWindowContent(component: JPanel): Content {
 
 fun getRightPanelDependingOnState(project: Project): JPanel {
     val service = cycode(project)
-    val pluginState = pluginState()
+    val pluginLocalState = pluginLocalState(project)
 
-    if (!pluginState.cliInstalled) {
+    if (!pluginLocalState.cliInstalled) {
         return LoadingContentTab().getContent(service)
     }
 
-    return if (pluginState.cliAuthed) {
+    return if (pluginLocalState.cliAuthed) {
         ScanContentTab().getContent(service)
     } else {
         AuthContentTab().getContent(service)
     }
 }
 
 fun updateToolWindowStateForAllProjects() {
-    // we are using this method to sync the state of the tool window for all open projects
+    // we are using this method to sync the state of the tool window for all open projects,
     // for example, after changing the auth state
     ApplicationManager.getApplication().runReadAction {
         val projects = ProjectManager.getInstance().openProjects
diff --git a/src/main/kotlin/com/cycode/plugin/components/toolWindow/components/cycodeActionToolBar/actions/RunAllAction.kt b/src/main/kotlin/com/cycode/plugin/components/toolWindow/components/cycodeActionToolBar/actions/RunAllAction.kt
@@ -3,7 +3,7 @@ package com.cycode.plugin.components.toolWindow.components.cycodeActionToolBar.a
 import com.cycode.plugin.CycodeBundle
 import com.cycode.plugin.cli.CliScanType
 import com.cycode.plugin.services.cycode
-import com.cycode.plugin.services.pluginState
+import com.cycode.plugin.services.pluginLocalState
 import com.intellij.icons.AllIcons
 import com.intellij.openapi.actionSystem.ActionUpdateThread
 import com.intellij.openapi.actionSystem.AnActionEvent
@@ -27,16 +27,25 @@ class RunAllAction :
         //  we can provide "stop" action only after that
         val project = e.project ?: return
         val service = cycode(project)
+        val pluginLocalState = pluginLocalState(project)
 
-        service.startScanForCurrentProject(CliScanType.Secret)
-        service.startScanForCurrentProject(CliScanType.Sca)
-        service.startScanForCurrentProject(CliScanType.Iac)
-        service.startScanForCurrentProject(CliScanType.Sast)
+        if (pluginLocalState.isSecretScanningEnabled) {
+            service.startScanForCurrentProject(CliScanType.Secret)
+        }
+        if (pluginLocalState.isScaScanningEnabled) {
+            service.startScanForCurrentProject(CliScanType.Sca)
+        }
+        if (pluginLocalState.isIacScanningEnabled) {
+            service.startScanForCurrentProject(CliScanType.Iac)
+        }
+        if (pluginLocalState.isSastScanningEnabled) {
+            service.startScanForCurrentProject(CliScanType.Sast)
+        }
     }
 
     override fun update(e: AnActionEvent) {
         e.presentation.isEnabled = e.project != null &&
                 !e.project!!.isDisposed &&
-                pluginState().cliAuthed
+                pluginLocalState(e.project).cliAuthed
     }
 }
diff --git a/src/main/kotlin/com/cycode/plugin/components/toolWindow/components/scanContentTab/ScanContentTab.kt b/src/main/kotlin/com/cycode/plugin/components/toolWindow/components/scanContentTab/ScanContentTab.kt
@@ -5,6 +5,7 @@ import com.cycode.plugin.cli.CliScanType
 import com.cycode.plugin.components.Component
 import com.cycode.plugin.components.common.createClickableLabel
 import com.cycode.plugin.services.CycodeService
+import com.cycode.plugin.services.pluginLocalState
 import com.intellij.util.ui.JBUI
 import java.awt.GridBagConstraints
 import java.awt.GridBagLayout
@@ -27,24 +28,31 @@ class ScanContentTab : Component<CycodeService>() {
     }
 
     override fun getContent(service: CycodeService): JPanel {
+        // do not get local state on class level because will be outdated
+        val pluginLocalState = pluginLocalState(service.project)
+
         addComponentToPanel(createClickableLabel(CycodeBundle.message("scanTabTitleLabel")))
         addComponentToPanel(
             JButton(CycodeBundle.message("scanTabSecretsBtn")).apply {
+                isEnabled = pluginLocalState.isSecretScanningEnabled
                 addActionListener { service.startScanForCurrentProject(CliScanType.Secret) }
             },
         )
         addComponentToPanel(
             JButton(CycodeBundle.message("scanTabScaBtn")).apply {
+                isEnabled = pluginLocalState.isScaScanningEnabled
                 addActionListener { service.startScanForCurrentProject(CliScanType.Sca) }
             },
         )
         addComponentToPanel(
             JButton(CycodeBundle.message("scanTabIacBtn")).apply {
+                isEnabled = pluginLocalState.isIacScanningEnabled
                 addActionListener { service.startScanForCurrentProject(CliScanType.Iac) }
             },
         )
         addComponentToPanel(
             JButton(CycodeBundle.message("scanTabSastBtn")).apply {
+                isEnabled = pluginLocalState.isSastScanningEnabled
                 addActionListener { service.startScanForCurrentProject(CliScanType.Sast) }
             },
         )
diff --git a/src/main/kotlin/com/cycode/plugin/components/toolWindow/components/treeView/TreeView.kt b/src/main/kotlin/com/cycode/plugin/components/toolWindow/components/treeView/TreeView.kt
@@ -182,7 +182,7 @@ class TreeView(
     }
 
     private fun createSecretDetectionNodes() {
-        val secretDetections = scanResults.getSecretResults()
+        val secretDetections = scanResults.secretResults
         if (secretDetections !is CliResult.Success) {
             return
         }
@@ -201,7 +201,7 @@ class TreeView(
     }
 
     private fun createScaDetectionNodes() {
-        val scaDetections = scanResults.getScaResults()
+        val scaDetections = scanResults.scaResults
         if (scaDetections !is CliResult.Success) {
             return
         }
@@ -220,7 +220,7 @@ class TreeView(
     }
 
     private fun createIacDetectionNodes() {
-        val iacDetections = scanResults.getIacResults()
+        val iacDetections = scanResults.iacResults
         if (iacDetections !is CliResult.Success) {
             return
         }
@@ -239,7 +239,7 @@ class TreeView(
     }
 
     private fun createSastDetectionNodes() {
-        val sastDetections = scanResults.getSastResults()
+        val sastDetections = scanResults.sastResults
         if (sastDetections !is CliResult.Success) {
             return
         }
diff --git a/src/main/kotlin/com/cycode/plugin/components/toolWindow/components/violationCardContentTab/iacViolationCardContentTab/IacViolationCardContentTab.kt b/src/main/kotlin/com/cycode/plugin/components/toolWindow/components/violationCardContentTab/iacViolationCardContentTab/IacViolationCardContentTab.kt
@@ -11,13 +11,13 @@ import com.cycode.plugin.components.toolWindow.components.violationCardContentTa
 import com.cycode.plugin.components.toolWindow.components.violationCardContentTab.iacViolationCardContentTab.components.shortSummary.IacShortSummary
 import com.cycode.plugin.components.toolWindow.components.violationCardContentTab.iacViolationCardContentTab.components.summary.IacSummary
 import com.cycode.plugin.components.toolWindow.components.violationCardContentTab.iacViolationCardContentTab.components.title.IacTitle
-import com.cycode.plugin.services.pluginState
+import com.cycode.plugin.services.pluginLocalState
 import com.intellij.openapi.project.Project
 import javax.swing.JComponent
 
 class IacViolationCardContentTab(val project: Project) : CommonViolationCardContentTab() {
     fun getContent(detection: IacDetection): JComponent {
-        val pluginState = pluginState()
+        val pluginLocalState = pluginLocalState(project)
 
         val titlePanel = IacTitle().getContent(detection)
         val shortSummaryPanel = IacShortSummary().getContent(detection)
@@ -35,7 +35,7 @@ class IacViolationCardContentTab(val project: Project) : CommonViolationCardCont
             cycodeGuidelines,
         )
 
-        if (pluginState.isAiLargeLanguageModelEnabled) {
+        if (pluginLocalState.isAiLargeLanguageModelEnabled) {
             val aiRemediationComponent = CardHtmlSummary(CycodeBundle.message("violationCardAiRemediationTitle"))
             val actionsPanel = IacActions(project).addContent(detection, aiRemediationComponent)
             componentsToRender.add(aiRemediationComponent.getContent())
diff --git a/src/main/kotlin/com/cycode/plugin/components/toolWindow/components/violationCardContentTab/sastViolationCardContentTab/SastViolationCardContentTab.kt b/src/main/kotlin/com/cycode/plugin/components/toolWindow/components/violationCardContentTab/sastViolationCardContentTab/SastViolationCardContentTab.kt
@@ -11,13 +11,13 @@ import com.cycode.plugin.components.toolWindow.components.violationCardContentTa
 import com.cycode.plugin.components.toolWindow.components.violationCardContentTab.sastViolationCardContentTab.components.shortSummary.SastShortSummary
 import com.cycode.plugin.components.toolWindow.components.violationCardContentTab.sastViolationCardContentTab.components.summary.SastSummary
 import com.cycode.plugin.components.toolWindow.components.violationCardContentTab.sastViolationCardContentTab.components.title.SastTitle
-import com.cycode.plugin.services.pluginState
+import com.cycode.plugin.services.pluginLocalState
 import com.intellij.openapi.project.Project
 import javax.swing.JComponent
 
 class SastViolationCardContentTab(val project: Project) : CommonViolationCardContentTab() {
     fun getContent(detection: SastDetection): JComponent {
-        val pluginState = pluginState()
+        val pluginLocalState = pluginLocalState(project)
 
         val titlePanel = SastTitle().getContent(detection)
         val shortSummaryPanel = SastShortSummary().getContent(detection)
@@ -35,7 +35,7 @@ class SastViolationCardContentTab(val project: Project) : CommonViolationCardCon
             cycodeGuidelines,
         )
 
-        if (pluginState.isAiLargeLanguageModelEnabled) {
+        if (pluginLocalState.isAiLargeLanguageModelEnabled) {
             val aiRemediationComponent = CardHtmlSummary(CycodeBundle.message("violationCardAiRemediationTitle"))
             val actionsPanel = SastActions(project).addContent(detection, aiRemediationComponent)
             componentsToRender.add(aiRemediationComponent.getContent())
diff --git a/src/main/kotlin/com/cycode/plugin/listeners/FileSaveListener.kt b/src/main/kotlin/com/cycode/plugin/listeners/FileSaveListener.kt
@@ -5,8 +5,8 @@ import com.cycode.plugin.cli.CliScanType
 import com.cycode.plugin.cli.isSupportedIacFile
 import com.cycode.plugin.cli.isSupportedPackageFile
 import com.cycode.plugin.services.cycode
+import com.cycode.plugin.services.pluginLocalState
 import com.cycode.plugin.services.pluginSettings
-import com.cycode.plugin.services.pluginState
 import com.intellij.openapi.diagnostic.thisLogger
 import com.intellij.openapi.editor.Document
 import com.intellij.openapi.fileEditor.FileDocumentManager
@@ -20,7 +20,7 @@ import java.util.concurrent.TimeUnit
 
 class FileSaveListener(private val project: Project) : FileDocumentManagerListener {
     private val service = cycode(project)
-    private val pluginState = pluginState()
+    private val pluginLocalState = pluginLocalState(project)
     private val pluginSettings = pluginSettings()
     private val collectedPathsToScan = mutableSetOf<String>() // we use a set to avoid duplicates
 
@@ -33,21 +33,21 @@ class FileSaveListener(private val project: Project) : FileDocumentManagerListen
         val pathsToScan = excludeNotExistingPaths(collectedPathsToScan.toMutableList())
         collectedPathsToScan.clear()
 
-        if (!pluginState.cliAuthed) {
+        if (!pluginLocalState.cliAuthed) {
             return
         }
 
-        if (pathsToScan.isNotEmpty()) {
+        if (pluginLocalState.isSecretScanningEnabled && pathsToScan.isNotEmpty()) {
             service.startScan(CliScanType.Secret, pathsToScan, onDemand = false)
         }
 
         val scaPathsToScan = excludeNonScaRelatedPaths(pathsToScan)
-        if (scaPathsToScan.isNotEmpty()) {
+        if (pluginLocalState.isScaScanningEnabled && scaPathsToScan.isNotEmpty()) {
             service.startScan(CliScanType.Sca, scaPathsToScan, onDemand = false)
         }
 
         val iacPathsToScan = excludeNonIacRelatedPaths(pathsToScan)
-        if (iacPathsToScan.isNotEmpty()) {
+        if (pluginLocalState.isIacScanningEnabled && iacPathsToScan.isNotEmpty()) {
             service.startScan(CliScanType.Iac, iacPathsToScan, onDemand = false)
         }
     }
@@ -78,7 +78,7 @@ class FileSaveListener(private val project: Project) : FileDocumentManagerListen
     override fun beforeDocumentSaving(document: Document) {
         thisLogger().debug("FileSaveListener.beforeDocumentSaving")
 
-        if (!pluginSettings.scanOnSave || !pluginState.cliAuthed) {
+        if (!pluginSettings.scanOnSave || !pluginLocalState.cliAuthed) {
             return
         }
 
diff --git a/src/main/kotlin/com/cycode/plugin/services/CliService.kt b/src/main/kotlin/com/cycode/plugin/services/CliService.kt
diff --git a/src/main/kotlin/com/cycode/plugin/services/CycodePersistentStateService.kt b/src/main/kotlin/com/cycode/plugin/services/CycodePersistentStateService.kt
diff --git a/src/main/kotlin/com/cycode/plugin/services/CycodeService.kt b/src/main/kotlin/com/cycode/plugin/services/CycodeService.kt
diff --git a/src/main/kotlin/com/cycode/plugin/services/CycodeTemporaryStateService.kt b/src/main/kotlin/com/cycode/plugin/services/CycodeTemporaryStateService.kt
diff --git a/src/main/kotlin/com/cycode/plugin/services/ScanResultsService.kt b/src/main/kotlin/com/cycode/plugin/services/ScanResultsService.kt
diff --git a/src/main/kotlin/com/cycode/plugin/services/Services.kt b/src/main/kotlin/com/cycode/plugin/services/Services.kt

Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@ class IacApplier(private val scanResults: ScanResultsService) : AnnotationApplie`
`21`	`21`	`}`
`22`	`22`
`23`	`23`	`override fun apply(psiFile: PsiFile, holder: AnnotationHolder) {`
`24`		`- val latestScanResult = scanResults.getIacResults()`
	`24`	`+ val latestScanResult = scanResults.iacResults`
`25`	`25`	`if (latestScanResult !is CliResult.Success) {`
`26`	`26`	`return`
`27`	`27`	`}`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@ class SastApplier(private val scanResults: ScanResultsService) : AnnotationAppli`
`20`	`20`	`}`
`21`	`21`
`22`	`22`	`override fun apply(psiFile: PsiFile, holder: AnnotationHolder) {`
`23`		`- val latestScanResult = scanResults.getSastResults()`
	`23`	`+ val latestScanResult = scanResults.sastResults`
`24`	`24`	`if (latestScanResult !is CliResult.Success) {`
`25`	`25`	`return`
`26`	`26`	`}`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ class ScaApplier(private val scanResults: ScanResultsService) : AnnotationApplie`
`31`	`31`	`}`
`32`	`32`
`33`	`33`	`override fun apply(psiFile: PsiFile, holder: AnnotationHolder) {`
`34`		`- val latestScanResult = scanResults.getScaResults()`
	`34`	`+ val latestScanResult = scanResults.scaResults`
`35`	`35`	`if (latestScanResult !is CliResult.Success) {`
`36`	`36`	`return`
`37`	`37`	`}`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ class SecretApplier(private val scanResults: ScanResultsService) : AnnotationApp`
`31`	`31`	`}`
`32`	`32`
`33`	`33`	`override fun apply(psiFile: PsiFile, holder: AnnotationHolder) {`
`34`		`- val latestScanResult = scanResults.getSecretResults()`
	`34`	`+ val latestScanResult = scanResults.secretResults`
`35`	`35`	`if (latestScanResult !is CliResult.Success) {`
`36`	`36`	`return`
`37`	`37`	`}`