Issue 4688 - stop using of LazyWebRequest in tests/UpdateCheck.cpp

test/UpdateCheck.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
@@ skipping 13 matching lines @@
 namespace
 {
   typedef std::shared_ptr<AdblockPlus::FilterEngine> FilterEnginePtr;
 
   void FindAndReplace(std::string& source, const std::string& find, const std::string& replace)
   {
     for (size_t pos = 0; (pos = source.find(find), pos) != std::string::npos; pos += replace.size())
       source.replace(pos, find.size(), replace);
   }
 
-  std::string previousRequestUrl;
-  class TestWebRequest : public LazyWebRequest
-  {
-  public:
-    AdblockPlus::ServerResponse response;
-    AdblockPlus::ServerResponse GET(const std::string& url, const AdblockPlus::HeaderList& requestHeaders) const
-    {
-      if (url.find("easylist") != std::string::npos)
-        return LazyWebRequest::GET(url, requestHeaders);
-
-      previousRequestUrl = url;
-      return response;
-    }
-  };
-
   class UpdateCheckTest : public ::testing::Test
   {
   protected:
     AdblockPlus::AppInfo appInfo;
-    std::shared_ptr<TestWebRequest> webRequest;
+    AdblockPlus::ServerResponse webRequestResponse;
+    DelayedWebRequest::SharedTasks webRequestTasks;
+    DelayedTimer::SharedTasks timerTasks;
     AdblockPlus::JsEnginePtr jsEngine;
     FilterEnginePtr filterEngine;
 
     bool eventCallbackCalled;
     AdblockPlus::JsValueList eventCallbackParams;
     bool updateCallbackCalled;
     std::string updateError;
 
     void SetUp()
     {
-      webRequest = std::make_shared<TestWebRequest>();
-
       eventCallbackCalled = false;
       updateCallbackCalled = false;
       Reset();
     }
 
     void Reset()
     {
       JsEngineCreationParameters jsEngineParams;
       jsEngineParams.appInfo = appInfo;
       jsEngineParams.logSystem.reset(new LazyLogSystem());
       jsEngineParams.fileSystem.reset(new LazyFileSystem());
-      jsEngineParams.timer = CreateDefaultTimer();
+      jsEngineParams.timer = DelayedTimer::New(timerTasks);
+      jsEngineParams.webRequest = DelayedWebRequest::New(webRequestTasks);
       jsEngine = CreateJsEngine(std::move(jsEngineParams));
-      jsEngine->SetWebRequest(webRequest);
       jsEngine->SetEventCallback("updateAvailable", [this](JsValueList&& params)
       {
         eventCallbackCalled = true;
         eventCallbackParams = std::move(params);
       });
 
       filterEngine = AdblockPlus::FilterEngine::Create(jsEngine);
     }
 
+    // Returns a URL or the empty string if there is no such request.
+    std::string ProcessPendingUpdateWebRequest()
+    {
+      auto ii = webRequestTasks->begin();
+      while (ii != webRequestTasks->end())
+      {

[hub, 2017/05/10 17:53:19]

Maybe I'm missing something, but wouldn't a for loop with range iterator works
here?

[sergei, 2017/05/10 18:15:54]

it will but it won't remove the found entry. Do you think it should be changed?

[hub, 2017/05/10 18:55:54]

uh. I missed that little detail :-/

+        if (ii->url.find("update.json") != std::string::npos)
+        {
+          ii->getCallback(webRequestResponse);
+          auto url = ii->url;
+          webRequestTasks->erase(ii);
+          return url;
+        }
+        ++ii;
+      }
+      return std::string();
+    }
+
     void ForceUpdateCheck()
     {
-      filterEngine->ForceUpdateCheck(
-          std::bind(&UpdateCheckTest::UpdateCallback, this, std::placeholders::_1));
-    }
-
-    void UpdateCallback(const std::string& error)
-    {
-      updateCallbackCalled = true;
-      updateError = error;
+      filterEngine->ForceUpdateCheck([this](const std::string& error)
+      {
+        updateCallbackCalled = true;
+        updateError = error;
+      });
+      DelayedTimer::ProcessImmediateTimers(timerTasks);
     }
   };
 }
 
 TEST_F(UpdateCheckTest, RequestFailure)
 {
-  webRequest->response.status = IWebRequest::NS_ERROR_FAILURE;
+  webRequestResponse.status = IWebRequest::NS_ERROR_FAILURE;
 
   appInfo.name = "1";
   appInfo.version = "3";
   appInfo.application = "4";
   appInfo.applicationVersion = "2";
   appInfo.developmentBuild = false;
 
   Reset();
   ForceUpdateCheck();
 
-  AdblockPlus::Sleep(100);
+  auto requestUrl = ProcessPendingUpdateWebRequest();
 
   ASSERT_FALSE(eventCallbackCalled);
   ASSERT_TRUE(updateCallbackCalled);
   ASSERT_FALSE(updateError.empty());
 
   std::string expectedUrl(filterEngine->GetPref("update_url_release").AsString());
   std::string platform = jsEngine->Evaluate("require('info').platform").AsString();
   std::string platformVersion = jsEngine->Evaluate("require('info').platformVersion").AsString();
 
   FindAndReplace(expectedUrl, "%NAME%", appInfo.name);
   FindAndReplace(expectedUrl, "%TYPE%", "1");   // manual update
   expectedUrl += "&addonName=" + appInfo.name +
                  "&addonVersion=" + appInfo.version +
                  "&application=" + appInfo.application +
                  "&applicationVersion=" + appInfo.applicationVersion +
                  "&platform=" + platform +
                  "&platformVersion=" + platformVersion +
                  "&lastVersion=0&downloadCount=0";
-  ASSERT_EQ(expectedUrl, previousRequestUrl);
+  ASSERT_EQ(expectedUrl, requestUrl);
 }
 
 TEST_F(UpdateCheckTest, UpdateAvailable)
 {
-  webRequest->response.status = IWebRequest::NS_OK;
-  webRequest->response.responseStatus = 200;
-  webRequest->response.responseText = "{\"1\": {\"version\":\"3.1\",\"url\":\"https://foo.bar/\"}}";
+  webRequestResponse.status = IWebRequest::NS_OK;
+  webRequestResponse.responseStatus = 200;
+  webRequestResponse.responseText = "{\"1\": {\"version\":\"3.1\",\"url\":\"https://foo.bar/\"}}";
 
   appInfo.name = "1";
   appInfo.version = "3";
   appInfo.application = "4";
   appInfo.applicationVersion = "2";
   appInfo.developmentBuild = true;
 
   Reset();
   ForceUpdateCheck();
 
-  AdblockPlus::Sleep(100);
+  auto requestUrl = ProcessPendingUpdateWebRequest();
 
   ASSERT_TRUE(eventCallbackCalled);
   ASSERT_EQ(1u, eventCallbackParams.size());
   ASSERT_EQ("https://foo.bar/", eventCallbackParams[0].AsString());
   ASSERT_TRUE(updateCallbackCalled);
   ASSERT_TRUE(updateError.empty());
 
   std::string expectedUrl(filterEngine->GetPref("update_url_devbuild").AsString());
   std::string platform = jsEngine->Evaluate("require('info').platform").AsString();
   std::string platformVersion = jsEngine->Evaluate("require('info').platformVersion").AsString();
 
   FindAndReplace(expectedUrl, "%NAME%", appInfo.name);
   FindAndReplace(expectedUrl, "%TYPE%", "1");   // manual update
   expectedUrl += "&addonName=" + appInfo.name +
                  "&addonVersion=" + appInfo.version +
                  "&application=" + appInfo.application +
                  "&applicationVersion=" + appInfo.applicationVersion +
                  "&platform=" + platform +
                  "&platformVersion=" + platformVersion +
                  "&lastVersion=0&downloadCount=0";
-  ASSERT_EQ(expectedUrl, previousRequestUrl);
+  ASSERT_EQ(expectedUrl, requestUrl);
 }
 
 TEST_F(UpdateCheckTest, ApplicationUpdateAvailable)
 {
-  webRequest->response.status = IWebRequest::NS_OK;
-  webRequest->response.responseStatus = 200;
-  webRequest->response.responseText = "{\"1/4\": {\"version\":\"3.1\",\"url\":\"https://foo.bar/\"}}";
+  webRequestResponse.status = IWebRequest::NS_OK;
+  webRequestResponse.responseStatus = 200;
+  webRequestResponse.responseText = "{\"1/4\": {\"version\":\"3.1\",\"url\":\"https://foo.bar/\"}}";
 
   appInfo.name = "1";
   appInfo.version = "3";
   appInfo.application = "4";
   appInfo.applicationVersion = "2";
   appInfo.developmentBuild = true;
 
   Reset();
   ForceUpdateCheck();
 
-  AdblockPlus::Sleep(100);
+  ProcessPendingUpdateWebRequest();
 
   ASSERT_TRUE(eventCallbackCalled);
   ASSERT_EQ(1u, eventCallbackParams.size());
   ASSERT_EQ("https://foo.bar/", eventCallbackParams[0].AsString());
-  ASSERT_TRUE(updateCallbackCalled);
   ASSERT_TRUE(updateError.empty());
 }
 
 TEST_F(UpdateCheckTest, WrongApplication)
 {
-  webRequest->response.status = IWebRequest::NS_OK;
-  webRequest->response.responseStatus = 200;
-  webRequest->response.responseText = "{\"1/3\": {\"version\":\"3.1\",\"url\":\"https://foo.bar/\"}}";
+  webRequestResponse.status = IWebRequest::NS_OK;
+  webRequestResponse.responseStatus = 200;
+  webRequestResponse.responseText = "{\"1/3\": {\"version\":\"3.1\",\"url\":\"https://foo.bar/\"}}";
 
   appInfo.name = "1";
   appInfo.version = "3";
   appInfo.application = "4";
   appInfo.applicationVersion = "2";
   appInfo.developmentBuild = true;
 
   Reset();
   ForceUpdateCheck();
 
-  AdblockPlus::Sleep(100);
+  ProcessPendingUpdateWebRequest();
 
   ASSERT_FALSE(eventCallbackCalled);
   ASSERT_TRUE(updateCallbackCalled);
   ASSERT_TRUE(updateError.empty());
 }
 
 TEST_F(UpdateCheckTest, WrongVersion)
 {
-  webRequest->response.status = IWebRequest::NS_OK;
-  webRequest->response.responseStatus = 200;
-  webRequest->response.responseText = "{\"1\": {\"version\":\"3\",\"url\":\"https://foo.bar/\"}}";
+  webRequestResponse.status = IWebRequest::NS_OK;
+  webRequestResponse.responseStatus = 200;
+  webRequestResponse.responseText = "{\"1\": {\"version\":\"3\",\"url\":\"https://foo.bar/\"}}";
 
   appInfo.name = "1";
   appInfo.version = "3";
   appInfo.application = "4";
   appInfo.applicationVersion = "2";
   appInfo.developmentBuild = true;
 
   Reset();
   ForceUpdateCheck();
 
-  AdblockPlus::Sleep(100);
+  ProcessPendingUpdateWebRequest();
 
   ASSERT_FALSE(eventCallbackCalled);
   ASSERT_TRUE(updateCallbackCalled);
   ASSERT_TRUE(updateError.empty());
 }
 
 TEST_F(UpdateCheckTest, WrongURL)
 {
-  webRequest->response.status = IWebRequest::NS_OK;
-  webRequest->response.responseStatus = 200;
-  webRequest->response.responseText = "{\"1\": {\"version\":\"3.1\",\"url\":\"http://insecure/\"}}";
+  webRequestResponse.status = IWebRequest::NS_OK;
+  webRequestResponse.responseStatus = 200;
+  webRequestResponse.responseText = "{\"1\": {\"version\":\"3.1\",\"url\":\"http://insecure/\"}}";
 
   appInfo.name = "1";
   appInfo.version = "3";
   appInfo.application = "4";
   appInfo.applicationVersion = "2";
   appInfo.developmentBuild = true;
 
   Reset();
   ForceUpdateCheck();
 
-  AdblockPlus::Sleep(100);
+  ProcessPendingUpdateWebRequest();
 
   ASSERT_FALSE(eventCallbackCalled);
   ASSERT_TRUE(updateCallbackCalled);
   ASSERT_FALSE(updateError.empty());
 }