chrome/android/java/src/org/chromium/chrome/browser/widget/bottomsheet/BottomSheetMetrics.java

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

package org.chromium.chrome.browser.widget.bottomsheet;

import android.support.annotation.IntDef;

import org.chromium.base.metrics.CachedMetrics;
import org.chromium.base.metrics.RecordUserAction;
import org.chromium.chrome.browser.widget.bottomsheet.BottomSheet.BottomSheetContent;
import org.chromium.chrome.browser.widget.bottomsheet.BottomSheet.StateChangeReason;

import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.util.concurrent.TimeUnit;

/**
 * Records user actions and histograms related to the {@link BottomSheet}.
 */
public class BottomSheetMetrics extends EmptyBottomSheetObserver {
    /**
     * The different ways that the bottom sheet can be opened. This is used to back a UMA
     * histogram and should therefore be treated as append-only.
     */
    @IntDef({SheetOpenReason.OPENED_BY_SWIPE})
    @Retention(RetentionPolicy.SOURCE)
    private @interface SheetOpenReason {
        int OPENED_BY_SWIPE = 0;
        // Obsolete: int OPENED_BY_OMNIBOX_FOCUS = 1;
        // Obsolete: int OPENED_BY_NEW_TAB_CREATION = 2;
        // Obsolete: int OPENED_BY_EXPAND_BUTTON = 3;
        // Obsolete: int OPENED_BY_STARTUP = 4;
        int NUM_ENTRIES = 5;
    }

    private static final CachedMetrics.TimesHistogramSample TIMES_FIRST_OPEN =
            new CachedMetrics.TimesHistogramSample(
                    "Android.ChromeHome.TimeToFirstOpen", TimeUnit.MILLISECONDS);

    private static final CachedMetrics.TimesHistogramSample TIMES_BETWEEN_CLOSE_AND_NEXT_OPEN =
            new CachedMetrics.TimesHistogramSample(
                    "Android.ChromeHome.TimeBetweenCloseAndNextOpen", TimeUnit.MILLISECONDS);

    private static final CachedMetrics.TimesHistogramSample TIMES_DURATION_OPEN =
            new CachedMetrics.TimesHistogramSample(
                    "Android.ChromeHome.DurationOpen", TimeUnit.MILLISECONDS);

    private static final CachedMetrics.EnumeratedHistogramSample ENUMERATED_OPEN_REASON =
            new CachedMetrics.EnumeratedHistogramSample(
                    "Android.ChromeHome.OpenReason", SheetOpenReason.NUM_ENTRIES);

    private static final CachedMetrics.ActionEvent ACTION_HALF_STATE =
            new CachedMetrics.ActionEvent("Android.ChromeHome.HalfState");
    private static final CachedMetrics.ActionEvent ACTION_FULL_STATE =
            new CachedMetrics.ActionEvent("Android.ChromeHome.FullState");

    private static final CachedMetrics.ActionEvent ACTION_OPENED_BY_SWIPE =
            new CachedMetrics.ActionEvent("Android.ChromeHome.OpenedBySwipe");

    private static final CachedMetrics.ActionEvent ACTION_CLOSED_BY_SWIPE =
            new CachedMetrics.ActionEvent("Android.ChromeHome.ClosedBySwipe");
    private static final CachedMetrics.ActionEvent ACTION_CLOSED_BY_BACK_PRESS =
            new CachedMetrics.ActionEvent("Android.ChromeHome.ClosedByBackPress");
    private static final CachedMetrics.ActionEvent ACTION_CLOSED_BY_TAP_SCRIM =
            new CachedMetrics.ActionEvent("Android.ChromeHome.ClosedByTapScrim");
    private static final CachedMetrics.ActionEvent ACTION_CLOSED_BY_NAVIGATION =
            new CachedMetrics.ActionEvent("Android.ChromeHome.ClosedByNavigation");
    private static final CachedMetrics.ActionEvent ACTION_CLOSED =
            new CachedMetrics.ActionEvent("Android.ChromeHome.Closed");

    /** Whether the sheet is currently open. */
    private boolean mIsSheetOpen;

    /** The last {@link BottomSheetContent} that was displayed. */
    private BottomSheetContent mLastContent;

    /** When this class was created. Used as a proxy for when the app was started. */
    private long mCreationTime;

    /** The last time the sheet was opened. */
    private long mLastOpenTime;

    /** The last time the sheet was closed. */
    private long mLastCloseTime;

    public BottomSheetMetrics() {
        mCreationTime = System.currentTimeMillis();
    }

    @Override
    public void onSheetOpened(int reason) {
        mIsSheetOpen = true;

        boolean isFirstOpen = mLastOpenTime == 0;
        mLastOpenTime = System.currentTimeMillis();

        if (isFirstOpen) {
            TIMES_FIRST_OPEN.record(mLastOpenTime - mCreationTime);
        } else {
            TIMES_BETWEEN_CLOSE_AND_NEXT_OPEN.record(mLastOpenTime - mLastCloseTime);
        }

        recordSheetOpenReason(reason);
    }

    @Override
    public void onSheetClosed(@StateChangeReason int reason) {
        mIsSheetOpen = false;

        recordSheetCloseReason(reason);

        mLastCloseTime = System.currentTimeMillis();
        TIMES_DURATION_OPEN.record(mLastCloseTime - mLastOpenTime);
    }

    @Override
    public void onSheetStateChanged(int newState) {
        if (newState == BottomSheet.SheetState.HALF) {
            ACTION_HALF_STATE.record();
        } else if (newState == BottomSheet.SheetState.FULL) {
            ACTION_FULL_STATE.record();
        }
    }

    /**
     * Records the reason the sheet was opened.
     * @param reason The {@link StateChangeReason} that caused the bottom sheet to open.
     */
    public void recordSheetOpenReason(@StateChangeReason int reason) {
        @SheetOpenReason
        int metricsReason = SheetOpenReason.OPENED_BY_SWIPE;
        switch (reason) {
            case StateChangeReason.SWIPE:
                metricsReason = SheetOpenReason.OPENED_BY_SWIPE;
                ACTION_OPENED_BY_SWIPE.record();
                break;
            case StateChangeReason.NONE:
                // Intentionally empty.
                break;
            default:
                assert false;
        }

        ENUMERATED_OPEN_REASON.record(metricsReason);
    }

    /**
     * Records the reason the sheet was closed.
     * @param reason The {@link StateChangeReason} that cause the bottom sheet to close.
     */
    private void recordSheetCloseReason(@StateChangeReason int reason) {
        switch (reason) {
            case StateChangeReason.SWIPE:
                ACTION_CLOSED_BY_SWIPE.record();
                break;
            case StateChangeReason.BACK_PRESS:
                ACTION_CLOSED_BY_BACK_PRESS.record();
                break;
            case StateChangeReason.TAP_SCRIM:
                ACTION_CLOSED_BY_TAP_SCRIM.record();
                break;
            case StateChangeReason.NAVIGATION:
                ACTION_CLOSED_BY_NAVIGATION.record();
                break;
            case StateChangeReason.NONE:
                ACTION_CLOSED.record();
                break;
            default:
                assert false;
        }
    }

    /**
     * Records that a user navigation instructed the NativePageFactory to create a native page for
     * the NTP. This may occur if the user has NTP URLs in a tab's navigation history.
     */
    public void recordNativeNewTabPageShown() {
        RecordUserAction.record("Android.ChromeHome.NativeNTPShown");
    }

    /**
     * Records that the user tapped the app menu item that triggers the in-product help bubble.
     */
    public void recordInProductHelpMenuItemClicked() {
        RecordUserAction.record("Android.ChromeHome.IPHMenuItemClicked");
    }
}