chore: refactor settings access (#2936)

* settings refactor wip * refactor backend settings * refactor frontend settings
crowbartools · Dec 21, 2024 · cee52a6 · cee52a6
1 parent 9c1d50b
commit cee52a6
Show file tree

Hide file tree

Showing 81 changed files with 1,015 additions and 1,689 deletions.
diff --git a/src/backend/app-management/electron/events/when-ready.js b/src/backend/app-management/electron/events/when-ready.js
@@ -176,8 +176,8 @@ exports.whenReady = async () => {
     builtinGameLoader.loadGames();
 
     windowManagement.updateSplashScreenStatus("Loading custom variables...");
-    const {settings} = require("../../../common/settings-access");
-    if (settings.getPersistCustomVariables()) {
+    const { SettingsManager } = require("../../../common/settings-manager");
+    if (SettingsManager.getSetting("PersistCustomVariables")) {
         const customVariableManager = require("../../../common/custom-variable-manager");
         customVariableManager.loadVariablesFromFile();
     }

diff --git a/src/backend/app-management/electron/events/windows-all-closed.js b/src/backend/app-management/electron/events/windows-all-closed.js
@@ -7,7 +7,7 @@ exports.windowsAllClosed = async () => {
     const logger = require("../../../logwrapper");
     logger.debug("All windows closed triggered");
 
-    const { settings } = require("../../../common/settings-access");
+    const { SettingsManager } = require("../../../common/settings-manager");
     const backupManager = require("../../../backup-manager");
 
     // Stop all scheduled tasks
@@ -27,7 +27,7 @@ exports.windowsAllClosed = async () => {
     chatModerationManager.stopService();
 
     // Persist custom variables
-    if (settings.getPersistCustomVariables()) {
+    if (SettingsManager.getSetting("PersistCustomVariables")) {
         const customVariableManager = require("../../../common/custom-variable-manager");
         customVariableManager.persistVariablesToFile();
     }
@@ -36,7 +36,7 @@ exports.windowsAllClosed = async () => {
     const viewerOnlineStatusManager = require("../../../viewers/viewer-online-status-manager");
     await viewerOnlineStatusManager.setAllViewersOffline();
 
-    if (settings.backupOnExit()) {
+    if (SettingsManager.getSetting("BackupOnExit")) {
         // Make a backup
         await backupManager.startBackup(false, app.quit);
     } else {

diff --git a/src/backend/app-management/electron/tray-creation.js b/src/backend/app-management/electron/tray-creation.js
@@ -6,7 +6,7 @@ const electron = require("electron");
 const { Menu, Tray, app, nativeImage } = electron;
 
 const frontendCommunicator = require('../../common/frontend-communicator.js');
-const { settings } = require("../../common/settings-access");
+const { SettingsManager } = require("../../common/settings-manager");
 
 let mainTray;
 let minimizedToTray = false;
@@ -62,7 +62,7 @@ module.exports = function createTray(mainWindow) {
     });
 
     mainWindow.on('minimize', () => {
-        if (settings.getMinimizeToTray() && minimizedToTray !== true) {
+        if (SettingsManager.getSetting("MinimizeToTray") && minimizedToTray !== true) {
             mainWindow.hide();
             minimizedToTray = true;
         }

diff --git a/src/backend/app-management/electron/window-management.js b/src/backend/app-management/electron/window-management.js
@@ -11,7 +11,7 @@ const logger = require("../../logwrapper");
 const { setupTitlebar, attachTitlebarToWindow } = require("custom-electron-titlebar/main");
 const screenHelpers = require("./screen-helpers");
 const frontendCommunicator = require("../../common/frontend-communicator");
-const { settings } = require("../../common/settings-access");
+const { SettingsManager } = require("../../common/settings-manager");
 
 const argv = require('../../common/argv-parser');
 
@@ -473,7 +473,7 @@ async function createMainWindow() {
             username: "Firebot"
         });
 
-        if (settings.getOpenStreamPreviewOnLaunch() === true) {
+        if (SettingsManager.getSetting("OpenStreamPreviewOnLaunch") === true) {
             createStreamPreviewWindow();
         }
 
@@ -483,7 +483,7 @@ async function createMainWindow() {
 
     mainWindow.on("close", (event) => {
         const connectionManager = require("../../common/connection-manager");
-        if (!settings.hasJustUpdated() && connectionManager.chatIsConnected() && connectionManager.streamerIsOnline()) {
+        if (!SettingsManager.getSetting("JustUpdated") && connectionManager.chatIsConnected() && connectionManager.streamerIsOnline()) {
             event.preventDefault();
             dialog.showMessageBox(mainWindow, {
                 message: "Are you sure you want to close Firebot while connected to Twitch?",

diff --git a/src/backend/auth/auth-manager.ts b/src/backend/auth/auth-manager.ts
@@ -2,20 +2,20 @@ import { EventEmitter } from "events";
 import ClientOAuth2 from "client-oauth2";
 import logger from "../logwrapper";
 import { AuthProvider, AuthProviderDefinition } from "./auth";
-import { settings } from "../common/settings-access";
+import { SettingsManager } from "../common/settings-manager";
 import frontendCommunicator from "../common/frontend-communicator";
 import { Notification, app } from "electron";
 import windowManagement from "../app-management/electron/window-management";
 
 class AuthManager extends EventEmitter {
-    private readonly _httpPort: string;
+    private readonly _httpPort: number;
     private _authProviders: AuthProvider[];
 
     constructor() {
         super();
 
         this._authProviders = [];
-        this._httpPort = settings.getWebServerPort();
+        this._httpPort = SettingsManager.getSetting("WebServerPort");
     }
 
     registerAuthProvider(provider: AuthProviderDefinition): void {

diff --git a/src/backend/backup-manager.ts b/src/backend/backup-manager.ts
@@ -6,7 +6,7 @@ import { glob } from "glob";
 import { DeflateOptions, Zip, ZipDeflate, unzipSync } from "fflate";
 import logger from "./logwrapper";
 import utils from "./utility";
-import { settings } from "./common/settings-access";
+import { SettingsManager } from "./common/settings-manager";
 import dataAccess from "./common/data-access.js";
 import frontendCommunicator from "./common/frontend-communicator";
 
@@ -31,7 +31,7 @@ class BackupManager {
     }
 
     private async cleanUpOldBackups(callback: () => void) {
-        const maxBackups = settings.maxBackupCount();
+        const maxBackups = SettingsManager.getSetting("MaxBackupCount");
 
         if (maxBackups !== "All") {
             const fileNames = (await fsp.readdir(this._backupFolderPath))
@@ -78,7 +78,7 @@ class BackupManager {
 
         // listen for all archive data to be written
         output.on("close", async () => {
-            settings.setLastBackupDate(new Date());
+            SettingsManager.saveSetting("LastBackupDate", new Date());
             await this.cleanUpOldBackups(callback);
         });
 
@@ -107,7 +107,7 @@ class BackupManager {
         //archive.directory(folderPath, "profiles");
 
         const varIgnoreInArchive = ['backups/**', 'clips/**', 'logs/**', 'overlay.html'];
-        const ignoreResources = settings.backupIgnoreResources();
+        const ignoreResources = SettingsManager.getSetting("BackupIgnoreResources");
 
         if (ignoreResources && !manualActivation) {
             logger.info("Ignoring overlay-resources folder");
@@ -147,8 +147,8 @@ class BackupManager {
     }
 
     async onceADayBackUpCheck() {
-        const shouldBackUp = settings.backupOnceADay(),
-            lastBackupDate = settings.lastBackupDate(),
+        const shouldBackUp = SettingsManager.getSetting("BackupOnceADay"),
+            lastBackupDate = SettingsManager.getSetting("LastBackupDate"),
             todayDate = new Date();
 
         if (shouldBackUp) {

diff --git a/src/backend/chat/chat-listeners/active-user-handler.js b/src/backend/chat/chat-listeners/active-user-handler.js
@@ -1,7 +1,7 @@
 "use strict";
 
 const chatHelpers = require("../chat-helpers");
-const { settings } = require("../../common/settings-access");
+const { SettingsManager } = require("../../common/settings-manager");
 const frontendCommunicator = require("../../common/frontend-communicator");
 const utils = require("../../utility");
 const chatRolesManager = require("../../roles/chat-roles-manager");
@@ -235,7 +235,7 @@ exports.addActiveUser = async (chatUser, includeInOnline = false, forceActive =
 
     const viewerDatabase = require("../../viewers/viewer-database");
 
-    const ttl = settings.getActiveChatUserListTimeout() * 60;
+    const ttl = SettingsManager.getSetting("ActiveChatUserListTimeout") * 60;
 
     let user = await viewerDatabase.getViewerById(chatUser.userId);
 

diff --git a/src/backend/chat/commands/chat-command-handler.ts b/src/backend/chat/commands/chat-command-handler.ts
@@ -11,7 +11,7 @@ import commandManager from "./command-manager";
 import commandCooldownManager from "./command-cooldown-manager";
 import twitchApi from "../../twitch-api/api";
 import commandRunner from "./command-runner";
-import { settings } from "../../common/settings-access";
+import { SettingsManager } from "../../common/settings-manager";
 
 const DEFAULT_COOLDOWN_MESSAGE = "This command is still on cooldown for: {timeLeft}";
 const DEFAULT_RESTRICTION_MESSAGE = "Sorry, you cannot use this command because: {reason}";
@@ -130,7 +130,7 @@ class CommandHandler {
             }
 
             // 'inherit' or undefined = inherit app settings
-            if (command.allowTriggerBySharedChat !== true && !settings.getAllowCommandsInSharedChat()) {
+            if (command.allowTriggerBySharedChat !== true && !SettingsManager.getSetting("AllowCommandsInSharedChat")) {
                 return false;
             }
         }

diff --git a/src/backend/cloud-sync/profile-sync.js b/src/backend/cloud-sync/profile-sync.js
@@ -6,7 +6,7 @@ const logger = require("../logwrapper");
 const commandList = require("./sync-handlers/command-list");
 const quoteList = require("./sync-handlers/quotes-list");
 const frontendCommunicator = require("../common/frontend-communicator");
-const { settings } = require("../common/settings-access");
+const { SettingsManager } = require("../common/settings-manager");
 const rankManager = require("../ranks/rank-manager");
 
 async function syncProfileData(profileSyncData) {
@@ -25,7 +25,7 @@ async function syncProfileData(profileSyncData) {
         'variables': variableManager.getReplaceVariables().map(v => v.definition),
         'ranks': rankManager.getAllItems(),
         'quotes': quotes,
-        'allowQuoteCSVDownloads': settings.getAllowQuoteCSVDownloads()
+        'allowQuoteCSVDownloads': SettingsManager.getSetting("AllowQuoteCSVDownloads")
     };
 
     const binId = await cloudSync.sync(completeSyncJSON);

diff --git a/src/backend/common/common-listeners.js b/src/backend/common/common-listeners.js
@@ -11,7 +11,7 @@ exports.setupCommonListeners = () => {
     const frontendCommunicator = require("./frontend-communicator");
     const dataAccess = require("./data-access");
     const profileManager = require("./profile-manager");
-    const { settings } = require("./settings-access");
+    const { SettingsManager } = require("./settings-manager");
     const backupManager = require("../backup-manager");
     const webServer = require("../../server/http-server-manager");
 
@@ -198,7 +198,7 @@ exports.setupCommonListeners = () => {
         const GhReleases = require("electron-gh-releases");
 
         //back up first
-        if (settings.backupBeforeUpdates()) {
+        if (SettingsManager.getSetting("BackupBeforeUpdates")) {
             await backupManager.startBackup();
         }
 
@@ -221,7 +221,7 @@ exports.setupCommonListeners = () => {
             renderWindow.webContents.send("updateDownloaded");
 
             // Prepare for update install on next run
-            settings.setJustUpdated(true);
+            SettingsManager.saveSetting("JustUpdated", true);
         });
     });
 

diff --git a/src/backend/common/connection-manager.js b/src/backend/common/connection-manager.js
@@ -3,7 +3,7 @@ const { EventEmitter } = require("events");
 const util = require("../utility");
 const logger = require("../logwrapper");
 const frontendCommunicator = require("./frontend-communicator");
-const { settings } = require("./settings-access");
+const { SettingsManager } = require("./settings-manager");
 const twitchApi = require("../twitch-api/api");
 const twitchChat = require("../chat/twitch-chat");
 const twitchPubSubClient = require("../twitch-api/pubsub/pubsub-client");
@@ -224,7 +224,7 @@ manager.on("service-connection-update", (data) => {
 });
 
 frontendCommunicator.onAsync("connect-sidebar-controlled-services", async () => {
-    const serviceIds = settings.getSidebarControlledServices();
+    const serviceIds = SettingsManager.getSetting("SidebarControlledServices");
 
     await manager.updateConnectionForServices(serviceIds.map(id => ({
         id,
@@ -233,7 +233,7 @@ frontendCommunicator.onAsync("connect-sidebar-controlled-services", async () =>
 });
 
 frontendCommunicator.on("disconnect-sidebar-controlled-services", () => {
-    const serviceIds = settings.getSidebarControlledServices();
+    const serviceIds = SettingsManager.getSetting("SidebarControlledServices");
     for (const id of serviceIds) {
         manager.updateServiceConnection(id, false);
     }

diff --git a/src/backend/common/handlers/custom-scripts/custom-script-helpers.js b/src/backend/common/handlers/custom-scripts/custom-script-helpers.js
@@ -2,7 +2,7 @@
 const twitchChat = require("../../../chat/twitch-chat");
 const twitchApi = require("../../../twitch-api/api");
 const profileManager = require("../../profile-manager");
-const settings = require('../../settings-access').settings;
+const settings = require('../../settings-manager').SettingsManager;
 const path = require("path");
 const logger = require("../../../logwrapper");
 const {

diff --git a/src/backend/common/handlers/custom-scripts/custom-script-runner.js b/src/backend/common/handlers/custom-scripts/custom-script-runner.js
@@ -2,11 +2,11 @@
 const { ipcMain, shell } = require("electron");
 const { v4: uuid } = require("uuid");
 const logger = require("../../../logwrapper");
-const { settings } = require("../../settings-access");
 const utils = require("../../../utility");
 const profileManager = require("../../profile-manager");
 const { getScriptPath, buildRunRequest, mapParameters, mapV4EffectToV5 } = require("./custom-script-helpers");
 const effectRunner = require("../../effect-runner.js");
+import { SettingsManager } from "../../settings-manager";
 
 /**
  * @typedef { import('./script-types').ScriptData } ScriptData
@@ -36,7 +36,7 @@ async function executeScript(scriptData, trigger, isStartupScript = false) {
     let customScript;
     try {
         // Make sure we first remove the cached version, incase there was any changes
-        if (settings.getClearCustomScriptCache()) {
+        if (SettingsManager.getSetting("ClearCustomScriptCache")) {
             delete require.cache[require.resolve(scriptFilePath)];
         }
         customScript = require(scriptFilePath);
@@ -168,7 +168,7 @@ async function runStartUpScript(startUpScriptConfig) {
     const { scriptName } = startUpScriptConfig;
     logger.debug(`running startup script: ${scriptName}`);
 
-    if (!settings.isCustomScriptsEnabled()) {
+    if (SettingsManager.getSetting("RunCustomScripts") !== true) {
         logger.warn("Attempted to run startup script but custom scripts are disabled.");
         return;
     }
@@ -229,7 +229,7 @@ function runScript(effect, trigger) {
 
     logger.debug(`running script: ${scriptName}`);
 
-    if (!settings.isCustomScriptsEnabled()) {
+    if (SettingsManager.getSetting("RunCustomScripts")) {
         renderWindow.webContents.send(
             "error",
             "Something attempted to run a custom script but this feature is disabled!"

diff --git a/src/backend/common/handlers/mediaProcessor.js b/src/backend/common/handlers/mediaProcessor.js
@@ -1,7 +1,7 @@
 "use strict";
 
 const { ipcMain, dialog } = require("electron");
-const settings = require("../settings-access").settings;
+const { SettingsManager } = require("../settings-manager");
 const resourceTokenManager = require("../../resourceTokenManager.js");
 const util = require("../../utility");
 const logger = require("../../logwrapper");
@@ -73,7 +73,7 @@ function soundProcessor(effect) {
         selectedOutputDevice == null ||
     selectedOutputDevice.label === "App Default"
     ) {
-        selectedOutputDevice = settings.getAudioOutputDevice();
+        selectedOutputDevice = SettingsManager.getSetting("AudioOutputDevice");
     }
     data.audioOutputDevice = selectedOutputDevice;
 
@@ -82,9 +82,9 @@ function soundProcessor(effect) {
         data.resourceToken = resourceToken;
     }
 
-    if (settings.useOverlayInstances()) {
+    if (SettingsManager.getSetting("UseOverlayInstances")) {
         if (effect.overlayInstance != null) {
-            if (settings.getOverlayInstances().includes(effect.overlayInstance)) {
+            if (SettingsManager.getSetting("OverlayInstances").includes(effect.overlayInstance)) {
                 data.overlayInstance = effect.overlayInstance;
             }
         }
@@ -125,9 +125,9 @@ async function imageProcessor(effect, trigger) {
         "customCoords": effect.customCoords
     };
 
-    if (settings.useOverlayInstances()) {
+    if (SettingsManager.getSetting("UseOverlayInstances")) {
         if (effect.overlayInstance != null) {
-            if (settings.getOverlayInstances().includes(effect.overlayInstance)) {
+            if (SettingsManager.getSetting("OverlayInstances").includes(effect.overlayInstance)) {
                 data.overlayInstance = effect.overlayInstance;
             }
         }
@@ -181,9 +181,9 @@ function videoProcessor(effect) {
         "loop": effect.loop === true
     };
 
-    if (settings.useOverlayInstances()) {
+    if (SettingsManager.getSetting("UseOverlayInstances")) {
         if (effect.overlayInstance != null) {
-            if (settings.getOverlayInstances().includes(effect.overlayInstance)) {
+            if (SettingsManager.getSetting("OverlayInstances").includes(effect.overlayInstance)) {
                 data.overlayInstance = effect.overlayInstance;
             }
         }
@@ -230,10 +230,10 @@ async function showText(effect, trigger) {
         dto.position = getRandomPresetLocation();
     }
 
-    if (settings.useOverlayInstances()) {
+    if (SettingsManager.getSetting("UseOverlayInstances")) {
         if (dto.overlayInstance != null) {
             //reset overlay if it doesnt exist
-            if (!settings.getOverlayInstances().includes(dto.overlayInstance)) {
+            if (!SettingsManager.getSetting("OverlayInstances").includes(dto.overlayInstance)) {
                 dto.overlayInstance = null;
             }
         }

diff --git a/src/backend/common/screenshot-helpers.ts b/src/backend/common/screenshot-helpers.ts
@@ -5,7 +5,7 @@ import logger from "../logwrapper";
 import twitchApi from "../twitch-api/api";
 import discordEmbedBuilder from "../integrations/builtin/discord/discord-embed-builder";
 import discord from "../integrations/builtin/discord/discord-message-sender";
-import { settings } from "../common/settings-access";
+import { SettingsManager } from "../common/settings-manager";
 import mediaProcessor from "../common/handlers/mediaProcessor";
 import webServer from "../../server/http-server-manager";
 import moment from "moment";
@@ -86,9 +86,9 @@ export function sendScreenshotToOverlay(screenshotDataUrl: string, effect: Scree
     }
 
     let overlayInstance = null;
-    if (settings.useOverlayInstances()) {
+    if (SettingsManager.getSetting("UseOverlayInstances")) {
         if (effect.overlayInstance != null) {
-            if (settings.getOverlayInstances().includes(effect.overlayInstance)) {
+            if (SettingsManager.getSetting("OverlayInstances").includes(effect.overlayInstance)) {
                 overlayInstance = effect.overlayInstance;
             }
         }