[Content suggestions] Add a function to the service API to fetch favicons

chrome/test/android/javatests/src/org/chromium/chrome/test/util/browser/suggestions/FakeSuggestionsSource.java

 // Copyright 2016 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.test.util.browser.suggestions;
 
 import android.graphics.Bitmap;
 
 import org.chromium.base.Callback;
 import org.chromium.chrome.browser.ntp.cards.SuggestionsCategoryInfo;
@@ skipping 14 matching lines @@
 /**
  * A fake Suggestions source for use in unit and instrumentation tests.
  */
 public class FakeSuggestionsSource implements SuggestionsSource {
     private SuggestionsSource.Observer mObserver;
     private final List<Integer> mCategories = new ArrayList<>();
     private final Map<Integer, List<SnippetArticle>> mSuggestions = new HashMap<>();
     private final Map<Integer, Integer> mCategoryStatus = new LinkedHashMap<>();
     private final Map<Integer, SuggestionsCategoryInfo> mCategoryInfo = new HashMap<>();
     private final Map<String, Bitmap> mThumbnails = new HashMap<>();
+    private final Map<String, Bitmap> mFavicons = new HashMap<>();

[Michael van Ouwerkerk, 2017/03/28 11:23:56]

Please document what the String represents.

[jkrcal, 2017/03/28 13:12:53]

Done.

 
     private final List<Integer> mDismissedCategories = new ArrayList<>();
     private final Map<Integer, List<SnippetArticle>> mDismissedCategorySuggestions =
             new HashMap<>();
     private final Map<Integer, Integer> mDismissedCategoryStatus = new LinkedHashMap<>();
     private final Map<Integer, SuggestionsCategoryInfo> mDismissedCategoryInfo = new HashMap<>();
 
     /**
      * Sets the status to be returned for a given category.
      */
@@ skipping 25 matching lines @@
     }
 
     /**
      * Sets the bitmap to be returned when the thumbnail is requested for a snippet with that id.
      */
     public void setThumbnailForId(String id, Bitmap bitmap) {
         mThumbnails.put(id, bitmap);
     }
 
     /**
+     * Sets the bitmap to be returned when the favicon is requested for a snippet with that id.

[Michael van Ouwerkerk, 2017/03/28 11:23:56]

We're trying to move away from this use of the word "snippet", correct? Then
maybe use "suggestion" here and in the documentation for setThumbnailForId.

[jkrcal, 2017/03/28 13:12:53]

Done.

+     */
+    public void setFaviconForId(String id, Bitmap bitmap) {
+        mFavicons.put(id, bitmap);
+    }
+
+    /**
      * Removes the given suggestion from the source and notifies any observer that it has been
      * invalidated.
      */
     public void fireSuggestionInvalidated(@CategoryInt int category, String idWithinCategory) {
         for (SnippetArticle suggestion : mSuggestions.get(category)) {
             if (suggestion.mIdWithinCategory.equals(idWithinCategory)) {
                 mSuggestions.get(category).remove(suggestion);
                 break;
             }
         }
@@ skipping 48 matching lines @@
     }
 
     @Override
     public void fetchSuggestionImage(SnippetArticle suggestion, Callback<Bitmap> callback) {
         if (mThumbnails.containsKey(suggestion.mIdWithinCategory)) {
             callback.onResult(mThumbnails.get(suggestion.mIdWithinCategory));
         }
     }
 
     @Override
+    public void fetchSuggestionFavicon(SnippetArticle suggestion, int minimumSizeInPixel,
+            int desiredSizeInPixel, Callback<Bitmap> callback) {
+        if (mFavicons.containsKey(suggestion.mIdWithinCategory)) {
+            callback.onResult(mFavicons.get(suggestion.mIdWithinCategory));

[Michael van Ouwerkerk, 2017/03/28 11:23:56]

The documentation for fetchSuggestionFavicon explicitly states the callback is
never called synchronously, can you implement that in this fake also?

[jkrcal, 2017/03/28 13:12:53]

Done.

+        }
+    }
+
+    @Override
     public void fetchSuggestions(@CategoryInt int category, String[] displayedSuggestionIds) {
         throw new UnsupportedOperationException();
     }
 
     @Override
     public void setObserver(Observer observer) {
         mObserver = observer;
     }
 
     @Override
@@ skipping 17 matching lines @@
 
     @Override
     public List<SnippetArticle> getSuggestionsForCategory(int category) {
         if (!SnippetsBridge.isCategoryStatusAvailable(mCategoryStatus.get(category))) {
             return Collections.emptyList();
         }
         List<SnippetArticle> result = mSuggestions.get(category);
         return result == null ? Collections.<SnippetArticle>emptyList() : new ArrayList<>(result);
     }
 }