Issue 4938 - fix race conditions and get rid of hacks related to DefaultFileSystem

test/FilterEngine.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 54 matching lines @@
     }
   };
 
   typedef FilterEngineTestGeneric<LazyFileSystem, AdblockPlus::DefaultLogSystem> FilterEngineTest;
   typedef FilterEngineTestGeneric<NoFilesFileSystem, LazyLogSystem> FilterEngineTestNoData;
 
   class FilterEngineWithFreshFolder : public ::testing::Test
   {
   protected:
     FileSystemPtr fileSystem;
+    std::list<SchedulerTask> fileSystemTasks;
     std::weak_ptr<JsEngine> weakJsEngine;
 
     void SetUp() override
     {
-      fileSystem = CreateDefaultFileSystem();
+      fileSystem = CreateDefaultFileSystem([this](const SchedulerTask& task)
+      {
+        fileSystemTasks.emplace_back(task);
+      });
       // 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())
+    JsEnginePtr CreateJsEngine(const AppInfo& appInfo = AppInfo())
     {
       JsEngineCreationParameters jsEngineParams;
       jsEngineParams.appInfo = appInfo;
       jsEngineParams.fileSystem = fileSystem;
       jsEngineParams.logSystem.reset(new LazyLogSystem());
       jsEngineParams.timer.reset(new NoopTimer());
       jsEngineParams.webRequest.reset(new NoopWebRequest());
-      auto jsEngine = CreateJsEngine(std::move(jsEngineParams));
+      auto jsEngine = ::CreateJsEngine(std::move(jsEngineParams));
       weakJsEngine = jsEngine;
       return jsEngine;
     }
+
+    FilterEnginePtr CreateFilterEngine(const JsEnginePtr& jsEngine,
+      const FilterEngine::CreationParameters& creationParams = FilterEngine::CreationParameters())
+    {
+      FilterEnginePtr retValue;
+      FilterEngine::CreateAsync(jsEngine, [&retValue](const FilterEnginePtr& filterEngine)
+      {
+        retValue = filterEngine;
+      }, creationParams);
+      while (!retValue && !fileSystemTasks.empty())
+      {
+        (*fileSystemTasks.begin())();
+        fileSystemTasks.pop_front();
+      }
+      return retValue;
+    }
+
     void TearDown() override
     {
       removeFileIfExists("patterns.ini");
       removeFileIfExists("prefs.json");
       fileSystem.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
+      bool hasStatRun = false;
+      bool doesFileExists;
+      fileSystem->Stat(path, [&hasStatRun, &doesFileExists](const IFileSystem::StatResult& stats, const std::string& error)
       {
-        try
-        {
-          Sync sync;
-          auto fs = fileSystem;
-          fileSystem->Stat(path,
-            [fs, &path, &sync](const IFileSystem::StatResult& stats, const std::string& error)
-            {
-              if (error.empty() && stats.exists)
-              {
-                fs->Remove(path, [&sync](const std::string& error)
-                  {
-                    sync.Set(error);
-                  });
-              }
-              else
-                sync.Set(error);
-            });
-          sync.WaitFor();
-          return sync.GetError().empty();
-        }
-        catch (...)
-        {
-          return false;
-        }
-      };
-      int i = 5;
-      while ((i-- > 0 && weakJsEngine.lock()) || !safeRemove())
-        std::this_thread::sleep_for(std::chrono::seconds(2));
+        EXPECT_TRUE(error.empty()) << error;
+        doesFileExists = stats.exists;
+        hasStatRun = true;
+      });
+      while (!hasStatRun && !fileSystemTasks.empty())
+      {
+        (*fileSystemTasks.begin())();
+        fileSystemTasks.pop_front();
+      }
+
+      if (!doesFileExists)
+        return;
+
+      bool hasRemoveRun = false;
+      fileSystem->Remove(path, [&hasRemoveRun](const std::string& error)
+      {
+        EXPECT_TRUE(error.empty()) << error;
+        hasRemoveRun = true;
+      });
+      while (!hasStatRun && !fileSystemTasks.empty())
+      {
+        (*fileSystemTasks.begin())();
+        fileSystemTasks.pop_front();
+      }
     }
   };
 
   class FilterEngineIsSubscriptionDownloadAllowedTest : public ::testing::Test
   {
   protected:
     typedef std::vector<std::pair<bool, std::string>> ConnectionTypes;
     DelayedWebRequest::SharedTasks webRequestTasks;
     DelayedTimer::SharedTasks timerTasks;
     FilterEngine::CreationParameters createParams;
@@ skipping 513 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 = AdblockPlus::FilterEngine::Create(jsEngine);
+  auto jsEngine = CreateJsEngine(appInfo);
+  auto filterEngine = CreateFilterEngine(jsEngine);
   const auto subscriptions = filterEngine->GetListedSubscriptions();
   ASSERT_EQ(2u, subscriptions.size());
   std::unique_ptr<Subscription> aaSubscription;
   std::unique_ptr<Subscription> langSubscription;
   if (subscriptions[0].IsAA())
   {
     aaSubscription.reset(new Subscription(subscriptions[0]));
     langSubscription.reset(new Subscription(subscriptions[1]));
   }
   else if (subscriptions[1].IsAA())
   {
     aaSubscription.reset(new Subscription(subscriptions[1]));
     langSubscription.reset(new Subscription(subscriptions[0]));
   }
   ASSERT_NE(nullptr, aaSubscription);
   ASSERT_NE(nullptr, langSubscription);
   EXPECT_EQ(langSubscriptionUrl, langSubscription->GetProperty("url").AsString());
   EXPECT_TRUE(filterEngine->IsAAEnabled());
 }
 
 TEST_F(FilterEngineWithFreshFolder, DisableSubscriptionsAutoSelectOnFirstRun)
 {
-  auto jsEngine = createJsEngine();
+  auto jsEngine = CreateJsEngine();
   FilterEngine::CreationParameters createParams;
   createParams.preconfiguredPrefs.emplace("first_run_subscription_auto_select", jsEngine->NewValue(false));
-  auto filterEngine = AdblockPlus::FilterEngine::Create(jsEngine, createParams);
+  auto filterEngine = CreateFilterEngine(jsEngine, createParams);
   const auto subscriptions = filterEngine->GetListedSubscriptions();
   EXPECT_EQ(0u, subscriptions.size());
   EXPECT_FALSE(filterEngine->IsAAEnabled());
 }
 
 namespace AA_ApiTest
 {
   const std::string kOtherSubscriptionUrl = "https://non-existing-subscription.txt";
   enum class AAStatus
   {
@@ skipping 316 matching lines @@
     std::string testConnection = "test connection";
     filterEngine->SetAllowedConnectionType(&testConnection);
     auto subscription = EnsureExampleSubscriptionAndForceUpdate("subB");
     EXPECT_EQ("synchronize_ok", subscription.GetProperty("downloadStatus").AsString());
     EXPECT_EQ(1u, subscription.GetProperty("filters").AsList().size());
     ASSERT_EQ(1u, capturedConnectionTypes.size());
     EXPECT_TRUE(capturedConnectionTypes[0].first);
     EXPECT_EQ(testConnection, capturedConnectionTypes[0].second);
   }
 }