dev: Add RecentMessages benchmark

.clang-tidy

@@ -65,5 +65,11 @@ CheckOptions:
   - key: readability-identifier-naming.LocalPointerIgnoredRegexp
     value: ^L$
 
+  # Benchmarks
+  - key: readability-identifier-naming.FunctionIgnoredRegexp
+    value: ^BM_[^_]+$
+  - key: readability-identifier-naming.ClassIgnoredRegexp
+    value: ^BM_[^_]+$
+
   - key: misc-const-correctness.AnalyzeValues
     value: false

.prettierignore

@@ -1,12 +1,15 @@
 # JSON resources should not be prettified...
 resources/*.json
+benchmarks/resources/*.json
+tests/resources/*.json
 # ...themes should be prettified for readability.
 !resources/themes/*.json
 
 # Ignore submodule files
 lib/*/
 conan-pkgs/*/
 cmake/sanitizers-cmake/
+tools/crash-handler
 
 # Build folders
 *build-*/

CHANGELOG.md

@@ -112,6 +112,7 @@
 - Dev: Autogenerate docs/plugin-meta.lua. (#5055)
 - Dev: Removed duplicate scale in settings dialog. (#5069)
 - Dev: Fix `NotebookTab` emitting updates for every message. (#5068)
+- Dev: Added benchmark for parsing and building recent messages. (#5071)
 
 ## 2.4.6
 

benchmarks/CMakeLists.txt

@@ -1,13 +1,16 @@
 project(chatterino-benchmark)
 
 set(benchmark_SOURCES
-    ${CMAKE_CURRENT_LIST_DIR}/src/main.cpp
-    ${CMAKE_CURRENT_LIST_DIR}/src/Emojis.cpp
-    ${CMAKE_CURRENT_LIST_DIR}/src/Highlights.cpp
-    ${CMAKE_CURRENT_LIST_DIR}/src/FormatTime.cpp
-    ${CMAKE_CURRENT_LIST_DIR}/src/Helpers.cpp
-    ${CMAKE_CURRENT_LIST_DIR}/src/LimitedQueue.cpp
-    ${CMAKE_CURRENT_LIST_DIR}/src/LinkParser.cpp
+    src/main.cpp
+    resources/bench.qrc
+
+    src/Emojis.cpp
+    src/Highlights.cpp
+    src/FormatTime.cpp
+    src/Helpers.cpp
+    src/LimitedQueue.cpp
+    src/LinkParser.cpp
+    src/RecentMessages.cpp
     # Add your new file above this line!
     )
 
@@ -27,4 +30,5 @@ set_target_properties(${PROJECT_NAME}
     RUNTIME_OUTPUT_DIRECTORY_RELEASE "${CMAKE_BINARY_DIR}/bin"
     RUNTIME_OUTPUT_DIRECTORY_DEBUG "${CMAKE_BINARY_DIR}/bin"
     RUNTIME_OUTPUT_DIRECTORY_RELWITHDEBINFO "${CMAKE_BINARY_DIR}/bin"
+    AUTORCC ON
     )

benchmarks/resources/bench.qrc

@@ -0,0 +1,6 @@
+<RCC>
+    <qresource prefix="/bench">
+        <file>recentmessages-nymn.json</file>
+        <file>seventvemotes-nymn.json</file>
+    </qresource>
+</RCC>

benchmarks/src/Emojis.cpp

@@ -145,16 +145,13 @@ static void BM_EmojiParsing(benchmark::State &state)
 
 BENCHMARK(BM_EmojiParsing);
 
-template <class... Args>
-static void BM_EmojiParsing2(benchmark::State &state, Args &&...args)
+static void BM_EmojiParsing2(benchmark::State &state, const QString &input,
+                             int expectedNumEmojis)
 {
     Emojis emojis;
 
     emojis.load();
 
-    auto argsTuple = std::make_tuple(std::move(args)...);
-    auto input = std::get<0>(argsTuple);
-    auto expectedNumEmojis = std::get<1>(argsTuple);
     for (auto _ : state)
     {
         auto output = emojis.parse(input);

benchmarks/src/FormatTime.cpp

@@ -4,35 +4,41 @@
 
 using namespace chatterino;
 
-template <class... Args>
-void BM_TimeFormatting(benchmark::State &state, Args &&...args)
+void BM_TimeFormattingQString(benchmark::State &state, const QString &v)
 {
-    auto args_tuple = std::make_tuple(std::move(args)...);
     for (auto _ : state)
     {
-        formatTime(std::get<0>(args_tuple));
+        formatTime(v);
     }
 }
 
-BENCHMARK_CAPTURE(BM_TimeFormatting, 0, 0);
-BENCHMARK_CAPTURE(BM_TimeFormatting, qs0, "0");
-BENCHMARK_CAPTURE(BM_TimeFormatting, 1337, 1337);
-BENCHMARK_CAPTURE(BM_TimeFormatting, qs1337, "1337");
-BENCHMARK_CAPTURE(BM_TimeFormatting, 623452, 623452);
-BENCHMARK_CAPTURE(BM_TimeFormatting, qs623452, "623452");
-BENCHMARK_CAPTURE(BM_TimeFormatting, 8345, 8345);
-BENCHMARK_CAPTURE(BM_TimeFormatting, qs8345, "8345");
-BENCHMARK_CAPTURE(BM_TimeFormatting, 314034, 314034);
-BENCHMARK_CAPTURE(BM_TimeFormatting, qs314034, "314034");
-BENCHMARK_CAPTURE(BM_TimeFormatting, 27, 27);
-BENCHMARK_CAPTURE(BM_TimeFormatting, qs27, "27");
-BENCHMARK_CAPTURE(BM_TimeFormatting, 34589, 34589);
-BENCHMARK_CAPTURE(BM_TimeFormatting, qs34589, "34589");
-BENCHMARK_CAPTURE(BM_TimeFormatting, 3659, 3659);
-BENCHMARK_CAPTURE(BM_TimeFormatting, qs3659, "3659");
-BENCHMARK_CAPTURE(BM_TimeFormatting, 1045345, 1045345);
-BENCHMARK_CAPTURE(BM_TimeFormatting, qs1045345, "1045345");
-BENCHMARK_CAPTURE(BM_TimeFormatting, 86432, 86432);
-BENCHMARK_CAPTURE(BM_TimeFormatting, qs86432, "86432");
-BENCHMARK_CAPTURE(BM_TimeFormatting, qsempty, "");
-BENCHMARK_CAPTURE(BM_TimeFormatting, qsinvalid, "asd");
+void BM_TimeFormattingInt(benchmark::State &state, int v)
+{
+    for (auto _ : state)
+    {
+        formatTime(v);
+    }
+}
+
+BENCHMARK_CAPTURE(BM_TimeFormattingInt, 0, 0);
+BENCHMARK_CAPTURE(BM_TimeFormattingInt, 1045345, 1045345);
+BENCHMARK_CAPTURE(BM_TimeFormattingInt, 1337, 1337);
+BENCHMARK_CAPTURE(BM_TimeFormattingInt, 27, 27);
+BENCHMARK_CAPTURE(BM_TimeFormattingInt, 314034, 314034);
+BENCHMARK_CAPTURE(BM_TimeFormattingInt, 34589, 34589);
+BENCHMARK_CAPTURE(BM_TimeFormattingInt, 3659, 3659);
+BENCHMARK_CAPTURE(BM_TimeFormattingInt, 623452, 623452);
+BENCHMARK_CAPTURE(BM_TimeFormattingInt, 8345, 8345);
+BENCHMARK_CAPTURE(BM_TimeFormattingInt, 86432, 86432);
+BENCHMARK_CAPTURE(BM_TimeFormattingQString, qs0, "0");
+BENCHMARK_CAPTURE(BM_TimeFormattingQString, qs1045345, "1045345");
+BENCHMARK_CAPTURE(BM_TimeFormattingQString, qs1337, "1337");
+BENCHMARK_CAPTURE(BM_TimeFormattingQString, qs27, "27");
+BENCHMARK_CAPTURE(BM_TimeFormattingQString, qs314034, "314034");
+BENCHMARK_CAPTURE(BM_TimeFormattingQString, qs34589, "34589");
+BENCHMARK_CAPTURE(BM_TimeFormattingQString, qs3659, "3659");
+BENCHMARK_CAPTURE(BM_TimeFormattingQString, qs623452, "623452");
+BENCHMARK_CAPTURE(BM_TimeFormattingQString, qs8345, "8345");
+BENCHMARK_CAPTURE(BM_TimeFormattingQString, qs86432, "86432");
+BENCHMARK_CAPTURE(BM_TimeFormattingQString, qsempty, "");
+BENCHMARK_CAPTURE(BM_TimeFormattingQString, qsinvalid, "asd");

benchmarks/src/RecentMessages.cpp

@@ -0,0 +1,223 @@
+#include "common/Literals.hpp"
+#include "controllers/accounts/AccountController.hpp"
+#include "controllers/highlights/HighlightController.hpp"
+#include "messages/Emote.hpp"
+#include "mocks/EmptyApplication.hpp"
+#include "mocks/TwitchIrcServer.hpp"
+#include "mocks/UserData.hpp"
+#include "providers/bttv/BttvEmotes.hpp"
+#include "providers/chatterino/ChatterinoBadges.hpp"
+#include "providers/ffz/FfzBadges.hpp"
+#include "providers/ffz/FfzEmotes.hpp"
+#include "providers/recentmessages/Impl.hpp"
+#include "providers/seventv/SeventvBadges.hpp"
+#include "providers/seventv/SeventvEmotes.hpp"
+#include "providers/twitch/TwitchChannel.hpp"
+#include "singletons/Emotes.hpp"
+#include "singletons/Resources.hpp"
+
+#include <benchmark/benchmark.h>
+#include <QFile>
+#include <QJsonArray>
+#include <QJsonDocument>
+#include <QString>
+
+#include <optional>
+
+using namespace chatterino;
+using namespace literals;
+
+namespace {
+
+class MockApplication : mock::EmptyApplication
+{
+public:
+    IEmotes *getEmotes() override
+    {
+        return &this->emotes;
+    }
+
+    IUserDataController *getUserData() override
+    {
+        return &this->userData;
+    }
+
+    AccountController *getAccounts() override
+    {
+        return &this->accounts;
+    }
+
+    ITwitchIrcServer *getTwitch() override
+    {
+        return &this->twitch;
+    }
+
+    ChatterinoBadges *getChatterinoBadges() override
+    {
+        return &this->chatterinoBadges;
+    }
+
+    FfzBadges *getFfzBadges() override
+    {
+        return &this->ffzBadges;
+    }
+
+    SeventvBadges *getSeventvBadges() override
+    {
+        return &this->seventvBadges;
+    }
+
+    HighlightController *getHighlights() override
+    {
+        return &this->highlights;
+    }
+
+    AccountController accounts;
+    Emotes emotes;
+    mock::UserDataController userData;
+    mock::MockTwitchIrcServer twitch;
+    ChatterinoBadges chatterinoBadges;
+    FfzBadges ffzBadges;
+    SeventvBadges seventvBadges;
+    HighlightController highlights;
+};
+
+std::optional<QJsonDocument> tryReadJsonFile(const QString &path)
+{
+    QFile file(path);
+    if (!file.open(QFile::ReadOnly))
+    {
+        return std::nullopt;
+    }
+
+    QJsonParseError e;
+    auto doc = QJsonDocument::fromJson(file.readAll(), &e);
+    if (e.error != QJsonParseError::NoError)
+    {
+        return std::nullopt;
+    }
+
+    return doc;
+}
+
+QJsonDocument readJsonFile(const QString &path)
+{
+    auto opt = tryReadJsonFile(path);
+    if (!opt)
+    {
+        _exit(1);
+    }
+    return *opt;
+}
+
+class RecentMessages
+{
+public:
+    explicit RecentMessages(const QString &name_)
+        : name(name_)
+        , chan(this->name)
+    {
+        const auto seventvEmotes =
+            tryReadJsonFile(u":/bench/seventvemotes-%1.json"_s.arg(this->name));
+        const auto bttvEmotes =
+            tryReadJsonFile(u":/bench/bttvemotes-%1.json"_s.arg(this->name));
+        const auto ffzEmotes =
+            tryReadJsonFile(u":/bench/ffzemotes-%1.json"_s.arg(this->name));
+
+        if (seventvEmotes)
+        {
+            this->chan.setSeventvEmotes(
+                std::make_shared<const EmoteMap>(seventv::detail::parseEmotes(
+                    seventvEmotes->object()["emote_set"_L1]
+                        .toObject()["emotes"_L1]
+                        .toArray(),
+                    false)));
+        }
+
+        if (bttvEmotes)
+        {
+            this->chan.setBttvEmotes(std::make_shared<const EmoteMap>(
+                bttv::detail::parseChannelEmotes(bttvEmotes->object(),
+                                                 this->name)));
+        }
+
+        if (ffzEmotes)
+        {
+            this->chan.setFfzEmotes(std::make_shared<const EmoteMap>(
+                ffz::detail::parseChannelEmotes(ffzEmotes->object())));
+        }
+
+        this->messages =
+            readJsonFile(u":/bench/recentmessages-%1.json"_s.arg(this->name));
+    }
+
+    ~RecentMessages()
+    {
+        QCoreApplication::sendPostedEvents(nullptr, QEvent::DeferredDelete);
+    }
+
+    virtual void run(benchmark::State &state) = 0;
+
+protected:
+    QString name;
+    MockApplication app;
+    TwitchChannel chan;
+    QJsonDocument messages;
+};
+
+class ParseRecentMessages : public RecentMessages
+{
+public:
+    explicit ParseRecentMessages(const QString &name_)
+        : RecentMessages(name_)
+    {
+    }
+
+    void run(benchmark::State &state)
+    {
+        for (auto _ : state)
+        {
+            auto parsed = recentmessages::detail::parseRecentMessages(
+                this->messages.object());
+            benchmark::DoNotOptimize(parsed);
+        }
+    }
+};
+
+class BuildRecentMessages : public RecentMessages
+{
+public:
+    explicit BuildRecentMessages(const QString &name_)
+        : RecentMessages(name_)
+    {
+    }
+
+    void run(benchmark::State &state)
+    {
+        auto parsed = recentmessages::detail::parseRecentMessages(
+            this->messages.object());
+        for (auto _ : state)
+        {
+            auto built = recentmessages::detail::buildRecentMessages(
+                parsed, &this->chan);
+            benchmark::DoNotOptimize(built);
+        }
+    }
+};
+
+void BM_ParseRecentMessages(benchmark::State &state, const QString &name)
+{
+    ParseRecentMessages bench(name);
+    bench.run(state);
+}
+
+void BM_BuildRecentMessages(benchmark::State &state, const QString &name)
+{
+    BuildRecentMessages bench(name);
+    bench.run(state);
+}
+
+}  // namespace
+
+BENCHMARK_CAPTURE(BM_ParseRecentMessages, nymn, u"nymn"_s);
+BENCHMARK_CAPTURE(BM_BuildRecentMessages, nymn, u"nymn"_s);

benchmarks/src/main.cpp

@@ -1,3 +1,4 @@
+#include "singletons/Resources.hpp"
 #include "singletons/Settings.hpp"
 
 #include <benchmark/benchmark.h>
@@ -11,6 +12,8 @@ int main(int argc, char **argv)
 {
     QApplication app(argc, argv);
 
+    initResources();
+
     ::benchmark::Initialize(&argc, argv);
 
     // Ensure settings are initialized before any benchmarks are run