android-34/org/chromium/base/jank_tracker/JankTrackerImpl.java

// Copyright 2021 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

package org.chromium.base.jank_tracker;

import android.app.Activity;
import android.os.Build;

/**
 * Class for recording janky frame metrics for a specific Activity.
 *
 * It should be constructed when the activity is created, recording starts and stops automatically
 * based on activity state. When the activity is being destroyed {@link #destroy()} should be called
 * to clear the activity state observer. All methods should be called from the UI thread.
 */
public class JankTrackerImpl implements JankTracker {
    private static final boolean IS_TRACKING_ENABLED =
            Build.VERSION.SDK_INT >= Build.VERSION_CODES.N;

    private final JankActivityTracker mActivityTracker;
    private final JankReportingScheduler mReportingScheduler;

    /**
     * Creates a new JankTracker instance tracking UI rendering of an activity. Metric recording
     * starts when the activity starts, and it's paused when the activity stops.
     */
    public JankTrackerImpl(Activity activity) {
        if (!IS_TRACKING_ENABLED) {
            mActivityTracker = null;
            mReportingScheduler = null;
            return;
        }

        FrameMetricsStore metricsStore = new FrameMetricsStore();
        FrameMetricsListener metricsListener = new FrameMetricsListener(metricsStore);
        mReportingScheduler = new JankReportingScheduler(metricsStore);
        mActivityTracker = new JankActivityTracker(activity, metricsListener, mReportingScheduler);
        mActivityTracker.initialize();
    }

    @Override
    public void startTrackingScenario(@JankScenario int scenario) {
        if (!IS_TRACKING_ENABLED) return;

        mReportingScheduler.startTrackingScenario(scenario);
    }

    @Override
    public void finishTrackingScenario(@JankScenario int scenario) {
        if (!IS_TRACKING_ENABLED) return;

        mReportingScheduler.finishTrackingScenario(scenario);
    }

    /**
     * Stops listening for Activity state changes.
     */
    public void destroy() {
        if (!IS_TRACKING_ENABLED) return;

        mActivityTracker.destroy();
    }
}