Merge pull request #3363 from crowbartools/v5

5.65.0 Release

Author: zunderscore

package-lock.json

@@ -1,6 +1,6 @@
 {
     "name": "firebotv5",
-    "version": "5.65.0-beta2",
+    "version": "5.65.0",
     "description": "Powerful all-in-one bot for Twitch streamers.",
     "main": "build/main.js",
     "scripts": {

package.json

@@ -24,11 +24,11 @@ class ScriptWebhookManager extends EventEmitter {
         this.scriptName = scriptName;
         this.setMaxListeners(0);
 
-        webhookManager.on("webhook-received", ({ config, payload, headers }) => {
-            if (config.scriptId !== this.scriptName) {
+        webhookManager.on("webhook-received", (data) => {
+            if (data.config.scriptId !== this.scriptName) {
                 return;
             }
-            this.emit("webhook-received", { config, payload, headers });
+            this.emit("webhook-received", data);
         });
     }
 

src/backend/common/handlers/custom-scripts/custom-script-helpers.js

@@ -71,7 +71,7 @@ export async function playSound(soundData: {
 
     // Set output device.
     let selectedOutputDevice = soundData.audioOutputDevice;
-    if (selectedOutputDevice?.deviceId == null) {
+    if (selectedOutputDevice?.deviceId == null || selectedOutputDevice.deviceId === "") {
         selectedOutputDevice = SettingsManager.getSetting("AudioOutputDevice");
     }
     data.audioOutputDevice = selectedOutputDevice;

src/backend/common/handlers/sound-handler.ts

@@ -170,7 +170,8 @@ export const FirebotEventSource: EventSource = {
                 webhookName: "Test Webhook",
                 webhookPayload: {
                     foo: "bar"
-                }
+                },
+                webhookRawPayload: "{ \"foo\": \"bar\" }"
             }
         },
         {

src/backend/events/builtin/firebot-event-source.ts

@@ -1,9 +1,13 @@
 import { join } from "path";
 
-import type { EventGroup, EventSettings } from "../../types/events";
-import type { SortTag } from "../../types/sort-tags";
+import type {
+    EventGroup,
+    EventSettings,
+    SortTag
+} from "../../types";
 
 import { ProfileManager } from "../common/profile-manager";
+import { SettingsManager } from "../common/settings-manager";
 import frontendCommunicator from "../common/frontend-communicator";
 import logger from "../logwrapper";
 
@@ -90,6 +94,10 @@ class EventsAccess {
             this._groups[group.id] = group;
             eventsDb.push(`/groups/${group.id}`, group);
             logger.debug(`Saved event group '${group.id}'.`);
+
+            this.rebuildSettings();
+
+            frontendCommunicator.send("event-access:event-set-saved", this._groups[group.id]);
         } catch (err) {
             logger.warn(`Unable to save event group '${group.id}'.`, err);
         }
@@ -104,11 +112,51 @@ class EventsAccess {
             this._groups = groupsToSave;
             eventsDb.push("/groups", groupsToSave);
             logger.debug(`Saved all groups.`);
+
+            this.rebuildSettings();
+
+            frontendCommunicator.send("event-access:all-event-sets-saved", this._groups);
         } catch (err) {
             logger.warn(`Unable to save groups.`, err);
         }
     }
 
+    private rebuildSettings() {
+        const settings = SettingsManager.getSetting("EventSetSettings");
+
+        // Remove stale items
+        const settingsKeys = Object.keys(settings);
+        for (const set of settingsKeys) {
+            if (!this._groups[set]) {
+                delete settings[set];
+            }
+        }
+
+        // Renumber
+        const totalSettings = Object.keys(settings).length;
+        const sortedSettings = Object.keys(settings)
+            .map(key => ({
+                id: key,
+                position: settings[key].position
+            }))
+            .sort((a, b) => a.position - b.position);
+        for (let i = 0; i < totalSettings; i++) {
+            settings[sortedSettings[i].id].position = i;
+        }
+
+        // Add missing items
+        for (const item of Object.values(this._groups)) {
+            if (!settings[item.id]) {
+                settings[item.id] = {
+                    position: Object.keys(settings).length
+                };
+            }
+        }
+
+        SettingsManager.saveSetting("EventSetSettings", settings);
+        frontendCommunicator.send("event-access:event-set-settings-updated", settings);
+    }
+
     removeEventFromGroups(eventId: string): void {
         for (const group in this._groups) {
             if (this._groups.hasOwnProperty(group)) {
@@ -162,6 +210,8 @@ class EventsAccess {
                 this._sortTags = eventsData.sortTags;
             }
 
+            this.rebuildSettings();
+
             logger.debug(`Loaded event data.`);
         } catch (err) {
             logger.warn(`There was an error reading events data file.`, err);
@@ -177,6 +227,10 @@ class EventsAccess {
             eventsDb.delete(`/groups/${groupId}`);
             delete this._groups[groupId];
             logger.debug(`Deleted event group '${groupId}'.`);
+
+            this.rebuildSettings();
+
+            frontendCommunicator.send("event-access:event-set-deleted", groupId);
         } catch (err) {
             logger.warn(`Unable to delete event group '${groupId}'.`, err);
         }

src/backend/events/events-access.ts

@@ -2,6 +2,8 @@ import { createLogger, format, transports } from "winston";
 import "winston-daily-rotate-file";
 import Transport from "winston-transport";
 import { TransformableInfo } from "logform";
+import { app } from "electron";
+import os from "os";
 import fs from "fs";
 import { getPathInUserData, getJsonDbInUserData } from "./common/data-access";
 import frontendCommunicator from "./common/frontend-communicator";
@@ -65,6 +67,16 @@ function getLogFormat(addMetadataToMessage = true) {
     );
 }
 
+const rotatingFileTransport = new transports.DailyRotateFile({
+    format: getLogFormat(),
+    level: fileLogLevel,
+    dirname: LOG_FOLDER,
+    filename: "%DATE%.log",
+    datePattern: "YYYY-MM-DD",
+    maxFiles: "7d",
+    utc: true
+});
+
 const logger = createLogger({
     level: "silly",
     exitOnError: false,
@@ -83,18 +95,15 @@ const logger = createLogger({
             ),
             level: "silly"
         }),
-        new transports.DailyRotateFile({
-            format: getLogFormat(),
-            level: fileLogLevel,
-            dirname: LOG_FOLDER,
-            filename: "%DATE%.log",
-            datePattern: "YYYY-MM-DD",
-            maxFiles: "7d",
-            utc: true
-        })
+        rotatingFileTransport
     ]
 });
 
+rotatingFileTransport.on("rotate", () => {
+    logger.info("Log rotated");
+    logger.info(`Firebot v${app.getVersion()}; Platform: ${os.platform()} ${os.arch()}; Version: ${os.type()} ${os.release()}`);
+});
+
 process.on("uncaughtException", error => logger.error("Uncaught exception", error));
 process.on("unhandledRejection", error => logger.error("Unhandled promise rejection", error));
 

src/backend/logwrapper.ts

@@ -24,6 +24,7 @@ import webhookHeaders from './webhook-headers';
 import webhookId from './webhook-id';
 import webhookName from './webhook-name';
 import webhookPayload from './webhook-payload';
+import webhookRawPayload from './webhook-raw-payload';
 
 export default [
     arg,
@@ -51,5 +52,6 @@ export default [
     webhookHeaders,
     webhookId,
     webhookName,
-    webhookPayload
+    webhookPayload,
+    webhookRawPayload
 ];

src/backend/variables/builtin/metadata/index.ts

@@ -0,0 +1,9 @@
+import { createEventDataVariable } from "../../variable-factory";
+
+export default createEventDataVariable({
+    handle: "webhookRawPayload",
+    description: "The raw payload of the webhook",
+    events: ["firebot:webhook-received"],
+    type: "text",
+    eventMetaKey: "webhookRawPayload"
+});

src/backend/variables/builtin/metadata/webhook-raw-payload.ts

@@ -10,7 +10,12 @@ import logger from "../logwrapper";
 import { maskPII } from "../utils";
 
 type ExtraEvents = {
-    "webhook-received": (data: { config: WebhookConfig, payload: unknown, headers: Record<string, string> }) => void;
+    "webhook-received": (data: { 
+        config: WebhookConfig,
+        payload: unknown, 
+        rawPayload?: string, 
+        headers: Record<string, string> 
+    }) => void;
 };
 
 class WebhookConfigManager extends JsonDbManager<WebhookConfig, ExtraEvents> {
@@ -37,7 +42,12 @@ class WebhookConfigManager extends JsonDbManager<WebhookConfig, ExtraEvents> {
                 logger.debug("Webhook received:", maskPII(msg.data));
             }
 
-            const data = msg.data as { webhookId: string, payload: unknown, headers: Record<string, string> };
+            const data = msg.data as { 
+                webhookId: string, 
+                payload: unknown, 
+                rawPayload?: string, 
+                headers: Record<string, string> 
+            };
 
             const webhookConfig = this.getItem(data.webhookId);
             if (!webhookConfig) {
@@ -55,13 +65,15 @@ class WebhookConfigManager extends JsonDbManager<WebhookConfig, ExtraEvents> {
             this.emit("webhook-received", {
                 config: webhookConfig,
                 payload,
+                rawPayload: data.rawPayload,
                 headers: data.headers ?? {}
             });
 
             void EventManager.triggerEvent("firebot", "webhook-received", {
                 webhookId: webhookConfig.id,
                 webhookName: webhookConfig.name,
                 webhookPayload: payload,
+                webhookRawPayload: data.rawPayload,
                 webhookHeaders: data.headers ?? {}
             });