Issue 4612 - enable AA on first run and make automatic adding of any subscription optional

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>
 
+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();
@@ skipping 73 matching lines @@
     }
 
   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 m_fileSystem;
+    std::weak_ptr<JsEngine> m_jsEngine;
+
+    void SetUp() override
+    {
+      m_fileSystem.reset(new DefaultFileSystem());
+      // Since there are 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())
+    {
+      auto jsEngine = JsEngine::New(appInfo);
+      m_jsEngine = jsEngine;
+      jsEngine->SetFileSystem(m_fileSystem);
+      jsEngine->SetWebRequest(AdblockPlus::WebRequestPtr(new LazyWebRequest()));
+      jsEngine->SetLogSystem(AdblockPlus::LogSystemPtr(new LazyLogSystem()));
+      return jsEngine;
+    }
+    void TearDown() override
+    {
+      removeFileIfExists("patterns.ini");
+      removeFileIfExists("prefs.json");
+      m_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.
+        int i = 100;
+        while (i-- > 0 && m_jsEngine.lock()) {
+          std::this_thread::sleep_for(std::chrono::seconds(2));
+        }
+      }
+      if (m_fileSystem->Stat(path).exists)
+        m_fileSystem->Remove(path);
+    }
+  };
 }
 
 TEST_F(FilterEngineTest, FilterCreation)
 {
   AdblockPlus::FilterPtr filter1 = filterEngine->GetFilter("foo");
   ASSERT_EQ(AdblockPlus::Filter::TYPE_BLOCKING, filter1->GetType());
   AdblockPlus::FilterPtr filter2 = filterEngine->GetFilter("@@foo");
   ASSERT_EQ(AdblockPlus::Filter::TYPE_EXCEPTION, filter2->GetType());
   AdblockPlus::FilterPtr filter3 = filterEngine->GetFilter("example.com##foo");
   ASSERT_EQ(AdblockPlus::Filter::TYPE_ELEMHIDE, filter3->GetType());
@@ skipping 416 matching lines @@
   std::weak_ptr<AdblockPlus::JsEngine> weakJsEngine;
   {
     auto jsEngine = AdblockPlus::JsEngine::New();
     jsEngine->SetFileSystem(AdblockPlus::FileSystemPtr(new LazyFileSystem()));
     jsEngine->SetWebRequest(AdblockPlus::WebRequestPtr(new LazyWebRequest()));
     jsEngine->SetLogSystem(AdblockPlus::LogSystemPtr(new LazyLogSystem()));
     auto filterEngine = FilterEnginePtr(new AdblockPlus::FilterEngine(jsEngine));
   }
   EXPECT_FALSE(weakJsEngine.lock());
 }
+
+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();
+  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, DisableAASubscriptionChoosingOnFirstRun)
+{
+  AppInfo appInfo;
+  appInfo.locale = "sk";
+  const std::string langSubscriptionUrl = "https://easylist-downloads.adblockplus.org/easylistczechslovak+easylist.txt";
+  auto jsEngine = createJsEngine(appInfo);
+  FilterEngine::Prefs preSettings;
+  preSettings["first_run_enable_acceptable_ads"] = jsEngine->NewValue(false);
+  auto filterEngine = FilterEnginePtr(new AdblockPlus::FilterEngine(jsEngine, preSettings));
+  const auto subscriptions = filterEngine->GetListedSubscriptions();
+  ASSERT_EQ(1u, subscriptions.size());
+  EXPECT_EQ(langSubscriptionUrl, subscriptions[0]->GetProperty("url")->AsString());
+}
+
+TEST_F(FilterEngineWithFreshFolder, DisableLangSubscriptionChoosingOnFirstRun)
+{
+  auto jsEngine = createJsEngine();
+  FilterEngine::Prefs preSettings;
+  preSettings["first_run_enable_current_locale_subscription"] = jsEngine->NewValue(false);
+  auto filterEngine = FilterEnginePtr(new AdblockPlus::FilterEngine(jsEngine, preSettings));
+  const auto subscriptions = filterEngine->GetListedSubscriptions();
+  ASSERT_EQ(1u, subscriptions.size());
+  const auto aaUrl = filterEngine->GetPref("subscriptions_exceptionsurl")->AsString();
+  EXPECT_EQ(aaUrl, subscriptions[0]->GetProperty("url")->AsString());
+}
+
+TEST_F(FilterEngineWithFreshFolder, DisableLangAndAASubscriptionsChoosingOnFirstRun)
+{
+  auto jsEngine = createJsEngine();
+  FilterEngine::Prefs preSettings;
+  preSettings["first_run_enable_acceptable_ads"] = jsEngine->NewValue(false);
+  preSettings["first_run_enable_current_locale_subscription"] = jsEngine->NewValue(false);
+  auto filterEngine = FilterEnginePtr(new AdblockPlus::FilterEngine(jsEngine, preSettings));
+  const auto subscriptions = filterEngine->GetListedSubscriptions();
+  EXPECT_EQ(0u, subscriptions.size());
+}