RUM-11445: Check if false alarm still exists

kikoveiga · kikoveiga · commit 4f7192f53532 · 2026-03-20T15:28:02.000Z
diff --git a/features/dd-sdk-android-trace/src/main/kotlin/com/datadog/android/trace/internal/DatadogPropagationHelper.kt b/features/dd-sdk-android-trace/src/main/kotlin/com/datadog/android/trace/internal/DatadogPropagationHelper.kt
@@ -391,15 +391,15 @@ class DatadogPropagationHelper internal constructor() {
             addHeader(
                 W3CHttpCodec.TRACE_PARENT_KEY,
                 // TODO RUM-11445 InvalidStringFormat false alarm
-                @Suppress("UnsafeThirdPartyFunctionCall", "InvalidStringFormat") // Format string is static
+                @Suppress("UnsafeThirdPartyFunctionCall") // Format string is static
                 W3C_TRACE_PARENT_DROP_SAMPLING_DECISION.format(
                     traceId.padStart(length = W3C_TRACE_ID_LENGTH, padChar = '0'),
                     spanId.padStart(length = W3C_PARENT_ID_LENGTH, padChar = '0')
                 )
             )
             // TODO RUM-2121 3rd party vendor information will be erased
             // TODO RUM-11445 InvalidStringFormat false alarm
-            @Suppress("UnsafeThirdPartyFunctionCall", "InvalidStringFormat") // Format string is static
+            @Suppress("UnsafeThirdPartyFunctionCall") // Format string is static
             var traceStateHeader = W3C_TRACE_STATE_DROP_SAMPLING_DECISION
                 .format(spanId.padStart(length = W3C_PARENT_ID_LENGTH, padChar = '0'))
             if (traceOrigin != null) {
diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
@@ -60,7 +60,7 @@ kover = "0.7.6"
 kspTesting = "1.5.0"
 
 # Tools
-detekt = "1.23.0"
+detekt = "1.23.4"
 dokka = "2.1.0"
 unmock = "0.9.0"
 robolectric = "4.4_r1-robolectric-r2"
@@ -209,7 +209,6 @@ androidLintTests = { module = "com.android.tools.lint:lint-tests", version.ref =
 systemStubsJupiter = { module = "uk.org.webcompere:system-stubs-jupiter", version.ref = "systemStubsJupiter" }
 
 # Tools
-detektCli = { module = "io.gitlab.arturbosch.detekt:detekt-cli", version.ref = "detekt" }
 detektApi = { module = "io.gitlab.arturbosch.detekt:detekt-api", version.ref = "detekt" }
 detektTest = { module = "io.gitlab.arturbosch.detekt:detekt-test", version.ref = "detekt" }
 okHttpMock = { module = "com.squareup.okhttp3:mockwebserver", version.ref = "okHttp" }
diff --git a/integrations/dd-sdk-android-okhttp/src/main/kotlin/com/datadog/android/okhttp/trace/TracingInterceptor.kt b/integrations/dd-sdk-android-okhttp/src/main/kotlin/com/datadog/android/okhttp/trace/TracingInterceptor.kt
@@ -529,15 +529,15 @@ internal constructor(
             requestBuilder.addHeader(
                 W3C_TRACEPARENT_KEY,
                 // TODO RUM-11445 InvalidStringFormat false alarm
-                @Suppress("UnsafeThirdPartyFunctionCall", "InvalidStringFormat") // Format string is static
+                @Suppress("UnsafeThirdPartyFunctionCall") // Format string is static
                 W3C_TRACEPARENT_DROP_SAMPLING_DECISION.format(
                     traceId.padStart(length = W3C_TRACE_ID_LENGTH, padChar = '0'),
                     spanId.padStart(length = W3C_PARENT_ID_LENGTH, padChar = '0')
                 )
             )
             // TODO RUM-2121 3rd party vendor information will be erased
             // TODO RUM-11445 InvalidStringFormat false alarm
-            @Suppress("UnsafeThirdPartyFunctionCall", "InvalidStringFormat") // Format string is static
+            @Suppress("UnsafeThirdPartyFunctionCall") // Format string is static
             var traceStateHeader = W3C_TRACESTATE_DROP_SAMPLING_DECISION
                 .format(spanId.padStart(length = W3C_PARENT_ID_LENGTH, padChar = '0'))
             if (traceOrigin != null) {
diff --git a/tools/detekt/src/main/kotlin/com/datadog/tools/detekt/rules/sdk/InvalidStringFormat.kt b/tools/detekt/src/main/kotlin/com/datadog/tools/detekt/rules/sdk/InvalidStringFormat.kt
@@ -19,10 +19,12 @@ import org.jetbrains.kotlin.descriptors.VariableDescriptor
 import org.jetbrains.kotlin.psi.KtCallExpression
 import org.jetbrains.kotlin.psi.KtDotQualifiedExpression
 import org.jetbrains.kotlin.psi.KtExpression
+import org.jetbrains.kotlin.psi.KtProperty
 import org.jetbrains.kotlin.psi.KtReferenceExpression
 import org.jetbrains.kotlin.psi.KtStringTemplateExpression
 import org.jetbrains.kotlin.psi.psiUtil.children
 import org.jetbrains.kotlin.resolve.BindingContext
+import org.jetbrains.kotlin.resolve.DescriptorToSourceUtils
 import org.jetbrains.kotlin.resolve.bindingContextUtil.getReferenceTargets
 import org.jetbrains.kotlin.resolve.calls.model.ResolvedCall
 import org.jetbrains.kotlin.resolve.calls.model.VarargValueArgument
@@ -137,8 +139,18 @@ class InvalidStringFormat : Rule() {
                 if (compileTimeInitializer != null) {
                     compileTimeInitializer.value as? String
                 } else {
-                    println("Unable to get compileTimeInitializer for $referenceTarget")
-                    null
+                    // compileTimeInitializer can be null when the CLI binding context
+                    // doesn't fully resolve companion object constants. Fall back to
+                    // reading the initializer from the PSI source declaration.
+                    val declaration = DescriptorToSourceUtils
+                        .descriptorToDeclaration(referenceTarget) as? KtProperty
+                    val initializer = declaration?.initializer
+                    if (initializer != null) {
+                        resolveStringExpression(initializer)
+                    } else {
+                        println("Unable to get compileTimeInitializer for $referenceTarget")
+                        null
+                    }
                 }
             } else {
                 println("Unknown referenceTarget:$referenceTarget")
diff --git a/tools/detekt/src/test/kotlin/com/datadog/tools/detekt/rules/sdk/InvalidStringFormatTest.kt b/tools/detekt/src/test/kotlin/com/datadog/tools/detekt/rules/sdk/InvalidStringFormatTest.kt
@@ -37,7 +37,7 @@ internal class InvalidStringFormatTest {
     fun `Warns unresolved String format {variable, ext}`() {
         // Given
         val code =
-            """ 
+            """
                 fun test(s: String): String {
                     var pattern = "Called %s with %s"
                     return pattern.format(s)
@@ -56,7 +56,7 @@ internal class InvalidStringFormatTest {
     fun `Warns unresolved String format {variable, static}`() {
         // Given
         val code =
-            """ 
+            """
                 fun test(s: String): String {
                     var pattern = "Called %s with %s"
                     return String.format(pattern, s)
@@ -75,7 +75,7 @@ internal class InvalidStringFormatTest {
     fun `Warns unresolved String format {argument, ext}`() {
         // Given
         val code =
-            """ 
+            """
                 fun test(pattern: String, s: String): String {
                     return pattern.format(s)
                 }
@@ -93,7 +93,7 @@ internal class InvalidStringFormatTest {
     fun `Warns unresolved String format {argument, static}`() {
         // Given
         val code =
-            """ 
+            """
                 fun test(pattern: String, s: String): String {
                     return String.format(pattern, s)
                 }
@@ -111,7 +111,7 @@ internal class InvalidStringFormatTest {
     fun `Warns unresolved String format {argument with defaults, ext}`() {
         // Given
         val code =
-            """ 
+            """
                 fun test(pattern: String = "%s", s: String): String {
                     return pattern.format(s)
                 }
@@ -129,7 +129,7 @@ internal class InvalidStringFormatTest {
     fun `Warns unresolved String format {argument with defaults, static}`() {
         // Given
         val code =
-            """ 
+            """
                 fun test(pattern: String = "%s", s: String): String {
                     return String.format(pattern, s)
                 }
@@ -620,4 +620,56 @@ internal class InvalidStringFormatTest {
     }
 
     // endregion
+
+    // region Test companion object const val
+
+    @Test
+    fun `Ignores valid format with const val in same class companion object`() {
+        // Given
+        val code =
+            """
+                class Foo {
+                    fun test(s: String, i: Int): String {
+                        return PATTERN.format(s, i)
+                    }
+
+                    companion object {
+                        const val PATTERN = "Called %s with %d"
+                    }
+                }
+            """.trimIndent()
+
+        // When
+        val findings = InvalidStringFormat()
+            .compileAndLintWithContext(kotlinEnv.env, code)
+
+        // Then
+        assertThat(findings).hasSize(0)
+    }
+
+    @Test
+    fun `Ignores valid format with const val in same class companion object {static call}`() {
+        // Given
+        val code =
+            """
+                class Foo {
+                    fun test(traceId: String, spanId: String): String {
+                        return String.format(W3C_PATTERN, traceId, spanId)
+                    }
+
+                    companion object {
+                        const val W3C_PATTERN = "00-%s-%s-00"
+                    }
+                }
+            """.trimIndent()
+
+        // When
+        val findings = InvalidStringFormat()
+            .compileAndLintWithContext(kotlinEnv.env, code)
+
+        // Then
+        assertThat(findings).hasSize(0)
+    }
+
+    // endregion
 }
