Ban Gson (#4139)

Gson is currently on the classpath, but the rest of the repo uses Jackson ObjectMapper. Gson is also in maintenance mode.
aws · Feb 20, 2024 · 6b5f024 · 6b5f024
1 parent a990210
commit 6b5f024
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 2 deletions.
diff --git a/detekt-rules/src/software/aws/toolkits/gradle/detekt/rules/BannedImportsRule.kt b/detekt-rules/src/software/aws/toolkits/gradle/detekt/rules/BannedImportsRule.kt
@@ -69,6 +69,16 @@ class BannedImportsRule : Rule() {
                     )
                 )
             }
+
+            if (importedFqName == "com.google.gson.Gson") {
+                report(
+                    CodeSmell(
+                        issue,
+                        Entity.from(element),
+                        message = "Use jacksonObjectMapper() insted of Gson"
+                    )
+                )
+            }
         }
     }
 }
diff --git a/detekt-rules/tst/software/aws/toolkits/gradle/detekt/rules/BannedImportsRuleTest.kt b/detekt-rules/tst/software/aws/toolkits/gradle/detekt/rules/BannedImportsRuleTest.kt
@@ -24,6 +24,13 @@ class BannedImportsRuleTest {
             .matches { it.id == "BannedImports" && it.message == "Use AssertJ instead of Hamcrest assertions" }
     }
 
+    @Test
+    fun `Importing Gson fails`() {
+        assertThat(rule.lint("import com.google.gson.Gson"))
+            .singleElement()
+            .matches { it.id == "BannedImports" && it.message == "Use jacksonObjectMapper() insted of Gson" }
+    }
+
     @Test
     fun `Importing Kotlin test assert fails`() {
         assertThat(rule.lint("import kotlin.test.assertTrue"))

diff --git a/.../tst/software/aws/toolkits/jetbrains/services/codewhisperer/CodeWhispererTelemetryTest.kt b/.../tst/software/aws/toolkits/jetbrains/services/codewhisperer/CodeWhispererTelemetryTest.kt
@@ -3,7 +3,7 @@
 
 package software.aws.toolkits.jetbrains.services.codewhisperer
 
-import com.google.gson.Gson
+import com.fasterxml.jackson.module.kotlin.jacksonObjectMapper
 import com.intellij.openapi.application.ApplicationManager
 import com.intellij.openapi.command.WriteCommandAction
 import com.intellij.openapi.editor.Editor
@@ -379,14 +379,15 @@ class CodeWhispererTelemetryTest : CodeWhispererTestBase() {
     fun `test user Decision events record CodeWhisperer reference info`() {
         val userGroup = CodeWhispererUserGroupSettings.getInstance().getUserGroup()
         withCodeWhispererServiceInvokedAndWait {}
+        val mapper = jacksonObjectMapper()
         argumentCaptor<MetricEvent>().apply {
             verify(batcher, atLeastOnce()).enqueue(capture())
             pythonResponse.completions().forEach {
                 assertEventsContainsFieldsAndCount(
                     allValues,
                     userDecision,
                     1,
-                    "codewhispererSuggestionReferences" to Gson().toJson(it.references().map { ref -> ref.licenseName() }.toSet()),
+                    "codewhispererSuggestionReferences" to mapper.writeValueAsString(it.references().map { ref -> ref.licenseName() }.toSet()),
                     "codewhispererSuggestionReferenceCount" to it.references().size.toString(),
                     "codewhispererUserGroup" to userGroup.name,
                     atLeast = true