refactor: Un-singletonize Paths & Updates

CHANGELOG.md

@@ -117,6 +117,7 @@
 - Dev: Channels without any animated elements on screen will skip updates from the GIF timer. (#5042, #5043, #5045)
 - Dev: Autogenerate docs/plugin-meta.lua. (#5055)
 - Dev: Refactor `NetworkPrivate`. (#5063)
+- Dev: Refactor `Paths` & `Updates`, focusing on reducing their singletoniability. (#5093)
 - 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)

mocks/include/mocks/EmptyApplication.hpp

@@ -2,14 +2,26 @@
 
 #include "Application.hpp"
 #include "common/Args.hpp"
+#include "singletons/Paths.hpp"
+#include "singletons/Updates.hpp"
 
 namespace chatterino::mock {
 
 class EmptyApplication : public IApplication
 {
 public:
+    EmptyApplication()
+        : updates_(this->paths_)
+    {
+    }
+
     virtual ~EmptyApplication() = default;
 
+    const Paths &getPaths() override
+    {
+        return this->paths_;
+    }
+
     const Args &getArgs() override
     {
         return this->args_;
@@ -168,8 +180,15 @@ class EmptyApplication : public IApplication
         return nullptr;
     }
 
+    Updates &getUpdates() override
+    {
+        return this->updates_;
+    }
+
 private:
+    Paths paths_;
     Args args_;
+    Updates updates_;
 };
 
 }  // namespace chatterino::mock

src/Application.cpp

@@ -107,18 +107,20 @@ IApplication::IApplication()
 // It will create the instances of the major classes, and connect their signals
 // to each other
 
-Application::Application(Settings &_settings, Paths &_paths, const Args &_args)
-    : args_(_args)
+Application::Application(Settings &_settings, const Paths &paths,
+                         const Args &_args, Updates &_updates)
+    : paths_(paths)
+    , args_(_args)
     , themes(&this->emplace<Theme>())
     , fonts(&this->emplace<Fonts>())
     , emotes(&this->emplace<Emotes>())
     , accounts(&this->emplace<AccountController>())
     , hotkeys(&this->emplace<HotkeyController>())
-    , windows(&this->emplace<WindowManager>())
+    , windows(&this->emplace(new WindowManager(paths)))
     , toasts(&this->emplace<Toasts>())
     , imageUploader(&this->emplace<ImageUploader>())
     , seventvAPI(&this->emplace<SeventvAPI>())
-    , crashHandler(&this->emplace<CrashHandler>())
+    , crashHandler(&this->emplace<CrashHandler>(new CrashHandler(paths)))
 
     , commands(&this->emplace<CommandController>())
     , notifications(&this->emplace<NotificationController>())
@@ -127,14 +129,15 @@ Application::Application(Settings &_settings, Paths &_paths, const Args &_args)
     , chatterinoBadges(&this->emplace<ChatterinoBadges>())
     , ffzBadges(&this->emplace<FfzBadges>())
     , seventvBadges(&this->emplace<SeventvBadges>())
-    , userData(&this->emplace<UserDataController>())
+    , userData(&this->emplace(new UserDataController(paths)))
     , sound(&this->emplace<ISoundController>(makeSoundController(_settings)))
     , twitchLiveController(&this->emplace<TwitchLiveController>())
     , twitchPubSub(new PubSub(TWITCH_PUBSUB_URL))
     , logging(new Logging(_settings))
 #ifdef CHATTERINO_HAVE_PLUGINS
-    , plugins(&this->emplace<PluginController>())
+    , plugins(&this->emplace(new PluginController(paths)))
 #endif
+    , updates(_updates)
 {
     Application::instance = this;
 
@@ -152,7 +155,7 @@ void Application::fakeDtor()
     this->twitchPubSub.reset();
 }
 
-void Application::initialize(Settings &settings, Paths &paths)
+void Application::initialize(Settings &settings, const Paths &paths)
 {
     assert(isAppInitialized == false);
     isAppInitialized = true;
@@ -237,8 +240,8 @@ int Application::run(QApplication &qtApp)
     }
 
     getSettings()->betaUpdates.connect(
-        [] {
-            Updates::instance().checkForUpdates();
+        [this] {
+            this->updates.checkForUpdates();
         },
         false);
 
@@ -340,7 +343,7 @@ void Application::save()
     }
 }
 
-void Application::initNm(Paths &paths)
+void Application::initNm(const Paths &paths)
 {
     (void)paths;
 

src/Application.hpp

@@ -15,6 +15,7 @@ class Args;
 class TwitchIrcServer;
 class ITwitchIrcServer;
 class PubSub;
+class Updates;
 
 class CommandController;
 class AccountController;
@@ -55,6 +56,7 @@ class IApplication
 
     static IApplication *instance;
 
+    virtual const Paths &getPaths() = 0;
     virtual const Args &getArgs() = 0;
     virtual Theme *getThemes() = 0;
     virtual Fonts *getFonts() = 0;
@@ -78,10 +80,12 @@ class IApplication
     virtual ITwitchLiveController *getTwitchLiveController() = 0;
     virtual ImageUploader *getImageUploader() = 0;
     virtual SeventvAPI *getSeventvAPI() = 0;
+    virtual Updates &getUpdates() = 0;
 };
 
 class Application : public IApplication
 {
+    const Paths &paths_;
     const Args &args_;
     std::vector<std::unique_ptr<Singleton>> singletons_;
     int argc_{};
@@ -90,7 +94,8 @@ class Application : public IApplication
 public:
     static Application *instance;
 
-    Application(Settings &_settings, Paths &_paths, const Args &_args);
+    Application(Settings &_settings, const Paths &paths, const Args &_args,
+                Updates &_updates);
     ~Application() override;
 
     Application(const Application &) = delete;
@@ -104,7 +109,7 @@ class Application : public IApplication
      */
     void fakeDtor();
 
-    void initialize(Settings &settings, Paths &paths);
+    void initialize(Settings &settings, const Paths &paths);
     void load();
     void save();
 
@@ -143,6 +148,10 @@ class Application : public IApplication
     PluginController *const plugins{};
 #endif
 
+    const Paths &getPaths() override
+    {
+        return this->paths_;
+    }
     const Args &getArgs() override
     {
         return this->args_;
@@ -214,6 +223,10 @@ class Application : public IApplication
     {
         return this->seventvAPI;
     }
+    Updates &getUpdates() override
+    {
+        return this->updates;
+    }
 
     pajlada::Signals::NoArgSignal streamerModeChanged;
 
@@ -222,7 +235,7 @@ class Application : public IApplication
     void initPubSub();
     void initBttvLiveUpdates();
     void initSeventvEventAPI();
-    void initNm(Paths &paths);
+    void initNm(const Paths &paths);
 
     template <typename T,
               typename = std::enable_if_t<std::is_base_of<Singleton, T>::value>>
@@ -242,6 +255,7 @@ class Application : public IApplication
     }
 
     NativeMessagingServer nmServer{};
+    Updates &updates;
 };
 
 Application *getApp();

src/RunGui.cpp

@@ -98,9 +98,9 @@ namespace {
         installCustomPalette();
     }
 
-    void showLastCrashDialog(const Args &args)
+    void showLastCrashDialog(const Args &args, const Paths &paths)
     {
-        auto *dialog = new LastRunCrashDialog(args);
+        auto *dialog = new LastRunCrashDialog(args, paths);
         // Use exec() over open() to block the app from being loaded
         // and to be able to set the safe mode.
         dialog->exec();
@@ -223,7 +223,8 @@ namespace {
     }
 }  // namespace
 
-void runGui(QApplication &a, Paths &paths, Settings &settings, const Args &args)
+void runGui(QApplication &a, const Paths &paths, Settings &settings,
+            const Args &args, Updates &updates)
 {
     initQt();
     initResources();
@@ -232,7 +233,7 @@ void runGui(QApplication &a, Paths &paths, Settings &settings, const Args &args)
 #ifdef Q_OS_WIN
     if (args.crashRecovery)
     {
-        showLastCrashDialog(args);
+        showLastCrashDialog(args, paths);
     }
 #endif
 
@@ -269,9 +270,9 @@ void runGui(QApplication &a, Paths &paths, Settings &settings, const Args &args)
     });
 
     chatterino::NetworkManager::init();
-    chatterino::Updates::instance().checkForUpdates();
+    updates.checkForUpdates();
 
-    Application app(settings, paths, args);
+    Application app(settings, paths, args, updates);
     app.initialize(settings, paths);
     app.run(a);
     app.save();

src/RunGui.hpp

@@ -7,8 +7,9 @@ namespace chatterino {
 class Args;
 class Paths;
 class Settings;
+class Updates;
 
-void runGui(QApplication &a, Paths &paths, Settings &settings,
-            const Args &args);
+void runGui(QApplication &a, const Paths &paths, Settings &settings,
+            const Args &args, Updates &updates);
 
 }  // namespace chatterino

src/common/Args.cpp

@@ -66,7 +66,7 @@ QStringList extractCommandLine(
 
 namespace chatterino {
 
-Args::Args(const QApplication &app)
+Args::Args(const QApplication &app, const Paths &paths)
 {
     QCommandLineParser parser;
     parser.setApplicationDescription("Chatterino 2 Client for Twitch Chat");
@@ -132,7 +132,7 @@ Args::Args(const QApplication &app)
 
     if (parser.isSet(channelLayout))
     {
-        this->applyCustomChannelLayout(parser.value(channelLayout));
+        this->applyCustomChannelLayout(parser.value(channelLayout), paths);
     }
 
     this->verbose = parser.isSet(verboseOption);
@@ -175,7 +175,7 @@ QStringList Args::currentArguments() const
     return this->currentArguments_;
 }
 
-void Args::applyCustomChannelLayout(const QString &argValue)
+void Args::applyCustomChannelLayout(const QString &argValue, const Paths &paths)
 {
     WindowLayout layout;
     WindowDescriptor window;
@@ -187,10 +187,9 @@ void Args::applyCustomChannelLayout(const QString &argValue)
     window.type_ = WindowType::Main;
 
     // Load main window layout from config file so we can use the same geometry
-    const QRect configMainLayout = [] {
-        const QString windowLayoutFile =
-            combinePath(getPaths()->settingsDirectory,
-                        WindowManager::WINDOW_LAYOUT_FILENAME);
+    const QRect configMainLayout = [paths] {
+        const QString windowLayoutFile = combinePath(
+            paths.settingsDirectory, WindowManager::WINDOW_LAYOUT_FILENAME);
 
         const WindowLayout configLayout =
             WindowLayout::loadFromFile(windowLayoutFile);

src/common/Args.hpp

@@ -8,6 +8,8 @@
 
 namespace chatterino {
 
+class Paths;
+
 /// Command line arguments passed to Chatterino.
 ///
 /// All accepted arguments:
@@ -31,7 +33,7 @@ class Args
 {
 public:
     Args() = default;
-    Args(const QApplication &app);
+    Args(const QApplication &app, const Paths &paths);
 
     bool printVersion{};
 
@@ -56,7 +58,7 @@ class Args
     QStringList currentArguments() const;
 
 private:
-    void applyCustomChannelLayout(const QString &argValue);
+    void applyCustomChannelLayout(const QString &argValue, const Paths &paths);
 
     QStringList currentArguments_;
 };

src/common/Credentials.cpp

@@ -1,5 +1,6 @@
 #include "common/Credentials.hpp"
 
+#include "Application.hpp"
 #include "debug/AssertInGuiThread.hpp"
 #include "singletons/Paths.hpp"
 #include "singletons/Settings.hpp"
@@ -40,7 +41,7 @@ bool useKeyring()
 #ifdef NO_QTKEYCHAIN
     return false;
 #endif
-    if (getPaths()->isPortable())
+    if (getIApp()->getPaths().isPortable())
     {
         return false;
     }
@@ -55,7 +56,8 @@ bool useKeyring()
 // Insecure storage:
 QString insecurePath()
 {
-    return combinePath(getPaths()->settingsDirectory, "credentials.json");
+    return combinePath(getIApp()->getPaths().settingsDirectory,
+                       "credentials.json");
 }
 
 QJsonDocument loadInsecure()

src/common/Singleton.hpp

@@ -17,7 +17,7 @@ class Singleton
     Singleton(Singleton &&) = delete;
     Singleton &operator=(Singleton &&) = delete;
 
-    virtual void initialize(Settings &settings, Paths &paths)
+    virtual void initialize(Settings &settings, const Paths &paths)
     {
         (void)(settings);
         (void)(paths);

src/common/network/NetworkPrivate.cpp

@@ -1,5 +1,6 @@
 #include "common/network/NetworkPrivate.hpp"
 
+#include "Application.hpp"
 #include "common/network/NetworkManager.hpp"
 #include "common/network/NetworkResult.hpp"
 #include "common/network/NetworkTask.hpp"
@@ -57,7 +58,8 @@ void loadUncached(std::shared_ptr<NetworkData> &&data)
 
 void loadCached(std::shared_ptr<NetworkData> &&data)
 {
-    QFile cachedFile(getPaths()->cacheDirectory() + "/" + data->getHash());
+    QFile cachedFile(getIApp()->getPaths().cacheDirectory() + "/" +
+                     data->getHash());
 
     if (!cachedFile.exists() || !cachedFile.open(QIODevice::ReadOnly))
     {