Merge pull request #203 from DataDog/nogorodnikov/merge-release-1.12.…

…0-into-main

Merge `release/1.12.0` branch into `main` branch

CHANGELOG.md

@@ -1,3 +1,9 @@
+# 1.12.0 / 2023-10-30
+
+* [IMPROVEMENT] Make plugin compatible with Kotlin Script. See [#197](https://github.com/DataDog/dd-sdk-android-gradle-plugin/pull/197)
+* [IMPROVEMENT] Lower log level from warning to info when no minification enabled. See [#198](https://github.com/DataDog/dd-sdk-android-gradle-plugin/pull/198)
+* [IMPROVEMENT] Allow customer to use non-standard obfuscation. See [#199](https://github.com/DataDog/dd-sdk-android-gradle-plugin/pull/199)
+
 # 1.11.0 / 2023-09-13
 
 * [BUGFIX] Delete old shrinked mapping file before writing to it. See [#189](https://github.com/DataDog/dd-sdk-android-gradle-plugin/pull/189)

README.md

@@ -32,6 +32,8 @@ datadog {
 
 If you're using variants, you can set a custom configuration per variant using the following syntax.
 
+#### Groovy 
+
 ```groovy
 datadog {
     site = "US1" // Variants with no configurations will use this as default
@@ -44,6 +46,20 @@ datadog {
 }
 ```
 
+#### Kotlin Script
+
+```kotlin
+datadog {
+    site = "US1" // Variants with no configurations will use this as default
+    variants {
+        register("fr") {
+            site = "EU1"
+            mappingFilePath = "path/to/fr/mapping.txt"
+        }
+    }
+}
+```
+
 ### Gradle configuration cache support
 
 This plugin supports [Gradle configuration cache](https://docs.gradle.org/7.1/userguide/configuration_cache.html) starting from the version `1.1.0`, but to have this support you need to disable SDK dependency check by setting `checkProjectDependencies` to `none`:

buildSrc/src/main/kotlin/com/datadog/gradle/config/MavenConfig.kt

@@ -20,7 +20,7 @@ import java.net.URI
 
 object MavenConfig {
 
-    val VERSION = Version(1, 11, 0, Version.Type.Release)
+    val VERSION = Version(1, 12, 0, Version.Type.Release)
     const val GROUP_ID = "com.datadoghq"
     const val PUBLICATION = "pluginMaven"
 }
@@ -37,7 +37,7 @@ fun Project.publishingConfig(projectDescription: String) {
     signingExtension.apply {
         val privateKey = System.getenv("GPG_PRIVATE_KEY")
         val password = System.getenv("GPG_PASSWORD")
-        isRequired = !hasProperty("dd-skip-signing")
+        isRequired = System.getenv("CI").toBoolean() && !hasProperty("dd-skip-signing")
         useInMemoryPgpKeys(privateKey, password)
         // com.gradle.plugin-publish plugin will automatically add signing task "signPluginMavenPublication"
         // sign(publishingExtension.publications.getByName(MavenConfig.PUBLICATION))

dd-sdk-android-gradle-plugin/src/main/kotlin/com/datadog/gradle/plugin/DdAndroidGradlePlugin.kt

@@ -25,6 +25,7 @@ import javax.inject.Inject
 /**
  * Plugin adding tasks for Android projects using Datadog's SDK for Android.
  */
+@Suppress("TooManyFunctions")
 class DdAndroidGradlePlugin @Inject constructor(
     private val execOps: ExecOperations
 ) : Plugin<Project> {
@@ -40,6 +41,8 @@ class DdAndroidGradlePlugin @Inject constructor(
             val androidExtension = target.extensions.findByType(AppExtension::class.java)
             if (androidExtension == null) {
                 LOGGER.error(ERROR_NOT_ANDROID)
+            } else if (!extension.enabled) {
+                LOGGER.info("Datadog extension disabled, no upload task created")
             } else {
                 androidExtension.applicationVariants.all { variant ->
                     configureVariantForUploadTask(target, variant, apiKey, extension)
@@ -73,13 +76,13 @@ class DdAndroidGradlePlugin @Inject constructor(
         apiKey: ApiKey,
         extension: DdExtension
     ): Task? {
-        if (!variant.buildType.isMinifyEnabled) {
-            LOGGER.warn("Minifying disabled for variant ${variant.name}, no upload task created")
-            return null
-        }
+        val extensionConfiguration = resolveExtensionConfiguration(extension, variant)
+        val isDefaultObfuscationEnabled = variant.buildType.isMinifyEnabled
+        val isNonDefaultObfuscationEnabled = extensionConfiguration.nonDefaultObfuscation
+        val isObfuscationEnabled = isDefaultObfuscationEnabled || isNonDefaultObfuscationEnabled
 
-        if (!extension.enabled) {
-            LOGGER.warn("Extension disabled for variant ${variant.name}, no upload task created")
+        if (!isObfuscationEnabled) {
+            LOGGER.info("Minifying disabled for variant ${variant.name}, no upload task created")
             return null
         }
 
@@ -91,13 +94,10 @@ class DdAndroidGradlePlugin @Inject constructor(
             DdMappingFileUploadTask::class.java,
             GitRepositoryDetector(execOps)
         )
-        val extensionConfiguration = resolveExtensionConfiguration(extension, variant)
 
         configureVariantTask(uploadTask, apiKey, flavorName, extensionConfiguration, variant)
 
-        val outputsDir = File(target.buildDir, "outputs")
-        uploadTask.mappingFilePath =
-            resolveMappingFilePath(extensionConfiguration, outputsDir, variant)
+        uploadTask.mappingFilePath = resolveMappingFilePath(extensionConfiguration, target, variant)
         uploadTask.mappingFilePackagesAliases =
             filterMappingFileReplacements(
                 extensionConfiguration.mappingFilePackageAliases,
@@ -108,9 +108,7 @@ class DdAndroidGradlePlugin @Inject constructor(
             uploadTask.datadogCiFile = findDatadogCiFile(target.projectDir)
         }
 
-        val reportsDir = File(outputsDir, "reports")
-        val datadogDir = File(reportsDir, "datadog")
-        uploadTask.repositoryFile = File(datadogDir, "repository.json")
+        uploadTask.repositoryFile = resolveDatadogRepositoryFile(target)
 
         val roots = mutableListOf<File>()
         variant.sourceSets.forEach {
@@ -128,7 +126,7 @@ class DdAndroidGradlePlugin @Inject constructor(
         extension: DdExtension
     ): Provider<DdCheckSdkDepsTask>? {
         if (!extension.enabled) {
-            LOGGER.warn("Extension disabled for variant ${variant.name}, no sdk check task created")
+            LOGGER.info("Extension disabled for variant ${variant.name}, no sdk check task created")
             return null
         }
 
@@ -187,19 +185,27 @@ class DdAndroidGradlePlugin @Inject constructor(
 
     private fun resolveMappingFilePath(
         extensionConfiguration: DdExtensionConfiguration,
-        outputsDir: File,
+        target: Project,
         variant: ApplicationVariant
     ): String {
         val customPath = extensionConfiguration.mappingFilePath
         return if (customPath != null) {
             customPath
         } else {
+            val outputsDir = File(target.buildDir, "outputs")
             val mappingDir = File(outputsDir, "mapping")
             val flavorDir = File(mappingDir, variant.name)
             File(flavorDir, "mapping.txt").path
         }
     }
 
+    private fun resolveDatadogRepositoryFile(target: Project): File {
+        val outputsDir = File(target.buildDir, "outputs")
+        val reportsDir = File(outputsDir, "reports")
+        val datadogDir = File(reportsDir, "datadog")
+        return File(datadogDir, "repository.json")
+    }
+
     private fun filterMappingFileReplacements(
         replacements: Map<String, String>,
         applicationId: String

dd-sdk-android-gradle-plugin/src/main/kotlin/com/datadog/gradle/plugin/DdExtension.kt

@@ -25,13 +25,36 @@ open class DdExtension(
     /**
      * Container for the variant's configurations.
      */
-    internal val variants =
-        objectFactory.domainObjectContainer(DdExtensionConfiguration::class.java)
+    internal val variants = objectFactory.domainObjectContainer(DdExtensionConfiguration::class.java)
 
     /**
-     * Closure method to create a DSL for variant configurations.
+     * Closure method to create a groovy DSL for variant configurations.
      */
     fun variants(configureClosure: Closure<DdExtensionConfiguration>) {
         variants.configure(configureClosure)
     }
+
+    /**
+     * Method compatible with Kotlin Script to create a DSL for variant configurations.
+     */
+    fun variants(configure: VariantScope.() -> Unit) {
+        configure(VariantScope())
+    }
+
+    /**
+     * Inner class used for Kotlin DSL.
+     */
+    inner class VariantScope {
+
+        /**
+         * Defines a new named object, which will be created and configured when it is required.
+         * @param name the name of the variant to configure
+         * @param configuration the action to run to configure the variant
+         */
+        fun register(name: String, configuration: DdExtensionConfiguration.() -> Unit) {
+            variants.register(name) {
+                configuration(it)
+            }
+        }
+    }
 }

dd-sdk-android-gradle-plugin/src/main/kotlin/com/datadog/gradle/plugin/DdExtensionConfiguration.kt

@@ -83,6 +83,13 @@ open class DdExtensionConfiguration(
      */
     var mappingFileTrimIndents: Boolean = false
 
+    /**
+     * This property declares that the obfuscation technology used is not the default
+     * R8/Proguard included in the Android toolchain (e.g.: Dexguard, …).
+     * Doing so will create an upload task for all variants and all build types
+     */
+    var nonDefaultObfuscation: Boolean = false
+
     /**
      * Ignore the config declared in `datadog-ci.json` file if found.
      */
@@ -98,5 +105,6 @@ open class DdExtensionConfiguration(
         mappingFilePackageAliases = config.mappingFilePackageAliases
         mappingFileTrimIndents = config.mappingFileTrimIndents
         ignoreDatadogCiFileConfig = config.ignoreDatadogCiFileConfig
+        nonDefaultObfuscation = config.nonDefaultObfuscation
     }
 }

dd-sdk-android-gradle-plugin/src/main/kotlin/com/datadog/gradle/plugin/internal/OkHttpUploader.kt

@@ -251,7 +251,7 @@ internal class OkHttpUploader : Uploader {
     companion object {
 
         // TODO add a plugin to automatically sync this with the `MavenConfig` value
-        internal const val VERSION = "1.11.0"
+        internal const val VERSION = "1.12.0"
 
         internal const val HEADER_API_KEY = "DD-API-KEY"
         internal const val HEADER_EVP_ORIGIN = "DD-EVP-ORIGIN"