Setup detekt static analysis plugin

android-agent/config/detekt/baseline.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0" ?>
+<SmellBaseline>
+  <ManuallySuppressedIssues/>
+  <CurrentIssues>
+    <ID>ForbiddenComment:SessionManager.kt$SessionManager$// TODO FIXME: This is not threadsafe -- if two threads call getSessionId()</ID>
+    <ID>ForbiddenComment:SessionManager.kt$SessionManager$// TODO: Make thread safe / wrap with AtomicReference?</ID>
+    <ID>LongParameterList:OpenTelemetryRumInitializer.kt$OpenTelemetryRumInitializer$( activityTracerCustomizer: ((Tracer) -&gt; Tracer)?, activityNameExtractor: ScreenNameExtractor?, fragmentTracerCustomizer: ((Tracer) -&gt; Tracer)?, fragmentNameExtractor: ScreenNameExtractor?, anrAttributesExtractors: List&lt;EventAttributesExtractor&lt;Array&lt;StackTraceElement&gt;&gt;&gt;, crashAttributesExtractors: List&lt;EventAttributesExtractor&lt;CrashDetails&gt;&gt;, networkChangeAttributesExtractors: List&lt;NetworkAttributesExtractor&gt;, slowRenderingDetectionPollInterval: Duration?, )</ID>
+    <ID>LongParameterList:OpenTelemetryRumInitializer.kt$OpenTelemetryRumInitializer$( application: Application, endpointBaseUrl: String, endpointHeaders: Map&lt;String, String&gt; = emptyMap(), spanEndpointConnectivity: EndpointConnectivity = HttpEndpointConnectivity.forTraces( endpointBaseUrl, endpointHeaders, ), logEndpointConnectivity: EndpointConnectivity = HttpEndpointConnectivity.forLogs( endpointBaseUrl, endpointHeaders, ), metricEndpointConnectivity: EndpointConnectivity = HttpEndpointConnectivity.forMetrics( endpointBaseUrl, endpointHeaders, ), rumConfig: OtelRumConfig = OtelRumConfig(), sessionConfig: SessionConfig = SessionConfig.withDefaults(), activityTracerCustomizer: ((Tracer) -&gt; Tracer)? = null, activityNameExtractor: ScreenNameExtractor? = null, fragmentTracerCustomizer: ((Tracer) -&gt; Tracer)? = null, fragmentNameExtractor: ScreenNameExtractor? = null, anrAttributesExtractors: List&lt;EventAttributesExtractor&lt;Array&lt;StackTraceElement&gt;&gt;&gt; = emptyList(), crashAttributesExtractors: List&lt;EventAttributesExtractor&lt;CrashDetails&gt;&gt; = emptyList(), networkChangeAttributesExtractors: List&lt;NetworkAttributesExtractor&gt; = emptyList(), slowRenderingDetectionPollInterval: Duration? = null, )</ID>
+  </CurrentIssues>
+</SmellBaseline>

buildSrc/build.gradle.kts

@@ -23,4 +23,5 @@ dependencies {
     implementation(libs.nullaway.plugin)
     implementation(libs.animalsniffer.plugin)
     implementation(libs.kotlin.plugin)
+    implementation(libs.detekt.plugin)
 }

buildSrc/src/main/kotlin/otel.android-library-conventions.gradle.kts

@@ -1,5 +1,5 @@
 import gradle.kotlin.dsl.accessors._d8282334f089ec6fbf714caba2b86dd9.kotlin
-import org.gradle.api.tasks.testing.logging.TestExceptionFormat
+import io.gitlab.arturbosch.detekt.Detekt
 import org.jetbrains.kotlin.gradle.dsl.JvmTarget
 import org.jetbrains.kotlin.gradle.dsl.KotlinVersion
 
@@ -9,6 +9,7 @@ plugins {
     id("otel.errorprone-conventions")
     id("kotlin-kapt")
     id("otel.animalsniffer-conventions")
+    id("io.gitlab.arturbosch.detekt")
 }
 
 val javaVersion = rootProject.extra["java_version"] as JavaVersion
@@ -56,6 +57,25 @@ tasks.withType<Test> {
     useJUnitPlatform()
 }
 
+detekt {
+    buildUponDefaultConfig = true
+    autoCorrect = true
+
+    // overwrite default behaviour here, if needed
+    config.from(rootProject.files("config/detekt/detekt.yml"))
+
+    // suppress pre-existing issues on a per-project basis
+    baseline = project.file("config/detekt/baseline.xml")
+}
+
+project.tasks.withType(Detekt::class.java).configureEach {
+    jvmTarget = targetJvm.target
+    reports {
+        html.required.set(true)
+        xml.required.set(false)
+    }
+}
+
 val libs = extensions.getByType<VersionCatalogsExtension>().named("libs")
 dependencies {
     implementation(libs.findLibrary("androidx-annotation").get())

config/detekt/detekt.yml

@@ -0,0 +1,3 @@
+# https://detekt.dev/docs/introduction/configurations/
+build:
+  maxIssues: 0

core/config/detekt/baseline.xml

@@ -0,0 +1,27 @@
+<?xml version="1.0" ?>
+<SmellBaseline>
+  <ManuallySuppressedIssues/>
+  <CurrentIssues>
+    <ID>EmptyFunctionBlock:GlobalAttributesSpanAppender.kt$GlobalAttributesSpanAppender${}</ID>
+    <ID>EmptyFunctionBlock:NetworkAttributesSpanAppender.kt$NetworkAttributesSpanAppender${}</ID>
+    <ID>EmptyFunctionBlock:SessionIdSpanAppender.kt$SessionIdSpanAppender${}</ID>
+    <ID>EmptyFunctionBlock:TestInitializationEvents.kt$TestInitializationEvents${ }</ID>
+    <ID>ImplicitDefaultLocale:DiskManager.kt$DiskManager$String.format( "Requested cache size: %s, folder size: %s", requestedSize, calculatedSize, )</ID>
+    <ID>ImplicitDefaultLocale:SessionIdRatioBasedSampler.kt$SessionIdRatioBasedSampler$String.format( "SessionIdRatioBased{traceIdRatioBased:%s}", ratioBasedSampler.description, )</ID>
+    <ID>LongParameterList:DiskBufferingConfig.kt$DiskBufferingConfig.Companion$( enabled: Boolean = false, maxCacheSize: Int = DEFAULT_MAX_CACHE_SIZE, maxFileAgeForWriteMillis: Long = TimeUnit.SECONDS.toMillis(30), minFileAgeForReadMillis: Long = TimeUnit.SECONDS.toMillis(33), maxFileAgeForReadMillis: Long = TimeUnit.HOURS.toMillis(18), maxCacheFileSize: Int = MAX_CACHE_FILE_SIZE, debugEnabled: Boolean = false, signalsBufferDir: File? = null, )</ID>
+    <ID>MagicNumber:DiskBufferingConfig.kt$DiskBufferingConfig.Companion$18</ID>
+    <ID>MagicNumber:DiskBufferingConfig.kt$DiskBufferingConfig.Companion$30</ID>
+    <ID>MagicNumber:DiskBufferingConfig.kt$DiskBufferingConfig.Companion$33</ID>
+    <ID>MagicNumber:DiskBufferingConfig.kt$DiskBufferingConfig.Companion$5</ID>
+    <ID>MagicNumber:DiskManager.kt$DiskManager$3</ID>
+    <ID>MagicNumber:SignalFromDiskExporter.kt$SignalFromDiskExporter$5</ID>
+    <ID>MaxLineLength:BufferDelegatingLogExporter.kt$BufferDelegatingLogExporter$*</ID>
+    <ID>MaxLineLength:BufferDelegatingMetricExporter.kt$BufferDelegatingMetricExporter$private var aggregationTemporalitySelector: AggregationTemporalitySelector = AggregationTemporalitySelector.alwaysCumulative()</ID>
+    <ID>MaxLineLength:DiskBufferingConfig.kt$DiskBufferingConfig.Companion$Log.w(OTEL_RUM_LOG_TAG, "overriding minFileAgeForReadMillis from $minFileAgeForReadMillis to $minRead")</ID>
+    <ID>MaxLineLength:GlobalAttributesSpanAppender.kt$GlobalAttributesSpanAppender$*</ID>
+    <ID>MaxLineLength:GlobalAttributesSpanAppenderTest.kt$GlobalAttributesSpanAppenderTest$every { originalSupplier.get() } returns attrs andThenThrows RuntimeException("Should not have been called again.")</ID>
+    <ID>MaxLineLength:NetworkAttributesSpanAppender.kt$NetworkAttributesSpanAppender.Companion$fun</ID>
+    <ID>MaxLineLength:SessionIdRatioBasedSampler.kt$SessionIdRatioBasedSampler$*</ID>
+    <ID>MaxLineLength:SignalFromDiskExporter.kt$SignalFromDiskExporter$*</ID>
+  </CurrentIssues>
+</SmellBaseline>

gradle/libs.versions.toml

@@ -15,6 +15,7 @@ junitKtx = "1.3.0"
 autoService = "1.1.1"
 androidx-navigation = "2.7.7"
 compose = "1.5.4"
+detekt = "1.23.8"
 
 [libraries]
 opentelemetry-platform-alpha = { module = "io.opentelemetry.instrumentation:opentelemetry-instrumentation-bom-alpha", version.ref = "opentelemetry-instrumentation-alpha" }
@@ -47,6 +48,7 @@ volley = "com.android.volley:volley:1.2.1"
 auto-service-annotations = { module = "com.google.auto.service:auto-service-annotations", version.ref = "autoService" }
 auto-service-processor = { module = "com.google.auto.service:auto-service", version.ref = "autoService" }
 compose = { group = "androidx.compose.ui", name = "ui", version.ref = "compose" }
+detekt-plugin = { module = "io.gitlab.arturbosch.detekt:detekt-gradle-plugin", version.ref = "detekt" }
 
 #Test tools
 opentelemetry-sdk-testing = { module = "io.opentelemetry:opentelemetry-sdk-testing" }

instrumentation/activity/config/detekt/baseline.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" ?>
+<SmellBaseline>
+  <ManuallySuppressedIssues/>
+  <CurrentIssues>
+    <ID>MagicNumber:ActivityLifecycleInstrumentation.kt$ActivityLifecycleInstrumentation$29</ID>
+    <ID>TooManyFunctions:ActivityCallbacks.kt$ActivityCallbacks : DefaultingActivityLifecycleCallbacks</ID>
+  </CurrentIssues>
+</SmellBaseline>

instrumentation/android-instrumentation/config/detekt/baseline.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" ?>
+<SmellBaseline>
+  <ManuallySuppressedIssues/>
+  <CurrentIssues>
+    <ID>MaxLineLength:AndroidInstrumentation.kt$AndroidInstrumentation$*</ID>
+    <ID>UseCheckOrError:AndroidInstrumentationLoaderImpl.kt$AndroidInstrumentationLoaderImpl$throw IllegalStateException("Instrumentation with type '${instrumentation::class.java}' already exists.")</ID>
+  </CurrentIssues>
+</SmellBaseline>

instrumentation/anr/config/detekt/baseline.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" ?>
+<SmellBaseline>
+  <ManuallySuppressedIssues/>
+  <CurrentIssues>
+    <ID>MagicNumber:AnrWatcher.kt$AnrWatcher$5</ID>
+    <ID>ReturnCount:AnrWatcher.kt$AnrWatcher$override fun run()</ID>
+  </CurrentIssues>
+</SmellBaseline>

instrumentation/common-api/config/detekt/baseline.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" ?>
+<SmellBaseline>
+  <ManuallySuppressedIssues/>
+  <CurrentIssues>
+    <ID>UnusedPrivateClass:ScreenNameExtractorTest.kt$ScreenNameExtractorTest$AnnotatedFragment : Fragment</ID>
+  </CurrentIssues>
+</SmellBaseline>

instrumentation/compose/click/config/detekt/baseline.xml

@@ -0,0 +1,16 @@
+<?xml version="1.0" ?>
+<SmellBaseline>
+  <ManuallySuppressedIssues/>
+  <CurrentIssues>
+    <ID>LongParameterList:ComposeClickEventGeneratorTest.kt$ComposeClickEventGeneratorTest$( targetX: Float = 0f, targetY: Float = 0f, hitOffset: IntArray = intArrayOf(10, 20), id: Int = 100, hit: Boolean = false, clickable: Boolean = false, useDescription: Boolean = false, )</ID>
+    <ID>LongParameterList:ComposeInstrumentationTest.kt$ComposeInstrumentationTest$( targetX: Float = 0f, targetY: Float = 0f, hitOffset: IntArray = intArrayOf(10, 20), id: Int = 100, hit: Boolean = false, clickable: Boolean = false, useDescription: Boolean = false, )</ID>
+    <ID>LongParameterList:ComposeTapTargetDetectorTest.kt$ComposeTapTargetDetectorTest$( targetX: Float = 0f, targetY: Float = 0f, hitOffset: IntArray = intArrayOf(10, 20), id: Int = 100, hit: Boolean = false, clickable: Boolean = false, useDescription: Boolean = false, )</ID>
+    <ID>MaxLineLength:ComposeClickEventGenerator.kt$ComposeClickEventGenerator$composeTapTargetDetector.findTapTarget(window.decorView, motionEvent.x, motionEvent.y)</ID>
+    <ID>MaxLineLength:ComposeClickEventGeneratorTest.kt$ComposeClickEventGeneratorTest$fun</ID>
+    <ID>NestedBlockDepth:ComposeTapTargetDetector.kt$ComposeTapTargetDetector$fun findTapTarget( decorView: View, x: Float, y: Float, ): LayoutNode?</ID>
+    <ID>NestedBlockDepth:ComposeTapTargetDetector.kt$ComposeTapTargetDetector$private fun getNodeName(node: LayoutNode): String?</ID>
+    <ID>NestedBlockDepth:ComposeTapTargetDetector.kt$ComposeTapTargetDetector$private fun isValidClickTarget(node: LayoutNode): Boolean</ID>
+    <ID>ReturnCount:ComposeTapTargetDetector.kt$ComposeTapTargetDetector$private fun getNodeName(node: LayoutNode): String?</ID>
+    <ID>ReturnCount:ComposeTapTargetDetector.kt$ComposeTapTargetDetector$private fun isValidClickTarget(node: LayoutNode): Boolean</ID>
+  </CurrentIssues>
+</SmellBaseline>

instrumentation/fragment/config/detekt/baseline.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" ?>
+<SmellBaseline>
+  <ManuallySuppressedIssues/>
+  <CurrentIssues>
+    <ID>MagicNumber:FragmentLifecycleInstrumentation.kt$FragmentLifecycleInstrumentation$29</ID>
+  </CurrentIssues>
+</SmellBaseline>

instrumentation/startup/config/detekt/baseline.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" ?>
+<SmellBaseline>
+  <ManuallySuppressedIssues/>
+  <CurrentIssues>
+    <ID>MaxLineLength:SdkInitializationEvents.kt$SdkInitializationEvents$*</ID>
+    <ID>TooManyFunctions:SdkInitializationEvents.kt$SdkInitializationEvents : InitializationEvents</ID>
+  </CurrentIssues>
+</SmellBaseline>

instrumentation/view-click/config/detekt/baseline.xml

@@ -0,0 +1,11 @@
+<?xml version="1.0" ?>
+<SmellBaseline>
+  <ManuallySuppressedIssues/>
+  <CurrentIssues>
+    <ID>LongParameterList:ViewClickInstrumentationTest.kt$ViewClickInstrumentationTest$( id: Int, motionEvent: MotionEvent, hitOffset: IntArray = intArrayOf(0, 0), clickable: Boolean = true, visibility: Int = View.VISIBLE, applyOthers: (T) -&gt; Unit = {}, )</ID>
+    <ID>MaxLineLength:ViewClickEventGenerator.kt$ViewClickEventGenerator$private fun isJetpackComposeView(view: View): Boolean</ID>
+    <ID>SwallowedException:ViewClickEventGenerator.kt$ViewClickEventGenerator$throwable: Throwable</ID>
+    <ID>TooGenericExceptionCaught:ViewClickEventGenerator.kt$ViewClickEventGenerator$throwable: Throwable</ID>
+    <ID>TooManyFunctions:ViewClickEventGenerator.kt$ViewClickEventGenerator</ID>
+  </CurrentIssues>
+</SmellBaseline>

services/config/detekt/baseline.xml

@@ -0,0 +1,13 @@
+<?xml version="1.0" ?>
+<SmellBaseline>
+  <ManuallySuppressedIssues/>
+  <CurrentIssues>
+    <ID>CyclomaticComplexMethod:PostApi28NetworkDetector.kt$PostApi28NetworkDetector$private fun getDataNetworkTypeName(dataNetworkType: Int): String</ID>
+    <ID>ForbiddenComment:NetworkDetector.kt$NetworkDetector.Companion$// TODO: Use ServiceManager to get the ConnectivityManager or similar (not yet managed/abstracted)</ID>
+    <ID>ForbiddenComment:NetworkDetector.kt$NetworkDetector.Companion$// TODO: Use ServiceManager to get the TelephonyManager or similar (not yet managed/abstracted)</ID>
+    <ID>MagicNumber:VisibleScreenTracker.kt$VisibleScreenTracker$29</ID>
+    <ID>MaxLineLength:CurrentNetworkProviderTest.kt$CurrentNetworkProviderTest$@Config(sdk = [Build.VERSION_CODES.N, Build.VERSION_CODES.P, Build.VERSION_CODES.Q, Build.VERSION_CODES.UPSIDE_DOWN_CAKE])</ID>
+    <ID>MaxLineLength:PeriodicRunnable.kt$PeriodicRunnable$* Called only if a) The runnable has never run before, OR b) The minimum amount of time delay has passed after the last run.</ID>
+    <ID>ReturnCount:SimpleNetworkDetector.kt$SimpleNetworkDetector$@RequiresApi(api = Build.VERSION_CODES.Q) private fun detectUsingModernApi(): CurrentNetwork</ID>
+  </CurrentIssues>
+</SmellBaseline>

test-common/config/detekt/baseline.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" ?>
+<SmellBaseline>
+  <ManuallySuppressedIssues/>
+  <CurrentIssues>
+    <ID>ForbiddenComment:AssertionExtensions.kt$// TODO: This will be removed after the event bits of logs gets out of incubating.</ID>
+  </CurrentIssues>
+</SmellBaseline>