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",
+                "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"],

[pfeldman, 2016/07/07 17:26:18]

We don't have guidelines for the enum literal naming, we should probably get
some...

[alex clarke (OOO till 29th), 2016/07/08 10:37:58]

Acknowledged. Happy to change these if you can think of clearer names.

+                "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": "setNavigationThrottleEnabled",
+                "parameters": [
+                    { "name": "enabled", "type": "boolean" }
+                ],
+                "description": "Toggles navigation throttling which allows programatic control over navigation and redirect response.",
+                "hidden": true,
+                "handlers": ["browser"]
+            },
+            {
+                "name": "navigationThrottleResponse",

[pfeldman, 2016/07/07 17:26:18]

processNavigation

[alex clarke (OOO till 29th), 2016/07/08 10:37:58]

Done.

+                "parameters": [
+                    { "name": "response", "$ref": "NavigationThrottleResponse" },
+                    { "name": "navigationId", "type": "integer" }
+                ],
+                "description": "Should be sent in response to a shouldAllowNavigation or a shouldAllowRedirect 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": "shouldAllowNavigation",

[pfeldman, 2016/07/07 17:26:18]

navigationRequested

[alex clarke (OOO till 29th), 2016/07/08 10:37:58]

Done.

+                "description": "Fired when a navigation is started if navigation throttles are enabled.  The navigation will be deferred until navigationThrottleResponse is called.",
+                "parameters": [
+                    { "name": "frameId", "$ref": "FrameId", "description": "Id of the frame that would navigate." },
+                    { "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"]
+            },
+            {
+                "name": "shouldAllowRedirect",

[pfeldman, 2016/07/07 17:26:18]

redirectRequested

[alex clarke (OOO till 29th), 2016/07/08 10:37:58]

Done.

+                "description": "Fired when a server redirect is recieved by a navigation if navigation throttles are enabled.  The navigation will be deferred until navigationThrottleResponse is called.",
+                "parameters": [
+                    { "name": "frameId", "$ref": "FrameId", "description": "Id of the frame that would navigate." },
+                    { "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"]
             }
         ]
     }]
 }