Fix flakyness in webRequest API tests

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 testServerPort;
 var testServer = "www.a.com";
 var defaultScheme = "http";
 var eventsCaptured;
 
 // 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;
 
 function runTests(tests) {
-  chrome.tabs.create({url: "about:blank"}, function(tab) {
-    tabId = tab.id;
-    tabIdMap = {};
-    tabIdMap[tabId] = 0;
-    chrome.test.getConfig(function(config) {
-      testServerPort = config.testServer.port;
-      chrome.test.runTests(tests);
-    });
-  });
+  var waitForAboutBlank = function(_, info, tab) {
+    if (info.status == "complete" && tab.url == "about:blank") {
+      tabId = tab.id;
+      tabIdMap = {};
+      tabIdMap[tabId] = 0;
+      chrome.tabs.onUpdated.removeListener(waitForAboutBlank);
+      chrome.test.getConfig(function(config) {
+        testServerPort = config.testServer.port;
+        chrome.test.runTests(tests);
+      });
+    }
+  };
+  chrome.tabs.onUpdated.addListener(waitForAboutBlank);
+  chrome.tabs.create({url: "about:blank"});

[Matt Perry, 2013/01/03 23:39:30]

wow this API sucks :)

 }
 
 // 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)
     throw new Error("Called getServerURL outside of runTests.");
   var host = opt_host || testServer;
   var scheme = opt_scheme || defaultScheme;
   return scheme + "://" + host + ":" + testServerPort + "/" + path;
@@ skipping 111 matching lines @@
   // since they are unpredictable.
   if (details.tabId == -1 || details.type == "other" ||
       details.url.match(/\/favicon.ico$/) ||
       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;

[battre, 2012/12/19 17:57:57]

we assign retval in 176 to a global variable without this. That's wrong.

   if (expectedEventData.length > currentIndex) {
     retval =
         expectedEventData[currentIndex].retval_function ?
         expectedEventData[currentIndex].retval_function(name, details) :
         expectedEventData[currentIndex].retval;
   }
 
   // Check that the frameId can be used to reliably determine the URL of the
   // frame that caused requests.
   if (name == "onBeforeRequest") {
@@ skipping 144 matching lines @@
   helper(chrome.webRequest.onHeadersReceived);
   helper(chrome.webRequest.onResponseStarted);
   helper(chrome.webRequest.onBeforeRedirect);
   helper(chrome.webRequest.onCompleted);
   helper(chrome.webRequest.onErrorOccurred);
 }
 
 function resetDeclarativeRules() {
   chrome.declarativeWebRequest.onRequest.removeRules();
 }