libraries/flicker/src/android/tools/common/traces/events/CujEvent.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.common.traces.events

import android.tools.common.CrossPlatform
import android.tools.common.Timestamp

/**
 * Represents a CUJ Event from the [EventLog]
 *
 * {@inheritDoc}
 */
class CujEvent(
    timestamp: Timestamp,
    val cuj: CujType,
    processId: Int,
    uid: String,
    threadId: Int,
    tag: String
) : Event(timestamp, processId, uid, threadId, tag) {

    val type: Type =
        when (tag) {
            JANK_CUJ_BEGIN_TAG -> Type.START
            JANK_CUJ_END_TAG -> Type.END
            JANK_CUJ_CANCEL_TAG -> Type.CANCEL
            else -> error("Unhandled tag type")
        }

    constructor(
        timestamp: Timestamp,
        processId: Int,
        uid: String,
        threadId: Int,
        tag: String,
        data: String
    ) : this(
        CrossPlatform.timestamp.from(
            elapsedNanos = getElapsedTimestampFromData(data),
            systemUptimeNanos = getSystemUptimeNanosFromData(data),
            unixNanos = timestamp.unixNanos
        ),
        getCujMarkerFromData(data),
        processId,
        uid,
        threadId,
        tag
    )

    override fun toString(): String {
        return "CujEvent(" +
            "timestamp=$timestamp, " +
            "cuj=$cuj, " +
            "processId=$processId, " +
            "uid=$uid, " +
            "threadId=$threadId, " +
            "tag=$tag" +
            ")"
    }

    companion object {
        private fun getCujMarkerFromData(data: String): CujType {
            val dataEntries = getDataEntries(data)
            val eventId = dataEntries[0].toInt()
            return CujType.from(eventId)
        }

        private fun getElapsedTimestampFromData(data: String): Long {
            val dataEntries = getDataEntries(data)
            return dataEntries[1].toLong()
        }

        private fun getSystemUptimeNanosFromData(data: String): Long {
            val dataEntries = getDataEntries(data)
            return dataEntries[2].toLong()
        }

        private fun getDataEntries(data: String): List<String> {
            require("""\[\d+,\d+,\d+]""".toRegex().matches(data)) {
                "Data ($data) didn't match expected format"
            }

            return data.slice(1..data.length - 2).split(",")
        }

        enum class Type {
            START,
            END,
            CANCEL
        }

        const val JANK_CUJ_BEGIN_TAG = "jank_cuj_events_begin_request"
        const val JANK_CUJ_END_TAG = "jank_cuj_events_end_request"
        const val JANK_CUJ_CANCEL_TAG = "jank_cuj_events_cancel_request"
    }
}