Simplify C++ -> JS messaging in chrome://quota-internals.

This is in preparation of migrating chrome://quota-internals to use
JS modules.

 - Replace calls to CallJavascriptFunctionUnsafe with FireWebUIListener.
 - Replace event handlers on unnecessary custom EventTarget instances
   with cr.addWebUIListener() calls.

Bug: 1028829
Change-Id: Id5a97d5e81a4e920dfe116a4b93cbacbf5ce55fe
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/2478847Reviewed-by: Rebekah Potter <rbpotter@chromium.org>
Commit-Queue: dpapad <dpapad@chromium.org>
Cr-Commit-Position: refs/heads/master@{#818397}

chrome/browser/resources/quota_internals/event_handler.js

@@ -245,20 +245,14 @@ function getOriginObject(type, host, origin) {
   return originObject;
 }
 
-/**
- * Event Handler for |cr.quota.onAvailableSpaceUpdated|.
- * |event.detail| contains |availableSpace|.
- * |availableSpace| represents total available disk space.
- * @param {!CustomEvent<number>} event AvailableSpaceUpdated event.
- */
-function handleAvailableSpace(event) {
-  availableSpace = event.detail;
+/** @param {number} space Total available disk space. */
+function handleAvailableSpace(space) {
+  availableSpace = space;
   $('diskspace-entry').textContent = numBytesToText_(availableSpace);
 }
 
 /**
- * Event Handler for |cr.quota.onGlobalInfoUpdated|.
- * |event.detail| contains a record which has:
+ * |data| contains a record which has:
  *   |type|:
  *     Storage type, that is either 'temporary' or 'persistent'.
  *   |usage|:
@@ -270,15 +264,14 @@ function handleAvailableSpace(event) {
  *
  *  |usage|, |unlimitedUsage| and |quota| can be missing,
  *  and some additional fields can be included.
- * @param {!CustomEvent<!{
+ * @param {!{
  *     type: string,
  *     usage: ?number,
  *     unlimitedUsage: ?number,
  *     quota: ?string
- * }>} event GlobalInfoUpdated event.
+ * }} data
  */
-function handleGlobalInfo(event) {
-  const data = event.detail;
+function handleGlobalInfo(data) {
   const storageObject = getStorageObject(data.type);
   copyAttributes_(data, storageObject.detail.payload);
   storageObject.reveal();
@@ -288,8 +281,7 @@ function handleGlobalInfo(event) {
 }
 
 /**
- * Event Handler for |cr.quota.onPerHostInfoUpdated|.
- * |event.detail| contains records which have:
+ * |dataArray| contains records which have:
  *   |host|:
  *     Hostname of the entry. (e.g. 'example.com')
  *   |type|:
@@ -301,16 +293,14 @@ function handleGlobalInfo(event) {
  *
  * |usage| and |quota| can be missing,
  * and some additional fields can be included.
- * @param {!CustomEvent<!Array<{
+ * @param {!Array<{
  *     host: string,
  *     type: string,
  *     usage: ?number,
  *     quota: ?number
- * }>>} event PerHostInfoUpdated event.
+ * }>} dataArray
  */
-function handlePerHostInfo(event) {
-  const dataArray = event.detail;
-
+function handlePerHostInfo(dataArray) {
   for (let i = 0; i < dataArray.length; ++i) {
     const data = dataArray[i];
     const hostObject = getHostObject(data.type, data.host);
@@ -323,8 +313,7 @@ function handlePerHostInfo(event) {
 }
 
 /**
- * Event Handler for |cr.quota.onPerOriginInfoUpdated|.
- * |event.detail| contains records which have:
+ * |dataArray| contains records which have:
  *   |origin|:
  *     Origin URL of the entry.
  *   |type|:
@@ -344,7 +333,7 @@ function handlePerHostInfo(event) {
  *
  * |inUse|, |usedCount|, |lastAccessTime| and |lastModifiedTime| can be missing,
  * and some additional fields can be included.
- * @param {!CustomEvent<!Array<!{
+ * @param {!Array<!{
  *     origin: string,
  *     type: string,
  *     host: string,
@@ -352,11 +341,9 @@ function handlePerHostInfo(event) {
  *     usedCount: ?number,
  *     lastAccessTime: ?number,
  *     lastModifiedTime: ?number
- * }>>} event PerOriginInfoUpdated event.
+ * }>} dataArray
  */
-function handlePerOriginInfo(event) {
-  const dataArray = event.detail;
-
+function handlePerOriginInfo(dataArray) {
   for (let i = 0; i < dataArray.length; ++i) {
     const data = dataArray[i];
     const originObject = getOriginObject(data.type, data.host, data.origin);
@@ -369,12 +356,10 @@ function handlePerOriginInfo(event) {
 }
 
 /**
- * Event Handler for |cr.quota.onStatisticsUpdated|.
- * |event.detail| contains misc statistics data as dictionary.
- * @param {!CustomEvent<!Object>} event StatisticsUpdated event.
+ * |data| contains misc statistics data as dictionary.
+ * @param {!Object} data
  */
-function handleStatistics(event) {
-  const data = event.detail;
+function handleStatistics(data) {
   for (const key in data) {
     let entry = statistics[key];
     if (!entry) {
@@ -391,13 +376,10 @@ function handleStatistics(event) {
 }
 
 /**
- * Event Handler for |cr.quota.onStoragePressureFlagUpdated|.
- * |event.detail| contains a boolean representing whether or not to show
- * the storage pressure UI.
- * @param {!CustomEvent<!Object>} event StoragePressureFlagUpdated event.
+ * @param {!{isStoragePressureEnabled: boolean}} data Contains a boolean
+ *     representing whether or not to show the storage pressure UI.
  */
-function handleStoragePressureFlagInfo(event) {
-  const data = event.detail;
+function handleStoragePressureFlagInfo(data) {
   $('storage-pressure-loading').hidden = true;
   if (data.isStoragePressureEnabled) {
     $('storage-pressure-outer').hidden = false;
@@ -499,15 +481,14 @@ function dump() {
 function onLoad() {
   cr.ui.decorate('tabbox', cr.ui.TabBox);
 
-  cr.quota.onAvailableSpaceUpdated.addEventListener(
-      'update', handleAvailableSpace);
-  cr.quota.onGlobalInfoUpdated.addEventListener('update', handleGlobalInfo);
-  cr.quota.onPerHostInfoUpdated.addEventListener('update', handlePerHostInfo);
-  cr.quota.onPerOriginInfoUpdated.addEventListener(
-      'update', handlePerOriginInfo);
-  cr.quota.onStatisticsUpdated.addEventListener('update', handleStatistics);
-  cr.quota.onStoragePressureFlagUpdated.addEventListener(
-      'update', handleStoragePressureFlagInfo);
+  cr.addWebUIListener('AvailableSpaceUpdated', handleAvailableSpace);
+  cr.addWebUIListener('GlobalInfoUpdated', handleGlobalInfo);
+  cr.addWebUIListener('PerHostInfoUpdated', handlePerHostInfo);
+  cr.addWebUIListener('PerOriginInfoUpdated', handlePerOriginInfo);
+  cr.addWebUIListener('StatisticsUpdated', handleStatistics);
+  cr.addWebUIListener(
+      'StoragePressureFlagUpdated', handleStoragePressureFlagInfo);
+
   cr.quota.requestInfo();
 
   $('refresh-button').addEventListener('click', cr.quota.requestInfo, false);

chrome/browser/resources/quota_internals/message_dispatcher.js

@@ -3,14 +3,10 @@
 // found in the LICENSE file.
 
 // require cr.js
-// require cr/event_target.js
-// require cr/util.js
 
 /**
  * Bridge between the browser and the page.
  * In this file:
- *   * define EventTargets to receive message from the browser,
- *   * dispatch browser messages to EventTarget,
  *   * define interface to request data to the browser.
  */
 
@@ -31,66 +27,10 @@ cr.define('cr.quota', function() {
     chrome.send('triggerStoragePressure', [origin]);
   }
 
-  /**
-   * Callback entry point from Browser.
-   * Messages are Dispatched as Event to:
-   *   * onAvailableSpaceUpdated,
-   *   * onGlobalInfoUpdated,
-   *   * onPerHostInfoUpdated,
-   *   * onPerOriginInfoUpdated,
-   *   * onStatisticsUpdated,
-   *   * onStoragePressureFlagUpdated.
-   * @param {string} message Message label. Possible Values are:
-   *   * 'AvailableSpaceUpdated',
-   *   * 'GlobalInfoUpdated',
-   *   * 'PerHostInfoUpdated',
-   *   * 'PerOriginInfoUpdated',
-   *   * 'StatisticsUpdated',
-   *   * 'StoragePressureFlagUpdated'.
-   * @param {Object} detail Message specific additional data.
-   */
-  function messageHandler(message, detail) {
-    let target = null;
-    switch (message) {
-      case 'AvailableSpaceUpdated':
-        target = cr.quota.onAvailableSpaceUpdated;
-        break;
-      case 'GlobalInfoUpdated':
-        target = cr.quota.onGlobalInfoUpdated;
-        break;
-      case 'PerHostInfoUpdated':
-        target = cr.quota.onPerHostInfoUpdated;
-        break;
-      case 'PerOriginInfoUpdated':
-        target = cr.quota.onPerOriginInfoUpdated;
-        break;
-      case 'StatisticsUpdated':
-        target = cr.quota.onStatisticsUpdated;
-        break;
-      case 'StoragePressureFlagUpdated':
-        target = cr.quota.onStoragePressureFlagUpdated;
-        break;
-      default:
-        console.error('Unknown Message');
-        break;
-    }
-    if (target) {
-      const event = document.createEvent('CustomEvent');
-      event.initCustomEvent('update', false, false, detail);
-      target.dispatchEvent(event);
-    }
-  }
 
-  return {
-    onAvailableSpaceUpdated: new cr.EventTarget(),
-    onGlobalInfoUpdated: new cr.EventTarget(),
-    onPerHostInfoUpdated: new cr.EventTarget(),
-    onPerOriginInfoUpdated: new cr.EventTarget(),
-    onStatisticsUpdated: new cr.EventTarget(),
-    onStoragePressureFlagUpdated: new cr.EventTarget(),
 
+  return {
     requestInfo: requestInfo,
     triggerStoragePressure: triggerStoragePressure,
-    messageHandler: messageHandler
   };
 });

chrome/browser/ui/webui/quota_internals/quota_internals_handler.cc

@@ -51,13 +51,13 @@ void QuotaInternalsHandler::RegisterMessages() {
 }
 
 void QuotaInternalsHandler::ReportAvailableSpace(int64_t available_space) {
-  SendMessage("AvailableSpaceUpdated",
-              base::Value(static_cast<double>(available_space)));
+  FireWebUIListener("AvailableSpaceUpdated",
+                    base::Value(static_cast<double>(available_space)));
 }
 
 void QuotaInternalsHandler::ReportGlobalInfo(const GlobalStorageInfo& data) {
   std::unique_ptr<base::Value> value(data.NewValue());
-  SendMessage("GlobalInfoUpdated", *value);
+  FireWebUIListener("GlobalInfoUpdated", *value);
 }
 
 void QuotaInternalsHandler::ReportPerHostInfo(
@@ -67,7 +67,7 @@ void QuotaInternalsHandler::ReportPerHostInfo(
     values.Append(itr->NewValue());
   }
 
-  SendMessage("PerHostInfoUpdated", values);
+  FireWebUIListener("PerHostInfoUpdated", values);
 }
 
 void QuotaInternalsHandler::ReportPerOriginInfo(
@@ -77,7 +77,7 @@ void QuotaInternalsHandler::ReportPerOriginInfo(
     origins_value.Append(itr->NewValue());
   }
 
-  SendMessage("PerOriginInfoUpdated", origins_value);
+  FireWebUIListener("PerOriginInfoUpdated", origins_value);
 }
 
 void QuotaInternalsHandler::ReportStatistics(const Statistics& stats) {
@@ -86,23 +86,18 @@ void QuotaInternalsHandler::ReportStatistics(const Statistics& stats) {
     dict.SetString(itr->first, itr->second);
   }
 
-  SendMessage("StatisticsUpdated", dict);
+  FireWebUIListener("StatisticsUpdated", dict);
 }
 
 void QuotaInternalsHandler::ReportStoragePressureFlag() {
   base::DictionaryValue flag_enabled;
   flag_enabled.SetBoolean("isStoragePressureEnabled",
                           IsStoragePressureEnabled());
-  SendMessage("StoragePressureFlagUpdated", flag_enabled);
-}
-
-void QuotaInternalsHandler::SendMessage(const std::string& message,
-                                        const base::Value& value) {
-  web_ui()->CallJavascriptFunctionUnsafe("cr.quota.messageHandler",
-                                         base::Value(message), value);
+  FireWebUIListener("StoragePressureFlagUpdated", flag_enabled);
 }
 
 void QuotaInternalsHandler::OnRequestInfo(const base::ListValue*) {
+  AllowJavascript();
   if (!proxy_.get())
     proxy_ = new QuotaInternalsProxy(this);
   ReportStoragePressureFlag();
@@ -113,6 +108,7 @@ void QuotaInternalsHandler::OnRequestInfo(const base::ListValue*) {
 
 void QuotaInternalsHandler::OnTriggerStoragePressure(
     const base::ListValue* args) {
+  AllowJavascript();
   CHECK_EQ(1U, args->GetSize());
   std::string origin_string;
   CHECK(args->GetString(0, &origin_string));

chrome/browser/ui/webui/quota_internals/quota_internals_handler.h

@@ -16,7 +16,6 @@
 #include "content/public/browser/web_ui_message_handler.h"
 
 namespace base {
-class Value;
 class ListValue;
 }
 
@@ -47,7 +46,6 @@ class QuotaInternalsHandler : public content::WebUIMessageHandler {
  private:
   void OnRequestInfo(const base::ListValue*);
   void OnTriggerStoragePressure(const base::ListValue*);
-  void SendMessage(const std::string& message, const base::Value& value);
 
   scoped_refptr<QuotaInternalsProxy> proxy_;