Add snooze to IPH controller

This CL adds snooze to Tab Group IPH. It will not be in effect
until Finch is set up on the server side.

Future CLs:
* Add UMA.
* Add multi-arm Finch experiments to test on/off snooze
  and snooze duration.

Bug: 1121399
Change-Id: I5d7396ad783c6da14fd33ed8d9d78e4b79179c21
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/2398940
Auto-Submit: Keren Zhu <kerenzhu@chromium.org>
Reviewed-by: Tommy Nyquist <nyquist@chromium.org>
Reviewed-by: Collin Baker <collinbaker@chromium.org>
Reviewed-by: Wei Li <weili@chromium.org>
Commit-Queue: Keren Zhu <kerenzhu@chromium.org>
Cr-Commit-Position: refs/heads/master@{#807991}

chrome/browser/ui/views/in_product_help/feature_promo_controller_views.cc

@@ -11,16 +11,20 @@
 #include "base/optional.h"
 #include "chrome/browser/feature_engagement/tracker_factory.h"
 #include "chrome/browser/profiles/profile.h"
+#include "chrome/browser/ui/in_product_help/feature_promo_snooze_service.h"
 #include "chrome/browser/ui/views/chrome_view_class_properties.h"
 #include "chrome/browser/ui/views/frame/browser_view.h"
 #include "chrome/browser/ui/views/in_product_help/feature_promo_bubble_params.h"
 #include "chrome/browser/ui/views/in_product_help/feature_promo_bubble_view.h"
 #include "chrome/browser/ui/views/in_product_help/feature_promo_registry.h"
+#include "components/feature_engagement/public/feature_constants.h"
 #include "components/feature_engagement/public/tracker.h"
 
 FeaturePromoControllerViews::FeaturePromoControllerViews(
     BrowserView* browser_view)
     : browser_view_(browser_view),
+      snooze_service_(std::make_unique<FeaturePromoSnoozeService>(
+          browser_view->browser()->profile())),
       tracker_(feature_engagement::TrackerFactory::GetForBrowserContext(
           browser_view->browser()->profile())) {
   DCHECK(tracker_);
@@ -40,6 +44,9 @@ FeaturePromoControllerViews::~FeaturePromoControllerViews() {
 bool FeaturePromoControllerViews::MaybeShowPromoWithParams(
     const base::Feature& iph_feature,
     const FeaturePromoBubbleParams& params) {
+  if (snooze_service_->IsBlocked(iph_feature))
+    return false;
+
   if (!tracker_->ShouldTriggerHelpUI(iph_feature))
     return false;
 
@@ -51,7 +58,12 @@ bool FeaturePromoControllerViews::MaybeShowPromoWithParams(
   anchor_view_tracker_.SetView(params.anchor_view);
 
   current_iph_feature_ = &iph_feature;
-  promo_bubble_ = FeaturePromoBubbleView::Create(std::move(params));
+  promo_bubble_ = FeaturePromoBubbleView::Create(
+      std::move(params),
+      base::BindRepeating(&FeaturePromoControllerViews::OnUserSnooze,
+                          base::Unretained(this), iph_feature),
+      base::BindRepeating(&FeaturePromoControllerViews::OnUserDismiss,
+                          base::Unretained(this), iph_feature));
   widget_observer_.Add(promo_bubble_->GetWidget());
 
   return true;
@@ -67,6 +79,16 @@ bool FeaturePromoControllerViews::MaybeShowPromo(
   return MaybeShowPromoWithParams(iph_feature, *params);
 }
 
+void FeaturePromoControllerViews::OnUserSnooze(
+    const base::Feature& iph_feature) {
+  snooze_service_->OnUserSnooze(iph_feature);
+}
+
+void FeaturePromoControllerViews::OnUserDismiss(
+    const base::Feature& iph_feature) {
+  snooze_service_->OnUserDismiss(iph_feature);
+}
+
 bool FeaturePromoControllerViews::BubbleIsShowing(
     const base::Feature& iph_feature) const {
   return promo_bubble_ && current_iph_feature_ == &iph_feature;

chrome/browser/ui/views/in_product_help/feature_promo_controller_views.h

@@ -5,6 +5,8 @@
 #ifndef CHROME_BROWSER_UI_VIEWS_IN_PRODUCT_HELP_FEATURE_PROMO_CONTROLLER_VIEWS_H_
 #define CHROME_BROWSER_UI_VIEWS_IN_PRODUCT_HELP_FEATURE_PROMO_CONTROLLER_VIEWS_H_
 
+#include <memory>
+
 #include "base/memory/weak_ptr.h"
 #include "base/scoped_observer.h"
 #include "chrome/browser/ui/views/in_product_help/feature_promo_controller.h"
@@ -15,6 +17,7 @@
 class BrowserView;
 class FeaturePromoBubbleView;
 struct FeaturePromoBubbleParams;
+class FeaturePromoSnoozeService;
 
 namespace base {
 struct Feature;
@@ -59,15 +62,27 @@ class FeaturePromoControllerViews : public FeaturePromoController,
     return promo_bubble_;
   }
 
+  FeaturePromoSnoozeService* snooze_service_for_testing() {
+    return snooze_service_.get();
+  }
+
  private:
   // Called when PromoHandle is destroyed to finish the promo.
   void FinishContinuedPromo() override;
 
   void HandleBubbleClosed();
 
+  // Call these methods when the user actively snooze or dismiss the IPH.
+  void OnUserSnooze(const base::Feature& iph_feature);
+  void OnUserDismiss(const base::Feature& iph_feature);
+
   // The browser window this instance is responsible for.
   BrowserView* const browser_view_;
 
+  // Snooze service that is notified when a user snoozes or dismisses the promo.
+  // Ask this service for display permission before |tracker_|.
+  std::unique_ptr<FeaturePromoSnoozeService> snooze_service_;
+
   // IPH backend that is notified of user events and decides whether to
   // trigger IPH.
   feature_engagement::Tracker* const tracker_;

chrome/browser/ui/views/in_product_help/feature_promo_controller_views_unittest.cc

@@ -10,6 +10,7 @@
 #include "base/test/bind_test_util.h"
 #include "chrome/browser/feature_engagement/tracker_factory.h"
 #include "chrome/browser/profiles/profile.h"
+#include "chrome/browser/ui/in_product_help/feature_promo_snooze_service.h"
 #include "chrome/browser/ui/views/chrome_view_class_properties.h"
 #include "chrome/browser/ui/views/frame/browser_view.h"
 #include "chrome/browser/ui/views/frame/test_with_browser_view.h"
@@ -116,6 +117,17 @@ TEST_F(FeaturePromoControllerViewsTest, ShowsBubble) {
   EXPECT_TRUE(controller_->promo_bubble_for_testing());
 }
 
+TEST_F(FeaturePromoControllerViewsTest, SnoozeServiceBlocksPromo) {
+  EXPECT_CALL(*mock_tracker_, ShouldTriggerHelpUI(Ref(kTestIPHFeature)))
+      .Times(0);
+  controller_->snooze_service_for_testing()->OnUserDismiss(kTestIPHFeature);
+  EXPECT_FALSE(controller_->MaybeShowPromoWithParams(kTestIPHFeature,
+                                                     DefaultBubbleParams()));
+  EXPECT_FALSE(controller_->BubbleIsShowing(kTestIPHFeature));
+  EXPECT_FALSE(controller_->promo_bubble_for_testing());
+  controller_->snooze_service_for_testing()->Reset(kTestIPHFeature);
+}
+
 TEST_F(FeaturePromoControllerViewsTest, PromoEndsWhenRequested) {
   EXPECT_CALL(*mock_tracker_, ShouldTriggerHelpUI(Ref(kTestIPHFeature)))
       .Times(1)

chrome/browser/ui/views/in_product_help/feature_promo_registry.cc

@@ -78,6 +78,11 @@ void FeaturePromoRegistry::RegisterKnownFeatures() {
     FeaturePromoBubbleParams params;
     params.body_string_specifier = IDS_TAB_GROUPS_NEW_GROUP_PROMO;
     params.arrow = views::BubbleBorder::TOP_LEFT;
+
+    // Turn on IPH Snooze only for Tab Group.
+    params.allow_snooze = base::FeatureList::IsEnabled(
+        feature_engagement::kIPHDesktopSnoozeFeature);
+
     RegisterFeature(feature_engagement::kIPHDesktopTabGroupsNewGroupFeature,
                     params, base::BindRepeating(GetTabGroupsAnchorView));
   }

components/feature_engagement/public/feature_constants.cc

@@ -26,6 +26,8 @@ const base::Feature kIPHReopenTabFeature{"IPH_ReopenTab",
                                          base::FEATURE_DISABLED_BY_DEFAULT};
 const base::Feature kIPHWebUITabStripFeature{"IPH_WebUITabStrip",
                                              base::FEATURE_DISABLED_BY_DEFAULT};
+const base::Feature kIPHDesktopSnoozeFeature{"IPH_DesktopSnoozeFeature",
+                                             base::FEATURE_DISABLED_BY_DEFAULT};
 #endif  // defined(OS_WIN) || defined(OS_APPLE) || defined(OS_LINUX) ||
         // defined(OS_CHROMEOS)
 

components/feature_engagement/public/feature_constants.h

@@ -24,6 +24,7 @@ extern const base::Feature kIPHGlobalMediaControlsFeature;
 extern const base::Feature kIPHPasswordsAccountStorageFeature;
 extern const base::Feature kIPHReopenTabFeature;
 extern const base::Feature kIPHWebUITabStripFeature;
+extern const base::Feature kIPHDesktopSnoozeFeature;
 #endif  // defined(OS_WIN) || defined(OS_APPLE) || defined(OS_LINUX) ||
         // defined(OS_CHROMEOS)