Improve page transition type heuristic in WebController

ios/web/web_state/ui/crw_wk_web_view_web_controller.mm

 // Copyright 2014 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #import "ios/web/web_state/ui/crw_wk_web_view_web_controller.h"
 
 #import <WebKit/WebKit.h>
 
 #include "base/containers/mru_cache.h"
 #include "base/ios/ios_util.h"
@@ skipping 96 matching lines @@
 }  // namespace
 
 @interface CRWWKWebViewWebController ()<WKNavigationDelegate, WKUIDelegate> {
   // The WKWebView managed by this instance.
   base::scoped_nsobject<WKWebView> _wkWebView;
 
   // The Watch Dog that detects and reports WKWebView crashes.
   base::scoped_nsobject<CRWWKWebViewCrashDetector> _crashDetector;
 
   // The actual URL of the document object (i.e., the last committed URL).
-  // TODO(stuartmorgan): Remove this in favor of just updating the session
-  // controller and treating that as authoritative. For now, this allows sharing
-  // the flow that's currently in the superclass.
+  // TODO(crbug.com/549616): Remove this in favor of just updating the
+  // navigation manager and treating that as authoritative. For now, this allows
+  // sharing the flow that's currently in the superclass.
   GURL _documentURL;
 
   // A set of script managers whose scripts have been injected into the current
   // page.
   // TODO(stuartmorgan): Revisit this approach; it's intended only as a stopgap
   // measure to make all the existing script managers work. Longer term, there
   // should probably be a couple of points where managers can register to have
   // things happen automatically based on page lifecycle, and if they don't want
   // to use one of those fixed points, they should make their scripts internally
   // idempotent.
@@ skipping 37 matching lines @@
   // Cancelled navigations should be simply discarded without handling any
   // specific error.
   BOOL _pendingNavigationCancelled;
 
   // CertVerification errors which happened inside
   // |webView:didReceiveAuthenticationChallenge:completionHandler:|.
   // Key is leaf-cert/host pair. This storage is used to carry calculated
   // cert status from |didReceiveAuthenticationChallenge:| to
   // |didFailProvisionalNavigation:| delegate method.
   scoped_ptr<CertVerificationErrorsCacheType> _certVerificationErrors;
+
+  // YES if the user has touched the content area since the last URL change.
+  BOOL _touchedSinceLastURLChange;
 }
 
 // Response's MIME type of the last known navigation.
 @property(nonatomic, copy) NSString* documentMIMEType;
 
 // Dictionary where keys are the names of WKWebView properties and values are
 // selector names which should be called when a corresponding property has
 // changed. e.g. @{ @"URL" : @"webViewURLDidChange" } means that
 // -[self webViewURLDidChange] must be called every time when WKWebView.URL is
 // changed.
@@ skipping 20 matching lines @@
 
 // Returns a new autoreleased web view created with given configuration.
 - (WKWebView*)createWebViewWithConfiguration:(WKWebViewConfiguration*)config;
 
 // Sets the value of the webView property, and performs its basic setup.
 - (void)setWebView:(WKWebView*)webView;
 
 // Returns whether the given navigation is triggered by a user link click.
 - (BOOL)isLinkNavigation:(WKNavigationType)navigationType;
 
+// Sets _documentURL to newURL, and updates any relevant state information.
+- (void)setDocumentURL:(const GURL&)newURL;
+
 // Sets value of the pendingReferrerString property.
 - (void)setPendingReferrerString:(NSString*)referrer;
 
 // Extracts the referrer value from WKNavigationAction and sets it as a pending.
 // The referrer is known in |decidePolicyForNavigationAction| however it must
 // be in a pending state until |didCommitNavigation| where it becames current.
 - (void)updatePendingReferrerFromNavigationAction:(WKNavigationAction*)action;
 
 // Replaces the current referrer with the pending one. Referrer becames current
 // at |didCommitNavigation| callback.
@@ skipping 174 matching lines @@
   // TODO(eugenebut): implement dialogs/windows suppression using
   // WKNavigationDelegate methods where possible.
   [super setPageDialogOpenPolicy:policy];
 }
 
 - (void)close {
   [_certVerificationController shutDown];
   [super close];
 }
 
+- (void)touched:(BOOL)touched {
+  [super touched:touched];
+  if (touched)
+    _touchedSinceLastURLChange = YES;
+}
+
 #pragma mark -
 #pragma mark Testing-Only Methods
 
 - (void)injectWebViewContentView:(CRWWebViewContentView*)webViewContentView {
   [super injectWebViewContentView:webViewContentView];
   [self setWebView:static_cast<WKWebView*>(webViewContentView.webView)];
 }
 
 #pragma mark - Protected property implementations
 
@@ skipping 325 matching lines @@
                                       name:kScriptImmediateName
                                    webView:webView];
   }
   [_wkWebView setNavigationDelegate:self];
   [_wkWebView setUIDelegate:self];
   for (NSString* keyPath in self.wkWebViewObservers) {
     [_wkWebView addObserver:self forKeyPath:keyPath options:0 context:nullptr];
   }
   _injectedScriptManagers.reset([[NSMutableSet alloc] init]);
   _crashDetector.reset([self newCrashDetectorWithWebView:_wkWebView]);
-  _documentURL = [self defaultURL];
+  [self setDocumentURL:[self defaultURL]];
 }
 
 - (BOOL)isLinkNavigation:(WKNavigationType)navigationType {
   switch (navigationType) {
     case WKNavigationTypeLinkActivated:
       return YES;
     case WKNavigationTypeOther:
       return [self userClickedRecently];
     default:
       return NO;
   }
 }
 
+- (void)setDocumentURL:(const GURL&)newURL {
+  if (newURL != _documentURL) {
+    _documentURL = newURL;
+    _touchedSinceLastURLChange = NO;
+  }
+}
+
 - (void)setPendingReferrerString:(NSString*)referrer {
   _pendingReferrerString.reset([referrer copy]);
 }
 
 - (void)updatePendingReferrerFromNavigationAction:(WKNavigationAction*)action {
   if (action.targetFrame.mainFrame)
     [self setPendingReferrerString:GetRefererFromNavigationAction(action)];
 }
 
 - (void)commitPendingReferrerString {
@@ skipping 347 matching lines @@
           base::SysNSStringToUTF8(challenge.protectionSpace.host);
       _certVerificationErrors->Put(
           web::CertHostPair(leafCert, host),
           CertVerificationError(is_recoverable, certStatus));
     }
   }
   completionHandler(NSURLSessionAuthChallengeRejectProtectionSpace, nil);
 }
 
 - (void)registerLoadRequest:(const GURL&)url {
-  // If load request is registered via WKWebViewWebController, assume transition
-  // is link or client redirect as other transitions will already be registered
-  // by web controller or delegates.
-  // TODO(stuartmorgan): Remove guesswork and replace with information from
-  // decidePolicyForNavigationAction:.
-  ui::PageTransition transition = self.userInteractionRegistered
-                                      ? ui::PAGE_TRANSITION_LINK
-                                      : ui::PAGE_TRANSITION_CLIENT_REDIRECT;
+  // Get the navigation type from the last main frame load request, and try to
+  // map that to a PageTransition.
+  WKNavigationType navigationType = _pendingNavigationTypeForMainFrame
+                                        ? *_pendingNavigationTypeForMainFrame
+                                        : WKNavigationTypeOther;
+  ui::PageTransition transition = ui::PAGE_TRANSITION_CLIENT_REDIRECT;
+  switch (navigationType) {
+    case WKNavigationTypeLinkActivated:
+      transition = ui::PAGE_TRANSITION_LINK;
+      break;
+    case WKNavigationTypeFormSubmitted:
+    case WKNavigationTypeFormResubmitted:
+      transition = ui::PAGE_TRANSITION_FORM_SUBMIT;
+      break;
+    case WKNavigationTypeBackForward:
+      transition = ui::PAGE_TRANSITION_FORWARD_BACK;
+      break;
+    case WKNavigationTypeReload:
+      transition = ui::PAGE_TRANSITION_RELOAD;
+      break;
+    case WKNavigationTypeOther:
+      // The "Other" type covers a variety of very different cases, which may
+      // or may not be the result of user actions. For now, guess based on
+      // whether there's been a touch since the last URL change.
+      // TODO(crbug.com/549301): See if this heuristic can be improved.
+      transition = _touchedSinceLastURLChange
+                       ? ui::PAGE_TRANSITION_LINK
+                       : ui::PAGE_TRANSITION_CLIENT_REDIRECT;
+      break;
+  }
   // The referrer is not known yet, and will be updated later.
   const web::Referrer emptyReferrer;
   [self registerLoadRequest:url referrer:emptyReferrer transition:transition];
 }
 
 - (void)URLDidChangeWithoutDocumentChange:(const GURL&)newURL {
   DCHECK(newURL == net::GURLWithNSURL([_wkWebView URL]));
   DCHECK_EQ(_documentURL.host(), newURL.host());
-  _documentURL = newURL;
+  [self setDocumentURL:newURL];
   // If called during window.history.pushState or window.history.replaceState
   // JavaScript evaluation, only update the document URL. This callback does not
   // have any information about the state object and cannot create (or edit) the
   // navigation entry for this page change. Web controller will sync with
   // history changes when a window.history.didPushState or
   // window.history.didReplaceState message is received, which should happen in
   // the next runloop.
   if (!_changingHistoryState) {
     [self registerLoadRequest:_documentURL];
     [self didStartLoadingURL:_documentURL updateHistory:YES];
@@ skipping 390 matching lines @@
   _certVerificationErrors->Clear();
   // This point should closely approximate the document object change, so reset
   // the list of injected scripts to those that are automatically injected.
   _injectedScriptManagers.reset([[NSMutableSet alloc] init]);
   [self injectWindowID];
 
   // The page has changed; commit the pending referrer.
   [self commitPendingReferrerString];
 
   // This is the point where the document's URL has actually changed.
-  _documentURL = net::GURLWithNSURL([_wkWebView URL]);
+  [self setDocumentURL:net::GURLWithNSURL([_wkWebView URL])];
   DCHECK(_documentURL == self.lastRegisteredRequestURL);
   [self webPageChanged];
 
   [self updateCurrentBackForwardListItemHolder];
 
 #if !defined(ENABLE_CHROME_NET_STACK_FOR_WKWEBVIEW)
   [self updateSSLStatusForCurrentNavigationItem];
 #endif
 
   // Report cases where SSL cert is missing for a secure connection.
@@ skipping 144 matching lines @@
                               placeholderText:defaultText
                                    requestURL:
             net::GURLWithNSURL(frame.request.URL)
                             completionHandler:completionHandler];
   } else if (completionHandler) {
     completionHandler(nil);
   }
 }
 
 @end