Add UMA stats for which icon types are shown and clicked on the NTP.

chrome/android/java/src/org/chromium/chrome/browser/ntp/NewTabPageView.java

 // 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.
 
 package org.chromium.chrome.browser.ntp;
 
 import android.annotation.SuppressLint;
 import android.content.Context;
 import android.content.res.Resources;
 import android.graphics.Bitmap;
@@ skipping 14 matching lines @@
 import android.view.MotionEvent;
 import android.view.View;
 import android.view.View.OnLayoutChangeListener;
 import android.view.ViewGroup;
 import android.view.ViewStub;
 import android.widget.Button;
 import android.widget.FrameLayout;
 import android.widget.ImageView;
 import android.widget.TextView;
 
-import org.chromium.base.CommandLine;
-import org.chromium.base.FieldTrialList;
 import org.chromium.base.VisibleForTesting;
-import org.chromium.base.metrics.RecordHistogram;
 import org.chromium.chrome.R;
-import org.chromium.chrome.browser.ChromeSwitches;
 import org.chromium.chrome.browser.favicon.FaviconHelper.FaviconAvailabilityCallback;
 import org.chromium.chrome.browser.favicon.FaviconHelper.FaviconImageCallback;
 import org.chromium.chrome.browser.favicon.LargeIconBridge.LargeIconCallback;
 import org.chromium.chrome.browser.ntp.LogoBridge.Logo;
 import org.chromium.chrome.browser.ntp.LogoBridge.LogoObserver;
 import org.chromium.chrome.browser.ntp.MostVisitedItem.MostVisitedItemManager;
 import org.chromium.chrome.browser.ntp.NewTabPage.OnSearchBoxScrollListener;
 import org.chromium.chrome.browser.profiles.MostVisitedSites.MostVisitedURLsObserver;
 import org.chromium.chrome.browser.profiles.MostVisitedSites.ThumbnailCallback;
 import org.chromium.chrome.browser.util.ViewUtils;
 import org.chromium.chrome.browser.widget.RoundedIconGenerator;
 import org.chromium.ui.text.SpanApplier;
 import org.chromium.ui.text.SpanApplier.SpanInfo;
 
 import java.util.Locale;
 
 import jp.tomorrowkey.android.gifplayer.BaseGifImage;
 
 /**
  * The native new tab page, represented by some basic data such as title and url, and an Android
  * View that displays the page.
  */
 public class NewTabPageView extends FrameLayout
         implements MostVisitedURLsObserver, OnLayoutChangeListener {
 
     static final int MAX_MOST_VISITED_SITES = 12;
     private static final int SHADOW_COLOR = 0x11000000;
     private static final long SNAP_SCROLL_DELAY_MS = 30;
 
-    private static final String ICON_NTP_FIELD_TRIAL_NAME = "IconNTP";
-    private static final String ICON_NTP_ENABLED_GROUP = "Enabled";
-
     // Taken from https://support.google.com/googleplay/answer/1727131?hl=en-GB
     private static final String[] SUPPORTED_SAMSUNG_DEVICES = {
         "sm-g920", // Galaxy S6
         "sm-g925", // Galaxy S6 Edge
         "404sc",   // Galaxy S6 Edge
         "scv31",   // Galaxy S6 Edge
         "sm-g890", // Galaxy S6 Active
         "sm-g800", // Galaxy S5 mini
         "sm-g860", // Galaxy S5 K Sport
         "sm-g870", // Galaxy S5 Active
@@ skipping 125 matching lines @@
 
         /**
          * Gets the default search provider's logo and calls logoObserver with the result.
          * @param logoObserver The callback to notify when the logo is available.
          */
         void getSearchProviderLogo(LogoObserver logoObserver);
 
         /**
          * Called when the NTP has completely finished loading (all views will be inflated
          * and any dependent resources will have been loaded).
+         * @param mostVisitedItems The MostVisitedItem shown on the NTP. Used to record metrics.
          */
-        void onLoadingComplete();
+        void onLoadingComplete(MostVisitedItem[] mostVisitedItems);
     }
 
     /**
      * Returns a title suitable for display for a link (e.g. a most visited item). If |title| is
      * non-empty, this simply returns it. Otherwise, returns a shortened form of the URL.
      */
     static String getTitleForDisplay(String title, String url) {
         if (TextUtils.isEmpty(title) && url != null) {
             Uri uri = Uri.parse(url);
             String host = uri.getHost();
             String path = uri.getPath();
             if (host == null) host = "";
             if (TextUtils.isEmpty(path) || path.equals("/")) path = "";
             title = host + path;
         }
         return title;
     }
 
     /**
      * Default constructor required for XML inflation.
      */
     public NewTabPageView(Context context, AttributeSet attrs) {
         super(context, attrs);
     }
 
-    private boolean isIconNtpEnabled() {
-        // Query the field trial state first, to ensure that UMA reports the correct group.
-        String fieldTrialGroup = FieldTrialList.findFullName(ICON_NTP_FIELD_TRIAL_NAME);
-        CommandLine commandLine = CommandLine.getInstance();
-        if (commandLine.hasSwitch(ChromeSwitches.DISABLE_ICON_NTP)) return false;
-        if (commandLine.hasSwitch(ChromeSwitches.ENABLE_ICON_NTP)) return true;
-        return fieldTrialGroup.equals(ICON_NTP_ENABLED_GROUP);
-    }
-
     /**
      * Initializes the NTP. This must be called immediately after inflation, before this object is
      * used in any other way.
      *
      * @param manager NewTabPageManager used to perform various actions when the user interacts
      *                with the page.
      * @param isSingleUrlBarMode Whether the NTP is in single URL bar mode.
      * @param searchProviderHasLogo Whether the search provider has a logo.
+     * @param isIconMode Whether to show the icon-based design, as opposed to the thumbnail design.
      */
     public void initialize(NewTabPageManager manager, boolean isSingleUrlBarMode,
-            boolean searchProviderHasLogo) {
+            boolean searchProviderHasLogo, boolean isIconMode) {
         mManager = manager;
 
         mScrollView = (NewTabScrollView) findViewById(R.id.ntp_scrollview);
         mScrollView.enableBottomShadow(SHADOW_COLOR);
         mContentView = (ViewGroup) findViewById(R.id.ntp_content);
 
-        mMostVisitedDesign = isIconNtpEnabled()
+        mMostVisitedDesign = isIconMode
                 ? new IconMostVisitedDesign(getContext())
                 : new ThumbnailMostVisitedDesign(getContext());
         ViewStub mostVisitedLayoutStub = (ViewStub) findViewById(R.id.most_visited_layout_stub);
         mostVisitedLayoutStub.setLayoutResource(mMostVisitedDesign.getMostVisitedLayoutId());
         mMostVisitedLayout = (ViewGroup) mostVisitedLayoutStub.inflate();
         mMostVisitedDesign.initMostVisitedLayout(mMostVisitedLayout, searchProviderHasLogo);
 
         mSearchProviderLogoView = (LogoView) findViewById(R.id.search_provider_logo);
         mSearchBoxView = findViewById(R.id.search_box);
         mNoSearchLogoSpacer = findViewById(R.id.no_search_logo_spacer);
@@ skipping 188 matching lines @@
      * is complete.
      */
     private void loadTaskCompleted() {
         assert mPendingLoadTasks > 0;
         mPendingLoadTasks--;
         if (mPendingLoadTasks == 0) {
             if (mLoadHasCompleted) {
                 assert false;
             } else {
                 mLoadHasCompleted = true;
-                mManager.onLoadingComplete();
-                mMostVisitedDesign.onLoadingComplete();
+                mManager.onLoadingComplete(mMostVisitedItems);
                 // Load the logo after everything else is finished, since it's lower priority.
                 loadSearchProviderLogo();
             }
         }
     }
 
     /**
      * Loads the search provider logo (e.g. Google doodle), if any.
      */
     private void loadSearchProviderLogo() {
@@ skipping 274 matching lines @@
                     item = oldItem;
                     item.setIndex(i);
                     oldItems[j] = null;
                     break;
                 }
             }
 
             // If nothing can be reused, create a new item.
             if (item == null) {
                 String displayTitle = getTitleForDisplay(title, url);
+                item = new MostVisitedItem(mManager, title, url, i);
                 View view = mMostVisitedDesign.createMostVisitedItemView(inflater, url, title,
-                        displayTitle, i, isInitialLoad);
-                item = new MostVisitedItem(mManager, title, url, i, view);
+                        displayTitle, item, isInitialLoad);
+                item.initView(view);
             }
 
             mMostVisitedItems[i] = item;
             mMostVisitedLayout.addView(item.getView());
         }
 
         mHasReceivedMostVisitedSites = true;
         updateMostVisitedPlaceholderVisibility();
 
         if (isInitialLoad) {
@@ skipping 57 matching lines @@
      * Interface for creating the most visited layout and tiles.
      * TODO(newt): delete this once a single design has been chosen.
      */
     private interface MostVisitedDesign {
         int getNumberOfTiles(boolean searchProviderHasLogo);
         int getMostVisitedLayoutId();
         int getMostVisitedLayoutBleed();
         void initMostVisitedLayout(ViewGroup mostVisitedLayout, boolean searchProviderHasLogo);
         void setSearchProviderHasLogo(View mostVisitedLayout, boolean hasLogo);
         View createMostVisitedItemView(LayoutInflater inflater, String url, String title,
-                String displayTitle, int index, boolean isInitialLoad);
+                String displayTitle, MostVisitedItem item, boolean isInitialLoad);
         void onFaviconUpdated(String url);
-        void onLoadingComplete();
     }
 
     /**
      * The old most visited design, where each tile shows a thumbnail of the page, a small favicon,
      * and the title.
      */
     private class ThumbnailMostVisitedDesign implements MostVisitedDesign {
 
         private static final int NUM_TILES = 6;
         private static final int FAVICON_CORNER_RADIUS_DP = 2;
@@ skipping 31 matching lines @@
         @Override
         public void initMostVisitedLayout(ViewGroup mostVisitedLayout,
                 boolean searchProviderHasLogo) {
         }
 
         @Override
         public void setSearchProviderHasLogo(View mostVisitedLayout, boolean hasLogo) {}
 
         @Override
         public View createMostVisitedItemView(LayoutInflater inflater, final String url,
-                String title, String displayTitle, int index, final boolean isInitialLoad) {
+                String title, String displayTitle, final MostVisitedItem item,
+                final boolean isInitialLoad) {
             final MostVisitedItemView view = (MostVisitedItemView) inflater.inflate(
                     R.layout.most_visited_item, mMostVisitedLayout, false);
             view.init(displayTitle);
 
             ThumbnailCallback thumbnailCallback = new ThumbnailCallback() {
                 @Override
-                public void onMostVisitedURLsThumbnailAvailable(Bitmap thumbnail) {
+                public void onMostVisitedURLsThumbnailAvailable(Bitmap thumbnail,
+                        boolean isLocalThumbnail) {
                     view.setThumbnail(thumbnail);
+                    if (thumbnail == null) {
+                        item.setTileType(MostVisitedTileType.THUMBNAIL_DEFAULT);
+                    } else if (isLocalThumbnail) {
+                        item.setTileType(MostVisitedTileType.THUMBNAIL_LOCAL);
+                    } else {
+                        item.setTileType(MostVisitedTileType.THUMBNAIL_SERVER);
+                    }
                     mSnapshotMostVisitedChanged = true;
                     if (isInitialLoad) loadTaskCompleted();
                 }
             };
             if (isInitialLoad) mPendingLoadTasks++;
             mManager.getURLThumbnail(url, thumbnailCallback);
 
             FaviconImageCallback faviconCallback = new FaviconImageCallback() {
                 @Override
                 public void onFaviconAvailable(Bitmap image, String iconUrl) {
@@ skipping 25 matching lines @@
                             image = mFaviconGenerator.generateIconForUrl(url);
                         }
                         view.setFavicon(image);
                         mSnapshotMostVisitedChanged = true;
                     }
                 };
                 mManager.getLocalFaviconImageForURL(url, mDesiredFaviconSize, faviconCallback);
                 break;
             }
         }
-
-        @Override
-        public void onLoadingComplete() {}
     }
 
     /**
      * The new-fangled design for most visited tiles, where each tile shows a large icon and title.
      */
     private class IconMostVisitedDesign implements MostVisitedDesign {
 
         private static final int NUM_TILES = 8;
         private static final int NUM_TILES_NO_LOGO = 12;
         private static final int MAX_ROWS = 2;
         private static final int MAX_ROWS_NO_LOGO = 3;
 
         private static final int ICON_CORNER_RADIUS_DP = 4;
         private static final int ICON_TEXT_SIZE_DP = 20;
         private static final int ICON_BACKGROUND_COLOR = 0xff787878;
         private static final int ICON_MIN_SIZE_PX = 48;
 
         private int mMostVisitedLayoutBleed;
         private int mMinIconSize;
         private int mDesiredIconSize;
         private RoundedIconGenerator mIconGenerator;
 
-        private int mNumGrayIcons;
-        private int mNumColorIcons;
-        private int mNumRealIcons;
-
         IconMostVisitedDesign(Context context) {
             Resources res = context.getResources();
             mMostVisitedLayoutBleed = res.getDimensionPixelSize(
                     R.dimen.icon_most_visited_layout_bleed);
             mDesiredIconSize = res.getDimensionPixelSize(R.dimen.icon_most_visited_icon_size);
             // On ldpi devices, mDesiredIconSize could be even smaller than ICON_MIN_SIZE_PX.
             mMinIconSize = Math.min(mDesiredIconSize, ICON_MIN_SIZE_PX);
             int desiredIconSizeDp = Math.round(
                     mDesiredIconSize / res.getDisplayMetrics().density);
             mIconGenerator = new RoundedIconGenerator(
@@ skipping 25 matching lines @@
 
         @Override
         public void setSearchProviderHasLogo(View mostVisitedLayout, boolean hasLogo) {
             int paddingTop = getResources().getDimensionPixelSize(hasLogo
                     ? R.dimen.icon_most_visited_layout_padding_top
                     : R.dimen.icon_most_visited_layout_no_logo_padding_top);
             mostVisitedLayout.setPadding(0, paddingTop, 0, 0);
         }
 
         class LargeIconCallbackImpl implements LargeIconCallback {
-            private String mUrl;
-            private IconMostVisitedItemView mView;
+            private MostVisitedItem mItem;
             private boolean mIsInitialLoad;
 
-            public LargeIconCallbackImpl(String url, IconMostVisitedItemView view,
-                    boolean isInitialLoad) {
-                mUrl = url;
-                mView = view;
+            public LargeIconCallbackImpl(MostVisitedItem item, boolean isInitialLoad) {
+                mItem = item;
                 mIsInitialLoad = isInitialLoad;
             }
 
             @Override
             public void onLargeIconAvailable(Bitmap icon, int fallbackColor) {
+                IconMostVisitedItemView view = (IconMostVisitedItemView) mItem.getView();
                 if (icon == null) {
                     mIconGenerator.setBackgroundColor(fallbackColor);
-                    icon = mIconGenerator.generateIconForUrl(mUrl);
-                    mView.setIcon(new BitmapDrawable(getResources(), icon));
-                    if (mIsInitialLoad) {
-                        if (fallbackColor == ICON_BACKGROUND_COLOR) {
-                            mNumGrayIcons++;
-                        } else {
-                            mNumColorIcons++;
-                        }
-                    }
+                    icon = mIconGenerator.generateIconForUrl(mItem.getUrl());
+                    view.setIcon(new BitmapDrawable(getResources(), icon));
+                    mItem.setTileType(fallbackColor == ICON_BACKGROUND_COLOR
+                            ? MostVisitedTileType.ICON_DEFAULT : MostVisitedTileType.ICON_COLOR);
                 } else {
                     RoundedBitmapDrawable roundedIcon = RoundedBitmapDrawableFactory.create(
                             getResources(), icon);
                     int cornerRadius = Math.round(ICON_CORNER_RADIUS_DP
                             * getResources().getDisplayMetrics().density * icon.getWidth()
                             / mDesiredIconSize);
                     roundedIcon.setCornerRadius(cornerRadius);
                     roundedIcon.setAntiAlias(true);
                     roundedIcon.setFilterBitmap(true);
-                    mView.setIcon(roundedIcon);
-                    if (mIsInitialLoad) mNumRealIcons++;
+                    view.setIcon(roundedIcon);
+                    mItem.setTileType(MostVisitedTileType.ICON_REAL);
                 }
                 mSnapshotMostVisitedChanged = true;
                 if (mIsInitialLoad) loadTaskCompleted();
             }
-        };
+        }
 
         @Override
         public View createMostVisitedItemView(LayoutInflater inflater, final String url,
-                String title, String displayTitle, int index, final boolean isInitialLoad) {
+                String title, String displayTitle, MostVisitedItem item,
+                final boolean isInitialLoad) {
             final IconMostVisitedItemView view = (IconMostVisitedItemView) inflater.inflate(
                     R.layout.icon_most_visited_item, mMostVisitedLayout, false);
             view.setTitle(displayTitle);
 
-            LargeIconCallback iconCallback = new LargeIconCallbackImpl(url, view, isInitialLoad);
+            LargeIconCallback iconCallback = new LargeIconCallbackImpl(item, isInitialLoad);
             if (isInitialLoad) mPendingLoadTasks++;
             mManager.getLargeIconForUrl(url, mMinIconSize, iconCallback);
 
             return view;
         }
 
         @Override
         public void onFaviconUpdated(final String url) {
             // Find a matching most visited item.
             for (MostVisitedItem item : mMostVisitedItems) {
-                if (!item.getUrl().equals(url)) continue;
-
-                final IconMostVisitedItemView view = (IconMostVisitedItemView) item.getView();
-                LargeIconCallback iconCallback = new LargeIconCallbackImpl(url, view, false);
-                mManager.getLargeIconForUrl(url, mMinIconSize, iconCallback);
-                break;
+                if (item.getUrl().equals(url)) {
+                    LargeIconCallback iconCallback = new LargeIconCallbackImpl(item, false);
+                    mManager.getLargeIconForUrl(url, mMinIconSize, iconCallback);
+                    break;
+                }
             }
         }
-
-        @Override
-        public void onLoadingComplete() {
-            RecordHistogram.recordCount100Histogram("NewTabPage.IconsGray", mNumGrayIcons);
-            RecordHistogram.recordCount100Histogram("NewTabPage.IconsColor", mNumColorIcons);
-            RecordHistogram.recordCount100Histogram("NewTabPage.IconsReal", mNumRealIcons);
-        }
     }
 }