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

Commit c2d97a5f authored by Ioana Alexandru's avatar Ioana Alexandru
Browse files

Move NotificationsInteractor & related repos to shared. 

We need a way to access notifications-related secure settings in new
sysui recommended architecture code. WallpaperPicker already had code
for this (in the form of a NotificationsInteractor,
NotificationsRepository and SecureSettingsRepository), so instead of
having multiple sources of truth for the same type of data, I moved
these to the shared package so both SystemUI and WallpaperPicker can
access them (see other CLs in topic).

I also renamed NotificationsInteractor and NotificationsRepository to
NotificationsSettingsInteractor and NotificationSettingsRepository
respectively, to better reflect the kind of data they handle.

This move also includes a very small behavior change - there was a
circular dependency between Notifications[Settings]Interactor and
NotificationsSnapshotRestorer, which deals with restoring setting when
the "Reset" button is pressed in WallpaperPicker. Since the snapshot
restorer only needs to exist in WallpaperPicker code, I split it from
the interactor and made it collect the settings flow from the interactor
directly.
I tested that this works correctly by running WallpaperPickerGoogle and
doing the following steps:
- open Lock screen customization page
- toggle "Show notifications on the lockscreen"
- lock the device to verify that the correct setting is applied
- unlock the device and press "Reset"
- verify that the toggle state is updated
- lock the device to verify that the old setting is applied

Keeping the test file in this package for now, because moving it is
complicated. See b/315806189.

Bug: 293167744
Test: manual (see steps above) + atest NotificationSettingsRepositoryTest
Flag: NONE

Change-Id: Iea3711af1871bb66ffed6f01c3fb1490d441cf02
parent 2584e8fe

src/com/android/customization/module/ThemePickerInjector.kt

+10 −10
Original line number Diff line number Diff line
@@ -56,8 +56,6 @@ import com.android.customization.picker.grid.data.repository.GridRepositoryImpl 
import com.android.customization.picker.grid.domain.interactor.GridInteractor

import com.android.customization.picker.grid.domain.interactor.GridSnapshotRestorer

import com.android.customization.picker.grid.ui.viewmodel.GridScreenViewModel

import com.android.customization.picker.notifications.data.repository.NotificationsRepository

import com.android.customization.picker.notifications.domain.interactor.NotificationsInteractor

import com.android.customization.picker.notifications.domain.interactor.NotificationsSnapshotRestorer

import com.android.customization.picker.notifications.ui.viewmodel.NotificationSectionViewModel

import com.android.customization.picker.quickaffordance.data.repository.KeyguardQuickAffordancePickerRepository
@@ -67,6 +65,8 @@ import com.android.customization.picker.quickaffordance.ui.viewmodel.KeyguardQui 
import com.android.systemui.shared.clocks.ClockRegistry

import com.android.systemui.shared.customization.data.content.CustomizationProviderClient

import com.android.systemui.shared.customization.data.content.CustomizationProviderClientImpl

import com.android.systemui.shared.notifications.data.repository.NotificationSettingsRepository

import com.android.systemui.shared.notifications.domain.interactor.NotificationSettingsInteractor

import com.android.wallpaper.config.BaseFlags

import com.android.wallpaper.module.CustomizationSections

import com.android.wallpaper.module.FragmentFactory
@@ -91,6 +91,7 @@ open class ThemePickerInjector 
internal constructor(

    @MainDispatcher private val mainScope: CoroutineScope,

    @MainDispatcher private val mainDispatcher: CoroutineDispatcher,

    @BackgroundDispatcher private val bgScope: CoroutineScope,

    @BackgroundDispatcher private val bgDispatcher: CoroutineDispatcher,

    private val userEventLogger: ThemesUserEventLogger,

) : WallpaperPicker2Injector(mainScope, bgDispatcher, userEventLogger), CustomizationInjector {
@@ -110,7 +111,7 @@ internal constructor( 
    private var clockCarouselViewModelFactory: ClockCarouselViewModel.Factory? = null

    private var clockViewFactory: ClockViewFactory? = null

    private var clockPickerSnapshotRestorer: ClockPickerSnapshotRestorer? = null

    private var notificationsInteractor: NotificationsInteractor? = null

    private var notificationSettingsInteractor: NotificationSettingsInteractor? = null

    private var notificationSectionViewModelFactory: NotificationSectionViewModel.Factory? = null

    private var colorPickerInteractor: ColorPickerInteractor? = null

    private var colorPickerViewModelFactory: ColorPickerViewModel.Factory? = null
@@ -297,19 +298,17 @@ internal constructor( 


    private fun getNotificationsInteractor(

        context: Context,

    ): NotificationsInteractor {

        val appContext = context.applicationContext

        return notificationsInteractor

            ?: NotificationsInteractor(

    ): NotificationSettingsInteractor {

        return notificationSettingsInteractor

            ?: NotificationSettingsInteractor(

                    repository =

                        NotificationsRepository(

                        NotificationSettingsRepository(

                            scope = getApplicationCoroutineScope(),

                            backgroundDispatcher = bgDispatcher,

                            secureSettingsRepository = getSecureSettingsRepository(context),

                        ),

                    snapshotRestorer = { getNotificationsSnapshotRestorer(appContext) },

                )

                .also { notificationsInteractor = it }

                .also { notificationSettingsInteractor = it }

    }



    private fun getNotificationsSnapshotRestorer(context: Context): NotificationsSnapshotRestorer {
@@ -319,6 +318,7 @@ internal constructor( 
                        getNotificationsInteractor(

                            context = context,

                        ),

                    backgroundScope = bgScope,

                )

                .also { notificationsSnapshotRestorer = it }

    }

src/com/android/customization/picker/clock/data/repository/ClockPickerRepositoryImpl.kt

+1 −1
Original line number Diff line number Diff line
@@ -23,7 +23,7 @@ import com.android.customization.picker.clock.shared.ClockSize 
import com.android.customization.picker.clock.shared.model.ClockMetadataModel

import com.android.systemui.plugins.clocks.ClockMetadata

import com.android.systemui.shared.clocks.ClockRegistry

import com.android.wallpaper.settings.data.repository.SecureSettingsRepository

import com.android.systemui.shared.settings.data.repository.SecureSettingsRepository

import kotlinx.coroutines.CoroutineDispatcher

import kotlinx.coroutines.CoroutineScope

import kotlinx.coroutines.ExperimentalCoroutinesApi

src/com/android/customization/picker/notifications/data/repository/NotificationsRepository.kt

deleted100644 → 0
+0 −74
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.customization.picker.notifications.data.repository



import android.provider.Settings

import com.android.customization.picker.notifications.shared.model.NotificationSettingsModel

import com.android.wallpaper.settings.data.repository.SecureSettingsRepository

import kotlinx.coroutines.CoroutineDispatcher

import kotlinx.coroutines.CoroutineScope

import kotlinx.coroutines.flow.SharedFlow

import kotlinx.coroutines.flow.SharingStarted

import kotlinx.coroutines.flow.map

import kotlinx.coroutines.flow.shareIn

import kotlinx.coroutines.withContext



/** Provides access to state related to notifications. */

class NotificationsRepository(

    scope: CoroutineScope,

    private val backgroundDispatcher: CoroutineDispatcher,

    private val secureSettingsRepository: SecureSettingsRepository,

) {

    /** The current state of the notification setting. */

    val settings: SharedFlow<NotificationSettingsModel> =

        secureSettingsRepository

            .intSetting(

                name = Settings.Secure.LOCK_SCREEN_SHOW_NOTIFICATIONS,

            )

            .map { lockScreenShowNotificationsInt ->

                NotificationSettingsModel(

                    isShowNotificationsOnLockScreenEnabled = lockScreenShowNotificationsInt == 1,

                )

            }

            .shareIn(

                scope = scope,

                started = SharingStarted.WhileSubscribed(),

                replay = 1,

            )



    suspend fun getSettings(): NotificationSettingsModel {

        return withContext(backgroundDispatcher) {

            NotificationSettingsModel(

                isShowNotificationsOnLockScreenEnabled =

                    secureSettingsRepository.get(

                        name = Settings.Secure.LOCK_SCREEN_SHOW_NOTIFICATIONS,

                        defaultValue = 0,

                    ) == 1

            )

        }

    }



    suspend fun setSettings(model: NotificationSettingsModel) {

        withContext(backgroundDispatcher) {

            secureSettingsRepository.set(

                name = Settings.Secure.LOCK_SCREEN_SHOW_NOTIFICATIONS,

                value = if (model.isShowNotificationsOnLockScreenEnabled) 1 else 0,

            )

        }

    }

}

src/com/android/customization/picker/notifications/domain/interactor/NotificationsInteractor.kt

deleted100644 → 0
+0 −52
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.customization.picker.notifications.domain.interactor



import com.android.customization.picker.notifications.data.repository.NotificationsRepository

import com.android.customization.picker.notifications.shared.model.NotificationSettingsModel

import javax.inject.Provider

import kotlinx.coroutines.flow.Flow



/** Encapsulates business logic for interacting with notifications. */

class NotificationsInteractor(

    private val repository: NotificationsRepository,

    private val snapshotRestorer: Provider<NotificationsSnapshotRestorer>,

) {

    /** The current state of the notification setting. */

    val settings: Flow<NotificationSettingsModel> = repository.settings



    /** Toggles the setting to show or hide notifications on the lock screen. */

    suspend fun toggleShowNotificationsOnLockScreenEnabled() {

        val currentModel = repository.getSettings()

        setSettings(

            currentModel.copy(

                isShowNotificationsOnLockScreenEnabled =

                    !currentModel.isShowNotificationsOnLockScreenEnabled,

            )

        )

    }



    suspend fun setSettings(model: NotificationSettingsModel) {

        repository.setSettings(model)

        snapshotRestorer.get().storeSnapshot(model)

    }



    suspend fun getSettings(): NotificationSettingsModel {

        return repository.getSettings()

    }

}

src/com/android/customization/picker/notifications/domain/interactor/NotificationsSnapshotRestorer.kt

+9 −4
Original line number Diff line number Diff line
@@ -12,24 +12,28 @@ 
 * 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.customization.picker.notifications.domain.interactor



import com.android.customization.picker.notifications.shared.model.NotificationSettingsModel

import com.android.systemui.shared.notifications.domain.interactor.NotificationSettingsInteractor

import com.android.systemui.shared.notifications.shared.model.NotificationSettingsModel

import com.android.wallpaper.picker.di.modules.BackgroundDispatcher

import com.android.wallpaper.picker.undo.domain.interactor.SnapshotRestorer

import com.android.wallpaper.picker.undo.domain.interactor.SnapshotStore

import com.android.wallpaper.picker.undo.shared.model.RestorableSnapshot

import kotlinx.coroutines.CoroutineScope

import kotlinx.coroutines.launch



/** Handles state restoration for notification settings. */

class NotificationsSnapshotRestorer(

    private val interactor: NotificationsInteractor,

    private val interactor: NotificationSettingsInteractor,

    @BackgroundDispatcher private val backgroundScope: CoroutineScope,

) : SnapshotRestorer {



    private var snapshotStore: SnapshotStore = SnapshotStore.NOOP



    fun storeSnapshot(model: NotificationSettingsModel) {

    private fun storeSnapshot(model: NotificationSettingsModel) {

        snapshotStore.store(snapshot(model))

    }
@@ -37,6 +41,7 @@ class NotificationsSnapshotRestorer( 
        store: SnapshotStore,

    ): RestorableSnapshot {

        snapshotStore = store

        backgroundScope.launch { interactor.settings.collect { model -> storeSnapshot(model) } }

        return snapshot(interactor.getSettings())

    }