Adds type information to the NetworkStateNotifier. Also allows for registration of observers.

Source/core/page/NetworkStateNotifierTest.cpp

+/*
+ * Copyright (c) 2014, Google Inc. All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met:
+ *
+ *     * Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ *     * Redistributions in binary form must reproduce the above
+ * copyright notice, this list of conditions and the following disclaimer
+ * in the documentation and/or other materials provided with the
+ * distribution.
+ *     * Neither the name of Google Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from
+ * this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#include "config.h"
+#include "core/page/NetworkStateNotifier.h"
+
+#include "core/dom/Document.h"
+#include "public/platform/Platform.h"
+#include "public/platform/WebNetworkConnection.h"
+#include "public/platform/WebThread.h"
+#include "wtf/Functional.h"
+#include <gtest/gtest.h>
+
+namespace WebCore {
+
+class StateObserver : public NetworkStateNotifier::NetworkStateObserver {
+public:
+    StateObserver()
+        : m_observedType(blink::WebNetworkConnection::None)
+        , m_callbackCount(0)
+    {
+    }
+
+    virtual void connectionTypeChange(blink::WebNetworkConnection::ConnectionType type)
+    {
+        m_observedType = type;
+        m_callbackCount += 1;
+
+        if (!m_closure.isNull())
+            m_closure();
+    }
+
+    blink::WebNetworkConnection::ConnectionType observedType() const
+    {
+        return m_observedType;
+    }
+
+    int callbackCount() const
+    {
+        return m_callbackCount;
+    }
+
+    void setNotificationCallback(const Closure& closure)
+    {
+        m_closure = closure;
+    }
+
+private:
+    Closure m_closure;
+    blink::WebNetworkConnection::ConnectionType m_observedType;
+    int m_callbackCount;
+    StateObserver* m_observerToAdd;
+};
+
+// A normal NetworkStateNotifier but it exits the run loop after its observers are notified of connection changes.
+class TestNetworkStateNotifier : public NetworkStateNotifier {
+public:
+    bool hasObservers() const
+    {
+        MutexLocker locker(m_mutex);
+        return !m_observers.isEmpty();
+    }
+
+    virtual void notifyObserversOnContext(ExecutionContext* context, blink::WebNetworkConnection::ConnectionType type) OVERRIDE
+    {
+        NetworkStateNotifier::notifyObserversOnContext(context, type);
+        blink::Platform::current()->currentThread()->exitRunLoop();

[adamk, 2014/05/21 16:06:05]

Rather than having to override this method, could you instead just post an
exitRunLoop task to your thread before you call enterRunLoop down in
NetworkStateNotifierTest::setType?

[jkarlin, 2014/05/21 16:34:01]

Good idea.  Done.

+    }
+};
+
+class NetworkStateNotifierTest : public testing::Test {
+public:
+    NetworkStateNotifierTest()
+        : m_document(Document::create())
+        , m_document2(Document::create())
+    {
+    }
+
+    ExecutionContext* executionContext()
+    {
+        return m_document.get();
+    }
+
+    ExecutionContext* executionContext2()
+    {
+        return m_document2.get();
+    }
+
+protected:
+    void setType(blink::WebNetworkConnection::ConnectionType type)
+    {
+        bool hasObservers = m_notifier.hasObservers();
+        m_notifier.setWebConnectionType(type);
+
+        if (hasObservers) {
+            // Enter run loop if tasks were posted.
+            blink::Platform::current()->currentThread()->enterRunLoop();
+        }
+    }
+
+    void addObserverOnNotification(StateObserver* observer, StateObserver* observerToAdd)
+    {
+        observer->setNotificationCallback(bind(&NetworkStateNotifier::addObserver, &m_notifier, observerToAdd, executionContext()));
+    }
+
+    void removeObserverOnNotification(StateObserver* observer, StateObserver* observerToRemove)
+    {
+        observer->setNotificationCallback(bind(&NetworkStateNotifier::removeObserver, &m_notifier, observerToRemove, executionContext()));
+    }
+
+    RefPtr<Document> m_document;
+    RefPtr<Document> m_document2;
+    TestNetworkStateNotifier m_notifier;
+};
+
+TEST_F(NetworkStateNotifierTest, AddObserver)
+{
+    StateObserver observer;
+    m_notifier.addObserver(&observer, executionContext());
+    EXPECT_EQ(observer.observedType(), blink::WebNetworkConnection::None);
+
+    setType(blink::WebNetworkConnection::Bluetooth);
+    EXPECT_EQ(observer.observedType(), blink::WebNetworkConnection::Bluetooth);
+    EXPECT_EQ(observer.callbackCount(), 1);
+}
+
+TEST_F(NetworkStateNotifierTest, RemoveObserver)
+{
+    StateObserver observer1, observer2;
+    m_notifier.addObserver(&observer1, executionContext());
+    m_notifier.removeObserver(&observer1, executionContext());
+    m_notifier.addObserver(&observer2, executionContext());
+
+    setType(blink::WebNetworkConnection::Bluetooth);
+    EXPECT_EQ(observer1.observedType(), blink::WebNetworkConnection::None);
+    EXPECT_EQ(observer2.observedType(), blink::WebNetworkConnection::Bluetooth);
+}
+
+TEST_F(NetworkStateNotifierTest, RemoveSoleObserver)
+{
+    StateObserver observer1, observer2;
+    m_notifier.addObserver(&observer1, executionContext());
+    m_notifier.removeObserver(&observer1, executionContext());
+
+    setType(blink::WebNetworkConnection::Bluetooth);
+    EXPECT_EQ(observer1.observedType(), blink::WebNetworkConnection::None);
+}
+
+TEST_F(NetworkStateNotifierTest, AddObserverWhileNotifying)
+{
+    StateObserver observer1, observer2;
+    m_notifier.addObserver(&observer1, executionContext());
+    addObserverOnNotification(&observer1, &observer2);
+
+    setType(blink::WebNetworkConnection::Bluetooth);
+    EXPECT_EQ(observer1.observedType(), blink::WebNetworkConnection::Bluetooth);
+    EXPECT_EQ(observer2.observedType(), blink::WebNetworkConnection::Bluetooth);
+}
+
+TEST_F(NetworkStateNotifierTest, RemoveSoleObserverWhileNotifying)
+{
+    StateObserver observer1;
+    m_notifier.addObserver(&observer1, executionContext());
+    removeObserverOnNotification(&observer1, &observer1);
+
+    setType(blink::WebNetworkConnection::Bluetooth);
+    EXPECT_EQ(observer1.observedType(), blink::WebNetworkConnection::Bluetooth);
+
+    setType(blink::WebNetworkConnection::Ethernet);
+    EXPECT_EQ(observer1.observedType(), blink::WebNetworkConnection::Bluetooth);
+}
+
+TEST_F(NetworkStateNotifierTest, RemoveCurrentObserverWhileNotifying)
+{
+    StateObserver observer1, observer2;
+    m_notifier.addObserver(&observer1, executionContext());
+    m_notifier.addObserver(&observer2, executionContext());
+    removeObserverOnNotification(&observer1, &observer1);
+
+    setType(blink::WebNetworkConnection::Bluetooth);
+    EXPECT_EQ(observer1.observedType(), blink::WebNetworkConnection::Bluetooth);
+    EXPECT_EQ(observer2.observedType(), blink::WebNetworkConnection::Bluetooth);
+
+    setType(blink::WebNetworkConnection::Ethernet);
+    EXPECT_EQ(observer1.observedType(), blink::WebNetworkConnection::Bluetooth);
+    EXPECT_EQ(observer2.observedType(), blink::WebNetworkConnection::Ethernet);
+}
+
+TEST_F(NetworkStateNotifierTest, RemovePastObserverWhileNotifying)
+{
+    StateObserver observer1, observer2;
+    m_notifier.addObserver(&observer1, executionContext());
+    m_notifier.addObserver(&observer2, executionContext());
+    removeObserverOnNotification(&observer2, &observer1);
+
+    setType(blink::WebNetworkConnection::Bluetooth);
+    EXPECT_EQ(observer1.observedType(), blink::WebNetworkConnection::Bluetooth);
+    EXPECT_EQ(observer2.observedType(), blink::WebNetworkConnection::Bluetooth);
+
+    setType(blink::WebNetworkConnection::Ethernet);
+    EXPECT_EQ(observer1.observedType(), blink::WebNetworkConnection::Bluetooth);
+    EXPECT_EQ(observer2.observedType(), blink::WebNetworkConnection::Ethernet);
+}
+
+TEST_F(NetworkStateNotifierTest, RemoveFutureObserverWhileNotifying)
+{
+    StateObserver observer1, observer2, observer3;
+    m_notifier.addObserver(&observer1, executionContext());
+    m_notifier.addObserver(&observer2, executionContext());
+    m_notifier.addObserver(&observer3, executionContext());
+    removeObserverOnNotification(&observer1, &observer2);
+
+    setType(blink::WebNetworkConnection::Bluetooth);
+
+    EXPECT_EQ(observer1.observedType(), blink::WebNetworkConnection::Bluetooth);
+    EXPECT_EQ(observer2.observedType(), blink::WebNetworkConnection::None);
+    EXPECT_EQ(observer3.observedType(), blink::WebNetworkConnection::Bluetooth);
+}
+
+TEST_F(NetworkStateNotifierTest, MultipleContextsAddObserver)
+{
+    StateObserver observer1, observer2;
+    m_notifier.addObserver(&observer1, executionContext());
+    m_notifier.addObserver(&observer2, executionContext2());
+
+    setType(blink::WebNetworkConnection::Bluetooth);
+    EXPECT_EQ(observer1.observedType(), blink::WebNetworkConnection::Bluetooth);
+    EXPECT_EQ(observer2.observedType(), blink::WebNetworkConnection::Bluetooth);
+}
+
+TEST_F(NetworkStateNotifierTest, RemoveContext)
+{
+    StateObserver observer1, observer2;
+    m_notifier.addObserver(&observer1, executionContext());
+    m_notifier.addObserver(&observer2, executionContext2());
+    m_notifier.removeObserver(&observer2, executionContext2());
+
+    setType(blink::WebNetworkConnection::Bluetooth);
+    EXPECT_EQ(observer1.observedType(), blink::WebNetworkConnection::Bluetooth);
+    EXPECT_EQ(observer2.observedType(), blink::WebNetworkConnection::None);
+}
+
+TEST_F(NetworkStateNotifierTest, RemoveAllContexts)
+{
+    StateObserver observer1, observer2;
+    m_notifier.addObserver(&observer1, executionContext());
+    m_notifier.addObserver(&observer2, executionContext2());
+    m_notifier.removeObserver(&observer1, executionContext());
+    m_notifier.removeObserver(&observer2, executionContext2());
+
+    setType(blink::WebNetworkConnection::Bluetooth);
+    EXPECT_EQ(observer1.observedType(), blink::WebNetworkConnection::None);
+    EXPECT_EQ(observer2.observedType(), blink::WebNetworkConnection::None);
+}
+
+} // namespace WebCore