🏠 Extract the ContentSuggestionManager interface from NTP

chrome/android/java/src/org/chromium/chrome/browser/ntp/cards/SuggestionsSection.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.cards;
 
 import org.chromium.base.Callback;
 import org.chromium.base.Log;
 import org.chromium.base.VisibleForTesting;
 import org.chromium.chrome.browser.ntp.NewTabPage.DestructionObserver;
-import org.chromium.chrome.browser.ntp.NewTabPageView.NewTabPageManager;
 import org.chromium.chrome.browser.ntp.snippets.CategoryInt;
 import org.chromium.chrome.browser.ntp.snippets.CategoryStatus.CategoryStatusEnum;
 import org.chromium.chrome.browser.ntp.snippets.SectionHeader;
 import org.chromium.chrome.browser.ntp.snippets.SnippetArticle;
 import org.chromium.chrome.browser.ntp.snippets.SnippetArticleViewHolder;
 import org.chromium.chrome.browser.ntp.snippets.SnippetsBridge;
 import org.chromium.chrome.browser.ntp.snippets.SuggestionsSource;
 import org.chromium.chrome.browser.offlinepages.ClientId;
 import org.chromium.chrome.browser.offlinepages.OfflinePageBridge;
 import org.chromium.chrome.browser.offlinepages.OfflinePageItem;
 import org.chromium.chrome.browser.suggestions.SuggestionsRanker;
+import org.chromium.chrome.browser.suggestions.SuggestionsUiDelegate;
 
 import java.util.ArrayList;
 import java.util.Iterator;
 import java.util.List;
 
 /**
  * A group of suggestions, with a header, a status card, and a progress indicator. This is
  * responsible for tracking whether its suggestions have been saved offline.
  */
 public class SuggestionsSection extends InnerNode {
@@ skipping 20 matching lines @@
     private boolean mSubsequentSuggestionsSeen;
 
     /**
      * Delegate interface that allows dismissing this section without introducing
      * a circular dependency.
      */
     public interface Delegate {
         void dismissSection(SuggestionsSection section);
     }
 
-    public SuggestionsSection(Delegate delegate, NewTabPageManager manager,
+    public SuggestionsSection(Delegate delegate, SuggestionsUiDelegate uiDelegate,
             SuggestionsRanker ranker, OfflinePageBridge offlinePageBridge,
             SuggestionsCategoryInfo info) {
         mDelegate = delegate;
         mCategoryInfo = info;
         mOfflinePageBridge = offlinePageBridge;
 
         mHeader = new SectionHeader(info.getTitle());
-        mSuggestionsList = new SuggestionsList(manager, ranker, info);
+        mSuggestionsList = new SuggestionsList(uiDelegate, ranker, info);
         mStatus = StatusItem.createNoSuggestionsItem(info);
         mMoreButton = new ActionItem(this, ranker);
         mProgressIndicator = new ProgressItem();
         addChildren(mHeader, mSuggestionsList, mStatus, mMoreButton, mProgressIndicator);
 
-        setupOfflinePageBridgeObserver(manager);
+        setupOfflinePageBridgeObserver(uiDelegate);
         refreshChildrenVisibility();
     }
 
     private static class SuggestionsList extends ChildNode implements Iterable<SnippetArticle> {
         private final List<SnippetArticle> mSuggestions = new ArrayList<>();
-        private final NewTabPageManager mNewTabPageManager;
+
+        // TODO(crbug.com/677672): Replace by SuggestionSource when it handles destruction.
+        private final SuggestionsUiDelegate mUiDelegate;
         private final SuggestionsRanker mSuggestionsRanker;
         private final SuggestionsCategoryInfo mCategoryInfo;
 
-        public SuggestionsList(NewTabPageManager newTabPageManager,
-                SuggestionsRanker ranker, SuggestionsCategoryInfo categoryInfo) {
-            mNewTabPageManager = newTabPageManager;
+        public SuggestionsList(SuggestionsUiDelegate uiDelegate, SuggestionsRanker ranker,
+                SuggestionsCategoryInfo categoryInfo) {
+            mUiDelegate = uiDelegate;
             mSuggestionsRanker = ranker;
             mCategoryInfo = categoryInfo;
         }
 
         @Override
         public int getItemCount() {
             return mSuggestions.size();
         }
 
         @Override
@@ skipping 59 matching lines @@
         }
 
         @Override
         public Iterator<SnippetArticle> iterator() {
             return mSuggestions.iterator();
         }
 
         @Override
         public void dismissItem(int position, Callback<String> itemRemovedCallback) {
             checkIndex(position);
-            SuggestionsSource suggestionsSource = mNewTabPageManager.getSuggestionsSource();
+            SuggestionsSource suggestionsSource = mUiDelegate.getSuggestionsSource();
             if (suggestionsSource == null) {
                 // It is possible for this method to be called after the NewTabPage has had
                 // destroy() called. This can happen when
                 // NewTabPageRecyclerView.dismissWithAnimation() is called and the animation ends
                 // after the user has navigated away. In this case we cannot inform the native side
                 // that the snippet has been dismissed (http://crbug.com/649299).
                 return;
             }
 
             SnippetArticle suggestion = remove(position);
             suggestionsSource.dismissSuggestion(suggestion);
             itemRemovedCallback.onResult(suggestion.mTitle);
         }
 
         public void updateSuggestionOfflineId(SnippetArticle article, Long newId) {
             int index = mSuggestions.indexOf(article);
             // The suggestions could have been removed / replaced in the meantime.
             if (index == -1) return;
 
             Long oldId = article.getOfflinePageOfflineId();
             article.setOfflinePageOfflineId(newId);
 
             if ((oldId == null) == (newId == null)) return;
             notifyItemChanged(index, SnippetArticleViewHolder.PARTIAL_UPDATE_OFFLINE_ID);
         }
     }
 
-    private void setupOfflinePageBridgeObserver(NewTabPageManager manager) {
+    private void setupOfflinePageBridgeObserver(SuggestionsUiDelegate uiDelegate) {
         final OfflinePageBridge.OfflinePageModelObserver observer =
                 new OfflinePageBridge.OfflinePageModelObserver() {
                     @Override
                     public void offlinePageModelLoaded() {
                         updateAllSnippetOfflineAvailability();
                     }
 
                     @Override
                     public void offlinePageAdded(OfflinePageItem addedPage) {
                         updateAllSnippetOfflineAvailability();
                     }
 
                     @Override
                     public void offlinePageDeleted(long offlineId, ClientId clientId) {
                         for (SnippetArticle article : mSuggestionsList) {
                             if (article.requiresExactOfflinePage()) continue;
                             Long articleOfflineId = article.getOfflinePageOfflineId();
                             if (articleOfflineId == null) continue;
                             if (articleOfflineId.longValue() != offlineId) continue;
                             // The old value cannot be simply removed without a request to the
                             // model, because there may be an older offline page for the same
                             // URL.
                             updateSnippetOfflineAvailability(article);
                         }
                     }
                 };
 
         mOfflinePageBridge.addObserver(observer);
 
-        manager.addDestructionObserver(new DestructionObserver() {
+        uiDelegate.addDestructionObserver(new DestructionObserver() {
             @Override
             public void onDestroy() {
                 mIsNtpDestroyed = true;
                 mOfflinePageBridge.removeObserver(observer);
             }
         });
     }
 
     private void refreshChildrenVisibility() {
         mStatus.setVisible(!hasSuggestions());
@@ skipping 212 matching lines @@
     @VisibleForTesting
     ActionItem getActionItem() {
         return mMoreButton;
     }
 
     @VisibleForTesting
     StatusItem getStatusItem() {
         return mStatus;
     }
 }