Merge pull request #3062 from DataDog/feature/cronet

Rum Resources instrumentation support for Cronet network library.

Author: satween

LICENSE-3rdparty.csv

@@ -50,6 +50,7 @@ import,com.benasher44,MIT,"Copyright (c) 2019 Ben Asher"
 import,com.github.bumptech.glide,"BSD 3-Clause","Copyright 2014 Google, Inc. All rights reserved, Copyright (c) 2013. Bump Technologies Inc. All Rights Reserved."
 import,com.facebook.fresco,MIT,"Copyright (c) Facebook, Inc. and its affiliates"
 import,com.github.spotbugs,"GNU LESSER GENERAL PUBLIC LICENSE, Version 2.1","Copyright (C) 1991, 1999 Free Software Foundation, Inc."
+import,com.google.android.gms,Apache-2.0,Copyright 2018 The Android Open Source Project
 import,com.google.android.material,Apache-2.0,Copyright 2018 The Android Open Source Project
 import,com.google.code.gson,Apache-2.0,Copyright 2008 Google Inc
 import,com.google.guava,Apache-2.0,Copyright 2009 The Guava Authors
@@ -70,6 +71,7 @@ import,io.reactivex.rxjava3.android,Apache-2.0,Copyright 2015 The RxAndroid auth
 import,org.jetbrains,Apache-2.0,Copyright 2010-2019 JetBrains s.r.o. and Kotlin Programming Language contributors
 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.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

@@ -115,6 +115,7 @@ analysis:detekt-custom:
     - ./gradlew :features:dd-sdk-android-webview:customDetektRules
     - ./gradlew :integrations:dd-sdk-android-coil:customDetektRules
     - ./gradlew :integrations:dd-sdk-android-compose:customDetektRules
+    - ./gradlew :integrations:dd-sdk-android-cronet:customDetektRules
     - ./gradlew :integrations:dd-sdk-android-fresco:customDetektRules
     - ./gradlew :integrations:dd-sdk-android-glide:customDetektRules
     - ./gradlew :integrations:dd-sdk-android-okhttp:customDetektRules
@@ -788,6 +789,23 @@ publish:release-compose:
     paths:
       - integrations/dd-sdk-android-compose/verification-metadata.xml
 
+publish:release-cronet:
+  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-cronet:publishToSonatype closeSonatypeStagingRepository --stacktrace --no-daemon
+  artifacts:
+    when: on_success
+    expire_in: 7 days
+    paths:
+      - integrations/dd-sdk-android-cronet/verification-metadata.xml
+
 publish:release-fresco:
   tags: [ "arch:amd64" ]
   only:
@@ -1089,6 +1107,7 @@ notify:merge-verification-metadata:
     - publish:release-webview
     - publish:release-coil
     - publish:release-compose
+    - publish:release-cronet
     - publish:release-fresco
     - publish:release-glide
     - publish:release-trace-coroutines

dd-sdk-android-core/api/apiSurface

@@ -147,6 +147,21 @@ interface com.datadog.android.api.feature.FeatureSdkCore : com.datadog.android.a
 interface com.datadog.android.api.feature.StorageBackedFeature : Feature
   val requestFactory: com.datadog.android.api.net.RequestFactory
   val storageConfiguration: com.datadog.android.api.storage.FeatureStorageConfiguration
+interface com.datadog.android.api.instrumentation.network.ExtendedRequestInfo
+  fun <T> tag(Class<T>): T?
+fun <T> HttpRequestInfo.tag(Class<T>): T?
+interface com.datadog.android.api.instrumentation.network.HttpRequestInfo
+  val url: String
+  val headers: Map<String, List<String>>
+  val contentType: String?
+  val method: String
+  fun contentLength(): Long?
+interface com.datadog.android.api.instrumentation.network.HttpResponseInfo
+  val url: String
+  val statusCode: Int
+  val headers: Map<String, List<String>>
+  val contentType: String?
+  val contentLength: Long?
 data class com.datadog.android.api.net.Request
   constructor(String, String, String, Map<String, String>, ByteArray, String? = null)
 data class com.datadog.android.api.net.RequestExecutionContext
@@ -291,6 +306,29 @@ interface com.datadog.android.core.internal.net.FirstPartyHostHeaderTypeResolver
   fun headerTypesForUrl(okhttp3.HttpUrl): Set<com.datadog.android.trace.TracingHeaderType>
   fun getAllHeaderTypes(): Set<com.datadog.android.trace.TracingHeaderType>
   fun isEmpty(): Boolean
+object com.datadog.android.core.internal.net.HttpSpec
+  object Method
+    const val GET: String
+    const val POST: String
+    const val PATCH: String
+    const val PUT: String
+    const val HEAD: String
+    const val DELETE: String
+    const val TRACE: String
+    const val OPTIONS: String
+    const val CONNECT: String
+    fun values()
+  object Headers
+    const val CONTENT_TYPE: String
+    const val CONTENT_LENGTH: String
+    const val WEBSOCKET_ACCEPT_HEADER: String
+  object ContentType
+    const val TEXT_PLAIN: String
+    const val TEXT_EVENT_STREAM: String
+    const val APPLICATION_GRPC: String
+    const val APPLICATION_GRPC_PROTO: String
+    const val APPLICATION_GRPC_JSON: String
+    fun isStream(String?): Boolean
 interface com.datadog.android.core.internal.persistence.Deserializer<P: Any, R: Any>
   fun deserialize(P): R?
 fun java.io.File.canReadSafe(com.datadog.android.api.InternalLogger): Boolean

dd-sdk-android-core/api/dd-sdk-android-core.api

@@ -443,6 +443,30 @@ public abstract interface class com/datadog/android/api/feature/StorageBackedFea
 	public abstract fun getStorageConfiguration ()Lcom/datadog/android/api/storage/FeatureStorageConfiguration;
 }
 
+public abstract interface class com/datadog/android/api/instrumentation/network/ExtendedRequestInfo {
+	public abstract fun tag (Ljava/lang/Class;)Ljava/lang/Object;
+}
+
+public final class com/datadog/android/api/instrumentation/network/ExtendedRequestInfoKt {
+	public static final fun tag (Lcom/datadog/android/api/instrumentation/network/HttpRequestInfo;Ljava/lang/Class;)Ljava/lang/Object;
+}
+
+public abstract interface class com/datadog/android/api/instrumentation/network/HttpRequestInfo {
+	public abstract fun contentLength ()Ljava/lang/Long;
+	public abstract fun getContentType ()Ljava/lang/String;
+	public abstract fun getHeaders ()Ljava/util/Map;
+	public abstract fun getMethod ()Ljava/lang/String;
+	public abstract fun getUrl ()Ljava/lang/String;
+}
+
+public abstract interface class com/datadog/android/api/instrumentation/network/HttpResponseInfo {
+	public abstract fun getContentLength ()Ljava/lang/Long;
+	public abstract fun getContentType ()Ljava/lang/String;
+	public abstract fun getHeaders ()Ljava/util/Map;
+	public abstract fun getStatusCode ()I
+	public abstract fun getUrl ()Ljava/lang/String;
+}
+
 public final class com/datadog/android/api/net/Request {
 	public fun <init> (Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/util/Map;[BLjava/lang/String;)V
 	public synthetic fun <init> (Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/util/Map;[BLjava/lang/String;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
@@ -798,6 +822,41 @@ public abstract interface class com/datadog/android/core/internal/net/FirstParty
 	public abstract fun isFirstPartyUrl (Lokhttp3/HttpUrl;)Z
 }
 
+public final class com/datadog/android/core/internal/net/HttpSpec {
+	public static final field INSTANCE Lcom/datadog/android/core/internal/net/HttpSpec;
+}
+
+public final class com/datadog/android/core/internal/net/HttpSpec$ContentType {
+	public static final field APPLICATION_GRPC Ljava/lang/String;
+	public static final field APPLICATION_GRPC_JSON Ljava/lang/String;
+	public static final field APPLICATION_GRPC_PROTO Ljava/lang/String;
+	public static final field INSTANCE Lcom/datadog/android/core/internal/net/HttpSpec$ContentType;
+	public static final field TEXT_EVENT_STREAM Ljava/lang/String;
+	public static final field TEXT_PLAIN Ljava/lang/String;
+	public final fun isStream (Ljava/lang/String;)Z
+}
+
+public final class com/datadog/android/core/internal/net/HttpSpec$Headers {
+	public static final field CONTENT_LENGTH Ljava/lang/String;
+	public static final field CONTENT_TYPE Ljava/lang/String;
+	public static final field INSTANCE Lcom/datadog/android/core/internal/net/HttpSpec$Headers;
+	public static final field WEBSOCKET_ACCEPT_HEADER Ljava/lang/String;
+}
+
+public final class com/datadog/android/core/internal/net/HttpSpec$Method {
+	public static final field CONNECT Ljava/lang/String;
+	public static final field DELETE Ljava/lang/String;
+	public static final field GET Ljava/lang/String;
+	public static final field HEAD Ljava/lang/String;
+	public static final field INSTANCE Lcom/datadog/android/core/internal/net/HttpSpec$Method;
+	public static final field OPTIONS Ljava/lang/String;
+	public static final field PATCH Ljava/lang/String;
+	public static final field POST Ljava/lang/String;
+	public static final field PUT Ljava/lang/String;
+	public static final field TRACE Ljava/lang/String;
+	public final fun values ()Ljava/util/List;
+}
+
 public abstract interface class com/datadog/android/core/internal/persistence/Deserializer {
 	public abstract fun deserialize (Ljava/lang/Object;)Ljava/lang/Object;
 }

dd-sdk-android-core/src/main/kotlin/com/datadog/android/api/instrumentation/network/ExtendedRequestInfo.kt

@@ -0,0 +1,22 @@
+/*
+ * 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.
+ */
+package com.datadog.android.api.instrumentation.network
+
+/**
+ * This interface indicates that the request supports non HTTP-specified methods.
+ */
+interface ExtendedRequestInfo {
+
+    /**
+     * Returns the tag attached with type as a key, or null if no tag is attached with that key.
+     */
+    fun <T> tag(type: Class<out T>): T?
+}
+
+/**
+ * Returns the tag attached with type as a key, or null if no tag is attached with that key.
+ */
+fun <T> HttpRequestInfo.tag(type: Class<out T>): T? = if (this is ExtendedRequestInfo) this.tag(type) else null

dd-sdk-android-core/src/main/kotlin/com/datadog/android/api/instrumentation/network/HttpRequestInfo.kt

@@ -0,0 +1,39 @@
+/*
+ * 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.
+ */
+package com.datadog.android.api.instrumentation.network
+
+/**
+ * Represents information about an HTTP request.
+ */
+interface HttpRequestInfo {
+    /**
+     * The URL associated with the HTTP request.
+     */
+    val url: String
+
+    /**
+     * Represents the HTTP headers associated with the request.
+     */
+    val headers: Map<String, List<String>>
+
+    /**
+     * The MIME type of the payload associated with the HTTP request or response, represented
+     * as a string. Can be null if the content type is unspecified.
+     */
+    val contentType: String?
+
+    /**
+     * Represents the HTTP method associated with the request.
+     */
+    val method: String
+
+    /**
+     * Retrieves the content length of the HTTP request.
+     *
+     * @return the length of the content in bytes, or null if the content length is unavailable.
+     */
+    fun contentLength(): Long?
+}

dd-sdk-android-core/src/main/kotlin/com/datadog/android/api/instrumentation/network/HttpResponseInfo.kt

@@ -0,0 +1,38 @@
+/*
+ * 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.
+ */
+package com.datadog.android.api.instrumentation.network
+
+/**
+ * Represents information about an HTTP response.
+ */
+interface HttpResponseInfo {
+    /**
+     * Represents the URL associated with an HTTP response.
+     */
+    val url: String
+
+    /**
+     * Represents the HTTP status code associated with the response.
+     */
+    val statusCode: Int
+
+    /**
+     * Represents the HTTP headers associated with a response.
+     */
+    val headers: Map<String, List<String>>
+
+    /**
+     * Represents the MIME type of the payload associated with an HTTP response.
+     */
+    val contentType: String?
+
+    /**
+     * Retrieves the content length from the response information.
+     *
+     * @return the content length as a Long if available, or null if it cannot be determined.
+     */
+    val contentLength: Long?
+}

dd-sdk-android-core/src/main/kotlin/com/datadog/android/core/internal/net/HttpSpec.kt

@@ -0,0 +1,103 @@
+/*
+ * 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.
+ */
+package com.datadog.android.core.internal.net
+
+import com.datadog.android.lint.InternalApi
+
+/**
+ * HTTP specification constants and utilities.
+ */
+@InternalApi
+object HttpSpec {
+
+    /**
+     * Standard HTTP request methods.
+     */
+    object Method {
+        /** HTTP GET method. */
+        const val GET: String = "GET"
+
+        /** HTTP POST method. */
+        const val POST: String = "POST"
+
+        /** HTTP PATCH method. */
+        const val PATCH: String = "PATCH"
+
+        /** HTTP PUT method. */
+        const val PUT: String = "PUT"
+
+        /** HTTP HEAD method. */
+        const val HEAD: String = "HEAD"
+
+        /** HTTP DELETE method. */
+        const val DELETE: String = "DELETE"
+
+        /** HTTP TRACE method. */
+        const val TRACE: String = "TRACE"
+
+        /** HTTP OPTIONS method. */
+        const val OPTIONS: String = "OPTIONS"
+
+        /** HTTP CONNECT method. */
+        const val CONNECT: String = "CONNECT"
+
+        /**
+         * Returns a list of all HTTP methods.
+         */
+        fun values() = listOf(GET, POST, PATCH, PUT, HEAD, DELETE, TRACE, OPTIONS, CONNECT)
+    }
+
+    /**
+     * Standard HTTP header names.
+     */
+    object Headers {
+        /** Content-Type header name. */
+        const val CONTENT_TYPE: String = "Content-Type"
+
+        /** Content-Length header name. */
+        const val CONTENT_LENGTH: String = "Content-Length"
+
+        /** Sec-WebSocket-Accept header name. */
+        const val WEBSOCKET_ACCEPT_HEADER: String = "Sec-WebSocket-Accept"
+    }
+
+    /**
+     * HTTP content type values and utilities.
+     */
+    object ContentType {
+
+        /** Plain text content type. */
+        const val TEXT_PLAIN: String = "text/plain"
+
+        /** Server-Sent Events content type. */
+        const val TEXT_EVENT_STREAM: String = "text/event-stream"
+
+        /** gRPC content type. */
+        const val APPLICATION_GRPC: String = "application/grpc"
+
+        /** gRPC with Protocol Buffers content type. */
+        const val APPLICATION_GRPC_PROTO: String = "application/grpc+proto"
+
+        /** gRPC with JSON content type. */
+        const val APPLICATION_GRPC_JSON: String = "application/grpc+json"
+
+        /**
+         * Checks if the given content type represents a streaming protocol.
+         * @param contentType the content type to check
+         * @return true if the content type is a stream type, false otherwise
+         */
+        fun isStream(contentType: String?): Boolean {
+            return contentType != null && contentType in STREAM_CONTENT_TYPES
+        }
+
+        private val STREAM_CONTENT_TYPES = setOf(
+            TEXT_EVENT_STREAM,
+            APPLICATION_GRPC,
+            APPLICATION_GRPC_PROTO,
+            APPLICATION_GRPC_JSON
+        )
+    }
+}