Issue 5450 - don't expose std::shared_ptr<JsEngine>

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 BaseWebRequestTest : public ::testing::Test
+  class BaseWebRequestTest : public BaseJsTest
   {
   protected:
     void SetUp()
     {
       ThrowingPlatformCreationParameters platformParams;
       platformParams.logSystem = CreateLogSystem();
       platformParams.timer.reset(new NoopTimer());
       platformParams.fileSystem.reset(fileSystem = new LazyFileSystem());
       platformParams.webRequest = CreateWebRequest();
       platform.reset(new Platform(std::move(platformParams)));
-      jsEngine = platform->GetJsEngine();
     }
 
     virtual WebRequestPtr CreateWebRequest() = 0;
 
     virtual LogSystemPtr CreateLogSystem()
     {
       return LogSystemPtr(new ThrowingLogSystem());
     }
 
-    std::unique_ptr<Platform> platform;
-    JsEnginePtr jsEngine;
     LazyFileSystem* fileSystem;
   };
 
   class DefaultWebRequestTest : public BaseWebRequestTest
   {
     WebRequestPtr CreateWebRequest() override
     {
       return CreateDefaultWebRequest([this](const SchedulerTask& task)
       {
         webRequestTasks.emplace_back(task);
       });
     }
     std::list<SchedulerTask> webRequestTasks;
   protected:
-    void WaitForVariable(const std::string& variable, const AdblockPlus::JsEnginePtr& jsEngine)
+    void WaitForVariable(const std::string& variable, AdblockPlus::JsEngine& jsEngine)
     {
-      while (jsEngine->Evaluate(variable).IsUndefined() && !webRequestTasks.empty())
+      while (jsEngine.Evaluate(variable).IsUndefined() && !webRequestTasks.empty())
       {
         (*webRequestTasks.begin())();
         webRequestTasks.pop_front();
       }
     }
   };
 
   class MockWebRequestTest : public BaseWebRequestTest
   {
     WebRequestPtr CreateWebRequest() override
@@ skipping 42 matching lines @@
         return result;
       }
       return std::make_pair(false, std::set<std::string>());
     }
 
     DelayedWebRequest::SharedTasks webRequestTasks;
     std::map<std::string, std::set<std::string>> requestHeaderNames;
   };
 
   // we return the url of the XHR.
-  std::string ResetTestXHR(const AdblockPlus::JsEnginePtr& jsEngine, const std::string& defaultUrl = "")
+  std::string ResetTestXHR(AdblockPlus::JsEngine& 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()));
     }
 
-    jsEngine->Evaluate(std::string("\
+    jsEngine.Evaluate(std::string("\
       var result;\
       var request = new XMLHttpRequest();\
       request.open('GET', '") + url + "'); \
       request.overrideMimeType('text/plain');\
       request.addEventListener('load', function() {result = request.responseText;}, false);\
       request.addEventListener('error', function() {result = 'error';}, false);\
     ");
     return url;
   }
 }
 
 TEST_F(MockWebRequestTest, BadCall)
 {
-  ASSERT_ANY_THROW(jsEngine->Evaluate("_webRequest.GET()"));
-  ASSERT_ANY_THROW(jsEngine->Evaluate("_webRequest.GET('', {}, function(){})"));
-  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)"));
+  auto& jsEngine = GetJsEngine();
+  ASSERT_ANY_THROW(jsEngine.Evaluate("_webRequest.GET()"));
+  ASSERT_ANY_THROW(jsEngine.Evaluate("_webRequest.GET('', {}, function(){})"));
+  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());
+  auto& jsEngine = GetJsEngine();
+  jsEngine.Evaluate("_webRequest.GET('http://example.com/', {X: 'Y'}, function(result) {foo = result;} )");
+  ASSERT_TRUE(jsEngine.Evaluate("this.foo").IsUndefined());
   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());
+  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)
 {
+  auto& jsEngine = GetJsEngine();
   // This URL should redirect to easylist-downloads.adblockplus.org and we
   // should get the actual filter list back.
-  jsEngine->Evaluate("_webRequest.GET('https://easylist-downloads.adblockplus.org/easylist.txt', {}, function(result) {foo = result;} )");
+  jsEngine.Evaluate("_webRequest.GET('https://easylist-downloads.adblockplus.org/easylist.txt', {}, function(result) {foo = result;} )");
   WaitForVariable("this.foo", jsEngine);
-  ASSERT_EQ("text/plain", jsEngine->Evaluate("foo.responseHeaders['content-type'].substr(0, 10)").AsString());
-  ASSERT_EQ(IWebRequest::NS_OK, jsEngine->Evaluate("foo.status").AsInt());
-  ASSERT_EQ(200, jsEngine->Evaluate("foo.responseStatus").AsInt());
-  ASSERT_EQ("[Adblock Plus ", jsEngine->Evaluate("foo.responseText.substr(0, 14)").AsString());
-  ASSERT_EQ("text/plain", jsEngine->Evaluate("foo.responseHeaders['content-type'].substr(0, 10)").AsString());
+  ASSERT_EQ("text/plain", jsEngine.Evaluate("foo.responseHeaders['content-type'].substr(0, 10)").AsString());
+  ASSERT_EQ(IWebRequest::NS_OK, jsEngine.Evaluate("foo.status").AsInt());
+  ASSERT_EQ(200, jsEngine.Evaluate("foo.responseStatus").AsInt());
+  ASSERT_EQ("[Adblock Plus ", jsEngine.Evaluate("foo.responseText.substr(0, 14)").AsString());
+  ASSERT_EQ("text/plain", jsEngine.Evaluate("foo.responseHeaders['content-type'].substr(0, 10)").AsString());
 #if defined(HAVE_CURL)
-  ASSERT_EQ("gzip", jsEngine->Evaluate("foo.responseHeaders['content-encoding'].substr(0, 4)").AsString());
+  ASSERT_EQ("gzip", jsEngine.Evaluate("foo.responseHeaders['content-encoding'].substr(0, 4)").AsString());
 #endif
-  ASSERT_TRUE(jsEngine->Evaluate("foo.responseHeaders['location']").IsUndefined());
+  ASSERT_TRUE(jsEngine.Evaluate("foo.responseHeaders['location']").IsUndefined());
 }
 
 TEST_F(DefaultWebRequestTest, XMLHttpRequest)
 {
+  auto& jsEngine = GetJsEngine();
   auto filterEngine = CreateFilterEngine(*fileSystem, *platform);
 
   ResetTestXHR(jsEngine, "https://easylist-downloads.adblockplus.org/easylist.txt");
-  jsEngine->Evaluate("\
+  jsEngine.Evaluate("\
     request.setRequestHeader('X', 'Y');\
     request.setRequestHeader('X2', 'Y2');\
     request.send(null);");
   WaitForVariable("result", jsEngine);
-  ASSERT_EQ(IWebRequest::NS_OK, jsEngine->Evaluate("request.channel.status").AsInt());
-  ASSERT_EQ(200, jsEngine->Evaluate("request.status").AsInt());
-  ASSERT_EQ("[Adblock Plus ", jsEngine->Evaluate("result.substr(0, 14)").AsString());
-  ASSERT_EQ("text/plain", jsEngine->Evaluate("request.getResponseHeader('Content-Type').substr(0, 10)").AsString());
+  ASSERT_EQ(IWebRequest::NS_OK, jsEngine.Evaluate("request.channel.status").AsInt());
+  ASSERT_EQ(200, jsEngine.Evaluate("request.status").AsInt());
+  ASSERT_EQ("[Adblock Plus ", jsEngine.Evaluate("result.substr(0, 14)").AsString());
+  ASSERT_EQ("text/plain", jsEngine.Evaluate("request.getResponseHeader('Content-Type').substr(0, 10)").AsString());
 #if defined(HAVE_CURL)
-  ASSERT_EQ("gzip", jsEngine->Evaluate("request.getResponseHeader('Content-Encoding').substr(0, 4)").AsString());
+  ASSERT_EQ("gzip", jsEngine.Evaluate("request.getResponseHeader('Content-Encoding').substr(0, 4)").AsString());
 #endif
-  ASSERT_TRUE(jsEngine->Evaluate("request.getResponseHeader('Location')").IsNull());
+  ASSERT_TRUE(jsEngine.Evaluate("request.getResponseHeader('Location')").IsNull());
 }
 #else
 TEST_F(DefaultWebRequestTest, DummyWebRequest)
 {
-  jsEngine->Evaluate("_webRequest.GET('https://easylist-downloads.adblockplus.org/easylist.txt', {}, function(result) {foo = result;} )");
+  auto& jsEngine = GetJsEngine();
+  jsEngine.Evaluate("_webRequest.GET('https://easylist-downloads.adblockplus.org/easylist.txt', {}, function(result) {foo = result;} )");
   WaitForVariable("this.foo", jsEngine);
-  ASSERT_EQ(IWebRequest::NS_ERROR_FAILURE, jsEngine->Evaluate("foo.status").AsInt());
-  ASSERT_EQ(0, jsEngine->Evaluate("foo.responseStatus").AsInt());
-  ASSERT_EQ("", jsEngine->Evaluate("foo.responseText").AsString());
-  ASSERT_EQ("{}", jsEngine->Evaluate("JSON.stringify(foo.responseHeaders)").AsString());
+  ASSERT_EQ(IWebRequest::NS_ERROR_FAILURE, jsEngine.Evaluate("foo.status").AsInt());
+  ASSERT_EQ(0, jsEngine.Evaluate("foo.responseStatus").AsInt());
+  ASSERT_EQ("", jsEngine.Evaluate("foo.responseText").AsString());
+  ASSERT_EQ("{}", jsEngine.Evaluate("JSON.stringify(foo.responseHeaders)").AsString());
 }
 
 TEST_F(DefaultWebRequestTest, XMLHttpRequest)
 {
+  auto& jsEngine = GetJsEngine();
   auto filterEngine = CreateFilterEngine(*fileSystem, *platform);
 
   ResetTestXHR(jsEngine);
-  jsEngine->Evaluate("\
+  jsEngine.Evaluate("\
     request.setRequestHeader('X', 'Y');\
     request.send(null);");
   WaitForVariable("result", jsEngine);
-  ASSERT_EQ(IWebRequest::NS_ERROR_FAILURE, jsEngine->Evaluate("request.channel.status").AsInt());
-  ASSERT_EQ(0, jsEngine->Evaluate("request.status").AsInt());
-  ASSERT_EQ("error", jsEngine->Evaluate("result").AsString());
-  ASSERT_TRUE(jsEngine->Evaluate("request.getResponseHeader('Content-Type')").IsNull());
+  ASSERT_EQ(IWebRequest::NS_ERROR_FAILURE, jsEngine.Evaluate("request.channel.status").AsInt());
+  ASSERT_EQ(0, jsEngine.Evaluate("request.status").AsInt());
+  ASSERT_EQ("error", jsEngine.Evaluate("result").AsString());
+  ASSERT_TRUE(jsEngine.Evaluate("request.getResponseHeader('Content-Type')").IsNull());
 }
 
 #endif
 
 namespace
 {
   class CatchLogSystem : public AdblockPlus::LogSystem
   {
   public:
     AdblockPlus::LogSystem::LogLevel lastLogLevel;
@@ skipping 25 matching lines @@
     {
       return LogSystemPtr(catchLogSystem = new CatchLogSystem());
     }
   protected:
     CatchLogSystem* catchLogSystem;
   };
 }
 
 TEST_F(MockWebRequestAndLogSystemTest, RequestHeaderValidation)
 {
+  auto& jsEngine = GetJsEngine();
   auto filterEngine = CreateFilterEngine(*fileSystem, *platform);
 
   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("\
+  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);
   ProcessPendingWebRequests();
   {
     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("\
+  jsEngine.Evaluate("\
     request.setRequestHeader('DNT', '1');\nrequest.send();");
   EXPECT_EQ(AdblockPlus::LogSystem::LOG_LEVEL_WARN, catchLogSystem->lastLogLevel);
   EXPECT_EQ(msg + "DNT", catchLogSystem->lastMessage);
   ProcessPendingWebRequests();
   {
     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("\
+  jsEngine.Evaluate("\
     request.setRequestHeader('X', 'y');\nrequest.send();");
   EXPECT_EQ(AdblockPlus::LogSystem::LOG_LEVEL_TRACE, catchLogSystem->lastLogLevel);
   EXPECT_EQ("", catchLogSystem->lastMessage);
   ProcessPendingWebRequests();
   {
     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("\
+  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);
   ProcessPendingWebRequests();
   {
     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("\
+  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);
   ProcessPendingWebRequests();
   {
     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("\
+  jsEngine.Evaluate("\
     request.setRequestHeader('Security', 'theater');\nrequest.send();");
   EXPECT_EQ(AdblockPlus::LogSystem::LOG_LEVEL_TRACE, catchLogSystem->lastLogLevel);
   EXPECT_EQ("", catchLogSystem->lastMessage);
   ProcessPendingWebRequests();
   {
     auto headersRequest = GetHeadersForRequest(url);
     EXPECT_TRUE(headersRequest.first);
     const auto& headers = headersRequest.second;
     EXPECT_FALSE(headers.cend() == headers.find("Security"));
   }
 }