Support WebSocket in WebRequest API.

chrome/test/data/extensions/api_test/webrequest/framework.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 getURL = chrome.extension.getURL;
 var deepEq = chrome.test.checkDeepEq;
 var expectedEventData;
 var capturedEventData;
 var capturedUnexpectedData;
 var expectedEventOrder;
 var tabId;
 var tabIdMap;
 var frameIdMap;
+var testWebSocketPort;
 var testServerPort;
 var testServer = "www.a.com";
 var defaultScheme = "http";
 var eventsCaptured;
 var listeners = {
   'onBeforeRequest': [],
   'onBeforeSendHeaders': [],
   'onAuthRequired': [],
   'onSendHeaders': [],
   'onHeadersReceived': [],
   'onResponseStarted': [],
   'onBeforeRedirect': [],
   'onCompleted': [],
   'onErrorOccurred': []
 };
 
 // If true, don't bark on events that were not registered via expect().
 // These events are recorded in capturedUnexpectedData instead of
 // capturedEventData.
 var ignoreUnexpected = false;
 
 // This is a debugging aid to print all received events as well as the
 // information whether they were expected.
 var logAllRequests = false;
 
+// Runs the |tests| using the |tab| as a default tab.
+function runTestsForTab(tests, tab) {
+  tabId = tab.id;
+  tabIdMap = {"-1": -1};
+  tabIdMap[tabId] = 0;
+  chrome.test.getConfig(function(config) {
+    testServerPort = config.testServer.port;
+    testWebSocketPort = config.testWebSocketPort;
+    chrome.test.runTests(tests);
+  });
+}
+
+// Creates an "about:blank" tab and runs |tests| with this tab as default.
 function runTests(tests) {
   var waitForAboutBlank = function(_, info, tab) {
     if (info.status == "complete" && tab.url == "about:blank") {
-      tabId = tab.id;
-      tabIdMap = {"-1": -1};
-      tabIdMap[tabId] = 0;
       chrome.tabs.onUpdated.removeListener(waitForAboutBlank);
-      chrome.test.getConfig(function(config) {
-        testServerPort = config.testServer.port;
-        chrome.test.runTests(tests);
-      });
+      runTestsForTab(tests, tab);
     }
   };
   chrome.tabs.onUpdated.addListener(waitForAboutBlank);
   chrome.tabs.create({url: "about:blank"});
 }
 
 // Returns an URL from the test server, fixing up the port. Must be called
 // from within a test case passed to runTests.
 function getServerURL(path, opt_host, opt_scheme) {
   if (!testServerPort)
@@ skipping 137 matching lines @@
       didMatchTabAndFrameId &&
       exp.details.method === details.method &&
       exp.details.url === details.url &&
       exp.details.type === details.type;
   });
 }
 
 function captureEvent(name, details, callback) {
   // Ignore system-level requests like safebrowsing updates and favicon fetches
   // since they are unpredictable.
-  if ((details.type == "other" && !details.url.includes('dont-ignore-me')) ||
+  // TODO(pkalinnikov): Remove the startsWith('ws') check once a new type gets

[Devlin, 2017/02/14 01:21:38]

When will this be?

[pkalinnikov, 2017/02/14 13:49:51]

I was thinking to address this in a follow-up CL. Do you think it should be done
in this one?

[Devlin, 2017/02/14 15:55:24]

I don't think this should be too complicated, and I'd rather do it at the same
time.  If we separate adding the functionality and differentiating, it means
that any extensions that try to use this have to code, like this, details.type
== 'other' && details.url.startsWith('ws') - and that kind of code has a nasty
habit of staying around.

If this ends up being painful, lemme know, but I think it should be
straightforward and should be addressed here.

[pkalinnikov, 2017/02/15 19:15:00]

Added new type in a separate CL.

+  // introduced for the WebSocket requests.
+  if ((details.type == "other" && !details.url.includes('dont-ignore-me') &&
+       !details.url.startsWith('ws')) ||
       isUnexpectedDetachedRequest(name, details) ||
       details.url.match(/\/favicon.ico$/) ||
-      details.url.match(/https:\/\/dl.google.com/))
+      details.url.match(/https:\/\/dl.google.com/)) {
     return;
+  }
 
   // Pull the extra per-event options out of the expected data. These let
   // us specify special return values per event.
   var currentIndex = capturedEventData.length;
   var extraOptions;
   var retval;
   if (expectedEventData.length > currentIndex) {
     retval =
         expectedEventData[currentIndex].retval_function ?
         expectedEventData[currentIndex].retval_function(name, details) :
@@ skipping 191 matching lines @@
   helper('onHeadersReceived');
   helper('onResponseStarted');
   helper('onBeforeRedirect');
   helper('onCompleted');
   helper('onErrorOccurred');
 }
 
 function resetDeclarativeRules() {
   chrome.declarativeWebRequest.onRequest.removeRules();
 }