libraries/flicker/src/android/tools/device/flicker/FlickerServiceTracesCollector.kt

/*
 * 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 android.tools.device.flicker

import android.tools.common.FLICKER_TAG
import android.tools.common.Logger
import android.tools.common.Scenario
import android.tools.common.flicker.TracesCollector
import android.tools.common.io.Reader
import android.tools.device.traces.SERVICE_TRACE_CONFIG
import android.tools.device.traces.io.ResultReaderWithLru
import android.tools.device.traces.io.ResultWriter
import android.tools.device.traces.monitors.events.EventLogMonitor
import android.tools.device.traces.monitors.surfaceflinger.LayersTraceMonitor
import android.tools.device.traces.monitors.surfaceflinger.TransactionsTraceMonitor
import android.tools.device.traces.monitors.wm.ShellTransitionTraceMonitor
import android.tools.device.traces.monitors.wm.WindowManagerTraceMonitor
import android.tools.device.traces.monitors.wm.WmTransitionTraceMonitor
import java.io.File
import kotlin.io.path.createTempDirectory

class FlickerServiceTracesCollector(
    private val outputDir: File = createTempDirectory().toFile(),
) : TracesCollector {
    private var scenario: Scenario? = null

    private val traceMonitors =
        listOf(
            WindowManagerTraceMonitor(),
            LayersTraceMonitor(),
            WmTransitionTraceMonitor(),
            ShellTransitionTraceMonitor(),
            TransactionsTraceMonitor(),
            EventLogMonitor()
        )

    override fun start(scenario: Scenario) {
        reportErrorsBlock("Failed to start traces") {
            require(this.scenario == null) { "Trace still running" }
            traceMonitors.forEach { it.start() }
            this.scenario = scenario
        }
    }

    override fun stop(): Reader {
        return reportErrorsBlock("Failed to stop traces") {
            val scenario = this.scenario
            require(scenario != null) { "Scenario not set - make sure trace was started properly" }

            Logger.v(LOG_TAG, "Creating output directory for trace files")
            outputDir.mkdirs()

            Logger.v(LOG_TAG, "Stopping trace monitors")
            val writer = ResultWriter().forScenario(scenario).withOutputDir(outputDir)
            traceMonitors.forEach { it.stop(writer) }
            this.scenario = null
            val result = writer.write()

            ResultReaderWithLru(result, SERVICE_TRACE_CONFIG)
        }
    }

    override fun cleanup() {
        if (outputDir.exists()) {
            outputDir.deleteRecursively()
        }
    }

    private fun <T : Any> reportErrorsBlock(msg: String, block: () -> T): T {
        try {
            return block()
        } catch (e: Throwable) {
            Logger.e(LOG_TAG, msg, e)
            throw e
        }
    }

    companion object {
        private const val LOG_TAG = "$FLICKER_TAG-Collector"
    }
}