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

Commit 88237907 authored by Helen Cheuk's avatar Helen Cheuk Committed by Android (Google) Code Review
Browse files

Merge "[Contextual Edu] Make contextual education module optional" into main

parents d95b534a 97507d8b

packages/SystemUI/multivalentTests/src/com/android/systemui/education/domain/interactor/KeyboardTouchpadEduInteractorTest.kt

+145 −3
Original line number Diff line number Diff line
@@ -30,8 +30,11 @@ import com.android.systemui.education.data.model.GestureEduModel 
import com.android.systemui.education.data.repository.contextualEducationRepository

import com.android.systemui.education.data.repository.fakeEduClock

import com.android.systemui.education.shared.model.EducationUiType

import com.android.systemui.inputdevice.tutorial.data.repository.DeviceType

import com.android.systemui.inputdevice.tutorial.tutorialSchedulerRepository

import com.android.systemui.keyboard.data.repository.keyboardRepository

import com.android.systemui.kosmos.testScope

import com.android.systemui.recents.OverviewProxyService.OverviewProxyListener

import com.android.systemui.testKosmos

import com.android.systemui.touchpad.data.repository.touchpadRepository

import com.android.systemui.user.data.repository.fakeUserRepository
@@ -42,10 +45,13 @@ import kotlinx.coroutines.launch 
import kotlinx.coroutines.test.TestScope

import kotlinx.coroutines.test.runCurrent

import kotlinx.coroutines.test.runTest

import org.junit.After

import org.junit.Assume.assumeTrue

import org.junit.Before

import org.junit.Test

import org.junit.runner.RunWith

import org.mockito.kotlin.argumentCaptor

import org.mockito.kotlin.verify

import platform.test.runner.parameterized.ParameterizedAndroidJunit4

import platform.test.runner.parameterized.Parameters
@@ -56,14 +62,19 @@ class KeyboardTouchpadEduInteractorTest(private val gestureType: GestureType) : 
    private val kosmos = testKosmos()

    private val testScope = kosmos.testScope

    private val contextualEduInteractor = kosmos.contextualEducationInteractor

    private val repository = kosmos.contextualEducationRepository

    private val touchpadRepository = kosmos.touchpadRepository

    private val keyboardRepository = kosmos.keyboardRepository

    private val tutorialSchedulerRepository = kosmos.tutorialSchedulerRepository

    private val userRepository = kosmos.fakeUserRepository

    private val overviewProxyService = kosmos.mockOverviewProxyService



    private val underTest: KeyboardTouchpadEduInteractor = kosmos.keyboardTouchpadEduInteractor

    private val eduClock = kosmos.fakeEduClock

    private val minDurationForNextEdu =

        KeyboardTouchpadEduInteractor.minIntervalBetweenEdu + 1.seconds

    private val initialDelayElapsedDuration =

        KeyboardTouchpadEduInteractor.initialDelayDuration + 1.seconds



    @Before

    fun setup() {
@@ -271,6 +282,131 @@ class KeyboardTouchpadEduInteractorTest(private val gestureType: GestureType) : 
            assertThat(model?.lastShortcutTriggeredTime).isEqualTo(eduClock.instant())

        }



    @Test

    fun dataUpdatedOnIncrementSignalCountWhenTouchpadConnected() =

        testScope.runTest {

            assumeTrue(gestureType != ALL_APPS)

            setUpForInitialDelayElapse()

            touchpadRepository.setIsAnyTouchpadConnected(true)



            val model by collectLastValue(repository.readGestureEduModelFlow(gestureType))

            val originalValue = model!!.signalCount

            val listener = getOverviewProxyListener()

            listener.updateContextualEduStats(/* isTrackpadGesture= */ false, gestureType)



            assertThat(model?.signalCount).isEqualTo(originalValue + 1)

        }



    @Test

    fun dataUnchangedOnIncrementSignalCountWhenTouchpadDisconnected() =

        testScope.runTest {

            setUpForInitialDelayElapse()

            touchpadRepository.setIsAnyTouchpadConnected(false)



            val model by collectLastValue(repository.readGestureEduModelFlow(gestureType))

            val originalValue = model!!.signalCount

            val listener = getOverviewProxyListener()

            listener.updateContextualEduStats(/* isTrackpadGesture= */ false, gestureType)



            assertThat(model?.signalCount).isEqualTo(originalValue)

        }



    @Test

    fun dataUpdatedOnIncrementSignalCountWhenKeyboardConnected() =

        testScope.runTest {

            assumeTrue(gestureType == ALL_APPS)

            setUpForInitialDelayElapse()

            keyboardRepository.setIsAnyKeyboardConnected(true)



            val model by collectLastValue(repository.readGestureEduModelFlow(gestureType))

            val originalValue = model!!.signalCount

            val listener = getOverviewProxyListener()

            listener.updateContextualEduStats(/* isTrackpadGesture= */ false, gestureType)



            assertThat(model?.signalCount).isEqualTo(originalValue + 1)

        }



    @Test

    fun dataUnchangedOnIncrementSignalCountWhenKeyboardDisconnected() =

        testScope.runTest {

            setUpForInitialDelayElapse()

            keyboardRepository.setIsAnyKeyboardConnected(false)



            val model by collectLastValue(repository.readGestureEduModelFlow(gestureType))

            val originalValue = model!!.signalCount

            val listener = getOverviewProxyListener()

            listener.updateContextualEduStats(/* isTrackpadGesture= */ false, gestureType)



            assertThat(model?.signalCount).isEqualTo(originalValue)

        }



    @Test

    fun dataAddedOnUpdateShortcutTriggerTime() =

        testScope.runTest {

            val model by collectLastValue(repository.readGestureEduModelFlow(gestureType))

            assertThat(model?.lastShortcutTriggeredTime).isNull()



            val listener = getOverviewProxyListener()

            listener.updateContextualEduStats(/* isTrackpadGesture= */ true, gestureType)



            assertThat(model?.lastShortcutTriggeredTime).isEqualTo(kosmos.fakeEduClock.instant())

        }



    @Test

    fun dataUpdatedOnIncrementSignalCountAfterInitialDelay() =

        testScope.runTest {

            setUpForDeviceConnection()

            tutorialSchedulerRepository.updateLaunchTime(DeviceType.TOUCHPAD, eduClock.instant())



            val model by collectLastValue(repository.readGestureEduModelFlow(gestureType))

            val originalValue = model!!.signalCount

            eduClock.offset(initialDelayElapsedDuration)

            val listener = getOverviewProxyListener()

            listener.updateContextualEduStats(/* isTrackpadGesture= */ false, gestureType)



            assertThat(model?.signalCount).isEqualTo(originalValue + 1)

        }



    @Test

    fun dataUnchangedOnIncrementSignalCountBeforeInitialDelay() =

        testScope.runTest {

            setUpForDeviceConnection()

            tutorialSchedulerRepository.updateLaunchTime(DeviceType.TOUCHPAD, eduClock.instant())



            val model by collectLastValue(repository.readGestureEduModelFlow(gestureType))

            val originalValue = model!!.signalCount

            // No offset to the clock to simulate update before initial delay

            val listener = getOverviewProxyListener()

            listener.updateContextualEduStats(/* isTrackpadGesture= */ false, gestureType)



            assertThat(model?.signalCount).isEqualTo(originalValue)

        }



    @Test

    fun dataUnchangedOnIncrementSignalCountWithoutOobeLaunchTime() =

        testScope.runTest {

            // No update to OOBE launch time to simulate no OOBE is launched yet

            setUpForDeviceConnection()



            val model by collectLastValue(repository.readGestureEduModelFlow(gestureType))

            val originalValue = model!!.signalCount

            val listener = getOverviewProxyListener()

            listener.updateContextualEduStats(/* isTrackpadGesture= */ false, gestureType)



            assertThat(model?.signalCount).isEqualTo(originalValue)

        }



    private suspend fun setUpForInitialDelayElapse() {

        tutorialSchedulerRepository.updateLaunchTime(DeviceType.TOUCHPAD, eduClock.instant())

        tutorialSchedulerRepository.updateLaunchTime(DeviceType.KEYBOARD, eduClock.instant())

        eduClock.offset(initialDelayElapsedDuration)

    }



    @After

    fun clear() {

        testScope.launch { tutorialSchedulerRepository.clearDataStore() }

    }



    private suspend fun triggerMaxEducationSignals(gestureType: GestureType) {

        // Increment max number of signal to try triggering education

        for (i in 1..KeyboardTouchpadEduInteractor.MAX_SIGNAL_COUNT) {
@@ -288,9 +424,15 @@ class KeyboardTouchpadEduInteractorTest(private val gestureType: GestureType) : 
        runCurrent()

    }



    private suspend fun setUpForDeviceConnection() {

        contextualEduInteractor.updateKeyboardFirstConnectionTime()

        contextualEduInteractor.updateTouchpadFirstConnectionTime()

    private fun setUpForDeviceConnection() {

        touchpadRepository.setIsAnyTouchpadConnected(true)

        keyboardRepository.setIsAnyKeyboardConnected(true)

    }



    private fun getOverviewProxyListener(): OverviewProxyListener {

        val listenerCaptor = argumentCaptor<OverviewProxyListener>()

        verify(overviewProxyService).addCallback(listenerCaptor.capture())

        return listenerCaptor.firstValue

    }



    companion object {

packages/SystemUI/multivalentTests/src/com/android/systemui/education/domain/interactor/KeyboardTouchpadStatsInteractorTest.kt

deleted100644 → 0
+0 −172
Original line number Diff line number Diff line 
/*

 * Copyright 2024 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.education.domain.interactor



import androidx.test.ext.junit.runners.AndroidJUnit4

import androidx.test.filters.SmallTest

import com.android.systemui.SysuiTestCase

import com.android.systemui.contextualeducation.GestureType.ALL_APPS

import com.android.systemui.contextualeducation.GestureType.BACK

import com.android.systemui.coroutines.collectLastValue

import com.android.systemui.education.data.repository.contextualEducationRepository

import com.android.systemui.education.data.repository.fakeEduClock

import com.android.systemui.inputdevice.tutorial.data.repository.DeviceType

import com.android.systemui.inputdevice.tutorial.tutorialSchedulerRepository

import com.android.systemui.keyboard.data.repository.keyboardRepository

import com.android.systemui.kosmos.testScope

import com.android.systemui.testKosmos

import com.android.systemui.touchpad.data.repository.touchpadRepository

import com.google.common.truth.Truth.assertThat

import kotlin.time.Duration.Companion.seconds

import kotlinx.coroutines.launch

import kotlinx.coroutines.test.runTest

import org.junit.After

import org.junit.Test

import org.junit.runner.RunWith



@SmallTest

@RunWith(AndroidJUnit4::class)

class KeyboardTouchpadStatsInteractorTest : SysuiTestCase() {

    private val kosmos = testKosmos()

    private val testScope = kosmos.testScope

    private val underTest = kosmos.keyboardTouchpadEduStatsInteractor

    private val keyboardRepository = kosmos.keyboardRepository

    private val touchpadRepository = kosmos.touchpadRepository

    private val repository = kosmos.contextualEducationRepository

    private val fakeClock = kosmos.fakeEduClock

    private val tutorialSchedulerRepository = kosmos.tutorialSchedulerRepository

    private val initialDelayElapsedDuration =

        KeyboardTouchpadEduStatsInteractorImpl.initialDelayDuration + 1.seconds



    @Test

    fun dataUpdatedOnIncrementSignalCountWhenTouchpadConnected() =

        testScope.runTest {

            setUpForInitialDelayElapse()

            touchpadRepository.setIsAnyTouchpadConnected(true)



            val model by collectLastValue(repository.readGestureEduModelFlow(BACK))

            val originalValue = model!!.signalCount

            underTest.incrementSignalCount(BACK)



            assertThat(model?.signalCount).isEqualTo(originalValue + 1)

        }



    @Test

    fun dataUnchangedOnIncrementSignalCountWhenTouchpadDisconnected() =

        testScope.runTest {

            setUpForInitialDelayElapse()

            touchpadRepository.setIsAnyTouchpadConnected(false)



            val model by collectLastValue(repository.readGestureEduModelFlow(BACK))

            val originalValue = model!!.signalCount

            underTest.incrementSignalCount(BACK)



            assertThat(model?.signalCount).isEqualTo(originalValue)

        }



    @Test

    fun dataUpdatedOnIncrementSignalCountWhenKeyboardConnected() =

        testScope.runTest {

            setUpForInitialDelayElapse()

            keyboardRepository.setIsAnyKeyboardConnected(true)



            val model by collectLastValue(repository.readGestureEduModelFlow(ALL_APPS))

            val originalValue = model!!.signalCount

            underTest.incrementSignalCount(ALL_APPS)



            assertThat(model?.signalCount).isEqualTo(originalValue + 1)

        }



    @Test

    fun dataUnchangedOnIncrementSignalCountWhenKeyboardDisconnected() =

        testScope.runTest {

            setUpForInitialDelayElapse()

            keyboardRepository.setIsAnyKeyboardConnected(false)



            val model by collectLastValue(repository.readGestureEduModelFlow(ALL_APPS))

            val originalValue = model!!.signalCount

            underTest.incrementSignalCount(ALL_APPS)



            assertThat(model?.signalCount).isEqualTo(originalValue)

        }



    @Test

    fun dataAddedOnUpdateShortcutTriggerTime() =

        testScope.runTest {

            val model by collectLastValue(repository.readGestureEduModelFlow(BACK))

            assertThat(model?.lastShortcutTriggeredTime).isNull()

            underTest.updateShortcutTriggerTime(BACK)

            assertThat(model?.lastShortcutTriggeredTime).isEqualTo(kosmos.fakeEduClock.instant())

        }



    @Test

    fun dataUpdatedOnIncrementSignalCountAfterInitialDelay() =

        testScope.runTest {

            setUpForDeviceConnection()

            tutorialSchedulerRepository.updateLaunchTime(DeviceType.TOUCHPAD, fakeClock.instant())



            fakeClock.offset(initialDelayElapsedDuration)

            val model by collectLastValue(repository.readGestureEduModelFlow(BACK))

            val originalValue = model!!.signalCount

            underTest.incrementSignalCount(BACK)



            assertThat(model?.signalCount).isEqualTo(originalValue + 1)

        }



    @Test

    fun dataUnchangedOnIncrementSignalCountBeforeInitialDelay() =

        testScope.runTest {

            setUpForDeviceConnection()

            tutorialSchedulerRepository.updateLaunchTime(DeviceType.TOUCHPAD, fakeClock.instant())



            // No offset to the clock to simulate update before initial delay

            val model by collectLastValue(repository.readGestureEduModelFlow(BACK))

            val originalValue = model!!.signalCount

            underTest.incrementSignalCount(BACK)



            assertThat(model?.signalCount).isEqualTo(originalValue)

        }



    @Test

    fun dataUnchangedOnIncrementSignalCountWithoutOobeLaunchTime() =

        testScope.runTest {

            // No update to OOBE launch time to simulate no OOBE is launched yet

            setUpForDeviceConnection()



            val model by collectLastValue(repository.readGestureEduModelFlow(BACK))

            val originalValue = model!!.signalCount

            underTest.incrementSignalCount(BACK)



            assertThat(model?.signalCount).isEqualTo(originalValue)

        }



    private suspend fun setUpForInitialDelayElapse() {

        tutorialSchedulerRepository.updateLaunchTime(DeviceType.TOUCHPAD, fakeClock.instant())

        tutorialSchedulerRepository.updateLaunchTime(DeviceType.KEYBOARD, fakeClock.instant())

        fakeClock.offset(initialDelayElapsedDuration)

    }



    private fun setUpForDeviceConnection() {

        touchpadRepository.setIsAnyTouchpadConnected(true)

        keyboardRepository.setIsAnyKeyboardConnected(true)

    }



    @After

    fun clear() {

        testScope.launch { tutorialSchedulerRepository.clearDataStore() }

    }

}

packages/SystemUI/src/com/android/systemui/dagger/ReferenceSystemUIModule.java

+2 −0
Original line number Diff line number Diff line
@@ -34,6 +34,7 @@ import com.android.systemui.display.ui.viewmodel.ConnectingDisplayViewModel; 
import com.android.systemui.dock.DockManager;

import com.android.systemui.dock.DockManagerImpl;

import com.android.systemui.doze.DozeHost;

import com.android.systemui.education.dagger.ContextualEducationModule;

import com.android.systemui.inputdevice.tutorial.KeyboardTouchpadTutorialModule;

import com.android.systemui.keyboard.shortcut.ShortcutHelperModule;

import com.android.systemui.keyguard.ui.composable.blueprint.DefaultBlueprintModule;
@@ -153,6 +154,7 @@ import javax.inject.Named; 
        VolumeModule.class,

        WallpaperModule.class,

        ShortcutHelperModule.class,

        ContextualEducationModule.class,

})

public abstract class ReferenceSystemUIModule {

packages/SystemUI/src/com/android/systemui/dagger/SystemUIModule.java

+1 −3
Original line number Diff line number Diff line
@@ -63,7 +63,6 @@ import com.android.systemui.display.DisplayModule; 
import com.android.systemui.doze.dagger.DozeComponent;

import com.android.systemui.dreams.dagger.DreamModule;

import com.android.systemui.dump.DumpManager;

import com.android.systemui.education.dagger.ContextualEducationModule;

import com.android.systemui.flags.FeatureFlags;

import com.android.systemui.flags.FlagDependenciesModule;

import com.android.systemui.flags.FlagsModule;
@@ -272,8 +271,7 @@ import javax.inject.Named; 
        UserModule.class,

        UtilModule.class,

        NoteTaskModule.class,

        WalletModule.class,

        ContextualEducationModule.class

        WalletModule.class

},

        subcomponents = {

                ComplicationComponent.class,

packages/SystemUI/src/com/android/systemui/education/dagger/ContextualEducationModule.kt

+0 −21
Original line number Diff line number Diff line
@@ -18,15 +18,12 @@ package com.android.systemui.education.dagger 


import com.android.systemui.CoreStartable

import com.android.systemui.Flags

import com.android.systemui.contextualeducation.GestureType

import com.android.systemui.coroutines.newTracingContext

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

import com.android.systemui.education.data.repository.ContextualEducationRepository

import com.android.systemui.education.data.repository.UserContextualEducationRepository

import com.android.systemui.education.domain.interactor.ContextualEducationInteractor

import com.android.systemui.education.domain.interactor.KeyboardTouchpadEduInteractor

import com.android.systemui.education.domain.interactor.KeyboardTouchpadEduStatsInteractor

import com.android.systemui.education.domain.interactor.KeyboardTouchpadEduStatsInteractorImpl

import com.android.systemui.education.ui.view.ContextualEduUiCoordinator

import dagger.Binds

import dagger.Lazy
@@ -82,18 +79,6 @@ interface ContextualEducationModule { 
            }

        }



        @Provides

        fun provideKeyboardTouchpadEduStatsInteractor(

            implLazy: Lazy<KeyboardTouchpadEduStatsInteractorImpl>

        ): KeyboardTouchpadEduStatsInteractor {

            return if (Flags.keyboardTouchpadContextualEducation()) {

                implLazy.get()

            } else {

                // No-op implementation when the flag is disabled.

                return NoOpKeyboardTouchpadEduStatsInteractor

            }

        }



        @Provides

        @IntoMap

        @ClassKey(KeyboardTouchpadEduInteractor::class)
@@ -124,12 +109,6 @@ interface ContextualEducationModule { 
    }

}



private object NoOpKeyboardTouchpadEduStatsInteractor : KeyboardTouchpadEduStatsInteractor {

    override fun incrementSignalCount(gestureType: GestureType) {}



    override fun updateShortcutTriggerTime(gestureType: GestureType) {}

}



private object NoOpCoreStartable : CoreStartable {

    override fun start() {}

}