RUM-10163: Add Coil3 Integration

Author: jonathanmos

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

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,6 +180,9 @@ internal fun Method.accessible(): Method {
 
 @Suppress("TooGenericExceptionCaught")
 internal fun Field.getSafe(target: Any?): Any? {
+    if (target == null && !isStatic(modifiers)) {
+        return null
+    }
     return try {
         get(target)
     } catch (e: IllegalAccessException) {

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-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/
+

integrations/dd-sdk-android-coil3/api/apiSurface

@@ -0,0 +1,3 @@
+class com.datadog.android.coil3.DatadogCoilRequestListener : coil3.request.ImageRequest.Listener
+  constructor(com.datadog.android.api.SdkCore = Datadog.getInstance())
+  override fun onError(coil3.request.ImageRequest, coil3.request.ErrorResult)

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

@@ -0,0 +1,7 @@
+public final class com/datadog/android/coil3/DatadogCoilRequestListener : coil3/request/ImageRequest$Listener {
+	public fun <init> ()V
+	public fun <init> (Lcom/datadog/android/api/SdkCore;)V
+	public synthetic fun <init> (Lcom/datadog/android/api/SdkCore;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
+	public fun onError (Lcoil3/request/ImageRequest;Lcoil3/request/ErrorResult;)V
+}
+

integrations/dd-sdk-android-coil3/build.gradle.kts

@@ -0,0 +1,72 @@
+/*
+ * Unless explicitly stated otherwise all files in this repository are licensed under the Apache License Version 2.0.
+ * This product includes software developed at Datadog (https://www.datadoghq.com/).
+ * Copyright 2016-Present Datadog, Inc.
+ */
+
+import com.datadog.gradle.config.androidLibraryConfig
+import com.datadog.gradle.config.dependencyUpdateConfig
+import com.datadog.gradle.config.detektCustomConfig
+import com.datadog.gradle.config.javadocConfig
+import com.datadog.gradle.config.junitConfig
+import com.datadog.gradle.config.kotlinConfig
+import com.datadog.gradle.config.publishingConfig
+import org.jetbrains.kotlin.gradle.dsl.JvmTarget
+
+plugins {
+    // Build
+    id("com.android.library")
+    kotlin("android")
+
+    // Publish
+    `maven-publish`
+    signing
+    id("org.jetbrains.dokka-javadoc")
+
+    // Analysis tools
+    id("com.github.ben-manes.versions")
+
+    // Tests
+    id("org.jetbrains.kotlinx.kover")
+
+    // Internal Generation
+    id("com.datadoghq.dependency-license")
+    id("apiSurface")
+    id("transitiveDependencies")
+    id("verificationXml")
+    id("binary-compatibility-validator")
+}
+
+android {
+    namespace = "com.datadog.android.coil3"
+}
+
+dependencies {
+    implementation(project(":features:dd-sdk-android-rum"))
+    implementation(libs.kotlin)
+    implementation(libs.okHttp)
+    implementation(libs.coil3)
+    implementation(libs.coil3NetworkOkHttp)
+
+    testImplementation(project(":tools:unit")) {
+        attributes {
+            attribute(
+                com.android.build.api.attributes.ProductFlavorAttr.of("platform"),
+                objects.named("jvm")
+            )
+        }
+    }
+    testImplementation(libs.bundles.jUnit5)
+    testImplementation(libs.bundles.testTools)
+    testImplementation(libs.okHttpMock)
+}
+
+kotlinConfig(jvmBytecodeTarget = JvmTarget.JVM_11)
+androidLibraryConfig()
+junitConfig()
+javadocConfig()
+dependencyUpdateConfig()
+publishingConfig(
+    "A Coil 3 integration to use with the Datadog monitoring library for Android applications."
+)
+detektCustomConfig()

integrations/dd-sdk-android-coil3/src/main/AndroidManifest.xml

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!--
+  ~ Unless explicitly stated otherwise all files in this repository are licensed under the Apache License Version 2.0.
+  ~ This product includes software developed at Datadog (https://www.datadoghq.com/).
+  ~ Copyright 2016-Present Datadog, Inc.
+  -->
+
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
+
+</manifest>
+