Issue 4931 - add possibility to not send data depending on connection properties

test/WebRequest.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 <sstream>
 #include "BaseJsTest.h"
 #include "../src/Thread.h"
+#include <atomic>
+#include <mutex>
+
+using namespace AdblockPlus;
 
 namespace
 {
   class MockWebRequest : public AdblockPlus::WebRequest
   {
   public:
     AdblockPlus::ServerResponse GET(const std::string& url, const AdblockPlus::HeaderList& requestHeaders) const
     {
       AdblockPlus::Sleep(50);
 
@@ skipping 36 matching lines @@
 {
   jsEngine->Evaluate("_webRequest.GET('http://example.com/', {X: 'Y'}, function(result) {foo = result;} )");
   ASSERT_TRUE(jsEngine->Evaluate("this.foo")->IsUndefined());
   AdblockPlus::Sleep(200);
   ASSERT_EQ(AdblockPlus::WebRequest::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());
 }
 
+TEST_F(MockWebRequestTest, ConnectionIsAllowedOnJsEngine)
+{
+  std::atomic<int> isConnectionAllowedCalledTimes(0);
+  jsEngine->SetIsConnectionAllowedCallback([&isConnectionAllowedCalledTimes]()->bool
+  {
+    ++isConnectionAllowedCalledTimes;
+    return true;
+  });
+  jsEngine->Evaluate("_webRequest.GET('http://example.com/', {X: 'Y'}, function(result) {foo = result;} )");
+  ASSERT_TRUE(jsEngine->Evaluate("this.foo")->IsUndefined());
+  AdblockPlus::Sleep(200);
+  EXPECT_EQ(1u, isConnectionAllowedCalledTimes);
+  EXPECT_EQ(AdblockPlus::WebRequest::NS_OK, jsEngine->Evaluate("foo.status")->AsInt());
+  EXPECT_EQ(123, jsEngine->Evaluate("foo.responseStatus")->AsInt());
+  EXPECT_EQ("http://example.com/\nX\nY", jsEngine->Evaluate("foo.responseText")->AsString());
+  EXPECT_EQ("{\"Foo\":\"Bar\"}", jsEngine->Evaluate("JSON.stringify(foo.responseHeaders)")->AsString());
+}
+
+TEST_F(MockWebRequestTest, ConnectionIsNotAllowedOnJsEngine)
+{
+  std::atomic<int> isConnectionAllowedCalledTimes(0);
+  jsEngine->SetIsConnectionAllowedCallback([&isConnectionAllowedCalledTimes]()->bool
+  {
+    ++isConnectionAllowedCalledTimes;
+    return false;
+  });
+  jsEngine->Evaluate("_webRequest.GET('http://example.com/', {X: 'Y'}, function(result) {foo = result;} )");
+  ASSERT_TRUE(jsEngine->Evaluate("this.foo")->IsUndefined());
+  AdblockPlus::Sleep(200);
+  EXPECT_EQ(1u, isConnectionAllowedCalledTimes);
+  EXPECT_EQ(AdblockPlus::WebRequest::NS_ERROR_CONNECTION_REFUSED, jsEngine->Evaluate("foo.status")->AsInt());
+  EXPECT_EQ(0, jsEngine->Evaluate("foo.responseStatus")->AsInt());
+  EXPECT_EQ("", jsEngine->Evaluate("foo.responseText")->AsString());
+  EXPECT_EQ("{}", jsEngine->Evaluate("JSON.stringify(foo.responseHeaders)")->AsString());
+}
+
+namespace
+{
+  class SyncStrings
+  {
+  public:
+    void Add(const std::string* value)
+    {
+      std::lock_guard<std::mutex> lock(mutex);
+      strings.emplace_back(!!value, value ? *value : "");
+    }
+    std::vector<std::pair<bool, std::string>> GetStrings() const
+    {
+      std::lock_guard<std::mutex> lock(mutex);
+      return strings;
+    }
+    void Clear()
+    {
+      std::lock_guard<std::mutex> lock(mutex);
+      strings.clear();
+    }
+  private:
+    mutable std::mutex mutex;
+    std::vector<std::pair<bool, std::string>> strings;
+  };
+}
+
+TEST_F(MockWebRequestTest, ConnectionIsAllowedOnFilterEngine1)
+{
+  FilterEngine::CreateParameters createParams;
+  std::string predefinedAllowedConnectionType = "non-metered";
+  createParams.preconfiguredPrefs.emplace("allowed_connection_type", jsEngine->NewValue(predefinedAllowedConnectionType));
+  auto receivedConnectionTypes = std::make_shared<SyncStrings>();
+  createParams.isConnectionAllowedCallback = [receivedConnectionTypes](const std::string* allowedConnectionType)->bool {
+    receivedConnectionTypes->Add(allowedConnectionType);
+    return true;
+  };
+  auto filterEngine = FilterEngine::Create(jsEngine, createParams);
+  jsEngine->Evaluate("_webRequest.GET('http://example.com/', {X: 'Y'}, function(result) {foo = result;} )");
+  ASSERT_TRUE(jsEngine->Evaluate("this.foo")->IsUndefined());
+  AdblockPlus::Sleep(200);
+  auto receivedConnectionTypesStrings = receivedConnectionTypes->GetStrings();
+  EXPECT_FALSE(receivedConnectionTypesStrings.empty());
+  for (const auto& connectionType : receivedConnectionTypesStrings)
+  {
+    EXPECT_TRUE(connectionType.first);
+    EXPECT_EQ(predefinedAllowedConnectionType, connectionType.second);
+  }
+  EXPECT_EQ(AdblockPlus::WebRequest::NS_OK, jsEngine->Evaluate("foo.status")->AsInt());
+  EXPECT_EQ(123, jsEngine->Evaluate("foo.responseStatus")->AsInt());
+  EXPECT_EQ("http://example.com/\nX\nY", jsEngine->Evaluate("foo.responseText")->AsString());
+  EXPECT_EQ("{\"Foo\":\"Bar\"}", jsEngine->Evaluate("JSON.stringify(foo.responseHeaders)")->AsString());
+}
+
+TEST_F(MockWebRequestTest, ConnectionIsAllowedOnFilterEngine2)
+{
+  FilterEngine::CreateParameters createParams;
+  auto receivedConnectionTypes = std::make_shared<SyncStrings>();
+  createParams.isConnectionAllowedCallback = [receivedConnectionTypes](const std::string* allowedConnectionType)->bool {
+    receivedConnectionTypes->Add(allowedConnectionType);
+    return true;
+  };
+  auto filterEngine = FilterEngine::Create(jsEngine, createParams);
+  jsEngine->Evaluate("_webRequest.GET('http://example.com/', {X: 'Y'}, function(result) {foo = result;} )");
+  ASSERT_TRUE(jsEngine->Evaluate("this.foo")->IsUndefined());
+  AdblockPlus::Sleep(200);
+  auto receivedConnectionTypesStrings = receivedConnectionTypes->GetStrings();
+  EXPECT_FALSE(receivedConnectionTypesStrings.empty());
+  for (const auto& connectionType : receivedConnectionTypesStrings)
+  {
+    EXPECT_FALSE(connectionType.first);
+  }
+  EXPECT_EQ(AdblockPlus::WebRequest::NS_OK, jsEngine->Evaluate("foo.status")->AsInt());
+  EXPECT_EQ(123, jsEngine->Evaluate("foo.responseStatus")->AsInt());
+  EXPECT_EQ("http://example.com/\nX\nY", jsEngine->Evaluate("foo.responseText")->AsString());
+  EXPECT_EQ("{\"Foo\":\"Bar\"}", jsEngine->Evaluate("JSON.stringify(foo.responseHeaders)")->AsString());
+}
+
+TEST_F(MockWebRequestTest, ConnectionIsAllowedOnFilterEngine3)
+{
+  // initially allowed connection type is not defined
+  FilterEngine::CreateParameters createParams;
+  auto receivedConnectionTypes = std::make_shared<SyncStrings>();
+  createParams.isConnectionAllowedCallback = [receivedConnectionTypes](const std::string* allowedConnectionType)->bool {
+    receivedConnectionTypes->Add(allowedConnectionType);
+    return true;
+  };
+  auto filterEngine = FilterEngine::Create(jsEngine, createParams);
+
+  jsEngine->Evaluate("_webRequest.GET('http://example.com/', {X: 'Y'}, function(result) {foo = result;} )");
+  ASSERT_TRUE(jsEngine->Evaluate("this.foo")->IsUndefined());
+  AdblockPlus::Sleep(200);
+  auto receivedConnectionTypesStrings = receivedConnectionTypes->GetStrings();
+  EXPECT_FALSE(receivedConnectionTypesStrings.empty());
+  for (const auto& connectionType : receivedConnectionTypesStrings)
+  {
+    EXPECT_FALSE(connectionType.first);
+  }
+  EXPECT_EQ(AdblockPlus::WebRequest::NS_OK, jsEngine->Evaluate("foo.status")->AsInt());
+  EXPECT_EQ(123, jsEngine->Evaluate("foo.responseStatus")->AsInt());
+  EXPECT_EQ("http://example.com/\nX\nY", jsEngine->Evaluate("foo.responseText")->AsString());
+  EXPECT_EQ("{\"Foo\":\"Bar\"}", jsEngine->Evaluate("JSON.stringify(foo.responseHeaders)")->AsString());
+
+  // set allowed connection type
+  std::string allowedConnectionType = "test-connection";
+  filterEngine->SetAllowedConnectionType(&allowedConnectionType);
+  receivedConnectionTypes->Clear();
+  jsEngine->Evaluate("_webRequest.GET('http://example.com/', {X: 'Y'}, function(result) {foo = result;} )");
+  AdblockPlus::Sleep(200);
+  receivedConnectionTypesStrings = receivedConnectionTypes->GetStrings();
+  EXPECT_FALSE(receivedConnectionTypesStrings.empty());
+  for (const auto& connectionType : receivedConnectionTypesStrings)
+  {
+    EXPECT_TRUE(connectionType.first);
+    EXPECT_EQ(allowedConnectionType, connectionType.second);
+  }
+
+  // remove allowed connection type
+  filterEngine->SetAllowedConnectionType(nullptr);
+  receivedConnectionTypes->Clear();
+  jsEngine->Evaluate("_webRequest.GET('http://example.com/', {X: 'Y'}, function(result) {foo = result;} )");
+  AdblockPlus::Sleep(200);
+  receivedConnectionTypesStrings = receivedConnectionTypes->GetStrings();
+  EXPECT_FALSE(receivedConnectionTypesStrings.empty());
+  for (const auto& connectionType : receivedConnectionTypesStrings)
+  {
+    EXPECT_FALSE(connectionType.first);
+  }
+}
+
+TEST_F(MockWebRequestTest, ConnectionIsNotAllowedOnFilterEngine)
+{
+  FilterEngine::CreateParameters createParams;
+  std::string predefinedAllowedConnectionType = "non-metered";
+  createParams.preconfiguredPrefs.emplace("allowed_connection_type", jsEngine->NewValue(predefinedAllowedConnectionType));
+  auto receivedConnectionTypes = std::make_shared<SyncStrings>();
+  createParams.isConnectionAllowedCallback = [receivedConnectionTypes](const std::string* allowedConnectionType)->bool {
+    receivedConnectionTypes->Add(allowedConnectionType);
+    return false;
+  };
+  auto filterEngine = FilterEngine::Create(jsEngine, createParams);
+  jsEngine->Evaluate("_webRequest.GET('http://example.com/', {X: 'Y'}, function(result) {foo = result;} )");
+  ASSERT_TRUE(jsEngine->Evaluate("this.foo")->IsUndefined());
+  AdblockPlus::Sleep(200);
+  auto receivedConnectionTypesStrings = receivedConnectionTypes->GetStrings();
+  EXPECT_FALSE(receivedConnectionTypesStrings.empty());
+  for (const auto& connectionType : receivedConnectionTypesStrings)
+  {
+    EXPECT_TRUE(connectionType.first);
+    EXPECT_EQ(predefinedAllowedConnectionType, connectionType.second);
+  }
+  EXPECT_EQ(AdblockPlus::WebRequest::NS_ERROR_CONNECTION_REFUSED, jsEngine->Evaluate("foo.status")->AsInt());
+  EXPECT_EQ(0, jsEngine->Evaluate("foo.responseStatus")->AsInt());
+  EXPECT_EQ("", jsEngine->Evaluate("foo.responseText")->AsString());
+  EXPECT_EQ("{}", jsEngine->Evaluate("JSON.stringify(foo.responseHeaders)")->AsString());
+}
+
 #if defined(HAVE_CURL) || defined(_WIN32)
 TEST_F(DefaultWebRequestTest, RealWebRequest)
 {
   // 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;} )");
   do
   {
     AdblockPlus::Sleep(200);
   } while (jsEngine->Evaluate("this.foo")->IsUndefined());
@@ skipping 38 matching lines @@
     AdblockPlus::Sleep(200);
   } while (jsEngine->Evaluate("this.foo")->IsUndefined());
   ASSERT_EQ(AdblockPlus::WebRequest::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)
 {
-  AdblockPlus::FilterEngine filterEngine(jsEngine);
+  auto filterEngine = AdblockPlus::FilterEngine::Create(jsEngine);
 
   jsEngine->Evaluate("\
     var result;\
     var request = new XMLHttpRequest();\
     request.open('GET', 'https://easylist-downloads.adblockplus.org/easylist.txt');\
     request.setRequestHeader('X', 'Y');\
     request.overrideMimeType('text/plain');\
     request.addEventListener('load', function() {result = request.responseText;}, false);\
     request.addEventListener('error', function() {result = 'error';}, false);\
     request.send(null);");
   do
   {
     AdblockPlus::Sleep(200);
   } while (jsEngine->Evaluate("result")->IsUndefined());
   ASSERT_EQ(AdblockPlus::WebRequest::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