ash/app_list/app_list_metrics.h - chromium/src.git - Git at Google

 // Copyright 2018 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.

 #ifndef ASH_APP_LIST_APP_LIST_METRICS_H_
 #define ASH_APP_LIST_APP_LIST_METRICS_H_

 #include "ash/ash_export.h"
 #include "ash/public/cpp/app_list/app_list_types.h"
 #include "base/time/time.h"
 #include "third_party/abseil-cpp/absl/types/optional.h"
 #include "ui/events/event.h"

 namespace ash {

 class SearchResult;

 // The UMA histogram that logs how the app list transitions from peeking to
 // fullscreen. Exposed in this header because it is recorded in multiple files.
 ASH_EXPORT extern const char kAppListPeekingToFullscreenHistogram[];

 // The different ways to create a new page in the apps grid. These values are
 // written to logs. New enum values can be added, but existing enums must never
 // be renumbered or deleted and reused.
 enum class AppListPageCreationType {
   kDraggingApp = 0,
   kMovingAppWithKeyboard = 1,
   kSyncOrInstall = 2,
   kMaxValue = kSyncOrInstall,
 };

 // These are used in histograms, do not remove/renumber entries. If you're
 // adding to this enum with the intention that it will be logged, update the
 // AppListZeroStateSearchResultUserActionType enum listing in
 // tools/metrics/histograms/enums.xml.
 enum class ZeroStateSearchResultUserActionType {
   kRemoveResult = 0,
   kAppendResult = 1,
   kMaxValue = kAppendResult,
 };

 // These are used in histograms, do not remove/renumber entries. If you're
 // adding to this enum with the intention that it will be logged, update the
 // AppListResultRemovalConfirmation enum listing in
 // tools/metrics/histograms/enums.xml.
 enum class SearchResultRemovalConfirmation {
   kRemovalConfirmed = 0,
   kRemovalCanceled = 1,
   kMaxValue = kRemovalCanceled,
 };

 // The different ways that the app list can transition from PEEKING to
 // FULLSCREEN_ALL_APPS. These values are written to logs.  New enum
 // values can be added, but existing enums must never be renumbered or deleted
 // and reused.
 enum AppListPeekingToFullscreenSource {
   kSwipe = 0,
   kExpandArrow = 1,
   kMousepadScroll = 2,
   kMousewheelScroll = 3,
   kMaxPeekingToFullscreen = 4,
 };

 // The different ways the app list can be shown. These values are written to
 // logs.  New enum values can be added, but existing enums must never be
 // renumbered or deleted and reused.
 enum AppListShowSource {
   kSearchKey = 0,
   kShelfButton = 1,
   kSwipeFromShelf = 2,
   kTabletMode = 3,
   kSearchKeyFullscreen = 4,
   kShelfButtonFullscreen = 5,
   kAssistantEntryPoint = 6,
   kScrollFromShelf = 7,
   kMaxValue = kScrollFromShelf,
 };

 // The two versions of folders. These values are written to logs.  New enum
 // values can be added, but existing enums must never be renumbered or deleted
 // and reused.
 enum AppListFolderOpened {
   kOldFolders = 0,
   kFullscreenAppListFolders = 1,
   kMaxFolderOpened = 2,
 };

 // The valid AppListState transitions. These values are written to logs.  New
 // enum values can be added, but existing enums must never be renumbered or
 // deleted and reused. If adding a state transition, add it to the switch
 // statement in AppListView::GetAppListStateTransitionSource.
 enum AppListStateTransitionSource {
   kFullscreenAllAppsToClosed = 0,
   kFullscreenAllAppsToFullscreenSearch = 1,
   kFullscreenAllAppsToPeeking = 2,
   kFullscreenSearchToClosed = 3,
   kFullscreenSearchToFullscreenAllApps = 4,
   kHalfToClosed = 5,
   KHalfToFullscreenSearch = 6,
   kHalfToPeeking = 7,
   kPeekingToClosed = 8,
   kPeekingToFullscreenAllApps = 9,
   kPeekingToHalf = 10,
   kMaxAppListStateTransition = 11,
 };

 // The different ways to change pages in the app list's app grid. These values
 // are written to logs.  New enum values can be added, but existing enums must
 // never be renumbered or deleted and reused.
 enum AppListPageSwitcherSource {
   kTouchPageIndicator = 0,
   kClickPageIndicator = 1,
   kSwipeAppGrid = 2,
   kFlingAppGrid = 3,
   kMouseWheelScroll = 4,
   kMousePadScroll = 5,
   kDragAppToBorder = 6,
   kMoveAppWithKeyboard = 7,
   kMouseDrag = 8,
   kMaxAppListPageSwitcherSource = 9,
 };

 // The different ways to move an app in app list's apps grid. These values are
 // written to logs. New enum values can be added, but existing enums must never
 // be renumbered or deleted and reused.
 enum AppListAppMovingType {
   kMoveByDragIntoFolder = 0,
   kMoveByDragOutOfFolder = 1,
   kMoveIntoAnotherFolder = 2,
   kReorderByDragInFolder = 3,
   kReorderByDragInTopLevel = 4,
   kReorderByKeyboardInFolder = 5,
   kReorderByKeyboardInTopLevel = 6,
   kMoveByKeyboardIntoFolder = 7,
   kMoveByKeyboardOutOfFolder = 8,
   kMaxAppListAppMovingType = 9,
 };

 // The presence of Drive QuickAccess search results when updating the zero-state
 // results list. These values are persisted to logs. Entries should not be
 // renumbered and numeric values should never be reused.
 enum class DriveQuickAccessResultPresence {
   kPresentAndShown = 0,
   kPresentAndNotShown = 1,
   kAbsent = 2,
   kMaxValue = kAbsent
 };

 // Different places a search result can be launched from. These values do not
 // persist to logs, so can be changed as-needed. However, changes should be
 // reflected in RecordSearchLaunchIndexAndQueryLength().
 enum SearchResultLaunchLocation {
   kResultList = 0,
   kTileList = 1,
 };

 // Different ways to trigger launcher animation in tablet mode.
 enum TabletModeAnimationTransition {
   // Release drag to show the launcher (launcher animates the rest of the way).
   kDragReleaseShow,

   // Release drag to hide the launcher (launcher animates the rest of the way).
   kDragReleaseHide,

   // Click the Home button in tablet mode.
   kHomeButtonShow,

   // Activate a window from shelf to hide the launcher in tablet mode.
   kHideHomeLauncherForWindow,

   // Enter the kFullscreenAllApps state (usually by deactivating the search box)
   kEnterFullscreenAllApps,

   // Enter the kFullscreenSearch state (usually by activating the search box).
   kEnterFullscreenSearch,

   // Enter the overview mode in tablet, with overview fading in instead of
   // sliding (as is the case with kEnterOverviewMode).
   kFadeInOverview,

   // Exit the overview mode in tablet, with overview fading out instead of
   // sliding (as is the case with kExitOverviewMode).
   kFadeOutOverview,
 };

 // Different actions that complete a user workflow within the launcher UI.
 // Used as bucket values in histograms that track completed user actions within
 // the launcher - do not remove/renumber existing items.
 enum class AppListUserAction {
   // User launched an app from the apps grid within the app list UI.
   kAppLaunchFromAppsGrid = 0,

   // User launched an app from list of recent apps within the app list UI.
   kAppLaunchFromRecentApps = 1,

   // User opened a non-app search result from the app list search results page.
   kOpenSearchResult = 2,

   // User opened an app search result from the app list search result page.
   kOpenAppSearchResult = 3,

   // User opened an item shown in continue section within the app list UI.
   kOpenContinueSectionTask = 4,

   // User opened a suggestion chip shown in the app list UI.
   kOpenSuggestionChip = 5,

   kMaxValue = kOpenSuggestionChip,
 };

 // Parameters to call RecordAppListAppLaunched. Passed to code that does not
 // directly have access to them, such ash AppListMenuModelAdapter.
 struct AppLaunchedMetricParams {
   AppLaunchedMetricParams();
   AppLaunchedMetricParams(AppListLaunchedFrom launched_from,
                           AppListLaunchType launch_type);
   AppLaunchedMetricParams(const AppLaunchedMetricParams&);
   AppLaunchedMetricParams& operator=(const AppLaunchedMetricParams&);
   ~AppLaunchedMetricParams();

   AppListLaunchedFrom launched_from = AppListLaunchedFrom::kLaunchedFromGrid;
   AppListLaunchType launch_type = AppListLaunchType::kSearchResult;
   AppListViewState app_list_view_state = AppListViewState::kClosed;
   bool is_tablet_mode = false;
   bool app_list_shown = false;
   absl::optional<base::TimeTicks> launcher_show_timestamp;
 };

 void AppListRecordPageSwitcherSourceByEventType(ui::EventType type,
                                                 bool is_tablet_mode);

 void RecordPageSwitcherSource(AppListPageSwitcherSource source,
                               bool is_tablet_mode);

 void RecordZeroStateSearchResultUserActionHistogram(
     ZeroStateSearchResultUserActionType action);

 void RecordZeroStateSearchResultRemovalHistogram(
     SearchResultRemovalConfirmation removal_decision);

 void RecordSearchResultRemovalDialogDecision(
     SearchResultRemovalConfirmation removal_decision);

 void RecordAppListUserJourneyTime(AppListShowSource source,
                                   base::TimeDelta time);

 void RecordPeriodicAppListMetrics();

 ASH_EXPORT void RecordSearchResultOpenSource(const SearchResult* result,
                                              AppListViewState state,
                                              bool is_tablet_mode);

 ASH_EXPORT void RecordSearchLaunchIndexAndQueryLength(
     SearchResultLaunchLocation launch_location,
     int query_length,
     int suggestion_index);

 ASH_EXPORT void RecordAppListAppLaunched(AppListLaunchedFrom launched_from,
                                          AppListViewState app_list_state,
                                          bool is_tablet_mode,
                                          bool app_list_shown);

 ASH_EXPORT void RecordLauncherWorkflowMetrics(
     AppListUserAction action,
     bool is_tablet_mode,
     absl::optional<base::TimeTicks> launcher_show_time);

 ASH_EXPORT bool IsCommandIdAnAppLaunch(int command_id);

 ASH_EXPORT void ReportPaginationSmoothness(bool is_tablet_mode, int smoothness);

 ASH_EXPORT void ReportCardifiedSmoothness(bool is_entering_cardified,
                                           int smoothness);

 }  // namespace ash

 #endif  // ASH_APP_LIST_APP_LIST_METRICS_H_
	// Copyright 2018 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.

	#ifndef ASH_APP_LIST_APP_LIST_METRICS_H_
	#define ASH_APP_LIST_APP_LIST_METRICS_H_

	#include "ash/ash_export.h"
	#include "ash/public/cpp/app_list/app_list_types.h"
	#include "base/time/time.h"
	#include "third_party/abseil-cpp/absl/types/optional.h"
	#include "ui/events/event.h"

	namespace ash {

	class SearchResult;

	// The UMA histogram that logs how the app list transitions from peeking to
	// fullscreen. Exposed in this header because it is recorded in multiple files.
	ASH_EXPORT extern const char kAppListPeekingToFullscreenHistogram[];

	// The different ways to create a new page in the apps grid. These values are
	// written to logs. New enum values can be added, but existing enums must never
	// be renumbered or deleted and reused.
	enum class AppListPageCreationType {
	kDraggingApp = 0,
	kMovingAppWithKeyboard = 1,
	kSyncOrInstall = 2,
	kMaxValue = kSyncOrInstall,
	};

	// These are used in histograms, do not remove/renumber entries. If you're
	// adding to this enum with the intention that it will be logged, update the
	// AppListZeroStateSearchResultUserActionType enum listing in
	// tools/metrics/histograms/enums.xml.
	enum class ZeroStateSearchResultUserActionType {
	kRemoveResult = 0,
	kAppendResult = 1,
	kMaxValue = kAppendResult,
	};

	// These are used in histograms, do not remove/renumber entries. If you're
	// adding to this enum with the intention that it will be logged, update the
	// AppListResultRemovalConfirmation enum listing in
	// tools/metrics/histograms/enums.xml.
	enum class SearchResultRemovalConfirmation {
	kRemovalConfirmed = 0,
	kRemovalCanceled = 1,
	kMaxValue = kRemovalCanceled,
	};

	// The different ways that the app list can transition from PEEKING to
	// FULLSCREEN_ALL_APPS. These values are written to logs. New enum
	// values can be added, but existing enums must never be renumbered or deleted
	// and reused.
	enum AppListPeekingToFullscreenSource {
	kSwipe = 0,
	kExpandArrow = 1,
	kMousepadScroll = 2,
	kMousewheelScroll = 3,
	kMaxPeekingToFullscreen = 4,
	};

	// The different ways the app list can be shown. These values are written to
	// logs. New enum values can be added, but existing enums must never be
	// renumbered or deleted and reused.
	enum AppListShowSource {
	kSearchKey = 0,
	kShelfButton = 1,
	kSwipeFromShelf = 2,
	kTabletMode = 3,
	kSearchKeyFullscreen = 4,
	kShelfButtonFullscreen = 5,
	kAssistantEntryPoint = 6,
	kScrollFromShelf = 7,
	kMaxValue = kScrollFromShelf,
	};

	// The two versions of folders. These values are written to logs. New enum
	// values can be added, but existing enums must never be renumbered or deleted
	// and reused.
	enum AppListFolderOpened {
	kOldFolders = 0,
	kFullscreenAppListFolders = 1,
	kMaxFolderOpened = 2,
	};

	// The valid AppListState transitions. These values are written to logs. New
	// enum values can be added, but existing enums must never be renumbered or
	// deleted and reused. If adding a state transition, add it to the switch
	// statement in AppListView::GetAppListStateTransitionSource.
	enum AppListStateTransitionSource {
	kFullscreenAllAppsToClosed = 0,
	kFullscreenAllAppsToFullscreenSearch = 1,
	kFullscreenAllAppsToPeeking = 2,
	kFullscreenSearchToClosed = 3,
	kFullscreenSearchToFullscreenAllApps = 4,
	kHalfToClosed = 5,
	KHalfToFullscreenSearch = 6,
	kHalfToPeeking = 7,
	kPeekingToClosed = 8,
	kPeekingToFullscreenAllApps = 9,
	kPeekingToHalf = 10,
	kMaxAppListStateTransition = 11,
	};

	// The different ways to change pages in the app list's app grid. These values
	// are written to logs. New enum values can be added, but existing enums must
	// never be renumbered or deleted and reused.
	enum AppListPageSwitcherSource {
	kTouchPageIndicator = 0,
	kClickPageIndicator = 1,
	kSwipeAppGrid = 2,
	kFlingAppGrid = 3,
	kMouseWheelScroll = 4,
	kMousePadScroll = 5,
	kDragAppToBorder = 6,
	kMoveAppWithKeyboard = 7,
	kMouseDrag = 8,
	kMaxAppListPageSwitcherSource = 9,
	};

	// The different ways to move an app in app list's apps grid. These values are
	// written to logs. New enum values can be added, but existing enums must never
	// be renumbered or deleted and reused.
	enum AppListAppMovingType {
	kMoveByDragIntoFolder = 0,
	kMoveByDragOutOfFolder = 1,
	kMoveIntoAnotherFolder = 2,
	kReorderByDragInFolder = 3,
	kReorderByDragInTopLevel = 4,
	kReorderByKeyboardInFolder = 5,
	kReorderByKeyboardInTopLevel = 6,
	kMoveByKeyboardIntoFolder = 7,
	kMoveByKeyboardOutOfFolder = 8,
	kMaxAppListAppMovingType = 9,
	};

	// The presence of Drive QuickAccess search results when updating the zero-state
	// results list. These values are persisted to logs. Entries should not be
	// renumbered and numeric values should never be reused.
	enum class DriveQuickAccessResultPresence {
	kPresentAndShown = 0,
	kPresentAndNotShown = 1,
	kAbsent = 2,
	kMaxValue = kAbsent
	};

	// Different places a search result can be launched from. These values do not
	// persist to logs, so can be changed as-needed. However, changes should be
	// reflected in RecordSearchLaunchIndexAndQueryLength().
	enum SearchResultLaunchLocation {
	kResultList = 0,
	kTileList = 1,
	};

	// Different ways to trigger launcher animation in tablet mode.
	enum TabletModeAnimationTransition {
	// Release drag to show the launcher (launcher animates the rest of the way).
	kDragReleaseShow,

	// Release drag to hide the launcher (launcher animates the rest of the way).
	kDragReleaseHide,

	// Click the Home button in tablet mode.
	kHomeButtonShow,

	// Activate a window from shelf to hide the launcher in tablet mode.
	kHideHomeLauncherForWindow,

	// Enter the kFullscreenAllApps state (usually by deactivating the search box)
	kEnterFullscreenAllApps,

	// Enter the kFullscreenSearch state (usually by activating the search box).
	kEnterFullscreenSearch,

	// Enter the overview mode in tablet, with overview fading in instead of
	// sliding (as is the case with kEnterOverviewMode).
	kFadeInOverview,

	// Exit the overview mode in tablet, with overview fading out instead of
	// sliding (as is the case with kExitOverviewMode).
	kFadeOutOverview,
	};

	// Different actions that complete a user workflow within the launcher UI.
	// Used as bucket values in histograms that track completed user actions within
	// the launcher - do not remove/renumber existing items.
	enum class AppListUserAction {
	// User launched an app from the apps grid within the app list UI.
	kAppLaunchFromAppsGrid = 0,

	// User launched an app from list of recent apps within the app list UI.
	kAppLaunchFromRecentApps = 1,

	// User opened a non-app search result from the app list search results page.
	kOpenSearchResult = 2,

	// User opened an app search result from the app list search result page.
	kOpenAppSearchResult = 3,

	// User opened an item shown in continue section within the app list UI.
	kOpenContinueSectionTask = 4,

	// User opened a suggestion chip shown in the app list UI.
	kOpenSuggestionChip = 5,

	kMaxValue = kOpenSuggestionChip,
	};

	// Parameters to call RecordAppListAppLaunched. Passed to code that does not
	// directly have access to them, such ash AppListMenuModelAdapter.
	struct AppLaunchedMetricParams {
	AppLaunchedMetricParams();
	AppLaunchedMetricParams(AppListLaunchedFrom launched_from,
	AppListLaunchType launch_type);
	AppLaunchedMetricParams(const AppLaunchedMetricParams&);
	AppLaunchedMetricParams& operator=(const AppLaunchedMetricParams&);
	~AppLaunchedMetricParams();

	AppListLaunchedFrom launched_from = AppListLaunchedFrom::kLaunchedFromGrid;
	AppListLaunchType launch_type = AppListLaunchType::kSearchResult;
	AppListViewState app_list_view_state = AppListViewState::kClosed;
	bool is_tablet_mode = false;
	bool app_list_shown = false;
	absl::optional<base::TimeTicks> launcher_show_timestamp;
	};

	void AppListRecordPageSwitcherSourceByEventType(ui::EventType type,
	bool is_tablet_mode);

	void RecordPageSwitcherSource(AppListPageSwitcherSource source,
	bool is_tablet_mode);

	void RecordZeroStateSearchResultUserActionHistogram(
	ZeroStateSearchResultUserActionType action);

	void RecordZeroStateSearchResultRemovalHistogram(
	SearchResultRemovalConfirmation removal_decision);

	void RecordSearchResultRemovalDialogDecision(
	SearchResultRemovalConfirmation removal_decision);

	void RecordAppListUserJourneyTime(AppListShowSource source,
	base::TimeDelta time);

	void RecordPeriodicAppListMetrics();

	ASH_EXPORT void RecordSearchResultOpenSource(const SearchResult* result,
	AppListViewState state,
	bool is_tablet_mode);

	ASH_EXPORT void RecordSearchLaunchIndexAndQueryLength(
	SearchResultLaunchLocation launch_location,
	int query_length,
	int suggestion_index);

	ASH_EXPORT void RecordAppListAppLaunched(AppListLaunchedFrom launched_from,
	AppListViewState app_list_state,
	bool is_tablet_mode,
	bool app_list_shown);

	ASH_EXPORT void RecordLauncherWorkflowMetrics(
	AppListUserAction action,
	bool is_tablet_mode,
	absl::optional<base::TimeTicks> launcher_show_time);

	ASH_EXPORT bool IsCommandIdAnAppLaunch(int command_id);

	ASH_EXPORT void ReportPaginationSmoothness(bool is_tablet_mode, int smoothness);

	ASH_EXPORT void ReportCardifiedSmoothness(bool is_entering_cardified,
	int smoothness);

	} // namespace ash

	#endif // ASH_APP_LIST_APP_LIST_METRICS_H_