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

Commit 3b331dbe authored by Jeff DeCew's avatar Jeff DeCew
Browse files

Extract the SystemUI 'config' from DumpHandler to a critical Dumpable

This just extracts some dump logic to clean up some cruft in DumpHandler

Test: atest DumpHandlerTest
Test: dumpsysui bugreport-critical
Test: dumpsysui config
Bug: 292221335
Change-Id: I1e91a5b31070778d7d96f8a9f6e217126258e939
parent c44cfb9c
Loading
Loading
Loading
Loading
+2 −38
Original line number Diff line number Diff line
@@ -16,12 +16,9 @@

package com.android.systemui.dump

import android.content.Context
import android.os.SystemClock
import android.os.Trace
import com.android.systemui.CoreStartable
import com.android.systemui.ProtoDumpable
import com.android.systemui.R
import com.android.systemui.dump.DumpHandler.Companion.PRIORITY_ARG_CRITICAL
import com.android.systemui.dump.DumpHandler.Companion.PRIORITY_ARG_NORMAL
import com.android.systemui.dump.DumpsysEntry.DumpableEntry
@@ -36,7 +33,6 @@ import java.io.FileDescriptor
import java.io.FileOutputStream
import java.io.PrintWriter
import javax.inject.Inject
import javax.inject.Provider

/**
 * Oversees SystemUI's output during bug reports (and dumpsys in general)
@@ -91,10 +87,9 @@ import javax.inject.Provider
class DumpHandler
@Inject
constructor(
    private val context: Context,
    private val dumpManager: DumpManager,
    private val logBufferEulogizer: LogBufferEulogizer,
    private val startables: MutableMap<Class<*>, Provider<CoreStartable>>,
    private val config: SystemUIConfigDumpable,
) {
    /** Dump the diagnostics! Behavior can be controlled via [args]. */
    fun dump(fd: FileDescriptor, pw: PrintWriter, args: Array<String>) {
@@ -148,7 +143,6 @@ constructor(
                dumpDumpable(target, pw, args.rawArgs)
            }
        }
        dumpConfig(pw)
    }

    private fun dumpNormal(pw: PrintWriter, args: ParsedArgs) {
@@ -267,37 +261,7 @@ constructor(
    }

    private fun dumpConfig(pw: PrintWriter) {
        pw.println("SystemUiServiceComponents configuration:")
        pw.print("vendor component: ")
        pw.println(context.resources.getString(R.string.config_systemUIVendorServiceComponent))
        val services: MutableList<String> =
            startables.keys.map({ cls: Class<*> -> cls.simpleName }).toMutableList()

        services.add(context.resources.getString(R.string.config_systemUIVendorServiceComponent))
        dumpServiceList(pw, "global", services.toTypedArray())
        dumpServiceList(pw, "per-user", R.array.config_systemUIServiceComponentsPerUser)
    }

    private fun dumpServiceList(pw: PrintWriter, type: String, resId: Int) {
        val services: Array<String> = context.resources.getStringArray(resId)
        dumpServiceList(pw, type, services)
    }

    private fun dumpServiceList(pw: PrintWriter, type: String, services: Array<String>?) {
        pw.print(type)
        pw.print(": ")
        if (services == null) {
            pw.println("N/A")
            return
        }
        pw.print(services.size)
        pw.println(" services")
        for (i in services.indices) {
            pw.print("  ")
            pw.print(i)
            pw.print(": ")
            pw.println(services[i])
        }
        config.dump(pw, arrayOf())
    }

    private fun dumpHelp(pw: PrintWriter) {
+73 −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.dump

import android.content.Context
import com.android.systemui.CoreStartable
import com.android.systemui.Dumpable
import com.android.systemui.R
import com.android.systemui.dagger.SysUISingleton
import java.io.PrintWriter
import javax.inject.Inject
import javax.inject.Provider

@SysUISingleton
class SystemUIConfigDumpable
@Inject
constructor(
    dumpManager: DumpManager,
    private val context: Context,
    private val startables: MutableMap<Class<*>, Provider<CoreStartable>>,
) : Dumpable {
    init {
        dumpManager.registerCriticalDumpable("SystemUiServiceComponents", this)
    }

    override fun dump(pw: PrintWriter, args: Array<out String>) {
        pw.println("SystemUiServiceComponents configuration:")
        pw.print("vendor component: ")
        pw.println(context.resources.getString(R.string.config_systemUIVendorServiceComponent))
        val services: MutableList<String> =
            startables.keys.map { cls: Class<*> -> cls.simpleName }.toMutableList()

        services.add(context.resources.getString(R.string.config_systemUIVendorServiceComponent))
        dumpServiceList(pw, "global", services.toTypedArray())
        dumpServiceList(pw, "per-user", R.array.config_systemUIServiceComponentsPerUser)
    }

    private fun dumpServiceList(pw: PrintWriter, type: String, resId: Int) {
        val services: Array<String> = context.resources.getStringArray(resId)
        dumpServiceList(pw, type, services)
    }

    private fun dumpServiceList(pw: PrintWriter, type: String, services: Array<String>?) {
        pw.print(type)
        pw.print(": ")
        if (services == null) {
            pw.println("N/A")
            return
        }
        pw.print(services.size)
        pw.println(" services")
        for (i in services.indices) {
            pw.print("  ")
            pw.print(i)
            pw.print(": ")
            pw.println(services[i])
        }
    }
}
+9 −11
Original line number Diff line number Diff line
@@ -26,10 +26,6 @@ import com.android.systemui.log.table.TableLogBuffer
import com.android.systemui.util.mockito.any
import com.android.systemui.util.mockito.eq
import com.google.common.truth.Truth.assertThat
import java.io.FileDescriptor
import java.io.PrintWriter
import java.io.StringWriter
import javax.inject.Provider
import org.junit.Before
import org.junit.Test
import org.mockito.Mock
@@ -37,6 +33,10 @@ import org.mockito.Mockito.anyInt
import org.mockito.Mockito.never
import org.mockito.Mockito.verify
import org.mockito.MockitoAnnotations
import java.io.FileDescriptor
import java.io.PrintWriter
import java.io.StringWriter
import javax.inject.Provider

@SmallTest
class DumpHandlerTest : SysuiTestCase() {
@@ -79,14 +79,12 @@ class DumpHandlerTest : SysuiTestCase() {
    fun setUp() {
        MockitoAnnotations.initMocks(this)

        dumpHandler = DumpHandler(
            mContext,
        val config = SystemUIConfigDumpable(
                dumpManager,
            logBufferEulogizer,
            mutableMapOf(
                EmptyCoreStartable::class.java to Provider { EmptyCoreStartable() }
            ),
                mContext,
                mutableMapOf(EmptyCoreStartable::class.java to Provider { EmptyCoreStartable() }),
        )
        dumpHandler = DumpHandler(dumpManager, logBufferEulogizer, config)
    }

    @Test