Adding Navigation Throttles to DevTools

third_party/WebKit/Source/core/inspector/browser_protocol.json

 {
     "version": { "major": "1", "minor": "1" },
     "domains": [{
         "domain": "Inspector",
         "hidden": true,
         "types": [],
         "commands": [
             {
                 "name": "enable",
                 "description": "Enables inspector domain notifications.",
@@ skipping 156 matching lines @@
                 "id": "AppManifestError",
                 "description": "Error while paring app manifest.",
                 "type": "object",
                 "properties": [
                   { "name": "message", "type": "string", "description": "Error message." },
                   { "name": "critical", "type": "integer", "description": "If criticial, this is a non-recoverable parse error." },
                   { "name": "line", "type": "integer", "description": "Error line." },
                   { "name": "column", "type": "integer", "description": "Error column." }
                 ],
                 "hidden": true
+            },
+            {
+                "id": "NavigationThrottleResponse",

[nasko, 2016/07/13 22:37:34]

Let's avoid using Throttle here as well. Throttles are just internal
implementation.

[alex clarke (OOO till 29th), 2016/07/14 16:06:05]

Done.

+                "description": "Proceed: allow the navigation; Cancel: cancel the navigation; CancelAndIgnore: cancels the navigation and makes the requester of the navigation acts like the request was never made.",
+                "type": "string",
+                "enum": ["Proceed", "Cancel", "CancelAndIgnore"],
+                "hidden": true
             }
         ],
         "commands": [
             {
                 "name": "enable",
                 "description": "Enables page domain notifications.",
                 "handlers": ["browser", "renderer"]
             },
             {
                 "name": "disable",
@@ skipping 287 matching lines @@
                 "name": "requestAppBanner",
                 "hidden": true,
                 "handlers": ["browser"]
             },
             {
                 "name": "setBlockedEventsWarningThreshold",
                 "hidden": true,
                 "parameters": [
                     { "name": "threshold", "type": "number", "description": "If set to a positive number, specifies threshold in seconds for input event latency that will cause a console warning about blocked event to be issued. If zero or less, the warning is disabled." }
                 ]
+            },
+            {
+                "name": "setControlNavigations",
+                "parameters": [
+                    { "name": "enabled", "type": "boolean" }
+                ],
+                "description": "Toggles navigation throttling which allows programatic control over navigation and redirect response.",
+                "hidden": true,
+                "handlers": ["browser"]
+            },
+            {
+                "name": "processNavigation",
+                "parameters": [
+                    { "name": "response", "$ref": "NavigationThrottleResponse" },
+                    { "name": "navigationId", "type": "integer" }
+                ],
+                "description": "Should be sent in response to a navigationRequested or a redirectRequested event, telling the browser how to handle the navigation.",
+                "hidden": true,
+                "handlers": ["browser"]
             }
         ],
         "events": [
             {
                 "name": "domContentEventFired",
                 "parameters": [
                     { "name": "timestamp", "type": "number" }
                 ]
             },
             {
@@ skipping 111 matching lines @@
                 "name": "interstitialShown",
                 "description": "Fired when interstitial page was shown",
                 "hidden": true,
                 "handlers": ["browser"]
             },
             {
                 "name": "interstitialHidden",
                 "description": "Fired when interstitial page was hidden",
                 "hidden": true,
                 "handlers": ["browser"]
+            },
+            {
+                "name": "navigationRequested",
+                "description": "Fired when a navigation is started if navigation throttles are enabled.  The navigation will be deferred until processNavigation is called.",
+                "parameters": [
+                    { "name": "isInMainFrame", "type": "boolean", "description": "Whether the navigation is taking place in the main frame or in a subframe." },
+                    { "name": "isParentMainFrame", "type": "boolean", "description": "Whether the navigation is taking place in a frame that is a direct child of the main frame." },

[nasko, 2016/07/13 22:37:34]

In general, I'd suggest exposing the minimum amount of data from the API, as
that locks us into supporting it long term. Unless we really really need this
specific boolean, let's remove it. I'll be curious to know if we do indeed need
it, what the use case is.

[alex clarke (OOO till 29th), 2016/07/14 16:06:05]

isParentMainFrame was speculative.  We can probably live without it.

[nasko, 2016/07/14 16:47:19]

The rule of thumb is that we only expose parts that are absolutely needed and
used. We can always expose additional bits once we need we know them and what
for.

+                    { "name": "isRedirect", "type": "boolean", "description": "Whether the navigation has encountered a server redirect or not." },
+                    { "name": "navigationId", "type": "integer" },
+                    { "name": "url", "type": "string", "description": "URL of requested navigation." },
+                    { "name": "rendererInitiated", "type": "boolean", "description": "Whether the navigation was initated by the renderer process." }
+                ],
+                "handlers": ["browser"]
             }
         ]
     },
     {
         "domain": "Rendering",
         "description": "This domain allows to control rendering of the page.",
         "hidden": true,
         "commands": [
             {
                 "name": "setShowPaintRects",
@@ skipping 3744 matching lines @@
                 "description": "Informs that port was successfully bound and got a specified connection id.",
                 "parameters": [
                     {"name": "port", "type": "integer", "description": "Port number that was successfully bound." },
                     {"name": "connectionId", "type": "string", "description": "Connection id to be used." }
                 ],
                 "handlers": ["browser"]
             }
         ]
     }]
 }