Merge pull request #3530 from element-hq/feature/bma/moduleConfig

Introduce ModulesConfig
element-hq · Sep 25, 2024 · e2ab1ef · e2ab1ef
2 parents fdd0a0d + 4fc1878
commit e2ab1ef
Show file tree

Hide file tree

Showing 5 changed files with 86 additions and 13 deletions.
diff --git a/app/build.gradle.kts b/app/build.gradle.kts
@@ -250,10 +250,12 @@ dependencies {
     implementation(projects.libraries.uiStrings)
     anvil(projects.anvilcodegen)
 
-    // Comment to not include firebase in the project
-    "gplayImplementation"(projects.libraries.pushproviders.firebase)
-    // Comment to not include unified push in the project
-    implementation(projects.libraries.pushproviders.unifiedpush)
+    if (ModulesConfig.pushProvidersConfig.includeFirebase) {
+        "gplayImplementation"(projects.libraries.pushproviders.firebase)
+    }
+    if (ModulesConfig.pushProvidersConfig.includeUnifiedPush) {
+        implementation(projects.libraries.pushproviders.unifiedpush)
+    }
 
     implementation(libs.appyx.core)
     implementation(libs.androidx.splash)

diff --git a/plugins/src/main/kotlin/ModulesConfig.kt b/plugins/src/main/kotlin/ModulesConfig.kt
@@ -0,0 +1,21 @@
+/*
+ * Copyright 2024 New Vector Ltd.
+ *
+ * SPDX-License-Identifier: AGPL-3.0-only
+ * Please see LICENSE in the repository root for full details.
+ */
+
+import config.AnalyticsConfig
+import config.PushProvidersConfig
+
+object ModulesConfig {
+    val pushProvidersConfig = PushProvidersConfig(
+        includeFirebase = true,
+        includeUnifiedPush = true,
+    )
+
+    val analyticsConfig: AnalyticsConfig = AnalyticsConfig.Enabled(
+        withPosthog = true,
+        withSentry = true,
+    )
+}
diff --git a/plugins/src/main/kotlin/config/AnalyticsConfig.kt b/plugins/src/main/kotlin/config/AnalyticsConfig.kt
@@ -0,0 +1,23 @@
+/*
+ * Copyright 2024 New Vector Ltd.
+ *
+ * SPDX-License-Identifier: AGPL-3.0-only
+ * Please see LICENSE in the repository root for full details.
+ */
+
+package config
+
+sealed interface AnalyticsConfig {
+    data class Enabled(
+        val withPosthog: Boolean,
+        val withSentry: Boolean,
+    ) : AnalyticsConfig {
+        init {
+            require(withPosthog || withSentry) {
+                "At least one analytics provider must be enabled"
+            }
+        }
+    }
+
+    object Disabled : AnalyticsConfig
+}
diff --git a/plugins/src/main/kotlin/config/PushProvidersConfig.kt b/plugins/src/main/kotlin/config/PushProvidersConfig.kt
@@ -0,0 +1,19 @@
+/*
+ * Copyright 2024 New Vector Ltd.
+ *
+ * SPDX-License-Identifier: AGPL-3.0-only
+ * Please see LICENSE in the repository root for full details.
+ */
+
+package config
+
+data class PushProvidersConfig(
+    val includeFirebase: Boolean,
+    val includeUnifiedPush: Boolean,
+) {
+    init {
+        require(includeFirebase || includeUnifiedPush) {
+            "At least one push provider must be included"
+        }
+    }
+}
diff --git a/plugins/src/main/kotlin/extension/DependencyHandleScope.kt b/plugins/src/main/kotlin/extension/DependencyHandleScope.kt
@@ -7,14 +7,14 @@
 
 package extension
 
+import config.AnalyticsConfig
+import ModulesConfig
 import org.gradle.accessors.dm.LibrariesForLibs
 import org.gradle.api.Action
 import org.gradle.api.artifacts.ExternalModuleDependency
 import org.gradle.api.logging.Logger
-import org.gradle.api.provider.Provider
 import org.gradle.kotlin.dsl.DependencyHandlerScope
 import org.gradle.kotlin.dsl.closureOf
-import org.gradle.kotlin.dsl.exclude
 import org.gradle.kotlin.dsl.project
 import java.io.File
 
@@ -24,7 +24,7 @@ private fun DependencyHandlerScope.implementation(dependency: Any) = dependencie
 private fun DependencyHandlerScope.implementation(
     dependency: Any,
     config: Action<ExternalModuleDependency>
-) = dependencies.add("implementation",  dependency, closureOf<ExternalModuleDependency> { config.execute(this) })
+) = dependencies.add("implementation", dependency, closureOf<ExternalModuleDependency> { config.execute(this) })
 
 private fun DependencyHandlerScope.androidTestImplementation(dependency: Any) = dependencies.add("androidTestImplementation", dependency)
 
@@ -111,13 +111,21 @@ fun DependencyHandlerScope.allLibrariesImpl() {
 }
 
 fun DependencyHandlerScope.allServicesImpl() {
-    // For analytics configuration, either use noop, or use the impl, with at least one analyticsproviders implementation
-    // implementation(project(":services:analytics:noop"))
-    implementation(project(":services:analytics:impl"))
     implementation(project(":services:analytics:compose"))
-    implementation(project(":services:analyticsproviders:posthog"))
-    implementation(project(":services:analyticsproviders:sentry"))
-
+    when (ModulesConfig.analyticsConfig) {
+        AnalyticsConfig.Disabled -> {
+            implementation(project(":services:analytics:noop"))
+        }
+        is AnalyticsConfig.Enabled -> {
+            implementation(project(":services:analytics:impl"))
+            if (ModulesConfig.analyticsConfig.withPosthog) {
+                implementation(project(":services:analyticsproviders:posthog"))
+            }
+            if (ModulesConfig.analyticsConfig.withSentry) {
+                implementation(project(":services:analyticsproviders:sentry"))
+            }
+        }
+    }
     implementation(project(":services:apperror:impl"))
     implementation(project(":services:appnavstate:impl"))
     implementation(project(":services:toolbox:impl"))