blob: 60b1ae7982814053205c09d5c3e0f9afb1552d2f [file] [log] [blame]
sdefresned9217bc2016-12-19 13:58:321// Copyright 2012 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.
4
5#import <UIKit/UIKit.h>
6
Rohit Rao44f204302017-08-10 14:49:547#include "ios/chrome/browser/prerender/preload_controller.h"
sdefresned9217bc2016-12-19 13:58:328
Hans Wennborg3a2fb61f2020-05-11 15:51:169#include "base/check_op.h"
sdefresned9217bc2016-12-19 13:58:3210#include "base/ios/device_util.h"
sdefresned9217bc2016-12-19 13:58:3211#include "base/metrics/field_trial.h"
asvitkinef1899e32017-01-27 16:30:2912#include "base/metrics/histogram_macros.h"
sdefresned9217bc2016-12-19 13:58:3213#include "base/strings/sys_string_conversions.h"
Moe Ahmadi7431d0b2018-04-13 17:32:2014#import "components/prefs/ios/pref_observer_bridge.h"
sdefresned9217bc2016-12-19 13:58:3215#include "components/prefs/pref_service.h"
edchincd32fdf2017-10-25 12:45:4516#import "components/signin/ios/browser/account_consistency_service.h"
mrefaat3ad5e412018-08-02 20:11:3417#import "ios/chrome/browser/app_launcher/app_launcher_tab_helper.h"
sdefresned9217bc2016-12-19 13:58:3218#include "ios/chrome/browser/browser_state/chrome_browser_state.h"
mrefaat4aec47b2019-03-29 18:44:2119#include "ios/chrome/browser/crash_report/crash_report_helper.h"
Sylvain Defresnef5d2d952017-11-14 11:15:3120#import "ios/chrome/browser/geolocation/omnibox_geolocation_controller.h"
Sylvain Defresnef5b8a8e2017-10-24 02:54:4421#import "ios/chrome/browser/history/history_tab_helper.h"
mrefaat3ad5e412018-08-02 20:11:3422#import "ios/chrome/browser/itunes_urls/itunes_urls_handler_tab_helper.h"
sdefresned9217bc2016-12-19 13:58:3223#include "ios/chrome/browser/pref_names.h"
Rohit Rao44f204302017-08-10 14:49:5424#include "ios/chrome/browser/prerender/preload_controller_delegate.h"
Stepan Khapugin193af312020-10-01 16:18:4025#import "ios/chrome/browser/prerender/prerender_pref.h"
edchincd32fdf2017-10-25 12:45:4526#import "ios/chrome/browser/signin/account_consistency_service_factory.h"
sdefresne2c600c52017-04-04 16:49:5927#import "ios/chrome/browser/tabs/tab_helper_util.h"
Eugene Butde5ddcdc2019-07-23 00:23:4228#import "ios/web/public/navigation/navigation_item.h"
29#import "ios/web/public/navigation/navigation_manager.h"
30#import "ios/web/public/navigation/web_state_policy_decider_bridge.h"
Yi Sua98c08fb2019-06-13 09:03:5631#include "ios/web/public/thread/web_thread.h"
Kurt Horimoto271707392019-09-21 00:28:0832#import "ios/web/public/ui/java_script_dialog_presenter.h"
Justin Cohen6836cfc52019-10-02 13:28:5833#include "ios/web/public/web_client.h"
Eugene Butd3564aaea2019-08-13 15:50:4534#import "ios/web/public/web_state.h"
Eugene But45bb9962019-09-16 17:34:2135#import "ios/web/public/web_state_observer_bridge.h"
sdefresned9217bc2016-12-19 13:58:3236#import "net/base/mac/url_conversions.h"
sdefresned9217bc2016-12-19 13:58:3237#include "ui/base/page_transition_types.h"
38
stkhapugine757b63a2017-04-10 12:31:2739#if !defined(__has_feature) || !__has_feature(objc_arc)
40#error "This file requires ARC support."
41#endif
42
mrefaat3ad5e412018-08-02 20:11:3443using web::WebStatePolicyDecider;
44
Kurt Horimotoeb0081e2019-09-26 18:53:3545// Protocol used to cancel a scheduled preload request.
46@protocol PreloadCancelling <NSObject>
Kurt Horimoto271707392019-09-21 00:28:0847
48// Schedules the current prerender to be cancelled during the next run of the
49// event loop.
50- (void)schedulePrerenderCancel;
51
Kurt Horimoto271707392019-09-21 00:28:0852@end
53
54namespace {
55
56// PrerenderFinalStatus values are used in the "Prerender.FinalStatus" histogram
57// and new values needs to be kept in sync with histogram.xml.
58enum PrerenderFinalStatus {
59 PRERENDER_FINAL_STATUS_USED = 0,
60 PRERENDER_FINAL_STATUS_MEMORY_LIMIT_EXCEEDED = 12,
61 PRERENDER_FINAL_STATUS_CANCELLED = 32,
62 PRERENDER_FINAL_STATUS_MAX = 52,
63};
64
65// Delay before starting to prerender a URL.
66const NSTimeInterval kPrerenderDelay = 0.5;
67
68// The finch experiment to turn off prerendering as a field trial.
69const char kTabEvictionFieldTrialName[] = "TabEviction";
70// The associated group.
71const char kPrerenderTabEvictionTrialGroup[] = "NoPrerendering";
72// The name of the histogram for recording final status (e.g. used/cancelled)
73// of prerender requests.
74const char kPrerenderFinalStatusHistogramName[] = "Prerender.FinalStatus";
75// The name of the histogram for recording the number of successful prerenders.
76const char kPrerendersPerSessionCountHistogramName[] =
77 "Prerender.PrerendersPerSessionCount";
78// The name of the histogram for recording time until a successful prerender.
Gauthier Ambard6d3ed3472020-05-11 09:11:4879const char kPrerenderPrerenderTimeSaved[] = "Prerender.PrerenderTimeSaved";
80// Histogram to record that the load was complete when the prerender was used.
81// Not recorded if the pre-render isn't used.
82const char kPrerenderLoadComplete[] = "Prerender.PrerenderLoadComplete";
Kurt Horimoto271707392019-09-21 00:28:0883
84// Is this install selected for this particular experiment.
85bool IsPrerenderTabEvictionExperimentalGroup() {
86 base::FieldTrial* trial =
87 base::FieldTrialList::Find(kTabEvictionFieldTrialName);
88 return trial && trial->group_name() == kPrerenderTabEvictionTrialGroup;
89}
90
Kurt Horimotoeb0081e2019-09-26 18:53:3591// Returns whether |url| can be prerendered.
92bool CanPrerenderURL(const GURL& url) {
93 // Prerendering is only enabled for http and https URLs.
94 return url.is_valid() &&
95 (url.SchemeIs(url::kHttpScheme) || url.SchemeIs(url::kHttpsScheme));
96}
97
98// Object used to schedule prerenders.
99class PrerenderRequest {
100 public:
101 PrerenderRequest() {}
102 PrerenderRequest(const GURL& url,
103 ui::PageTransition transition,
104 const web::Referrer& referrer)
105 : url_(url), transition_(transition), referrer_(referrer) {}
106
107 const GURL& url() const { return url_; }
108 ui::PageTransition transition() const { return transition_; }
109 const web::Referrer referrer() const { return referrer_; }
110
111 private:
112 const GURL url_;
113 const ui::PageTransition transition_ = ui::PAGE_TRANSITION_LINK;
114 const web::Referrer referrer_;
115};
116
Kurt Horimoto271707392019-09-21 00:28:08117// A no-op JavaScriptDialogPresenter that cancels prerendering when the
118// prerendered page attempts to show dialogs.
119class PreloadJavaScriptDialogPresenter : public web::JavaScriptDialogPresenter {
120 public:
Kurt Horimotoeb0081e2019-09-26 18:53:35121 explicit PreloadJavaScriptDialogPresenter(
122 id<PreloadCancelling> cancel_handler)
123 : cancel_handler_(cancel_handler) {
124 DCHECK(cancel_handler_);
Kurt Horimoto271707392019-09-21 00:28:08125 }
126
127 // web::JavaScriptDialogPresenter:
128 void RunJavaScriptDialog(web::WebState* web_state,
129 const GURL& origin_url,
130 web::JavaScriptDialogType dialog_type,
131 NSString* message_text,
132 NSString* default_prompt_text,
133 web::DialogClosedCallback callback) override {
134 std::move(callback).Run(NO, nil);
Kurt Horimotoeb0081e2019-09-26 18:53:35135 [cancel_handler_ schedulePrerenderCancel];
Kurt Horimoto271707392019-09-21 00:28:08136 }
137
138 void CancelDialogs(web::WebState* web_state) override {}
139
140 private:
Kurt Horimotoeb0081e2019-09-26 18:53:35141 __weak id<PreloadCancelling> cancel_handler_ = nil;
Kurt Horimoto271707392019-09-21 00:28:08142};
143} // namespace
144
Kurt Horimotoeb0081e2019-09-26 18:53:35145@interface PreloadController () <CRConnectionTypeObserverBridge,
146 CRWWebStateDelegate,
147 CRWWebStateObserver,
148 CRWWebStatePolicyDecider,
149 ManageAccountsDelegate,
150 PrefObserverDelegate,
151 PreloadCancelling> {
152 std::unique_ptr<web::WebStateDelegateBridge> _webStateDelegate;
153 std::unique_ptr<web::WebStateObserverBridge> _webStateObserver;
154 std::unique_ptr<PrefObserverBridge> _observerBridge;
155 std::unique_ptr<ConnectionTypeObserverBridge> _connectionTypeObserver;
156 std::unique_ptr<web::WebStatePolicyDeciderBridge> _policyDeciderBridge;
sdefresned9217bc2016-12-19 13:58:32157
Kurt Horimotoeb0081e2019-09-26 18:53:35158 // The WebState used for prerendering.
159 std::unique_ptr<web::WebState> _webState;
160
161 // The scheduled request.
162 std::unique_ptr<PrerenderRequest> _scheduledRequest;
163
164 // Registrar for pref changes notifications.
165 PrefChangeRegistrar _prefChangeRegistrar;
166
167 // The dialog presenter.
168 std::unique_ptr<web::JavaScriptDialogPresenter> _dialogPresenter;
169}
170
171// The ChromeBrowserState passed on initialization.
Sylvain Defresne8f0cda2b2020-01-24 11:50:00172@property(nonatomic) ChromeBrowserState* browserState;
Kurt Horimotoeb0081e2019-09-26 18:53:35173
174// Redefine property as readwrite. The URL that is prerendered in |_webState|.
175// This can be different from the value returned by WebState last committed
176// navigation item, for example in cases where there was a redirect.
177//
178// When choosing whether or not to use a prerendered Tab,
179// BrowserViewController compares the URL being loaded by the omnibox with the
180// URL of the prerendered Tab. Comparing against the Tab's currently URL
181// could return false negatives in cases of redirect, hence the need to store
182// the originally prerendered URL.
183@property(nonatomic, readwrite, assign) GURL prerenderedURL;
184
185// The URL in the currently scheduled prerender request, or an empty one if
186// there is no prerender scheduled.
187@property(nonatomic, readonly) const GURL& scheduledURL;
188
Stepan Khapugin193af312020-10-01 16:18:40189// Network prediction settings.
190@property(nonatomic)
191 prerender_prefs::NetworkPredictionSetting networkPredictionSetting;
Kurt Horimotoeb0081e2019-09-26 18:53:35192
193// Whether or not the current connection is using WWAN.
Stepan Khapugin193af312020-10-01 16:18:40194@property(nonatomic, assign) BOOL isOnCellularNetwork;
Kurt Horimotoeb0081e2019-09-26 18:53:35195
196// Number of successful prerenders (i.e. the user viewed the prerendered page)
197// during the lifetime of this controller.
198@property(nonatomic) NSUInteger successfulPrerendersPerSessionCount;
199
200// Tracks the time of the last attempt to load a prerender URL. Used for UMA
201// reporting of load durations.
202@property(nonatomic) base::TimeTicks startTime;
203
Gauthier Ambard6d3ed3472020-05-11 09:11:48204// Whether the load was completed or not.
205@property(nonatomic, assign) BOOL loadCompleted;
206// The time between the start of the load and the completion (only valid if the
207// load completed).
208@property(nonatomic) base::TimeDelta completionTime;
209
Kurt Horimotoeb0081e2019-09-26 18:53:35210// Called to start any scheduled prerendering requests.
211- (void)startPrerender;
212
213// Destroys the preview Tab and resets |prerenderURL_| to the empty URL.
214- (void)destroyPreviewContents;
215
216// Removes any scheduled prerender requests and resets |scheduledURL| to the
217// empty URL.
218- (void)removeScheduledPrerenderRequests;
219
220// Records metric on a successful prerender.
221- (void)recordReleaseMetrics;
222
223@end
224
225@implementation PreloadController
Kurt Horimoto38bfb152019-09-25 21:05:41226
Sylvain Defresne8f0cda2b2020-01-24 11:50:00227- (instancetype)initWithBrowserState:(ChromeBrowserState*)browserState {
sdefresned9217bc2016-12-19 13:58:32228 DCHECK(browserState);
229 DCHECK_CURRENTLY_ON(web::WebThread::UI);
230 if ((self = [super init])) {
Kurt Horimotoeb0081e2019-09-26 18:53:35231 _browserState = browserState;
Stepan Khapugin193af312020-10-01 16:18:40232 _networkPredictionSetting =
233 static_cast<prerender_prefs::NetworkPredictionSetting>(
234 _browserState->GetPrefs()->GetInteger(
235 prefs::kNetworkPredictionSetting));
236 _isOnCellularNetwork = net::NetworkChangeNotifier::IsConnectionCellular(
sdefresned9217bc2016-12-19 13:58:32237 net::NetworkChangeNotifier::GetConnectionType());
Kurt Horimotoeb0081e2019-09-26 18:53:35238 _webStateDelegate = std::make_unique<web::WebStateDelegateBridge>(self);
239 _webStateObserver = std::make_unique<web::WebStateObserverBridge>(self);
240 _observerBridge = std::make_unique<PrefObserverBridge>(self);
241 _prefChangeRegistrar.Init(_browserState->GetPrefs());
242 _observerBridge->ObserveChangesForPreference(
Stepan Khapugin193af312020-10-01 16:18:40243 prefs::kNetworkPredictionSetting, &_prefChangeRegistrar);
Kurt Horimotoeb0081e2019-09-26 18:53:35244 _dialogPresenter = std::make_unique<PreloadJavaScriptDialogPresenter>(self);
Stepan Khapugin193af312020-10-01 16:18:40245 if (_networkPredictionSetting ==
246 prerender_prefs::NetworkPredictionSetting::kEnabledWifiOnly) {
Kurt Horimotoeb0081e2019-09-26 18:53:35247 _connectionTypeObserver =
Sylvain Defresne949367262018-03-02 22:33:16248 std::make_unique<ConnectionTypeObserverBridge>(self);
sdefresned9217bc2016-12-19 13:58:32249 }
250
251 [[NSNotificationCenter defaultCenter]
252 addObserver:self
253 selector:@selector(didReceiveMemoryWarning)
254 name:UIApplicationDidReceiveMemoryWarningNotification
255 object:nil];
256 }
257 return self;
258}
259
sdefresned9217bc2016-12-19 13:58:32260- (void)dealloc {
Steven Holte95922222018-09-14 20:06:23261 UMA_HISTOGRAM_COUNTS_1M(kPrerendersPerSessionCountHistogramName,
Kurt Horimotoeb0081e2019-09-26 18:53:35262 self.successfulPrerendersPerSessionCount);
sdefresned9217bc2016-12-19 13:58:32263 [self cancelPrerender];
sdefresned9217bc2016-12-19 13:58:32264}
265
Kurt Horimotoeb0081e2019-09-26 18:53:35266#pragma mark - Accessors
267
268- (const GURL&)scheduledURL {
269 return _scheduledRequest ? _scheduledRequest->url() : GURL::EmptyGURL();
270}
271
272- (BOOL)isEnabled {
273 DCHECK_CURRENTLY_ON(web::WebThread::UI);
Stepan Khapugin193af312020-10-01 16:18:40274
275 if (IsPrerenderTabEvictionExperimentalGroup() ||
276 ios::device_util::IsSingleCoreDevice() ||
277 !ios::device_util::RamIsAtLeast512Mb() ||
278 net::NetworkChangeNotifier::IsOffline()) {
279 return false;
280 }
281
282 switch (self.networkPredictionSetting) {
283 case prerender_prefs::NetworkPredictionSetting::kEnabledWifiOnly: {
284 return !self.isOnCellularNetwork;
285 }
286
287 case prerender_prefs::NetworkPredictionSetting::kEnabledWifiAndCellular: {
288 return true;
289 }
290
291 case prerender_prefs::NetworkPredictionSetting::kDisabled: {
292 return false;
293 }
294 }
Kurt Horimotoeb0081e2019-09-26 18:53:35295}
296
Gauthier Ambard6d3ed3472020-05-11 09:11:48297- (void)setLoadCompleted:(BOOL)loadCompleted {
298 if (_loadCompleted == loadCompleted)
299 return;
300
301 _loadCompleted = loadCompleted;
302
303 if (loadCompleted) {
304 self.completionTime = base::TimeTicks::Now() - self.startTime;
305 } else {
306 self.completionTime = base::TimeDelta();
307 }
308}
309
Kurt Horimotoeb0081e2019-09-26 18:53:35310#pragma mark - Public
311
312- (void)browserStateDestroyed {
313 [self cancelPrerender];
314 _connectionTypeObserver.reset();
315}
316
sdefresned9217bc2016-12-19 13:58:32317- (void)prerenderURL:(const GURL&)url
318 referrer:(const web::Referrer&)referrer
319 transition:(ui::PageTransition)transition
320 immediately:(BOOL)immediately {
Kurt Horimotoeb0081e2019-09-26 18:53:35321 // TODO(crbug.com/754050): If CanPrerenderURL() returns false, should we
Rohit Rao44f204302017-08-10 14:49:54322 // cancel any scheduled prerender requests?
Kurt Horimotoeb0081e2019-09-26 18:53:35323 if (!self.enabled || !CanPrerenderURL(url))
sdefresned9217bc2016-12-19 13:58:32324 return;
325
326 // Ignore this request if there is already a scheduled request for the same
327 // URL; or, if there is no scheduled request, but the currently prerendered
328 // page matches this URL.
Kurt Horimotoeb0081e2019-09-26 18:53:35329 if (url == self.scheduledURL ||
330 (self.scheduledURL.is_empty() && url == self.prerenderedURL)) {
sdefresned9217bc2016-12-19 13:58:32331 return;
332 }
333
334 [self removeScheduledPrerenderRequests];
Kurt Horimotoeb0081e2019-09-26 18:53:35335 _scheduledRequest =
336 std::make_unique<PrerenderRequest>(url, transition, referrer);
sdefresned9217bc2016-12-19 13:58:32337
338 NSTimeInterval delay = immediately ? 0.0 : kPrerenderDelay;
339 [self performSelector:@selector(startPrerender)
340 withObject:nil
341 afterDelay:delay];
342}
343
sdefresned9217bc2016-12-19 13:58:32344- (void)cancelPrerender {
345 [self cancelPrerenderForReason:PRERENDER_FINAL_STATUS_CANCELLED];
346}
347
348- (void)cancelPrerenderForReason:(PrerenderFinalStatus)reason {
349 [self removeScheduledPrerenderRequests];
350 [self destroyPreviewContentsForReason:reason];
351}
352
Sylvain Defresnef5d2d952017-11-14 11:15:31353- (BOOL)isWebStatePrerendered:(web::WebState*)webState {
Kurt Horimotoeb0081e2019-09-26 18:53:35354 return webState && _webState.get() == webState;
Sylvain Defresnef5d2d952017-11-14 11:15:31355}
356
Justin Cohenceff1a212019-10-01 20:43:43357- (std::unique_ptr<web::WebState>)releasePrerenderContents {
Justin Cohen6836cfc52019-10-02 13:28:58358 if (!_webState ||
359 _webState->GetNavigationManager()->IsRestoreSessionInProgress())
Kurt Horimotoeb0081e2019-09-26 18:53:35360 return nullptr;
361
362 self.successfulPrerendersPerSessionCount++;
Justin Cohen118fee6c2018-12-06 19:36:59363 [self recordReleaseMetrics];
sdefresned9217bc2016-12-19 13:58:32364 [self removeScheduledPrerenderRequests];
Kurt Horimotoeb0081e2019-09-26 18:53:35365 self.prerenderedURL = GURL();
366 self.startTime = base::TimeTicks();
Gauthier Ambard6d3ed3472020-05-11 09:11:48367 self.loadCompleted = NO;
Sylvain Defresnef5b8a8e2017-10-24 02:54:44368
Sylvain Defresnef5d2d952017-11-14 11:15:31369 // Move the pre-rendered WebState to a local variable so that it will no
370 // longer be considered as pre-rendering (otherwise tab helpers may early
371 // exist when invoked).
Kurt Horimotoeb0081e2019-09-26 18:53:35372 std::unique_ptr<web::WebState> webState = std::move(_webState);
Sylvain Defresnef5d2d952017-11-14 11:15:31373 DCHECK(![self isWebStatePrerendered:webState.get()]);
edchincd32fdf2017-10-25 12:45:45374
Kurt Horimotoeb0081e2019-09-26 18:53:35375 webState->RemoveObserver(_webStateObserver.get());
Olivier Robin984283a2020-06-22 11:08:50376 breakpad::StopMonitoringURLsForPreloadWebState(webState.get());
Sylvain Defresnef5d2d952017-11-14 11:15:31377 webState->SetDelegate(nullptr);
Kurt Horimotoeb0081e2019-09-26 18:53:35378 _policyDeciderBridge.reset();
Gauthier Ambard5144bfbd2017-11-15 10:07:52379 HistoryTabHelper::FromWebState(webState.get())
Sylvain Defresnef5d2d952017-11-14 11:15:31380 ->SetDelayHistoryServiceNotification(false);
381
382 if (AccountConsistencyService* accountConsistencyService =
383 ios::AccountConsistencyServiceFactory::GetForBrowserState(
Kurt Horimotoeb0081e2019-09-26 18:53:35384 self.browserState)) {
Gauthier Ambard5144bfbd2017-11-15 10:07:52385 accountConsistencyService->RemoveWebStateHandler(webState.get());
Sylvain Defresnef5d2d952017-11-14 11:15:31386 }
387
mrefaata4bdb95b2018-12-04 18:36:10388 if (!webState->IsLoading()) {
mrefaatc977e372019-02-04 22:19:18389 [[OmniboxGeolocationController sharedInstance]
390 finishPageLoadForWebState:webState.get()
391 loadSuccess:YES];
sdefresne2c600c52017-04-04 16:49:59392 }
393
Sylvain Defresnef5d2d952017-11-14 11:15:31394 return webState;
sdefresned9217bc2016-12-19 13:58:32395}
396
Kurt Horimotoeb0081e2019-09-26 18:53:35397#pragma mark - CRConnectionTypeObserverBridge
398
sdefresned9217bc2016-12-19 13:58:32399- (void)connectionTypeChanged:(net::NetworkChangeNotifier::ConnectionType)type {
400 DCHECK_CURRENTLY_ON(web::WebThread::UI);
Stepan Khapugin193af312020-10-01 16:18:40401 self.isOnCellularNetwork =
402 net::NetworkChangeNotifier::IsConnectionCellular(type);
403 if (self.networkPredictionSetting ==
404 prerender_prefs::NetworkPredictionSetting::kEnabledWifiOnly &&
405 self.isOnCellularNetwork) {
sdefresned9217bc2016-12-19 13:58:32406 [self cancelPrerender];
Stepan Khapugin193af312020-10-01 16:18:40407 }
sdefresned9217bc2016-12-19 13:58:32408}
409
Sylvain Defresnef5d2d952017-11-14 11:15:31410#pragma mark - CRWWebStateDelegate
411
Eugene But6c41f5e2018-11-09 00:39:32412- (web::WebState*)webState:(web::WebState*)webState
413 createNewWebStateForURL:(const GURL&)URL
414 openerURL:(const GURL&)openerURL
415 initiatedByUser:(BOOL)initiatedByUser {
416 DCHECK([self isWebStatePrerendered:webState]);
417 [self schedulePrerenderCancel];
418 return nil;
419}
420
421- (web::JavaScriptDialogPresenter*)javaScriptDialogPresenterForWebState:
422 (web::WebState*)webState {
423 DCHECK([self isWebStatePrerendered:webState]);
Kurt Horimotoeb0081e2019-09-26 18:53:35424 return _dialogPresenter.get();
Eugene But6c41f5e2018-11-09 00:39:32425}
426
Sylvain Defresnef5d2d952017-11-14 11:15:31427- (void)webState:(web::WebState*)webState
428 didRequestHTTPAuthForProtectionSpace:(NSURLProtectionSpace*)protectionSpace
429 proposedCredential:(NSURLCredential*)proposedCredential
430 completionHandler:(void (^)(NSString* username,
431 NSString* password))handler {
432 DCHECK([self isWebStatePrerendered:webState]);
433 [self schedulePrerenderCancel];
434 if (handler) {
435 handler(nil, nil);
436 }
437}
438
Gauthier Ambard99f408192020-08-03 12:56:46439- (UIView*)webViewContainerForWebState:(web::WebState*)webState {
440 return [self.delegate webViewContainer];
441}
442
Sylvain Defresne949367262018-03-02 22:33:16443#pragma mark - CRWWebStateObserver
sdefresned9217bc2016-12-19 13:58:32444
Sylvain Defresne949367262018-03-02 22:33:16445- (void)webState:(web::WebState*)webState
Gauthier Ambard2b604d82019-11-05 13:23:15446 didFinishNavigation:(web::NavigationContext*)navigation {
447 DCHECK_EQ(webState, _webState.get());
448 if ([self shouldCancelPreloadForMimeType:webState->GetContentsMimeType()])
449 [self schedulePrerenderCancel];
450}
451
452- (void)webState:(web::WebState*)webState
Sylvain Defresne949367262018-03-02 22:33:16453 didLoadPageWithSuccess:(BOOL)loadSuccess {
Kurt Horimotoeb0081e2019-09-26 18:53:35454 DCHECK_EQ(webState, _webState.get());
Gauthier Ambard2b604d82019-11-05 13:23:15455 // The load should have been cancelled when the navigation finishes, but this
456 // makes sure that we didn't miss one.
Gauthier Ambard6d3ed3472020-05-11 09:11:48457 if ([self shouldCancelPreloadForMimeType:webState->GetContentsMimeType()]) {
Sylvain Defresne949367262018-03-02 22:33:16458 [self schedulePrerenderCancel];
Gauthier Ambard6d3ed3472020-05-11 09:11:48459 } else if (loadSuccess) {
460 self.loadCompleted = YES;
461 }
Sylvain Defresne949367262018-03-02 22:33:16462}
463
mrefaat3ad5e412018-08-02 20:11:34464#pragma mark - CRWWebStatePolicyDecider
465
Mike Dougherty15f6db52020-04-09 19:13:07466- (WebStatePolicyDecider::PolicyDecision)
467 shouldAllowRequest:(NSURLRequest*)request
468 requestInfo:(const WebStatePolicyDecider::RequestInfo&)info {
mrefaat3ad5e412018-08-02 20:11:34469 GURL requestURL = net::GURLWithNSURL(request.URL);
470 // Don't allow preloading for requests that are handled by opening another
471 // application or by presenting a native UI.
472 if (AppLauncherTabHelper::IsAppUrl(requestURL) ||
473 ITunesUrlsHandlerTabHelper::CanHandleUrl(requestURL)) {
474 [self schedulePrerenderCancel];
Mike Dougherty15f6db52020-04-09 19:13:07475 return WebStatePolicyDecider::PolicyDecision::Cancel();
mrefaat3ad5e412018-08-02 20:11:34476 }
Mike Dougherty15f6db52020-04-09 19:13:07477 return WebStatePolicyDecider::PolicyDecision::Allow();
mrefaat3ad5e412018-08-02 20:11:34478}
Kurt Horimotoeb0081e2019-09-26 18:53:35479
480#pragma mark - ManageAccountsDelegate
481
482- (void)onManageAccounts {
483 [self schedulePrerenderCancel];
484}
485
Nohemi Fernandez753c2f62020-09-09 15:18:41486- (void)onShowConsistencyPromo {
487 [self schedulePrerenderCancel];
488}
489
Kurt Horimotoeb0081e2019-09-26 18:53:35490- (void)onAddAccount {
491 [self schedulePrerenderCancel];
492}
493
494- (void)onGoIncognito:(const GURL&)url {
495 [self schedulePrerenderCancel];
496}
497
498#pragma mark - PrefObserverDelegate
499
500- (void)onPreferenceChanged:(const std::string&)preferenceName {
Stepan Khapugin193af312020-10-01 16:18:40501 if (preferenceName == prefs::kNetworkPredictionSetting) {
Kurt Horimotoeb0081e2019-09-26 18:53:35502 DCHECK_CURRENTLY_ON(web::WebThread::UI);
503 // The logic is simpler if both preferences changes are handled equally.
Stepan Khapugin193af312020-10-01 16:18:40504 self.networkPredictionSetting =
505 static_cast<prerender_prefs::NetworkPredictionSetting>(
506 self.browserState->GetPrefs()->GetInteger(
507 prefs::kNetworkPredictionSetting));
Kurt Horimotoeb0081e2019-09-26 18:53:35508
Stepan Khapugin193af312020-10-01 16:18:40509 switch (self.networkPredictionSetting) {
510 case prerender_prefs::NetworkPredictionSetting::kEnabledWifiOnly: {
511 if (!_connectionTypeObserver.get()) {
512 self.isOnCellularNetwork =
513 net::NetworkChangeNotifier::IsConnectionCellular(
514 net::NetworkChangeNotifier::GetConnectionType());
515 _connectionTypeObserver =
516 std::make_unique<ConnectionTypeObserverBridge>(self);
517 }
518 if (self.isOnCellularNetwork) {
519 [self cancelPrerender];
520 }
521 break;
Kurt Horimotoeb0081e2019-09-26 18:53:35522 }
Stepan Khapugin193af312020-10-01 16:18:40523
524 case prerender_prefs::NetworkPredictionSetting::kEnabledWifiAndCellular: {
525 _connectionTypeObserver.reset();
526 break;
527 }
528
529 case prerender_prefs::NetworkPredictionSetting::kDisabled: {
Kurt Horimotoeb0081e2019-09-26 18:53:35530 [self cancelPrerender];
Stepan Khapugin193af312020-10-01 16:18:40531 _connectionTypeObserver.reset();
532 break;
Kurt Horimotoeb0081e2019-09-26 18:53:35533 }
Kurt Horimotoeb0081e2019-09-26 18:53:35534 }
535 }
536}
537
538#pragma mark - PreloadCancelling
539
540- (void)schedulePrerenderCancel {
541 // TODO(crbug.com/228550): Instead of cancelling the prerender, should we mark
542 // it as failed instead? That way, subsequent prerender requests for the same
543 // URL will not kick off new prerenders.
544 [self removeScheduledPrerenderRequests];
545 [self performSelector:@selector(cancelPrerender) withObject:nil afterDelay:0];
546}
547
548#pragma mark - Cancellation Helpers
549
Gauthier Ambard2b604d82019-11-05 13:23:15550- (BOOL)shouldCancelPreloadForMimeType:(std::string)mimeType {
551 // Cancel prerendering if response is "application/octet-stream". It can be a
552 // video file which should not be played from preload tab. See issue at
553 // http://crbug.com/436813 for more details.
554 // On iOS 13, PDF are getting focused when loaded, preventing the user from
555 // typing in the omnibox. See crbug.com/1017352.
556 return mimeType == "application/octet-stream" ||
557 mimeType == "application/pdf";
558}
559
Kurt Horimotoeb0081e2019-09-26 18:53:35560- (void)removeScheduledPrerenderRequests {
561 [NSObject cancelPreviousPerformRequestsWithTarget:self];
562 _scheduledRequest = nullptr;
563}
564
565#pragma mark - Prerender Helpers
566
567- (void)startPrerender {
568 // Destroy any existing prerenders before starting a new one.
569 [self destroyPreviewContents];
570 self.prerenderedURL = self.scheduledURL;
571 std::unique_ptr<PrerenderRequest> request = std::move(_scheduledRequest);
572
Justin Cohen6836cfc52019-10-02 13:28:58573 web::WebState* webStateToReplace = [self.delegate webStateToReplace];
574 if (!self.prerenderedURL.is_valid() || !webStateToReplace) {
Kurt Horimotoeb0081e2019-09-26 18:53:35575 [self destroyPreviewContents];
576 return;
577 }
578
579 web::WebState::CreateParams createParams(self.browserState);
Yi Suee7be512019-12-09 13:25:10580 _webState = web::WebState::CreateWithStorageSession(
581 createParams, webStateToReplace->BuildSessionStorage());
Justin Cohen6836cfc52019-10-02 13:28:58582
Kurt Horimotoeb0081e2019-09-26 18:53:35583 // Add the preload controller as a policyDecider before other tab helpers, so
584 // that it can block the navigation if needed before other policy deciders
585 // execute thier side effects (eg. AppLauncherTabHelper launching app).
586 _policyDeciderBridge =
587 std::make_unique<web::WebStatePolicyDeciderBridge>(_webState.get(), self);
588 AttachTabHelpers(_webState.get(), /*for_prerender=*/true);
589
Kurt Horimotoeb0081e2019-09-26 18:53:35590 _webState->SetDelegate(_webStateDelegate.get());
591 _webState->AddObserver(_webStateObserver.get());
Olivier Robin984283a2020-06-22 11:08:50592 breakpad::MonitorURLsForPreloadWebState(_webState.get());
Kurt Horimotoeb0081e2019-09-26 18:53:35593 _webState->SetWebUsageEnabled(true);
594
595 if (AccountConsistencyService* accountConsistencyService =
596 ios::AccountConsistencyServiceFactory::GetForBrowserState(
597 self.browserState)) {
598 accountConsistencyService->SetWebStateHandler(_webState.get(), self);
599 }
600
601 HistoryTabHelper::FromWebState(_webState.get())
602 ->SetDelayHistoryServiceNotification(true);
603
604 web::NavigationManager::WebLoadParams loadParams(self.prerenderedURL);
605 loadParams.referrer = request->referrer();
606 loadParams.transition_type = request->transition();
Kurt Horimotoeb0081e2019-09-26 18:53:35607 _webState->SetKeepRenderProcessAlive(true);
608 _webState->GetNavigationManager()->LoadURLWithParams(loadParams);
609
610 // LoadIfNecessary is needed because the view is not created (but needed) when
611 // loading the page. TODO(crbug.com/705819): Remove this call.
612 _webState->GetNavigationManager()->LoadIfNecessary();
613
614 self.startTime = base::TimeTicks::Now();
Gauthier Ambard6d3ed3472020-05-11 09:11:48615 self.loadCompleted = NO;
Kurt Horimotoeb0081e2019-09-26 18:53:35616}
617
618#pragma mark - Teardown Helpers
619
620- (void)destroyPreviewContents {
621 [self destroyPreviewContentsForReason:PRERENDER_FINAL_STATUS_CANCELLED];
622}
623
624- (void)destroyPreviewContentsForReason:(PrerenderFinalStatus)reason {
625 if (!_webState)
626 return;
627
628 UMA_HISTOGRAM_ENUMERATION(kPrerenderFinalStatusHistogramName, reason,
629 PRERENDER_FINAL_STATUS_MAX);
630
Kurt Horimotoeb0081e2019-09-26 18:53:35631 _webState->RemoveObserver(_webStateObserver.get());
Olivier Robin984283a2020-06-22 11:08:50632 breakpad::StopMonitoringURLsForPreloadWebState(_webState.get());
Kurt Horimotoeb0081e2019-09-26 18:53:35633 _webState->SetDelegate(nullptr);
634 _webState.reset();
635
636 self.prerenderedURL = GURL();
637 self.startTime = base::TimeTicks();
Gauthier Ambard6d3ed3472020-05-11 09:11:48638 self.loadCompleted = NO;
Kurt Horimotoeb0081e2019-09-26 18:53:35639}
640
641#pragma mark - Notification Helpers
642
643- (void)didReceiveMemoryWarning {
644 [self cancelPrerenderForReason:PRERENDER_FINAL_STATUS_MEMORY_LIMIT_EXCEEDED];
645}
646
647#pragma mark - Metrics Helpers
648
649- (void)recordReleaseMetrics {
650 UMA_HISTOGRAM_ENUMERATION(kPrerenderFinalStatusHistogramName,
651 PRERENDER_FINAL_STATUS_USED,
652 PRERENDER_FINAL_STATUS_MAX);
653
Gauthier Ambard6d3ed3472020-05-11 09:11:48654 UMA_HISTOGRAM_BOOLEAN(kPrerenderLoadComplete, self.loadCompleted);
655
656 if (self.loadCompleted) {
657 DCHECK_NE(base::TimeDelta(), self.completionTime);
658 UMA_HISTOGRAM_TIMES(kPrerenderPrerenderTimeSaved, self.completionTime);
659 } else {
660 DCHECK_NE(base::TimeTicks(), self.startTime);
661 UMA_HISTOGRAM_TIMES(kPrerenderPrerenderTimeSaved,
662 base::TimeTicks::Now() - self.startTime);
663 }
Kurt Horimotoeb0081e2019-09-26 18:53:35664}
665
sdefresned9217bc2016-12-19 13:58:32666@end