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

Commit 4533782e authored by Fabián Kozynski's avatar Fabián Kozynski
Browse files

Add a QSSettingsRestoredRepository 

This is the first step to improving the B&R story in the new pipeline.

This is not flagged as it's not actually connected to anything.

Test: manual, send broadcast through adb
Test: atest QSSettingsRestoredBroadcastRepositoryTest
Bug: 289502851
Change-Id: I78ea4fb750ec6b403d7abd801174835a094acec1
parent ee20263f

packages/SystemUI/src/com/android/systemui/qs/pipeline/dagger/QSPipelineModule.kt

+14 −0
Original line number Diff line number Diff line
@@ -22,6 +22,8 @@ import com.android.systemui.log.LogBuffer 
import com.android.systemui.log.LogBufferFactory

import com.android.systemui.qs.pipeline.data.repository.InstalledTilesComponentRepository

import com.android.systemui.qs.pipeline.data.repository.InstalledTilesComponentRepositoryImpl

import com.android.systemui.qs.pipeline.data.repository.QSSettingsRestoredBroadcastRepository

import com.android.systemui.qs.pipeline.data.repository.QSSettingsRestoredRepository

import com.android.systemui.qs.pipeline.data.repository.TileSpecRepository

import com.android.systemui.qs.pipeline.data.repository.TileSpecSettingsRepository

import com.android.systemui.qs.pipeline.domain.interactor.CurrentTilesInteractor
@@ -56,6 +58,11 @@ abstract class QSPipelineModule { 
    @ClassKey(QSPipelineCoreStartable::class)

    abstract fun provideCoreStartable(startable: QSPipelineCoreStartable): CoreStartable



    @Binds

    abstract fun provideQSSettingsRestoredRepository(

            impl: QSSettingsRestoredBroadcastRepository

    ): QSSettingsRestoredRepository



    companion object {

        /**

         * Provides a logging buffer for all logs related to the new Quick Settings pipeline to log
@@ -67,5 +74,12 @@ abstract class QSPipelineModule { 
        fun provideQSTileListLogBuffer(factory: LogBufferFactory): LogBuffer {

            return factory.create(QSPipelineLogger.TILE_LIST_TAG, maxSize = 700, systrace = false)

        }



        @Provides

        @SysUISingleton

        @QSRestoreLog

        fun providesQSRestoreLogBuffer(factory: LogBufferFactory): LogBuffer {

            return factory.create(QSPipelineLogger.RESTORE_TAG, maxSize = 50, systrace = false)

        }

    }

}

packages/SystemUI/src/com/android/systemui/qs/pipeline/dagger/QSRestoreLog.kt

0 → 100644
+6 −0
Original line number Diff line number Diff line 
package com.android.systemui.qs.pipeline.dagger



import javax.inject.Qualifier



/** A [LogBuffer] for the QS pipeline to track restore of associated settings. */

@Qualifier @MustBeDocumented @Retention(AnnotationRetention.RUNTIME) annotation class QSRestoreLog

packages/SystemUI/src/com/android/systemui/qs/pipeline/data/model/RestoreData.kt

0 → 100644
+10 −0
Original line number Diff line number Diff line 
package com.android.systemui.qs.pipeline.data.model



import com.android.systemui.qs.pipeline.shared.TileSpec



/** Data restored from Quick Settings as part of Backup & Restore. */

data class RestoreData(

    val restoredTiles: List<TileSpec>,

    val restoredAutoAddedTiles: Set<TileSpec>,

    val userId: Int,

)

packages/SystemUI/src/com/android/systemui/qs/pipeline/data/repository/AutoAddRepository.kt

+3 −5
Original line number Diff line number Diff line
@@ -120,16 +120,14 @@ constructor( 


    private suspend fun load(userId: Int): Set<TileSpec> {

        return withContext(bgDispatcher) {

            (secureSettings.getStringForUser(SETTING, userId) ?: "")

                .split(",")

                .map(TileSpec::create)

                .filter { it !is TileSpec.Invalid }

                .toSet()

            (secureSettings.getStringForUser(SETTING, userId) ?: "").toTilesSet()

        }

    }



    companion object {

        private const val SETTING = Settings.Secure.QS_AUTO_ADDED_TILES

        private const val DELIMITER = ","



        private fun String.toTilesSet() = TilesSettingConverter.toTilesSet(this)

    }

}

packages/SystemUI/src/com/android/systemui/qs/pipeline/data/repository/QSSettingsRestoredRepository.kt

0 → 100644
+122 −0
Original line number Diff line number Diff line 
package com.android.systemui.qs.pipeline.data.repository



import android.content.Intent

import android.content.IntentFilter

import android.os.UserHandle

import android.provider.Settings

import android.util.Log

import com.android.systemui.broadcast.BroadcastDispatcher

import com.android.systemui.dagger.SysUISingleton

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

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

import com.android.systemui.qs.pipeline.data.model.RestoreData

import com.android.systemui.qs.pipeline.data.repository.TilesSettingConverter.toTilesList

import com.android.systemui.qs.pipeline.shared.logging.QSPipelineLogger

import javax.inject.Inject

import kotlinx.coroutines.CoroutineDispatcher

import kotlinx.coroutines.CoroutineScope

import kotlinx.coroutines.flow.Flow

import kotlinx.coroutines.flow.SharingStarted

import kotlinx.coroutines.flow.buffer

import kotlinx.coroutines.flow.catch

import kotlinx.coroutines.flow.filter

import kotlinx.coroutines.flow.flow

import kotlinx.coroutines.flow.flowOn

import kotlinx.coroutines.flow.onEach

import kotlinx.coroutines.flow.shareIn



/** Provides restored data (from Backup and Restore) for Quick Settings pipeline */

interface QSSettingsRestoredRepository {

    val restoreData: Flow<RestoreData>

}



@SysUISingleton

class QSSettingsRestoredBroadcastRepository

@Inject

constructor(

    broadcastDispatcher: BroadcastDispatcher,

    logger: QSPipelineLogger,

    @Application private val scope: CoroutineScope,

    @Background private val backgroundDispatcher: CoroutineDispatcher,

) : QSSettingsRestoredRepository {



    override val restoreData =

        flow {

                val firstIntent = mutableMapOf<Int, Intent>()

                broadcastDispatcher

                    .broadcastFlow(INTENT_FILTER, UserHandle.ALL) { intent, receiver ->

                        intent to receiver.sendingUserId

                    }

                    .filter { it.first.isCorrectSetting() }

                    .collect { (intent, user) ->

                        if (user !in firstIntent) {

                            firstIntent[user] = intent

                        } else {

                            val firstRestored = firstIntent.remove(user)!!

                            emit(processIntents(user, firstRestored, intent))

                        }

                    }

            }

            .catch { Log.e(TAG, "Error parsing broadcast", it) }

            .flowOn(backgroundDispatcher)

            .buffer(BUFFER_CAPACITY)

            .shareIn(scope, SharingStarted.Eagerly)

            .onEach(logger::logSettingsRestored)



    private fun processIntents(user: Int, intent1: Intent, intent2: Intent): RestoreData {

        intent1.validateIntent()

        intent2.validateIntent()

        val setting1 = intent1.getStringExtra(Intent.EXTRA_SETTING_NAME)

        val setting2 = intent2.getStringExtra(Intent.EXTRA_SETTING_NAME)

        val (tiles, autoAdd) =

            if (setting1 == TILES_SETTING && setting2 == AUTO_ADD_SETTING) {

                intent1 to intent2

            } else if (setting1 == AUTO_ADD_SETTING && setting2 == TILES_SETTING) {

                intent2 to intent1

            } else {

                throw IllegalStateException("Wrong intents ($intent1, $intent2)")

            }



        return RestoreData(

            (tiles.getStringExtra(Intent.EXTRA_SETTING_NEW_VALUE) ?: "").toTilesList(),

            (autoAdd.getStringExtra(Intent.EXTRA_SETTING_NEW_VALUE) ?: "").toTilesSet(),

            user,

        )

    }



    private companion object {

        private const val TAG = "QSSettingsRestoredBroadcastRepository"

        // This capacity is the number of restore data that we will keep buffered in the shared

        // flow. It is unlikely that at any given time there would be this many restores being

        // processed by consumers, but just in case that a couple of users are restored at the

        // same time and they need to be replayed for the consumers of the flow.

        private const val BUFFER_CAPACITY = 10



        private val INTENT_FILTER = IntentFilter(Intent.ACTION_SETTING_RESTORED)

        private const val TILES_SETTING = Settings.Secure.QS_TILES

        private const val AUTO_ADD_SETTING = Settings.Secure.QS_AUTO_ADDED_TILES

        private val requiredExtras =

            listOf(

                Intent.EXTRA_SETTING_NAME,

                Intent.EXTRA_SETTING_PREVIOUS_VALUE,

                Intent.EXTRA_SETTING_NEW_VALUE,

            )



        private fun Intent.isCorrectSetting(): Boolean {

            val setting = getStringExtra(Intent.EXTRA_SETTING_NAME)

            return setting == TILES_SETTING || setting == AUTO_ADD_SETTING

        }



        private fun Intent.validateIntent() {

            requiredExtras.forEach { extra ->

                if (!hasExtra(extra)) {

                    throw IllegalStateException("$this doesn't have $extra")

                }

            }

        }



        private fun String.toTilesList() = toTilesList(this)



        private fun String.toTilesSet() = TilesSettingConverter.toTilesSet(this)

    }

}