feat: Add initial EventSub Helix support

.clang-tidy

@@ -40,7 +40,7 @@ CheckOptions:
   - key: readability-identifier-naming.FunctionCase
     value: camelBack
   - key: readability-identifier-naming.FunctionIgnoredRegexp
-    value: ^TEST$
+    value: ^(TEST|MOCK_METHOD)$
 
   - key: readability-identifier-naming.MemberCase
     value: camelBack

.gitmodules

@@ -41,3 +41,6 @@
 [submodule "tools/crash-handler"]
 	path = tools/crash-handler
 	url = https://github.com/Chatterino/crash-handler
+[submodule "lib/twitch-eventsub-ws"]
+	path = lib/twitch-eventsub-ws
+	url = https://github.com/Chatterino/twitch-eventsub-ws

CHANGELOG.md

@@ -101,6 +101,7 @@
 - Dev: Refactor `common/Credentials`. (#4979)
 - Dev: Refactor chat logger. (#5058)
 - Dev: Refactor Twitch PubSub client. (#5059)
+- Dev: Add EventSub Helix support. (#4962)
 - Dev: Changed lifetime of context menus. (#4924)
 - Dev: Renamed `tools` directory to `scripts`. (#5035)
 - Dev: Refactor `ChannelView`, removing a bunch of clang-tidy warnings. (#4926)

CMakeLists.txt

@@ -123,7 +123,7 @@ endif ()
 find_package(Sanitizers QUIET)
 
 # Find boost on the system
-find_package(Boost REQUIRED OPTIONAL_COMPONENTS headers)
+find_package(Boost REQUIRED OPTIONAL_COMPONENTS headers json)
 
 # Find OpenSSL on the system
 find_package(OpenSSL REQUIRED)
@@ -204,6 +204,8 @@ else()
     add_subdirectory("${CMAKE_SOURCE_DIR}/lib/settings" EXCLUDE_FROM_ALL)
 endif()
 
+add_subdirectory("${CMAKE_SOURCE_DIR}/lib/twitch-eventsub-ws" EXCLUDE_FROM_ALL)
+
 if (CHATTERINO_PLUGINS)
     set(LUA_INCLUDE_DIRS "${CMAKE_SOURCE_DIR}/lib/lua/src")
     add_subdirectory(lib/lua)

mocks/include/mocks/Helix.hpp

@@ -392,6 +392,15 @@ class Helix : public IHelix
          (FailureCallback<HelixSendShoutoutError, QString> failureCallback)),
         (override));
 
+    MOCK_METHOD(void, createEventSubSubscription,
+                (const QString &type, const QString &version,
+                 const QString &sessionID, const QJsonObject &condition,
+                 ResultCallback<HelixCreateEventSubSubscriptionResponse>
+                     successCallback,
+                 (FailureCallback<HelixCreateEventSubSubscriptionError, QString>
+                      failureCallback)),
+                (override));
+
     MOCK_METHOD(void, update, (QString clientId, QString oauthToken),
                 (override));
 

resources/licenses/howard-hinnant-date.txt

@@ -0,0 +1,30 @@
+The MIT License (MIT)
+
+Copyright (c) 2015, 2016, 2017 Howard Hinnant
+Copyright (c) 2016 Adrian Colomitchi
+Copyright (c) 2017 Florian Dang
+Copyright (c) 2017 Paul Thompson
+Copyright (c) 2018, 2019 Tomasz Kamiński
+Copyright (c) 2019 Jiangang Zhuang
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+Our apologies.  When the previous paragraph was written, lowercase had not yet
+been invented (that would involve another several millennia of evolution).
+We did not mean to shout.

src/CMakeLists.txt

@@ -372,6 +372,10 @@ set(SOURCE_FILES
 
         providers/twitch/ChannelPointReward.cpp
         providers/twitch/ChannelPointReward.hpp
+        providers/twitch/EventSub.cpp
+        providers/twitch/EventSub.hpp
+        providers/twitch/EventSubMessageBuilder.cpp
+        providers/twitch/EventSubMessageBuilder.hpp
         providers/twitch/IrcMessageHandler.cpp
         providers/twitch/IrcMessageHandler.hpp
         providers/twitch/PubSubActions.cpp
@@ -764,7 +768,9 @@ target_link_libraries(${LIBRARY_PROJECT}
         RapidJSON::RapidJSON
         LRUCache
         MagicEnum
+        twitch-eventsub-ws
         )
+
 if (CHATTERINO_PLUGINS)
     target_link_libraries(${LIBRARY_PROJECT} PUBLIC lua)
 endif()
@@ -814,6 +820,11 @@ if (BUILD_APP)
 
     target_link_libraries(${EXECUTABLE_PROJECT} PUBLIC ${LIBRARY_PROJECT})
 
+    target_link_libraries(${EXECUTABLE_PROJECT}
+        PUBLIC
+        twitch-eventsub-ws
+        )
+
     set_target_directory_hierarchy(${EXECUTABLE_PROJECT})
 
     if (WIN32)

src/common/ChannelChatters.cpp

@@ -89,7 +89,7 @@ size_t ChannelChatters::colorsSize() const
     return size;
 }
 
-const QColor ChannelChatters::getUserColor(const QString &user)
+const QColor ChannelChatters::getUserColor(const QString &user) const
 {
     const auto chatterColors = this->chatterColors_.access();
 

src/common/ChannelChatters.hpp

@@ -24,7 +24,7 @@ class ChannelChatters
     void addRecentChatter(const QString &user);
     void addJoinedUser(const QString &user);
     void addPartedUser(const QString &user);
-    const QColor getUserColor(const QString &user);
+    const QColor getUserColor(const QString &user) const;
     void setUserColor(const QString &user, const QColor &color);
     void updateOnlineChatters(const std::unordered_set<QString> &usernames);
 

src/common/QLogging.cpp

@@ -50,6 +50,8 @@ Q_LOGGING_CATEGORY(chatterinoStreamlink, "chatterino.streamlink", logThreshold);
 Q_LOGGING_CATEGORY(chatterinoTheme, "chatterino.theme", logThreshold);
 Q_LOGGING_CATEGORY(chatterinoTokenizer, "chatterino.tokenizer", logThreshold);
 Q_LOGGING_CATEGORY(chatterinoTwitch, "chatterino.twitch", logThreshold);
+Q_LOGGING_CATEGORY(chatterinoTwitchEventSub, "chatterino.twitch.eventsub",
+                   logThreshold);
 Q_LOGGING_CATEGORY(chatterinoTwitchLiveController,
                    "chatterino.twitch.livecontroller", logThreshold);
 Q_LOGGING_CATEGORY(chatterinoUpdate, "chatterino.update", logThreshold);

src/common/QLogging.hpp

@@ -38,6 +38,7 @@ Q_DECLARE_LOGGING_CATEGORY(chatterinoStreamlink);
 Q_DECLARE_LOGGING_CATEGORY(chatterinoTheme);
 Q_DECLARE_LOGGING_CATEGORY(chatterinoTokenizer);
 Q_DECLARE_LOGGING_CATEGORY(chatterinoTwitch);
+Q_DECLARE_LOGGING_CATEGORY(chatterinoTwitchEventSub);
 Q_DECLARE_LOGGING_CATEGORY(chatterinoTwitchLiveController);
 Q_DECLARE_LOGGING_CATEGORY(chatterinoUpdate);
 Q_DECLARE_LOGGING_CATEGORY(chatterinoWebsocket);

src/controllers/commands/CommandController.cpp

@@ -451,6 +451,8 @@ void CommandController::initialize(Settings &, const Paths &paths)
     this->registerCommand("/debug-force-image-unload",
                           &commands::forceImageUnload);
 
+    this->registerCommand("/debug-eventsub", &commands::debugEventSub);
+
     this->registerCommand("/shield", &commands::shieldModeOn);
     this->registerCommand("/shieldoff", &commands::shieldModeOff);
 

src/controllers/commands/builtin/chatterino/Debugging.cpp

@@ -1,12 +1,19 @@
 #include "controllers/commands/builtin/chatterino/Debugging.hpp"
 
+#include "Application.hpp"
 #include "common/Channel.hpp"
 #include "common/Env.hpp"
 #include "common/Literals.hpp"
+#include "controllers/accounts/AccountController.hpp"
 #include "controllers/commands/CommandContext.hpp"
 #include "messages/Image.hpp"
 #include "messages/MessageBuilder.hpp"
 #include "messages/MessageElement.hpp"
+#include "providers/twitch/api/Helix.hpp"
+#include "providers/twitch/EventSub.hpp"
+#include "providers/twitch/TwitchAccount.hpp"
+#include "providers/twitch/TwitchChannel.hpp"
+#include "providers/twitch/TwitchIrcServer.hpp"
 #include "singletons/Theme.hpp"
 #include "util/PostToThread.hpp"
 
@@ -134,4 +141,13 @@ QString forceImageUnload(const CommandContext &ctx)
     return "";
 }
 
+QString debugEventSub(const CommandContext &ctx)
+{
+    static EventSub eventSub;
+
+    eventSub.start();
+
+    return "";
+}
+
 }  // namespace chatterino::commands

src/controllers/commands/builtin/chatterino/Debugging.hpp

@@ -22,4 +22,6 @@ QString forceImageGarbageCollection(const CommandContext &ctx);
 
 QString forceImageUnload(const CommandContext &ctx);
 
+QString debugEventSub(const CommandContext &ctx);
+
 }  // namespace chatterino::commands