Skip to content

Commit

Permalink
Don't use different manifest file name for SI and SR component
Browse files Browse the repository at this point in the history
Use same manifest filename and determine it's SI or SR by its
contents.
And delete utils. APIs that in utils should be in service impl file.
  • Loading branch information
simonhong committed Apr 17, 2020
1 parent 8b37618 commit a3eeb48
Show file tree
Hide file tree
Showing 10 changed files with 47 additions and 93 deletions.
5 changes: 3 additions & 2 deletions browser/brave_local_state_prefs.cc
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
#include "brave/components/brave_referrals/buildflags/buildflags.h"
#include "brave/components/brave_shields/browser/ad_block_service.h"
#include "brave/components/brave_shields/browser/brave_shields_p3a.h"
#include "brave/components/ntp_background_images/browser/ntp_background_images_utils.h"
#include "brave/components/ntp_background_images/browser/ntp_background_images_service.h"
#include "brave/components/p3a/brave_p3a_service.h"
#include "brave/components/p3a/buildflags.h"
#include "chrome/browser/first_run/first_run.h"
Expand Down Expand Up @@ -45,7 +45,8 @@ void RegisterLocalStatePrefs(PrefRegistrySimple* registry) {
brave_shields::RegisterPrefsForAdBlockService(registry);
RegisterPrefsForBraveStatsUpdater(registry);
registry->RegisterBooleanPref(kRemoteDebuggingEnabled, false);
ntp_background_images::RegisterLocalStatePrefs(registry);
ntp_background_images::NTPBackgroundImagesService::RegisterLocalStatePrefs(
registry);
#if BUILDFLAG(ENABLE_BRAVE_REFERRALS)
RegisterPrefsForBraveReferralsService(registry);
#endif
Expand Down
1 change: 0 additions & 1 deletion browser/brave_profile_prefs.cc
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@
#include "brave/components/brave_wallet/browser/buildflags/buildflags.h"
#include "brave/components/brave_wayback_machine/buildflags.h"
#include "brave/components/brave_webtorrent/browser/buildflags/buildflags.h"
#include "brave/components/ntp_background_images/browser/ntp_background_images_utils.h"
#include "brave/components/speedreader/buildflags.h"
#include "chrome/browser/net/prediction_options.h"
#include "chrome/browser/prefs/session_startup_pref.h"
Expand Down
2 changes: 0 additions & 2 deletions components/ntp_background_images/browser/BUILD.gn
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,6 @@ static_library("browser") {
"ntp_background_images_service.h",
"ntp_background_images_source.cc",
"ntp_background_images_source.h",
"ntp_background_images_utils.cc",
"ntp_background_images_utils.h",
"sponsored_images_component_data.cc",
"sponsored_images_component_data.h",
"switches.cc",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,20 +24,19 @@
#include "brave/components/ntp_background_images/browser/ntp_background_images_component_installer.h"
#include "brave/components/ntp_background_images/browser/ntp_background_images_data.h"
#include "brave/components/ntp_background_images/browser/ntp_background_images_source.h"
#include "brave/components/ntp_background_images/browser/ntp_background_images_utils.h"
#include "brave/components/ntp_background_images/browser/sponsored_images_component_data.h"
#include "brave/components/ntp_background_images/browser/switches.h"
#include "brave/components/ntp_background_images/browser/url_constants.h"
#include "brave/components/ntp_background_images/common/pref_names.h"
#include "components/component_updater/component_updater_service.h"
#include "components/prefs/pref_registry_simple.h"
#include "components/prefs/pref_service.h"

namespace ntp_background_images {

namespace {

constexpr char kNTPSIManifestFile[] = "photo.json";
constexpr char kNTPSRManifestFile[] = "data.json";
constexpr char kNTPManifestFile[] = "photo.json";
constexpr char kNTPSRMappingTableFile[] = "mapping-table.json";

constexpr char kNTPSRMappingTableComponentPublicKey[] = "MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAp7IWv7wzH/KLrxx7BKWOIIUMDylQNzxwM5Fig2WHc16BoMW9Kaya/g17Bpfp0YIvxdcmDBcB9kFALqQLxi1WQfa9d7YxqcmAGUKo407RMwEa6dQVkIPMFz2ZPGSfFgr526gYOqWh3Q4h8oN94qxBLgFyT25SMK5zQDGyq96ntME4MQRNwpDBUv7DDK7Npwe9iE8cBgzYTvf0taAFn2ZZi1RhS0RzpdynucpKosnc0sVBLTXy+HDvnMr+77T48zM0YmpjIh8Qmrp9CNbKzZUsZzNfnHpL9IZnjwQ51EOYdPGX2r1obChVZN19HzpK5scZEMRKoCMfCepWpEkMSIoPzQIDAQAB"; // NOLINT
Expand Down Expand Up @@ -84,17 +83,7 @@ std::string HandleComponentData(
const base::FilePath& installed_dir,
const base::FilePath& super_referral_cache_dir,
bool is_super_referral) {
const auto ntp_si_manifest_path =
installed_dir.AppendASCII(kNTPSIManifestFile);
const auto ntp_sr_manifest_path =
installed_dir.AppendASCII(kNTPSRManifestFile);

base::FilePath json_path;
if (base::PathExists(ntp_si_manifest_path))
json_path = ntp_si_manifest_path;
else if (base::PathExists(ntp_sr_manifest_path))
json_path = ntp_sr_manifest_path;

base::FilePath json_path = installed_dir.AppendASCII(kNTPManifestFile);
std::string contents;

if (json_path.empty()) {
Expand All @@ -117,6 +106,21 @@ std::string HandleComponentData(

} // namespace

// static
void NTPBackgroundImagesService::RegisterLocalStatePrefs(
PrefRegistrySimple* registry) {
registry->RegisterDictionaryPref(
prefs::kNewTabPageCachedSuperReferralComponentInfo);
registry->RegisterStringPref(
prefs::kNewTabPageCachedSuperReferralComponentData, std::string());
registry->RegisterStringPref(
prefs::kNewTabPageCachedSuperReferralCode, std::string());
registry->RegisterListPref(
prefs::kNewTabPageCachedSuperReferralFaviconList);
registry->RegisterBooleanPref(
prefs::kNewTabPageGetInitialSRComponentInProgress, false);
}

NTPBackgroundImagesService::NTPBackgroundImagesService(
component_updater::ComponentUpdateService* cus,
PrefService* local_pref,
Expand Down Expand Up @@ -538,6 +542,21 @@ void NTPBackgroundImagesService::RestoreCachedTopSitesFaviconList() {
cached_top_site_favicon_list_.push_back(file.GetString());
}

bool NTPBackgroundImagesService::IsValidSuperReferralComponentInfo(
const base::Value& component_info) const {
if (!component_info.is_dict())
return false;

if (!component_info.FindStringKey(kPublicKey))
return false;
if (!component_info.FindStringKey(kComponentID))
return false;
if (!component_info.FindStringKey(kThemeName))
return false;

return true;
}

std::vector<std::string>
NTPBackgroundImagesService::GetCachedTopSitesFaviconList() const {
return cached_top_site_favicon_list_;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ namespace component_updater {
class ComponentUpdateService;
} // namespace component_updater

class PrefRegistrySimple;
class PrefService;

namespace ntp_background_images {
Expand All @@ -38,6 +39,8 @@ class NTPBackgroundImagesService {
virtual ~Observer() {}
};

static void RegisterLocalStatePrefs(PrefRegistrySimple* registry);

NTPBackgroundImagesService(
component_updater::ComponentUpdateService* cus,
PrefService* local_pref,
Expand Down Expand Up @@ -111,6 +114,8 @@ class NTPBackgroundImagesService {
void OnGetMappingTableData(const std::string& json_string);

std::string GetReferralPromoCode() const;
bool IsValidSuperReferralComponentInfo(
const base::Value& component_info) const;

void CacheTopSitesFaviconList();
void RestoreCachedTopSitesFaviconList();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@
#include "brave/components/brave_referrals/browser/brave_referrals_service.h"
#include "brave/components/ntp_background_images/browser/ntp_background_images_data.h"
#include "brave/components/ntp_background_images/browser/ntp_background_images_service.h"
#include "brave/components/ntp_background_images/browser/ntp_background_images_utils.h"
#include "brave/components/ntp_background_images/common/pref_names.h"
#include "components/prefs/testing_pref_service.h"
#include "testing/gtest/include/gtest/gtest.h"
Expand Down Expand Up @@ -116,7 +115,7 @@ class NTPBackgroundImagesServiceTest : public testing::Test {

void SetUp() override {
auto* registry = pref_service_.registry();
RegisterLocalStatePrefs(registry);
NTPBackgroundImagesService::RegisterLocalStatePrefs(registry);
brave::RegisterPrefsForBraveReferralsService(registry);
}

Expand Down Expand Up @@ -398,7 +397,7 @@ TEST_F(NTPBackgroundImagesServiceTest, WithSuperReferralCodeTest) {
EXPECT_TRUE(service_->mapping_table_requested_);
EXPECT_FALSE(service_->marked_this_install_is_not_super_referral_forever_);

EXPECT_FALSE(IsValidSuperReferralComponentInfo(*pref_service_.Get(
EXPECT_FALSE(service_->IsValidSuperReferralComponentInfo(*pref_service_.Get(
prefs::kNewTabPageCachedSuperReferralComponentInfo)));
service_->OnGetMappingTableData(kTestMappingTable);
EXPECT_TRUE(pref_service_.GetBoolean(
Expand All @@ -417,7 +416,7 @@ TEST_F(NTPBackgroundImagesServiceTest, WithSuperReferralCodeTest) {
EXPECT_FALSE(pref_service_.GetBoolean(
prefs::kNewTabPageGetInitialSRComponentInProgress));
auto* data = service_->GetBackgroundImagesData(true);
EXPECT_TRUE(IsValidSuperReferralComponentInfo(*pref_service_.Get(
EXPECT_TRUE(service_->IsValidSuperReferralComponentInfo(*pref_service_.Get(
prefs::kNewTabPageCachedSuperReferralComponentInfo)));
EXPECT_TRUE(data->IsSuperReferral());
EXPECT_FALSE(pref_service_.GetString(
Expand All @@ -427,7 +426,7 @@ TEST_F(NTPBackgroundImagesServiceTest, WithSuperReferralCodeTest) {
service_->OnGetComponentJsonData(true, kTestEmptyComponent);
EXPECT_TRUE(pref_service_.GetString(
prefs::kNewTabPageCachedSuperReferralCode).empty());
EXPECT_FALSE(IsValidSuperReferralComponentInfo(*pref_service_.Get(
EXPECT_FALSE(service_->IsValidSuperReferralComponentInfo(*pref_service_.Get(
prefs::kNewTabPageCachedSuperReferralComponentInfo)));
EXPECT_TRUE(pref_service_.GetString(
prefs::kNewTabPageCachedSuperReferralComponentData).empty());
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@
#include "brave/components/ntp_background_images/browser/ntp_background_images_data.h"
#include "brave/components/ntp_background_images/browser/ntp_background_images_service.h"
#include "brave/components/ntp_background_images/browser/ntp_background_images_source.h"
#include "brave/components/ntp_background_images/browser/ntp_background_images_utils.h"
#include "brave/components/ntp_background_images/common/pref_names.h"
#include "components/prefs/testing_pref_service.h"
#include "testing/gtest/include/gtest/gtest.h"
Expand All @@ -25,7 +24,7 @@ class NTPBackgroundImagesSourceTest : public testing::Test {

void SetUp() override {
auto* registry = local_pref_.registry();
ntp_background_images::RegisterLocalStatePrefs(registry);
NTPBackgroundImagesService::RegisterLocalStatePrefs(registry);
brave::RegisterPrefsForBraveReferralsService(registry);
service_.reset(new NTPBackgroundImagesService(
nullptr, &local_pref_, base::FilePath()));
Expand Down

This file was deleted.

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@
#include "brave/components/brave_referrals/browser/brave_referrals_service.h"
#include "brave/components/ntp_background_images/browser/ntp_background_images_data.h"
#include "brave/components/ntp_background_images/browser/ntp_background_images_service.h"
#include "brave/components/ntp_background_images/browser/ntp_background_images_utils.h"
#include "brave/components/ntp_background_images/browser/view_counter_service.h"
#include "brave/components/ntp_background_images/common/pref_names.h"
#include "components/prefs/testing_pref_service.h"
Expand Down Expand Up @@ -58,7 +57,7 @@ class NTPBackgroundImagesViewCounterTest : public testing::Test {
ViewCounterService::RegisterProfilePrefs(registry);
auto* local_registry = local_pref_.registry();
brave::RegisterPrefsForBraveReferralsService(local_registry);
RegisterLocalStatePrefs(local_registry);
NTPBackgroundImagesService::RegisterLocalStatePrefs(local_registry);

service_ = std::make_unique<NTPBackgroundImagesService>(
nullptr,
Expand Down

0 comments on commit a3eeb48

Please sign in to comment.