PlzNavigate: identify same-page browser-initiated navigation.

content/common/frame_message_enums.h

 // 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.
 
 #ifndef CONTENT_COMMON_FRAME_MESSAGE_ENUMS_H_
 #define CONTENT_COMMON_FRAME_MESSAGE_ENUMS_H_
 
 #include "content/common/accessibility_mode_enums.h"
 
 struct FrameMsg_Navigate_Type {
@@ skipping 11 matching lines @@
     // The navigation is the result of session restore and should honor the
     // page's cache policy while restoring form state. This is set to true if
     // restoring a tab/session from the previous session and the previous
     // session did not crash. If this is not set and the page was restored then
     // the page's cache policy is ignored and we load from the cache.
     RESTORE,
 
     // Like RESTORE, except that the navigation contains POST data.
     RESTORE_WITH_POST,
 
-    // Navigation type not categorized by the other types.
-    NORMAL,
+    // History navigation inside the same document.
+    HISTORY_SAME_DOCUMENT,
+
+    // History navigation to a different document.
+    HISTORY_DIFFERENT_DOCUMENT,
+
+    // Navigation inside the same document. It occurs when the part of the url
+    // that is modified is after the '#' part.
+    SAME_DOCUMENT,
+
+    // Navigation to another document.
+    DIFFERENT_DOCUMENT,
+
+    // Used as a default value. Can be used to assert that the navigation
+    // classification has been done.
+    UNSPECIFIED,

[nasko, 2017/01/23 19:10:13]

Can we avoid having such value? We should know the type of navigation at all
times, right?

[arthursonzogni, 2017/01/24 15:17:04]

It is used in the default constructor of CommonNavigationParams 

The default constructor is used in a bunch of test and some renderer-initiated
code. It looks like a lot of them are replacing the navigation_type attribute
after this constructor (which is the right thing to do) but I don't know if
nothing has been forgotten somewhere (and in the future tests...).
I put this special value to avoid silent-failures, which will be hard to debug.

I will use Frame_Navigate_Type::DIFFERENT_DOCUMENT instead. Tell me if it is
still okay.

[nasko, 2017/01/24 16:59:35]

Using DIFFERENT_DOCUMENT sgtm, since it is the most frequently used action.

 
     // Last guard value, so we can use it for validity checks.
-    NAVIGATE_TYPE_LAST = NORMAL,
+    NAVIGATE_TYPE_LAST = UNSPECIFIED,
   };
+
+  static bool IsReload(Value value) {
+    return value == RELOAD || value == RELOAD_BYPASSING_CACHE ||
+           value == RELOAD_ORIGINAL_REQUEST_URL;
+  }
+
+  static bool IsSameDocument(Value value) {
+    return value == SAME_DOCUMENT || value == HISTORY_SAME_DOCUMENT;
+  }
+
+  static bool IsHistory(Value value) {
+    return value == HISTORY_SAME_DOCUMENT ||
+           value == HISTORY_DIFFERENT_DOCUMENT;
+  }
 };
 
 struct FrameMsg_UILoadMetricsReportType {
  public:
   enum Value {
     // Do not report metrics for this load.
     NO_REPORT,
 
     // Report metrics for this load, that originated from clicking on a link.
     REPORT_LINK,
 
     // Report metrics for this load, that originated from an Android OS intent.
     REPORT_INTENT,
 
     REPORT_TYPE_LAST = REPORT_INTENT,
   };
 };
 
 #endif  // CONTENT_COMMON_FRAME_MESSAGE_ENUMS_H_