Merge branch 'main' of github.com:advanced-security/SARIF-viewer

adrienpessu · adrienpessu · commit 370e2f66d402 · 2024-01-19T10:42:58.000+01:00
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -203,7 +203,7 @@ jobs:
 
       # Cache Plugin Verifier IDEs
       - name: Setup Plugin Verifier IDEs Cache
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: ${{ needs.build.outputs.pluginVerifierHomeDir }}/ides
           key: plugin-verifier-${{ hashFiles('build/listProductsReleases.txt') }}
diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
@@ -5,7 +5,7 @@ annotations = "24.1.0"
 # plugins
 kotlin = "1.9.22"
 changelog = "2.2.0"
-gradleIntelliJPlugin = "1.16.1"
+gradleIntelliJPlugin = "1.17.0"
 qodana = "0.1.13"
 kover = "0.7.5"
 
diff --git a/src/main/kotlin/com/github/adrienpessu/sarifviewer/actions/OpenLocalAction.kt b/src/main/kotlin/com/github/adrienpessu/sarifviewer/actions/OpenLocalAction.kt
@@ -7,9 +7,6 @@ import com.intellij.openapi.actionSystem.AnActionEvent
 class OpenLocalAction : AnAction("Open local Sarif file") {
 
     var myToolWindow: SarifViewerWindowFactory.MyToolWindow? = null
-        set(value) {
-            field = value
-        }
 
     override fun actionPerformed(e: AnActionEvent) {
         myToolWindow?.openLocalFile()
diff --git a/src/main/kotlin/com/github/adrienpessu/sarifviewer/actions/RefreshAction.kt b/src/main/kotlin/com/github/adrienpessu/sarifviewer/actions/RefreshAction.kt
@@ -7,9 +7,6 @@ import com.intellij.openapi.actionSystem.AnActionEvent
 
 class RefreshAction : AnAction("Refresh from GitHub") {
     var myToolWindow: SarifViewerWindowFactory.MyToolWindow? = null
-        set(value) {
-            field = value
-        }
 
     override fun actionPerformed(e: AnActionEvent) {
         val gitHubInstance = myToolWindow?.github?: throw SarifViewerException.INVALID_REPOSITORY
diff --git a/src/main/kotlin/com/github/adrienpessu/sarifviewer/configurable/SettingComponent.kt b/src/main/kotlin/com/github/adrienpessu/sarifviewer/configurable/SettingComponent.kt
@@ -34,26 +34,26 @@ class SettingComponent {
     }
 
     fun getGhTokenText(): String {
-        return ghTokenText.getText()
+        return ghTokenText.text
     }
 
     fun setGhTokenText(newText: String) {
-        ghTokenText.setText(newText)
+        ghTokenText.text = newText
     }
 
     fun getGhesHostnameText(): String {
-        return ghesHostnameText.getText()
+        return ghesHostnameText.text
     }
 
     fun getGhesTokenText(): String {
-        return ghesTokenText.getText()
+        return ghesTokenText.text
     }
 
     fun setGhesHostnameText(newText: String) {
-        ghesHostnameText.setText(newText)
+        ghesHostnameText.text = newText
     }
 
     fun setGhesTokenText(newText: String) {
-        ghesTokenText.setText(newText)
+        ghesTokenText.text = newText
     }
 }
diff --git a/src/main/kotlin/com/github/adrienpessu/sarifviewer/configurable/Settings.kt b/src/main/kotlin/com/github/adrienpessu/sarifviewer/configurable/Settings.kt
@@ -32,9 +32,9 @@ class Settings : Configurable, Configurable.NoScroll, Disposable {
 
     override fun isModified(): Boolean =
             listOf(
-                    !mySettingsComponent!!.getGhTokenText().equals(SettingsState.instance.state.pat),
-                    !mySettingsComponent!!.getGhesHostnameText().equals(SettingsState.instance.state.ghesHostname),
-                    !mySettingsComponent!!.getGhesTokenText().equals(SettingsState.instance.state.ghesPat),
+                mySettingsComponent!!.getGhTokenText() != SettingsState.instance.state.pat,
+                mySettingsComponent!!.getGhesHostnameText() != SettingsState.instance.state.ghesHostname,
+                mySettingsComponent!!.getGhesTokenText() != SettingsState.instance.state.ghesPat,
             ).any()
 
     override fun apply() {
diff --git a/src/main/kotlin/com/github/adrienpessu/sarifviewer/models/BranchItemComboBox.kt b/src/main/kotlin/com/github/adrienpessu/sarifviewer/models/BranchItemComboBox.kt
@@ -8,10 +8,10 @@ data class BranchItemComboBox(
     val commit: String = "",
 ) {
     override fun toString(): String {
-        if (prNumber == 0) {
-            return head
+        return if (prNumber == 0) {
+            head
         } else {
-            return "pr$prNumber ($prTitle)"
+            "pr$prNumber ($prTitle)"
         }
     }
 }
diff --git a/src/main/kotlin/com/github/adrienpessu/sarifviewer/toolWindow/MyCustomInlayRenderer.kt b/src/main/kotlin/com/github/adrienpessu/sarifviewer/toolWindow/MyCustomInlayRenderer.kt
@@ -0,0 +1,26 @@
+package com.github.adrienpessu.sarifviewer.toolWindow
+
+import com.intellij.openapi.editor.EditorCustomElementRenderer
+import com.intellij.openapi.editor.Inlay
+import com.intellij.openapi.editor.impl.EditorImpl
+import com.intellij.openapi.editor.markup.TextAttributes
+import java.awt.Font
+import java.awt.Graphics
+import java.awt.Rectangle
+
+class MyCustomInlayRenderer(private val text: String) : EditorCustomElementRenderer {
+
+    private val myFont = Font("Courrier new", Font.ITALIC, 12)
+    override fun paint(inlay: Inlay<*>, g: Graphics, targetRegion: Rectangle, textAttributes: TextAttributes) {
+
+        (inlay.editor as EditorImpl).apply {
+            g.font = myFont
+            g.color = colorsScheme.defaultForeground
+            g.drawString(text, targetRegion.x, targetRegion.y + ascent)
+        }
+    }
+
+    override fun calcWidthInPixels(inlay: Inlay<*>): Int {
+        return (inlay.editor as EditorImpl).getFontMetrics(myFont.style).stringWidth(text)
+    }
+}
diff --git a/src/main/kotlin/com/github/adrienpessu/sarifviewer/toolWindow/SarifViewerWindowFactory.kt b/src/main/kotlin/com/github/adrienpessu/sarifviewer/toolWindow/SarifViewerWindowFactory.kt
@@ -19,21 +19,16 @@ import com.intellij.openapi.actionSystem.ActionManager
 import com.intellij.openapi.actionSystem.AnAction
 import com.intellij.openapi.components.service
 import com.intellij.openapi.diagnostic.thisLogger
-import com.intellij.openapi.editor.ScrollType
-import com.intellij.openapi.fileEditor.FileDocumentManager
+import com.intellij.openapi.editor.Editor
 import com.intellij.openapi.fileEditor.FileEditorManager
 import com.intellij.openapi.fileEditor.OpenFileDescriptor
 import com.intellij.openapi.project.DumbService
 import com.intellij.openapi.project.Project
 import com.intellij.openapi.ui.ComboBox
-import com.intellij.openapi.ui.MessageType
-import com.intellij.openapi.ui.popup.Balloon
-import com.intellij.openapi.ui.popup.JBPopupFactory
 import com.intellij.openapi.vfs.VirtualFileManager
 import com.intellij.openapi.wm.ToolWindow
 import com.intellij.openapi.wm.ToolWindowFactory
 import com.intellij.ui.ScrollPaneFactory
-import com.intellij.ui.awt.RelativePoint
 import com.intellij.ui.components.JBPanel
 import com.intellij.ui.components.JBTabbedPane
 import com.intellij.ui.content.ContentFactory
@@ -551,6 +546,7 @@ class SarifViewerWindowFactory : ToolWindowFactory {
                                 leaf.address.split(":")[1].toInt(),
                                 0,
                                 leaf.level,
+                                leaf.ruleId,
                                 leaf.ruleDescription
                             )
 
@@ -578,9 +574,16 @@ class SarifViewerWindowFactory : ToolWindowFactory {
             lineNumber: Int,
             columnNumber: Int = 0,
             level: String = "",
-            ruleDescription: String = ""
+            rule: String = "",
+            description: String = ""
         ) {
 
+            val editor: Editor = FileEditorManager.getInstance(project).selectedTextEditor ?: return
+            val inlayModel = editor.inlayModel
+
+            inlayModel.getBlockElementsInRange(0, editor.document.textLength).filter { it.renderer is MyCustomInlayRenderer }
+                .forEach { it.dispose() }
+
             VirtualFileManager.getInstance().findFileByNioPath(Path.of("${project.basePath}/$path"))
                 ?.let { virtualFile ->
                     FileEditorManager.getInstance(project).openTextEditor(
@@ -592,36 +595,21 @@ class SarifViewerWindowFactory : ToolWindowFactory {
                         ),
                         true // request focus to editor
                     )
-                    FileDocumentManager.getInstance().getDocument(virtualFile)?.let { document ->
-                        if (ruleDescription.isNotEmpty()) {
-                            val lineStartOffset = document.getLineStartOffset(lineNumber - 1)
-                            val lineEndOffset = document.getLineEndOffset(lineNumber - 1)
-                            val editor = FileEditorManager.getInstance(project).selectedTextEditor ?: return
-                            editor.caretModel.moveToOffset(lineStartOffset)
-                            editor.scrollingModel.scrollToCaret(ScrollType.CENTER)
-                            editor.selectionModel.setSelection(lineStartOffset, lineEndOffset)
-
-                            val messageType = when (level) {
-                                "error" -> MessageType.ERROR
-                                "warning" -> MessageType.WARNING
-                                else -> MessageType.INFO
-                            }
+                    val editor: Editor = FileEditorManager.getInstance(project).selectedTextEditor ?: return
+                    val inlayModel = editor.inlayModel
 
-                            // add a balloon on the selection
-                            val balloon = JBPopupFactory.getInstance().createHtmlTextBalloonBuilder(
-                                ruleDescription,
-                                messageType,
-                                null
-                            ).createBalloon()
-                            balloon.show(
-                                RelativePoint(
-                                    editor.contentComponent,
-                                    editor.visualPositionToXY(editor.caretModel.visualPosition)
-                                ), Balloon.Position.above
-                            )
-                        }
-                    }
+                    val offset = editor.document.getLineStartOffset(lineNumber - 1)
 
+                    val icon = when (level) {
+                        "error" -> "🛑"
+                        "warning" -> "⚠️"
+                        "note" -> "📝"
+                        else -> ""
+                    }
+                    val description = "$icon $rule: $description"
+                    if (description.isNotEmpty()) {
+                        inlayModel.addBlockElement(offset, true, true, 1, MyCustomInlayRenderer(description))
+                    }
                 }
         }
 

Original file line number	Diff line number	Diff line change
`@@ -34,26 +34,26 @@ class SettingComponent {`
`34`	`34`	`}`
`35`	`35`
`36`	`36`	`fun getGhTokenText(): String {`
`37`		`- return ghTokenText.getText()`
	`37`	`+ return ghTokenText.text`
`38`	`38`	`}`
`39`	`39`
`40`	`40`	`fun setGhTokenText(newText: String) {`
`41`		`- ghTokenText.setText(newText)`
	`41`	`+ ghTokenText.text = newText`
`42`	`42`	`}`
`43`	`43`
`44`	`44`	`fun getGhesHostnameText(): String {`
`45`		`- return ghesHostnameText.getText()`
	`45`	`+ return ghesHostnameText.text`
`46`	`46`	`}`
`47`	`47`
`48`	`48`	`fun getGhesTokenText(): String {`
`49`		`- return ghesTokenText.getText()`
	`49`	`+ return ghesTokenText.text`
`50`	`50`	`}`
`51`	`51`
`52`	`52`	`fun setGhesHostnameText(newText: String) {`
`53`		`- ghesHostnameText.setText(newText)`
	`53`	`+ ghesHostnameText.text = newText`
`54`	`54`	`}`
`55`	`55`
`56`	`56`	`fun setGhesTokenText(newText: String) {`
`57`		`- ghesTokenText.setText(newText)`
	`57`	`+ ghesTokenText.text = newText`
`58`	`58`	`}`
`59`	`59`	`}`
Original file line number	Diff line number	Diff line change
`@@ -8,10 +8,10 @@ data class BranchItemComboBox(`
`8`	`8`	`val commit: String = "",`
`9`	`9`	`) {`
`10`	`10`	`override fun toString(): String {`
`11`		`- if (prNumber == 0) {`
`12`		`- return head`
	`11`	`+ return if (prNumber == 0) {`
	`12`	`+ head`
`13`	`13`	`} else {`
`14`		`- return "pr$prNumber ($prTitle)"`
	`14`	`+ "pr$prNumber ($prTitle)"`
`15`	`15`	`}`
`16`	`16`	`}`
`17`	`17`	`}`