Merge remote-tracking branch 'origin/develop' into feature/v3

Author: satween

.gitlab-ci.yml

@@ -1,5 +1,5 @@
 variables:
-  CURRENT_CI_IMAGE: "17"
+  CURRENT_CI_IMAGE: "18"
   CI_IMAGE_DOCKER: registry.ddbuild.io/ci/dd-sdk-android:$CURRENT_CI_IMAGE
   GIT_DEPTH: 5
 

CONTRIBUTING.md

@@ -24,23 +24,28 @@ In addition, to be able to run the static analysis tools locally, you should run
 This project hosts the following modules:
 
   - `dd-sdk-android-core`: the main library implementing the core functionality of SDK (storage and upload of data, core APIs);
+  - `dd-sdk-android-internal`: a library providing internal APIs, classes and utilities shared by the SDK modules;
   - `features/***`: a set of libraries implementing Datadog products: 
     - `features/dd-sdk-android-logs`: a library to send logs to Datadog;
     - `features/dd-sdk-android-rum`: a library to track user navigation and interaction;
     - `features/dd-sdk-android-ndk`: a lightweight library to track crashes from NDK libraries;
     - `features/dd-sdk-android-session-replay`: a library to capture the window content;
+    - `features/dd-sdk-android-session-replay-compose`: an extension for Session Replay to integrate with the Jetpack Compose;
     - `features/dd-sdk-android-session-replay-material`: an extension for Session Replay to integrate with the Material Design library;
-    - `features/dd-sdk-android-session-trace`: a library to measure performance of operations locally;
-    - `features/dd-sdk-android-session-webview`: a library to forward logs and RUM events captured in a webview to be linked with the mobile session;
+    - `features/dd-sdk-android-trace`: a library to measure performance of operations locally;
+    - `features/dd-sdk-android-trace-otel`: an extension of Trace library to integrate with OpenTelemetry;
+    - `features/dd-sdk-android-webview`: a library to forward logs and RUM events captured in a webview to be linked with the mobile session;
   - `integrations/***`: a set of libraries integrating Datadog products in third party libraries:
     - `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-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-okhttp`: a lightweight library providing an instrumentation for [OkHttp](https://square.github.io/okhttp/);
+    - `integrations/dd-sdk-android-okhttp-otel`: a lightweight library a support of OpenTelemetry for the [OkHttp](https://square.github.io/okhttp/) instrumentation;
     - `integrations/dd-sdk-android-rx`: a lightweight library providing a bridge integration between Datadog SDK and [RxJava](https://github.com/ReactiveX/RxJava);
     - `integrations/dd-sdk-android-sqldelight`: a lightweight library providing a bridge integration between Datadog SDK and [SQLDelight](https://cashapp.github.io/sqldelight/);
     - `integrations/dd-sdk-android-tv`: a lightweight library providing extensions for [Android TV](https://www.android.com/tv/)
-    - `integrations/dd-sdk-android-ktx`: a set of Kotlin extensions to make the Datadog SDK more Kotlin friendly;
+    - `integrations/dd-sdk-android-trace-coroutines`: a set of extensions for Kotlin Coroutines to ease the work with the Trace library;
+    - `integrations/dd-sdk-android-rum-coroutines`: a set of extensions for Kotlin Coroutines to ease the work with the RUM library;
     - `integrations/dd-sdk-android-glide`: a lightweight library providing a bridge integration between Datadog SDK and [Glide](https://bumptech.github.io/glide/);
     - `integrations/dd-sdk-android-timber`: a lightweight library providing a bridge integration between Datadog SDK and [Timber](https://github.com/JakeWharton/timber);
   - `instrumented/***`: a set of modules used to run instrumented tests:
@@ -52,8 +57,11 @@ This project hosts the following modules:
     - `tools/unit`: a utility library with code to help writing unit tests;
   - `sample/***`: a few sample applications showcasing how to use the library features in production code;
     - `sample/kotlin`: a sample mobile application;
-    - `sample/vendor-lib`: a sample android library, to showcase vendors using Datadog in a host app also using Datadog;
-    - `sample/wear`: a sample watch application;
+    - `sample/vendor-lib`: a sample Android library, to showcase vendors using Datadog in a host app also using Datadog;
+    - `sample/wear`: a sample Wear OS application;
+    - `sample/automotive`: a sample Automotive OS application;
+    - `sample/tv`: a sample Android TV OS application;
+    - `sample/benchmark`: a sample application to collect SDK performance metrics;
 
 ### Building the SDK
 

build.gradle.kts

@@ -49,11 +49,16 @@ allprojects {
 nexusPublishing {
     this.repositories {
         sonatype {
-            val sonatypeUsername = System.getenv("OSSRH_USERNAME")
-            val sonatypePassword = System.getenv("OSSRH_PASSWORD")
-            stagingProfileId.set("378eecbbe2cf9")
+            val sonatypeUsername = System.getenv("CENTRAL_PUBLISHER_USERNAME")
+            val sonatypePassword = System.getenv("CENTRAL_PUBLISHER_PASSWORD")
             if (sonatypeUsername != null) username.set(sonatypeUsername)
             if (sonatypePassword != null) password.set(sonatypePassword)
+            // see https://github.com/gradle-nexus/publish-plugin#publishing-to-maven-central-via-sonatype-central
+            // For official documentation:
+            // staging repo publishing https://central.sonatype.org/publish/publish-portal-ossrh-staging-api/#configuration
+            // snapshot publishing https://central.sonatype.org/publish/publish-portal-snapshots/#publishing-via-other-methods
+            nexusUrl.set(uri("https://ossrh-staging-api.central.sonatype.com/service/local/"))
+            snapshotRepositoryUrl.set(uri("https://central.sonatype.com/repository/maven-snapshots/"))
         }
     }
 }

ci/Dockerfile.gitlab

@@ -1,4 +1,5 @@
-FROM registry.ddbuild.io/images/docker:24.0.4-gbi-focal
+# This base image is based on a GBI image
+FROM registry.ddbuild.io/images/docker:24.0.4-jammy
 
 ENV DEBIAN_FRONTEND=noninteractive
 

ci/pipelines/default-pipeline.yml

@@ -42,8 +42,8 @@ stages:
     - aws ssm get-parameter --region us-east-1 --name ci.dd-sdk-android.gradle-properties --with-decryption --query "Parameter.Value" --out text >> ./gradle.properties
     - export GPG_PRIVATE_KEY=$(aws ssm get-parameter --region us-east-1 --name ci.dd-sdk-android.signing.gpg_private_key --with-decryption --query "Parameter.Value" --out text)
     - export GPG_PASSWORD=$(aws ssm get-parameter --region us-east-1 --name ci.dd-sdk-android.signing.gpg_passphrase --with-decryption --query "Parameter.Value" --out text)
-    - export OSSRH_USERNAME=$(aws ssm get-parameter --region us-east-1 --name ci.dd-sdk-android.signing.ossrh_username --with-decryption --query "Parameter.Value" --out text)
-    - export OSSRH_PASSWORD=$(aws ssm get-parameter --region us-east-1 --name ci.dd-sdk-android.signing.ossrh_password --with-decryption --query "Parameter.Value" --out text)
+    - export CENTRAL_PUBLISHER_USERNAME=$(aws ssm get-parameter --region us-east-1 --name ci.dd-sdk-android.publishing.central_username --with-decryption --query "Parameter.Value" --out text)
+    - export CENTRAL_PUBLISHER_PASSWORD=$(aws ssm get-parameter --region us-east-1 --name ci.dd-sdk-android.publishing.central_password --with-decryption --query "Parameter.Value" --out text)
     - export GPG_PUBLIC_FINGERPRINT=$(aws ssm get-parameter --region us-east-1 --name ci.dd-sdk-android.signing.gpg_public_key --with-decryption --query "Parameter.Value" --out text | gpg --import --import-options show-only | grep -E -o -e "[A-F0-9]{40}")
 
 # CI IMAGE
@@ -53,7 +53,7 @@ ci-image:
   when: manual
   except: [ tags, schedules ]
   tags: [ "arch:amd64" ]
-  image: 486234852809.dkr.ecr.us-east-1.amazonaws.com/docker:24.0.4-gbi-focal
+  image: 486234852809.dkr.ecr.us-east-1.amazonaws.com/docker:24.0.4-jammy
   script:
     - docker buildx build --tag $CI_IMAGE_DOCKER -f ./ci/Dockerfile.gitlab --push .
 
@@ -974,6 +974,9 @@ notify:dogfood-app:
   only:
     - tags
   image: $CI_IMAGE_DOCKER
+  id_tokens:
+    DDOCTOSTS_ID_TOKEN:
+      aud: dd-octo-sts
   stage: notify
   when: on_success
   script:
@@ -986,6 +989,9 @@ notify:dogfood-demo:
   only:
     - tags
   image: $CI_IMAGE_DOCKER
+  id_tokens:
+    DDOCTOSTS_ID_TOKEN:
+      aud: dd-octo-sts
   stage: notify
   when: on_success
   script:

ci/scripts/check_latest_release_is_published.sh

@@ -18,11 +18,5 @@ for artifactId in $(./gradlew -q listAllPublishedArtifactIds); do
     echo "Release $tag_name exists for $artifactId"
   else
     echo "Release $tag_name doesn't exist for $artifactId"
-    # TODO remove this check when
-    # https://github.com/DataDog/dd-sdk-android/commit/ccd79322895a6ba135e2b73b32005fb4aeb5c31c
-    # is released
-    if [ $artifactId != "dd-sdk-android-benchmark-internal" ]; then
-      exit 1
-    fi
   fi
 done

features/dd-sdk-android-session-replay/src/main/kotlin/com/datadog/android/sessionreplay/internal/async/RecordedDataQueueHandler.kt

@@ -99,7 +99,6 @@ internal class RecordedDataQueueHandler(
      * for example if a snapshot failed to traverse the tree).
      * If neither of the previous conditions occurs, the loop breaks.
      */
-    @MainThread
     override fun tryToConsumeItems() {
         // no need to create a thread if the queue is empty
         if (recordedDataQueue.isEmpty()) {

features/dd-sdk-android-session-replay/src/main/kotlin/com/datadog/android/sessionreplay/internal/async/RecordedDataQueueRefs.kt

@@ -6,15 +6,11 @@
 
 package com.datadog.android.sessionreplay.internal.async
 
-import android.os.Handler
-import android.os.Looper
-
 /**
  * References to the work queue context.
  */
 internal data class RecordedDataQueueRefs(
-    private val recordedDataQueueHandler: RecordedDataQueueHandler,
-    private val mainThreadHandler: Handler = Handler(Looper.getMainLooper())
+    private val recordedDataQueueHandler: RecordedDataQueueHandler
 ) {
     // this can only be populated after the snapshot has been created
     internal var recordedDataQueueItem: SnapshotRecordedDataQueueItem? = null
@@ -28,9 +24,6 @@ internal data class RecordedDataQueueRefs(
     }
 
     internal fun tryToConsumeItem() {
-        mainThreadHandler.post {
-            @Suppress("ThreadSafety") // we are in the main thread context
-            recordedDataQueueHandler.tryToConsumeItems()
-        }
+        recordedDataQueueHandler.tryToConsumeItems()
     }
 }

features/dd-sdk-android-session-replay/src/main/kotlin/com/datadog/android/sessionreplay/internal/processor/NodeFlattener.kt

@@ -19,7 +19,7 @@ internal class NodeFlattener(private val wireframeUtils: WireframeUtils = Wirefr
         stack.push(root)
         while (stack.isNotEmpty()) {
             val node = stack.pop()
-            node.wireframes
+            node.wireframes.toList()
                 .map { wireframe ->
                     val clip = wireframeUtils.resolveWireframeClip(wireframe, node.parents)
                     wireframe.copy(clip = clip)

features/dd-sdk-android-session-replay/src/test/kotlin/com/datadog/android/sessionreplay/internal/async/RecordedDataQueueRefsTest.kt

@@ -6,7 +6,6 @@
 
 package com.datadog.android.sessionreplay.internal.async
 
-import android.os.Handler
 import com.datadog.android.sessionreplay.forge.ForgeConfigurator
 import fr.xgouchet.elmyr.junit5.ForgeConfiguration
 import fr.xgouchet.elmyr.junit5.ForgeExtension
@@ -15,10 +14,8 @@ import org.junit.jupiter.api.Test
 import org.junit.jupiter.api.extension.ExtendWith
 import org.junit.jupiter.api.extension.Extensions
 import org.mockito.Mock
-import org.mockito.Mockito.`when`
 import org.mockito.junit.jupiter.MockitoExtension
 import org.mockito.junit.jupiter.MockitoSettings
-import org.mockito.kotlin.any
 import org.mockito.kotlin.verify
 import org.mockito.quality.Strictness
 
@@ -37,18 +34,9 @@ internal class RecordedDataQueueRefsTest {
     @Mock
     lateinit var mockRecordedDataQueueItem: SnapshotRecordedDataQueueItem
 
-    @Mock
-    lateinit var mockHandler: Handler
-
     @BeforeEach
     fun setup() {
-        // make mockHandler execute all runnables immediately
-        `when`(mockHandler.post(any())).thenAnswer {
-            (it.arguments[0] as Runnable).run()
-            true
-        }
-
-        testedDataQueueRefs = RecordedDataQueueRefs(mockDataQueueHandler, mockHandler)
+        testedDataQueueRefs = RecordedDataQueueRefs(mockDataQueueHandler)
         testedDataQueueRefs.recordedDataQueueItem = mockRecordedDataQueueItem
     }