-
Notifications
You must be signed in to change notification settings - Fork 909
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add Brave Ads status header to search.brave.com calls.
- Loading branch information
Showing
8 changed files
with
244 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
51 changes: 51 additions & 0 deletions
51
components/brave_ads/browser/ads_status_header_throttle.cc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| /* Copyright 2022 The Brave Authors. All rights reserved. | ||
| * This Source Code Form is subject to the terms of the Mozilla Public | ||
| * License, v. 2.0. If a copy of the MPL was not distributed with this file, | ||
| * You can obtain one at http://mozilla.org/MPL/2.0/. */ | ||
|
|
||
| #include "brave/components/brave_ads/browser/ads_status_header_throttle.h" | ||
|
|
||
| #include "brave/components/brave_ads/browser/ads_service.h" | ||
| #include "brave/components/brave_search/common/brave_search_utils.h" | ||
| #include "services/network/public/cpp/resource_request.h" | ||
| #include "third_party/blink/public/mojom/loader/resource_load_info.mojom-shared.h" | ||
|
|
||
| namespace { | ||
|
|
||
| constexpr char kAdsStatusHeader[] = "X-Brave-Ads-Enabled"; | ||
| constexpr char kAdsEnabledStatusValue[] = "1"; | ||
|
|
||
| } // namespace | ||
|
|
||
| namespace brave_ads { | ||
|
|
||
| // static | ||
| std::unique_ptr<blink::URLLoaderThrottle> | ||
| AdsStatusHeaderThrottle::MaybeCreateThrottle( | ||
| const AdsService* ads_service, | ||
| const network::ResourceRequest& request) { | ||
| DCHECK_EQ(request.resource_type, | ||
| static_cast<int>(blink::mojom::ResourceType::kMainFrame)); | ||
| if (!ads_service || !ads_service->IsEnabled() || | ||
| !request.is_outermost_main_frame || | ||
| !brave_search::IsAllowedHost(request.url)) { | ||
| return nullptr; | ||
| } | ||
|
|
||
| return std::make_unique<AdsStatusHeaderThrottle>(); | ||
| } | ||
|
|
||
| AdsStatusHeaderThrottle::AdsStatusHeaderThrottle() = default; | ||
|
|
||
| AdsStatusHeaderThrottle::~AdsStatusHeaderThrottle() = default; | ||
|
|
||
| void AdsStatusHeaderThrottle::WillStartRequest( | ||
| network::ResourceRequest* request, | ||
| bool* /* defer */) { | ||
| DCHECK(request); | ||
| DCHECK(brave_search::IsAllowedHost(request->url)); | ||
|
|
||
| request->headers.SetHeader(kAdsStatusHeader, kAdsEnabledStatusValue); | ||
| } | ||
|
|
||
| } // namespace brave_ads |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| /* Copyright 2022 The Brave Authors. All rights reserved. | ||
| * This Source Code Form is subject to the terms of the Mozilla Public | ||
| * License, v. 2.0. If a copy of the MPL was not distributed with this file, | ||
| * You can obtain one at http://mozilla.org/MPL/2.0/. */ | ||
|
|
||
| #ifndef BRAVE_COMPONENTS_BRAVE_ADS_BROWSER_ADS_STATUS_HEADER_THROTTLE_H_ | ||
| #define BRAVE_COMPONENTS_BRAVE_ADS_BROWSER_ADS_STATUS_HEADER_THROTTLE_H_ | ||
|
|
||
| #include <memory> | ||
|
|
||
| #include "third_party/blink/public/common/loader/url_loader_throttle.h" | ||
|
|
||
| namespace network { | ||
| struct ResourceRequest; | ||
| } // namespace network | ||
|
|
||
| namespace brave_ads { | ||
|
|
||
| class AdsService; | ||
|
|
||
| class AdsStatusHeaderThrottle : public blink::URLLoaderThrottle { | ||
| public: | ||
| static std::unique_ptr<blink::URLLoaderThrottle> MaybeCreateThrottle( | ||
| const AdsService* ads_service, | ||
| const network::ResourceRequest& request); | ||
|
|
||
| AdsStatusHeaderThrottle(); | ||
| ~AdsStatusHeaderThrottle() override; | ||
|
|
||
| AdsStatusHeaderThrottle(const AdsStatusHeaderThrottle&) = delete; | ||
| AdsStatusHeaderThrottle& operator=(const AdsStatusHeaderThrottle&) = delete; | ||
| AdsStatusHeaderThrottle(AdsStatusHeaderThrottle&&) = delete; | ||
| AdsStatusHeaderThrottle& operator=(AdsStatusHeaderThrottle&&) = delete; | ||
|
|
||
| // Implements blink::URLLoaderThrottle: | ||
| void WillStartRequest(network::ResourceRequest* request, | ||
| bool* defer) override; | ||
| }; | ||
|
|
||
| } // namespace brave_ads | ||
|
|
||
| #endif // BRAVE_COMPONENTS_BRAVE_ADS_BROWSER_ADS_STATUS_HEADER_THROTTLE_H_ |
97 changes: 97 additions & 0 deletions
97
components/brave_ads/browser/ads_status_header_throttle_unittest.cc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| /* Copyright (c) 2022 The Brave Authors. All rights reserved. | ||
| * This Source Code Form is subject to the terms of the Mozilla Public | ||
| * License, v. 2.0. If a copy of the MPL was not distributed with this file, | ||
| * You can obtain one at http://mozilla.org/MPL/2.0/. */ | ||
|
|
||
| #include <string> | ||
|
|
||
| #include "brave/components/brave_ads/browser/ads_service.h" | ||
| #include "brave/components/brave_ads/browser/ads_status_header_throttle.h" | ||
| #include "brave/components/brave_ads/browser/mock_ads_service.h" | ||
| #include "services/network/public/cpp/resource_request.h" | ||
| #include "testing/gtest/include/gtest/gtest.h" | ||
| #include "third_party/blink/public/mojom/loader/resource_load_info.mojom-shared.h" | ||
|
|
||
| using ::testing::Return; | ||
|
|
||
| namespace { | ||
|
|
||
| constexpr char kAdsStatusHeader[] = "X-Brave-Ads-Enabled"; | ||
| constexpr char kAdsEnabledStatusValue[] = "1"; | ||
| constexpr char kAllowedURL[] = "https://search.brave.com/search"; | ||
| constexpr char kNotAllowedURL[] = "https://brave.com/search"; | ||
| constexpr char kTestingHeaderName[] = "TestingHeaderName"; | ||
| constexpr char kTestingHeaderValue[] = "TestingHeaderValue"; | ||
|
|
||
| } // namespace | ||
|
|
||
| namespace brave_ads { | ||
|
|
||
| class AdsStatusHeaderThrottleTest : public ::testing::Test { | ||
| public: | ||
| void SetUp() override { | ||
| ON_CALL(mock_ads_service_, IsEnabled()).WillByDefault(Return(true)); | ||
| } | ||
|
|
||
| const AdsService* GetAdsService() const { return &mock_ads_service_; } | ||
|
|
||
| network::ResourceRequest BuildRequest() { | ||
| network::ResourceRequest request; | ||
| request.url = GURL(kAllowedURL); | ||
| request.is_outermost_main_frame = true; | ||
| request.headers.SetHeader("TestingHeaderName", "TestingHeaderValue"); | ||
| return request; | ||
| } | ||
|
|
||
| private: | ||
| MockAdsService mock_ads_service_; | ||
| }; | ||
|
|
||
| TEST_F(AdsStatusHeaderThrottleTest, AdsEnabledForAllowedHost) { | ||
| network::ResourceRequest request = BuildRequest(); | ||
| auto throttle = | ||
| AdsStatusHeaderThrottle::MaybeCreateThrottle(GetAdsService(), request); | ||
| ASSERT_TRUE(throttle); | ||
| bool defer = false; | ||
| throttle->WillStartRequest(&request, &defer); | ||
| EXPECT_FALSE(defer); | ||
| std::string value; | ||
| EXPECT_TRUE(request.headers.GetHeader(kAdsStatusHeader, &value)); | ||
| EXPECT_EQ(kAdsEnabledStatusValue, value); | ||
| EXPECT_TRUE(request.headers.GetHeader(kTestingHeaderName, &value)); | ||
| EXPECT_EQ(kTestingHeaderValue, value); | ||
| } | ||
|
|
||
| TEST_F(AdsStatusHeaderThrottleTest, AdsDisabledForAllowedHost) { | ||
| network::ResourceRequest request = BuildRequest(); | ||
| MockAdsService ads_service; | ||
| EXPECT_CALL(ads_service, IsEnabled()).WillOnce(Return(false)); | ||
| auto throttle = | ||
| AdsStatusHeaderThrottle::MaybeCreateThrottle(&ads_service, request); | ||
| EXPECT_FALSE(throttle); | ||
| } | ||
|
|
||
| TEST_F(AdsStatusHeaderThrottleTest, IncognitoModeForAllowedHost) { | ||
| network::ResourceRequest request = BuildRequest(); | ||
| auto throttle = | ||
| AdsStatusHeaderThrottle::MaybeCreateThrottle(nullptr, request); | ||
| EXPECT_FALSE(throttle); | ||
| } | ||
|
|
||
| TEST_F(AdsStatusHeaderThrottleTest, AdsEnabledForNotAllowedHost) { | ||
| network::ResourceRequest request = BuildRequest(); | ||
| request.url = GURL(kNotAllowedURL); | ||
| auto throttle = | ||
| AdsStatusHeaderThrottle::MaybeCreateThrottle(GetAdsService(), request); | ||
| EXPECT_FALSE(throttle); | ||
| } | ||
|
|
||
| TEST_F(AdsStatusHeaderThrottleTest, NonOutermostMainFrameNavigation) { | ||
| network::ResourceRequest request = BuildRequest(); | ||
| request.is_outermost_main_frame = false; | ||
| auto throttle = | ||
| AdsStatusHeaderThrottle::MaybeCreateThrottle(GetAdsService(), request); | ||
| EXPECT_FALSE(throttle); | ||
| } | ||
|
|
||
| } // namespace brave_ads |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters