// Copyright 2018 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include <algorithm>
#include <optional>
#include <string>
#include <vector>

#include "base/feature_list.h"
#include "base/functional/bind.h"
#include "base/functional/callback_helpers.h"
#include "base/strings/string_split.h"
#include "base/test/scoped_feature_list.h"
#include "build/build_config.h"
#include "chrome/browser/apps/app_service/app_registry_cache_waiter.h"
#include "chrome/browser/banners/test_app_banner_manager_desktop.h"
#include "chrome/browser/profiles/profile.h"
#include "chrome/browser/ui/actions/chrome_action_id.h"
#include "chrome/browser/ui/page_action/page_action_controller.h"
#include "chrome/browser/ui/page_action/page_action_icon_type.h"
#include "chrome/browser/ui/tabs/public/tab_features.h"
#include "chrome/browser/ui/test/test_browser_dialog.h"
#include "chrome/browser/ui/ui_features.h"
#include "chrome/browser/ui/views/bookmarks/bookmark_bar_view.h"
#include "chrome/browser/ui/views/frame/browser_view.h"
#include "chrome/browser/ui/views/global_media_controls/media_toolbar_button_view.h"
#include "chrome/browser/ui/views/page_action/page_action_view_interface.h"
#include "chrome/browser/ui/views/page_action/test_support/page_action_test_accessor.h"
#include "chrome/browser/ui/views/toolbar/toolbar_view.h"
#include "chrome/browser/user_education/user_education_service.h"
#include "chrome/browser/user_education/user_education_service_factory.h"
#include "chrome/browser/web_applications/link_capturing_features.h"
#include "chrome/browser/web_applications/mojom/user_display_mode.mojom.h"
#include "chrome/browser/web_applications/test/web_app_install_test_utils.h"
#include "chrome/browser/web_applications/web_app_provider.h"
#include "chrome/browser/web_applications/web_app_registrar.h"
#include "chrome/browser/web_applications/web_app_ui_manager.h"
#include "chrome/common/buildflags.h"
#include "chrome/test/base/interactive_test_utils.h"
#include "chrome/test/base/ui_test_utils.h"
#include "chrome/test/user_education/interactive_feature_promo_test.h"
#include "components/bookmarks/common/bookmark_pref_names.h"
#include "components/feature_engagement/public/feature_constants.h"
#include "components/feature_engagement/public/feature_list.h"
#include "components/keyed_service/content/browser_context_dependency_manager.h"
#include "components/live_caption/caption_util.h"
#include "components/user_education/common/feature_promo/feature_promo_controller.h"
#include "components/user_education/common/feature_promo/feature_promo_result.h"
#include "components/user_education/common/feature_promo/feature_promo_specification.h"
#include "content/public/test/browser_test.h"
#include "testing/gmock/include/gmock/gmock.h"
#include "ui/base/interaction/expect_call_in_scope.h"
#include "ui/base/interaction/interaction_sequence_test_util.h"

using ::testing::_;
using ::testing::AnyNumber;
using ::testing::NiceMock;
using ::testing::Ref;
using ::testing::Return;

namespace {

// Returns an appropriate set of string replacements; passing the wrong number
// of replacements for the body text of the IPH will cause a DCHECK.
user_education::FeaturePromoSpecification::FormatParameters
GetReplacementsForFeature(const base::Feature& feature) {
  if (&feature == &feature_engagement::kIPHDesktopPwaInstallFeature) {
    return u"Placeholder Text";
  }
  return user_education::FeaturePromoSpecification::NoSubstitution();
}

}  // namespace

using TestBase = InteractiveFeaturePromoTestMixin<DialogBrowserTest>;

class FeaturePromoDialogTest : public TestBase {
 public:
  FeaturePromoDialogTest()
      // Specifying features to enable is not important because a mock
      // FeatureEngagementTracker is used.
      : TestBase(UseMockTracker()) {
    feature_ = GetFeatureForTest();
    scoped_feature_list_.InitWithFeatures(
        /* enabled_features =*/{*feature_},
        /* disabled_features =*/{});

    // TODO(crbug.com/40727458): fix cause of bubbles overflowing the
    // screen and remove this.
    set_should_verify_dialog_bounds(false);
  }
  void SetUp() override {
    webapps::TestAppBannerManagerDesktop::SetUp();
    TestBase::SetUp();
  }
  void SetUpOnMainThread() override {
    TestBase::SetUpOnMainThread();
    browser()->GetWindow()->Activate();
    ui_test_utils::BrowserActivationWaiter(browser()).WaitForActivation();
  }

  void TearDownOnMainThread() override {
    Profile* const profile = browser()->GetProfile();
    web_app::WebAppRegistrar& registrar =
        web_app::WebAppProvider::GetForTest(profile)->registrar_unsafe();
    for (const auto& app_id : registrar.GetAppIds()) {
      apps::AppReadinessWaiter app_readiness_waiter(
          profile, app_id, apps::Readiness::kUninstalledByUser);
      web_app::test::UninstallWebApp(profile, app_id);
      app_readiness_waiter.Await();
    }

    TestBase::TearDownOnMainThread();
  }

  ~FeaturePromoDialogTest() override = default;

  // DialogBrowserTest:
  void ShowUi(const std::string& name) override {
    auto* const promo_controller =
        UserEducationServiceFactory::GetForBrowserContext(
            browser()->GetProfile())
            ->GetFeaturePromoControllerForTesting();
    auto const context = BrowserUserEducationInterface::From(browser())
                             ->GetUserEducationContextForTesting();
    ASSERT_TRUE(promo_controller);

    // The browser may have already queued a promo for startup. Since the test
    // uses a mock, cancel that and just show it directly.
    const auto status = promo_controller->GetPromoStatus(*feature_);
    if (status == user_education::FeaturePromoStatus::kQueued) {
      promo_controller->EndPromo(
          *feature_, user_education::EndFeaturePromoReason::kAbortPromo);
    }

    // Set up mock tracker to allow the IPH, then attempt to show it.
    EXPECT_CALL(*GetMockTrackerFor(browser()),
                ShouldTriggerHelpUI(Ref(*feature_)))
        .Times(1)
        .WillOnce(Return(true));
    user_education::FeaturePromoParams params(*feature_);
    params.body_params = GetReplacementsForFeature(*feature_);
    UNCALLED_MOCK_CALLBACK(
        user_education::FeaturePromoController::ShowPromoResultCallback,
        show_callback);
    params.show_promo_result_callback = show_callback.Get();
    EXPECT_ASYNC_CALL_IN_SCOPE(
        show_callback, Run(user_education::FeaturePromoResult::Success()),
        promo_controller->MaybeShowPromo(std::move(params), context));
  }

 private:
  // Looks up the IPH name from the test name and returns the corresponding
  // base::Feature.
  const base::Feature* GetFeatureForTest() const {
    const std::string full_name =
        testing::UnitTest::GetInstance()->current_test_info()->name();
    const std::string name = full_name.substr(full_name.find('_') + 1);
    std::vector<const base::Feature*> iph_features =
        feature_engagement::GetAllFeatures();
    auto feature_it =
        std::ranges::find(iph_features, name, &base::Feature::name);
    CHECK(feature_it != iph_features.end());
    return *feature_it;
  }

  raw_ptr<const base::Feature> feature_ = nullptr;
  base::test::ScopedFeatureList scoped_feature_list_;
};

// Adding new tests for your promo
//
// When you add a new IPH, add a test for your promo. In most cases you
// can follow these steps:
//
// 1. Get the feature name for your IPH. This will be the of the form
//    IPH_<name>. It should be the same as defined in
//    //components/feature_engagement/public/feature_constants.cc.
//
// 2. Define a new test below with the name InvokeUi_IPH_<name>. Place
//    it in alphabetical order.
//
// 3. Call set_baseline("<cl-number>"). This enables Skia Gold pixel
//    tests for your IPH.
//
// 4. Call ShowAndVerifyUi().
//
// For running your test reference the docs in
// //chrome/browser/ui/test/test_browser_dialog.h

IN_PROC_BROWSER_TEST_F(FeaturePromoDialogTest, InvokeUi_IPH_DesktopPwaInstall) {
  set_baseline("2936082");
  // Navigate to an installable site so PWA install icon shows up.
  ASSERT_TRUE(embedded_test_server()->Start());
  ASSERT_TRUE(ui_test_utils::NavigateToURL(
      browser(),
      embedded_test_server()->GetURL("/banners/manifest_test_page.html")));
  content::WebContents* web_contents =
      browser()->GetTabStripModel()->GetActiveWebContents();
  auto* app_banner_manager =
      webapps::TestAppBannerManagerDesktop::FromWebContents(web_contents);
  app_banner_manager->WaitForInstallableCheck();
  EXPECT_TRUE(page_actions::PageActionTestAccessor(browser(), kActionInstallPwa)
                  .GetVisible());

  browser()->GetWindow()->Activate();
  ui_test_utils::BrowserActivationWaiter(browser()).WaitForActivation();

  ShowAndVerifyUi();
}

#if !BUILDFLAG(IS_CHROMEOS)
IN_PROC_BROWSER_TEST_F(FeaturePromoDialogTest, InvokeUi_IPH_ProfileSwitch) {
  set_baseline("3710120");
  ShowAndVerifyUi();
}
#endif  // !BUILDFLAG(IS_CHROMEOS)

IN_PROC_BROWSER_TEST_F(FeaturePromoDialogTest,
                       InvokeUi_IPH_DesktopSharedHighlighting) {
  set_baseline("3253618");
  ShowAndVerifyUi();
}