Merge pull request #3054 from DataDog/jmoskovich/rum-10163/coil3-support

RUM-10163: Add Coil3 Integration

Author: jonathanmos

CONTRIBUTING.md

@@ -40,6 +40,7 @@ This project hosts the following modules:
   - `integrations/***`: a set of libraries integrating Datadog products in third party libraries:
     - `integrations/dd-sdk-android-apollo`: a lightweight library providing a bridge integration between Datadog SDK and [Apollo Kotlin](https://github.com/apollographql/apollo-kotlin)
     - `integrations/dd-sdk-android-coil`: a lightweight library providing a bridge integration between Datadog SDK and [Coil](https://coil-kt.github.io/coil/);
+    - `integrations/dd-sdk-android-coil3`: a lightweight library providing a bridge integration between Datadog SDK and [Coil 3](https://coil-kt.github.io/coil/);
     - `integrations/dd-sdk-android-compose`: a lightweight library providing a bridge integration between Datadog SDK and [Jetpack Compose](https://developer.android.com/jetpack/compose);
     - `integrations/dd-sdk-android-fresco`: a lightweight library providing a bridge integration between Datadog SDK and [Fresco](https://frescolib.org/);
     - `integrations/dd-sdk-android-glide`: a lightweight library providing a bridge integration between Datadog SDK and [Glide](https://bumptech.github.io/glide/);

LICENSE-3rdparty.csv

@@ -63,6 +63,7 @@ import,com.squareup.sqldelight,Apache-2.0,"Copyright 2016 Square, Inc"
 import,com.fasterxml.jackson,Apache-2.0,"Copyright 2020 Datadog, Inc."
 import,com.datadoghq,Apache-2.0,"Copyright 2017 Datadog, Inc"
 import,io.coil-kt,Apache-2.0,Copyright 2021 Coil Contributors
+import,io.coil-kt.coil3,Apache-2.0,Copyright 2021 Coil Contributors
 import,io.opentelemetry,Apache-2.0,Copyright 2019 The OpenTelemetry Authors
 import,io.opentracing,Apache-2.0,Copyright 2016-2017 The OpenTracing Authors
 import,io.opentracing.contrib,Apache-2.0,Copyright 2016-2017 The OpenTracing Authors
@@ -72,6 +73,7 @@ import,org.jetbrains,Apache-2.0,Copyright 2010-2019 JetBrains s.r.o. and Kotlin
 import,org.jetbrains.kotlin,Apache-2.0,Copyright 2010-2019 JetBrains s.r.o. and Kotlin Programming Language contributors
 import,org.jetbrains.kotlinx,Apache-2.0,Copyright 2010-2019 JetBrains s.r.o. and Kotlin Programming Language contributors
 import,org.chromium.net,Apache-2.0,"Copyright 2015 The Chromium Authors"
+import,org.jetbrains.skiko,Apache-2.0,Copyright 2010-2019 JetBrains s.r.o. and Kotlin Programming Language contributors
 import,org.reactivestreams,CC0,Copyright 2014 Reactive Streams
 import(test),androidx.autofill,Apache-2.0,Copyright 2018 The Android Open Source Project
 import(test),androidx.concurrent,Apache-2.0,Copyright 2018 The Android Open Source Project

ci/pipelines/default-pipeline.yml

@@ -119,6 +119,7 @@ analysis:detekt-custom:
     - ./gradlew :features:dd-sdk-android-trace-otel:customDetektRules
     - ./gradlew :features:dd-sdk-android-webview:customDetektRules
     - ./gradlew :integrations:dd-sdk-android-coil:customDetektRules
+    - ./gradlew :integrations:dd-sdk-android-coil3:customDetektRules
     - ./gradlew :integrations:dd-sdk-android-compose:customDetektRules
     - ./gradlew :integrations:dd-sdk-android-cronet:customDetektRules
     - ./gradlew :integrations:dd-sdk-android-fresco:customDetektRules
@@ -783,6 +784,23 @@ publish:release-coil:
     paths:
       - integrations/dd-sdk-android-coil/verification-metadata.xml
 
+publish:release-coil3:
+  tags: [ "arch:amd64" ]
+  only:
+    - tags
+    - develop
+  image: $CI_IMAGE_DOCKER
+  stage: publish
+  timeout: 30m
+  script:
+    - !reference [.snippets, set-publishing-credentials]
+    - ./gradlew :integrations:dd-sdk-android-coil3:publishToSonatype closeSonatypeStagingRepository --stacktrace --no-daemon
+  artifacts:
+    when: on_success
+    expire_in: 7 days
+    paths:
+      - integrations/dd-sdk-android-coil3/verification-metadata.xml
+
 publish:release-compose:
   tags: [ "arch:amd64" ]
   only:
@@ -1117,6 +1135,7 @@ notify:merge-verification-metadata:
     - publish:release-session-replay-compose
     - publish:release-webview
     - publish:release-coil
+    - publish:release-coil3
     - publish:release-compose
     - publish:release-cronet
     - publish:release-fresco

detekt_custom_safe_calls.yml

@@ -584,6 +584,7 @@ datadog:
       - "java.lang.ref.WeakReference.constructor(kotlin.Nothing?)"
       - "java.lang.ref.WeakReference.constructor(kotlin.String?)"
       - "java.lang.ref.WeakReference.get()"
+      - "java.lang.reflect.isStatic(kotlin.Int)"
       - "java.lang.reflect.Field.getSafe(kotlin.Any?)"
       - "java.lang.reflect.Field.accessible()"
       - "java.lang.StringBuilder.append(kotlin.Char)"

features/dd-sdk-android-session-replay-compose/src/main/kotlin/com/datadog/android/sessionreplay/compose/internal/reflection/ComposeReflection.kt

@@ -12,6 +12,7 @@ import com.datadog.android.api.InternalLogger
 import com.datadog.android.api.feature.FeatureSdkCore
 import java.lang.reflect.Field
 import java.lang.reflect.Method
+import java.lang.reflect.Modifier.isStatic
 
 @Suppress("StringLiteralDuplication")
 internal object ComposeReflection {
@@ -179,17 +180,18 @@ internal fun Method.accessible(): Method {
 
 @Suppress("TooGenericExceptionCaught")
 internal fun Field.getSafe(target: Any?): Any? {
+    if (target == null && !isStatic(modifiers)) {
+        return null
+    }
     return try {
+        @Suppress("UnsafeThirdPartyFunctionCall") // null is checked above so no npe possible
         get(target)
     } catch (e: IllegalAccessException) {
         logReflectionException(name, LOG_TYPE_FIELD, LOG_REASON_FIELD_NO_ACCESSIBLE, e)
         null
     } catch (e: IllegalArgumentException) {
         logReflectionException(name, LOG_TYPE_FIELD, LOG_REASON_INCOMPATIBLE_TYPE, e)
         null
-    } catch (e: NullPointerException) {
-        logNullPointerException(name, LOG_TYPE_FIELD, e)
-        null
     } catch (e: ExceptionInInitializerError) {
         logReflectionException(name, LOG_TYPE_FIELD, LOG_REASON_INITIALIZATION_ERROR, e)
         null

features/dd-sdk-android-session-replay-compose/src/main/kotlin/com/datadog/android/sessionreplay/compose/internal/utils/ReflectionUtils.kt

@@ -159,9 +159,8 @@ internal class ReflectionUtils {
     fun getCoil3AsyncImagePainter(semanticsNode: SemanticsNode): Painter? {
         // Check if Coil3 ContentPainterNode is present first to optimize the performance
         // by skipping the node chain iteration
-        if (PainterNodeClass == null) {
-            return null
-        }
+        if (PainterNodeClass == null) return null
+
         val layoutNode = LayoutNodeField?.getSafe(semanticsNode)
         val nodeChain = NodesFieldOfLayoutNode?.getSafe(layoutNode)
         val headNode = HeadFieldOfNodeChain?.getSafe(nodeChain) as? Modifier.Node
@@ -176,8 +175,7 @@ internal class ReflectionUtils {
             currentNode = ChildFieldOfModifierNode?.getSafe(currentNode) as? Modifier.Node
         }
         val asyncImagePainter = PainterFieldOfPainterNode?.getSafe(painterNode)
-        val painter =
-            asyncImagePainter?.let { PainterMethodOfAsync3ImagePainter?.invoke(it) }
+        val painter = asyncImagePainter?.let { PainterMethodOfAsync3ImagePainter?.invoke(it) }
         return painter as? Painter
     }
 
@@ -205,9 +203,8 @@ internal class ReflectionUtils {
     fun getAsyncImagePainter(semanticsNode: SemanticsNode): Painter? {
         // Check if Coil AsyncImagePainter is present first to optimize the performance
         // by skipping the modifier iteration
-        if (AsyncImagePainterClass == null) {
-            return null
-        }
+        if (AsyncImagePainterClass == null) return null
+
         val asyncPainter = semanticsNode.layoutInfo.getModifierInfo().firstNotNullOfOrNull {
             if (ContentPainterModifierClass?.isInstance(it.modifier) == true) {
                 PainterFieldOfContentPainterModifier?.getSafe(it.modifier)

gradle/libs.versions.toml

@@ -85,6 +85,7 @@ kotlinXmlBuilder = "1.9.3"
 sqlDelight = "1.5.5"
 coil = "1.0.0"
 coilCompose = "2.1.0"
+coil3 = "3.0.4"
 fresco = "2.3.0"
 glide = "4.11.0"
 picasso = "2.8"
@@ -237,6 +238,9 @@ kotlinXmlBuilder = {module="org.redundent:kotlin-xml-builder", version.ref="kotl
 sqlDelight = { module = "com.squareup.sqldelight:android-driver", version.ref = "sqlDelight" }
 coil = { module = "io.coil-kt:coil", version.ref = "coil" }
 coilCompose = { module = "io.coil-kt:coil-compose", version.ref = "coilCompose" }
+coil3 = { module = "io.coil-kt.coil3:coil", version.ref = "coil3" }
+coil3Compose = { module = "io.coil-kt.coil3:coil-compose", version.ref = "coil3" }
+coil3NetworkOkHttp = { module = "io.coil-kt.coil3:coil-network-okhttp", version.ref = "coil3" }
 
 frescoCore = { module = "com.facebook.fresco:fresco", version.ref = "fresco" }
 frescoOkHttp3 = { module = "com.facebook.fresco:imagepipeline-okhttp3", version.ref = "fresco" }

integrations/dd-sdk-android-coil/src/test/kotlin/com/datadog/android/coil/DatadogCoilRequestListenerTest.kt

@@ -49,7 +49,7 @@ import kotlin.reflect.jvm.isAccessible
 @MockitoSettings(strictness = Strictness.LENIENT)
 internal class DatadogCoilRequestListenerTest {
 
-    lateinit var underTest: DatadogCoilRequestListener
+    private lateinit var testable: DatadogCoilRequestListener
 
     @Mock
     lateinit var mockRumMonitor: RumMonitor
@@ -68,7 +68,7 @@ internal class DatadogCoilRequestListenerTest {
             isAccessible = true
             call(GlobalRumMonitor::class.objectInstance, mockRumMonitor, mockSdkCore)
         }
-        underTest = DatadogCoilRequestListener(mockSdkCore)
+        testable = DatadogCoilRequestListener(mockSdkCore)
     }
 
     @AfterEach
@@ -88,7 +88,7 @@ internal class DatadogCoilRequestListenerTest {
         mockRequest = mockImageRequest(fakePath)
 
         // WHEN
-        underTest.onError(mockRequest, fakeException)
+        testable.onError(mockRequest, fakeException)
 
         // THEN
         val argumentCaptor = argumentCaptor<Map<String, Any?>>()
@@ -114,7 +114,7 @@ internal class DatadogCoilRequestListenerTest {
         mockRequest = mockImageRequest(mockUri)
 
         // WHEN
-        underTest.onError(mockRequest, fakeException)
+        testable.onError(mockRequest, fakeException)
 
         // THEN
         val argumentCaptor = argumentCaptor<Map<String, Any?>>()
@@ -137,7 +137,7 @@ internal class DatadogCoilRequestListenerTest {
         mockRequest = mockImageRequest(fakeHttpUrl)
 
         // WHEN
-        underTest.onError(mockRequest, fakeException)
+        testable.onError(mockRequest, fakeException)
 
         // THEN
         val argumentCaptor = argumentCaptor<Map<String, Any?>>()
@@ -160,7 +160,7 @@ internal class DatadogCoilRequestListenerTest {
         mockRequest = mockImageRequest(fakeFile)
 
         // WHEN
-        underTest.onError(mockRequest, fakeException)
+        testable.onError(mockRequest, fakeException)
 
         // THEN
         val argumentCaptor = argumentCaptor<Map<String, Any?>>()
@@ -183,7 +183,7 @@ internal class DatadogCoilRequestListenerTest {
         mockRequest = mockImageRequest(mockDrawable)
 
         // WHEN
-        underTest.onError(mockRequest, fakeException)
+        testable.onError(mockRequest, fakeException)
 
         // THEN
         val argumentCaptor = argumentCaptor<Map<String, Any?>>()
@@ -203,7 +203,7 @@ internal class DatadogCoilRequestListenerTest {
         mockRequest = mockImageRequest(mockDrawable)
 
         // WHEN
-        underTest.onError(mockRequest, fakeException)
+        testable.onError(mockRequest, fakeException)
 
         // THEN
         val argumentCaptor = argumentCaptor<Map<String, Any?>>()

integrations/dd-sdk-android-coil3/.gitignore

@@ -0,0 +1,19 @@
+# Built application files
+*.apk
+*.ap_
+*.aab
+
+# Files for the ART/Dalvik VM
+*.dex
+
+# Java class files
+*.class
+
+# Generated files
+bin/
+gen/
+out/
+
+# Gradle files
+build/
+

integrations/dd-sdk-android-coil3/README.md

@@ -0,0 +1,64 @@
+# Datadog Integration for Coil 3
+
+## Getting Started 
+
+To include the Datadog integration for [Coil 3][1] in your project, add the
+following to your application's `build.gradle` file.
+
+```groovy
+dependencies {
+    implementation "com.datadoghq:dd-sdk-android-rum:<latest-version>"
+    implementation "com.datadoghq:dd-sdk-android-okhttp:<latest-version>"
+    implementation "com.datadoghq:dd-sdk-android-coil3:<latest-version>"
+}
+```
+
+### Initial Setup
+
+1. Setup RUM monitoring, see the dedicated [Datadog Android RUM Collection documentation][2] to learn how.
+2. Setup OkHttp instrumentation with Datadog RUM SDK, see the [dedicated documentation][3] to learn how.
+
+Follow Coil 3's [documentation][4] to:
+ 
+ - Create your own `ImageLoader` by providing your own `OkHttpClient` (configured with `DatadogInterceptor`) using `OkHttpNetworkFetcherFactory`.
+
+```kotlin
+    val okHttpClient = OkHttpClient.Builder()
+        .addInterceptor(DatadogInterceptor.Builder(tracedHosts).build())
+        .build()
+
+    val imageLoader = ImageLoader.Builder(context)
+        .components {
+            add(OkHttpNetworkFetcherFactory(okHttpClient))
+        }
+        .build()
+
+    SingletonImageLoader.setSafe { imageLoader }
+```
+
+- Decorate the `ImageRequest.Builder` with the `DatadogCoilRequestListener` whenever you perform an image loading request.
+ 
+```kotlin
+    imageView.load(uri) {
+       listener(DatadogCoilRequestListener())
+    }
+```
+
+With this setup:
+- The `DatadogInterceptor` on OkHttpClient automatically tracks Coil's network requests (creating APM Traces and RUM Resource events)
+- The `DatadogCoilRequestListener` reports image loading failures (creating RUM Error events)
+
+## Contributing
+
+For details on contributing, read the 
+[Contributing Guide](../../CONTRIBUTING.md).
+
+## License
+
+[Apache License, v2.0](../../LICENSE)
+
+[1]: https://github.com/coil-kt/coil
+[2]: https://docs.datadoghq.com/real_user_monitoring/android/?tab=kotlin
+[3]: https://docs.datadoghq.com/real_user_monitoring/android/advanced_configuration/?tab=kotlin#automatically-track-network-requests
+[4]: https://coil-kt.github.io/coil/upgrading_to_coil3/
+