Merge pull request #1159 from crowbartools/v5

V5.38.1
crowbartools · May 10, 2021 · eb5ce6f · eb5ce6f
2 parents 417bd6a + 6da19a0
commit eb5ce6f
Show file tree

Hide file tree

Showing 16 changed files with 142 additions and 64 deletions.
diff --git a/backend/chat/chat-listeners/twitch-chat-listeners.js b/backend/chat/chat-listeners/twitch-chat-listeners.js
@@ -6,6 +6,7 @@ const chatHelpers = require("../chat-helpers");
 const activeUserHandler = require("./active-user-handler");
 const accountAccess = require("../../common/account-access");
 const chatModerationManager = require("../moderation/chat-moderation-manager");
+const twitchEventsHandler = require("../../events/twitch-events");
 
 const events = require("events");
 
@@ -53,17 +54,15 @@ exports.setupChatListeners = (streamerChatClient) => {
 
         activeUserHandler.addActiveUser(msg.userInfo, true);
 
-        const viewerArrivedListener = require("../../events/twitch-events/viewer-arrived");
-        viewerArrivedListener.triggerViewerArrived(msg.userInfo.displayName);
+        twitchEventsHandler.viewerArrived.triggerViewerArrived(msg.userInfo.displayName);
 
         const { streamer, bot } = accountAccess.getAccounts();
         if (user !== streamer.username && user !== bot.username) {
             const timerManager = require("../../timers/timer-manager");
             timerManager.incrementChatLineCounters();
         }
 
-        const chatMessageListener = require("../../events/twitch-events/chat-message");
-        chatMessageListener.triggerChatMessage(firebotChatMessage);
+        twitchEventsHandler.chatMessage.triggerChatMessage(firebotChatMessage);
     });
 
     streamerChatClient.onWhisper(async (_user, messageText, msg) => {
@@ -78,49 +77,41 @@ exports.setupChatListeners = (streamerChatClient) => {
         const firebotChatMessage = await chatHelpers.buildFirebotChatMessage(msg, messageText, false, true);
         frontendCommunicator.send("twitch:chat:message", firebotChatMessage);
 
-        const chatMessageListener = require("../../events/twitch-events/chat-message");
-        chatMessageListener.triggerChatMessage(firebotChatMessage);
+        twitchEventsHandler.chatMessage.triggerChatMessage(firebotChatMessage);
 
-        const viewerArrivedListener = require("../../events/twitch-events/viewer-arrived");
-        viewerArrivedListener.triggerViewerArrived(msg.userInfo.displayName);
+        twitchEventsHandler.viewerArrived.triggerViewerArrived(msg.userInfo.displayName);
     });
 
     streamerChatClient.onMessageRemove((_channel, messageId) => {
         frontendCommunicator.send("twitch:chat:message:deleted", messageId);
     });
 
     streamerChatClient.onHosted((_, byChannel, auto, viewers) => {
-        const hostListener = require("../../events/twitch-events/host");
-        hostListener.triggerHost(byChannel, auto, viewers);
+        twitchEventsHandler.host.triggerHost(byChannel, auto, viewers);
         const logger = require("../../logwrapper");
         logger.debug(`Host triggered by ${byChannel}. Is auto: ${auto}`);
     });
 
     streamerChatClient.onSubGift((_channel, _user, giftSubInfo, msg) => {
-        const giftSubListener = require("../../events/twitch-events/gift-sub");
-        giftSubListener.triggerSubGift(giftSubInfo.gifterDisplayName,
+        twitchEventsHandler.giftSub.triggerSubGift(giftSubInfo.gifterDisplayName,
             giftSubInfo.displayName, giftSubInfo.plan, giftSubInfo.planName,
             giftSubInfo.giftDuration);
     });
 
     streamerChatClient.onCommunitySub((_channel, _user, subInfo, msg) => {
-        const giftSubListener = require("../../events/twitch-events/gift-sub");
-        giftSubListener.triggerCommunitySubGift(subInfo.gifterDisplayName,
+        twitchEventsHandler.giftSub.triggerCommunitySubGift(subInfo.gifterDisplayName,
             subInfo.plan, subInfo.count);
     });
 
     streamerChatClient.onRaid((_channel, _username, raidInfo) => {
-        const raidListener = require("../../events/twitch-events/raid");
-        raidListener.triggerRaid(raidInfo.displayName, raidInfo.viewerCount);
+        twitchEventsHandler.raid.triggerRaid(raidInfo.displayName, raidInfo.viewerCount);
     });
 
     streamerChatClient.onBan((_, username) => {
-        const bannedListener = require("../../events/twitch-events/viewer-banned");
-        bannedListener.triggerBanned(username);
+        twitchEventsHandler.viewerBanned.triggerBanned(username);
     });
 
     streamerChatClient.onTimeout((_, username, duration) => {
-        const timeoutListener = require("../../events/twitch-events/viewer-timeout");
-        timeoutListener.triggerTimeout(username, duration);
+        twitchEventsHandler.viewerTimeout.triggerTimeout(username, duration);
     });
 };
diff --git a/backend/chat/twitch-chat.js b/backend/chat/twitch-chat.js
@@ -296,8 +296,8 @@ frontendCommunicator.on("send-chat-message", async sendData => {
         let firebotMessage = await chatHelpers.buildFirebotChatMessageFromText(message);
         commandHandler.handleChatMessage(firebotMessage);
 
-        const chatMessageListener = require("../events/twitch-events/chat-message");
-        chatMessageListener.triggerChatMessage(firebotMessage);
+        const twitchEventsHandler = require("../events/twitch-events");
+        twitchEventsHandler.chatMessage.triggerChatMessage(firebotMessage);
     }
 
     twitchChat.sendChatMessage(message, null, accountType);

diff --git a/backend/cloud-sync/profile-sync.js b/backend/cloud-sync/profile-sync.js
@@ -8,26 +8,29 @@ const quoteList = require("./sync-handlers/quotes-list");
 const { settings } = require("../common/settings-access");
 
 async function syncProfileData(profileSyncData) {
-    let streamerUsername = accountAccess.getAccounts().streamer.username;
-    let commands = await commandList.getCommandListForSync(profileSyncData.username, profileSyncData.userRoles);
-    let quotes = await quoteList.getQuoteListForSync();
+    const streamerUsername = accountAccess.getAccounts().streamer.username;
+    const commands = await commandList.getCommandListForSync(profileSyncData.username, profileSyncData.userRoles);
+    const quotes = await quoteList.getQuoteListForSync();
 
-    let completeSyncJSON = {
+    const variableManager = require("../variables/replace-variable-manager");
+
+    const completeSyncJSON = {
         'owner': streamerUsername,
         'chatter': profileSyncData.username,
         'profilePage': profileSyncData.profilePage,
         'commands': commands,
+        'variables': variableManager.getReplaceVariables().map(v => v.definition),
         'quotes': quotes,
         'allowQuoteCSVDownloads': settings.getAllowQuoteCSVDownloads()
     };
 
-    let binId = await cloudSync.sync(completeSyncJSON);
+    const binId = await cloudSync.sync(completeSyncJSON);
 
     if (binId != null) {
         return binId;
     }
 
-    logger.error('Cloud Sync: Unable to get binId from bytebin for quotes list.');
+    logger.error('Cloud Sync: Unable to get binId from bytebin for profile data.');
     return null;
 }
 

diff --git a/backend/events/twitch-events.js b/backend/events/twitch-events.js
@@ -0,0 +1,14 @@
+"use strict";
+
+exports.chatMessage = require('./twitch-events/chat-message');
+exports.cheer = require('./twitch-events/cheer');
+exports.follow = require('./twitch-events/follow');
+exports.giftSub = require('./twitch-events/gift-sub');
+exports.host = require('./twitch-events/host');
+exports.raid = require('./twitch-events/raid');
+exports.rewardRedemption = require('./twitch-events/reward-redemption');
+exports.sub = require('./twitch-events/sub');
+exports.viewerArrived = require('./twitch-events/viewer-arrived');
+exports.viewerBanned = require('./twitch-events/viewer-banned');
+exports.viewerTimeout = require('./twitch-events/viewer-timeout');
+exports.whisper = require('./twitch-events/whisper');
diff --git a/backend/events/twitch-events/reward-redemption.js b/backend/events/twitch-events/reward-redemption.js
@@ -50,6 +50,7 @@ exports.handleRewardRedemption = (redemptionMessage) => {
             rewardId: redemptionMessage.rewardId,
             rewardImage: imageUrl,
             rewardName: redemptionMessage.rewardName,
+            rewardDescription: redemptionMessage.rewardPrompt,
             rewardCost: redemptionMessage.rewardCost
         };
 

diff --git a/backend/events/twitch-events/sub.js b/backend/events/twitch-events/sub.js
@@ -14,17 +14,23 @@ function getSubType (subPlan) {
         return "Tier 3";
     }
 }
-
+/**
+ *
+ * @param {import("twitch-pubsub-client").PubSubSubscriptionMessage} subInfo
+ */
 exports.triggerSub = (subInfo) => {
     const subType = getSubType(subInfo.subPlan);
+    const totalMonths = subInfo.months != null ? subInfo.months : 1;
+    const streak = subInfo.streakMonths != null ? subInfo.streakMonths : 1;
+    const isPrime = subInfo.subPlan === "Prime";
 
     eventManager.triggerEvent("twitch", "sub", {
         username: subInfo.userDisplayName,
         subPlan: subInfo.subPlan,
         subType: subType,
-        totalMonths: subInfo.months,
-        streak: subInfo.streakMonths,
-        isPrime: subInfo.subPlan === "Prime",
+        totalMonths: totalMonths,
+        streak: streak,
+        isPrime: isPrime,
         isResub: subInfo.isResub
     });
 };
diff --git a/backend/integrations/builtin/streamelements/streamelements-event-handler.js b/backend/integrations/builtin/streamelements/streamelements-event-handler.js
@@ -23,7 +23,7 @@ const eventSourceDefinition = {
             activityFeed: {
                 icon: "fad fa-money-bill",
                 getMessage: (eventData) => {
-                    return `**${eventData.username}** donated **$${eventData.dononationAmount}**${eventData.donationMessage && !!eventData.donationMessage.length ? `: *${eventData.donationMessage}*` : ''}`;
+                    return `**${eventData.from}** donated **$${eventData.dononationAmount}**${eventData.donationMessage && !!eventData.donationMessage.length ? `: *${eventData.donationMessage}*` : ''}`;
                 }
             }
         },

diff --git a/backend/integrations/builtin/streamlabs/events/streamlabs-event-handler.js b/backend/integrations/builtin/streamlabs/events/streamlabs-event-handler.js
@@ -23,7 +23,7 @@ const eventSourceDefinition = {
             activityFeed: {
                 icon: "fad fa-money-bill",
                 getMessage: (eventData) => {
-                    return `**${eventData.username}** donated **${eventData.formattedDonationAmount}**${eventData.donationMessage && !!eventData.donationMessage.length ? `: *${eventData.donationMessage}*` : ''}`;
+                    return `**${eventData.from}** donated **${eventData.formattedDonationAmount}**${eventData.donationMessage && !!eventData.donationMessage.length ? `: *${eventData.donationMessage}*` : ''}`;
                 }
             }
         },
@@ -36,7 +36,7 @@ const eventSourceDefinition = {
             activityFeed: {
                 icon: "fad fa-money-bill",
                 getMessage: (eventData) => {
-                    return `**${eventData.username}** donated **${eventData.formattedDonationAmount}** to ExtraLife${eventData.donationMessage && !!eventData.donationMessage.length ? `: *${eventData.donationMessage}*` : ''}`;
+                    return `**${eventData.from}** donated **${eventData.formattedDonationAmount}** to ExtraLife${eventData.donationMessage && !!eventData.donationMessage.length ? `: *${eventData.donationMessage}*` : ''}`;
                 }
             }
         },

diff --git a/backend/integrations/builtin/tipeeestream/events/tipeeestream-event-handler.js b/backend/integrations/builtin/tipeeestream/events/tipeeestream-event-handler.js
@@ -22,7 +22,7 @@ const eventSourceDefinition = {
             activityFeed: {
                 icon: "fad fa-money-bill",
                 getMessage: (eventData) => {
-                    return `**${eventData.username}** donated **${eventData.formattedDonationAmmount}**${eventData.donationMessage && !!eventData.donationMessage.length ? `: *${eventData.donationMessage}*` : ''}`;
+                    return `**${eventData.from}** donated **${eventData.formattedDonationAmmount}**${eventData.donationMessage && !!eventData.donationMessage.length ? `: *${eventData.donationMessage}*` : ''}`;
                 }
             }
         },

diff --git a/backend/twitch-api/follow-poll.js b/backend/twitch-api/follow-poll.js
@@ -4,7 +4,7 @@ const accountAccess = require("../common/account-access");
 
 const twitchApi = require("./client");
 
-const followEvent = require("../events/twitch-events/follow");
+const twitchEventsHandler = require("../events/twitch-events");
 
 let followPollIntervalId;
 let lastUserId;
@@ -43,7 +43,7 @@ exports.startFollowPoll = () => {
                 }
 
                 if (follow.userId !== lastUserId) {
-                    followEvent.triggerFollow(follow.userDisplayName, follow.userId);
+                    twitchEventsHandler.follow.triggerFollow(follow.userDisplayName, follow.userId);
                 } else {
                     break;
                 }

diff --git a/backend/twitch-api/pubsub/pubsub-client.js b/backend/twitch-api/pubsub/pubsub-client.js
@@ -75,31 +75,28 @@ async function createClient() {
     }
 
     try {
-        const rewardRedemptionHandler =
-        require("../../events/twitch-events/reward-redemption");
+        const twitchEventsHandler = require('../../events/twitch-events');
+
         const redemptionListener = await pubSubClient.onRedemption(streamer.userId,
             (message) => {
-                rewardRedemptionHandler.handleRewardRedemption(message);
+                twitchEventsHandler.rewardRedemption.handleRewardRedemption(message);
             });
 
         listeners.push(redemptionListener);
 
         const whisperListener = await pubSubClient.onWhisper(streamer.userId, (message) => {
-            const whisperListener = require("../../events/twitch-events/whisper");
-            whisperListener.triggerWhisper(message.senderName, message.text);
+            twitchEventsHandler.whisper.triggerWhisper(message.senderName, message.text);
         });
         listeners.push(whisperListener);
 
         const bitsListener = await pubSubClient.onBits(streamer.userId, (event) => {
-            const cheerListener = require("../../events/twitch-events/cheer");
-            cheerListener.triggerCheer(event.userName, event.isAnonymous, event.bits, event.totalBits, event.message);
+            twitchEventsHandler.cheer.triggerCheer(event.userName, event.isAnonymous, event.bits, event.totalBits, event.message);
         });
         listeners.push(bitsListener);
 
         const subsListener = await pubSubClient.onSubscription(streamer.userId, (subInfo) => {
             if (!subInfo.isGift) {
-                const subsHandler = require("../../events/twitch-events/sub");
-                subsHandler.triggerSub(subInfo);
+                twitchEventsHandler.sub.triggerSub(subInfo);
             }
         });
         listeners.push(subsListener);

diff --git a/backend/variables/builtin-variable-loader.js b/backend/variables/builtin-variable-loader.js
@@ -77,6 +77,7 @@ exports.loadReplaceVariables = () => {
         'read-file',
         'regexExec',
         'regexTest',
+        'reward-description',
         'reward-cost',
         'reward-image-url',
         'reward-message',

diff --git a/backend/variables/builtin/reward-description.js b/backend/variables/builtin/reward-description.js
@@ -0,0 +1,29 @@
+"use strict";
+
+const {
+    EffectTrigger
+} = require("../../effects/models/effectModels");
+
+const { OutputDataType, VariableCategory } = require("../../../shared/variable-constants");
+
+let triggers = {};
+triggers[EffectTrigger.EVENT] = ["twitch:channel-reward-redemption"];
+triggers[EffectTrigger.CHANNEL_REWARD] = true;
+triggers[EffectTrigger.MANUAL] = true;
+
+const model = {
+    definition: {
+        handle: "rewardDescription",
+        description: "The description of the reward",
+        triggers: triggers,
+        categories: [VariableCategory.COMMON],
+        possibleDataOutput: [OutputDataType.TEXT]
+    },
+    evaluator: (trigger) => {
+        return trigger.metadata.eventData ?
+            trigger.metadata.eventData.rewardDescription :
+            trigger.metadata.rewardDescription;
+    }
+};
+
+module.exports = model;
diff --git a/backend/variables/builtin/user-exists.js b/backend/variables/builtin/user-exists.js
@@ -7,6 +7,7 @@ const { OutputDataType, VariableCategory } = require("../../../shared/variable-c
 const model = {
     definition: {
         handle: "userExists",
+        usage: "userExists[username]",
         description: "Outputs 'true' if a user exists in Firebot's database, 'false' if not",
         categories: [VariableCategory.ADVANCED],
         possibleDataOutput: [OutputDataType.TEXT]