Add dictation to SwitchAccess context menu

Bug: 864796
Cq-Include-Trybots: luci.chromium.try:closure_compilation
Change-Id: Ie299534b069a83dc38012468f547810f7b83b0b0
Reviewed-on: https://chromium-review.googlesource.com/c/1227501Reviewed-by: Dominick Ng <dominickn@chromium.org>
Reviewed-by: Istiaque Ahmed <lazyboy@chromium.org>
Reviewed-by: James Cook <jamescook@chromium.org>
Reviewed-by: David Tseng <dtseng@chromium.org>
Commit-Queue: Zach Helfinstein <zhelfins@chromium.org>
Cr-Commit-Position: refs/heads/master@{#596340}

ash/accelerators/accelerator_controller.cc

@@ -31,6 +31,7 @@
 #include "ash/new_window_controller.h"
 #include "ash/public/cpp/app_list/app_list_constants.h"
 #include "ash/public/cpp/ash_features.h"
+#include "ash/public/interfaces/accessibility_controller.mojom.h"
 #include "ash/resources/vector_icons/vector_icons.h"
 #include "ash/root_window_controller.h"
 #include "ash/rotator/window_rotation.h"
@@ -812,9 +813,8 @@ bool CanHandleToggleDictation() {
 
 void HandleToggleDictation() {
   base::RecordAction(UserMetricsAction("Accel_Toggle_Dictation"));
-  UserMetricsRecorder::RecordUserToggleDictation(
-      DictationToggleMethod::kToggleByKeyboard);
-  Shell::Get()->accessibility_controller()->ToggleDictation();
+  Shell::Get()->accessibility_controller()->ToggleDictationFromSource(
+      mojom::DictationToggleSource::kKeyboard);
 }
 
 bool CanHandleToggleDockedMagnifier() {

ash/accessibility/accessibility_controller.cc

@@ -27,6 +27,7 @@
 #include "ash/system/power/scoped_backlights_forced_off.h"
 #include "ash/wm/tablet_mode/tablet_mode_controller.h"
 #include "base/command_line.h"
+#include "base/metrics/user_metrics.h"
 #include "base/strings/string16.h"
 #include "chromeos/audio/cras_audio_handler.h"
 #include "components/pref_registry/pref_registry_syncable.h"
@@ -648,6 +649,14 @@ void AccessibilityController::ToggleDictation() {
   }
 }
 
+void AccessibilityController::ToggleDictationFromSource(
+    mojom::DictationToggleSource source) {
+  base::RecordAction(base::UserMetricsAction("Accel_Toggle_Dictation"));
+  UserMetricsRecorder::RecordUserToggleDictation(source);
+
+  ToggleDictation();
+}
+
 void AccessibilityController::SilenceSpokenFeedback() {
   if (client_)
     client_->SilenceSpokenFeedback();

ash/accessibility/accessibility_controller.h

@@ -167,6 +167,7 @@ class ASH_EXPORT AccessibilityController
   void SetSelectToSpeakState(mojom::SelectToSpeakState state) override;
   void SetSelectToSpeakEventHandlerDelegate(
       mojom::SelectToSpeakEventHandlerDelegatePtr delegate) override;
+  void ToggleDictationFromSource(mojom::DictationToggleSource source) override;
 
   // SessionObserver:
   void OnSigninScreenPrefServiceInitialized(PrefService* prefs) override;

ash/metrics/user_metrics_recorder.cc

@@ -13,6 +13,7 @@
 #include "ash/public/cpp/shelf_item.h"
 #include "ash/public/cpp/shelf_model.h"
 #include "ash/public/cpp/shell_window_ids.h"
+#include "ash/public/interfaces/accessibility_controller.mojom-shared.h"
 #include "ash/public/interfaces/window_state_type.mojom.h"
 #include "ash/session/session_controller.h"
 #include "ash/shelf/shelf.h"
@@ -200,9 +201,9 @@ void UserMetricsRecorder::RecordUserClickOnShelfButton(
 
 // static
 void UserMetricsRecorder::RecordUserToggleDictation(
-    DictationToggleMethod method) {
+    mojom::DictationToggleSource source) {
   UMA_HISTOGRAM_ENUMERATION("Accessibility.CrosDictation.ToggleDictationMethod",
-                            method);
+                            source);
 }
 
 void UserMetricsRecorder::RecordUserMetricsAction(UserMetricsAction action) {

ash/metrics/user_metrics_recorder.h

@@ -16,19 +16,14 @@
 
 namespace ash {
 
+namespace mojom {
+enum class DictationToggleSource;
+}  // namespace mojom
+
 class DemoSessionMetricsRecorder;
 class DesktopTaskSwitchMetricRecorder;
 class PointerMetricsRecorder;
 
-// CrosDictationStartDictationMethod enum values.
-// These values are persisted to logs and should not be renumbered or re-used.
-// See tools/metrics/histograms/enums.xml.
-enum class DictationToggleMethod {
-  kToggleByKeyboard,
-  kToggleByButton,
-  kMaxValue = kToggleByButton
-};
-
 // User Metrics Recorder provides a repeating callback (RecordPeriodicMetrics)
 // on a timer to allow recording of state data over time to the UMA records.
 // Any additional states (in ash) that require monitoring can be added to
@@ -51,7 +46,7 @@ class ASH_EXPORT UserMetricsRecorder {
       LoginMetricsRecorder::ShelfButtonClickTarget target);
 
   // Record the method used to activate dictation.
-  static void RecordUserToggleDictation(DictationToggleMethod method);
+  static void RecordUserToggleDictation(mojom::DictationToggleSource source);
 
   // Records an Ash owned user action.
   void RecordUserMetricsAction(UserMetricsAction action);

ash/public/interfaces/accessibility_controller.mojom

@@ -48,6 +48,22 @@ enum AccessibilityPanelState {
   FULLSCREEN
 };
 
+// These values are persisted to logs and should not be renumbered or re-used.
+// See tools/metrics/histograms/enums.xml.
+enum DictationToggleSource {
+  // Toggled by the keyboard command (Search + D).
+  kKeyboard,
+
+  // Toggled by the dictation button in the tray.
+  kButton,
+
+  // Switch Access context menu button.
+  kSwitchAccess,
+
+  // Chromevox chrome extension.
+  kChromevox
+};
+
 enum SelectToSpeakState {
   // Select to Speak is not actively selecting text or speaking.
   kSelectToSpeakStateInactive,
@@ -111,6 +127,9 @@ interface AccessibilityController {
   // Set the delegate used by the Select-to-Speak event handler.
   SetSelectToSpeakEventHandlerDelegate(
       SelectToSpeakEventHandlerDelegate delegate);
+
+  // Starts or stops dictation. Records metrics for toggling via SwitchAccess.
+  ToggleDictationFromSource(DictationToggleSource source);
 };
 
 // Interface for ash to request accessibility service from its client (e.g.

ash/system/accessibility/dictation_button_tray.cc

@@ -6,6 +6,7 @@
 
 #include "ash/accessibility/accessibility_controller.h"
 #include "ash/metrics/user_metrics_recorder.h"
+#include "ash/public/interfaces/accessibility_controller.mojom.h"
 #include "ash/resources/vector_icons/vector_icons.h"
 #include "ash/shelf/shelf_constants.h"
 #include "ash/shell.h"
@@ -46,11 +47,9 @@ DictationButtonTray::~DictationButtonTray() {
 }
 
 bool DictationButtonTray::PerformAction(const ui::Event& event) {
-  UserMetricsRecorder::RecordUserToggleDictation(
-      DictationToggleMethod::kToggleByButton);
+  Shell::Get()->accessibility_controller()->ToggleDictationFromSource(
+      mojom::DictationToggleSource::kButton);
 
-  Shell::Get()->accelerator_controller()->PerformActionIfEnabled(
-      AcceleratorAction::TOGGLE_DICTATION);
   CheckDictationStatusAndUpdateIcon();
   return true;
 }

chrome/browser/accessibility/accessibility_extension_api.cc

@@ -35,6 +35,7 @@
 #include "ui/events/keycodes/keyboard_codes.h"
 
 #if defined(OS_CHROMEOS)
+#include "ash/public/interfaces/accessibility_controller.mojom.h"
 #include "ash/public/interfaces/accessibility_focus_ring_controller.mojom.h"
 #include "ash/public/interfaces/constants.mojom.h"
 #include "ash/public/interfaces/event_rewriter_controller.mojom.h"
@@ -53,6 +54,17 @@ namespace {
 
 const char kErrorNotSupported[] = "This API is not supported on this platform.";
 
+#if defined(OS_CHROMEOS)
+ash::mojom::AccessibilityControllerPtr GetAccessibilityController() {
+  // Connect to the accessibility mojo interface in ash.
+  ash::mojom::AccessibilityControllerPtr accessibility_controller;
+  content::ServiceManagerConnection::GetForProcess()
+      ->GetConnector()
+      ->BindInterface(ash::mojom::kServiceName, &accessibility_controller);
+  return accessibility_controller;
+}
+#endif
+
 }  // namespace
 
 ExtensionFunction::ResponseAction
@@ -302,4 +314,20 @@ AccessibilityPrivateOnSelectToSpeakStateChangedFunction::Run() {
   return RespondNow(NoArguments());
 }
 
+ExtensionFunction::ResponseAction
+AccessibilityPrivateToggleDictationFunction::Run() {
+  ash::mojom::DictationToggleSource source =
+      ash::mojom::DictationToggleSource::kChromevox;
+  if (extension()->id() == extension_misc::kSwitchAccessExtensionId)
+    source = ash::mojom::DictationToggleSource::kSwitchAccess;
+  else if (extension()->id() == extension_misc::kChromeVoxExtensionId)
+    source = ash::mojom::DictationToggleSource::kChromevox;
+  else
+    NOTREACHED();
+
+  GetAccessibilityController()->ToggleDictationFromSource(source);
+
+  return RespondNow(NoArguments());
+}
+
 #endif  // defined (OS_CHROMEOS)

chrome/browser/accessibility/accessibility_extension_api.h

@@ -97,6 +97,17 @@ class AccessibilityPrivateOnSelectToSpeakStateChangedFunction
   DECLARE_EXTENSION_FUNCTION("accessibilityPrivate.onSelectToSpeakStateChanged",
                              ACCESSIBILITY_PRIVATE_ONSELECTTOSPEAKSTATECHANGED)
 };
+
+// API function that is called when a SwitchAccess user toggles Dictation from
+// the context menu.
+class AccessibilityPrivateToggleDictationFunction
+    : public UIThreadExtensionFunction {
+  ~AccessibilityPrivateToggleDictationFunction() override {}
+  ResponseAction Run() override;
+  DECLARE_EXTENSION_FUNCTION("accessibilityPrivate.toggleDictation",
+                             ACCESSIBILITY_PRIVATE_TOGGLEDICTATION)
+};
+
 #endif  // defined (OS_CHROMEOS)
 
 #endif  // CHROME_BROWSER_ACCESSIBILITY_ACCESSIBILITY_EXTENSION_API_H_

chrome/browser/resources/chromeos/switch_access/automation_manager.js

@@ -251,8 +251,9 @@ class AutomationManager {
   getRelevantMenuActions_() {
     // TODO(crbug/881080): determine relevant actions programmatically.
     let actions = [
-      ContextMenuManager.Action.CLICK, ContextMenuManager.Action.OPTIONS,
-      ContextMenuManager.Action.SCROLL_UP, ContextMenuManager.Action.SCROLL_DOWN
+      ContextMenuManager.Action.CLICK, ContextMenuManager.Action.DICTATION,
+      ContextMenuManager.Action.OPTIONS, ContextMenuManager.Action.SCROLL_UP,
+      ContextMenuManager.Action.SCROLL_DOWN
     ];
     return actions;
   }

chrome/browser/resources/chromeos/switch_access/context_menu_manager.js

@@ -194,6 +194,8 @@ class ContextMenuManager {
 
     if (event.data === ContextMenuManager.Action.CLICK)
       this.automationManager_.selectCurrentNode();
+    else if (event.data === ContextMenuManager.Action.DICTATION)
+      chrome.accessibilityPrivate.toggleDictation();
     else if (event.data === ContextMenuManager.Action.OPTIONS)
       window.switchAccess.showOptionsPage();
     else if (
@@ -228,6 +230,7 @@ class ContextMenuManager {
  */
 ContextMenuManager.Action = {
   CLICK: 'click',
+  DICTATION: 'dictation',
   OPTIONS: 'options',
   SCROLL_BACKWARD: 'scroll-backward',
   SCROLL_DOWN: 'scroll-down',

chrome/browser/resources/chromeos/switch_access/panel.html

@@ -19,6 +19,7 @@
     <button class="action" id="scroll-up" disabled>Scroll up</button>
     <button class="action" id="scroll-right" disabled>Scroll right</button>
     <button class="action" id="scroll-left" disabled>Scroll left</button>
+    <button class="action" id="dictation">Dictation</button>
     <button class="action" id="options">Options</button>
   </div>
 </body>

chrome/browser/ui/ash/accessibility/accessibility_controller_client_unittest.cc

@@ -45,6 +45,8 @@ class TestAccessibilityController : ash::mojom::AccessibilityController {
   void SetSelectToSpeakState(ash::mojom::SelectToSpeakState state) override {}
   void SetSelectToSpeakEventHandlerDelegate(
       ash::mojom::SelectToSpeakEventHandlerDelegatePtr delegate) override {}
+  void ToggleDictationFromSource(
+      ash::mojom::DictationToggleSource source) override {}
 
   bool was_client_set() const { return was_client_set_; }
 

chrome/common/extensions/api/accessibility_private.json

@@ -225,6 +225,13 @@
           }
         ],
         "platforms": ["chromeos"]
+      },
+      {
+        "name": "toggleDictation",
+        "type": "function",
+        "description": "Toggles dictation between active and inactive states.",
+        "parameters": [],
+        "platforms": ["chromeos"]
       }
     ],
     "events": [

extensions/browser/extension_function_histogram_value.h

@@ -1344,6 +1344,7 @@ enum HistogramValue {
   AUTOTESTPRIVATE_BOOTSTRAPMACHINELEARNINGSERVICE = 1281,
   AUTOTESTPRIVATE_RUNCROSTINIUNINSTALLER = 1282,
   AUTOTESTPRIVATE_TAKESCREENSHOT = 1283,
+  ACCESSIBILITY_PRIVATE_TOGGLEDICTATION = 1284,
   // Last entry: Add new entries above, then run:
   // python tools/metrics/histograms/update_extension_histograms.py
   ENUM_BOUNDARY

third_party/closure_compiler/externs/accessibility_private.js

@@ -208,3 +208,8 @@ chrome.accessibilityPrivate.onSelectToSpeakStateChanged = function(state) {};
  * @type {!ChromeEvent}
  */
 chrome.accessibilityPrivate.onSelectToSpeakStateChangeRequested;
+
+/**
+ * Called when a Switch Access user activates dictation from the context menu.
+ */
+chrome.accessibilityPrivate.toggleDictation = function() {};

tools/metrics/histograms/enums.xml

@@ -8885,6 +8885,8 @@ Called by update_net_error_codes.py.-->
 <enum name="CrosDictationToggleDictationMethod">
   <int value="0" label="Search+D"/>
   <int value="1" label="Click onscreen button"/>
+  <int value="2" label="Select the button in the SwitchAccess context menu"/>
+  <int value="3" label="ChromeVox gesture"/>
 </enum>
 
 <enum name="CrosDisksArchiveType">
@@ -16913,6 +16915,7 @@ Called by update_net_error_codes.py.-->
   <int value="1281" label="AUTOTESTPRIVATE_BOOTSTRAPMACHINELEARNINGSERVICE"/>
   <int value="1282" label="AUTOTESTPRIVATE_RUNCROSTINIUNINSTALLER"/>
   <int value="1283" label="AUTOTESTPRIVATE_TAKESCREENSHOT"/>
+  <int value="1284" label="ACCESSIBILITY_PRIVATE_TOGGLEDICTATION"/>
 </enum>
 
 <enum name="ExtensionIconState">