Issue 5180 - remove synchronous WebRequest interface and stop exposing of DefaultWebRequest

test/WebRequest.cpp

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
  * Copyright (C) 2006-2017 eyeo GmbH
  *
  * Adblock Plus is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License version 3 as
  * published by the Free Software Foundation.
  *
  * Adblock Plus is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
  * along with Adblock Plus.  If not, see <http://www.gnu.org/licenses/>.
  */
 
 #include <sstream>
 #include "BaseJsTest.h"
 #include "../src/Thread.h"
 #include <atomic>
 #include <mutex>
 
 using namespace AdblockPlus;
 
 namespace
 {
-  class MockWebRequest : public AdblockPlus::WebRequest
+  class DefaultWebRequestTest : public ::testing::Test
   {
-  public:
-    AdblockPlus::ServerResponse GET(const std::string& url, const AdblockPlus::HeaderList& requestHeaders) const
+  protected:
+    void SetUp()
     {
-      std::set<std::string> headerNames;
-      for (auto header : requestHeaders)
+      JsEngineCreationParameters jsEngineParams;
+      jsEngineParams.timer.reset(new NoopTimer());
+      jsEngineParams.fileSystem.reset(new LazyFileSystem());
+      jsEngineParams.webRequest = CreateWebRequest();
+      jsEngine = CreateJsEngine(std::move(jsEngineParams));
+    }
+
+    virtual WebRequestPtr CreateWebRequest()
+    {
+      return CreateDefaultWebRequest();
+    }
+
+    JsEnginePtr jsEngine;
+  };
+
+  class MockWebRequestTest : public DefaultWebRequestTest
+  {
+    virtual WebRequestPtr CreateWebRequest() override
+    {
+      return DelayedWebRequest::New(webRequestTasks);
+    }
+
+  protected:
+    void ProcessPendingWebRequests()
+    {
+      for (auto iiWebTask = webRequestTasks->cbegin(); iiWebTask != webRequestTasks->cend();
+      webRequestTasks->erase(iiWebTask++))
       {
-        headerNames.insert(header.first);
+        const auto& webRequestTask = *iiWebTask;
+        std::set<std::string> headerNames;
+        for (const auto& header : webRequestTask.headers)
+        {
+          headerNames.insert(header.first);
+        }
+        // we currently ignore the result. We should check it actually gets inserted.
+        requestHeaderNames.insert(std::make_pair(webRequestTask.url, std::move(headerNames)));
+
+        AdblockPlus::ServerResponse result;
+        result.status = IWebRequest::NS_OK;
+        result.responseStatus = 123;
+        result.responseHeaders.push_back(std::pair<std::string, std::string>("Foo", "Bar"));
+        result.responseText = webRequestTask.url + "\n";
+        if (!webRequestTask.headers.empty())
+        {
+          result.responseText += webRequestTask.headers[0].first + "\n" + webRequestTask.headers[0].second;
+        }
+        webRequestTask.getCallback(result);
       }
-      {
-        std::lock_guard<std::mutex> lock(requestHeaderNamesMutex);
-        // we currently ignore the result. We should check it actually gets inserted.
-        requestHeaderNames.insert(std::make_pair(url, std::move(headerNames)));
-      }
-
-      AdblockPlus::Sleep(50);
-
-      AdblockPlus::ServerResponse result;
-      result.status = IWebRequest::NS_OK;
-      result.responseStatus = 123;
-      result.responseHeaders.push_back(std::pair<std::string, std::string>("Foo", "Bar"));
-      result.responseText = url + "\n";
-      if (!requestHeaders.empty())
-      {
-        result.responseText += requestHeaders[0].first + "\n" + requestHeaders[0].second;
-      }
-      return result;
     }
 
     // Testing method
-    // Get the headers for the request. Return a pair of a bool (found
-    // or not) and the actual header names
-    std::pair<bool, std::set<std::string>> headersForRequest(const std::string& url)
+    // Get the headers for the request. Return a pair of a bool (found or not)
+    // and the actual header names
+    std::pair<bool, std::set<std::string>> GetHeadersForRequest(const std::string& url)
     {
-      std::lock_guard<std::mutex> lock(requestHeaderNamesMutex);
       auto iter = requestHeaderNames.find(url);
       if (iter != requestHeaderNames.end())
       {
         auto result = std::make_pair(true, iter->second);
         requestHeaderNames.erase(iter);
         return result;
       }
       return std::make_pair(false, std::set<std::string>());
     }
 
-    // mutable. Very Ugly. But we are testing and need to change this in GET which is const.
-    mutable std::mutex requestHeaderNamesMutex;
-    mutable std::map<std::string, std::set<std::string>> requestHeaderNames;
+    DelayedWebRequest::SharedTasks webRequestTasks;
+    std::map<std::string, std::set<std::string>> requestHeaderNames;
   };
 
-  template<class T>
-  class WebRequestTest : public ::testing::Test
-  {
-  protected:
-    void SetUp()
-    {
-      JsEngineCreationParameters jsEngineParams;
-      jsEngineParams.timer.reset(new NoopTimer());
-      jsEngineParams.fileSystem.reset(new LazyFileSystem());
-      jsEngine = CreateJsEngine(std::move(jsEngineParams));
-      webRequest = std::make_shared<T>();
-      jsEngine->SetWebRequest(webRequest);
-    }
-
-    std::shared_ptr<T> webRequest;
-    JsEnginePtr jsEngine;
-  };
-
-  typedef WebRequestTest<MockWebRequest> MockWebRequestTest;
-  typedef WebRequestTest<AdblockPlus::DefaultWebRequestSync> DefaultWebRequestTest;
-  typedef WebRequestTest<MockWebRequest> XMLHttpRequestTest;
-
   // we return the url of the XHR.
   std::string ResetTestXHR(const AdblockPlus::JsEnginePtr& jsEngine, const std::string& defaultUrl = "")
   {
     std::string url = defaultUrl;
     // make up a unique URL if we don't have one.
     if (url == "")
     {
       url = "https://tests.adblockplus.org/easylist.txt-";
       url += std::to_string(std::chrono::system_clock::to_time_t(std::chrono::system_clock::now()));
     }
@@ skipping 26 matching lines @@
   ASSERT_ANY_THROW(jsEngine->Evaluate("_webRequest.GET({toString: false}, {}, function(){})"));
   ASSERT_ANY_THROW(jsEngine->Evaluate("_webRequest.GET('http://example.com/', null, function(){})"));
   ASSERT_ANY_THROW(jsEngine->Evaluate("_webRequest.GET('http://example.com/', {}, null)"));
   ASSERT_ANY_THROW(jsEngine->Evaluate("_webRequest.GET('http://example.com/', {}, function(){}, 0)"));
 }
 
 TEST_F(MockWebRequestTest, SuccessfulRequest)
 {
   jsEngine->Evaluate("_webRequest.GET('http://example.com/', {X: 'Y'}, function(result) {foo = result;} )");
   ASSERT_TRUE(jsEngine->Evaluate("this.foo").IsUndefined());
-  AdblockPlus::Sleep(200);
+  ProcessPendingWebRequests();
   ASSERT_EQ(IWebRequest::NS_OK, jsEngine->Evaluate("foo.status").AsInt());
   ASSERT_EQ(123, jsEngine->Evaluate("foo.responseStatus").AsInt());
   ASSERT_EQ("http://example.com/\nX\nY", jsEngine->Evaluate("foo.responseText").AsString());
   ASSERT_EQ("{\"Foo\":\"Bar\"}", jsEngine->Evaluate("JSON.stringify(foo.responseHeaders)").AsString());
 }
 
 #if defined(HAVE_CURL) || defined(_WIN32)
 TEST_F(DefaultWebRequestTest, RealWebRequest)
 {
   // This URL should redirect to easylist-downloads.adblockplus.org and we
@@ skipping 82 matching lines @@
     void clear()
     {
       lastLogLevel = AdblockPlus::LogSystem::LOG_LEVEL_TRACE;
       lastMessage.clear();
     }
   };
 
   typedef std::shared_ptr<CatchLogSystem> CatchLogSystemPtr;
 }
 
-TEST_F(XMLHttpRequestTest, RequestHeaderValidation)
+TEST_F(MockWebRequestTest, RequestHeaderValidation)
 {
   auto catchLogSystem = CatchLogSystemPtr(new CatchLogSystem());
   jsEngine->SetLogSystem(catchLogSystem);
 
   auto filterEngine = AdblockPlus::FilterEngine::Create(jsEngine);
 
   const std::string msg = "Attempt to set a forbidden header was denied: ";
 
   // The test will check that console.warn has been called when the
   // header is rejected. While this is an implementation detail, we
   // have no other way to check this
 
   // test 'Accept-Encoding' is rejected
   catchLogSystem->clear();
   std::string url = ResetTestXHR(jsEngine);
   jsEngine->Evaluate("\
     request.setRequestHeader('Accept-Encoding', 'gzip');\nrequest.send();");
   EXPECT_EQ(AdblockPlus::LogSystem::LOG_LEVEL_WARN, catchLogSystem->lastLogLevel);
   EXPECT_EQ(msg + "Accept-Encoding", catchLogSystem->lastMessage);
-  WaitForVariable("result", jsEngine);
+  ProcessPendingWebRequests();
   {
-    auto headersRequest = webRequest->headersForRequest(url);
+    auto headersRequest = GetHeadersForRequest(url);
     EXPECT_TRUE(headersRequest.first);
     const auto& headers = headersRequest.second;
     EXPECT_TRUE(headers.cend() == headers.find("Accept-Encoding"));
   }
 
   // test 'DNT' is rejected
   catchLogSystem->clear();
   url = ResetTestXHR(jsEngine);
   jsEngine->Evaluate("\
     request.setRequestHeader('DNT', '1');\nrequest.send();");
   EXPECT_EQ(AdblockPlus::LogSystem::LOG_LEVEL_WARN, catchLogSystem->lastLogLevel);
   EXPECT_EQ(msg + "DNT", catchLogSystem->lastMessage);
-  WaitForVariable("result", jsEngine);
+  ProcessPendingWebRequests();
   {
-    auto headersRequest = webRequest->headersForRequest(url);
+    auto headersRequest = GetHeadersForRequest(url);
     EXPECT_TRUE(headersRequest.first);
     const auto& headers = headersRequest.second;
     EXPECT_TRUE(headers.cend() == headers.find("DNT"));
   }
 
   // test random 'X' header is accepted
   catchLogSystem->clear();
   url = ResetTestXHR(jsEngine);
   jsEngine->Evaluate("\
     request.setRequestHeader('X', 'y');\nrequest.send();");
   EXPECT_EQ(AdblockPlus::LogSystem::LOG_LEVEL_TRACE, catchLogSystem->lastLogLevel);
   EXPECT_EQ("", catchLogSystem->lastMessage);
-  WaitForVariable("result", jsEngine);
+  ProcessPendingWebRequests();
   {
-    auto headersRequest = webRequest->headersForRequest(url);
+    auto headersRequest = GetHeadersForRequest(url);
     EXPECT_TRUE(headersRequest.first);
     const auto& headers = headersRequest.second;
     EXPECT_FALSE(headers.cend() == headers.find("X"));
   }
 
   // test /^Proxy-/ is rejected.
   catchLogSystem->clear();
   url = ResetTestXHR(jsEngine);
   jsEngine->Evaluate("\
     request.setRequestHeader('Proxy-foo', 'bar');\nrequest.send();");
   EXPECT_EQ(AdblockPlus::LogSystem::LOG_LEVEL_WARN, catchLogSystem->lastLogLevel);
   EXPECT_EQ(msg + "Proxy-foo", catchLogSystem->lastMessage);
-  WaitForVariable("result", jsEngine);
+  ProcessPendingWebRequests();
   {
-    auto headersRequest = webRequest->headersForRequest(url);
+    auto headersRequest = GetHeadersForRequest(url);
     EXPECT_TRUE(headersRequest.first);
     const auto& headers = headersRequest.second;
     EXPECT_TRUE(headers.cend() == headers.find("Proxy-foo"));
   }
 
   // test /^Sec-/ is rejected.
   catchLogSystem->clear();
   url = ResetTestXHR(jsEngine);
   jsEngine->Evaluate("\
     request.setRequestHeader('Sec-foo', 'bar');\nrequest.send();");
   EXPECT_EQ(AdblockPlus::LogSystem::LOG_LEVEL_WARN, catchLogSystem->lastLogLevel);
   EXPECT_EQ(msg + "Sec-foo", catchLogSystem->lastMessage);
-  WaitForVariable("result", jsEngine);
+  ProcessPendingWebRequests();
   {
-    auto headersRequest = webRequest->headersForRequest(url);
+    auto headersRequest = GetHeadersForRequest(url);
     EXPECT_TRUE(headersRequest.first);
     const auto& headers = headersRequest.second;
     EXPECT_TRUE(headers.cend() == headers.find("Sec-foo"));
   }
 
   // test 'Security' is accepted.
   catchLogSystem->clear();
   url = ResetTestXHR(jsEngine);
   jsEngine->Evaluate("\
     request.setRequestHeader('Security', 'theater');\nrequest.send();");
   EXPECT_EQ(AdblockPlus::LogSystem::LOG_LEVEL_TRACE, catchLogSystem->lastLogLevel);
   EXPECT_EQ("", catchLogSystem->lastMessage);
-  WaitForVariable("result", jsEngine);
+  ProcessPendingWebRequests();
   {
-    auto headersRequest = webRequest->headersForRequest(url);
+    auto headersRequest = GetHeadersForRequest(url);
     EXPECT_TRUE(headersRequest.first);
     const auto& headers = headersRequest.second;
     EXPECT_FALSE(headers.cend() == headers.find("Security"));
   }
 }