Configure demo app flavors in the build logic (#1230)

* Update baseline profiles * Configure demo app flavors in the build logic * Move configureFlavors to the demo-app --------- Co-authored-by: Aleksandar Apostolov <[email protected]>
GetStream · Nov 21, 2024 · fb37338 · fb37338
1 parent ff79501
commit fb37338
Show file tree

Hide file tree

Showing 8 changed files with 80 additions and 41 deletions.
diff --git a/benchmark/build.gradle.kts b/benchmark/build.gradle.kts
@@ -14,6 +14,7 @@
  * limitations under the License.
  */
 import io.getstream.video.android.Configuration
+import io.getstream.video.configureFlavors
 
 @Suppress("DSL_SCOPE_VIOLATION")
 plugins {
@@ -62,16 +63,15 @@ android {
         }
     }
 
-    flavorDimensions += "environment"
-    productFlavors {
-        create("development") {
-            dimension = "environment"
-            proguardFiles("benchmark-rules.pro")
-        }
-        create("production") {
-            dimension = "environment"
-            proguardFiles("benchmark-rules.pro")
-        }
+    // Use the same flavor dimensions as the application to allow generating Baseline Profiles on prod,
+    // which is more close to what will be shipped to users (no fake data), but has ability to run the
+    // benchmarks on demo, so we benchmark on stable data.
+    configureFlavors(this) { flavor ->
+        buildConfigField(
+            "String",
+            "APP_FLAVOR_SUFFIX",
+            "\"${flavor.applicationIdSuffix ?: ""}\""
+        )
     }
 
     targetProjectPath = ":demo-app"

diff --git a/benchmark/src/main/kotlin/io/getstream/video/android/benchmark/BaselineProfileGenerator.kt b/benchmark/src/main/kotlin/io/getstream/video/android/benchmark/BaselineProfileGenerator.kt
@@ -30,7 +30,7 @@ internal class BaselineProfileGenerator {
     @Test
     fun startup() =
         baselineProfileRule.collect(
-            packageName = packageName,
+            packageName = PACKAGE_NAME,
             stableIterations = 2,
             maxIterations = 8,
             includeInStartupProfile = true,

diff --git a/benchmark/src/main/kotlin/io/getstream/video/android/benchmark/Const.kt b/benchmark/src/main/kotlin/io/getstream/video/android/benchmark/Const.kt
diff --git a/benchmark/src/main/kotlin/io/getstream/video/android/benchmark/Utils.kt b/benchmark/src/main/kotlin/io/getstream/video/android/benchmark/Utils.kt
@@ -22,6 +22,14 @@ import androidx.test.uiautomator.UiDevice
 import androidx.test.uiautomator.UiObject2
 import androidx.test.uiautomator.Until
 
+/**
+ * Convenience parameter to use proper package name with regards to build type and build flavor.
+ */
+val PACKAGE_NAME = buildString {
+    append("io.getstream.video.android")
+    append(BuildConfig.APP_FLAVOR_SUFFIX)
+}
+
 internal fun UiDevice.waitForObject(selector: BySelector, timeout: Long = 5_000): UiObject2? {
     if (wait(Until.hasObject(selector), timeout)) {
         return findObject(selector)

diff --git a/build-logic/convention/src/main/kotlin/AndroidApplicationComposeConventionPlugin.kt b/build-logic/convention/src/main/kotlin/AndroidApplicationComposeConventionPlugin.kt
@@ -1,5 +1,7 @@
+import com.android.build.api.dsl.ApplicationExtension
 import com.android.build.gradle.internal.dsl.BaseAppModuleExtension
 import io.getstream.video.configureAndroidCompose
+import io.getstream.video.configureFlavors
 import io.getstream.video.configureKotlinAndroid
 import org.gradle.api.Plugin
 import org.gradle.api.Project

diff --git a/build-logic/convention/src/main/kotlin/AndroidApplicationConventionPlugin.kt b/build-logic/convention/src/main/kotlin/AndroidApplicationConventionPlugin.kt
@@ -1,4 +1,6 @@
+import com.android.build.api.dsl.ApplicationExtension
 import com.android.build.gradle.internal.dsl.BaseAppModuleExtension
+import io.getstream.video.configureFlavors
 import io.getstream.video.configureKotlinAndroid
 import org.gradle.api.Plugin
 import org.gradle.api.Project

diff --git a/build-logic/convention/src/main/kotlin/io/getstream/video/DemoFlavor.kt b/build-logic/convention/src/main/kotlin/io/getstream/video/DemoFlavor.kt
@@ -0,0 +1,43 @@
+package io.getstream.video
+
+import com.android.build.api.dsl.ApplicationExtension
+import com.android.build.api.dsl.ApplicationProductFlavor
+import com.android.build.api.dsl.CommonExtension
+import com.android.build.api.dsl.ProductFlavor
+
+@Suppress("EnumEntryName")
+enum class FlavorDimension {
+    contentType
+}
+
+// The content for the app can either come from local static data which is useful for demo
+// purposes, or from a production backend server which supplies up-to-date, real content.
+// These two product flavors reflect this behaviour.
+@Suppress("EnumEntryName")
+enum class VideoDemoFlavor(val dimension: FlavorDimension, val applicationIdSuffix: String? = null) {
+    development(FlavorDimension.contentType, applicationIdSuffix = ".dogfooding"),
+    production(FlavorDimension.contentType)
+}
+
+fun configureFlavors(
+    commonExtension: CommonExtension<*, *, *, *, *, *>,
+    flavorConfigurationBlock: ProductFlavor.(flavor: VideoDemoFlavor) -> Unit = {}
+) {
+    commonExtension.apply {
+        flavorDimensions += "environment"
+        productFlavors {
+            VideoDemoFlavor.values().forEach {
+                create(it.name) {
+                    dimension = "environment"
+                    flavorConfigurationBlock(this, it)
+                    if (this@apply is ApplicationExtension && this is ApplicationProductFlavor) {
+                        if (it.applicationIdSuffix != null) {
+                            applicationIdSuffix = it.applicationIdSuffix
+                        }
+                    }
+                    proguardFiles("benchmark-rules.pro")
+                }
+            }
+        }
+    }
+}
diff --git a/demo-app/build.gradle.kts b/demo-app/build.gradle.kts
@@ -18,7 +18,10 @@
 import com.android.build.api.variant.BuildConfigField
 import com.android.build.api.variant.ResValue
 import com.github.triplet.gradle.androidpublisher.ResolutionStrategy
+import io.getstream.video.FlavorDimension
+import io.getstream.video.VideoDemoFlavor
 import io.getstream.video.android.Configuration
+import io.getstream.video.configureFlavors
 import java.io.FileInputStream
 import java.util.*
 
@@ -45,6 +48,7 @@ android {
         targetSdk = Configuration.targetSdk
         versionCode = 1
         versionName = Configuration.streamVideoCallGooglePlayVersion
+        missingDimensionStrategy(FlavorDimension.contentType.name, VideoDemoFlavor.development.name)
         vectorDrawables {
             useSupportLibrary = true
         }
@@ -83,6 +87,8 @@ android {
         }
     }
 
+    configureFlavors(this)
+
     buildTypes {
         getByName("debug") {
             versionNameSuffix = "-DEBUG"
@@ -94,6 +100,7 @@ android {
         }
         getByName("release") {
             isMinifyEnabled = true
+            baselineProfile.automaticGenerationDuringBuild = true
             proguardFiles(
                 getDefaultProguardFile("proguard-android-optimize.txt"),
                 "proguard-rules.pro"
@@ -110,17 +117,6 @@ android {
         }
     }
 
-    flavorDimensions += "environment"
-    productFlavors {
-        create("development") {
-            dimension = "environment"
-            applicationIdSuffix = ".dogfooding"
-        }
-        create("production") {
-            dimension = "environment"
-        }
-    }
-
     buildFeatures {
         resValues = true
         buildConfig = true
@@ -136,6 +132,13 @@ android {
 
     baselineProfile {
         mergeIntoMain = true
+
+        // Don't build on every iteration of a full assemble.
+        // Instead enable generation directly for the release build variant.
+        automaticGenerationDuringBuild = false
+
+        // Make use of Dex Layout Optimizations via Startup Profiles
+        dexLayoutOptimization = true
     }
 
     playConfigs {