Avoiding direct BuildConfig usage

changelog.d/6406.misc

@@ -0,0 +1 @@
+[Modularization] Provides abstraction to avoids direct usages of BuildConfig

vector-config/src/main/java/im/vector/app/config/Analytics.kt

@@ -0,0 +1,48 @@
+/*
+ * Copyright (c) 2022 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package im.vector.app.config
+
+/**
+ * The types of analytics Element currently supports.
+ */
+sealed interface Analytics {
+
+    /**
+     * Disables the analytics integrations.
+     */
+    object Disabled : Analytics
+
+    /**
+     * Analytics integration via PostHog.
+     */
+    data class PostHog(
+            /**
+             * The PostHog instance url.
+             */
+            val postHogHost: String,
+
+            /**
+             * The PostHog instance API key.
+             */
+            val postHogApiKey: String,
+
+            /**
+             * A URL to more information about the analytics collection.
+             */
+            val policyLink: String,
+    ) : Analytics
+}

vector-config/src/main/java/im/vector/app/config/Config.kt

@@ -36,4 +36,57 @@ object Config {
      * - Changing the value from `true` to `false` will force the app to return to the background sync / Firebase Push.
      */
     const val ALLOW_EXTERNAL_UNIFIED_PUSH_DISTRIBUTORS = true
+
+    const val ENABLE_LOCATION_SHARING = true
+    const val LOCATION_MAP_TILER_KEY = "fU3vlMsMn4Jb6dnEIFsx"
+
+    /**
+     * The maximum length of voice messages in milliseconds.
+     */
+    const val VOICE_MESSAGE_LIMIT_MS = 120_000L
+
+    /**
+     * The strategy for sharing device keys.
+     */
+    val KEY_SHARING_STRATEGY = KeySharingStrategy.WhenTyping
+
+    /**
+     * The onboarding flow.
+     */
+    val ONBOARDING_VARIANT = OnboardingVariant.FTUE_AUTH
+
+    /**
+     * If set, MSC3086 asserted identity messages sent on VoIP calls will cause the call to appear in the room corresponding to the asserted identity.
+     * This *must* only be set in trusted environments.
+     */
+    const val HANDLE_CALL_ASSERTED_IDENTITY_EVENTS = false
+
+    const val LOW_PRIVACY_LOG_ENABLE = false
+    const val ENABLE_STRICT_MODE_LOGS = false
+
+    /**
+     * The analytics configuration to use for the Debug build type.
+     * Can be disabled by providing Analytics.Disabled
+     */
+    val DEBUG_ANALYTICS_CONFIG = Analytics.PostHog(
+            postHogHost = "https://posthog.element.dev",
+            postHogApiKey = "phc_VtA1L35nw3aeAtHIx1ayrGdzGkss7k1xINeXcoIQzXN",
+            policyLink = "https://element.io/cookie-policy",
+    )
+
+    /**
+     * The analytics configuration to use for the Release build type.
+     * Can be disabled by providing Analytics.Disabled
+     */
+    val RELEASE_ANALYTICS_CONFIG = Analytics.PostHog(
+            postHogHost = "https://posthog.hss.element.io",
+            postHogApiKey = "phc_Jzsm6DTm6V2705zeU5dcNvQDlonOR68XvX2sh1sEOHO",
+            policyLink = "https://element.io/cookie-policy",
+    )
+
+    /**
+     * The analytics configuration to use for the Nightly build type.
+     * Can be disabled by providing Analytics.Disabled
+     */
+    val NIGHTLY_ANALYTICS_CONFIG = RELEASE_ANALYTICS_CONFIG
 }

vector/src/debug/java/im/vector/app/config/AnalyticsConfig.kt → vector-config/src/main/java/im/vector/app/config/KeySharingStrategy.kt

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2021 New Vector Ltd
+ * Copyright (c) 2022 New Vector Ltd
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -16,12 +16,20 @@
 
 package im.vector.app.config
 
-import im.vector.app.BuildConfig
-import im.vector.app.features.analytics.AnalyticsConfig
+enum class KeySharingStrategy {
+    /**
+     * Keys will be sent for the first time when the first message is sent.
+     * This is handled by the Matrix SDK so there's no need to do it in Vector.
+     */
+    WhenSendingEvent,
 
-val analyticsConfig: AnalyticsConfig = object : AnalyticsConfig {
-    override val isEnabled = BuildConfig.APPLICATION_ID == "im.vector.app.debug"
-    override val postHogHost = "https://posthog.element.dev"
-    override val postHogApiKey = "phc_VtA1L35nw3aeAtHIx1ayrGdzGkss7k1xINeXcoIQzXN"
-    override val policyLink = "https://element.io/cookie-policy"
+    /**
+     * Keys will be sent for the first time when the timeline displayed.
+     */
+    WhenEnteringRoom,
+
+    /**
+     * Keys will be sent for the first time when a typing started.
+     */
+    WhenTyping
 }

vector/src/release/java/im/vector/app/config/AnalyticsConfig.kt → vector-config/src/main/java/im/vector/app/config/OnboardingVariant.kt

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2021 New Vector Ltd
+ * Copyright (c) 2022 New Vector Ltd
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -16,17 +16,8 @@
 
 package im.vector.app.config
 
-import im.vector.app.BuildConfig
-import im.vector.app.features.analytics.AnalyticsConfig
-
-private val allowedPackageList = listOf(
-        "im.vector.app",
-        "im.vector.app.nightly",
-)
-
-val analyticsConfig: AnalyticsConfig = object : AnalyticsConfig {
-    override val isEnabled = BuildConfig.APPLICATION_ID in allowedPackageList
-    override val postHogHost = "https://posthog.hss.element.io"
-    override val postHogApiKey = "phc_Jzsm6DTm6V2705zeU5dcNvQDlonOR68XvX2sh1sEOHO"
-    override val policyLink = "https://element.io/cookie-policy"
+enum class OnboardingVariant {
+    LEGACY,
+    LOGIN_2,
+    FTUE_AUTH
 }

vector/build.gradle

@@ -156,19 +156,6 @@ android {
         buildConfigField "String", "GIT_BRANCH_NAME", "\"${gitBranchName()}\""
         buildConfigField "String", "BUILD_NUMBER", "\"${buildNumber}\""
 
-        buildConfigField "im.vector.app.features.VectorFeatures.OnboardingVariant", "ONBOARDING_VARIANT", "im.vector.app.features.VectorFeatures.OnboardingVariant.FTUE_AUTH"
-
-        buildConfigField "im.vector.app.features.crypto.keysrequest.OutboundSessionKeySharingStrategy", "outboundSessionKeySharingStrategy", "im.vector.app.features.crypto.keysrequest.OutboundSessionKeySharingStrategy.WhenTyping"
-
-        buildConfigField "Long", "VOICE_MESSAGE_DURATION_LIMIT_MS", "120_000L"
-
-        //  If set, MSC3086 asserted identity messages sent on VoIP calls will cause the call to appear in the room corresponding to the asserted identity.
-        //  This *must* only be set in trusted environments.
-        buildConfigField "Boolean", "handleCallAssertedIdentityEvents", "false"
-
-        buildConfigField "Boolean", "enableLocationSharing", "true"
-        buildConfigField "String", "mapTilerKey", "\"fU3vlMsMn4Jb6dnEIFsx\""
-
         testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
 
         // Keep abiFilter for the universalApk
@@ -250,10 +237,6 @@ android {
             resValue "string", "app_name", "Element dbg"
             resValue "color", "launcher_background", "#0DBD8B"
 
-            buildConfigField "boolean", "LOW_PRIVACY_LOG_ENABLE", "false"
-            // Set to true if you want to enable strict mode in debug
-            buildConfigField "boolean", "ENABLE_STRICT_MODE_LOGS", "false"
-
             signingConfig signingConfigs.debug
 
             if (project.hasProperty("coverage")) {
@@ -265,10 +248,6 @@ android {
             resValue "string", "app_name", "Element"
             resValue "color", "launcher_background", "#0DBD8B"
 
-            buildConfigField "boolean", "LOW_PRIVACY_LOG_ENABLE", "false"
-            buildConfigField "boolean", "ENABLE_STRICT_MODE_LOGS", "false"
-
-            // When updating this block, please also update the same block in the `nightly` buildType below
             postprocessing {
                 removeUnusedCode true
                 removeUnusedResources true
@@ -329,7 +308,6 @@ android {
             versionName "${versionMajor}.${versionMinor}.${versionPatch}${getGplayVersionSuffix()}"
 
             resValue "bool", "isGplay", "true"
-            buildConfigField "boolean", "ALLOW_FCM_USE", "true"
             buildConfigField "String", "SHORT_FLAVOR_DESCRIPTION", "\"G\""
             buildConfigField "String", "FLAVOR_DESCRIPTION", "\"GooglePlay\""
         }
@@ -340,7 +318,6 @@ android {
             versionName "${versionMajor}.${versionMinor}.${versionPatch}${getFdroidVersionSuffix()}"
 
             resValue "bool", "isGplay", "false"
-            buildConfigField "boolean", "ALLOW_FCM_USE", "false"
             buildConfigField "String", "SHORT_FLAVOR_DESCRIPTION", "\"F\""
             buildConfigField "String", "FLAVOR_DESCRIPTION", "\"FDroid\""
         }

vector/src/debug/java/im/vector/app/features/debug/features/DebugFeaturesStateFactory.kt

@@ -70,6 +70,11 @@ class DebugFeaturesStateFactory @Inject constructor(
                                 key = DebugFeatureKeys.allowExternalUnifiedPushDistributors,
                                 factory = VectorFeatures::allowExternalUnifiedPushDistributors
                         ),
+                        createBooleanFeature(
+                                label = "Enable Live Location Sharing",
+                                key = DebugFeatureKeys.liveLocationSharing,
+                                factory = VectorFeatures::isLocationSharingEnabled
+                        ),
                         createBooleanFeature(
                                 label = "Force usage of OpusEncoder library",
                                 key = DebugFeatureKeys.forceUsageOfOpusEncoder,

vector/src/debug/java/im/vector/app/features/debug/features/DebugVectorFeatures.kt

@@ -24,6 +24,7 @@ import androidx.datastore.preferences.core.booleanPreferencesKey
 import androidx.datastore.preferences.core.edit
 import androidx.datastore.preferences.core.stringPreferencesKey
 import androidx.datastore.preferences.preferencesDataStore
+import im.vector.app.config.OnboardingVariant
 import im.vector.app.features.DefaultVectorFeatures
 import im.vector.app.features.VectorFeatures
 import kotlinx.coroutines.flow.first
@@ -39,8 +40,8 @@ class DebugVectorFeatures(
 
     private val dataStore = context.dataStore
 
-    override fun onboardingVariant(): VectorFeatures.OnboardingVariant {
-        return readPreferences().getEnum<VectorFeatures.OnboardingVariant>() ?: vectorFeatures.onboardingVariant()
+    override fun onboardingVariant(): OnboardingVariant {
+        return readPreferences().getEnum<OnboardingVariant>() ?: vectorFeatures.onboardingVariant()
     }
 
     override fun isOnboardingAlreadyHaveAccountSplashEnabled(): Boolean = read(DebugFeatureKeys.onboardingAlreadyHaveAnAccount)
@@ -66,6 +67,9 @@ class DebugVectorFeatures(
     override fun isScreenSharingEnabled(): Boolean = read(DebugFeatureKeys.screenSharing)
             ?: vectorFeatures.isScreenSharingEnabled()
 
+    override fun isLocationSharingEnabled(): Boolean = read(DebugFeatureKeys.liveLocationSharing)
+            ?: vectorFeatures.isLocationSharingEnabled()
+
     override fun forceUsageOfOpusEncoder(): Boolean = read(DebugFeatureKeys.forceUsageOfOpusEncoder)
             ?: vectorFeatures.forceUsageOfOpusEncoder()
 

vector/src/main/java/im/vector/app/VectorApplication.kt

@@ -40,7 +40,9 @@ import com.mapbox.mapboxsdk.Mapbox
 import com.vanniktech.emoji.EmojiManager
 import com.vanniktech.emoji.google.GoogleEmojiProvider
 import dagger.hilt.android.HiltAndroidApp
+import im.vector.app.config.Config
 import im.vector.app.core.di.ActiveSessionHolder
+import im.vector.app.core.resources.BuildMeta
 import im.vector.app.features.analytics.VectorAnalytics
 import im.vector.app.features.call.webrtc.WebRtcCallManager
 import im.vector.app.features.configuration.VectorConfiguration
@@ -99,6 +101,7 @@ class VectorApplication :
     @Inject lateinit var flipperProxy: FlipperProxy
     @Inject lateinit var matrix: Matrix
     @Inject lateinit var fcmHelper: FcmHelper
+    @Inject lateinit var buildMeta: BuildMeta
 
     // font thread handler
     private var fontThreadHandler: Handler? = null
@@ -127,12 +130,12 @@ class VectorApplication :
                 .filterIsInstance(JitsiMeetDefaultLogHandler::class.java)
                 .forEach { Timber.uproot(it) }
 
-        if (BuildConfig.DEBUG) {
+        if (buildMeta.isDebug) {
             Timber.plant(Timber.DebugTree())
         }
         Timber.plant(vectorFileLogger)
 
-        if (BuildConfig.DEBUG) {
+        if (buildMeta.isDebug) {
             Stetho.initializeWithDefaults(this)
         }
         logInfo()
@@ -148,7 +151,7 @@ class VectorApplication :
                 R.array.com_google_android_gms_fonts_certs
         )
         FontsContractCompat.requestFont(this, fontRequest, emojiCompatFontProvider, getFontThreadHandler())
-        VectorLocale.init(this)
+        VectorLocale.init(this, buildMeta)
         ThemeUtils.init(this)
         vectorConfiguration.applyToApplicationContext()
 
@@ -196,7 +199,7 @@ class VectorApplication :
     }
 
     private fun enableStrictModeIfNeeded() {
-        if (BuildConfig.ENABLE_STRICT_MODE_LOGS) {
+        if (Config.ENABLE_STRICT_MODE_LOGS) {
             StrictMode.setThreadPolicy(
                     StrictMode.ThreadPolicy.Builder()
                             .detectAll()