Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit f9bd9a5f authored by Coco Duan's avatar Coco Duan
Browse files

Hub mode tutorial indicator 

Show an indicator view on keyguard when hub mode related settings
are enabled and communal flag is on.
Once the tutorial completes, the indicator will be hidden.

Bug: b/301269121
Test: atest CommunalTutorialRepositoryImplTest
Test: atest CommunalTutorialInteractorTest
Test: enable feature flag communal_hub;
adb shell settings put secure hub_mode_tutorial_state 0
adb shell settings put secure hub_mode_tutorial_state 1
adb shell settings put secure hub_mode_tutorial_state 10

Change-Id: I018179ee6ad6d118dd94b9757a24e6e2f1e544e4
parent 1c3c42fd

packages/SystemUI/res/values/dimens.xml

+5 −0
Original line number Diff line number Diff line
@@ -852,6 +852,11 @@ 
         'keyguard_affordance_horizontal_offset' -->

    <dimen name="keyguard_indication_area_padding">82dp</dimen>



    <!-- The width/padding of the communal tutorial indicator on keyguard. -->

    <dimen name="communal_tutorial_indicator_fixed_width">168dp</dimen>

    <dimen name="communal_tutorial_indicator_padding">24dp</dimen>

    <dimen name="communal_tutorial_indicator_horizontal_offset">32dp</dimen>



    <!-- The width/height of the unlock icon view on keyguard. -->

    <dimen name="keyguard_lock_height">42dp</dimen>

    <dimen name="keyguard_lock_padding">20dp</dimen>

packages/SystemUI/res/values/ids.xml

+1 −0
Original line number Diff line number Diff line
@@ -222,6 +222,7 @@ 
    <item type="id" name="lock_icon" />

    <item type="id" name="lock_icon_bg" />

    <item type="id" name="burn_in_layer" />

    <item type="id" name="communal_tutorial_indicator" />



    <!-- Privacy dialog -->

    <item type="id" name="privacy_dialog_close_app_button" />

packages/SystemUI/res/values/strings.xml

+3 −0
Original line number Diff line number Diff line
@@ -1043,6 +1043,9 @@ 
    <!-- Indication on the keyguard that is shown when the device is dock charging. [CHAR LIMIT=80]-->

    <string name="keyguard_indication_charging_time_dock"><xliff:g id="percentage" example="20%">%2$s</xliff:g> • Charging • Full in <xliff:g id="charging_time_left" example="4 hr, 2 min">%1$s</xliff:g></string>



    <!-- Indicator shown to start the communal tutorial. [CHAR LIMIT=100] -->

    <string name="communal_tutorial_indicator_text">Click on the arrow button to start the communal tutorial</string>



    <!-- Related to user switcher --><skip/>



    <!-- Accessibility label for the button that opens the user switcher. -->

packages/SystemUI/src/com/android/systemui/communal/data/repository/CommunalTutorialRepository.kt

0 → 100644
+144 −0
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2023 The Android Open Source Project

 *

 * 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 com.android.systemui.communal.data.repository



import android.provider.Settings

import android.provider.Settings.Secure.HUB_MODE_TUTORIAL_NOT_STARTED

import android.provider.Settings.Secure.HubModeTutorialState

import com.android.systemui.dagger.SysUISingleton

import com.android.systemui.dagger.qualifiers.Application

import com.android.systemui.dagger.qualifiers.Background

import com.android.systemui.log.LogBuffer

import com.android.systemui.log.core.Logger

import com.android.systemui.log.dagger.CommunalLog

import com.android.systemui.settings.UserTracker

import com.android.systemui.user.data.repository.UserRepository

import com.android.systemui.util.settings.SecureSettings

import com.android.systemui.util.settings.SettingsProxyExt.observerFlow

import javax.inject.Inject

import kotlinx.coroutines.CoroutineDispatcher

import kotlinx.coroutines.CoroutineScope

import kotlinx.coroutines.ExperimentalCoroutinesApi

import kotlinx.coroutines.flow.Flow

import kotlinx.coroutines.flow.SharingStarted

import kotlinx.coroutines.flow.StateFlow

import kotlinx.coroutines.flow.filterNotNull

import kotlinx.coroutines.flow.flatMapLatest

import kotlinx.coroutines.flow.map

import kotlinx.coroutines.flow.onStart

import kotlinx.coroutines.flow.shareIn

import kotlinx.coroutines.flow.stateIn

import kotlinx.coroutines.withContext



/**

 * Repository for the current state of hub mode tutorial. Valid states are defined in

 * [HubModeTutorialState].

 */

interface CommunalTutorialRepository {

    /** Emits the tutorial state stored in Settings */

    val tutorialSettingState: StateFlow<Int>



    /** Update the tutorial state */

    suspend fun setTutorialState(@HubModeTutorialState state: Int)

}



@OptIn(ExperimentalCoroutinesApi::class)

@SysUISingleton

class CommunalTutorialRepositoryImpl

@Inject

constructor(

    @Application private val applicationScope: CoroutineScope,

    @Background private val backgroundDispatcher: CoroutineDispatcher,

    userRepository: UserRepository,

    private val secureSettings: SecureSettings,

    private val userTracker: UserTracker,

    @CommunalLog logBuffer: LogBuffer,

) : CommunalTutorialRepository {



    companion object {

        private const val TAG = "CommunalTutorialRepository"

    }



    private data class SettingsState(

        @HubModeTutorialState val hubModeTutorialState: Int? = null,

    )



    private val logger = Logger(logBuffer, TAG)



    private val settingsState: Flow<SettingsState> =

        userRepository.selectedUserInfo

            .flatMapLatest { observeSettings() }

            .shareIn(scope = applicationScope, started = SharingStarted.WhileSubscribed())



    /** Emits the state of tutorial state in settings */

    override val tutorialSettingState: StateFlow<Int> =

        settingsState

            .map { it.hubModeTutorialState }

            .filterNotNull()

            .stateIn(

                scope = applicationScope,

                started = SharingStarted.WhileSubscribed(),

                initialValue = HUB_MODE_TUTORIAL_NOT_STARTED

            )



    private fun observeSettings(): Flow<SettingsState> =

        secureSettings

            .observerFlow(

                userId = userTracker.userId,

                names =

                    arrayOf(

                        Settings.Secure.HUB_MODE_TUTORIAL_STATE,

                    )

            )

            // Force an update

            .onStart { emit(Unit) }

            .map { readFromSettings() }



    private suspend fun readFromSettings(): SettingsState =

        withContext(backgroundDispatcher) {

            val userId = userTracker.userId

            val hubModeTutorialState =

                secureSettings.getIntForUser(

                    Settings.Secure.HUB_MODE_TUTORIAL_STATE,

                    HUB_MODE_TUTORIAL_NOT_STARTED,

                    userId,

                )

            val settingsState = SettingsState(hubModeTutorialState)

            logger.d({ "Communal tutorial state for user $int1 in settings: $str1" }) {

                int1 = userId

                str1 = settingsState.hubModeTutorialState.toString()

            }



            settingsState

        }



    override suspend fun setTutorialState(state: Int): Unit =

        withContext(backgroundDispatcher) {

            val userId = userTracker.userId

            if (tutorialSettingState.value == state) {

                return@withContext

            }

            logger.d({ "Update communal tutorial state to $int1 for user $int2" }) {

                int1 = state

                int2 = userId

            }

            secureSettings.putIntForUser(

                Settings.Secure.HUB_MODE_TUTORIAL_STATE,

                state,

                userId,

            )

        }

}

packages/SystemUI/src/com/android/systemui/communal/data/repository/CommunalTutorialRepositoryModule.kt

0 → 100644
+27 −0
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2023 The Android Open Source Project

 *

 * 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 com.android.systemui.communal.data.repository



import dagger.Binds

import dagger.Module



@Module

interface CommunalTutorialRepositoryModule {

    @Binds

    fun communalTutorialRepository(impl: CommunalTutorialRepositoryImpl): CommunalTutorialRepository

}