[Most Visited] Log suggestion provider to UMA

chrome/browser/resources/local_ntp/most_visited_util.js

 // Copyright 2013 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.
 
 
 /**
  * @fileoverview Utilities for rendering most visited thumbnails and titles.
  */
 
 <include src="instant_iframe_validation.js">
@@ skipping 18 matching lines @@
   // secondary thumbnail as a fallback.
   NTP_FALLBACK_THUMBNAIL_USED: 4,
   // The suggestion is coming from the server.
   NTP_SERVER_SIDE_SUGGESTION: 5,
   // The suggestion is coming from the client.
   NTP_CLIENT_SIDE_SUGGESTION: 6,
   // The visuals of that tile are handled externally by the page itself.
   NTP_EXTERNAL_TILE: 7
 };
 
+/** @type {string} Indicating the suggestion came from the server. */
+var SERVER_PROVIDER = 'server';
+
+/** @type {string} Indicating the suggestions came from the client. */
+var CLIENT_PROVIDER = 'client';
+
 /**
  * Parses query parameters from Location.
  * @param {string} location The URL to generate the CSS url for.
  * @return {Object} Dictionary containing name value pairs for URL.
  */
 function parseQueryParams(location) {
   var params = Object.create(null);
   var query = location.search.substring(1);
   var vars = query.split('&');
   for (var i = 0; i < vars.length; i++) {
@@ skipping 14 matching lines @@
 
 /**
  * Creates a new most visited link element.
  * @param {Object} params URL parameters containing styles for the link.
  * @param {string} href The destination for the link.
  * @param {string} title The title for the link.
  * @param {string|undefined} text The text for the link or none.
  * @param {string|undefined} ping If specified, a location relative to the
  *     referrer of this iframe, to ping when the link is clicked. Only works if
  *     the referrer is HTTPS.
+ * @param {string|undefined} provider A provider name (max 8 alphanumeric
+ *     characters) used for logging. Undefined if suggestion is not coming from
+ *     the server.
  * @return {HTMLAnchorElement} A new link element.
  */
-function createMostVisitedLink(params, href, title, text, ping) {
+function createMostVisitedLink(params, href, title, text, ping, provider) {
   var styles = getMostVisitedStyles(params, !!text);
   var link = document.createElement('a');
   link.style.color = styles.color;
   link.style.fontSize = styles.fontSize + 'px';
   if (styles.fontFamily)
     link.style.fontFamily = styles.fontFamily;
   link.href = href;
   if ('pos' in params && isFinite(params.pos)) {
     link.ping = '/log.html?pos=' + params.pos;
+    if (provider)
+      link.ping += '&pr=' + provider;
     // If a ping parameter was specified, add it to the list of pings, relative
     // to the referrer of this iframe, which is the default search provider.
     if (ping) {
       var parentUrl = document.createElement('a');
       parentUrl.href = document.referrer;
       if (parentUrl.protocol == 'https:') {
         link.ping += ' ' + parentUrl.origin + '/' + ping;
       }
     }
   }
@@ skipping 60 matching lines @@
   var data = {};
   if (params.url) {
     // Means that the suggestion data comes from the server. Create data object.
     data.url = params.url;
     data.thumbnailUrl = params.tu || '';
     data.thumbnailUrl2 = params.tu2 || '';
     data.title = params.ti || '';
     data.direction = params.di || '';
     data.domain = params.dom || '';
     data.ping = params.ping || '';
+    data.provider = params.pr || SERVER_PROVIDER;
     // Log the fact that suggestion was obtained from the server.
     var ntpApiHandle = chrome.embeddedSearch.newTabPage;
     ntpApiHandle.logEvent(NTP_LOGGING_EVENT_TYPE.NTP_SERVER_SIDE_SUGGESTION);
   } else {
     var apiHandle = chrome.embeddedSearch.searchBox;
     data = apiHandle.getMostVisitedItemData(params.rid);
     if (!data)
       return;
+    data.provider = CLIENT_PROVIDER;
     delete data.ping;
   }
   if (/^javascript:/i.test(data.url) ||
       /^javascript:/i.test(data.thumbnailUrl) ||
-      /^javascript:/i.test(data.thumbnailUrl2))
+      /^javascript:/i.test(data.thumbnailUrl2) ||
+      !/^[a-z0-9]{0,8}$/i.test(data.provider))

[Jered, 2013/12/13 19:39:38]

/^[a-z0-9]{0,8}$/i.test(undefined) is false. Did you mean for the "0" to catch
the case where provider is undefined?

[Mathieu, 2013/12/13 20:00:38]

From the if..else above it should never be undefined, which is why I removed my
original condition of 

(data.provider && !/^[a-z0-9]{0,8}$/i.test(data.provider))

But let me know if you feel strongly about this.

     return;
   if (data.direction)
     document.body.dir = data.direction;
   fill(params, data);
 }