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",
+    )
+}