Fix ChromeVox compile after ES6 class refactoring

The Clsoure compiler (which gets run on upload PRESUBMIT) is now flagging many errors in ChromeVox. This is due to the recent work to move us to ES6 styled classes.

The errors themselves were mostly there previously and uncaught because Closure is fairly loose in flagging errors given a slightly different js structure.

Test: git cl presubmit -u --force
Change-Id: I4c09adf0a5fd6e3894f7316dc4d5a9c4bf9a825d
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/2026760Reviewed-by: Akihiro Ota <akihiroota@chromium.org>
Commit-Queue: David Tseng <dtseng@chromium.org>
Cr-Commit-Position: refs/heads/master@{#736503}

chrome/browser/resources/chromeos/accessibility/chromevox/background/classic_background.js

@@ -35,74 +35,7 @@ goog.require('TtsBackground');
  * interprets them.
  */
 ChromeVoxBackground = class {
-  constructor() {}
-
-  /**
-   * @param {string} pref
-   * @param {*} value
-   * @param {boolean} announce
-   */
-  static setPref(pref, value, announce) {
-    if (pref == 'earcons') {
-      AbstractEarcons.enabled = !!value;
-    } else if (pref == 'sticky' && announce) {
-      if (value) {
-        ChromeVox.tts.speak(
-            Msgs.getMsg('sticky_mode_enabled'), QueueMode.FLUSH);
-      } else {
-        ChromeVox.tts.speak(
-            Msgs.getMsg('sticky_mode_disabled'), QueueMode.FLUSH);
-      }
-    } else if (pref == 'typingEcho' && announce) {
-      var announceStr = '';
-      switch (value) {
-        case TypingEcho.CHARACTER:
-          announceStr = Msgs.getMsg('character_echo');
-          break;
-        case TypingEcho.WORD:
-          announceStr = Msgs.getMsg('word_echo');
-          break;
-        case TypingEcho.CHARACTER_AND_WORD:
-          announceStr = Msgs.getMsg('character_and_word_echo');
-          break;
-        case TypingEcho.NONE:
-          announceStr = Msgs.getMsg('none_echo');
-          break;
-        default:
-          break;
-      }
-      if (announceStr) {
-        ChromeVox.tts.speak(announceStr, QueueMode.QUEUE);
-      }
-    } else if (pref == 'brailleCaptions') {
-      BrailleCaptionsBackground.setActive(!!value);
-    } else if (pref == 'position') {
-      ChromeVox.position =
-          /** @type {Object<string, constants.Point>} */ (JSON.parse(
-              /** @type {string} */ (value)));
-    }
-    window['prefs'].setPref(pref, value);
-    ChromeVoxBackground.readPrefs();
-  }
-
-  /**
-   * Read and apply preferences that affect the background context.
-   */
-  static readPrefs() {
-    if (!window['prefs']) {
-      return;
-    }
-
-    var prefs = window['prefs'].getPrefs();
-    ChromeVoxEditableTextBase.useIBeamCursor =
-        (prefs['useIBeamCursor'] == 'true');
-    ChromeVox.isStickyPrefOn = (prefs['sticky'] == 'true');
-  }
-
-  /**
-   * Initialize the background page: set up TTS and bridge listeners.
-   */
-  init() {
+  constructor() {
     this.prefs = new ChromeVoxPrefs();
     ChromeVoxBackground.readPrefs();
 
@@ -177,6 +110,68 @@ ChromeVoxBackground = class {
     });
   }
 
+  /**
+   * @param {string} pref
+   * @param {*} value
+   * @param {boolean} announce
+   */
+  static setPref(pref, value, announce) {
+    if (pref == 'earcons') {
+      AbstractEarcons.enabled = !!value;
+    } else if (pref == 'sticky' && announce) {
+      if (value) {
+        ChromeVox.tts.speak(
+            Msgs.getMsg('sticky_mode_enabled'), QueueMode.FLUSH);
+      } else {
+        ChromeVox.tts.speak(
+            Msgs.getMsg('sticky_mode_disabled'), QueueMode.FLUSH);
+      }
+    } else if (pref == 'typingEcho' && announce) {
+      var announceStr = '';
+      switch (value) {
+        case TypingEcho.CHARACTER:
+          announceStr = Msgs.getMsg('character_echo');
+          break;
+        case TypingEcho.WORD:
+          announceStr = Msgs.getMsg('word_echo');
+          break;
+        case TypingEcho.CHARACTER_AND_WORD:
+          announceStr = Msgs.getMsg('character_and_word_echo');
+          break;
+        case TypingEcho.NONE:
+          announceStr = Msgs.getMsg('none_echo');
+          break;
+        default:
+          break;
+      }
+      if (announceStr) {
+        ChromeVox.tts.speak(announceStr, QueueMode.QUEUE);
+      }
+    } else if (pref == 'brailleCaptions') {
+      BrailleCaptionsBackground.setActive(!!value);
+    } else if (pref == 'position') {
+      ChromeVox.position =
+          /** @type {Object<string, constants.Point>} */ (JSON.parse(
+              /** @type {string} */ (value)));
+    }
+    window['prefs'].setPref(pref, value);
+    ChromeVoxBackground.readPrefs();
+  }
+
+  /**
+   * Read and apply preferences that affect the background context.
+   */
+  static readPrefs() {
+    if (!window['prefs']) {
+      return;
+    }
+
+    var prefs = window['prefs'].getPrefs();
+    ChromeVoxEditableTextBase.useIBeamCursor =
+        (prefs['useIBeamCursor'] == 'true');
+    ChromeVox.isStickyPrefOn = (prefs['sticky'] == 'true');
+  }
+
   /**
    * Inject ChromeVox into a tab.
    * @param {Array<Tab>} tabs The tab where ChromeVox scripts should be
@@ -363,7 +358,6 @@ ChromeVoxBackground = class {
 // so that other background pages can access it. Also export the prefs object
 // for access by the options page.
 let background = new ChromeVoxBackground();
-background.init();
 
 // TODO: this needs to be cleaned up (move to init?).
 window['speak'] = goog.bind(background.tts.speak, background.tts);

chrome/browser/resources/chromeos/accessibility/chromevox/background/custom_automation_event.js

@@ -9,8 +9,14 @@
  * construct, unlike the object from the extension system.
  */
 
+goog.provide('ChromeVoxEvent');
 goog.provide('CustomAutomationEvent');
 
+/**
+ * @typedef{chrome.automation.AutomationEvent|CustomAutomationEvent}
+ */
+var ChromeVoxEvent;
+
 /**
  * An object we can use instead of a chrome.automation.AutomationEvent.
  */
@@ -27,7 +33,7 @@ CustomAutomationEvent = class {
   }
 
   /**
-   * @override
+   * Stops the propagation of this event.
    */
   stopPropagation() {
     throw Error('Can\'t call stopPropagation on a CustomAutomationEvent');

chrome/browser/resources/chromeos/accessibility/chromevox/background/desktop_automation_handler.js

@@ -104,7 +104,7 @@ DesktopAutomationHandler = class extends BaseAutomationHandler {
 
   /**
    * Provides all feedback once ChromeVox's focus changes.
-   * @param {!AutomationEvent} evt
+   * @param {!ChromeVoxEvent} evt
    */
   onEventDefault(evt) {
     var node = evt.target;
@@ -140,7 +140,7 @@ DesktopAutomationHandler = class extends BaseAutomationHandler {
   }
 
   /**
-   * @param {!AutomationEvent} evt
+   * @param {!ChromeVoxEvent} evt
    */
   onEventFromViews(evt) {
     if (evt.target.root.role == RoleType.DESKTOP) {
@@ -149,7 +149,7 @@ DesktopAutomationHandler = class extends BaseAutomationHandler {
     }
 
     /**
-     * @param {!AutomationEvent} evt
+     * @param {!ChromeVoxEvent} evt
      */
     onEventIfSelected(evt) {
       if (evt.target.selected) {
@@ -199,7 +199,7 @@ DesktopAutomationHandler = class extends BaseAutomationHandler {
     }
 
     /**
-     * @param {!AutomationEvent} evt
+     * @param {!ChromeVoxEvent} evt
      */
     onHover(evt) {
       if (!GestureCommandHandler.getEnabled()) {
@@ -242,7 +242,7 @@ DesktopAutomationHandler = class extends BaseAutomationHandler {
 
     /**
      * Makes an announcement without changing focus.
-     * @param {!AutomationEvent} evt
+     * @param {!ChromeVoxEvent} evt
      */
     onAlert(evt) {
       var node = evt.target;
@@ -264,7 +264,7 @@ DesktopAutomationHandler = class extends BaseAutomationHandler {
   }
 
   /**
-   * @param {!AutomationEvent} evt
+   * @param {!ChromeVoxEvent} evt
    */
   onDocumentSelectionChanged(evt) {
     var selectionStart = evt.target.selectionStartObject;
@@ -293,7 +293,7 @@ DesktopAutomationHandler = class extends BaseAutomationHandler {
 
   /**
    * Provides all feedback once a focus event fires.
-   * @param {!AutomationEvent} evt
+   * @param {!ChromeVoxEvent} evt
    */
   onFocus(evt) {
     if (evt.target.role == RoleType.ROOT_WEB_AREA &&
@@ -341,7 +341,7 @@ DesktopAutomationHandler = class extends BaseAutomationHandler {
 
   /**
    * Provides all feedback once a load complete event fires.
-   * @param {!AutomationEvent} evt
+   * @param {!ChromeVoxEvent} evt
    */
   onLoadComplete(evt) {
     // A load complete gets fired on the desktop node when display metrics
@@ -405,7 +405,7 @@ DesktopAutomationHandler = class extends BaseAutomationHandler {
 
   /**
    * Provides all feedback once a change event in a text field fires.
-   * @param {!AutomationEvent} evt
+   * @param {!ChromeVoxEvent} evt
    * @private
    */
   onEditableChanged_(evt) {
@@ -448,7 +448,7 @@ DesktopAutomationHandler = class extends BaseAutomationHandler {
 
     /**
      * Provides all feedback once a value changed event fires.
-     * @param {!AutomationEvent} evt
+     * @param {!ChromeVoxEvent} evt
      */
     onValueChanged(evt) {
       // Skip root web areas.
@@ -501,7 +501,7 @@ DesktopAutomationHandler = class extends BaseAutomationHandler {
 
     /**
      * Handle updating the active indicator when the document scrolls.
-     * @param {!AutomationEvent} evt
+     * @param {!ChromeVoxEvent} evt
      */
     onScrollPositionChanged(evt) {
       var currentRange = ChromeVoxState.instance.currentRange;
@@ -511,7 +511,7 @@ DesktopAutomationHandler = class extends BaseAutomationHandler {
     }
 
     /**
-     * @param {!AutomationEvent} evt
+     * @param {!ChromeVoxEvent} evt
      */
     onSelection(evt) {
       // Invalidate any previous editable text handler state since some nodes,
@@ -540,7 +540,7 @@ DesktopAutomationHandler = class extends BaseAutomationHandler {
 
     /**
      * Provides all feedback once a menu start event fires.
-     * @param {!AutomationEvent} evt
+     * @param {!ChromeVoxEvent} evt
      */
     onMenuStart(evt) {
       ChromeVoxState.instance.markCurrentRange();
@@ -549,7 +549,7 @@ DesktopAutomationHandler = class extends BaseAutomationHandler {
 
     /**
      * Provides all feedback once a menu end event fires.
-     * @param {!AutomationEvent} evt
+     * @param {!ChromeVoxEvent} evt
      */
     onMenuEnd(evt) {
       this.onEventDefault(evt);
@@ -615,7 +615,7 @@ DesktopAutomationHandler = class extends BaseAutomationHandler {
     }
 
     /**
-     * @param {AutomationEvent} evt
+     * @param {ChromeVoxEvent} evt
      * @private
      */
     maybeRecoverFocusAndOutput_(evt, focus) {

chrome/browser/resources/chromeos/accessibility/chromevox/background/editing.js

@@ -49,6 +49,9 @@ editing.TextEditHandler = class {
       throw '|node| must be editable.';
     }
 
+    /** @private {AutomationEditableText} */
+    this.editableText_;
+
     chrome.automation.getDesktop(function(desktop) {
       // A rich text field is one where selection gets placed on a DOM
       // descendant to a root text field. This is one of:
@@ -59,7 +62,6 @@ editing.TextEditHandler = class {
       // from ARC++).
       var useRichText = node.state[StateType.RICHLY_EDITABLE];
 
-      /** @private {!AutomationEditableText} */
       this.editableText_ = useRichText ? new AutomationRichEditableText(node) :
                                          new AutomationEditableText(node);
     }.bind(this));
@@ -76,7 +78,7 @@ editing.TextEditHandler = class {
    * |valueChanged|.
    * An implementation of this method should emit the appropriate braille and
    * spoken feedback for the event.
-   * @param {!(AutomationEvent|CustomAutomationEvent)} evt
+   * @param {!ChromeVoxEvent} evt
    */
   onEvent(evt) {
     if (evt.type !== EventType.TEXT_CHANGED &&
@@ -259,7 +261,7 @@ var AutomationEditableText = class extends ChromeVoxEditableTextBase {
 
   /**
    * @param {string} value
-   * @return {!Array<string>}
+   * @return {!Array<number>}
    * @private
    */
   static getLineBreaks_(value) {
@@ -954,6 +956,9 @@ editing.EditableLine = class {
     this.end_ = new Cursor(endNode, endIndex);
     this.end_ = this.end_.deepEquivalent || this.end_;
 
+    /** @private {AutomationNode|undefined} */
+    this.endContainer_;
+
     // Update |startIndex| and |endIndex| if the calls above to
     // cursors.Cursor.deepEquivalent results in cursors to different container
     // nodes. The cursors can point directly to inline text boxes, in which case

chrome/browser/resources/chromeos/accessibility/chromevox/background/logging/event_stream_logger.js

@@ -31,7 +31,7 @@ EventStreamLogger = class {
 
   /**
    * Adds eventStreamLogging to this handler.
-   * @param {chrome.automation.chrome.automation.EventType} eventType
+   * @param {chrome.automation.EventType} eventType
    * @protected
    */
   addWatcher_(eventType) {
@@ -40,7 +40,7 @@ EventStreamLogger = class {
 
   /**
    * Removes eventStreamLogging from this handler.
-   * @param {chrome.automation.chrome.automation.EventType} eventType
+   * @param {chrome.automation.EventType} eventType
    * @protected
    */
   removeWatcher_(eventType) {
@@ -57,7 +57,7 @@ EventStreamLogger = class {
   }
 
   /**
-   * @param {chrome.automation.chrome.automation.EventType} eventType
+   * @param {chrome.automation.EventType} eventType
    * @param {boolean} checked
    */
   notifyEventStreamFilterChanged(eventType, checked) {

chrome/browser/resources/chromeos/accessibility/chromevox/background/mouse_handler.js

@@ -18,14 +18,26 @@ const INTERVAL_MS_BETWEEN_HIT_TESTS = 50;
 BackgroundMouseHandler = class extends BaseAutomationHandler {
   constructor() {
     super(null);
+    /** @private {chrome.automation.AutomationNode} */
+    this.node_;
+    /**
+     *
+     * The desktop node.
+     *
+     * @private {!chrome.automation.AutomationNode}
+     */
+    this.desktop_;
+    /** @private {boolean|undefined} */
+    this.isWaitingBeforeHitTest_;
+    /** @private {boolean|undefined} */
+    this.hasPendingEvents_;
+    /** @private {number|undefined} */
+    this.mouseX_;
+    /** @private {number|undefined} */
+    this.mouseY_;
+
     chrome.automation.getDesktop((desktop) => {
       this.node_ = desktop;
-      /**
-       *
-       * The desktop node.
-       *
-       * @private {!chrome.automation.AutomationNode}
-       */
       this.desktop_ = desktop;
       this.addListener_(EventType.MOUSE_MOVED, this.onMouseMove);
 
@@ -62,6 +74,9 @@ BackgroundMouseHandler = class extends BaseAutomationHandler {
    * false and |hasPendingEvents| is true.
    */
   runHitTest() {
+    if (this.mouseX_ === undefined || this.mouseY_ === undefined) {
+      return;
+    }
     this.desktop_.hitTest(this.mouseX_, this.mouseY_, EventType.HOVER);
     this.hasPendingEvents_ = false;
     this.startTimer();

chrome/browser/resources/chromeos/accessibility/chromevox/background/output.js

@@ -480,17 +480,19 @@ Output = class {
         continue;
       }
 
-      var speechProps = /** @type {Object} */ (
+      var speechProps = {};
+      var speechPropsInstance = /** @type {Output.SpeechProperties} */ (
           buff.getSpanInstanceOf(Output.SpeechProperties));
 
-      if (!speechProps) {
+      if (!speechPropsInstance) {
         speechProps = this.initialSpeechProps_;
       } else {
         for (var [key, value] of Object.entries(this.initialSpeechProps_)) {
-          if (speechProps[key] === undefined) {
-            speechProps[key] = value;
+          if (speechPropsInstance.properties[key] === undefined) {
+            speechPropsInstance.properties[key] = value;
           }
         }
+        speechProps = speechPropsInstance.properties;
       }
 
       speechProps.category = this.speechCategory_;
@@ -753,7 +755,7 @@ Output = class {
                   buff, options, newLanguage, outputString) {
                 var speechProps = new Output.SpeechProperties();
                 // Set output language.
-                speechProps['lang'] = newLanguage;
+                speechProps.properties['lang'] = newLanguage;
                 // Append outputString to buff.
                 this.append_(buff, outputString, options);
                 // Attach associated SpeechProperties if the buffer is
@@ -973,7 +975,7 @@ Output = class {
 
             if (this.formatOptions_.auralStyle) {
               speechProps = new Output.SpeechProperties();
-              speechProps['relativePitch'] = -0.3;
+              speechProps.properties['relativePitch'] = -0.3;
             }
             options.annotation.push(token);
             var msg = node.role;
@@ -1223,7 +1225,7 @@ Output = class {
             if (!speechProps) {
               speechProps = new Output.SpeechProperties();
             }
-            speechProps['relativePitch'] = -0.2;
+            speechProps.properties['relativePitch'] = -0.2;
           }
           var isPluralized = (token[0] == '@');
           if (isPluralized) {
@@ -1311,7 +1313,7 @@ Output = class {
         } else if (prefix == '!') {
           ruleStr.write(' ! ' + token + '\n');
           speechProps = new Output.SpeechProperties();
-          speechProps[token] = true;
+          speechProps.properties[token] = true;
           if (tree.firstChild) {
             if (!this.formatOptions_.auralStyle) {
               speechProps = undefined;
@@ -1327,7 +1329,7 @@ Output = class {
             } else {
               value = parseFloat(node[value]) / -10.0;
             }
-            speechProps[token] = value;
+            speechProps.properties[token] = value;
             return;
           }
         }
@@ -1759,7 +1761,7 @@ Output = class {
 
       // Hints should be delayed.
       var hintProperties = new Output.SpeechProperties();
-      hintProperties['delay'] = true;
+      hintProperties.properties['delay'] = true;
 
       ruleStr.write('hint_: ');
       if (EventSourceState.get() == EventSourceType.TOUCH_GESTURE) {
@@ -2656,7 +2658,26 @@ Output.RULES = {
  * Used to annotate utterances with speech properties.
  */
 Output.SpeechProperties = class {
-  constructor() {}
+  constructor() {
+    /** @private {!Object} */
+    this.properties_ = {};
+  }
+
+  /** @return {!Object} */
+  get properties() {
+    return this.properties_;
+  }
+
+  /** @override */
+  toJSON() {
+    // Make a copy of our properties since the caller really shouldn't be
+    // modifying our local state.
+    var clone = {};
+    for (var key in this.properties_) {
+      clone[key] = this.properties_[key];
+    }
+    return clone;
+  }
 };
 
 /**

chrome/browser/resources/chromeos/accessibility/chromevox/background/panel/i_search.js

@@ -60,6 +60,9 @@ ISearch = class {
       throw 'Incremental search started from invalid range.';
     }
 
+    /** @private {ISearchHandler} */
+    this.handler_;
+
     var leaf = AutomationUtil.findNodePre(
                    cursor.node, Dir.FORWARD, AutomationPredicate.leaf) ||
         cursor.node;

chrome/browser/resources/chromeos/accessibility/chromevox/background/panel/panel_menu.js

@@ -271,9 +271,18 @@ PanelNodeMenu = class extends PanelMenu {
    */
   constructor(menuMsg, node, pred, async) {
     super(menuMsg);
+    /** @private {AutomationNode} */
     this.node_ = node;
+    /** @private {AutomationPredicate.Unary} */
     this.pred_ = pred;
+    /** @private {boolean} */
     this.async_ = async;
+    /** @private {AutomationTreeWalker|undefined} */
+    this.walker_;
+    /** @private {number} */
+    this.nodeCount_ = 0;
+    /** @private {boolean} */
+    this.selectNext_ = false;
     this.populate_();
   }
 

chrome/browser/resources/chromeos/accessibility/chromevox/background/range_automation_handler.js

@@ -31,6 +31,9 @@ RangeAutomationHandler = class extends BaseAutomationHandler {
     /** @private {Output} */
     this.lastAttributeOutput_;
 
+    /** @private {number} */
+    this.delayedAttributeOutputId_ = -1;
+
     ChromeVoxState.addObserver(this);
   }
 
@@ -64,7 +67,7 @@ RangeAutomationHandler = class extends BaseAutomationHandler {
   }
 
   /**
-   * @param {!AutomationEvent} evt
+   * @param {!ChromeVoxEvent} evt
    */
   onEventIfInRange(evt) {
     if (!DesktopAutomationHandler.announceActions &&
@@ -113,7 +116,7 @@ RangeAutomationHandler = class extends BaseAutomationHandler {
   }
 
   /**
-   * @param {!AutomationEvent} evt
+   * @param {!ChromeVoxEvent} evt
    */
   onAriaAttributeChanged(evt) {
     // Don't report changes on editable nodes since they interfere with text
@@ -140,7 +143,7 @@ RangeAutomationHandler = class extends BaseAutomationHandler {
 
   /**
    * Provides all feedback once a checked state changed event fires.
-   * @param {!AutomationEvent} evt
+   * @param {!ChromeVoxEvent} evt
    */
   onCheckedStateChanged(evt) {
     if (!AutomationPredicate.checkable(evt.target)) {
@@ -155,7 +158,7 @@ RangeAutomationHandler = class extends BaseAutomationHandler {
   /**
    * Updates the focus ring if the location of the current range, or
    * an descendant of the current range, changes.
-   * @param {!AutomationEvent} evt
+   * @param {!ChromeVoxEvent} evt
    */
   onLocationChanged(evt) {
     var cur = ChromeVoxState.instance.currentRange;

chrome/browser/resources/chromeos/accessibility/chromevox/braille/braille_display_manager.js

@@ -68,6 +68,8 @@ BrailleDisplayManager = class {
      * @private
      */
     this.realDisplayState_ = this.displayState_;
+    /** @private {number|undefined} */
+    this.blinkerId_;
 
     translatorManager.addChangeListener(function() {
       this.translateContent_(this.content_, this.expansionType_);

chrome/browser/resources/chromeos/accessibility/chromevox/common/editable_text_base.js

@@ -37,14 +37,8 @@ TextChangeEvent = class {
    * @param {boolean} triggeredByUser .
    */
   constructor(newValue, newStart, newEnd, triggeredByUser) {
-    Object.defineProperty(this, 'value', {
-      get: function() {
-        return this.value_;
-      }.bind(this),
-      set: function(val) {
-        this.value_ = val.replace(/\u00a0/g, ' ');
-      }.bind(this)
-    });
+    /** @private {string} */
+    this.value_ = '';
     this.value = newValue;
 
     this.start = newStart;
@@ -58,6 +52,13 @@ TextChangeEvent = class {
       this.start = tempOffset;
     }
   }
+
+  get value() {
+    return this.value_;
+  }
+  set value(val) {
+    this.value_ = val.replace(/\u00a0/g, ' ');
+  }
 };