<webview>: Implement declarativeWebRequest API

chrome/test/data/extensions/platform_apps/web_view/shim/main.js

 // Copyright (c) 2012 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.
 
 var util = {};
 var embedder = {};
 embedder.baseGuestURL = '';
 embedder.emptyGuestURL = '';
 embedder.windowOpenGuestURL = '';
 embedder.noReferrerGuestURL = '';
@@ skipping 332 matching lines @@
   webview.partition = 'foobar';
   webview.addEventListener('loadabort', function(e) {
     embedder.test.succeed();
   });
   webview.setAttribute('src', invalidResource);
   document.body.appendChild(webview);
 }
 
 function testWebRequestAPIExistence() {
   var apiPropertiesToCheck = [
+    // Declarative WebRequest API.
+    'onMessage',
+    'onRequest',
+    // WebRequest API.
     'onBeforeRequest',
     'onBeforeSendHeaders',
     'onSendHeaders',
     'onHeadersReceived',
     'onAuthRequired',
     'onBeforeRedirect',
     'onResponseStarted',
     'onCompleted',
     'onErrorOccurred'
   ];
   var webview = document.createElement('webview');
   webview.setAttribute('partition', arguments.callee.name);
   webview.addEventListener('loadstop', function(e) {
     for (var i = 0; i < apiPropertiesToCheck.length; ++i) {
       embedder.test.assertEq('object',
-                             typeof webview[apiPropertiesToCheck[i]]);
+                             typeof webview.request[apiPropertiesToCheck[i]]);
       embedder.test.assertEq(
-          'function', typeof webview[apiPropertiesToCheck[i]].addListener);
-      embedder.test.assertEq(webview[apiPropertiesToCheck[i]],
-                             webview.request[apiPropertiesToCheck[i]]);
+          'function',
+          typeof webview.request[apiPropertiesToCheck[i]].addListener);
+      embedder.test.assertEq(
+          'function',
+          typeof webview.request[apiPropertiesToCheck[i]].addRules);
+      embedder.test.assertEq(
+          'function',
+          typeof webview.request[apiPropertiesToCheck[i]].getRules);
+      embedder.test.assertEq(
+          'function',
+          typeof webview.request[apiPropertiesToCheck[i]].removeRules);
     }
-
     embedder.test.succeed();
   });
   webview.setAttribute('src', 'data:text/html,webview check api');
   document.body.appendChild(webview);
 }
 
 // This test verifies that the loadstart, loadstop, and exit events fire as
 // expected.
 function testEventName() {
   var webview = document.createElement('webview');
@@ skipping 487 matching lines @@
 // webview.
 function testWebRequestAPI() {
   var webview = new WebView();
   webview.request.onBeforeRequest.addListener(function(e) {
     embedder.test.succeed();
   }, { urls: ['<all_urls>']}) ;
   webview.src = embedder.windowOpenGuestURL;
   document.body.appendChild(webview);
 }
 
+// This test verifies that the basic use cases of the declarative WebRequest API
+// work as expected. This test demonstrates that rules can be added prior to
+// navigation and attachment.
+// 1. It adds a rule to block URLs that contain guest.
+// 2. It attempts to navigate to a guest.html page.
+// 3. It detects the appropriate loadabort message.
+// 4. It removes the rule blocking the page and reloads.
+// 5. The page loads successfully.
+function testDeclarativeWebRequestAPI() {
+  var step = 1;
+  var webview = new WebView();
+  var rule = {
+    conditions: [
+      new chrome.webViewRequest.RequestMatcher(
+        {
+          url: { urlContains: 'guest' }
+        }
+      )
+    ],
+    actions: [
+      new chrome.webViewRequest.CancelRequest()
+    ]
+  };
+  webview.request.onRequest.addRules([rule]);
+  webview.addEventListener('loadcommit', function(e) {

[lazyboy, 2013/11/05 20:43:51]

nit: move this after 'loadabort' event registration so it is easier to follow.

[Fady Samuel, 2013/11/06 14:54:15]

Done.

+    embedder.test.assertEq(2, step);
+    embedder.test.succeed();
+  });
+  webview.addEventListener('loadabort', function(e) {
+    embedder.test.assertEq(1, step);
+    embedder.test.assertEq('ERR_BLOCKED_BY_CLIENT', e.reason);
+    step = 2;
+    webview.request.onRequest.removeRules();
+    webview.reload();
+  });
+  webview.src = embedder.emptyGuestURL;
+  document.body.appendChild(webview);
+}
+
 // This test verifies that the WebRequest API onBeforeRequest event fires on
 // clients*.google.com URLs.
 function testWebRequestAPIGoogleProperty() {
   var webview = new WebView();
   webview.request.onBeforeRequest.addListener(function(e) {
     embedder.test.succeed();
     return {cancel: true};
   }, { urls: ['<all_urls>']}, ['blocking']) ;
   webview.src = 'http://clients6.google.com';
   document.body.appendChild(webview);
@@ skipping 272 matching lines @@
   'testNavOnSrcAttributeChange': testNavOnSrcAttributeChange,
   'testReassignSrcAttribute': testReassignSrcAttribute,
   'testRemoveSrcAttribute': testRemoveSrcAttribute,
   'testBrowserPluginNotAllowed': testBrowserPluginNotAllowed,
   'testPluginLoadPermission': testPluginLoadPermission,
   'testNewWindow': testNewWindow,
   'testNewWindowTwoListeners': testNewWindowTwoListeners,
   'testNewWindowNoPreventDefault': testNewWindowNoPreventDefault,
   'testNewWindowNoReferrerLink': testNewWindowNoReferrerLink,
   'testContentLoadEvent': testContentLoadEvent,
+  'testDeclarativeWebRequestAPI': testDeclarativeWebRequestAPI,
   'testWebRequestAPI': testWebRequestAPI,
   'testWebRequestAPIGoogleProperty': testWebRequestAPIGoogleProperty,
   'testWebRequestListenerSurvivesReparenting':
       testWebRequestListenerSurvivesReparenting,
   'testGetProcessId': testGetProcessId,
   'testLoadStartLoadRedirect': testLoadStartLoadRedirect,
   'testLoadAbortChromeExtensionURLWrongPartition':
       testLoadAbortChromeExtensionURLWrongPartition,
   'testLoadAbortEmptyResponse': testLoadAbortEmptyResponse,
   'testLoadAbortIllegalChromeURL': testLoadAbortIllegalChromeURL,
   'testLoadAbortIllegalFileURL': testLoadAbortIllegalFileURL,
   'testLoadAbortIllegalJavaScriptURL': testLoadAbortIllegalJavaScriptURL,
   'testNavigationToExternalProtocol': testNavigationToExternalProtocol,
   'testReload': testReload,
   'testRemoveWebviewOnExit': testRemoveWebviewOnExit,
   'testRemoveWebviewAfterNavigation': testRemoveWebviewAfterNavigation,
   'testResizeWebviewResizesContent': testResizeWebviewResizesContent
 };
 
 onload = function() {
   chrome.test.getConfig(function(config) {
     embedder.setUp_(config);
     chrome.test.sendMessage("Launched");
   });
 };