Merge pull request #1997 from embrace-io/migrate-proj-properties

fractalwrench · web-flow · commit fc2d679384e6 · 2025-03-07T13:53:44.000Z
Migrate project properties to extension
diff --git a/UPGRADING.md b/UPGRADING.md
@@ -23,6 +23,7 @@ below:
 | `SwazzlerExtension.Variant.swazzlerOff`               | `embrace.buildVariantFilter.disablePluginForVariant()`                  |
 | `SwazzlerExtension.Variant.setSwazzlingEnabled()`     | `embrace.buildVariantFilter.disableBytecodeInstrumentationForVariant()` |
 | `SwazzlerExtension.Variant.disablePluginForVariant()` | `embrace.buildVariantFilter.disablePluginForVariant()`                  |
+| `embrace.disableCollectBuildData`                     | `embrace.telemetryEnabled`                                              |
 | `swazzler.forceIncrementalOverwrite`                  | Obsolete - no alternative provided.                                     |
 | `swazzler.disableRNBundleRetriever`                   | Obsolete - no alternative provided.                                     |
 | `swazzler.customSymbolsDirectory`                     | Obsolete - no alternative provided.                                     |
diff --git a/embrace-gradle-plugin/src/main/java/io/embrace/android/gradle/plugin/api/EmbraceBytecodeInstrumentation.kt b/embrace-gradle-plugin/src/main/java/io/embrace/android/gradle/plugin/api/EmbraceBytecodeInstrumentation.kt
@@ -14,7 +14,7 @@ abstract class EmbraceBytecodeInstrumentation @Inject internal constructor(objec
      * Global flag that overrides all others & decides whether Embrace should perform any bytecode instrumentation.
      * Defaults to true.
      */
-    val enabled: Property<Boolean> = objectFactory.property(Boolean::class.java)
+    val enabled: Property<Boolean> = objectFactory.property(Boolean::class.java).convention(true)
 
     /**
      * Whether Embrace should automatically instrument OkHttp requests. Defaults to true.
diff --git a/embrace-gradle-plugin/src/main/java/io/embrace/android/gradle/plugin/api/EmbraceExtension.kt b/embrace-gradle-plugin/src/main/java/io/embrace/android/gradle/plugin/api/EmbraceExtension.kt
@@ -23,12 +23,6 @@ abstract class EmbraceExtension @Inject internal constructor(objectFactory: Obje
     val autoAddEmbraceComposeDependency: Property<Boolean> =
         objectFactory.property(Boolean::class.java)
 
-    /**
-     * Whether the Embrace Gradle Plugin should automatically upload mapping files for stacktrace deobfuscation.
-     * Defaults to true.
-     */
-    val mappingFileUploadEnabled: Property<Boolean> = objectFactory.property(Boolean::class.java)
-
     /**
      * Whether the Embrace Gradle Plugin should report telemetry on its own performance.
      * Defaults to true.
@@ -39,7 +33,7 @@ abstract class EmbraceExtension @Inject internal constructor(objectFactory: Obje
      * Whether the Embrace Gradle Plugin should fail the build if it encounters an error during a HTTP request.
      * Defaults to true.
      */
-    val failBuildOnUploadErrors: Property<Boolean> = objectFactory.property(Boolean::class.java)
+    val failBuildOnUploadErrors: Property<Boolean> = objectFactory.property(Boolean::class.java).convention(true)
 
     /**
      * DSL for configuring how Embrace instruments bytecode.
diff --git a/embrace-gradle-plugin/src/main/java/io/embrace/android/gradle/plugin/buildreporter/BuildTelemetryService.kt b/embrace-gradle-plugin/src/main/java/io/embrace/android/gradle/plugin/buildreporter/BuildTelemetryService.kt
@@ -25,12 +25,16 @@ abstract class BuildTelemetryService :
     interface Params : BuildServiceParameters {
         val request: Property<BuildTelemetryRequest>
         val baseUrl: Property<String>
+        val telemetryDisabled: Property<Boolean>
     }
 
     /**
      * It gets called moments before build is about to finish.
      */
     override fun close() {
+        if (parameters.telemetryDisabled.get()) {
+            return
+        }
         val networkService = OkHttpNetworkService(parameters.baseUrl.get())
         networkService.postBuildTelemetry(parameters.request.get())
     }
@@ -46,9 +50,6 @@ abstract class BuildTelemetryService :
             behavior: PluginBehavior,
             agpWrapper: AgpWrapper,
         ): Provider<BuildTelemetryService> {
-            if (behavior.isTelemetryDisabled) {
-                return project.provider { null }
-            }
             val serviceProvider: Provider<BuildTelemetryService> =
                 project.gradle.sharedServices
                     .registerIfAbsent(
@@ -65,6 +66,7 @@ abstract class BuildTelemetryService :
                             )
                             params.request.set(telemetryProvider)
                             params.baseUrl.set(behavior.baseUrl)
+                            params.telemetryDisabled.set(behavior.isTelemetryDisabled)
                         }
                     }
 
diff --git a/embrace-gradle-plugin/src/main/java/io/embrace/android/gradle/plugin/config/InstrumentationBehaviorImpl.kt b/embrace-gradle-plugin/src/main/java/io/embrace/android/gradle/plugin/config/InstrumentationBehaviorImpl.kt
@@ -14,24 +14,28 @@ class InstrumentationBehaviorImpl(
         embrace.bytecodeInstrumentation
     }
 
+    private val enabled by lazy {
+        instrumentation.enabled.get()
+    }
+
     override val okHttpEnabled: Boolean by lazy {
-        instrumentation.okhttpEnabled.orNull ?: extension.instrumentOkHttp.orNull ?: true
+        enabled && (instrumentation.okhttpEnabled.orNull ?: extension.instrumentOkHttp.orNull ?: true)
     }
 
     override val onClickEnabled: Boolean by lazy {
-        instrumentation.onClickEnabled.orNull ?: extension.instrumentOnClick.orNull ?: true
+        enabled && (instrumentation.onClickEnabled.orNull ?: extension.instrumentOnClick.orNull ?: true)
     }
 
     override val onLongClickEnabled: Boolean by lazy {
-        instrumentation.onLongClickEnabled.orNull ?: extension.instrumentOnLongClick.orNull ?: true
+        enabled && (instrumentation.onLongClickEnabled.orNull ?: extension.instrumentOnLongClick.orNull ?: true)
     }
 
     override val webviewEnabled: Boolean by lazy {
-        instrumentation.webviewOnPageStartedEnabled.orNull ?: extension.instrumentWebview.orNull ?: true
+        enabled && (instrumentation.webviewOnPageStartedEnabled.orNull ?: extension.instrumentWebview.orNull ?: true)
     }
 
     override val fcmPushNotificationsEnabled: Boolean by lazy {
-        instrumentation.firebasePushNotificationsEnabled.orNull ?: extension.instrumentFirebaseMessaging.orNull ?: false
+        enabled && (instrumentation.firebasePushNotificationsEnabled.orNull ?: extension.instrumentFirebaseMessaging.orNull ?: false)
     }
 
     override val ignoredClasses: List<String> by lazy {
diff --git a/embrace-gradle-plugin/src/main/java/io/embrace/android/gradle/plugin/config/PluginBehavior.kt b/embrace-gradle-plugin/src/main/java/io/embrace/android/gradle/plugin/config/PluginBehavior.kt
@@ -1,11 +1,13 @@
 package io.embrace.android.gradle.plugin.config
 
+import org.gradle.api.provider.Provider
+
 interface PluginBehavior {
 
     /**
      * Whether telemetry can be captured for this build, set via `embrace.disableCollectBuildData`.
      */
-    val isTelemetryDisabled: Boolean
+    val isTelemetryDisabled: Provider<Boolean>
 
     /**
      * Whether Unity EDM is enabled, set via `embrace.externalDependencyManager`
@@ -25,7 +27,7 @@ interface PluginBehavior {
     /**
      * Whether the plugin should fail the build on upload errors, set via `embrace.failBuildOnUploadErrors`
      */
-    val failBuildOnUploadErrors: Boolean
+    val failBuildOnUploadErrors: Provider<Boolean>
 
     /**
      * The base URL for the Embrace API, set via `embrace.baseUrl`
@@ -74,6 +76,5 @@ const val EMBRACE_BASE_URL = "embrace.baseUrl"
 const val EMBRACE_DISABLE_COLLECT_BUILD_DATA = "embrace.disableCollectBuildData"
 const val EMBRACE_UPLOAD_IL2CPP_MAPPING_FILES = "embrace.uploadIl2CppMappingFiles"
 const val EMBRACE_DISABLE_MAPPING_FILE_UPLOAD = "embrace.disableMappingFileUpload"
-const val EMBRACE_FAIL_BUILD_ON_UPLOAD_ERRORS = "embrace.failBuildOnUploadErrors"
 const val EMBRACE_UNITY_EXTERNAL_DEPENDENCY_MANAGER = "embrace.externalDependencyManager"
 const val DEFAULT_SYMBOL_STORE_HOST_URL = "https://dsym-store.emb-api.com"
diff --git a/embrace-gradle-plugin/src/main/java/io/embrace/android/gradle/plugin/config/PluginBehaviorImpl.kt b/embrace-gradle-plugin/src/main/java/io/embrace/android/gradle/plugin/config/PluginBehaviorImpl.kt
@@ -5,6 +5,7 @@ package io.embrace.android.gradle.plugin.config
 import io.embrace.android.gradle.plugin.api.EmbraceExtension
 import io.embrace.android.gradle.swazzler.plugin.extension.SwazzlerExtension
 import org.gradle.api.Project
+import org.gradle.api.provider.Provider
 import java.io.File
 
 class PluginBehaviorImpl(
@@ -17,8 +18,10 @@ class PluginBehaviorImpl(
         InstrumentationBehaviorImpl(extension, embrace)
     }
 
-    override val isTelemetryDisabled: Boolean by lazy {
-        project.getBoolProperty(EMBRACE_DISABLE_COLLECT_BUILD_DATA)
+    override val isTelemetryDisabled: Provider<Boolean> by lazy {
+        project.provider {
+            embrace.telemetryEnabled.orNull?.not() ?: project.getBoolProperty(EMBRACE_DISABLE_COLLECT_BUILD_DATA)
+        }
     }
 
     override val isUnityEdmEnabled: Boolean by lazy {
@@ -33,8 +36,10 @@ class PluginBehaviorImpl(
         project.getBoolProperty(EMBRACE_DISABLE_MAPPING_FILE_UPLOAD)
     }
 
-    override val failBuildOnUploadErrors: Boolean by lazy {
-        project.getProperty(EMBRACE_FAIL_BUILD_ON_UPLOAD_ERRORS) != "false"
+    override val failBuildOnUploadErrors: Provider<Boolean> by lazy {
+        project.provider {
+            embrace.failBuildOnUploadErrors.get()
+        }
     }
 
     override val baseUrl: String by lazy {
diff --git a/embrace-gradle-plugin/src/main/java/io/embrace/android/gradle/plugin/tasks/il2cpp/Il2CppUploadTaskRegistration.kt b/embrace-gradle-plugin/src/main/java/io/embrace/android/gradle/plugin/tasks/il2cpp/Il2CppUploadTaskRegistration.kt
@@ -137,7 +137,7 @@ class Il2CppUploadTaskRegistration : EmbraceTaskRegistration {
                         endpoint = info.endpoint,
                         fileName = info.filename,
                         buildId = variantInfo.buildId,
-                        failBuildOnUploadErrors = behavior.failBuildOnUploadErrors,
+                        failBuildOnUploadErrors = behavior.failBuildOnUploadErrors.get(),
                         baseUrl = behavior.baseUrl,
                     )
                 }
diff --git a/embrace-gradle-plugin/src/main/java/io/embrace/android/gradle/plugin/tasks/ndk/NdkUploadTaskRegistration.kt b/embrace-gradle-plugin/src/main/java/io/embrace/android/gradle/plugin/tasks/ndk/NdkUploadTaskRegistration.kt
@@ -60,7 +60,7 @@ class NdkUploadTaskRegistration(
                         appId = embraceConfig?.appId.orEmpty(),
                         apiToken = embraceConfig?.apiToken.orEmpty(),
                         endpoint = EmbraceEndpoint.NDK,
-                        failBuildOnUploadErrors = behavior.failBuildOnUploadErrors,
+                        failBuildOnUploadErrors = behavior.failBuildOnUploadErrors.get(),
                         baseUrl = behavior.baseUrl,
                     )
                 }
diff --git a/embrace-gradle-plugin/src/main/java/io/embrace/android/gradle/plugin/tasks/r8/JvmMappingUploadTaskRegistration.kt b/embrace-gradle-plugin/src/main/java/io/embrace/android/gradle/plugin/tasks/r8/JvmMappingUploadTaskRegistration.kt
@@ -91,7 +91,7 @@ class JvmMappingUploadTaskRegistration : EmbraceTaskRegistration {
                         fileName = FILE_NAME_MAPPING_TXT,
                         buildId = variantConfig.buildId,
                         baseUrl = behavior.baseUrl,
-                        failBuildOnUploadErrors = behavior.failBuildOnUploadErrors,
+                        failBuildOnUploadErrors = behavior.failBuildOnUploadErrors.get(),
                     )
                 }
             )
diff --git a/embrace-gradle-plugin/src/main/java/io/embrace/android/gradle/plugin/tasks/reactnative/EmbraceRnSourcemapGeneratorTaskRegistration.kt b/embrace-gradle-plugin/src/main/java/io/embrace/android/gradle/plugin/tasks/reactnative/EmbraceRnSourcemapGeneratorTaskRegistration.kt
@@ -95,7 +95,7 @@ class EmbraceRnSourcemapGeneratorTaskRegistration : EmbraceTaskRegistration {
                         endpoint = EmbraceEndpoint.SOURCE_MAP,
                         fileName = FILE_NAME_SOURCE_MAP_JSON,
                         baseUrl = behavior.baseUrl,
-                        failBuildOnUploadErrors = behavior.failBuildOnUploadErrors,
+                        failBuildOnUploadErrors = behavior.failBuildOnUploadErrors.get(),
                     )
                 }
             )
diff --git a/embrace-gradle-plugin/src/test/java/io/embrace/android/gradle/plugin/config/InstrumentationBehaviorImplTest.kt b/embrace-gradle-plugin/src/test/java/io/embrace/android/gradle/plugin/config/InstrumentationBehaviorImplTest.kt
@@ -44,6 +44,12 @@ class InstrumentationBehaviorImplTest {
         assertFalse(behavior.okHttpEnabled)
     }
 
+    @Test
+    fun `okHttpEnabled disabled via global`() {
+        embrace.bytecodeInstrumentation.enabled.set(false)
+        assertFalse(behavior.okHttpEnabled)
+    }
+
     @Test
     fun `onClickEnabled default`() {
         assertTrue(behavior.onClickEnabled)
@@ -61,6 +67,12 @@ class InstrumentationBehaviorImplTest {
         assertFalse(behavior.onClickEnabled)
     }
 
+    @Test
+    fun `onClickEnabled disabled via global`() {
+        embrace.bytecodeInstrumentation.enabled.set(false)
+        assertFalse(behavior.onClickEnabled)
+    }
+
     @Test
     fun `onLongClickEnabled default`() {
         assertTrue(behavior.onLongClickEnabled)
@@ -78,6 +90,12 @@ class InstrumentationBehaviorImplTest {
         assertFalse(behavior.onLongClickEnabled)
     }
 
+    @Test
+    fun `onLongClickEnabled disabled via global`() {
+        embrace.bytecodeInstrumentation.enabled.set(false)
+        assertFalse(behavior.onLongClickEnabled)
+    }
+
     @Test
     fun `webviewEnabled default`() {
         assertTrue(behavior.webviewEnabled)
@@ -95,6 +113,12 @@ class InstrumentationBehaviorImplTest {
         assertFalse(behavior.webviewEnabled)
     }
 
+    @Test
+    fun `webviewEnabled disabled via global`() {
+        embrace.bytecodeInstrumentation.enabled.set(false)
+        assertFalse(behavior.webviewEnabled)
+    }
+
     @Test
     fun `fcmPushNotificationsEnabled default`() {
         assertFalse(behavior.fcmPushNotificationsEnabled)
@@ -112,6 +136,13 @@ class InstrumentationBehaviorImplTest {
         assertTrue(behavior.fcmPushNotificationsEnabled)
     }
 
+    @Test
+    fun `fcmPushNotificationsEnabled disabled via global`() {
+        embrace.bytecodeInstrumentation.firebasePushNotificationsEnabled.set(true)
+        embrace.bytecodeInstrumentation.enabled.set(false)
+        assertFalse(behavior.fcmPushNotificationsEnabled)
+    }
+
     @Test
     fun `ignoredClasses default`() {
         assertTrue(behavior.ignoredClasses.isEmpty())
diff --git a/embrace-gradle-plugin/src/test/java/io/embrace/android/gradle/plugin/config/PluginBehaviorImplTest.kt b/embrace-gradle-plugin/src/test/java/io/embrace/android/gradle/plugin/config/PluginBehaviorImplTest.kt
@@ -31,19 +31,25 @@ class PluginBehaviorImplTest {
 
     @Test
     fun `telemetry disabled default`() {
-        assertFalse(behavior.isTelemetryDisabled)
+        assertFalse(behavior.isTelemetryDisabled.get())
     }
 
     @Test
     fun `telemetry disabled valid`() {
         addGradleProperty(EMBRACE_DISABLE_COLLECT_BUILD_DATA, "true")
-        assertTrue(behavior.isTelemetryDisabled)
+        assertTrue(behavior.isTelemetryDisabled.get())
     }
 
     @Test
     fun `telemetry disabled invalid`() {
         addGradleProperty(EMBRACE_DISABLE_COLLECT_BUILD_DATA, "foo")
-        assertFalse(behavior.isTelemetryDisabled)
+        assertFalse(behavior.isTelemetryDisabled.get())
+    }
+
+    @Test
+    fun `telemetry disabled via embrace extension`() {
+        embrace.telemetryEnabled.set(false)
+        assertTrue(behavior.isTelemetryDisabled.get())
     }
 
     @Test
@@ -97,6 +103,17 @@ class PluginBehaviorImplTest {
         assertFalse(behavior.isUploadMappingFilesDisabled)
     }
 
+    @Test
+    fun `fail build on upload error default`() {
+        assertTrue(behavior.failBuildOnUploadErrors.get())
+    }
+
+    @Test
+    fun `fail build on upload error via embrace`() {
+        embrace.failBuildOnUploadErrors.set(false)
+        assertFalse(behavior.failBuildOnUploadErrors.get())
+    }
+
     @Test
     fun `base url default`() {
         assertEquals(DEFAULT_SYMBOL_STORE_HOST_URL, behavior.baseUrl)
diff --git a/embrace-gradle-plugin/src/test/java/io/embrace/android/gradle/plugin/ndk/NdkUploadTaskRegistrationTest.kt b/embrace-gradle-plugin/src/test/java/io/embrace/android/gradle/plugin/ndk/NdkUploadTaskRegistrationTest.kt

Original file line number	Diff line number	Diff line change
`@@ -14,24 +14,28 @@ class InstrumentationBehaviorImpl(`
`14`	`14`	`embrace.bytecodeInstrumentation`
`15`	`15`	`}`
`16`	`16`
	`17`	`+ private val enabled by lazy {`
	`18`	`+ instrumentation.enabled.get()`
	`19`	`+ }`
	`20`	`+`
`17`	`21`	`override val okHttpEnabled: Boolean by lazy {`
`18`		`- instrumentation.okhttpEnabled.orNull ?: extension.instrumentOkHttp.orNull ?: true`
	`22`	`+ enabled && (instrumentation.okhttpEnabled.orNull ?: extension.instrumentOkHttp.orNull ?: true)`
`19`	`23`	`}`
`20`	`24`
`21`	`25`	`override val onClickEnabled: Boolean by lazy {`
`22`		`- instrumentation.onClickEnabled.orNull ?: extension.instrumentOnClick.orNull ?: true`
	`26`	`+ enabled && (instrumentation.onClickEnabled.orNull ?: extension.instrumentOnClick.orNull ?: true)`
`23`	`27`	`}`
`24`	`28`
`25`	`29`	`override val onLongClickEnabled: Boolean by lazy {`
`26`		`- instrumentation.onLongClickEnabled.orNull ?: extension.instrumentOnLongClick.orNull ?: true`
	`30`	`+ enabled && (instrumentation.onLongClickEnabled.orNull ?: extension.instrumentOnLongClick.orNull ?: true)`
`27`	`31`	`}`
`28`	`32`
`29`	`33`	`override val webviewEnabled: Boolean by lazy {`
`30`		`- instrumentation.webviewOnPageStartedEnabled.orNull ?: extension.instrumentWebview.orNull ?: true`
	`34`	`+ enabled && (instrumentation.webviewOnPageStartedEnabled.orNull ?: extension.instrumentWebview.orNull ?: true)`
`31`	`35`	`}`
`32`	`36`
`33`	`37`	`override val fcmPushNotificationsEnabled: Boolean by lazy {`
`34`		`- instrumentation.firebasePushNotificationsEnabled.orNull ?: extension.instrumentFirebaseMessaging.orNull ?: false`
	`38`	`+ enabled && (instrumentation.firebasePushNotificationsEnabled.orNull ?: extension.instrumentFirebaseMessaging.orNull ?: false)`
`35`	`39`	`}`
`36`	`40`
`37`	`41`	`override val ignoredClasses: List<String> by lazy {`
Original file line number	Diff line number	Diff line change
`@@ -137,7 +137,7 @@ class Il2CppUploadTaskRegistration : EmbraceTaskRegistration {`
`137`	`137`	`endpoint = info.endpoint,`
`138`	`138`	`fileName = info.filename,`
`139`	`139`	`buildId = variantInfo.buildId,`
`140`		`- failBuildOnUploadErrors = behavior.failBuildOnUploadErrors,`
	`140`	`+ failBuildOnUploadErrors = behavior.failBuildOnUploadErrors.get(),`
`141`	`141`	`baseUrl = behavior.baseUrl,`
`142`	`142`	`)`
`143`	`143`	`}`
Original file line number	Diff line number	Diff line change
`@@ -60,7 +60,7 @@ class NdkUploadTaskRegistration(`
`60`	`60`	`appId = embraceConfig?.appId.orEmpty(),`
`61`	`61`	`apiToken = embraceConfig?.apiToken.orEmpty(),`
`62`	`62`	`endpoint = EmbraceEndpoint.NDK,`
`63`		`- failBuildOnUploadErrors = behavior.failBuildOnUploadErrors,`
	`63`	`+ failBuildOnUploadErrors = behavior.failBuildOnUploadErrors.get(),`
`64`	`64`	`baseUrl = behavior.baseUrl,`
`65`	`65`	`)`
`66`	`66`	`}`
Original file line number	Diff line number	Diff line change
`@@ -91,7 +91,7 @@ class JvmMappingUploadTaskRegistration : EmbraceTaskRegistration {`
`91`	`91`	`fileName = FILE_NAME_MAPPING_TXT,`
`92`	`92`	`buildId = variantConfig.buildId,`
`93`	`93`	`baseUrl = behavior.baseUrl,`
`94`		`- failBuildOnUploadErrors = behavior.failBuildOnUploadErrors,`
	`94`	`+ failBuildOnUploadErrors = behavior.failBuildOnUploadErrors.get(),`
`95`	`95`	`)`
`96`	`96`	`}`
`97`	`97`	`)`