1 // Copyright 2015 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
5 #include "chrome/browser/banners/app_banner_data_fetcher.h"
7 #include "base/command_line.h"
8 #include "base/location.h"
9 #include "base/run_loop.h"
10 #include "base/single_thread_task_runner.h"
11 #include "base/task_runner.h"
12 #include "base/thread_task_runner_handle.h"
13 #include "chrome/browser/banners/app_banner_data_fetcher_desktop.h"
14 #include "chrome/browser/banners/app_banner_settings_helper.h"
15 #include "chrome/browser/ui/browser.h"
16 #include "chrome/browser/ui/tabs/tab_strip_model.h"
17 #include "chrome/common/chrome_switches.h"
18 #include "chrome/test/base/in_process_browser_test.h"
19 #include "chrome/test/base/ui_test_utils.h"
20 #include "content/public/common/content_switches.h"
21 #include "content/public/test/test_navigation_observer.h"
22 #include "net/test/embedded_test_server/embedded_test_server.h"
26 class TestObserver
: public AppBannerDataFetcher::Observer
{
28 TestObserver(AppBannerDataFetcher
* fetcher
, base::Closure quit_closure
)
30 quit_closure_(quit_closure
) {
31 fetcher_
->AddObserverForTesting(this);
34 virtual ~TestObserver() {
36 fetcher_
->RemoveObserverForTesting(this);
39 void OnDecidedWhetherToShow(AppBannerDataFetcher
* fetcher
,
40 bool will_show
) override
{
41 base::ThreadTaskRunnerHandle::Get()->PostTask(FROM_HERE
, quit_closure_
);
42 ASSERT_FALSE(will_show_
.get());
43 will_show_
.reset(new bool(will_show
));
46 void OnFetcherDestroyed(AppBannerDataFetcher
* fetcher
) override
{
47 base::ThreadTaskRunnerHandle::Get()->PostTask(FROM_HERE
, quit_closure_
);
51 bool will_show() { return will_show_
.get() && *will_show_
; }
54 AppBannerDataFetcher
* fetcher_
;
55 base::Closure quit_closure_
;
56 scoped_ptr
<bool> will_show_
;
59 class AppBannerDataFetcherBrowserTest
: public InProcessBrowserTest
,
60 public AppBannerDataFetcher::Delegate
{
62 AppBannerDataFetcherBrowserTest() : weak_factory_(this) {
65 void SetUpOnMainThread() override
{
66 AppBannerSettingsHelper::SetEngagementWeights(1, 1);
67 ASSERT_TRUE(embedded_test_server()->InitializeAndWaitUntilReady());
68 InProcessBrowserTest::SetUpOnMainThread();
71 bool HandleNonWebApp(const std::string
& platform
,
73 const std::string
& id
) override
{
74 base::ThreadTaskRunnerHandle::Get()->PostTask(FROM_HERE
, quit_closure_
);
75 non_web_platform_
= platform
;
79 void SetUpCommandLine(base::CommandLine
* command_line
) override
{
80 command_line
->AppendSwitch(
81 switches::kEnableExperimentalWebPlatformFeatures
);
82 // Make sure app banners are disabled in the browser, otherwise they will
83 // interfere with the test.
84 command_line
->AppendSwitch(switches::kDisableAddToShelf
);
88 void RunFetcher(const GURL
& url
,
89 const std::string
& expected_non_web_platform
,
90 ui::PageTransition transition
,
91 bool expected_to_show
) {
92 content::WebContents
* web_contents
=
93 browser()->tab_strip_model()->GetActiveWebContents();
94 scoped_refptr
<AppBannerDataFetcherDesktop
> fetcher(
95 new AppBannerDataFetcherDesktop(web_contents
,
96 weak_factory_
.GetWeakPtr(), 128));
98 base::RunLoop run_loop
;
99 quit_closure_
= run_loop
.QuitClosure();
100 scoped_ptr
<TestObserver
> observer(new TestObserver(fetcher
.get(),
101 run_loop
.QuitClosure()));
102 fetcher
->Start(url
, transition
);
105 EXPECT_EQ(expected_non_web_platform
, non_web_platform_
);
106 EXPECT_EQ(expected_to_show
, observer
->will_show());
107 ASSERT_FALSE(fetcher
->is_active());
110 void LoadURLAndWaitForServiceWorker(const GURL
& url
) {
111 content::WebContents
* web_contents
=
112 browser()->tab_strip_model()->GetActiveWebContents();
113 content::TestNavigationObserver
observer(web_contents
, 2);
114 ui_test_utils::NavigateToURL(browser(), url
);
116 EXPECT_EQ("sw_activated", observer
.last_navigation_url().ref());
119 void RunBannerTest(const std::string
& manifest_page
,
120 ui::PageTransition transition
,
121 unsigned int unshown_repetitions
,
123 std::string
valid_page(manifest_page
);
124 GURL test_url
= embedded_test_server()->GetURL(valid_page
);
125 content::WebContents
* web_contents
=
126 browser()->tab_strip_model()->GetActiveWebContents();
128 for (unsigned int i
= 0; i
< unshown_repetitions
; ++i
) {
129 LoadURLAndWaitForServiceWorker(test_url
);
130 RunFetcher(web_contents
->GetURL(), std::string(), transition
, false);
131 AppBannerDataFetcher::SetTimeDeltaForTesting(i
+1);
134 // On the final loop, check whether the banner triggered or not as expected.
135 LoadURLAndWaitForServiceWorker(test_url
);
136 RunFetcher(web_contents
->GetURL(), std::string(), transition
, expectation
);
140 std::string non_web_platform_
;
141 base::Closure quit_closure_
;
142 base::WeakPtrFactory
<AppBannerDataFetcherBrowserTest
> weak_factory_
;
145 IN_PROC_BROWSER_TEST_F(AppBannerDataFetcherBrowserTest
,
146 WebAppBannerCreatedDirect
) {
147 RunBannerTest("/banners/manifest_test_page.html", ui::PAGE_TRANSITION_TYPED
,
151 IN_PROC_BROWSER_TEST_F(AppBannerDataFetcherBrowserTest
,
152 WebAppBannerCreatedDirectSingle
) {
153 AppBannerSettingsHelper::SetEngagementWeights(2, 1);
154 RunBannerTest("/banners/manifest_test_page.html",
155 ui::PAGE_TRANSITION_GENERATED
, 0, true);
158 IN_PROC_BROWSER_TEST_F(AppBannerDataFetcherBrowserTest
,
159 WebAppBannerCreatedDirectMultiple
) {
160 AppBannerSettingsHelper::SetEngagementWeights(0.5, 1);
161 RunBannerTest("/banners/manifest_test_page.html",
162 ui::PAGE_TRANSITION_GENERATED
, 3, true);
165 IN_PROC_BROWSER_TEST_F(AppBannerDataFetcherBrowserTest
,
166 WebAppBannerCreatedIndirect
) {
167 RunBannerTest("/banners/manifest_test_page.html", ui::PAGE_TRANSITION_LINK
,
171 IN_PROC_BROWSER_TEST_F(AppBannerDataFetcherBrowserTest
,
172 WebAppBannerCreatedIndirectSingle
) {
173 AppBannerSettingsHelper::SetEngagementWeights(1, 3);
174 RunBannerTest("/banners/manifest_test_page.html", ui::PAGE_TRANSITION_RELOAD
,
178 IN_PROC_BROWSER_TEST_F(AppBannerDataFetcherBrowserTest
,
179 WebAppBannerCreatedIndirectMultiple
) {
180 AppBannerSettingsHelper::SetEngagementWeights(1, 0.5);
181 RunBannerTest("/banners/manifest_test_page.html", ui::PAGE_TRANSITION_LINK
,
185 IN_PROC_BROWSER_TEST_F(AppBannerDataFetcherBrowserTest
,
186 WebAppBannerCreatedVarious
) {
187 AppBannerSettingsHelper::SetEngagementWeights(0.5, 0.25);
189 std::string
valid_page("/banners/manifest_test_page.html");
190 GURL test_url
= embedded_test_server()->GetURL(valid_page
);
191 content::WebContents
* web_contents
=
192 browser()->tab_strip_model()->GetActiveWebContents();
194 // Add a direct nav on day 1.
195 LoadURLAndWaitForServiceWorker(test_url
);
196 RunFetcher(web_contents
->GetURL(), std::string(), ui::PAGE_TRANSITION_TYPED
,
199 // Add an indirect nav on day 1 which is ignored.
200 LoadURLAndWaitForServiceWorker(test_url
);
201 RunFetcher(web_contents
->GetURL(), std::string(), ui::PAGE_TRANSITION_LINK
,
203 AppBannerDataFetcher::SetTimeDeltaForTesting(1);
205 // Add an indirect nav on day 2.
206 LoadURLAndWaitForServiceWorker(test_url
);
207 RunFetcher(web_contents
->GetURL(), std::string(),
208 ui::PAGE_TRANSITION_MANUAL_SUBFRAME
, false);
210 // Add a direct nav on day 2 which overrides.
211 LoadURLAndWaitForServiceWorker(test_url
);
212 RunFetcher(web_contents
->GetURL(), std::string(),
213 ui::PAGE_TRANSITION_GENERATED
, false);
214 AppBannerDataFetcher::SetTimeDeltaForTesting(2);
216 // Add a direct nav on day 3.
217 LoadURLAndWaitForServiceWorker(test_url
);
218 RunFetcher(web_contents
->GetURL(), std::string(),
219 ui::PAGE_TRANSITION_GENERATED
, false);
220 AppBannerDataFetcher::SetTimeDeltaForTesting(3);
222 // Add an indirect nav on day 4.
223 LoadURLAndWaitForServiceWorker(test_url
);
224 RunFetcher(web_contents
->GetURL(), std::string(),
225 ui::PAGE_TRANSITION_FORM_SUBMIT
, false);
227 // Add a direct nav on day 4 which should trigger the banner.
228 LoadURLAndWaitForServiceWorker(test_url
);
229 RunFetcher(web_contents
->GetURL(), std::string(),
230 ui::PAGE_TRANSITION_TYPED
, true);
233 IN_PROC_BROWSER_TEST_F(AppBannerDataFetcherBrowserTest
,
234 WebAppBannerNoTypeInManifest
) {
235 RunBannerTest("/banners/manifest_no_type_test_page.html",
236 ui::PAGE_TRANSITION_TYPED
, 1, true);
239 IN_PROC_BROWSER_TEST_F(AppBannerDataFetcherBrowserTest
,
240 WebAppBannerNoTypeInManifestCapsExtension
) {
241 RunBannerTest("/banners/manifest_no_type_caps_test_page.html",
242 ui::PAGE_TRANSITION_TYPED
, 1, true);
245 IN_PROC_BROWSER_TEST_F(AppBannerDataFetcherBrowserTest
, PlayAppManifest
) {
246 std::string
valid_page("/banners/play_app_test_page.html");
247 GURL test_url
= embedded_test_server()->GetURL(valid_page
);
248 content::WebContents
* web_contents
=
249 browser()->tab_strip_model()->GetActiveWebContents();
251 // Native banners do not require the SW, so we can just load the URL.
252 ui_test_utils::NavigateToURL(browser(), test_url
);
253 std::string
play_platform("play");
254 RunFetcher(web_contents
->GetURL(), play_platform
, ui::PAGE_TRANSITION_TYPED
,
257 // The logic to get the details for a play app banner are only on android
258 // builds, so this test does not check that the banner is shown.
261 IN_PROC_BROWSER_TEST_F(AppBannerDataFetcherBrowserTest
, NoManifest
) {
262 RunBannerTest("/banners/no_manifest_test_page.html",
263 ui::PAGE_TRANSITION_TYPED
, 1, false);
266 IN_PROC_BROWSER_TEST_F(AppBannerDataFetcherBrowserTest
, CancelBannerDirect
) {
267 RunBannerTest("/banners/cancel_test_page.html", ui::PAGE_TRANSITION_TYPED
, 1,
271 IN_PROC_BROWSER_TEST_F(AppBannerDataFetcherBrowserTest
, CancelBannerIndirect
) {
272 AppBannerSettingsHelper::SetEngagementWeights(1, 0.5);
273 RunBannerTest("/banners/cancel_test_page.html", ui::PAGE_TRANSITION_TYPED
, 3,
277 IN_PROC_BROWSER_TEST_F(AppBannerDataFetcherBrowserTest
, PromptBanner
) {
278 RunBannerTest("/banners/prompt_test_page.html", ui::PAGE_TRANSITION_TYPED
, 1,
282 IN_PROC_BROWSER_TEST_F(AppBannerDataFetcherBrowserTest
, PromptBannerInHandler
) {
283 RunBannerTest("/banners/prompt_in_handler_test_page.html",
284 ui::PAGE_TRANSITION_TYPED
, 1, true);
287 IN_PROC_BROWSER_TEST_F(AppBannerDataFetcherBrowserTest
, WebAppBannerInIFrame
) {
288 RunBannerTest("/banners/iframe_test_page.html", ui::PAGE_TRANSITION_TYPED
, 1,
292 } // namespace banners