FeatureFlag: first implementation

libraries/featureflag/api/build.gradle.kts

@@ -0,0 +1,27 @@
+/*
+ * Copyright (c) 2023 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.
+ */
+
+plugins {
+    id("io.element.android-library")
+}
+
+android {
+    namespace = "io.element.android.libraries.featureflag.api"
+}
+
+dependencies {
+    implementation(libs.coroutines.core)
+}

libraries/featureflag/api/src/main/kotlin/io/element/android/libraries/featureflag/api/Feature.kt

@@ -0,0 +1,39 @@
+/*
+ * Copyright (c) 2023 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 io.element.android.libraries.featureflag.api
+
+interface Feature {
+    /**
+     * Unique key to identify the feature.
+     */
+    val key: String
+
+    /**
+     * Title to show in the UI. Not needed to be translated as it's only dev accessible.
+     */
+    val title: String
+
+    /**
+     * Optional description to give more context on the feature.
+     */
+    val description: String?
+
+    /**
+     * The default value of the feature (enabled or disabled).
+     */
+    val defaultValue: Boolean
+}

libraries/featureflag/api/src/main/kotlin/io/element/android/libraries/featureflag/api/FeatureFlagService.kt

@@ -0,0 +1,35 @@
+/*
+ * Copyright (c) 2023 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 io.element.android.libraries.featureflag.api
+
+interface FeatureFlagService {
+
+    /**
+     * @param feature the feature to check for
+     *
+     * @return true if the feature is enabled
+     */
+    suspend fun isFeatureEnabled(feature: Feature): Boolean
+
+    /**
+     * @param feature the feature to enable or disable
+     * @param enabled true to enable the feature
+     *
+     * @return true if the method succeeds, ie if a RuntimeFeatureFlagProvider is registered
+     */
+    suspend fun setFeatureEnabled(feature: Feature, enabled: Boolean): Boolean
+}

libraries/featureflag/api/src/main/kotlin/io/element/android/libraries/featureflag/api/FeatureFlags.kt

@@ -0,0 +1,37 @@
+/*
+ * Copyright (c) 2023 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 io.element.android.libraries.featureflag.api
+
+enum class FeatureFlags(
+    override val key: String,
+    override val title: String,
+    override val description: String? = null,
+    override val defaultValue: Boolean = true
+) : Feature {
+    CollapseRoomStateEvents(
+        key = "feature.collapseroomstateevents",
+        title = "Collapse room state events",
+    ),
+    ShowStartChatFlow(
+        key = "feature.showstartchatflow",
+        title = "Show start chat flow",
+    ),
+    ShowMediaUploadingFlow(
+        key = "feature.showmediauploadingflow",
+        title = "Show media uploading flow",
+    )
+}

libraries/featureflag/impl/build.gradle.kts

@@ -0,0 +1,44 @@
+/*
+ * Copyright (c) 2023 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.
+ */
+
+// TODO: Remove once https://youtrack.jetbrains.com/issue/KTIJ-19369 is fixed
+@Suppress("DSL_SCOPE_VIOLATION")
+plugins {
+    id("io.element.android-library")
+    alias(libs.plugins.anvil)
+    alias(libs.plugins.ksp)
+    id("kotlin-parcelize")
+}
+
+android {
+    namespace = "io.element.android.libraries.featureflag.impl"
+}
+
+anvil {
+    generateDaggerFactories.set(true)
+}
+
+dependencies {
+    api(projects.libraries.featureflag.api)
+    implementation(libs.dagger)
+    implementation(libs.androidx.datastore.preferences)
+    implementation(projects.libraries.di)
+    implementation(projects.libraries.core)
+    testImplementation(libs.test.junit)
+    testImplementation(libs.coroutines.test)
+    testImplementation(libs.test.truth)
+    testImplementation(libs.test.turbine)
+}

libraries/featureflag/impl/src/main/kotlin/io/element/android/libraries/featureflag/impl/BuildtimeFeatureFlagProvider.kt

@@ -0,0 +1,42 @@
+/*
+ * Copyright (c) 2023 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 io.element.android.libraries.featureflag.impl
+
+import io.element.android.libraries.featureflag.api.Feature
+import io.element.android.libraries.featureflag.api.FeatureFlags
+import javax.inject.Inject
+
+class BuildtimeFeatureFlagProvider @Inject constructor() :
+    FeatureFlagProvider {
+
+    override val priority: Int
+        get() = LOW_PRIORITY
+
+    override suspend fun isFeatureEnabled(feature: Feature): Boolean {
+        return if (feature is FeatureFlags) {
+            when (feature) {
+                FeatureFlags.CollapseRoomStateEvents -> false
+                FeatureFlags.ShowStartChatFlow -> false
+                FeatureFlags.ShowMediaUploadingFlow -> false
+            }
+        } else {
+            false
+        }
+    }
+
+    override fun hasFeature(feature: Feature) = true
+}

libraries/featureflag/impl/src/main/kotlin/io/element/android/libraries/featureflag/impl/DefaultFeatureFlagService.kt

@@ -0,0 +1,48 @@
+/*
+ * Copyright (c) 2023 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 io.element.android.libraries.featureflag.impl
+
+import com.squareup.anvil.annotations.ContributesBinding
+import io.element.android.libraries.di.AppScope
+import io.element.android.libraries.di.SingleIn
+import io.element.android.libraries.featureflag.api.Feature
+import io.element.android.libraries.featureflag.api.FeatureFlagService
+import javax.inject.Inject
+
+@ContributesBinding(AppScope::class)
+@SingleIn(AppScope::class)
+class DefaultFeatureFlagService @Inject constructor(
+    private val providers: Set<@JvmSuppressWildcards FeatureFlagProvider>
+) : FeatureFlagService {
+
+    override suspend fun isFeatureEnabled(feature: Feature): Boolean {
+        return providers.filter { it.hasFeature(feature) }
+            .sortedBy(FeatureFlagProvider::priority)
+            .firstOrNull()
+            ?.isFeatureEnabled(feature)
+            ?: feature.defaultValue
+    }
+
+    override suspend fun setFeatureEnabled(feature: Feature, enabled: Boolean): Boolean {
+        return providers.filterIsInstance(RuntimeFeatureFlagProvider::class.java)
+            .sortedBy(FeatureFlagProvider::priority)
+            .firstOrNull()
+            ?.setFeatureEnabled(feature, enabled)
+            ?.let { true }
+            ?: false
+    }
+}

libraries/featureflag/impl/src/main/kotlin/io/element/android/libraries/featureflag/impl/FeatureFlagProvider.kt

@@ -0,0 +1,30 @@
+/*
+ * Copyright (c) 2023 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 io.element.android.libraries.featureflag.impl
+
+import io.element.android.libraries.featureflag.api.Feature
+
+interface FeatureFlagProvider {
+    val priority: Int
+    suspend fun isFeatureEnabled(feature: Feature): Boolean
+    fun hasFeature(feature: Feature): Boolean
+}
+
+const val LOW_PRIORITY = 0
+const val MEDIUM_PRIORITY = 1
+const val HIGH_PRIORITY = 2
+

libraries/featureflag/impl/src/main/kotlin/io/element/android/libraries/featureflag/impl/PreferencesFeatureFlagProvider.kt

@@ -0,0 +1,55 @@
+/*
+ * Copyright (c) 2023 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 io.element.android.libraries.featureflag.impl
+
+import android.content.Context
+import androidx.datastore.core.DataStore
+import androidx.datastore.preferences.core.Preferences
+import androidx.datastore.preferences.core.booleanPreferencesKey
+import androidx.datastore.preferences.core.edit
+import androidx.datastore.preferences.preferencesDataStore
+import io.element.android.libraries.di.ApplicationContext
+import io.element.android.libraries.featureflag.api.Feature
+import kotlinx.coroutines.flow.first
+import kotlinx.coroutines.flow.map
+import javax.inject.Inject
+
+private val Context.dataStore: DataStore<Preferences> by preferencesDataStore(name = "elementx_featureflag")
+
+class PreferencesFeatureFlagProvider @Inject constructor(@ApplicationContext context: Context) : RuntimeFeatureFlagProvider {
+
+    private val store = context.dataStore
+
+    override val priority: Int
+        get() = MEDIUM_PRIORITY
+
+    override suspend fun setFeatureEnabled(feature: Feature, enabled: Boolean) {
+        store.edit { prefs ->
+            prefs[booleanPreferencesKey(feature.key)] = enabled
+        }
+    }
+
+    override suspend fun isFeatureEnabled(feature: Feature): Boolean {
+        return store.data.map { prefs ->
+            prefs[booleanPreferencesKey(feature.key)] ?: feature.defaultValue
+        }.first()
+    }
+
+    override fun hasFeature(feature: Feature): Boolean {
+        return true
+    }
+}

libraries/featureflag/impl/src/main/kotlin/io/element/android/libraries/featureflag/impl/RuntimeFeatureFlagProvider.kt

@@ -0,0 +1,23 @@
+/*
+ * Copyright (c) 2023 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 io.element.android.libraries.featureflag.impl
+
+import io.element.android.libraries.featureflag.api.Feature
+
+interface RuntimeFeatureFlagProvider : FeatureFlagProvider {
+    suspend fun setFeatureEnabled(feature: Feature, enabled: Boolean)
+}

libraries/featureflag/impl/src/main/kotlin/io/element/android/libraries/featureflag/impl/di/FeatureFlagModule.kt

@@ -0,0 +1,56 @@
+/*
+ * Copyright (c) 2023 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 io.element.android.libraries.featureflag.impl.di
+
+import com.squareup.anvil.annotations.ContributesTo
+import dagger.Module
+import dagger.Provides
+import dagger.multibindings.ElementsIntoSet
+import io.element.android.libraries.core.meta.BuildMeta
+import io.element.android.libraries.di.AppScope
+import io.element.android.libraries.featureflag.impl.BuildtimeFeatureFlagProvider
+import io.element.android.libraries.featureflag.impl.FeatureFlagProvider
+import io.element.android.libraries.featureflag.impl.PreferencesFeatureFlagProvider
+import io.element.android.libraries.featureflag.impl.RuntimeFeatureFlagProvider
+
+@Module
+@ContributesTo(AppScope::class)
+object FeatureFlagModule {
+
+    @Provides
+    fun providesRuntimeFeatureFlagProvider(preferencesFeatureFlagProvider: PreferencesFeatureFlagProvider): RuntimeFeatureFlagProvider {
+        return preferencesFeatureFlagProvider
+    }
+
+    @JvmStatic
+    @Provides
+    @ElementsIntoSet
+    fun providesFeatureFlagProvider(
+        buildMeta: BuildMeta,
+        buildtimeFeatureFlagProvider: BuildtimeFeatureFlagProvider,
+        runtimeFeatureFlagProvider: RuntimeFeatureFlagProvider,
+    ): Set<FeatureFlagProvider> {
+        val providers = HashSet<FeatureFlagProvider>()
+        //TODO change this condition?
+        if (buildMeta.isDebug) {
+            providers.add(runtimeFeatureFlagProvider)
+        } else {
+            providers.add(buildtimeFeatureFlagProvider)
+        }
+        return providers
+    }
+}

libraries/featureflag/ui/build.gradle.kts

@@ -0,0 +1,39 @@
+/*
+ * Copyright (c) 2023 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.
+ */
+
+// TODO: Remove once https://youtrack.jetbrains.com/issue/KTIJ-19369 is fixed
+@Suppress("DSL_SCOPE_VIOLATION")
+plugins {
+    id("io.element.android-compose-library")
+    alias(libs.plugins.anvil)
+    alias(libs.plugins.ksp)
+    id("kotlin-parcelize")
+}
+
+android {
+    namespace = "io.element.android.libraries.featureflag.ui"
+}
+
+anvil {
+    generateDaggerFactories.set(true)
+}
+
+dependencies {
+    implementation(projects.anvilannotations)
+    anvil(projects.anvilcodegen)
+    implementation(projects.libraries.designsystem)
+    ksp(libs.showkase.processor)
+}

libraries/featureflag/ui/src/main/kotlin/io/element/android/libraries/featureflag/ui/FeatureListView.kt

@@ -0,0 +1,85 @@
+/*
+ * Copyright (c) 2023 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 io.element.android.libraries.featureflag.ui
+
+import androidx.compose.foundation.lazy.LazyColumn
+import androidx.compose.foundation.lazy.items
+import androidx.compose.runtime.Composable
+import androidx.compose.ui.Modifier
+import androidx.compose.ui.tooling.preview.Preview
+import io.element.android.libraries.designsystem.components.preferences.PreferenceSwitch
+import io.element.android.libraries.designsystem.preview.ElementPreviewDark
+import io.element.android.libraries.designsystem.preview.ElementPreviewLight
+import io.element.android.libraries.featureflag.ui.model.FeatureUiModel
+import io.element.android.libraries.featureflag.ui.model.aFeatureUiModelList
+import kotlinx.collections.immutable.ImmutableList
+
+@Composable
+fun FeatureListView(
+    features: ImmutableList<FeatureUiModel>,
+    onCheckedChange: (FeatureUiModel, Boolean) -> Unit,
+    modifier: Modifier = Modifier
+) {
+    LazyColumn(
+        modifier = modifier,
+    ) {
+        items(
+            items = features,
+            key = { it.key }
+        ) { feature ->
+
+            fun onCheckedChange(isChecked: Boolean) {
+                onCheckedChange(feature, isChecked)
+            }
+
+            FeaturePreferenceView(feature = feature, onCheckedChange = ::onCheckedChange)
+        }
+    }
+}
+
+@Composable
+fun FeaturePreferenceView(
+    feature: FeatureUiModel,
+    onCheckedChange: (Boolean) -> Unit,
+    modifier: Modifier = Modifier
+) {
+
+    PreferenceSwitch(
+        title = feature.title,
+        isChecked = feature.isEnabled,
+        modifier = modifier,
+        onCheckedChange = onCheckedChange
+    )
+}
+
+@Preview
+@Composable
+internal fun FeatureListViewLightPreview() =
+    ElementPreviewLight { ContentToPreview() }
+
+@Preview
+@Composable
+internal fun FeatureListViewDarkPreview() =
+    ElementPreviewDark { ContentToPreview() }
+
+@Composable
+private fun ContentToPreview() {
+    FeatureListView(
+        features = aFeatureUiModelList(),
+        onCheckedChange = { _, _ -> }
+    )
+}

libraries/featureflag/ui/src/main/kotlin/io/element/android/libraries/featureflag/ui/model/FeatureUiModel.kt

@@ -0,0 +1,23 @@
+/*
+ * Copyright (c) 2023 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 io.element.android.libraries.featureflag.ui.model
+
+data class FeatureUiModel(
+    val key: String,
+    val title: String,
+    val isEnabled: Boolean
+)

libraries/featureflag/ui/src/main/kotlin/io/element/android/libraries/featureflag/ui/model/FeatureUiModelProvider.kt

@@ -0,0 +1,27 @@
+/*
+ * Copyright (c) 2023 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 io.element.android.libraries.featureflag.ui.model
+
+import kotlinx.collections.immutable.ImmutableList
+import kotlinx.collections.immutable.persistentListOf
+
+fun aFeatureUiModelList(): ImmutableList<FeatureUiModel> {
+    return persistentListOf(
+        FeatureUiModel("key1", "Display State Events", true),
+        FeatureUiModel("key2", "Display Room Events", false)
+    )
+}