Issue #3593 - Make isolate a fully internal member of the engine

test/FilterEngine.cpp

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
  * Copyright (C) 2006-2016 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 "BaseJsTest.h"
 #include <thread>
+#include "../src/JsEngineTransition.h"
 
 using namespace AdblockPlus;
 
 namespace
 {
   typedef std::shared_ptr<AdblockPlus::FilterEngine> FilterEnginePtr;
 
   class VeryLazyFileSystem : public LazyFileSystem
   {
   public:
     StatResult Stat(const std::string& path) const
     {
       return StatResult();
     }
   };
 
   template<class FileSystem, class LogSystem>
   class FilterEngineTestGeneric : public BaseJsTest
   {
 
   protected:
     FilterEnginePtr filterEngine;
     std::shared_ptr<LazyWebRequest> webRequest;
 
     void SetUp()
     {
       BaseJsTest::SetUp();
-      jsEngine->SetFileSystem(AdblockPlus::FileSystemPtr(new FileSystem));
+      jsEngine->SetFileSystem(std::make_shared<FileSystem>());
       webRequest = std::make_shared<LazyWebRequest>();
       jsEngine->SetWebRequest(webRequest);
-      jsEngine->SetLogSystem(AdblockPlus::LogSystemPtr(new LogSystem));
-      filterEngine = FilterEnginePtr(new AdblockPlus::FilterEngine(jsEngine));
+      jsEngine->SetLogSystem(std::make_shared<LogSystem>());
+      filterEngine = std::make_shared<AdblockPlus::FilterEngine>(jsEngine);
     }
 
     void TearDown()
     {
       if (webRequest)
       {
         webRequest->Cancel();
       }
       webRequest.reset();
       filterEngine.reset();
@@ skipping 25 matching lines @@
     public:
       AdblockPlus::ServerResponse response;
 
       AdblockPlus::ServerResponse GET(const std::string& url,
           const AdblockPlus::HeaderList& requestHeaders) const
       {
         return response;
       }
     };
 
-    MockWebRequest* mockWebRequest;
+    AdblockPlus::JsEnginePtr jsEngine;
+    std::shared_ptr<MockWebRequest> mockWebRequest;
     FilterEnginePtr filterEngine;
 
     void SetUp()
     {
       AdblockPlus::AppInfo appInfo;
       appInfo.name = "test";
       appInfo.version = "1.0.1";
-      AdblockPlus::JsEnginePtr jsEngine = CreateJsEngine(appInfo);
-      jsEngine->SetFileSystem(AdblockPlus::FileSystemPtr(new LazyFileSystem));
-      mockWebRequest = new MockWebRequest;
-      jsEngine->SetWebRequest(AdblockPlus::WebRequestPtr(mockWebRequest));
-      filterEngine = FilterEnginePtr(new AdblockPlus::FilterEngine(jsEngine));
+      jsEngine = CreateJsEngine(appInfo);
+      jsEngine->SetFileSystem(std::make_shared<LazyFileSystem>());
+      mockWebRequest = std::make_shared<MockWebRequest>();
+      jsEngine->SetWebRequest(mockWebRequest);
+      filterEngine = std::make_shared<FilterEngine>(jsEngine);
+    }
+
+    void TearDown()
+    {
+      filterEngine.reset();
+      mockWebRequest.reset();
+      ToInternal(jsEngine)->WaitForQuietScheduler();
+      ASSERT_EQ(1, jsEngine.use_count());
+      jsEngine.reset();
     }
   };
 
   struct MockUpdateAvailableCallback
   {
     MockUpdateAvailableCallback(int& timesCalled) : timesCalled(timesCalled) {}
 
     void operator()(const std::string&)
     {
       timesCalled++;
     }
 
   private:
     // We currently cannot store timesCalled in the functor, see:
     // https://issues.adblockplus.org/ticket/1378.
     int& timesCalled;
   };
 
   // Workaround for https://issues.adblockplus.org/ticket/1397.
   void NoOpUpdaterCallback(const std::string&) {}
 
   class FilterEngineWithFreshFolder : public ::testing::Test
   {
   protected:
     FileSystemPtr fileSystem;
-    std::weak_ptr<JsEngine> weakJsEngine;
+    std::shared_ptr<LazyWebRequest> webRequest;
+    AdblockPlus::JsEnginePtr jsEngine;
 
     void SetUp() override
     {
-      fileSystem.reset(new DefaultFileSystem());
+      fileSystem = std::make_shared<DefaultFileSystem>();
+      webRequest = std::make_shared<LazyWebRequest>();
       // Since there is neither in memory FS nor functionality to work with
       // directories use the hack: manually clean the directory.
       removeFileIfExists("patterns.ini");
       removeFileIfExists("prefs.json");
     }
-    JsEnginePtr createJsEngine(const AppInfo& appInfo = AppInfo())
+
+    void createJsEngine(const AppInfo& appInfo = AppInfo())
     {
-      auto jsEngine = JsEngine::New(appInfo);
-      weakJsEngine = jsEngine;
+      jsEngine = JsEngine::New(appInfo);
       jsEngine->SetFileSystem(fileSystem);
-      jsEngine->SetWebRequest(AdblockPlus::WebRequestPtr(new LazyWebRequest()));
-      jsEngine->SetLogSystem(AdblockPlus::LogSystemPtr(new LazyLogSystem()));
-      return jsEngine;
+      jsEngine->SetWebRequest(webRequest);
+      jsEngine->SetLogSystem(std::make_shared<LazyLogSystem>());
     }
+
     void TearDown() override
     {
+      if (webRequest)
+      {
+        webRequest->Cancel();
+      }
       removeFileIfExists("patterns.ini");
       removeFileIfExists("prefs.json");
       fileSystem.reset();
+      ToInternal(jsEngine)->WaitForQuietScheduler();
+      ASSERT_EQ(1, jsEngine.use_count());
+      jsEngine.reset();
     }
+
     void removeFileIfExists(const std::string& path)
     {
       // Hack: allow IO to finish currently running operations, in particular
       // writing into files. Otherwise we get "Permission denied".
       auto safeRemove = [this, &path]()->bool
       {
         try
         {
           if (fileSystem->Stat(path).exists)
             fileSystem->Remove(path);
           return true;
         }
         catch (...)
         {
           return false;
         }
       };
       int i = 5;
-      while ((i-- > 0 && weakJsEngine.lock()) || !safeRemove())
+      while ((i-- > 0) || !safeRemove())
         std::this_thread::sleep_for(std::chrono::seconds(2));
     }
   };
 }
 
 TEST_F(FilterEngineTest, FilterCreation)
 {
   AdblockPlus::FilterPtr filter1 = filterEngine->GetFilter("foo");
   ASSERT_EQ(AdblockPlus::Filter::TYPE_BLOCKING, filter1->GetType());
   AdblockPlus::FilterPtr filter2 = filterEngine->GetFilter("@@foo");
@@ skipping 412 matching lines @@
   ASSERT_FALSE(filterEngine->IsElemhideWhitelisted(
       "http://example.co.uk",
       documentUrls1));
 }
 
 TEST_F(FilterEngineWithFreshFolder, LangAndAASubscriptionsAreChosenOnFirstRun)
 {
   AppInfo appInfo;
   appInfo.locale = "zh";
   const std::string langSubscriptionUrl = "https://easylist-downloads.adblockplus.org/easylistchina+easylist.txt";
-  auto jsEngine = createJsEngine(appInfo);
-  auto filterEngine = FilterEnginePtr(new AdblockPlus::FilterEngine(jsEngine));
-  const auto subscriptions = filterEngine->GetListedSubscriptions();
+  createJsEngine(appInfo);
+  auto filterEngine = std::make_shared<AdblockPlus::FilterEngine>(jsEngine);
+  auto subscriptions = filterEngine->GetListedSubscriptions();
   ASSERT_EQ(2u, subscriptions.size());
   const auto aaUrl = filterEngine->GetPref("subscriptions_exceptionsurl")->AsString();
   SubscriptionPtr aaSubscription;
   SubscriptionPtr langSubscription;
   if (subscriptions[0]->GetProperty("url")->AsString() == aaUrl)
   {
     aaSubscription = subscriptions[0];
     langSubscription = subscriptions[1];
   }
   else if (subscriptions[1]->GetProperty("url")->AsString() == aaUrl)
   {
     aaSubscription = subscriptions[1];
     langSubscription = subscriptions[0];
   }
   ASSERT_NE(nullptr, aaSubscription);
   ASSERT_NE(nullptr, langSubscription);
   EXPECT_EQ(aaUrl, aaSubscription->GetProperty("url")->AsString());
   EXPECT_EQ(langSubscriptionUrl, langSubscription->GetProperty("url")->AsString());
 }
 
 TEST_F(FilterEngineWithFreshFolder, DisableSubscriptionsAutoSelectOnFirstRun)
 {
-  auto jsEngine = createJsEngine();
+  createJsEngine();
   FilterEngine::Prefs preSettings;
   preSettings["first_run_subscription_auto_select"] = jsEngine->NewValue(false);
-  auto filterEngine = FilterEnginePtr(new AdblockPlus::FilterEngine(jsEngine, preSettings));
+  auto filterEngine = std::make_shared<AdblockPlus::FilterEngine>(jsEngine, preSettings);
   const auto subscriptions = filterEngine->GetListedSubscriptions();
   EXPECT_EQ(0u, subscriptions.size());
 }