Merge remote-tracking branch 'origin/master' into chatterino7

Now we're on commit de4f6a9; Changes from upstream we've pulled: - Major: Fixed constant disconnections with more than 20 channels by rate-limiting outgoing JOIN messages. (Chatterino#3112, Chatterino#3115)
SevenTV · Aug 4, 2021 · 5afdaeb · 5afdaeb · zneix · Aug 4, 2021
2 parents 10af9b3 + de4f6a9
commit 5afdaeb
Show file tree

Hide file tree

Showing 17 changed files with 177 additions and 273 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,8 +3,9 @@
 ## Unversioned
 
 - Major: Newly uploaded Twitch emotes are once again present in emote picker and can be autocompleted with Tab as well. (#2992)
+- Major: Deprecated `/(un)follow` commands and (un)following in the usercards as Twitch has removed this feature for 3rd party applications. (#3076, #3078)
 - Major: Added the ability to add nicknames for users. (#137, #2981)
-- Major: Work on rate-limiting JOINs and PARTs. (#3112)
+- Major: Fixed constant disconnections with more than 20 channels by rate-limiting outgoing JOIN messages. (#3112, #3115)
 - Minor: Added autocompletion in /whispers for Twitch emotes, Global Bttv/Ffz emotes and emojis. (#2999, #3033)
 - Minor: Received Twitch messages now use the exact same timestamp (obtained from Twitch's server) for every Chatterino user instead of assuming message timestamp on client's side. (#3021)
 - Minor: Received IRC messages use `time` message tag for timestamp if it's available. (#3021)

diff --git a/chatterino.pro b/chatterino.pro
@@ -255,6 +255,7 @@ SOURCES += \
     src/util/LayoutHelper.cpp \
     src/util/NuulsUploader.cpp \
     src/util/RapidjsonHelpers.cpp \
+    src/util/RatelimitBucket.cpp \
     src/util/SplitCommand.cpp \
     src/util/StreamerMode.cpp \
     src/util/StreamLink.cpp \
@@ -515,6 +516,7 @@ HEADERS += \
     src/util/rangealgorithm.hpp \
     src/util/RapidjsonHelpers.hpp \
     src/util/RapidJsonSerializeQString.hpp \
+    src/util/RatelimitBucket.hpp \
     src/util/RemoveScrollAreaBackground.hpp \
     src/util/SampleCheerMessages.hpp \
     src/util/SampleLinks.hpp \
@@ -589,6 +591,7 @@ HEADERS += \
     src/widgets/settingspages/IgnoresPage.hpp \
     src/widgets/settingspages/KeyboardSettingsPage.hpp \
     src/widgets/settingspages/ModerationPage.hpp \
+    src/widgets/settingspages/NicknamesPage.hpp \
     src/widgets/settingspages/NotificationPage.hpp \
     src/widgets/settingspages/SettingsPage.hpp \
     src/widgets/splits/ClosedSplits.hpp \

diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt
@@ -297,6 +297,8 @@ set(SOURCE_FILES
         util/NuulsUploader.hpp
         util/RapidjsonHelpers.cpp
         util/RapidjsonHelpers.hpp
+        util/RatelimitBucket.cpp
+        util/RatelimitBucket.hpp
         util/SplitCommand.cpp
         util/SplitCommand.hpp
         util/StreamLink.cpp

diff --git a/src/controllers/commands/CommandController.cpp b/src/controllers/commands/CommandController.cpp
@@ -373,6 +373,22 @@ void CommandController::initialize(Settings &, Paths &paths)
             return "";
         });
 
+    this->registerCommand("/follow", [](const auto &words, auto channel) {
+        channel->addMessage(makeSystemMessage(
+            "Twitch has removed the ability to follow users through "
+            "third-party applications. For more information, see "
+            "https://github.com/Chatterino/chatterino2/issues/3076"));
+        return "";
+    });
+
+    this->registerCommand("/unfollow", [](const auto &words, auto channel) {
+        channel->addMessage(makeSystemMessage(
+            "Twitch has removed the ability to unfollow users through "
+            "third-party applications. For more information, see "
+            "https://github.com/Chatterino/chatterino2/issues/3076"));
+        return "";
+    });
+
     /// Supported commands
 
     this->registerCommand(
@@ -407,90 +423,6 @@ void CommandController::initialize(Settings &, Paths &paths)
 
     this->registerCommand("/unblock", unblockLambda);
 
-    this->registerCommand("/follow", [](const auto &words, auto channel) {
-        if (words.size() < 2)
-        {
-            channel->addMessage(makeSystemMessage("Usage: /follow [user]"));
-            return "";
-        }
-
-        auto currentUser = getApp()->accounts->twitch.getCurrent();
-
-        if (currentUser->isAnon())
-        {
-            channel->addMessage(
-                makeSystemMessage("You must be logged in to follow someone!"));
-            return "";
-        }
-
-        auto target = words.at(1);
-
-        getHelix()->getUserByName(
-            target,
-            [currentUser, channel, target](const auto &targetUser) {
-                getHelix()->followUser(
-                    currentUser->getUserId(), targetUser.id,
-                    [channel, target]() {
-                        channel->addMessage(makeSystemMessage(
-                            "You successfully followed " + target));
-                    },
-                    [channel, target]() {
-                        channel->addMessage(makeSystemMessage(
-                            QString("User %1 could not be followed, an unknown "
-                                    "error occurred!")
-                                .arg(target)));
-                    });
-            },
-            [channel, target] {
-                channel->addMessage(
-                    makeSystemMessage(QString("User %1 could not be followed, "
-                                              "no user with that name found!")
-                                          .arg(target)));
-            });
-
-        return "";
-    });
-
-    this->registerCommand("/unfollow", [](const auto &words, auto channel) {
-        if (words.size() < 2)
-        {
-            channel->addMessage(makeSystemMessage("Usage: /unfollow [user]"));
-            return "";
-        }
-
-        auto currentUser = getApp()->accounts->twitch.getCurrent();
-
-        if (currentUser->isAnon())
-        {
-            channel->addMessage(makeSystemMessage(
-                "You must be logged in to unfollow someone!"));
-            return "";
-        }
-
-        auto target = words.at(1);
-
-        getHelix()->getUserByName(
-            target,
-            [currentUser, channel, target](const auto &targetUser) {
-                getHelix()->unfollowUser(
-                    currentUser->getUserId(), targetUser.id,
-                    [channel, target]() {
-                        channel->addMessage(makeSystemMessage(
-                            "You successfully unfollowed " + target));
-                    },
-                    [channel, target]() {
-                        channel->addMessage(makeSystemMessage(
-                            "An error occurred while unfollowing " + target));
-                    });
-            },
-            [channel, target] {
-                channel->addMessage(makeSystemMessage(
-                    QString("User %1 could not be followed!").arg(target)));
-            });
-
-        return "";
-    });
-
     this->registerCommand("/user", [](const auto &words, auto channel) {
         if (words.size() < 2)
         {

diff --git a/src/providers/irc/AbstractIrcServer.cpp b/src/providers/irc/AbstractIrcServer.cpp
@@ -15,6 +15,10 @@ const int RECONNECT_BASE_INTERVAL = 2000;
 // 60 falloff counter means it will try to reconnect at most every 60*2 seconds
 const int MAX_FALLOFF_COUNTER = 60;
 
+// Ratelimits for joinBucket_
+const int JOIN_RATELIMIT_BUDGET = 18;
+const int JOIN_RATELIMIT_COOLDOWN = 10500;
+
 AbstractIrcServer::AbstractIrcServer()
 {
     // Initialize the connections
@@ -23,6 +27,17 @@ AbstractIrcServer::AbstractIrcServer()
     this->writeConnection_->moveToThread(
         QCoreApplication::instance()->thread());
 
+    // Apply a leaky bucket rate limiting to JOIN messages
+    auto actuallyJoin = [&](QString message) {
+        if (!this->channels.contains(message))
+        {
+            return;
+        }
+        this->readConnection_->sendRaw("JOIN #" + message);
+    };
+    this->joinBucket_.reset(new RatelimitBucket(
+        JOIN_RATELIMIT_BUDGET, JOIN_RATELIMIT_COOLDOWN, actuallyJoin, this));
+
     QObject::connect(this->writeConnection_.get(),
                      &Communi::IrcConnection::messageReceived, this,
                      [this](auto msg) {
@@ -224,7 +239,7 @@ ChannelPtr AbstractIrcServer::getOrAddChannel(const QString &dirtyChannelName)
         {
             if (this->readConnection_->isConnected())
             {
-                this->readConnection_->sendRaw("JOIN #" + channelName);
+                this->joinBucket_->send(channelName);
             }
         }
     }
@@ -284,7 +299,7 @@ void AbstractIrcServer::onReadConnected(IrcConnection *connection)
     {
         if (auto channel = weak.lock())
         {
-            connection->sendRaw("JOIN #" + channel->getName());
+            this->joinBucket_->send(channel->getName());
         }
     }
 

diff --git a/src/providers/irc/AbstractIrcServer.hpp b/src/providers/irc/AbstractIrcServer.hpp
@@ -8,6 +8,7 @@
 
 #include "common/Common.hpp"
 #include "providers/irc/IrcConnection2.hpp"
+#include "util/RatelimitBucket.hpp"
 
 namespace chatterino {
 
@@ -88,6 +89,10 @@ class AbstractIrcServer : public QObject
     QObjectPtr<IrcConnection> writeConnection_ = nullptr;
     QObjectPtr<IrcConnection> readConnection_ = nullptr;
 
+    // Our rate limiting bucket for the Twitch join rate limits
+    // https://dev.twitch.tv/docs/irc/guide#rate-limits
+    QObjectPtr<RatelimitBucket> joinBucket_;
+
     QTimer reconnectTimer_;
     int falloffCounter_ = 1;
 

diff --git a/src/providers/twitch/TwitchAccount.cpp b/src/providers/twitch/TwitchAccount.cpp
@@ -186,23 +186,6 @@ void TwitchAccount::unblockUser(QString userId, std::function<void()> onSuccess,
         std::move(onFailure));
 }
 
-void TwitchAccount::checkFollow(const QString targetUserID,
-                                std::function<void(FollowResult)> onFinished)
-{
-    const auto onResponse = [onFinished](bool following, const auto &record) {
-        if (!following)
-        {
-            onFinished(FollowResult_NotFollowing);
-            return;
-        }
-
-        onFinished(FollowResult_Following);
-    };
-
-    getHelix()->getUserFollow(this->getUserId(), targetUserID, onResponse,
-                              [] {});
-}
-
 SharedAccessGuard<const std::set<TwitchUser>> TwitchAccount::accessBlocks()
     const
 {

diff --git a/src/providers/twitch/TwitchAccount.hpp b/src/providers/twitch/TwitchAccount.hpp
@@ -108,9 +108,6 @@ class TwitchAccount : public Account
     void unblockUser(QString userId, std::function<void()> onSuccess,
                      std::function<void()> onFailure);
 
-    void checkFollow(const QString targetUserID,
-                     std::function<void(FollowResult)> onFinished);
-
     SharedAccessGuard<const std::set<QString>> accessBlockedUserIds() const;
     SharedAccessGuard<const std::set<TwitchUser>> accessBlocks() const;
 

diff --git a/src/providers/twitch/api/Helix.cpp b/src/providers/twitch/api/Helix.cpp
@@ -142,25 +142,6 @@ void Helix::getUserFollowers(
                             std::move(failureCallback));
 }
 
-void Helix::getUserFollow(
-    QString userId, QString targetId,
-    ResultCallback<bool, HelixUsersFollowsRecord> successCallback,
-    HelixFailureCallback failureCallback)
-{
-    this->fetchUsersFollows(
-        std::move(userId), std::move(targetId),
-        [successCallback](const auto &response) {
-            if (response.data.empty())
-            {
-                successCallback(false, HelixUsersFollowsRecord());
-                return;
-            }
-
-            successCallback(true, response.data[0]);
-        },
-        std::move(failureCallback));
-}
-
 void Helix::fetchStreams(
     QStringList userIds, QStringList userLogins,
     ResultCallback<std::vector<HelixStream>> successCallback,
@@ -354,50 +335,6 @@ void Helix::getGameById(QString gameId,
         failureCallback);
 }
 
-void Helix::followUser(QString userId, QString targetId,
-                       std::function<void()> successCallback,
-                       HelixFailureCallback failureCallback)
-{
-    QUrlQuery urlQuery;
-
-    urlQuery.addQueryItem("from_id", userId);
-    urlQuery.addQueryItem("to_id", targetId);
-
-    this->makeRequest("users/follows", urlQuery)
-        .type(NetworkRequestType::Post)
-        .onSuccess([successCallback](auto /*result*/) -> Outcome {
-            successCallback();
-            return Success;
-        })
-        .onError([failureCallback](auto /*result*/) {
-            // TODO: make better xd
-            failureCallback();
-        })
-        .execute();
-}
-
-void Helix::unfollowUser(QString userId, QString targetId,
-                         std::function<void()> successCallback,
-                         HelixFailureCallback failureCallback)
-{
-    QUrlQuery urlQuery;
-
-    urlQuery.addQueryItem("from_id", userId);
-    urlQuery.addQueryItem("to_id", targetId);
-
-    this->makeRequest("users/follows", urlQuery)
-        .type(NetworkRequestType::Delete)
-        .onSuccess([successCallback](auto /*result*/) -> Outcome {
-            successCallback();
-            return Success;
-        })
-        .onError([failureCallback](auto /*result*/) {
-            // TODO: make better xd
-            failureCallback();
-        })
-        .execute();
-}
-
 void Helix::createClip(QString channelId,
                        ResultCallback<HelixClip> successCallback,
                        std::function<void(HelixClipError)> failureCallback,

diff --git a/src/providers/twitch/api/Helix.hpp b/src/providers/twitch/api/Helix.hpp
@@ -341,11 +341,6 @@ class Helix final : boost::noncopyable
         ResultCallback<HelixUsersFollowsResponse> successCallback,
         HelixFailureCallback failureCallback);
 
-    void getUserFollow(
-        QString userId, QString targetId,
-        ResultCallback<bool, HelixUsersFollowsRecord> successCallback,
-        HelixFailureCallback failureCallback);
-
     // https://dev.twitch.tv/docs/api/reference#get-streams
     void fetchStreams(QStringList userIds, QStringList userLogins,
                       ResultCallback<std::vector<HelixStream>> successCallback,
@@ -372,16 +367,6 @@ class Helix final : boost::noncopyable
     void getGameById(QString gameId, ResultCallback<HelixGame> successCallback,
                      HelixFailureCallback failureCallback);
 
-    // https://dev.twitch.tv/docs/api/reference#create-user-follows
-    void followUser(QString userId, QString targetId,
-                    std::function<void()> successCallback,
-                    HelixFailureCallback failureCallback);
-
-    // https://dev.twitch.tv/docs/api/reference#delete-user-follows
-    void unfollowUser(QString userId, QString targetlId,
-                      std::function<void()> successCallback,
-                      HelixFailureCallback failureCallback);
-
     // https://dev.twitch.tv/docs/api/reference#create-clip
     void createClip(QString channelId,
                     ResultCallback<HelixClip> successCallback,

diff --git a/src/providers/twitch/api/README.md b/src/providers/twitch/api/README.md
@@ -47,26 +47,6 @@ URL: https://dev.twitch.tv/docs/api/reference#get-streams
   - `TwitchChannel` to get live status, game, title, and viewer count of a channel
   - `NotificationController` to provide notifications for channels you might not have open in Chatterino, but are still interested in getting notifications for
 
-### Follow User
-
-URL: https://dev.twitch.tv/docs/api/reference#create-user-follows  
-Requires `user:edit:follows` scope
-
-- We implement this in `providers/twitch/api/Helix.cpp followUser`  
-  Used in:
-  - `widgets/dialogs/UserInfoPopup.cpp` to follow a user by ticking follow checkbox in usercard
-  - `controllers/commands/CommandController.cpp` in /follow command
-
-### Unfollow User
-
-URL: https://dev.twitch.tv/docs/api/reference#delete-user-follows  
-Requires `user:edit:follows` scope
-
-- We implement this in `providers/twitch/api/Helix.cpp unfollowUser`  
-  Used in:
-  - `widgets/dialogs/UserInfoPopup.cpp` to unfollow a user by unticking follow checkbox in usercard
-  - `controllers/commands/CommandController.cpp` in /unfollow command
-
 ### Create Clip
 
 URL: https://dev.twitch.tv/docs/api/reference#create-clip