📰 Tweak the suggestion ranks for UMA to handle fetchMore

chrome/android/java/src/org/chromium/chrome/browser/ntp/snippets/SnippetsBridge.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.browser.ntp.snippets;
 
 import android.graphics.Bitmap;
 
 import org.chromium.base.Callback;
 import org.chromium.base.annotations.CalledByNative;
 import org.chromium.chrome.browser.ntp.cards.SuggestionsCategoryInfo;
 import org.chromium.chrome.browser.ntp.snippets.CategoryStatus.CategoryStatusEnum;
 import org.chromium.chrome.browser.profiles.Profile;
+import org.chromium.chrome.browser.suggestions.SuggestionsUma;
 
 import java.util.ArrayList;
 import java.util.List;
 
 /**
  * Provides access to the snippets to display on the NTP using the C++ ContentSuggestionsService.
  */
 public class SnippetsBridge implements SuggestionsSource {
     private static final String TAG = "SnippetsBridge";
 
     private long mNativeSnippetsBridge;
     private SuggestionsSource.Observer mObserver;
+    private SuggestionsUma mUmaHelper;

[Bernhard Bauer, 2017/01/11 13:53:38]

I think I would make this an interface and have SectionList directly implement
it.

[dgn, 2017/01/12 14:29:58]

Done.

 
     public static boolean isCategoryStatusAvailable(@CategoryStatusEnum int status) {
         // Note: This code is duplicated in content_suggestions_category_status.cc.
         return status == CategoryStatus.AVAILABLE_LOADING || status == CategoryStatus.AVAILABLE;
     }
 
     /** Returns whether the category is considered "enabled", and can show content suggestions. */
     public static boolean isCategoryEnabled(@CategoryStatusEnum int status) {
         switch (status) {
             case CategoryStatus.INITIALIZING:
@@ skipping 76 matching lines @@
     @Override
     public void fetchSuggestionImage(SnippetArticle suggestion, Callback<Bitmap> callback) {
         assert mNativeSnippetsBridge != 0;
         nativeFetchSuggestionImage(mNativeSnippetsBridge, suggestion.mCategory,
                 suggestion.mIdWithinCategory, callback);
     }
 
     @Override
     public void dismissSuggestion(SnippetArticle suggestion) {
         assert mNativeSnippetsBridge != 0;
-        nativeDismissSuggestion(mNativeSnippetsBridge, suggestion.mUrl, suggestion.mGlobalPosition,
-                suggestion.mCategory, suggestion.mPosition, suggestion.mIdWithinCategory);
+        int suggestionRank = mUmaHelper.getSuggestionRank(suggestion);

[Bernhard Bauer, 2017/01/11 13:53:38]

If getSuggestionRank returns -1 when the suggestion is not found, assert against
that at the call site?

[dgn, 2017/01/12 14:29:58]

Done.

+        int suggestionGlobalRank = mUmaHelper.getSuggestionGlobalRank(suggestion, suggestionRank);
+        nativeDismissSuggestion(mNativeSnippetsBridge, suggestion.mUrl, suggestionGlobalRank,
+                suggestion.mCategory, suggestionRank, suggestion.mIdWithinCategory);
     }
 
     @Override
     public void dismissCategory(@CategoryInt int category) {
         assert mNativeSnippetsBridge != 0;
         nativeDismissCategory(mNativeSnippetsBridge, category);
     }
 
     @Override
     public void restoreDismissedCategories() {
         assert mNativeSnippetsBridge != 0;
         nativeRestoreDismissedCategories(mNativeSnippetsBridge);
     }
 
     public void onPageShown(int[] categories, int[] suggestionsPerCategory) {
         assert mNativeSnippetsBridge != 0;
         nativeOnPageShown(mNativeSnippetsBridge, categories, suggestionsPerCategory);
     }
 
     public void onSuggestionShown(SnippetArticle suggestion) {
         assert mNativeSnippetsBridge != 0;
-        nativeOnSuggestionShown(mNativeSnippetsBridge, suggestion.mGlobalPosition,
-                suggestion.mCategory, suggestion.mPosition,
-                suggestion.mPublishTimestampMilliseconds, suggestion.mScore);
+        int suggestionRank = mUmaHelper.getSuggestionRank(suggestion);
+        int suggestionGlobalRank = mUmaHelper.getSuggestionGlobalRank(suggestion, suggestionRank);
+        nativeOnSuggestionShown(mNativeSnippetsBridge, suggestionGlobalRank, suggestion.mCategory,
+                suggestionRank, suggestion.mPublishTimestampMilliseconds, suggestion.mScore);
     }
 
     public void onSuggestionOpened(SnippetArticle suggestion, int windowOpenDisposition) {
         assert mNativeSnippetsBridge != 0;
-        nativeOnSuggestionOpened(mNativeSnippetsBridge, suggestion.mGlobalPosition,
-                suggestion.mCategory, suggestion.mPosition,
-                suggestion.mPublishTimestampMilliseconds, suggestion.mScore, windowOpenDisposition);
+        int suggestionRank = mUmaHelper.getSuggestionRank(suggestion);
+        int suggestionGlobalRank = mUmaHelper.getSuggestionGlobalRank(suggestion, suggestionRank);
+        nativeOnSuggestionOpened(mNativeSnippetsBridge, suggestionGlobalRank, suggestion.mCategory,
+                suggestionRank, suggestion.mPublishTimestampMilliseconds, suggestion.mScore,
+                windowOpenDisposition);
     }
 
     public void onSuggestionMenuOpened(SnippetArticle suggestion) {
         assert mNativeSnippetsBridge != 0;
-        nativeOnSuggestionMenuOpened(mNativeSnippetsBridge, suggestion.mGlobalPosition,
-                suggestion.mCategory, suggestion.mPosition,
-                suggestion.mPublishTimestampMilliseconds, suggestion.mScore);
+        int suggestionRank = mUmaHelper.getSuggestionRank(suggestion);
+        int suggestionGlobalRank = mUmaHelper.getSuggestionGlobalRank(suggestion, suggestionRank);
+        nativeOnSuggestionMenuOpened(mNativeSnippetsBridge, suggestionGlobalRank,
+                suggestion.mCategory, suggestionRank, suggestion.mPublishTimestampMilliseconds,
+                suggestion.mScore);
     }
 
     public void onMoreButtonShown(int category, int position) {
         assert mNativeSnippetsBridge != 0;
         nativeOnMoreButtonShown(mNativeSnippetsBridge, category, position);
     }
 
     public void onMoreButtonClicked(int category, int position) {
         assert mNativeSnippetsBridge != 0;
         nativeOnMoreButtonClicked(mNativeSnippetsBridge, category, position);
@@ skipping 14 matching lines @@
 
     public static void notifySchedulerAboutColdStart() {
         SnippetsBridge snippetsBridge = new SnippetsBridge(Profile.getLastUsedProfile());
         snippetsBridge.onColdStart();
     }
 
     public static void onSuggestionTargetVisited(int category, long visitTimeMs) {
         nativeOnSuggestionTargetVisited(category, visitTimeMs);
     }
 
-    /**
-     * Sets the recipient for the fetched snippets.
-     *
-     * An observer needs to be set before the native code attempts to transmit snippets them to
-     * java. Upon registration, the observer will be notified of already fetched snippets.
-     *
-     * @param observer object to notify when snippets are received.
-     */
     @Override
-    public void setObserver(SuggestionsSource.Observer observer) {
+    public void init(SuggestionsSource.Observer observer, SuggestionsUma umaHelper) {
         assert observer != null;
         mObserver = observer;
+
+        assert mUmaHelper == null;

[Bernhard Bauer, 2017/01/11 13:53:38]

TBH, I kind of like keeping simple set methods that don't do anything fancy.
It's not really necessary to set both the observer and the helper at the same
time, so we could just have them be two separate methods.

[dgn, 2017/01/12 14:29:58]

Done.

+        mUmaHelper = umaHelper;
     }
 
     @Override
     public void fetchSuggestions(@CategoryInt int category, String[] displayedSuggestionIds) {
         nativeFetch(mNativeSnippetsBridge, category, displayedSuggestionIds);
     }
 
     private void onActivityWarmResumed() {
         assert mNativeSnippetsBridge != 0;
         nativeOnActivityWarmResumed(mNativeSnippetsBridge);
     }
 
     private void onColdStart() {
         assert mNativeSnippetsBridge != 0;
         nativeOnColdStart(mNativeSnippetsBridge);
     }
 
     @CalledByNative
     private static List<SnippetArticle> createSuggestionList() {
         return new ArrayList<>();
     }
 
     @CalledByNative
     private static SnippetArticle addSuggestion(List<SnippetArticle> suggestions, int category,
             String id, String title, String publisher, String previewText, String url,
             long timestamp, float score) {
         int position = suggestions.size();
         suggestions.add(new SnippetArticle(
-                category, id, title, publisher, previewText, url, timestamp, score, position));
+                category, id, title, publisher, previewText, url, timestamp, score));
         return suggestions.get(position);
     }
 
     @CalledByNative
     private static void setAssetDownloadDataForSuggestion(
             SnippetArticle suggestion, String filePath, String mimeType) {
         suggestion.setAssetDownloadData(filePath, mimeType);
     }
 
     @CalledByNative
@@ skipping 73 matching lines @@
             float score);
     private native void nativeOnMoreButtonShown(
             long nativeNTPSnippetsBridge, int category, int position);
     private native void nativeOnMoreButtonClicked(
             long nativeNTPSnippetsBridge, int category, int position);
     private native void nativeOnActivityWarmResumed(long nativeNTPSnippetsBridge);
     private native void nativeOnColdStart(long nativeNTPSnippetsBridge);
     private static native void nativeOnSuggestionTargetVisited(int category, long visitTimeMs);
     private static native void nativeOnNTPInitialized(long nativeNTPSnippetsBridge);
 }