Merge pull request #4635 from vector-im/feature/adm/debug-features-override

Debug features override

vector/src/debug/AndroidManifest.xml

@@ -7,6 +7,7 @@
         <activity android:name=".features.debug.DebugPermissionActivity" />
         <activity android:name=".features.debug.settings.DebugPrivateSettingsActivity" />
         <activity android:name=".features.debug.sas.DebugSasEmojiActivity" />
+        <activity android:name=".features.debug.features.DebugFeaturesSettingsActivity" />
     </application>
 
 </manifest>

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

@@ -34,6 +34,7 @@ import im.vector.app.core.utils.checkPermissions
 import im.vector.app.core.utils.registerForPermissionsResult
 import im.vector.app.core.utils.toast
 import im.vector.app.databinding.ActivityDebugMenuBinding
+import im.vector.app.features.debug.features.DebugFeaturesSettingsActivity
 import im.vector.app.features.debug.sas.DebugSasEmojiActivity
 import im.vector.app.features.debug.settings.DebugPrivateSettingsActivity
 import im.vector.app.features.qrcode.QrCodeScannerActivity
@@ -76,6 +77,7 @@ class DebugMenuActivity : VectorBaseActivity<ActivityDebugMenuBinding>() {
     }
 
     private fun setupViews() {
+        views.debugFeatures.setOnClickListener { startActivity(Intent(this, DebugFeaturesSettingsActivity::class.java)) }
         views.debugPrivateSetting.setOnClickListener { openPrivateSettings() }
         views.debugTestTextViewLink.setOnClickListener { testTextViewLink() }
         views.debugOpenButtonStylesLight.setOnClickListener {

vector/src/debug/java/im/vector/app/features/debug/di/FeaturesModule.kt

@@ -0,0 +1,48 @@
+/*
+ * Copyright (c) 2021 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.features.debug.di
+
+import android.content.Context
+import dagger.Binds
+import dagger.Module
+import dagger.Provides
+import dagger.hilt.InstallIn
+import dagger.hilt.components.SingletonComponent
+import im.vector.app.features.DefaultVectorFeatures
+import im.vector.app.features.VectorFeatures
+import im.vector.app.features.debug.features.DebugVectorFeatures
+
+@InstallIn(SingletonComponent::class)
+@Module
+interface FeaturesModule {
+
+    @Binds
+    fun bindFeatures(debugFeatures: DebugVectorFeatures): VectorFeatures
+
+    companion object {
+
+        @Provides
+        fun providesDefaultVectorFeatures(): DefaultVectorFeatures {
+            return DefaultVectorFeatures()
+        }
+
+        @Provides
+        fun providesDebugVectorFeatures(context: Context, defaultVectorFeatures: DefaultVectorFeatures): DebugVectorFeatures {
+            return DebugVectorFeatures(context, defaultVectorFeatures)
+        }
+    }
+}

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

@@ -0,0 +1,52 @@
+/*
+ * Copyright (c) 2021 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.features.debug.features
+
+import android.os.Bundle
+import dagger.hilt.android.AndroidEntryPoint
+import im.vector.app.core.extensions.cleanup
+import im.vector.app.core.extensions.configureWith
+import im.vector.app.core.platform.VectorBaseActivity
+import im.vector.app.databinding.FragmentGenericRecyclerBinding
+import javax.inject.Inject
+
+@AndroidEntryPoint
+class DebugFeaturesSettingsActivity : VectorBaseActivity<FragmentGenericRecyclerBinding>() {
+
+    @Inject lateinit var debugFeatures: DebugVectorFeatures
+    @Inject lateinit var debugFeaturesStateFactory: DebugFeaturesStateFactory
+    @Inject lateinit var controller: FeaturesController
+
+    override fun getBinding() = FragmentGenericRecyclerBinding.inflate(layoutInflater)
+
+    override fun onCreate(savedInstanceState: Bundle?) {
+        super.onCreate(savedInstanceState)
+        controller.listener = object : EnumFeatureItem.Listener {
+            override fun <T : Enum<T>> onOptionSelected(option: T?, feature: Feature.EnumFeature<T>) {
+                debugFeatures.overrideEnum(option, feature.type)
+            }
+        }
+        views.genericRecyclerView.configureWith(controller)
+        controller.setData(debugFeaturesStateFactory.create())
+    }
+
+    override fun onDestroy() {
+        controller.listener = null
+        views.genericRecyclerView.cleanup()
+        super.onDestroy()
+    }
+}

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

@@ -0,0 +1,46 @@
+/*
+ * Copyright (c) 2021 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.features.debug.features
+
+import im.vector.app.features.DefaultVectorFeatures
+import javax.inject.Inject
+
+class DebugFeaturesStateFactory @Inject constructor(
+        private val debugFeatures: DebugVectorFeatures,
+        private val defaultFeatures: DefaultVectorFeatures
+) {
+
+    fun create(): FeaturesState {
+        return FeaturesState(listOf(
+                createEnumFeature(
+                        label = "Login version",
+                        selection = debugFeatures.loginVersion(),
+                        default = defaultFeatures.loginVersion()
+                )
+        ))
+    }
+
+    private inline fun <reified T : Enum<T>> createEnumFeature(label: String, selection: T, default: T): Feature {
+        return Feature.EnumFeature(
+                label = label,
+                selection = selection.takeIf { debugFeatures.hasEnumOverride(T::class) },
+                default = default,
+                options = enumValues<T>().toList(),
+                type = T::class
+        )
+    }
+}

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

@@ -0,0 +1,78 @@
+/*
+ * Copyright (c) 2021 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.features.debug.features
+
+import android.content.Context
+import androidx.datastore.core.DataStore
+import androidx.datastore.preferences.core.MutablePreferences
+import androidx.datastore.preferences.core.Preferences
+import androidx.datastore.preferences.core.edit
+import androidx.datastore.preferences.core.stringPreferencesKey
+import androidx.datastore.preferences.preferencesDataStore
+import im.vector.app.features.DefaultVectorFeatures
+import im.vector.app.features.VectorFeatures
+import kotlinx.coroutines.flow.first
+import kotlinx.coroutines.runBlocking
+import kotlin.reflect.KClass
+
+private val Context.dataStore: DataStore<Preferences> by preferencesDataStore(name = "debug_features")
+
+class DebugVectorFeatures(
+        context: Context,
+        private val vectorFeatures: DefaultVectorFeatures
+) : VectorFeatures {
+
+    private val dataStore = context.dataStore
+
+    override fun loginVersion(): VectorFeatures.LoginVersion {
+        return readPreferences().getEnum<VectorFeatures.LoginVersion>() ?: vectorFeatures.loginVersion()
+    }
+
+    fun <T : Enum<T>> hasEnumOverride(type: KClass<T>) = readPreferences().containsEnum(type)
+
+    fun <T : Enum<T>> overrideEnum(value: T?, type: KClass<T>) {
+        if (value == null) {
+            updatePreferences { it.removeEnum(type) }
+        } else {
+            updatePreferences { it.putEnum(value, type) }
+        }
+    }
+
+    private fun readPreferences() = runBlocking { dataStore.data.first() }
+
+    private fun updatePreferences(block: (MutablePreferences) -> Unit) = runBlocking {
+        dataStore.edit { block(it) }
+    }
+}
+
+private fun <T : Enum<T>> MutablePreferences.removeEnum(type: KClass<T>) {
+    remove(enumPreferencesKey(type))
+}
+
+private fun <T : Enum<T>> Preferences.containsEnum(type: KClass<T>) = contains(enumPreferencesKey(type))
+
+private fun <T : Enum<T>> MutablePreferences.putEnum(value: T, type: KClass<T>) {
+    this[enumPreferencesKey(type)] = value.name
+}
+
+private inline fun <reified T : Enum<T>> Preferences.getEnum(): T? {
+    return get(enumPreferencesKey<T>())?.let { enumValueOf<T>(it) }
+}
+
+private inline fun <reified T : Enum<T>> enumPreferencesKey() = enumPreferencesKey(T::class)
+
+private fun <T : Enum<T>> enumPreferencesKey(type: KClass<T>) = stringPreferencesKey("enum-${type.simpleName}")

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

@@ -0,0 +1,79 @@
+/*
+ * Copyright 2019 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.features.debug.features
+
+import android.view.View
+import android.widget.AdapterView
+import android.widget.ArrayAdapter
+import android.widget.Spinner
+import android.widget.TextView
+import com.airbnb.epoxy.EpoxyAttribute
+import com.airbnb.epoxy.EpoxyModelClass
+import im.vector.app.core.epoxy.VectorEpoxyHolder
+import im.vector.app.core.epoxy.VectorEpoxyModel
+
+@EpoxyModelClass(layout = im.vector.app.R.layout.item_feature)
+abstract class EnumFeatureItem : VectorEpoxyModel<EnumFeatureItem.Holder>() {
+
+    @EpoxyAttribute
+    lateinit var feature: Feature.EnumFeature<*>
+
+    @EpoxyAttribute(EpoxyAttribute.Option.DoNotHash)
+    var listener: Listener? = null
+
+    override fun bind(holder: Holder) {
+        super.bind(holder)
+        holder.label.text = feature.label
+
+        holder.optionsSpinner.apply {
+            val arrayAdapter = ArrayAdapter<String>(context, android.R.layout.simple_spinner_dropdown_item)
+            arrayAdapter.add("DEFAULT - ${feature.default.name}")
+            arrayAdapter.addAll(feature.options.map { it.name })
+            adapter = arrayAdapter
+
+            feature.selection?.let {
+                setSelection(feature.options.indexOf(it) + 1, false)
+            }
+
+            onItemSelectedListener = object : AdapterView.OnItemSelectedListener {
+                override fun onItemSelected(parent: AdapterView<*>?, view: View?, position: Int, id: Long) {
+                    when (position) {
+                        0    -> listener?.onOptionSelected(option = null, feature)
+                        else -> feature.onOptionSelected(position - 1)
+                    }
+                }
+
+                override fun onNothingSelected(parent: AdapterView<*>?) {
+                    // do nothing
+                }
+            }
+        }
+    }
+
+    private fun <T : Enum<T>> Feature.EnumFeature<T>.onOptionSelected(selection: Int) {
+        listener?.onOptionSelected(options[selection], this)
+    }
+
+    class Holder : VectorEpoxyHolder() {
+        val label by bind<TextView>(im.vector.app.R.id.feature_label)
+        val optionsSpinner by bind<Spinner>(im.vector.app.R.id.feature_options)
+    }
+
+    interface Listener {
+        fun <T : Enum<T>> onOptionSelected(option: T?, feature: Feature.EnumFeature<T>)
+    }
+}

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

@@ -0,0 +1,55 @@
+/*
+ * Copyright 2019 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.features.debug.features
+
+import com.airbnb.epoxy.TypedEpoxyController
+import javax.inject.Inject
+import kotlin.reflect.KClass
+
+data class FeaturesState(
+        val features: List<Feature>
+)
+
+sealed interface Feature {
+
+    data class EnumFeature<T : Enum<T>>(
+            val label: String,
+            val selection: T?,
+            val default: T,
+            val options: List<T>,
+            val type: KClass<T>
+    ) : Feature
+}
+
+class FeaturesController @Inject constructor() : TypedEpoxyController<FeaturesState>() {
+
+    var listener: EnumFeatureItem.Listener? = null
+
+    override fun buildModels(data: FeaturesState?) {
+        if (data == null) return
+
+        data.features.forEachIndexed { index, feature ->
+            when (feature) {
+                is Feature.EnumFeature<*> -> enumFeatureItem {
+                    id(index)
+                    feature(feature)
+                    listener(this@FeaturesController.listener)
+                }
+            }
+        }
+    }
+}

vector/src/debug/res/layout/activity_debug_menu.xml

@@ -20,6 +20,12 @@
             android:padding="@dimen/layout_horizontal_margin"
             android:showDividers="middle">
 
+            <Button
+                android:id="@+id/debug_features"
+                android:layout_width="wrap_content"
+                android:layout_height="wrap_content"
+                android:text="Features" />
+
             <Button
                 android:id="@+id/debug_private_setting"
                 android:layout_width="wrap_content"

vector/src/debug/res/layout/item_feature.xml

@@ -0,0 +1,30 @@
+<?xml version="1.0" encoding="utf-8"?>
+<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
+    xmlns:tools="http://schemas.android.com/tools"
+    android:layout_width="match_parent"
+    android:layout_height="wrap_content"
+    android:layout_marginStart="16dp"
+    android:layout_marginTop="4dp"
+    android:layout_marginEnd="16dp"
+    android:layout_marginBottom="4dp"
+    android:gravity="center_vertical"
+    android:orientation="horizontal">
+
+    <TextView
+        android:id="@+id/feature_label"
+        style="@style/Widget.Vector.TextView.Subtitle"
+        android:layout_width="0dp"
+        android:layout_height="wrap_content"
+        android:layout_marginStart="8dp"
+        android:layout_weight="1"
+        android:gravity="center"
+        android:textColor="?vctr_content_primary"
+        tools:text="Login version" />
+
+    <androidx.appcompat.widget.AppCompatSpinner
+        android:id="@+id/feature_options"
+        android:layout_width="0dp"
+        android:layout_height="wrap_content"
+        android:layout_weight="1"/>
+
+</LinearLayout>

vector/src/main/java/im/vector/app/core/di/SingletonModule.kt

@@ -31,8 +31,6 @@ import im.vector.app.core.error.DefaultErrorFormatter
 import im.vector.app.core.error.ErrorFormatter
 import im.vector.app.core.time.Clock
 import im.vector.app.core.time.DefaultClock
-import im.vector.app.features.DefaultVectorFeatures
-import im.vector.app.features.VectorFeatures
 import im.vector.app.features.invite.AutoAcceptInvites
 import im.vector.app.features.invite.CompileTimeAutoAcceptInvites
 import im.vector.app.features.navigation.DefaultNavigator
@@ -135,9 +133,4 @@ object VectorStaticModule {
     fun providesCoroutineDispatchers(): CoroutineDispatchers {
         return CoroutineDispatchers(io = Dispatchers.IO, computation = Dispatchers.Default)
     }
-
-    @Provides
-    fun providesFeatures(): VectorFeatures {
-        return DefaultVectorFeatures()
-    }
 }

vector/src/release/java/im/vector/app/core/di/FeaturesModule.kt

@@ -0,0 +1,34 @@
+/*
+ * Copyright (c) 2021 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.core.di
+
+import dagger.Module
+import dagger.Provides
+import dagger.hilt.InstallIn
+import dagger.hilt.components.SingletonComponent
+import im.vector.app.features.DefaultVectorFeatures
+import im.vector.app.features.VectorFeatures
+
+@InstallIn(SingletonComponent::class)
+@Module
+object FeaturesModule {
+
+    @Provides
+    fun providesFeatures(): VectorFeatures {
+        return DefaultVectorFeatures()
+    }
+}