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

Commit 44ae2d86 authored by helencheuk's avatar helencheuk Committed by Helen Cheuk
Browse files

[Contextual Edu] Simple implementation of repository 

Add repository for basic use case

Test: ContextualEducationRepositoryTest
Bug: 317496783
Flag: com.android.systemui.keyboard_touchpad_contextual_education
Change-Id: I80e112328afec23c220cfe1b374aed16513cd73c
parent c78176d9

packages/SystemUI/Android.bp

+2 −0
Original line number Diff line number Diff line
@@ -552,6 +552,7 @@ android_library { 
        "androidx.exifinterface_exifinterface",

        "androidx.room_room-runtime",

        "androidx.room_room-ktx",

        "androidx.datastore_datastore-preferences",

        "com.google.android.material_material",

        "device_state_flags_lib",

        "kotlinx_coroutines_android",
@@ -705,6 +706,7 @@ android_library { 
        "androidx.exifinterface_exifinterface",

        "androidx.room_room-runtime",

        "androidx.room_room-ktx",

        "androidx.datastore_datastore-preferences",

        "device_state_flags_lib",

        "kotlinx-coroutines-android",

        "kotlinx-coroutines-core",

packages/SystemUI/multivalentTests/src/com/android/systemui/education/data/repository/ContextualEducationRepositoryTest.kt

0 → 100644
+95 −0
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.data.repository



import android.content.Context

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

import androidx.test.filters.SmallTest

import com.android.systemui.SysuiTestCase

import com.android.systemui.SysuiTestableContext

import com.android.systemui.coroutines.collectLastValue

import com.android.systemui.kosmos.Kosmos

import com.android.systemui.kosmos.testDispatcher

import com.android.systemui.kosmos.testScope

import com.android.systemui.shared.education.GestureType.BACK_GESTURE

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

import java.io.File

import javax.inject.Provider

import kotlinx.coroutines.CoroutineScope

import kotlinx.coroutines.test.TestScope

import kotlinx.coroutines.test.runTest

import org.junit.Before

import org.junit.Rule

import org.junit.Test

import org.junit.rules.TemporaryFolder

import org.junit.runner.RunWith



@SmallTest

@RunWith(AndroidJUnit4::class)

class ContextualEducationRepositoryTest : SysuiTestCase() {



    private lateinit var underTest: ContextualEducationRepository

    private val kosmos = Kosmos()

    private val testScope = kosmos.testScope

    private val dsScopeProvider: Provider<CoroutineScope> = Provider {

        TestScope(kosmos.testDispatcher).backgroundScope

    }

    private val testUserId = 1111



    // For deleting any test files created after the test

    @get:Rule val tmpFolder: TemporaryFolder = TemporaryFolder.builder().assureDeletion().build()



    @Before

    fun setUp() {

        // Create TestContext here because TemporaryFolder.create() is called in @Before. It is

        // needed before calling TemporaryFolder.newFolder().

        val testContext = TestContext(context, tmpFolder.newFolder())

        val userRepository = UserContextualEducationRepository(testContext, dsScopeProvider)

        underTest = ContextualEducationRepository(userRepository)

        underTest.setUser(testUserId)

    }



    @Test

    fun changeRetrievedValueForNewUser() =

        testScope.runTest {

            // Update data for old user.

            underTest.incrementSignalCount(BACK_GESTURE)

            val model by collectLastValue(underTest.readGestureEduModelFlow(BACK_GESTURE))

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



            // User is changed.

            underTest.setUser(1112)

            // Assert count is 0 after user is changed.

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

        }



    @Test

    fun incrementSignalCount() =

        testScope.runTest {

            underTest.incrementSignalCount(BACK_GESTURE)

            val model by collectLastValue(underTest.readGestureEduModelFlow(BACK_GESTURE))

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

        }



    /** Test context which allows overriding getFilesDir path */

    private class TestContext(context: Context, private val folder: File) :

        SysuiTestableContext(context) {

        override fun getFilesDir(): File {

            return folder

        }

    }

}

packages/SystemUI/shared/src/com/android/systemui/shared/education/GestureType.kt

0 → 100644
+21 −0
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.shared.education



enum class GestureType {

    BACK_GESTURE,

}

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

+3 −1
Original line number Diff line number Diff line
@@ -63,6 +63,7 @@ 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;
@@ -261,7 +262,8 @@ import javax.inject.Named; 
        UserModule.class,

        UtilModule.class,

        NoteTaskModule.class,

        WalletModule.class

        WalletModule.class,

        ContextualEducationModule.class

        },

        subcomponents = {

            ComplicationComponent.class,

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

0 → 100644
+40 −0
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.dagger



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

import dagger.Module

import dagger.Provides

import javax.inject.Qualifier

import kotlinx.coroutines.CoroutineDispatcher

import kotlinx.coroutines.CoroutineScope

import kotlinx.coroutines.SupervisorJob



@Module

interface ContextualEducationModule {

    @Qualifier annotation class EduDataStoreScope



    companion object {

        @EduDataStoreScope

        @Provides

        fun provideEduDataStoreScope(

            @Background bgDispatcher: CoroutineDispatcher

        ): CoroutineScope {

            return CoroutineScope(bgDispatcher + SupervisorJob())

        }

    }

}