Issue 2693 - Update adblockplus dependency

test/Notification.cpp

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
  * Copyright (C) 2006-2015 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 29 matching lines @@
       filterEngine.reset(new FilterEngine(jsEngine));
     }
 
     void AddNotification(const std::string& notification)
     {
       jsEngine->Evaluate("(function()"
       "{"
         "require('notification').Notification.addNotification(" + notification + ");"
       "})();");
     }
+
+    struct PeekNotificationResult
+    {
+      bool isCallbackCalled;

[Felix Dahlke, 2015/06/25 18:35:49]

Can't we derive this by checking if the notification pointer is pointing
somewhere? Then we could return a NotificationPtr instead of
PeekNotificationResult.

[sergei, 2015/06/26 14:21:17]

Yes we can. I just wanted to be sure that it's really not called rather than we
cannot construct `AdblockPlus::Notification` object.

Fixed to use `NotificationPtr`.

+      NotificationPtr notification;
+    };
+    PeekNotificationResult PeekNotification(const std::string& url = std::string())

[Felix Dahlke, 2015/06/25 18:35:49]

Nit: "peek" sounds a bit weird to me here, why not just "show"?

We've got a very similar function in the JS tests BTW:

  function showNotifications(url)
  {
    let shownNotifications = [];
    function showListener(notification)
    {
      shownNotifications.push(notification);
      Notification.markAsShown(notification.id);
    }
    Notification.addShowListener(showListener);
    Notification.showNext(url);
    Notification.removeShowListener(showListener);
    return shownNotifications;
  }

We're working with an array of notifications instead of a single one there, to
ensure the show handler is not being called multiple times. But we don't have to
do that here as well IMO.

[sergei, 2015/06/26 14:21:17]

Because I don't mark the notification as shown, so we can say that it stays in
some internal queue, there is even a test for that case
`TEST_F(NotificationTest, MarkAsShown)`.
 
I also thought about multiple times calls but decided to check merely that it's
called with the correct notification object.

[Felix Dahlke, 2015/06/30 19:45:31]

Yeah right, makes sense then.
Yeah, surely sufficient, we don't need to repeat the core tests here.

+    {
+      PeekNotificationResult retValue = {false};
+      filterEngine->SetNotificationAvailableCallback([&retValue](const NotificationPtr& notification)

[Felix Dahlke, 2015/06/25 18:35:49]

Still C++03 here :)

[sergei, 2015/06/26 14:21:17]

Done.

+      {
+        retValue.isCallbackCalled = true;
+        retValue.notification = notification;
+      });
+      filterEngine->ShowNextNotification(url);
+      filterEngine->RemoveNotificationAvailableCallback();
+      return retValue;
+    }
   };
 
   class MockWebRequest : public WebRequest
   {
   public:
     std::string responseText;
     explicit MockWebRequest(const std::string& notification)
       : responseText(notification)
     {
     }
@@ skipping 36 matching lines @@
         new MockWebRequest(responseJsonText)));
       jsEngine->SetLogSystem(LogSystemPtr(new DefaultLogSystem()));
       filterEngine.reset(new FilterEngine(jsEngine));
     }
   };
 #endif
 }
 
 TEST_F(NotificationTest, NoNotifications)
 {
-  NotificationPtr notification = filterEngine->GetNextNotificationToShow();
-  EXPECT_EQ(NULL, notification.get());
+  EXPECT_FALSE(PeekNotification().isCallbackCalled);
 }
 
 #ifdef NotificationMockWebRequestTest_ENABLED
 TEST_F(NotificationMockWebRequestTest, SingleNotification)
 {
+  bool isNotificationCallbackCalled = false;
+  filterEngine->SetNotificationAvailableCallback([&isNotificationCallbackCalled](const NotificationPtr& notification)
+  {
+    isNotificationCallbackCalled = true;
+    ASSERT_TRUE(notification);
+    EXPECT_EQ(NotificationType::NOTIFICATION_TYPE_INFORMATION, notification->GetType());
+    EXPECT_EQ("Title", notification->GetTitle());
+    EXPECT_EQ("message", notification->GetMessageString());
+    notification->MarkAsShown();
+  });
   AdblockPlus::Sleep(5000/*msec*/); // it's a hack
-  NotificationPtr notification = filterEngine->GetNextNotificationToShow();
-  // try another one immediately to avoid queuing of the next notification by
-  // the timer.
-  EXPECT_EQ(NULL, filterEngine->GetNextNotificationToShow().get());
-  ASSERT_TRUE(notification);
-  EXPECT_EQ(NotificationType::NOTIFICATION_TYPE_INFORMATION, notification->GetType());
-  EXPECT_EQ("Title", notification->GetTitle());
-  EXPECT_EQ("message", notification->GetMessageString());
+  EXPECT_TRUE(isNotificationCallbackCalled);
 }
 #endif
 
 TEST_F(NotificationTest, AddNotification)
 {
   AddNotification("{"
       "type: 'critical',"
       "title: 'testTitle',"
       "message: 'testMessage',"
     "}");
-  NotificationPtr notification = filterEngine->GetNextNotificationToShow();
-  ASSERT_TRUE(notification);
-  EXPECT_EQ(NotificationType::NOTIFICATION_TYPE_CRITICAL, notification->GetType());
-  EXPECT_EQ("testTitle", notification->GetTitle());
-  EXPECT_EQ("testMessage", notification->GetMessageString());
+  PeekNotificationResult peekNotificationResult = PeekNotification();
+  ASSERT_TRUE(peekNotificationResult.notification);
+  EXPECT_EQ(NotificationType::NOTIFICATION_TYPE_CRITICAL, peekNotificationResult.notification->GetType());
+  EXPECT_EQ("testTitle", peekNotificationResult.notification->GetTitle());
+  EXPECT_EQ("testMessage", peekNotificationResult.notification->GetMessageString());
 }
 
 TEST_F(NotificationTest, FilterByUrl)
 {
   AddNotification("{ id: 'no-filter', type: 'critical' }");
   AddNotification("{ id: 'www.com', type: 'information',"
-    "urlFilters:['http://www.com']"
+    "urlFilters:['||www.com$document']"
   "}");
   AddNotification("{ id: 'www.de', type: 'question',"
-    "urlFilters:['http://www.de']"
+    "urlFilters:['||www.de$document']"
   "}");
 
-  NotificationPtr notification = filterEngine->GetNextNotificationToShow();
-  ASSERT_TRUE(notification);
-  EXPECT_EQ(NotificationType::NOTIFICATION_TYPE_CRITICAL, notification->GetType());
+  PeekNotificationResult peekNotificationResult = PeekNotification();
+  ASSERT_TRUE(peekNotificationResult.notification);
+  EXPECT_EQ(NotificationType::NOTIFICATION_TYPE_CRITICAL, peekNotificationResult.notification->GetType());
 
-  notification = filterEngine->GetNextNotificationToShow("http://www.de");
-  ASSERT_TRUE(notification);
-  EXPECT_EQ(NotificationType::NOTIFICATION_TYPE_QUESTION, notification->GetType());
+  peekNotificationResult = PeekNotification("http://www.de");
+  ASSERT_TRUE(peekNotificationResult.notification);
+  EXPECT_EQ(NotificationType::NOTIFICATION_TYPE_QUESTION, peekNotificationResult.notification->GetType());
 
-  notification = filterEngine->GetNextNotificationToShow("http://www.com");
-  ASSERT_TRUE(notification);
-  EXPECT_EQ(NotificationType::NOTIFICATION_TYPE_INFORMATION, notification->GetType());
+  peekNotificationResult = PeekNotification("http://www.com");
+  ASSERT_TRUE(peekNotificationResult.notification);
+  EXPECT_EQ(NotificationType::NOTIFICATION_TYPE_INFORMATION, peekNotificationResult.notification->GetType());
 }
 
 TEST_F(NotificationTest, MarkAsShown)
 {
   AddNotification("{ id: 'id', type: 'question' }");
-  NotificationPtr notification = filterEngine->GetNextNotificationToShow();
-  EXPECT_TRUE(notification);
-  notification = filterEngine->GetNextNotificationToShow();
-  ASSERT_TRUE(notification);
-  notification->MarkAsShown();
-  EXPECT_EQ(NULL, filterEngine->GetNextNotificationToShow().get());
+  EXPECT_TRUE(PeekNotification().notification);
+  PeekNotificationResult peekNotificationResult = PeekNotification();
+  ASSERT_TRUE(peekNotificationResult.notification);
+  peekNotificationResult.notification->MarkAsShown();
+  EXPECT_FALSE(PeekNotification().isCallbackCalled);
 }
 
 TEST_F(NotificationTest, NoLinks)
 {
   AddNotification("{ id: 'id'}");
-  NotificationPtr notification = filterEngine->GetNextNotificationToShow();
-  ASSERT_TRUE(notification);
-  std::vector<std::string> notificationLinks = notification->GetLinks();
-  EXPECT_EQ(0, notificationLinks.size());
+  PeekNotificationResult peekNotificationResult = PeekNotification();
+  ASSERT_TRUE(peekNotificationResult.notification);
+  EXPECT_EQ(0, peekNotificationResult.notification->GetLinks().size());
 }
 
 TEST_F(NotificationTest, Links)
 {
   AddNotification("{ id: 'id', links: ['link1', 'link2'] }");
-  NotificationPtr notification = filterEngine->GetNextNotificationToShow();
-  ASSERT_TRUE(notification);
-  std::vector<std::string> notificationLinks = notification->GetLinks();
+  PeekNotificationResult peekNotificationResult = PeekNotification();
+  ASSERT_TRUE(peekNotificationResult.notification);
+  std::vector<std::string> notificationLinks = peekNotificationResult.notification->GetLinks();
   ASSERT_EQ(2, notificationLinks.size());
   EXPECT_EQ("link1", notificationLinks[0]);
   EXPECT_EQ("link2", notificationLinks[1]);
-}
+}