chrome/browser/privacy_sandbox/privacy_sandbox_notice_service_unittest.cc

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

#include "chrome/browser/privacy_sandbox/privacy_sandbox_notice_service.h"

#include "base/json/values_util.h"
#include "base/test/scoped_feature_list.h"
#include "base/test/task_environment.h"
#include "base/time/time.h"
#include "components/prefs/testing_pref_service.h"
#include "components/privacy_sandbox/privacy_sandbox_features.h"
#include "components/privacy_sandbox/privacy_sandbox_notice_constants.h"
#include "components/privacy_sandbox/privacy_sandbox_notice_storage.h"
#include "components/privacy_sandbox/privacy_sandbox_prefs.h"
#include "testing/gmock/include/gmock/gmock.h"
#include "testing/gtest/include/gtest/gtest.h"

namespace privacy_sandbox {
namespace {

// TODO(crbug.com/333408794): Add browser tests ensuring prefs are migrated
// after notice flow completion.
class PrivacySandboxNoticeServiceTest : public testing::Test {
 public:
  PrivacySandboxNoticeServiceTest()
      : task_env_(base::test::TaskEnvironment::TimeSource::MOCK_TIME) {
    RegisterProfilePrefs(prefs()->registry());
    scoped_feature_list_.InitAndEnableFeature(
        kPrivacySandboxMigratePrefsToNoticeConsentDataModel);
  }

  std::string GetTopicsNoticeName() {
#if BUILDFLAG(IS_ANDROID)
    return kTopicsConsentModalClankBrApp;
#else
    return kTopicsConsentModal;
#endif
  }

  std::string GetProtectedAudienceMeasurementNoticeName() {
#if BUILDFLAG(IS_ANDROID)
    return kProtectedAudienceMeasurementNoticeModalClankBrApp;
#else
    return kProtectedAudienceMeasurementNoticeModal;
#endif
  }

  std::string GetThreeAdsAPIsNoticeName() {
#if BUILDFLAG(IS_ANDROID)
    return kThreeAdsAPIsNoticeModalClankBrApp;
#else
    return kThreeAdsAPIsNoticeModal;
#endif
  }

  std::string GetMeasurementNoticeName() {
#if BUILDFLAG(IS_ANDROID)
    return kMeasurementNoticeModalClankBrApp;
#else
    return kMeasurementNoticeModal;
#endif
  }

  TestingPrefServiceSimple* prefs() { return &prefs_; }

 private:
  base::test::TaskEnvironment task_env_;
  TestingPrefServiceSimple prefs_;
  base::test::ScopedFeatureList scoped_feature_list_;
};

// If original prefs are set from Settings, then new prefs shouldn't be set and
// should be their default values.
TEST_F(PrivacySandboxNoticeServiceTest,
       NoticeActionSetWhenMigratedFromSettings) {
  prefs()->SetBoolean(prefs::kPrivacySandboxTopicsConsentGiven, true);
  prefs()->SetInteger(prefs::kPrivacySandboxTopicsConsentLastUpdateReason,
                      static_cast<int>(TopicsConsentUpdateSource::kSettings));
  prefs()->SetTime(prefs::kPrivacySandboxTopicsConsentLastUpdateTime,
                   base::Time::FromMillisecondsSinceUnixEpoch(100));
  auto notice_service = PrivacySandboxNoticeService(prefs());
  const auto result = notice_service.GetNoticeStorage()->ReadNoticeData(
      prefs(), GetTopicsNoticeName());
  EXPECT_EQ(result->schema_version, 1);
  EXPECT_EQ(result->notice_action_taken,
            NoticeActionTaken::kUnknownActionPreMigration);
  EXPECT_EQ(base::TimeToValue(result->notice_action_taken_time), "0");
}

TEST_F(PrivacySandboxNoticeServiceTest,
       PrefsNotSetWhenMigratedFromTopicsWithNoConsentDecision) {
  prefs()->SetInteger(
      prefs::kPrivacySandboxTopicsConsentLastUpdateReason,
      static_cast<int>(TopicsConsentUpdateSource::kConfirmation));
  auto notice_service = privacy_sandbox::PrivacySandboxNoticeService(prefs());
  const auto result = notice_service.GetNoticeStorage()->ReadNoticeData(
      prefs(), GetTopicsNoticeName());
  EXPECT_EQ(result, std::nullopt);
}

TEST_F(PrivacySandboxNoticeServiceTest,
       NoticeActionAndTimeSetWhenMigratedFromTopicsWithConsent) {
  prefs()->SetInteger(
      prefs::kPrivacySandboxTopicsConsentLastUpdateReason,
      static_cast<int>(TopicsConsentUpdateSource::kConfirmation));
  prefs()->SetBoolean(prefs::kPrivacySandboxTopicsConsentGiven, true);
  prefs()->SetTime(prefs::kPrivacySandboxTopicsConsentLastUpdateTime,
                   base::Time::FromMillisecondsSinceUnixEpoch(100));
  auto notice_service = PrivacySandboxNoticeService(prefs());
  const auto result = notice_service.GetNoticeStorage()->ReadNoticeData(
      prefs(), GetTopicsNoticeName());
  EXPECT_EQ(result->schema_version, 1);
  EXPECT_EQ(result->notice_action_taken, NoticeActionTaken::kOptIn);
  EXPECT_EQ(result->notice_action_taken_time,
            base::Time::FromMillisecondsSinceUnixEpoch(100));
}

TEST_F(PrivacySandboxNoticeServiceTest,
       NoticeActionAndTimeSetWhenMigratedFromTopicsWithoutConsent) {
  prefs()->SetInteger(
      prefs::kPrivacySandboxTopicsConsentLastUpdateReason,
      static_cast<int>(TopicsConsentUpdateSource::kConfirmation));
  prefs()->SetBoolean(prefs::kPrivacySandboxTopicsConsentGiven, false);
  prefs()->SetTime(prefs::kPrivacySandboxTopicsConsentLastUpdateTime,
                   base::Time::FromMillisecondsSinceUnixEpoch(100));
  auto notice_service = PrivacySandboxNoticeService(prefs());
  const auto result = notice_service.GetNoticeStorage()->ReadNoticeData(
      prefs(), GetTopicsNoticeName());
  EXPECT_EQ(result->schema_version, 1);
  EXPECT_EQ(result->notice_action_taken, NoticeActionTaken::kOptOut);
  EXPECT_EQ(result->notice_action_taken_time,
            base::Time::FromMillisecondsSinceUnixEpoch(100));
}

// Clank specific tests.
#if BUILDFLAG(IS_ANDROID)
TEST_F(PrivacySandboxNoticeServiceTest,
       DuringMigrationClankBrAppPrefsNotSetWhenTopicsSetFromCCT) {
  /* Set old prefs. */
  prefs()->SetInteger(
      prefs::kPrivacySandboxTopicsConsentLastUpdateReason,
      static_cast<int>(TopicsConsentUpdateSource::kConfirmation));
  prefs()->SetBoolean(prefs::kPrivacySandboxTopicsConsentGiven, false);
  prefs()->SetTime(prefs::kPrivacySandboxTopicsConsentLastUpdateTime,
                   base::Time::FromMillisecondsSinceUnixEpoch(100));

  /* Set new CCT prefs. */
  PrivacySandboxNoticeStorage notice_storage;
  notice_storage.SetNoticeShown(prefs(), kTopicsConsentModalClankCCT,
                                base::Time::Now());
  const auto result =
      notice_storage.ReadNoticeData(prefs(), GetTopicsNoticeName());

  /* Migration code. */
  auto notice_service = PrivacySandboxNoticeService(prefs());
  EXPECT_EQ(result, std::nullopt);
}

TEST_F(PrivacySandboxNoticeServiceTest,
       DuringMigrationBrAppPrefsNotSetWhenTopicsSetFromDesktop) {
  /* Set old prefs. */
  prefs()->SetInteger(
      prefs::kPrivacySandboxTopicsConsentLastUpdateReason,
      static_cast<int>(TopicsConsentUpdateSource::kConfirmation));
  prefs()->SetBoolean(prefs::kPrivacySandboxTopicsConsentGiven, false);
  prefs()->SetTime(prefs::kPrivacySandboxTopicsConsentLastUpdateTime,
                   base::Time::FromMillisecondsSinceUnixEpoch(100));

  /* Set new CCT prefs. */
  PrivacySandboxNoticeStorage notice_storage;
  notice_storage.SetNoticeShown(prefs(), kTopicsConsentModal,
                                base::Time::Now());
  const auto result =
      notice_storage.ReadNoticeData(prefs(), GetTopicsNoticeName());

  /* Migration code. */
  auto notice_service = PrivacySandboxNoticeService(prefs());
  EXPECT_EQ(result, std::nullopt);
}
#endif  // BUILDFLAG(IS_ANDROID)

#if !BUILDFLAG(IS_ANDROID)
TEST_F(PrivacySandboxNoticeServiceTest,
       DuringMigrationDesktopPrefsNotSetWhenTopicsSetFromBrApp) {
  /* Set old prefs. */
  prefs()->SetInteger(
      prefs::kPrivacySandboxTopicsConsentLastUpdateReason,
      static_cast<int>(TopicsConsentUpdateSource::kConfirmation));
  prefs()->SetBoolean(prefs::kPrivacySandboxTopicsConsentGiven, false);
  prefs()->SetTime(prefs::kPrivacySandboxTopicsConsentLastUpdateTime,
                   base::Time::FromMillisecondsSinceUnixEpoch(100));

  /* Set new prefs. */
  PrivacySandboxNoticeStorage notice_storage;
  notice_storage.SetNoticeShown(prefs(), kTopicsConsentModalClankBrApp,
                                base::Time::Now());
  const auto result =
      notice_storage.ReadNoticeData(prefs(), GetTopicsNoticeName());

  /* Migration code. */
  auto notice_service = PrivacySandboxNoticeService(prefs());
  EXPECT_EQ(result, std::nullopt);
}

#endif  // !BUILDFLAG(IS_ANDROID)

TEST_F(PrivacySandboxNoticeServiceTest,
       PrefsNotSetWhenMigratedFromProtectedAudienceMeasurementWithNoAck) {
  auto notice_service = privacy_sandbox::PrivacySandboxNoticeService(prefs());
  const auto result = notice_service.GetNoticeStorage()->ReadNoticeData(
      prefs(), GetProtectedAudienceMeasurementNoticeName());
  EXPECT_EQ(result, std::nullopt);
}

TEST_F(PrivacySandboxNoticeServiceTest,
       NoticeActionSetWhenMigratedFromProtectedAudienceMeasurementWithAck) {
  prefs()->SetBoolean(prefs::kPrivacySandboxM1EEANoticeAcknowledged, true);
  auto notice_service = PrivacySandboxNoticeService(prefs());
  const auto result = notice_service.GetNoticeStorage()->ReadNoticeData(
      prefs(), GetProtectedAudienceMeasurementNoticeName());
  EXPECT_EQ(result->schema_version, 1);
  EXPECT_EQ(result->notice_action_taken, NoticeActionTaken::kAck);
  EXPECT_EQ(result->notice_action_taken_time, base::Time());
}

// Clank specific tests.
#if BUILDFLAG(IS_ANDROID)
TEST_F(
    PrivacySandboxNoticeServiceTest,
    DuringMigrationClankBrAppPrefsNotSetWhenProtectedAudienceMeasurementSetFromCCT) {
  /* Set old prefs. */
  prefs()->SetBoolean(prefs::kPrivacySandboxM1EEANoticeAcknowledged, true);

  /* Set new CCT prefs. */
  PrivacySandboxNoticeStorage notice_storage;
  notice_storage.SetNoticeShown(
      prefs(), kProtectedAudienceMeasurementNoticeModalClankCCT,
      base::Time::Now());
  const auto result = notice_storage.ReadNoticeData(
      prefs(), GetProtectedAudienceMeasurementNoticeName());

  /* Migration code. */
  auto notice_service = PrivacySandboxNoticeService(prefs());
  EXPECT_EQ(result, std::nullopt);
}

TEST_F(
    PrivacySandboxNoticeServiceTest,
    DuringMigrationPrefsNotSetWhenProtectedAudienceMeasurementSetFromDesktop) {
  /* Set old prefs. */
  prefs()->SetBoolean(prefs::kPrivacySandboxM1EEANoticeAcknowledged, true);

  /* Set new prefs. */
  PrivacySandboxNoticeStorage notice_storage;
  notice_storage.SetNoticeShown(
      prefs(), kProtectedAudienceMeasurementNoticeModal, base::Time::Now());
  const auto result = notice_storage.ReadNoticeData(
      prefs(), GetProtectedAudienceMeasurementNoticeName());

  /* Migration code. */
  auto notice_service = PrivacySandboxNoticeService(prefs());
  EXPECT_EQ(result, std::nullopt);
}
#endif  // BUILDFLAG(IS_ANDROID)

#if !BUILDFLAG(IS_ANDROID)
TEST_F(
    PrivacySandboxNoticeServiceTest,
    DuringMigrationDesktopPrefsNotSetWhenProtectedAudienceMeasurementSetFromBrApp) {
  /* Set old prefs. */
  prefs()->SetBoolean(prefs::kPrivacySandboxM1EEANoticeAcknowledged, true);

  /* Set new prefs. */
  PrivacySandboxNoticeStorage notice_storage;
  notice_storage.SetNoticeShown(
      prefs(), kProtectedAudienceMeasurementNoticeModalClankBrApp,
      base::Time::Now());
  const auto result = notice_storage.ReadNoticeData(
      prefs(), GetProtectedAudienceMeasurementNoticeName());

  /* Migration code. */
  auto notice_service = PrivacySandboxNoticeService(prefs());
  EXPECT_EQ(result, std::nullopt);
}
#endif  // !BUILDFLAG(IS_ANDROID)

TEST_F(PrivacySandboxNoticeServiceTest,
       PrefsNotSetWhenMigratedFromThreeAdsAPIsWithNoAck) {
  auto notice_service = privacy_sandbox::PrivacySandboxNoticeService(prefs());
  const auto result = notice_service.GetNoticeStorage()->ReadNoticeData(
      prefs(), GetThreeAdsAPIsNoticeName());
  EXPECT_EQ(result, std::nullopt);
}

TEST_F(PrivacySandboxNoticeServiceTest,
       NoticeActionSetWhenMigratedFromThreeAdsAPIsWithAck) {
  prefs()->SetBoolean(prefs::kPrivacySandboxM1RowNoticeAcknowledged, true);
  auto notice_service = PrivacySandboxNoticeService(prefs());
  const auto result = notice_service.GetNoticeStorage()->ReadNoticeData(
      prefs(), GetThreeAdsAPIsNoticeName());
  EXPECT_EQ(result->schema_version, 1);
  EXPECT_EQ(result->notice_action_taken, NoticeActionTaken::kAck);
  EXPECT_EQ(result->notice_action_taken_time, base::Time());
}

// Clank specific tests.
#if BUILDFLAG(IS_ANDROID)
TEST_F(PrivacySandboxNoticeServiceTest,
       DuringMigrationClankBrAppPrefsNotSetWhenThreeAdsAPIsSetFromCCT) {
  /* Set old prefs. */
  prefs()->SetBoolean(prefs::kPrivacySandboxM1RowNoticeAcknowledged, true);

  /* Set new CCT prefs. */
  PrivacySandboxNoticeStorage notice_storage;
  notice_storage.SetNoticeShown(prefs(), kThreeAdsAPIsNoticeModalClankCCT,
                                base::Time::Now());
  const auto result =
      notice_storage.ReadNoticeData(prefs(), GetThreeAdsAPIsNoticeName());

  /* Migration code. */
  auto notice_service = PrivacySandboxNoticeService(prefs());
  EXPECT_EQ(result, std::nullopt);
}

TEST_F(PrivacySandboxNoticeServiceTest,
       DuringMigrationPrefsNotSetWhenThreeAdsAPIsSetFromDesktop) {
  /* Set old prefs. */
  prefs()->SetBoolean(prefs::kPrivacySandboxM1RowNoticeAcknowledged, true);

  /* Set new CCT prefs. */
  PrivacySandboxNoticeStorage notice_storage;
  notice_storage.SetNoticeShown(prefs(), kThreeAdsAPIsNoticeModal,
                                base::Time::Now());
  const auto result =
      notice_storage.ReadNoticeData(prefs(), GetThreeAdsAPIsNoticeName());

  /* Migration code. */
  auto notice_service = PrivacySandboxNoticeService(prefs());
  EXPECT_EQ(result, std::nullopt);
}
#endif  // BUILDFLAG(IS_ANDROID)

#if !BUILDFLAG(IS_ANDROID)
TEST_F(PrivacySandboxNoticeServiceTest,
       DuringMigrationDesktopPrefsNotSetWhenThreeAdsAPIsSetFromBrApp) {
  /* Set old prefs. */
  prefs()->SetBoolean(prefs::kPrivacySandboxM1RowNoticeAcknowledged, true);

  /* Set new CCT prefs. */
  PrivacySandboxNoticeStorage notice_storage;
  notice_storage.SetNoticeShown(prefs(), kThreeAdsAPIsNoticeModalClankBrApp,
                                base::Time::Now());
  const auto result =
      notice_storage.ReadNoticeData(prefs(), GetThreeAdsAPIsNoticeName());

  /* Migration code. */
  auto notice_service = PrivacySandboxNoticeService(prefs());
  EXPECT_EQ(result, std::nullopt);
}
#endif  // !BUILDFLAG(IS_ANDROID)

TEST_F(PrivacySandboxNoticeServiceTest,
       PrefsNotSetWhenMigratedFromMeasurementWithNoAck) {
  auto notice_service = privacy_sandbox::PrivacySandboxNoticeService(prefs());
  const auto result = notice_service.GetNoticeStorage()->ReadNoticeData(
      prefs(), GetMeasurementNoticeName());
  EXPECT_EQ(result, std::nullopt);
}

TEST_F(PrivacySandboxNoticeServiceTest,
       NoticeActionSetWhenMigratedFromMeasurementWithAck) {
  prefs()->SetBoolean(prefs::kPrivacySandboxM1RestrictedNoticeAcknowledged,
                      true);
  auto notice_service = PrivacySandboxNoticeService(prefs());
  const auto result = notice_service.GetNoticeStorage()->ReadNoticeData(
      prefs(), GetMeasurementNoticeName());
  EXPECT_EQ(result->schema_version, 1);
  EXPECT_EQ(result->notice_action_taken, NoticeActionTaken::kAck);
  EXPECT_EQ(result->notice_action_taken_time, base::Time());
}

// Clank specific tests.
#if BUILDFLAG(IS_ANDROID)
TEST_F(PrivacySandboxNoticeServiceTest,
       DuringMigrationClankBrAppPrefsNotSetWhenMeasurementSetFromCCT) {
  /* Set old prefs. */
  prefs()->SetBoolean(prefs::kPrivacySandboxM1RestrictedNoticeAcknowledged,
                      true);

  /* Set new CCT prefs. */
  PrivacySandboxNoticeStorage notice_storage;
  notice_storage.SetNoticeShown(prefs(), kMeasurementNoticeModalClankCCT,
                                base::Time::Now());
  const auto result =
      notice_storage.ReadNoticeData(prefs(), GetMeasurementNoticeName());

  /* Migration code. */
  auto notice_service = PrivacySandboxNoticeService(prefs());
  EXPECT_EQ(result, std::nullopt);
}

TEST_F(PrivacySandboxNoticeServiceTest,
       DuringMigrationPrefsNotSetWhenMeasurementSetFromDesktop) {
  /* Set old prefs. */
  prefs()->SetBoolean(prefs::kPrivacySandboxM1RestrictedNoticeAcknowledged,
                      true);

  /* Set new CCT prefs. */
  PrivacySandboxNoticeStorage notice_storage;
  notice_storage.SetNoticeShown(prefs(), kMeasurementNoticeModal,
                                base::Time::Now());
  const auto result =
      notice_storage.ReadNoticeData(prefs(), GetMeasurementNoticeName());

  /* Migration code. */
  auto notice_service = PrivacySandboxNoticeService(prefs());
  EXPECT_EQ(result, std::nullopt);
}
#endif  // BUILDFLAG(IS_ANDROID)

#if !BUILDFLAG(IS_ANDROID)
TEST_F(PrivacySandboxNoticeServiceTest,
       DuringMigrationDesktopPrefsNotSetWhenMeasurementSetFromBrApp) {
  /* Set old prefs. */
  prefs()->SetBoolean(prefs::kPrivacySandboxM1RestrictedNoticeAcknowledged,
                      true);

  /* Set new CCT prefs. */
  PrivacySandboxNoticeStorage notice_storage;
  notice_storage.SetNoticeShown(prefs(), kMeasurementNoticeModalClankBrApp,
                                base::Time::Now());
  const auto result =
      notice_storage.ReadNoticeData(prefs(), GetMeasurementNoticeName());

  /* Migration code. */
  auto notice_service = PrivacySandboxNoticeService(prefs());
  EXPECT_EQ(result, std::nullopt);
}
#endif  // !BUILDFLAG(IS_ANDROID)

}  // namespace
}  // namespace privacy_sandbox