shortcuts: Add metric to track side panel navigation

Bug: b/216049298 Test: ash_unittests, browser_tests Change-Id: Ifacadbaf8b579cfebfe0eb7e0836a2840695a8c8 Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/4937235 Reviewed-by: Emily Stark <estark@chromium.org> Commit-Queue: Jimmy Gong <jimmyxgong@chromium.org> Reviewed-by: David Padlipsky <dpad@google.com> Cr-Commit-Position: refs/heads/main@{#1212851}
chromium · Oct 20, 2023 · f413d4f · f413d4f
1 parent c680850
commit f413d4f
Show file tree

Hide file tree

Showing 11 changed files with 83 additions and 2 deletions.
diff --git a/ash/public/mojom/accelerator_info.mojom b/ash/public/mojom/accelerator_info.mojom
@@ -67,6 +67,7 @@ enum AcceleratorLayoutStyle {
 };
 
 // Enum of top-level accelerator categories. Used in the UI for categorization.
+// Must be kept in sync with enums.xml: `ShortcutCustomizationMainCategory`.
 enum AcceleratorCategory {
   kGeneral,
   kDevice,

diff --git a/ash/webui/shortcut_customization_ui/backend/accelerator_configuration_provider.cc b/ash/webui/shortcut_customization_ui/backend/accelerator_configuration_provider.cc
@@ -1176,6 +1176,12 @@ void AcceleratorConfigurationProvider::RecordUserAction(
   }
 }
 
+void AcceleratorConfigurationProvider::RecordMainCategoryNavigation(
+    mojom::AcceleratorCategory category) {
+  base::UmaHistogramEnumeration(
+      "Ash.ShortcutCustomization.MainCategoryNavigation", category);
+}
+
 void AcceleratorConfigurationProvider::BindInterface(
     mojo::PendingReceiver<
         shortcut_customization::mojom::AcceleratorConfigurationProvider>

diff --git a/ash/webui/shortcut_customization_ui/backend/accelerator_configuration_provider.h b/ash/webui/shortcut_customization_ui/backend/accelerator_configuration_provider.h
@@ -128,6 +128,8 @@ class AcceleratorConfigurationProvider
   void RestoreAllDefaults(RestoreAllDefaultsCallback callback) override;
   void RecordUserAction(
       shortcut_customization::mojom::UserAction user_action) override;
+  void RecordMainCategoryNavigation(
+      mojom::AcceleratorCategory category) override;
 
   // ui::InputDeviceEventObserver:
   void OnInputDeviceConfigurationChanged(uint8_t input_device_types) override;

diff --git a/ash/webui/shortcut_customization_ui/backend/accelerator_configuration_provider_unittest.cc b/ash/webui/shortcut_customization_ui/backend/accelerator_configuration_provider_unittest.cc
@@ -3171,6 +3171,26 @@ TEST_F(AcceleratorConfigurationProviderTest, UserActions) {
                    "ShortcutCustomization_SuccessfullyModified"));
 }
 
+TEST_F(AcceleratorConfigurationProviderTest, MainNavigationCategoryMetrics) {
+  histogram_tester_->ExpectBucketCount(
+      "Ash.ShortcutCustomization.MainCategoryNavigation",
+      mojom::AcceleratorCategory::kGeneral, 0);
+  histogram_tester_->ExpectBucketCount(
+      "Ash.ShortcutCustomization.MainCategoryNavigation",
+      mojom::AcceleratorCategory::kAccessibility, 0);
+
+  provider_->RecordMainCategoryNavigation(mojom::AcceleratorCategory::kGeneral);
+  provider_->RecordMainCategoryNavigation(
+      mojom::AcceleratorCategory::kAccessibility);
+
+  histogram_tester_->ExpectBucketCount(
+      "Ash.ShortcutCustomization.MainCategoryNavigation",
+      mojom::AcceleratorCategory::kGeneral, 1);
+  histogram_tester_->ExpectBucketCount(
+      "Ash.ShortcutCustomization.MainCategoryNavigation",
+      mojom::AcceleratorCategory::kAccessibility, 1);
+}
+
 TEST_F(AcceleratorConfigurationProviderTest,
        VerifyAllAcceleratorsHaveKeyString) {
   // The following is a set of VKEYs that are ignored in this test. If there is

diff --git a/ash/webui/shortcut_customization_ui/mojom/shortcut_customization.mojom b/ash/webui/shortcut_customization_ui/mojom/shortcut_customization.mojom
@@ -163,4 +163,7 @@ interface AcceleratorConfigurationProvider {
 
   // Records the specific user action histogram.
   RecordUserAction(UserAction user_action);
+
+  // Records the side panel category the user navigates to.
+  RecordMainCategoryNavigation(ash.mojom.AcceleratorCategory category);
 };
diff --git a/ash/webui/shortcut_customization_ui/resources/js/fake_shortcut_provider.ts b/ash/webui/shortcut_customization_ui/resources/js/fake_shortcut_provider.ts
@@ -8,7 +8,7 @@ import {assert} from 'chrome://resources/js/assert.js';
 
 import {AcceleratorResultData, AcceleratorsUpdatedObserverRemote, PolicyUpdatedObserverRemote, UserAction} from '../mojom-webui/ash/webui/shortcut_customization_ui/mojom/shortcut_customization.mojom-webui.js';
 
-import {Accelerator, AcceleratorConfigResult, AcceleratorSource, MojoAcceleratorConfig, MojoLayoutInfo, ShortcutProviderInterface} from './shortcut_types.js';
+import {Accelerator, AcceleratorCategory, AcceleratorConfigResult, AcceleratorSource, MojoAcceleratorConfig, MojoLayoutInfo, ShortcutProviderInterface} from './shortcut_types.js';
 
 
 /**
@@ -34,6 +34,7 @@ export class FakeShortcutProvider implements ShortcutProviderInterface {
   private addAcceleratorCallCount: number = 0;
   private removeAcceleratorCallCount: number = 0;
   private lastRecordedUserAction: UserAction;
+  private lastRecordedMainCategory: AcceleratorCategory;
 
   constructor() {
     this.methods = new FakeMethodResolver();
@@ -55,6 +56,7 @@ export class FakeShortcutProvider implements ShortcutProviderInterface {
     this.methods.register('getConflictAccelerator');
     this.methods.register('getDefaultAcceleratorsForId');
     this.methods.register('recordUserAction');
+    this.methods.register('recordMainCategoryNavigation');
     this.registerObservables();
   }
 
@@ -179,6 +181,14 @@ export class FakeShortcutProvider implements ShortcutProviderInterface {
     return this.lastRecordedUserAction;
   }
 
+  recordMainCategoryNavigation(category: AcceleratorCategory): void {
+    this.lastRecordedMainCategory = category;
+  }
+
+  getLatestMainCategoryNavigated(): AcceleratorCategory {
+    return this.lastRecordedMainCategory;
+  }
+
   preventProcessingAccelerators(_preventProcessingAccelerators: boolean):
       Promise<void> {
     ++this.preventProcessingAcceleratorsCallCount;

diff --git a/ash/webui/shortcut_customization_ui/resources/js/mojo_interface_provider.ts b/ash/webui/shortcut_customization_ui/resources/js/mojo_interface_provider.ts
@@ -8,7 +8,7 @@ import {AcceleratorConfigurationProvider, AcceleratorConfigurationProviderRemote
 
 import {fakeAcceleratorConfig, fakeLayoutInfo} from './fake_data.js';
 import {FakeShortcutProvider} from './fake_shortcut_provider.js';
-import {Accelerator, AcceleratorSource, MojoAcceleratorConfig, MojoLayoutInfo, ShortcutProviderInterface} from './shortcut_types.js';
+import {Accelerator, AcceleratorCategory, AcceleratorSource, MojoAcceleratorConfig, MojoLayoutInfo, ShortcutProviderInterface} from './shortcut_types.js';
 
 /**
  * @fileoverview
@@ -145,6 +145,10 @@ export class ShortcutProviderWrapper implements ShortcutProviderInterface {
   recordUserAction(userAction: UserAction): void {
     this.remote.recordUserAction(userAction);
   }
+
+  recordMainCategoryNavigation(category: AcceleratorCategory): void {
+    this.remote.recordMainCategoryNavigation(category);
+  }
 }
 
 export function getShortcutProvider(): ShortcutProviderInterface {

diff --git a/ash/webui/shortcut_customization_ui/resources/js/shortcuts_page.ts b/ash/webui/shortcut_customization_ui/resources/js/shortcuts_page.ts
@@ -13,6 +13,7 @@ import {afterNextRender, microTask, PolymerElement} from 'chrome://resources/pol
 import {AcceleratorLookupManager} from './accelerator_lookup_manager.js';
 import {AcceleratorRowElement} from './accelerator_row.js';
 import {AcceleratorSubsectionElement} from './accelerator_subsection.js';
+import {getShortcutProvider} from './mojo_interface_provider.js';
 import {RouteObserver, Router} from './router.js';
 import {AcceleratorCategory, AcceleratorSubcategory} from './shortcut_types';
 import {getTemplate} from './shortcuts_page.html.js';
@@ -108,6 +109,10 @@ export class ShortcutsPageElement extends PolymerElement implements
   onNavigationPageChanged({isActive}: {isActive: boolean}): void {
     if (isActive) {
       afterNextRender(this, () => {
+        if (this.initialData) {
+          getShortcutProvider().recordMainCategoryNavigation(
+              this.initialData.category);
+        }
         // Dispatch a custom event to inform the parent to scroll to the top
         // after active page changes.
         this.dispatchEvent(new CustomEvent('scroll-to-top', {

diff --git a/chrome/test/data/webui/chromeos/shortcut_customization/shortcut_customization_test.ts b/chrome/test/data/webui/chromeos/shortcut_customization/shortcut_customization_test.ts
@@ -269,6 +269,8 @@ suite('shortcutCustomizationAppTest', function() {
     page = initShortcutCustomizationAppElement();
     await flushTasks();
 
+    assertEquals(undefined, provider.getLatestMainCategoryNavigated());
+
     const navPanel =
         getPage().shadowRoot!.querySelector('navigation-view-panel');
     const navSelector =
@@ -281,6 +283,10 @@ suite('shortcutCustomizationAppTest', function() {
 
     await flushTasks();
 
+    assertEquals(
+        AcceleratorCategory.kBrowser,
+        provider.getLatestMainCategoryNavigated());
+
     const actualSubsections = getSubsections(AcceleratorCategory.kBrowser);
     const expectedLayouts =
         getManager().getSubcategories(AcceleratorCategory.kBrowser);

diff --git a/tools/metrics/histograms/enums.xml b/tools/metrics/histograms/enums.xml
@@ -100057,6 +100057,20 @@ https://www.dmtf.org/sites/default/files/standards/documents/DSP0134_2.7.1.pdf
   <int value="4" label="ResetAll"/>
 </enum>
 
+<enum name="ShortcutCustomizationMainCategory">
+  <summary>
+    The categories that are present within the Key Shortcuts app.
+  </summary>
+  <int value="0" label="General"/>
+  <int value="1" label="Device"/>
+  <int value="2" label="Browser"/>
+  <int value="3" label="Text"/>
+  <int value="4" label="WindowsAndDesks"/>
+  <int value="5" label="Accessibility"/>
+  <int value="6" label="Debug"/>
+  <int value="7" label="Developer"/>
+</enum>
+
 <enum name="ShortcutsCreationResult">
   <summary>Result of creating shortcuts for PWA.</summary>
   <int value="0" label="Success"/>

diff --git a/tools/metrics/histograms/metadata/ash/histograms.xml b/tools/metrics/histograms/metadata/ash/histograms.xml
@@ -6294,6 +6294,16 @@ chromium-metrics-reviews@google.com.
   </summary>
 </histogram>
 
+<histogram name="Ash.ShortcutCustomization.MainCategoryNavigation"
+    enum="ShortcutCustomizationMainCategory" expires_after="2024-08-17">
+  <owner>jimmyxgong@chromium.org</owner>
+  <owner>cros-peripherals@google.com</owner>
+  <summary>
+    Tracks the number of times a user navigates to a main category in the side
+    panel of the Key Shortcuts app.
+  </summary>
+</histogram>
+
 <histogram
     name="Ash.ShortcutCustomization.RemoveDefaultAccelerator.{ActionName}"
     units="Shortcuts" expires_after="2024-08-17">