Cleanup: Change LogMostVisitedImpression|Navigation APIs to take an enum

chrome/browser/resources/local_ntp/most_visited_single.js

 /* Copyright 2015 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. */
 
  // Single iframe for NTP tiles.
 (function() {
 'use strict';
 
 
 /**
  * The different types of events that are logged from the NTP.  This enum is
  * used to transfer information from the NTP JavaScript to the renderer and is
  * not used as a UMA enum histogram's logged value.
  * Note: Keep in sync with common/ntp_logging_events.h
  * @enum {number}
  * @const
  */
 var LOG_TYPE = {
-  // The suggestion is coming from the server. Unused here.
+  // The suggestion is coming from the server.
   NTP_SERVER_SIDE_SUGGESTION: 0,
   // The suggestion is coming from the client.
   NTP_CLIENT_SIDE_SUGGESTION: 1,
   // Indicates a tile was rendered, no matter if it's a thumbnail, a gray tile
   // or an external tile.
   NTP_TILE: 2,
   // The tile uses a local thumbnail image.
   NTP_THUMBNAIL_TILE: 3,
   // Used when no thumbnail is specified and a gray tile with the domain is used
   // as the main tile. Unused here.
@@ skipping 10 matching lines @@
   // The visuals of that tile's fallback are handled externally. Unused here.
   NTP_EXTERNAL_TILE_FALLBACK: 8,
   // The user moused over an NTP tile.
   NTP_MOUSEOVER: 9,
   // A NTP Tile has finished loading (successfully or failing).
   NTP_TILE_LOADED: 10,
 };
 
 
 /**
+ * The different sources that an NTP tile can have.
+ * Note: Keep in sync with common/ntp_logging_events.h
+ * @enum {number}
+ * @const
+ */
+var TILE_SOURCE = {
+  NTP_TILE_SOURCE_CLIENT: 0,

[Bernhard Bauer, 2016/07/05 14:31:54]

Nit: you get the equivalent of namespacing here -- no need to prefix these
values with NTP_TILE_SOURCE.

[Marc Treib, 2016/07/05 14:37:53]

I'd like to keep the entries identical to the C++ enum entries, to make them
greppable. LOG_TYPE above does the same. (Bad enough that the values are
duplicated in C++ and JS, but it should at least be possible to search for
them...)

+  NTP_TILE_SOURCE_SERVER: 1,
+};
+
+
+/**
  * Total number of tiles to show at any time. If the host page doesn't send
  * enough tiles, we fill them blank.
  * @const {number}
  */
 var NUMBER_OF_TILES = 8;
 
 
 /**
  * Whether to use icons instead of thumbnails.
  * @type {boolean}
  */
 var USE_ICONS = false;
 
 
 /**
  * Number of lines to display in titles.
  * @type {number}
  */
 var NUM_TITLE_LINES = 1;
 
-/**
- * Type of the impression provider for a generic client-provided suggestion.
- * @type {string}
- * @const
- */
-var CLIENT_PROVIDER_NAME = 'client';
-
-/**
- * Type of the impression provider for a generic server-provided suggestion.
- * @type {string}
- * @const
- */
-var SERVER_PROVIDER_NAME = 'server';
 
 /**
  * The origin of this request.
  * @const {string}
  */
 var DOMAIN_ORIGIN = '{{ORIGIN}}';
 
 
 /**
  * Counter for DOM elements that we are waiting to finish loading.
@@ skipping 24 matching lines @@
 
 /**
  * Log an event on the NTP.
  * @param {number} eventType Event from LOG_TYPE.
  */
 var logEvent = function(eventType) {
   chrome.embeddedSearch.newTabPage.logEvent(eventType);
 };
 
 /**
- * Log impression of a most visited tile on the NTP.
- * @param {number} tileIndex position of the tile, >= 0 and < NUMBER_OF_TILES
- * @param {string} provider specifies the UMA histogram to be reported
- *     (NewTabPage.SuggestionsImpression.{provider})
+ * Log impression of an NTP tile.
+ * @param {number} tileIndex Position of the tile, >= 0 and < NUMBER_OF_TILES.
+ * @param {number} tileSource The source from TILE_SOURCE.
  */
-function logMostVisitedImpression(tileIndex, provider) {
+function logMostVisitedImpression(tileIndex, tileSource) {
   chrome.embeddedSearch.newTabPage.logMostVisitedImpression(tileIndex,
-                                                            provider);
+                                                            tileSource);
 }
 
 /**
- * Log click on a most visited tile on the NTP.
- * @param {number} tileIndex position of the tile, >= 0 and < NUMBER_OF_TILES
- * @param {string} provider specifies the UMA histogram to be reported
- *     (NewTabPage.SuggestionsImpression.{provider})
+ * Log click on an NTP tile.
+ * @param {number} tileIndex Position of the tile, >= 0 and < NUMBER_OF_TILES.
+ * @param {number} tileSource The source from TILE_SOURCE.
  */
-function logMostVisitedNavigation(tileIndex, provider) {
+function logMostVisitedNavigation(tileIndex, tileSource) {
   chrome.embeddedSearch.newTabPage.logMostVisitedNavigation(tileIndex,
-                                                            provider);
+                                                            tileSource);
 }
 
 /**
  * Down counts the DOM elements that we are waiting for the page to load.
  * When we get to 0, we send a message to the parent window.
  * This is usually used as an EventListener of onload/onerror.
  */
 var countLoad = function() {
   loadedCounter -= 1;
   if (loadedCounter <= 0) {
@@ skipping 162 matching lines @@
  * @param {object} args Data for the tile to be rendered.
  */
 var addTile = function(args) {
   if (isFinite(args.rid)) {
     // If a valid number passed in |args.rid|: a local chrome suggestion.
     var data = chrome.embeddedSearch.searchBox.getMostVisitedItemData(args.rid);
     if (!data)
       return;
 
     data.tid = data.rid;
-    data.provider = CLIENT_PROVIDER_NAME;
+    data.tileSource = TILE_SOURCE.NTP_TILE_SOURCE_CLIENT;
     if (!data.faviconUrl) {
       data.faviconUrl = 'chrome-search://favicon/size/16@' +
           window.devicePixelRatio + 'x/' + data.renderViewId + '/' + data.tid;
     }
     logEvent(LOG_TYPE.NTP_CLIENT_SIDE_SUGGESTION);
     tiles.appendChild(renderTile(data));
   } else if (args.url) {
     // If a URL is passed: a server-side suggestion.
-    args.provider = args.provider || SERVER_PROVIDER_NAME;
+    args.tileSource = TILE_SOURCE.NTP_TILE_SOURCE_SERVER;
     // check sanity of the arguments
     if (/^javascript:/i.test(args.url) ||
-        /^javascript:/i.test(args.thumbnailUrl) ||
-        !/^[a-z0-9]{0,8}$/i.test(args.provider))
+        /^javascript:/i.test(args.thumbnailUrl))
       return;
     logEvent(LOG_TYPE.NTP_SERVER_SIDE_SUGGESTION);
     tiles.appendChild(renderTile(args));
   } else {  // an empty tile
     tiles.appendChild(renderTile(null));
   }
 };
 
 /**
  * Called when the user decided to add a tile to the blacklist.
@@ skipping 33 matching lines @@
   var tile = document.createElement('a');
 
   if (data == null) {
     tile.className = 'mv-empty-tile';
     return tile;
   }
 
   logEvent(LOG_TYPE.NTP_TILE);
   // The tile will be appended to tiles.
   var position = tiles.children.length;
-  if (data.provider) {
-    logMostVisitedImpression(position, data.provider);
-  }
+  logMostVisitedImpression(position, data.tileSource);
 
   tile.className = 'mv-tile';
   tile.setAttribute('data-tid', data.tid);
   var html = [];
   if (!USE_ICONS) {
     html.push('<div class="mv-favicon"></div>');
   }
   html.push('<div class="mv-title"></div><div class="mv-thumb"></div>');
   html.push('<div class="mv-x"></div>');
   tile.innerHTML = html.join('');
   tile.lastElementChild.title = queryArgs['removeTooltip'] || '';
 
   if (isSchemeAllowed(data.url)) {
     tile.href = data.url;
   }
   tile.title = data.title;
   if (data.impressionUrl) {
     impressionUrl = data.impressionUrl;
   }
   if (data.pingUrl) {
     tile.addEventListener('click', function(ev) {
       navigator.sendBeacon(data.pingUrl);
     });
   }
 
   tile.addEventListener('click', function(ev) {
-    if (data.provider) {
-      logMostVisitedNavigation(position, data.provider);
-    }
+    logMostVisitedNavigation(position, data.tileSource);
   });
 
   tile.addEventListener('keydown', function(event) {
     if (event.keyCode == 46 /* DELETE */ ||
         event.keyCode == 8 /* BACKSPACE */) {
       event.preventDefault();
       event.stopPropagation();
       blacklistTile(this);
     } else if (event.keyCode == 13 /* ENTER */ ||
                event.keyCode == 32 /* SPACE */) {
@@ skipping 208 matching lines @@
     var html = document.querySelector('html');
     html.dir = 'rtl';
   }
 
   window.addEventListener('message', handlePostMessage);
 };
 
 
 window.addEventListener('DOMContentLoaded', init);
 })();