feat: Basic PubSub Manager for Live Emote Updates (#4087)

Co-authored-by: Rasmus Karlsson <rasmus.karlsson@pajlada.com>

tests/src/BasicPubSub.cpp

@@ -0,0 +1,148 @@
+#include "providers/liveupdates/BasicPubSubClient.hpp"
+#include "providers/liveupdates/BasicPubSubManager.hpp"
+
+#include <gtest/gtest.h>
+#include <QByteArray>
+#include <QJsonDocument>
+#include <QJsonObject>
+#include <QString>
+
+#include <deque>
+#include <mutex>
+#include <optional>
+
+using namespace chatterino;
+using namespace std::chrono_literals;
+
+struct DummySubscription {
+    int type;
+    QString condition;
+
+    bool operator==(const DummySubscription &rhs) const
+    {
+        return std::tie(this->condition, this->type) ==
+               std::tie(rhs.condition, rhs.type);
+    }
+    bool operator!=(const DummySubscription &rhs) const
+    {
+        return !(rhs == *this);
+    }
+
+    QByteArray encodeSubscribe() const
+    {
+        QJsonObject root;
+        root["op"] = "sub";
+        root["type"] = this->type;
+        root["condition"] = this->condition;
+        return QJsonDocument(root).toJson();
+    }
+    QByteArray encodeUnsubscribe() const
+    {
+        QJsonObject root;
+        root["op"] = "unsub";
+        root["type"] = this->type;
+        root["condition"] = this->condition;
+        return QJsonDocument(root).toJson();
+    }
+
+    friend QDebug &operator<<(QDebug &dbg,
+                              const DummySubscription &subscription)
+    {
+        dbg << "DummySubscription{ condition:" << subscription.condition
+            << "type:" << (int)subscription.type << '}';
+        return dbg;
+    }
+};
+
+namespace std {
+template <>
+struct hash<DummySubscription> {
+    size_t operator()(const DummySubscription &sub) const
+    {
+        return (size_t)qHash(sub.condition, qHash(sub.type));
+    }
+};
+}  // namespace std
+
+class MyManager : public BasicPubSubManager<DummySubscription>
+{
+public:
+    MyManager(QString host)
+        : BasicPubSubManager(std::move(host))
+    {
+    }
+
+    std::atomic<int32_t> messagesReceived{0};
+
+    std::optional<QString> popMessage()
+    {
+        std::lock_guard<std::mutex> guard(this->messageMtx_);
+        if (this->messageQueue_.empty())
+        {
+            return std::nullopt;
+        }
+        QString front = this->messageQueue_.front();
+        this->messageQueue_.pop_front();
+        return front;
+    }
+
+    void sub(const DummySubscription &sub)
+    {
+        // We don't track subscriptions in this test
+        this->subscribe(sub);
+    }
+
+    void unsub(const DummySubscription &sub)
+    {
+        this->unsubscribe(sub);
+    }
+
+protected:
+    void onMessage(
+        websocketpp::connection_hdl /*hdl*/,
+        BasicPubSubManager<DummySubscription>::WebsocketMessagePtr msg) override
+    {
+        std::lock_guard<std::mutex> guard(this->messageMtx_);
+        this->messagesReceived.fetch_add(1, std::memory_order_acq_rel);
+        this->messageQueue_.emplace_back(
+            QString::fromStdString(msg->get_payload()));
+    }
+
+private:
+    std::mutex messageMtx_;
+    std::deque<QString> messageQueue_;
+};
+
+TEST(BasicPubSub, SubscriptionCycle)
+{
+    const QString host("wss://127.0.0.1:9050/liveupdates/sub-unsub");
+    auto *manager = new MyManager(host);
+    manager->start();
+
+    std::this_thread::sleep_for(50ms);
+    manager->sub({1, "foo"});
+    std::this_thread::sleep_for(500ms);
+
+    ASSERT_EQ(manager->diag.connectionsOpened, 1);
+    ASSERT_EQ(manager->diag.connectionsClosed, 0);
+    ASSERT_EQ(manager->diag.connectionsFailed, 0);
+    ASSERT_EQ(manager->messagesReceived, 1);
+
+    ASSERT_EQ(manager->popMessage(), QString("ack-sub-1-foo"));
+
+    manager->unsub({1, "foo"});
+    std::this_thread::sleep_for(50ms);
+
+    ASSERT_EQ(manager->diag.connectionsOpened, 1);
+    ASSERT_EQ(manager->diag.connectionsClosed, 0);
+    ASSERT_EQ(manager->diag.connectionsFailed, 0);
+    ASSERT_EQ(manager->messagesReceived, 2);
+    ASSERT_EQ(manager->popMessage(), QString("ack-unsub-1-foo"));
+
+    manager->stop();
+
+    ASSERT_EQ(manager->diag.connectionsOpened, 1);
+    ASSERT_EQ(manager->diag.connectionsClosed, 1);
+    ASSERT_EQ(manager->diag.connectionsFailed, 0);
+    ASSERT_EQ(manager->messagesReceived, 2);
+}