Issue 5002 - Fix potential concurrency issues in WebRequest tests.

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
@@ skipping 43 matching lines @@
       }
       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)
     {
       std::lock_guard<std::mutex> lock(requestHeaderNamesMutex);
-      const auto& iter = requestHeaderNames.find(url);

[sergei, 2017/04/19 13:17:29]

const reference keeps the object from destroying here, but could you please just
leave `auto` or `const auto`?

[hub, 2017/04/19 14:41:00]

indeed, it's better. not sure what I thought here.

+      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;
   };
 
   template<class T>
   class WebRequestTest : public BaseJsTest
   {
   protected:
     void SetUp()
     {
       BaseJsTest::SetUp();
-      webRequest = AdblockPlus::WebRequestPtr(new T());
+      webRequest = std::make_shared<T>();
       jsEngine->SetWebRequest(webRequest);
       jsEngine->SetFileSystem(AdblockPlus::FileSystemPtr(new LazyFileSystem()));
     }
 
-    AdblockPlus::WebRequestPtr webRequest;

[sergei, 2017/04/19 13:17:29]

What about storing of std::shared_ptr<MockWebRequest> and avoid castings later?

[hub, 2017/04/19 14:41:00]

more like std::shared_ptr<T>. Sure I can do that.

+    std::shared_ptr<T> webRequest;
   };
 
   typedef WebRequestTest<MockWebRequest> MockWebRequestTest;
   typedef WebRequestTest<AdblockPlus::DefaultWebRequest> 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;
@@ skipping 141 matching lines @@
 
   typedef std::shared_ptr<CatchLogSystem> CatchLogSystemPtr;
 }
 
 TEST_F(XMLHttpRequestTest, RequestHeaderValidation)
 {
   auto catchLogSystem = CatchLogSystemPtr(new CatchLogSystem());
   jsEngine->SetLogSystem(catchLogSystem);
 
   auto filterEngine = AdblockPlus::FilterEngine::Create(jsEngine);
-  auto mockWebRequest =
-    std::static_pointer_cast<MockWebRequest>(webRequest);
-
-  ASSERT_TRUE(mockWebRequest);
 
   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);
   {
-    auto headersRequest = mockWebRequest->headersForRequest(url);
+    auto headersRequest = webRequest->headersForRequest(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);
   {
-    auto headersRequest = mockWebRequest->headersForRequest(url);
+    auto headersRequest = webRequest->headersForRequest(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);
   {
-    auto headersRequest = mockWebRequest->headersForRequest(url);
+    auto headersRequest = webRequest->headersForRequest(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);
   {
-    auto headersRequest = mockWebRequest->headersForRequest(url);
+    auto headersRequest = webRequest->headersForRequest(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);
   {
-    auto headersRequest = mockWebRequest->headersForRequest(url);
+    auto headersRequest = webRequest->headersForRequest(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);
   {
-    auto headersRequest = mockWebRequest->headersForRequest(url);
+    auto headersRequest = webRequest->headersForRequest(url);
     EXPECT_TRUE(headersRequest.first);
     const auto& headers = headersRequest.second;
     EXPECT_FALSE(headers.cend() == headers.find("Security"));
   }
 }