Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New Layout - Labs Flag (to replace feature flag) #7038

Merged
merged 16 commits into from
Sep 8, 2022
Merged

New Layout - Labs Flag (to replace feature flag) #7038

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
2450954
Replaces feature flag with labs flag
ericdecanini Sep 6, 2022
fbe5918
Adds changelog file
ericdecanini Sep 6, 2022
a851b0a
Fixes lint error
ericdecanini Sep 6, 2022
5e0d84b
Uses referenced default value for new layout labs flag
ericdecanini Sep 6, 2022
91b4918
Merge remote-tracking branch 'origin/feature/nfe/app_layout_hide_filt…
ericdecanini Sep 6, 2022
468c7b6
Re-adds feature flag
ericdecanini Sep 6, 2022
31a3552
Merge remote-tracking branch 'origin/develop' into feature/eric/new-l…
ericdecanini Sep 6, 2022
b7efd63
Changes vector feature preference key and function name for clarity
ericdecanini Sep 6, 2022
d77ce27
Fixes wrong use of feature flag instead of labs flag
ericdecanini Sep 6, 2022
9564c8f
Changes some preferences to be enabled or disabled by labs flag
ericdecanini Sep 6, 2022
6c23634
Unlocks the drawer layout when not new layout
ericdecanini Sep 6, 2022
afbb76f
Fixes lint error
ericdecanini Sep 7, 2022
64c8789
Merge remote-tracking branch 'origin/develop' into feature/eric/new-l…
ericdecanini Sep 7, 2022
37b2163
Merge remote-tracking branch 'origin/develop' into feature/eric/new-l…
ericdecanini Sep 7, 2022
6badbe7
robots are not checking feature flag for newAppLayout
Sep 8, 2022
2ab0343
sanity test now reads properties value to determine app layout featur…
Sep 8, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelog.d/7038.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Adds New App Layout into Labs
3 changes: 3 additions & 0 deletions library/ui-strings/src/main/res/values/strings.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -438,6 +438,9 @@
<string name="home_layout_preferences_sort_activity">Activity</string>
<string name="home_layout_preferences_sort_name">A - Z</string>

<string name="labs_enable_new_app_layout_title">Enable new layout</string>
<string name="labs_enable_new_app_layout_summary">A simplified Element with optional tabs</string>

<!-- Home fragment -->
<string name="invitations_header">Invites</string>
<string name="low_priority_header">Low priority</string>
Expand Down
1 change: 1 addition & 0 deletions vector-config/src/main/res/values/config-settings.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@

<!-- Level 1: Labs -->
<bool name="settings_labs_thread_messages_default">false</bool>
<bool name="settings_labs_new_app_layout_default">false</bool>
<bool name="settings_timeline_show_live_sender_info_visible">true</bool>
<bool name="settings_timeline_show_live_sender_info_default">false</bool>
<!-- Level 1: Advanced settings -->
Expand Down
2 changes: 1 addition & 1 deletion vector/src/main/java/im/vector/app/core/platform/VectorBaseActivity.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -249,7 +249,7 @@ abstract class VectorBaseActivity<VB : ViewBinding> : AppCompatActivity(), Maver

initUiAndData()

if (vectorFeatures.isNewAppLayoutEnabled()) {
if (vectorPreferences.isNewAppLayoutEnabled()) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since both vectorFeatures.isNewAppLayoutEnabled() and vectorPreferences.isNewAppLayoutEnabled() exist now, there is a risk of using the former instead of the latter, especially now that we have many open PR on the subject. Maybe rename the later to something else to force a compilation error on existing PR.

Something like vectorFeatures.isNewAppLayoutFeatureEnabled(). Also maybe document it to tell the developer that they may want to use vectorPreferences.isNewAppLayoutEnabled() instead, to take care of the labs settings.

I admit this is quite ugly...

tryOrNull { // Add to XML theme when feature flag is removed
val toolbarBackground = MaterialColors.getColor(views.root, R.attr.vctr_toolbar_background)
window.statusBarColor = toolbarBackground
Expand Down
8 changes: 4 additions & 4 deletions vector/src/main/java/im/vector/app/features/home/HomeActivity.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,7 @@ class HomeActivity :

override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
isNewAppLayoutEnabled = vectorFeatures.isNewAppLayoutEnabled()
isNewAppLayoutEnabled = vectorPreferences.isNewAppLayoutEnabled()
analyticsScreenName = MobileScreen.ScreenName.Home
supportFragmentManager.registerFragmentLifecycleCallbacks(fragmentLifecycleCallbacks, false)
unifiedPushHelper.register(this) {
Expand All @@ -217,7 +217,7 @@ class HomeActivity :
roomListSharedActionViewModel = viewModelProvider[RoomListSharedActionViewModel::class.java]
views.drawerLayout.addDrawerListener(drawerListener)
if (isFirstCreation()) {
if (vectorFeatures.isNewAppLayoutEnabled()) {
if (vectorPreferences.isNewAppLayoutEnabled()) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we want to unlock the drawer in the else block, since this is now a runtime setting.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch!

views.drawerLayout.setDrawerLockMode(DrawerLayout.LOCK_MODE_LOCKED_CLOSED)
replaceFragment(views.homeDetailFragmentContainer, NewHomeDetailFragment::class.java)
} else {
Expand Down Expand Up @@ -581,12 +581,12 @@ class HomeActivity :
}

private fun checkNewAppLayoutFlagChange() {
if (buildMeta.isDebug && vectorFeatures.isNewAppLayoutEnabled() != isNewAppLayoutEnabled) {
if (buildMeta.isDebug && vectorPreferences.isNewAppLayoutEnabled() != isNewAppLayoutEnabled) {
restart()
}
}

override fun getMenuRes() = if (vectorFeatures.isNewAppLayoutEnabled()) R.menu.menu_new_home else R.menu.menu_home
override fun getMenuRes() = if (vectorPreferences.isNewAppLayoutEnabled()) R.menu.menu_new_home else R.menu.menu_home

override fun handlePrepareMenu(menu: Menu) {
menu.findItem(R.id.menu_home_init_sync_legacy).isVisible = vectorPreferences.developerMode()
Expand Down
11 changes: 11 additions & 0 deletions vector/src/main/java/im/vector/app/features/settings/VectorPreferences.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ import im.vector.app.R
import im.vector.app.core.di.DefaultSharedPreferences
import im.vector.app.core.resources.BuildMeta
import im.vector.app.core.time.Clock
import im.vector.app.features.VectorFeatures
import im.vector.app.features.disclaimer.SHARED_PREF_KEY
import im.vector.app.features.home.ShortcutsHandler
import im.vector.app.features.homeserver.ServerUrlsRepository
Expand All @@ -39,6 +40,7 @@ class VectorPreferences @Inject constructor(
private val context: Context,
private val clock: Clock,
private val buildMeta: BuildMeta,
private val vectorFeatures: VectorFeatures,
) {

companion object {
Expand All @@ -63,6 +65,7 @@ class VectorPreferences @Inject constructor(
const val SETTINGS_BACKGROUND_SYNC_PREFERENCE_KEY = "SETTINGS_BACKGROUND_SYNC_PREFERENCE_KEY"
const val SETTINGS_BACKGROUND_SYNC_DIVIDER_PREFERENCE_KEY = "SETTINGS_BACKGROUND_SYNC_DIVIDER_PREFERENCE_KEY"
const val SETTINGS_LABS_PREFERENCE_KEY = "SETTINGS_LABS_PREFERENCE_KEY"
const val SETTINGS_LABS_NEW_APP_LAYOUT_KEY = "SETTINGS_LABS_ENABLE_NEW_LAYOUT"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

generally the val and the string has the same content (sort of convention, which is nice when looking across the whole codebase for the string), so maybe change to

Suggested change
const val SETTINGS_LABS_NEW_APP_LAYOUT_KEY = "SETTINGS_LABS_ENABLE_NEW_LAYOUT"
const val SETTINGS_LABS_NEW_APP_LAYOUT_KEY = "SETTINGS_LABS_NEW_APP_LAYOUT_KEY"

Do not forget to also change on vector_settings_labs.xml

const val SETTINGS_CRYPTOGRAPHY_PREFERENCE_KEY = "SETTINGS_CRYPTOGRAPHY_PREFERENCE_KEY"
const val SETTINGS_CRYPTOGRAPHY_DIVIDER_PREFERENCE_KEY = "SETTINGS_CRYPTOGRAPHY_DIVIDER_PREFERENCE_KEY"
const val SETTINGS_CRYPTOGRAPHY_MANAGE_PREFERENCE_KEY = "SETTINGS_CRYPTOGRAPHY_MANAGE_PREFERENCE_KEY"
Expand Down Expand Up @@ -1151,6 +1154,14 @@ class VectorPreferences @Inject constructor(
return spaceIdsJoined?.takeIf { it.isNotEmpty() }?.split(",").orEmpty()
}

/**
* Indicates whether or not new app layout is enabled.
*/
fun isNewAppLayoutEnabled(): Boolean {
return vectorFeatures.isNewAppLayoutEnabled() &&
defaultPrefs.getBoolean(SETTINGS_LABS_NEW_APP_LAYOUT_KEY, getDefault(R.bool.settings_labs_new_app_layout_default))
}

fun showLiveSenderInfo(): Boolean {
return defaultPrefs.getBoolean(SETTINGS_TIMELINE_SHOW_LIVE_SENDER_INFO, getDefault(R.bool.settings_timeline_show_live_sender_info_default))
}
Expand Down
8 changes: 6 additions & 2 deletions vector/src/main/java/im/vector/app/features/settings/VectorSettingsLabsFragment.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,8 +75,12 @@ class VectorSettingsLabsFragment :
}
}

findPreference<VectorSwitchPreference>(VectorPreferences.SETTINGS_LABS_UNREAD_NOTIFICATIONS_AS_TAB)!!.let {
it.isVisible = !vectorFeatures.isNewAppLayoutEnabled()
findPreference<VectorSwitchPreference>(VectorPreferences.SETTINGS_LABS_NEW_APP_LAYOUT_KEY)?.let { pref ->
pref.isVisible = vectorFeatures.isNewAppLayoutEnabled()
}

findPreference<VectorSwitchPreference>(VectorPreferences.SETTINGS_LABS_UNREAD_NOTIFICATIONS_AS_TAB)?.let { pref ->
pref.isVisible = !vectorFeatures.isNewAppLayoutEnabled()
}
}

Expand Down
8 changes: 4 additions & 4 deletions vector/src/main/java/im/vector/app/features/spaces/SpaceListFragment.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,11 +35,11 @@ import im.vector.app.core.extensions.configureWith
import im.vector.app.core.platform.StateView
import im.vector.app.core.platform.VectorBaseFragment
import im.vector.app.databinding.FragmentSpaceListBinding
import im.vector.app.features.VectorFeatures
import im.vector.app.features.home.HomeActivitySharedAction
import im.vector.app.features.home.HomeSharedActionViewModel
import im.vector.app.features.home.room.list.actions.RoomListSharedAction
import im.vector.app.features.home.room.list.actions.RoomListSharedActionViewModel
import im.vector.app.features.settings.VectorPreferences
import org.matrix.android.sdk.api.session.room.model.RoomSummary
import javax.inject.Inject

Expand All @@ -58,7 +58,7 @@ class SpaceListFragment :

@Inject lateinit var spaceController: SpaceSummaryController
@Inject lateinit var newSpaceController: NewSpaceSummaryController
@Inject lateinit var vectorFeatures: VectorFeatures
@Inject lateinit var vectorPreferences: VectorPreferences

private lateinit var homeActivitySharedActionViewModel: HomeSharedActionViewModel
private lateinit var roomListSharedActionViewModel: RoomListSharedActionViewModel
Expand All @@ -79,7 +79,7 @@ class SpaceListFragment :
}

private fun setupSpaceController() {
if (vectorFeatures.isNewAppLayoutEnabled()) {
if (vectorPreferences.isNewAppLayoutEnabled()) {
newSpaceController.callback = this
views.groupListView.configureWith(newSpaceController)
} else {
Expand Down Expand Up @@ -169,7 +169,7 @@ class SpaceListFragment :
else -> Unit
}

if (vectorFeatures.isNewAppLayoutEnabled()) {
if (vectorPreferences.isNewAppLayoutEnabled()) {
newSpaceController.update(state)
} else {
spaceController.update(state)
Expand Down
6 changes: 6 additions & 0 deletions vector/src/main/res/xml/vector_settings_labs.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,4 +83,10 @@
android:summary="@string/labs_enable_element_call_permission_shortcuts_summary"
android:title="@string/labs_enable_element_call_permission_shortcuts" />

<im.vector.app.core.preference.VectorSwitchPreference
android:defaultValue="@bool/settings_labs_new_app_layout_default"
android:key="SETTINGS_LABS_ENABLE_NEW_LAYOUT"
android:summary="@string/labs_enable_new_app_layout_summary"
android:title="@string/labs_enable_new_app_layout_title" />

</androidx.preference.PreferenceScreen>