CM-37864 - Integrate Sentry (#73)

Author: MarshalX

.github/workflows/build.yml

@@ -97,6 +97,7 @@ jobs:
         if: ${{ github.event_name == 'workflow_dispatch' }}
         env:
           PUBLISH_TOKEN: ${{ secrets.PUBLISH_TOKEN }}
+          SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}
         run: ./gradlew publishPlugin
 
       #  test:

CHANGELOG.md

@@ -4,6 +4,10 @@
 
 ## [Unreleased]
 
+## [1.9.2] - 2024-07-15
+
+- Integrate Sentry
+
 ## [1.9.1] - 2024-06-25
 
 - Remove forgotten "coming soon" from SAST
@@ -93,6 +97,8 @@
 
 The first public release of the plugin.
 
+[1.9.2]: https://github.com/cycodehq/intellij-platform-plugin/releases/tag/v1.9.2
+
 [1.9.1]: https://github.com/cycodehq/intellij-platform-plugin/releases/tag/v1.9.1
 
 [1.9.0]: https://github.com/cycodehq/intellij-platform-plugin/releases/tag/v1.9.0
@@ -129,4 +135,4 @@ The first public release of the plugin.
 
 [1.0.0]: https://github.com/cycodehq/intellij-platform-plugin/releases/tag/v1.0.0
 
-[Unreleased]: https://github.com/cycodehq/intellij-platform-plugin/compare/v1.4.0...HEAD
+[Unreleased]: https://github.com/cycodehq/intellij-platform-plugin/compare/v1.9.2...HEAD

build.gradle.kts

@@ -10,6 +10,7 @@ plugins {
     alias(libs.plugins.gradleIntelliJPlugin) // Gradle IntelliJ Plugin
     alias(libs.plugins.changelog) // Gradle Changelog Plugin
     alias(libs.plugins.kover) // Gradle Kover Plugin
+    alias(libs.plugins.sentry)
 }
 
 group = properties("pluginGroup").get()
@@ -66,6 +67,20 @@ koverReport {
     }
 }
 
+// Configure Sentry
+sentry {
+    includeDependenciesReport = false
+
+    // Generates a JVM (Java, Kotlin, etc.) source bundle and uploads your source code to Sentry.
+    // This enables source context, allowing you to see your source
+    // code as part of your stack traces in Sentry.
+    includeSourceContext = true
+
+    org = "cycode"
+    projectName = "intellij-platform-plugin"
+    authToken = environment("SENTRY_AUTH_TOKEN")
+}
+
 tasks {
     wrapper {
         gradleVersion = properties("gradleVersion").get()
@@ -124,6 +139,7 @@ tasks {
 
     publishPlugin {
         dependsOn("patchChangelog")
+        dependsOn("sentryUploadSourceBundleJava")
         token = environment("PUBLISH_TOKEN")
         // The pluginVersion is based on the SemVer (https://semver.org) and supports pre-release labels, like 2.1.7-alpha.3
         // Specify pre-release label to publish the plugin in a custom Release Channel automatically. Read more:

gradle.properties

@@ -4,7 +4,7 @@ pluginGroup = com.cycode.plugin
 pluginName = Cycode
 pluginRepositoryUrl = https://github.com/cycodehq/intellij-platform-plugin
 # SemVer format -> https://semver.org
-pluginVersion = 1.9.1
+pluginVersion = 1.9.2
 
 # Supported build number ranges and IntelliJ Platform versions -> https://plugins.jetbrains.com/docs/intellij/build-number-ranges.html
 pluginSinceBuild = 211.1

gradle/libs.versions.toml

@@ -10,6 +10,7 @@ kotlin = "1.9.20"
 changelog = "2.2.0"
 gradleIntelliJPlugin = "1.17.1"
 kover = "0.7.3"
+sentry = "4.9.0"
 
 [libraries]
 annotations = { group = "org.jetbrains", name = "annotations", version.ref = "annotations" }
@@ -22,3 +23,4 @@ dokka = { id = "org.jetbrains.dokka", version.ref = "dokka" }
 gradleIntelliJPlugin = { id = "org.jetbrains.intellij", version.ref = "gradleIntelliJPlugin" }
 kotlin = { id = "org.jetbrains.kotlin.jvm", version.ref = "kotlin" }
 kover = { id = "org.jetbrains.kotlinx.kover", version.ref = "kover" }
+sentry = { id = "io.sentry.jvm.gradle", version.ref = "sentry" }

src/main/kotlin/com/cycode/plugin/Consts.kt

@@ -1,5 +1,6 @@
 package com.cycode.plugin
 
+import com.cycode.plugin.utils.getPluginVersion
 import com.intellij.openapi.application.PathManager
 import com.intellij.openapi.util.SystemInfo
 
@@ -16,12 +17,17 @@ private fun getDefaultCliPath(): String {
     return "${Consts.PLUGIN_PATH}/cycode"
 }
 
+private fun getSentryReleaseVersion(): String {
+    val appName = CycodeBundle.message("appName")
+    val version = getPluginVersion()
+    return "$appName@${version}"
+}
 
 class Consts {
     companion object {
         val PLUGIN_PATH = PathManager.getPluginsPath() + "/cycode-intellij-platform-plugin"
         val DEFAULT_CLI_PATH = getDefaultCliPath()
-        const val REQUIRED_CLI_VERSION = "1.10.1"
+        const val REQUIRED_CLI_VERSION = "1.10.3"
 
         const val CLI_GITHUB_ORG = "cycodehq"
         const val CLI_GITHUB_REPO = "cycode-cli"
@@ -30,5 +36,11 @@ class Consts {
 
         const val PLUGIN_AUTO_SAVE_FLUSH_INITIAL_DELAY_SEC = 0L
         const val PLUGIN_AUTO_SAVE_FLUSH_DELAY_SEC = 5L
+
+        const val SENTRY_DSN = "https://0f0524e8d03a4283702a10ed4b6e03d0@o1026942.ingest.us.sentry.io/4507543885774848"
+        const val SENTRY_DEBUG = false
+        val SENTRY_RELEASE = getSentryReleaseVersion()
+        const val SENTRY_SAMPLE_RATE = 1.0
+        const val SENTRY_SEND_DEFAULT_PII = false
     }
 }

src/main/kotlin/com/cycode/plugin/activities/PostStartupActivity.kt

@@ -1,13 +1,16 @@
 package com.cycode.plugin.activities
 
 import com.cycode.plugin.annotators.CycodeAnnotator
+import com.cycode.plugin.sentry.SentryInit
 import com.cycode.plugin.services.cycode
 import com.intellij.openapi.diagnostic.thisLogger
 import com.intellij.openapi.project.Project
 import com.intellij.openapi.startup.StartupActivity
 
 class PostStartupActivity : StartupActivity.DumbAware {
     override fun runActivity(project: Project) {
+        SentryInit.init()
+
         // we are using singleton here because runActivity is called for each project
         CycodeAnnotator.INSTANCE.registerForAllLangs()
 

src/main/kotlin/com/cycode/plugin/cli/CliWrapper.kt

@@ -14,6 +14,7 @@ import com.intellij.execution.process.ProcessOutputTypes
 import com.intellij.openapi.diagnostic.thisLogger
 import com.intellij.openapi.util.Key
 import com.intellij.util.io.BaseOutputReader
+import io.sentry.Sentry
 import java.io.File
 import java.nio.charset.Charset
 
@@ -104,6 +105,7 @@ class CliWrapper(val executablePath: String, val workDirectory: String? = null)
                 val result: CliError = mapper.readValue(stdout)
                 return CliResult.Error(result)
             } catch (e: Exception) {
+                Sentry.captureException(e)
                 thisLogger().error("Failed to parse ANY CLI output: $stdout", e)
             }
 

src/main/kotlin/com/cycode/plugin/cli/UserAgent.kt

@@ -1,17 +1,17 @@
 package com.cycode.plugin.cli
 
+import com.cycode.plugin.CycodeBundle
 import com.cycode.plugin.cli.models.IDEUserAgent
+import com.cycode.plugin.utils.getPluginVersion
 import com.fasterxml.jackson.databind.ObjectMapper
 import com.fasterxml.jackson.databind.PropertyNamingStrategies
-import com.intellij.ide.plugins.PluginManagerCore
 import com.intellij.openapi.application.ApplicationInfo
-import com.intellij.openapi.extensions.PluginId
 
 private fun retrieveIDEInfo(): IDEUserAgent {
     val appInfo = ApplicationInfo.getInstance()
 
-    val appName = "jetbrains_plugin"
-    val appVersion = PluginManagerCore.getPlugin(PluginId.getId("com.cycode.plugin"))?.version ?: "unknown"
+    val appName = CycodeBundle.message("appName")
+    val appVersion = getPluginVersion()
     val envName = appInfo.versionName
     val envVersion = appInfo.fullVersion
 

src/main/kotlin/com/cycode/plugin/cli/models/AuthCheckResult.kt

@@ -3,4 +3,10 @@ package com.cycode.plugin.cli.models
 data class AuthCheckResult(
     val result: Boolean,
     val message: String,
+    val data: AuthCheckResultData,
+)
+
+data class AuthCheckResultData(
+    val userId: String,
+    val tenantId: String,
 )