Stub out Google Mobile Services and Firebase with Open Source library, new build flavor 'gms' to use it

Author: tw-hx

app/build.gradle.kts

@@ -85,7 +85,8 @@ val selectableVariants = listOf(
   "playProdQuickstart",
   "playStagingQuickstart",
   "websiteProdSpinner",
-  "websiteProdRelease",
+  "websiteFossProdRelease",
+  "websiteGmsProdRelease",
   "githubProdSpinner",
   "githubProdRelease"
 )
@@ -159,7 +160,7 @@ android {
 
   ndkVersion = libs.versions.ndk.get()
 
-  flavorDimensions += listOf("distribution", "environment")
+  flavorDimensions += listOf("distribution", "gms", "environment")
 
   android.bundle.language.enableSplit = false
 
@@ -446,8 +447,10 @@ android {
     }
 
     create("website") {
+      val MAU = if (gradle.startParameter.taskRequests.toString().contains("Foss")) "false" else "true"
+
       dimension = "distribution"
-      buildConfigField("boolean", "MANAGES_APP_UPDATES", "true")
+      buildConfigField("boolean", "MANAGES_APP_UPDATES", "${MAU}")
       buildConfigField("String", "APK_UPDATE_MANIFEST_URL", "\"https://updates.signal.org/android/latest.json\"")
       buildConfigField("String", "BUILD_DISTRIBUTION_TYPE", "\"website\"")
     }
@@ -468,6 +471,17 @@ android {
       buildConfigField("boolean", "LINK_DEVICE_UX_ENABLED", "true")
     }
 
+    create("gms") {
+      dimension = "gms"
+      isDefault = true
+      buildConfigField("boolean", "USE_OSM", "false")
+    }
+
+    create("foss") {
+      dimension = "gms"
+      buildConfigField("boolean", "USE_OSM", "true")
+    }
+
     create("prod") {
       dimension = "environment"
 
@@ -759,14 +773,16 @@ dependencies {
   implementation(libs.androidx.emoji2)
   implementation(libs.androidx.paging.runtime)
   implementation(libs.androidx.paging.compose)
-  implementation(libs.firebase.messaging) {
+  "gmsImplementation"(libs.firebase.messaging) {
     exclude(group = "com.google.firebase", module = "firebase-core")
     exclude(group = "com.google.firebase", module = "firebase-analytics")
     exclude(group = "com.google.firebase", module = "firebase-measurement-connector")
   }
-  implementation(libs.google.play.services.maps)
-  implementation(libs.google.play.services.auth)
-  implementation(libs.google.signin)
+  "gmsImplementation"(libs.google.play.services.maps)
+  "gmsImplementation"(libs.google.play.services.auth)
+  "gmsImplementation"(libs.google.signin)
+  "fossImplementation"(project(":lib:fakegms"))
+  "fossImplementation"(libs.osmdroid)
   implementation(libs.androidx.media)
   implementation(libs.bundles.media3)
   implementation(libs.conscrypt.android)
@@ -806,15 +822,16 @@ dependencies {
   implementation(libs.accompanist.drawablepainter)
   implementation(libs.kotlin.stdlib.jdk8)
   implementation(libs.kotlin.reflect)
-  implementation(libs.kotlinx.coroutines.play.services)
+  "gmsImplementation"(libs.kotlinx.coroutines.play.services)
   implementation(libs.kotlinx.coroutines.rx3)
   implementation(libs.jackson.module.kotlin)
   implementation(libs.rxjava3.rxandroid)
   implementation(libs.rxjava3.rxkotlin)
   implementation(libs.rxdogtag)
   implementation(libs.kotlinx.serialization.json)
 
-  implementation(project(":lib:billing"))
+  "gmsImplementation"(project(":lib:billing"))
+  "fossImplementation"(project(":lib:fakebilling"))
   implementation(project(":feature:media-send"))
 
   "spinnerImplementation"(project(":lib:spinner"))

app/src/main/java/org/thoughtcrime/securesms/components/location/SignalPlace.java

@@ -11,6 +11,7 @@
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.google.android.gms.maps.model.LatLng;
 
+import org.thoughtcrime.securesms.BuildConfig;
 import org.signal.core.util.logging.Log;
 import org.thoughtcrime.securesms.maps.AddressData;
 import org.signal.core.util.JsonUtils;
@@ -19,7 +20,8 @@
 
 public class SignalPlace {
 
-  private static final String URL = "https://maps.google.com/maps";
+  private static final String GMS_URL = "https://maps.google.com/maps";
+  private static final String OSM_URL = "https://www.openstreetmap.org/";
   private static final String TAG = Log.tag(SignalPlace.class);
 
   @JsonProperty
@@ -62,10 +64,21 @@ public String getDescription() {
       description += (address + "\n");
     }
 
-    description += Uri.parse(URL)
-                      .buildUpon()
-                      .appendQueryParameter("q", String.format("%s,%s", latitude, longitude))
-                      .build().toString();
+    if (BuildConfig.USE_OSM) {
+      // Thanks to https://github.com/sergimn for suggesting place marker
+      description += Uri.parse(OSM_URL)
+                        .buildUpon()
+                        .appendQueryParameter("mlat", String.format("%s", latitude))
+                        .appendQueryParameter("mlon", String.format("%s", longitude))
+                        .encodedFragment(String.format("map=15/%s/%s", latitude, longitude))
+                        .build().toString();
+    }
+    else {
+      description += Uri.parse(GMS_URL)
+                        .buildUpon()
+                        .appendQueryParameter("q", String.format("%s,%s", latitude, longitude))
+                        .build().toString();
+    }
 
     return description;
   }

build.gradle.kts

@@ -126,7 +126,9 @@ tasks.register("ciRemote") {
 }
 
 // Wire up QA dependencies after all projects are evaluated
-gradle.projectsEvaluated {
+// AT - dirty hack
+val sptr = gradle.startParameter.taskRequests.toString()
+if (!sptr.contains("Foss") && !sptr.contains("Gms") && !sptr.contains("depend")) gradle.projectsEvaluated {
   val appTestTask = tasks.findByPath(":Signal-Android:testPlayProdDebugUnitTest")!!
   val appLintTask = tasks.findByPath(":Signal-Android:lintPlayProdDebug")!!
   val appCompileInstrumentationTask = tasks.findByPath(":Signal-Android:compilePlayProdDebugAndroidTestSources")
@@ -204,6 +206,7 @@ gradle.projectsEvaluated {
 
   // If you let all of these things run in parallel, gradle will likely OOM.
   // To avoid this, we put non-app tests and lints behind the much heavier app tests and lints.
+
   subprojects.filter { it.name != "Signal-Android" }.forEach { subproject ->
     appTestTask.let { task ->
       subproject.tasks.findByName("testDebugUnitTest")?.mustRunAfter(task)

core/util/build.gradle.kts

@@ -7,6 +7,26 @@ plugins {
 
 android {
   namespace = "org.signal.core.util"
+
+  flavorDimensions += listOf("gms")
+  productFlavors {
+    create("gms") {
+      dimension = "gms"
+      isDefault = true
+    }
+
+    create("foss") {
+      dimension = "gms"
+    }
+  }
+}
+
+androidComponents {
+  beforeVariants { variant ->
+    val sptr = gradle.startParameter.taskRequests.toString()
+    if (variant.name.lowercase().contains("foss")) variant.enable = sptr.contains("Foss")
+    else if (variant.name.lowercase().contains("gms")) variant.enable = sptr.contains("Gms")
+  }
 }
 
 dependencies {
@@ -21,7 +41,8 @@ dependencies {
   implementation(libs.jackson.core)
   implementation(libs.jackson.module.kotlin)
   implementation(libs.google.libphonenumber)
-  implementation(libs.google.play.services.base)
+  "gmsImplementation"(libs.google.play.services.base)
+  "fossImplementation"(project(":lib:fakegms"))
   testImplementation(libs.androidx.sqlite.framework)
 
   testImplementation(testLibs.junit.junit)

feature/registration/build.gradle.kts

@@ -23,6 +23,18 @@ android {
       isIncludeAndroidResources = true
     }
   }
+
+  flavorDimensions += listOf("gms")
+  productFlavors {
+    create("gms") {
+      dimension = "gms"
+      isDefault = true
+    }
+
+    create("foss") {
+      dimension = "gms"
+    }
+  }
 }
 
 screenshotTests {
@@ -58,7 +70,8 @@ dependencies {
   implementation(project(":core:util"))
   implementation(project(":core:models-jvm"))
   implementation(project(":core:serialization"))
-  implementation(project(":lib:billing"))
+  "gmsImplementation"(project(":lib:billing"))
+  "fossImplementation"(project(":lib:fakebilling"))
   implementation(project(":lib:device-transfer"))
   implementation(project(":lib:password-manager"))
   implementation(project(":lib:signal-login"))
@@ -95,8 +108,9 @@ dependencies {
   implementation(libs.google.libphonenumber)
 
   // Phone number hint + SMS verification code retriever
-  implementation(libs.google.play.services.auth)
-  implementation(libs.kotlinx.coroutines.play.services)
+  "gmsImplementation"(libs.google.play.services.auth)
+  "gmsImplementation"(libs.kotlinx.coroutines.play.services)
+  "fossImplementation"(project(":lib:fakegms"))
 
   // Testing
   testImplementation(testFixtures(project(":core:ui")))

gradle/libs.versions.toml

@@ -213,6 +213,9 @@ mp4parser-isoparser = { module = "org.mp4parser:isoparser", version.ref = "mp4pa
 mp4parser-streaming = { module = "org.mp4parser:streaming", version.ref = "mp4parser" }
 mp4parser-muxer = { module = "org.mp4parser:muxer", version.ref = "mp4parser" }
 
+# Signal-FOSS
+osmdroid = "org.osmdroid:osmdroid-android:6.1.20"
+
 [bundles]
 media3 = ["androidx-media3-exoplayer", "androidx-media3-session", "androidx-media3-ui"]
 mp4parser = ["mp4parser-isoparser", "mp4parser-streaming", "mp4parser-muxer"]

gradle/verification-metadata.xml

@@ -20,6 +20,52 @@ https://docs.gradle.org/current/userguide/dependency_verification.html
       </trusted-artifacts>
    </configuration>
    <components>
+      <!-- Begin Signal-FOSS -->
+      <component group="org.osmdroid" name="osmdroid-android" version="6.1.20">
+         <artifact name="osmdroid-android-6.1.20.aar">
+            <sha256 value="2cbec2a2a1a671a76849897748080079a3158a7a4c8554b86f2c75860f91046a" origin="Generated by Gradle"/>
+         </artifact>
+      </component>
+      <component group="androidx.asynclayoutinflater" name="asynclayoutinflater" version="1.0.0">
+         <artifact name="asynclayoutinflater-1.0.0.aar">
+            <sha256 value="f7eab60c57addd94bb06275832fe7600611beaaae1a1ec597c231956faf96c8b" origin="Generated by Gradle"/>
+         </artifact>
+      </component>
+      <component group="androidx.coordinatorlayout" name="coordinatorlayout" version="1.0.0">
+         <artifact name="coordinatorlayout-1.0.0.aar">
+            <sha256 value="e508c695489493374d942bf7b4ee02abf7571d25aac4c622e57d6cd5cd29eb73" origin="Generated by Gradle"/>
+         </artifact>
+      </component>
+      <component group="androidx.recyclerview" name="recyclerview" version="1.0.0">
+         <artifact name="recyclerview-1.0.0.aar">
+            <sha256 value="06956fb1ac014027ca9d2b40469a4b42aa61b4957bb11848e1ff352701ab4548" origin="Generated by Gradle"/>
+         </artifact>
+      </component>
+      <component group="androidx.transition" name="transition" version="1.4.1">
+         <artifact name="transition-1.4.1.aar">
+            <sha256 value="36d28d9ec33a8c64313842bce99c95736da5b27a6b3a513639050de82f075726" origin="Generated by Gradle"/>
+         </artifact>
+         <artifact name="transition-1.4.1.module">
+            <sha256 value="dec13dbe9ab525bcb115b47b4f219ce262c4892859c653912f898964eccf79ae" origin="Generated by Gradle"/>
+         </artifact>
+      </component>
+      <component group="androidx.window" name="window" version="1.0.0">
+         <artifact name="window-1.0.0.aar">
+            <sha256 value="i3212985be4127373ca4d0ea7f8b81a250ae2105e924f7940105d067a0f9ac130" origin="Generated by Gradle"/>
+         </artifact>
+         <artifact name="window-1.0.0.module">
+            <sha256 value="536773d2b2d65c26ce06b8c95e0fb415f1ad25d9b87330170f508689d3ad5ffb" origin="Generated by Gradle"/>
+         </artifact>
+      </component>
+      <component group="org.jetbrains.kotlinx" name="kotlinx-coroutines-android" version="1.5.2">
+         <artifact name="kotlinx-coroutines-android-1.5.2.jar">
+            <sha256 value="86cf9892b0bd5306a8f4d7ad8a82356f614dc7d519eb3063b0887d7c2b405928" origin="Generated by Gradle"/>
+         </artifact>
+         <artifact name="kotlinx-coroutines-android-1.5.2.module">
+            <sha256 value="5b76ccbd274432887e1e7536313a808d4eb054971d5e0648064d13d27264c811" origin="Generated by Gradle"/>
+         </artifact>
+      </component>
+      <!-- End Signal-FOSS -->
       <component group="androidx.activity" name="activity" version="1.0.0">
          <artifact name="activity-1.0.0.aar">
             <sha256 value="d1bc9842455c2e534415d88c44df4d52413b478db9093a1ba36324f705f44c3d" origin="Generated by Gradle"/>

lib/debuglogs-viewer/build.gradle.kts

@@ -9,6 +9,18 @@ android {
   buildFeatures {
     buildConfig = true
   }
+
+  flavorDimensions += listOf("gms")
+  productFlavors {
+    create("gms") {
+      dimension = "gms"
+      isDefault = true
+    }
+
+    create("foss") {
+      dimension = "gms"
+    }
+  }
 }
 
 dependencies {
@@ -23,6 +35,6 @@ dependencies {
     exclude(group = "com.google.protobuf", module = "protobuf-java")
   }
 
-  api(libs.google.play.services.wallet)
+  "gmsApi"(libs.google.play.services.wallet)
   api(libs.square.okhttp3)
 }

lib/donations/build.gradle.kts

@@ -15,6 +15,18 @@ android {
   defaultConfig {
     vectorDrawables.useSupportLibrary = true
   }
+
+  flavorDimensions += listOf("gms")
+  productFlavors {
+    create("gms") {
+      dimension = "gms"
+      isDefault = true
+    }
+
+    create("foss") {
+      dimension = "gms"
+    }
+  }
 }
 
 dependencies {
@@ -35,6 +47,7 @@ dependencies {
   }
   testImplementation(testFixtures(project(":lib:libsignal-service")))
 
-  api(libs.google.play.services.wallet)
+  "gmsApi"(libs.google.play.services.wallet)
+  "fossApi"(project(":lib:fakegms"))
   api(libs.square.okhttp3)
 }

lib/fakebilling/build.gradle.kts

@@ -0,0 +1,13 @@
+plugins {
+  id("signal-library")
+}
+
+android {
+  namespace = "org.signal.billing"
+}
+
+dependencies {
+  lintChecks(project(":lintchecks"))
+
+  implementation(project(":core:util"))
+}