Merge pull request #2235 from crowbartools/v5

.github/workflows/compile-and-release.yml

@@ -87,17 +87,17 @@ jobs:
           npm config set msvs_version 2022
           npm install --global --production --omit=dev [email protected]
 
+      - name: Linux Build Prep
+        if: runner.os == 'linux'
+        run: sudo apt-get install libx11-dev libxtst-dev libpng-dev
+
       - name: Restore Robotjs from cache
         id: robotjs-cache
         uses: actions/cache/restore@v3
         with:
           key: ${{ runner.os }}-robotjs
           path: ./node_modules/robotjs/
 
-      - name: Linux Build Prep
-        if: runner.os == 'linux'
-        run: sudo apt-get install libx11-dev libxtst-dev libpng-dev
-
       - name: Install Global Dependencies
         run: npm install --global --production --omit=dev grunt-cli node-gyp
 
@@ -140,9 +140,6 @@ jobs:
         with:
           path: ./bundles/
 
-      - name: Rename Artifacts
-        run: mv ./bundles/Windows/firebot-${{ needs.checkversion.outputs.version }}-full.nupkg ./bundles/Windows/firebot-v${{ needs.checkversion.outputs.version }}-full.nupkg
-
       - name: Create Release
         uses: softprops/action-gh-release@v1
         env:

package.json

@@ -1,6 +1,6 @@
 {
   "name": "firebotv5",
-  "version": "5.57.0",
+  "version": "5.58.0",
   "description": "Powerful all-in-one bot for Twitch streamers.",
   "main": "build/main.js",
   "scripts": {
@@ -49,10 +49,10 @@
   "dependencies": {
     "@aws-sdk/client-polly": "^3.26.0",
     "@crowbartools/firebot-custom-scripts-types": "^5.53.2-6",
-    "@twurple/api": "^6.0.6",
-    "@twurple/auth": "^6.0.6",
-    "@twurple/chat": "^6.0.6",
-    "@twurple/pubsub": "^6.0.6",
+    "@twurple/api": "^6.0.9",
+    "@twurple/auth": "^6.0.9",
+    "@twurple/chat": "^6.0.9",
+    "@twurple/pubsub": "^6.0.9",
     "@zunderscore/elgato-light-control": "^1.1.2",
     "angular": "^1.8.0",
     "angular-animate": "^1.7.8",

src/backend/chat/commands/builtin/steam/steam-access.js

@@ -108,6 +108,10 @@ const getSteamGameDetails = async (requestedGame) => {
         gameDetails.releaseDate = foundGame.release_date.date;
     }
 
+    if (foundGame.short_description) {
+        gameDetails.shortDescription = foundGame.short_description;
+    }
+
     return gameDetails;
 };
 

src/backend/chat/commands/builtin/steam/steam.js

@@ -22,7 +22,7 @@ const steam = {
             outputTemplate: {
                 type: "string",
                 title: "Output Template",
-                tip: "Variables: {gameName}, {price}, {releaseDate}, {metaCriticScore}, {steamUrl}",
+                tip: "Variables: {gameName}, {price}, {releaseDate}, {metaCriticScore}, {steamUrl}, {steamShortDescription}",
                 default: `{gameName} (Price: {price} - Released: {releaseDate} - Metacritic: {metaCriticScore}) {steamUrl}`,
                 useTextArea: true
             }
@@ -49,7 +49,8 @@ const steam = {
                     .replace("{price}", gameDetails.price || "Unknown")
                     .replace("{releaseDate}", gameDetails.releaseDate || "Unknown")
                     .replace("{metaCriticScore}", gameDetails.score || "Unknown")
-                    .replace("{steamUrl}", gameDetails.url);
+                    .replace("{steamUrl}", gameDetails.url)
+                    .replace("{steamShortDescription}", gameDetails.shortDescription || "Unknown");
             }
         }
 

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

@@ -97,6 +97,7 @@ function buildModules(scriptManifest) {
         twitchApi: twitchApi,
         httpServer: require("../../../../server/http-server-manager"),
         effectManager: require("../../../effects/effectManager"),
+        effectRunner: require("../../effect-runner"),
         conditionManager: require("../../../effects/builtin/conditional-effects/conditions/condition-manager"),
         restrictionManager: require("../../../restrictions/restriction-manager"),
         commandManager: require("../../../chat/commands/CommandManager"),
@@ -115,7 +116,8 @@ function buildModules(scriptManifest) {
         quotesManager: require("../../../quotes/quotes-manager"),
         frontendCommunicator: require("../../frontend-communicator"),
         counterManager: require("../../../counters/counter-manager"),
-        utils: require("../../../utility")
+        utils: require("../../../utility"),
+        resourceTokenManager: require("../../../resourceTokenManager")
     };
 }
 

src/backend/common/handlers/fileWriterProcessor.js

@@ -1,6 +1,7 @@
 "use strict";
 
 const fs = require("fs-extra");
+const path = require("path");
 const logger = require("../../logwrapper");
 
 function doesTextExistInFile(filepath, text) {
@@ -75,6 +76,7 @@ exports.run = async effect => {
                     fs.appendFileSync(effect.filepath, text + "\n", "utf8");
                 }
             } else {
+                fs.ensureDirSync(path.dirname(effect.filepath));
                 fs.appendFileSync(effect.filepath, text + "\n", "utf8");
             }
         } else if (effect.writeMode === "delete") {

src/backend/common/user-access.js

@@ -24,7 +24,7 @@ async function userFollowsChannels(username, channelNames) {
         if (cachedFollow !== undefined) {
             userFollowsChannel = cachedFollow;
         } else {
-            userFollowsChannel = await twitchApi.users.doesUserFollowChannelLegacy(username, channelName);
+            userFollowsChannel = await twitchApi.users.doesUserFollowChannel(username, channelName);
 
             // set cache value
             followCache.set(`${username}:${channelName}`, userFollowsChannel);

src/backend/effects/builtin/control-emulation.js

@@ -125,6 +125,18 @@ const effect = {
             "f10",
             "f11",
             "f12",
+            "f13",
+            "f14",
+            "f15",
+            "f16",
+            "f17",
+            "f18",
+            "f19",
+            "f20",
+            "f21",
+            "f22",
+            "f23",
+            "f24",
             "alt",
             "control",
             "shift",

src/backend/effects/builtin/cooldown-command.js

@@ -209,7 +209,7 @@ const model = {
                     commandId: id,
                     subcommandId: effect.subcommandId,
                     username: effect.username,
-                    cooldowns: {
+                    cooldown: {
                         global: !isNaN(effect.globalCooldownSecs) ? parseInt(effect.globalCooldownSecs) : undefined,
                         user: !isNaN(effect.userCooldownSecs) && effect.username != null && effect.username !== '' ? parseInt(effect.userCooldownSecs) : undefined
                     }
@@ -219,7 +219,7 @@ const model = {
                     commandId: id,
                     subcommandId: effect.subcommandId,
                     username: effect.clearUsername,
-                    cooldowns: {
+                    cooldown: {
                         global: effect.clearGlobalCooldown,
                         user: effect.clearUserCooldown
                     }

src/backend/effects/builtin/loop-effects.js

@@ -81,9 +81,9 @@ const model = {
 
         $scope.loopModeChanged = () => {
             if ($scope.effect.loopMode === "count") {
-                $scope.effect.loopCount = 5;
+                $scope.effect.loopCount = "5";
             } else if ($scope.effect.loopMode === "conditional") {
-                $scope.effect.loopCount = 25;
+                $scope.effect.loopCount = "25";
             }
         };
 

src/backend/effects/builtin/pause-resume-effect-queue.ts

@@ -88,11 +88,11 @@ const model: EffectType<{
             return false;
         } else {
             if (effect.action === "Pause") {
-                effectQueueRunner.pauseQueue(effect.effectQueue);
+                effectQueueManager.pauseQueue(effect.effectQueue);
             } else if (effect.action === "Resume") {
-                effectQueueRunner.resumeQueue(effect.effectQueue);
+                effectQueueManager.resumeQueue(effect.effectQueue);
             } else {
-                effectQueueRunner.toggleQueue(effect.effectQueue);
+                effectQueueManager.toggleQueue(effect.effectQueue);
             }
         }
 

src/backend/effects/builtin/play-video.js

@@ -10,6 +10,9 @@ const accountAccess = require("../../common/account-access");
 const util = require("../../utility");
 const fs = require('fs-extra');
 const path = require("path");
+const frontendCommunicator = require('../../common/frontend-communicator');
+const { wait } = require("../../utility");
+const { parseYoutubeId } = require("../../../shared/youtube-url-parser");
 
 /**
  * The Play Video effect
@@ -366,7 +369,7 @@ const playVideo = {
             /**@type {import('@twurple/api').HelixClip} */
             let clip;
             if (effect.videoType === "Twitch Clip") {
-                clipId = effect.twitchClipUrl.replace("https://clips.twitch.tv/", "");
+                clipId = effect.twitchClipUrl.split("/").pop();
                 try {
                     clip = await client.clips.getClipById(clipId);
                 } catch (error) {
@@ -439,54 +442,40 @@ const playVideo = {
         }
 
         let resourceToken;
-        if (effect.videoType === "YouTube Video") {
-            resourceToken = resourceTokenManager.storeResourcePath(data.filepath, effect.length);
-        } else {
-            const durationToken = resourceTokenManager.storeResourcePath(data.filepath, 5);
-
-            const durationPromise = new Promise(async (resolve, reject) => {
-                const listener = (event) => {
-                    try {
-                        if (event.name === "video-duration" && event.data.resourceToken === durationToken) {
-                            webServer.removeListener("overlay-event", listener);
-                            resolve(event.data.duration);
-                        }
-                    } catch (err) {
-                        logger.error("Error while trying to process overlay-event for getVideoDuration: ", err);
-                        reject(err);
-                    }
-                };
-                webServer.on("overlay-event", listener);
-            });
-
-            webServer.sendToOverlay("getVideoDuration", {
-                resourceToken: durationToken,
-                overlayInstance: data.overlayInstance
-            });
-
-            const duration = await durationPromise;
-            resourceToken = resourceTokenManager.storeResourcePath(data.filepath, duration + 5);
-            logger.info(`Retrieved duration for video: ${duration}`);
+        let duration;
+        if (effect.videoType === "YouTube Video" && !effect.wait) {
+            logger.debug("Play Video Effect: Proceeding without Youtube Video Duration because wait is false");
+        } else if (effect.videoType === "YouTube Video" && effect.wait) {
+            const youtubeData = parseYoutubeId(data.youtubeId);
+            data.youtubeId = youtubeData.id;
+            const result = await frontendCommunicator.fireEventAsync("getYoutubeVideoDuration", data.youtubeId);
+            if (!isNaN(result)) {
+                duration = result;
+            } else {
+                // Error
+                logger.error("Play Video Effect: Unable to retrieve Youtube Video Duration", result);
+                return;
+            }
+            if (data.videoStarttime == null || data.videoStarttime == "" || data.videoStarttime == 0) {
+                data.videoStarttime = youtubeData.startTime;
+            }
+        } else if (effect.videoType === "Local Video") {
+            const result = await frontendCommunicator.fireEventAsync("getVideoDuration", data.filepath);
+            if (!isNaN(result)) {
+                duration = result;
+            }
+            resourceToken = resourceTokenManager.storeResourcePath(data.filepath, duration);
         }
 
         data.resourceToken = resourceToken;
 
         webServer.sendToOverlay("video", data);
         if (effect.wait) {
-            await new Promise(async (resolve, reject) => {
-                const listener = (event) => {
-                    try {
-                        if (event.name === "video-end" && event.data.resourceToken === resourceToken) {
-                            webServer.removeListener("overlay-event", listener);
-                            resolve();
-                        }
-                    } catch (err) {
-                        logger.error("Error while trying to process overlay-event for play-video: ", err);
-                        reject(err);
-                    }
-                };
-                webServer.on("overlay-event", listener);
-            });
+            let internalDuration = data.videoDuration;
+            if (internalDuration == null || internalDuration === 0 || internalDuration === "") {
+                internalDuration = duration;
+            }
+            await wait(internalDuration * 1000);
         }
         return true;
     },
@@ -544,7 +533,7 @@ const playVideo = {
                 const data = event;
 
                 const videoType = data.videoType;
-                const filepath = data.filepath;
+                const filepath = data.filepath ?? "";
                 let fileExt = filepath.split(".").pop();
                 if (fileExt === "ogv") {
                     fileExt = "ogg";
@@ -637,9 +626,6 @@ const playVideo = {
                         const exitVideo = () => {
                             delete startedVidCache[this.id]; // eslint-disable-line no-undef
                             animateVideoExit(`#${wrapperId}`, exitAnimation, exitDuration, inbetweenAnimation);
-                            setTimeout(function(){
-                                sendWebsocketEvent("video-end", {resourceToken: token}); // eslint-disable-line no-undef
-                            }, millisecondsFromString(exitDuration));
                         };
 
                         // Remove div after X time.
@@ -669,29 +655,6 @@ const playVideo = {
 
                     $(".wrapper").append(wrappedHtml);
 
-                    try {
-                        const url = new URL(youtubeId);
-                        if (url.hostname.includes("www.youtube.com")) {
-                            for (const [key, value] of url.searchParams) {
-                                if (key === "v") {
-                                    youtubeId = value;
-                                } else if (key === "t") {
-                                    videoStarttime = value;
-                                }
-                            }
-                        }
-                        if (url.hostname.includes("youtu.be")) {
-                            youtubeId = url.pathname.replace("/", "");
-                            for (const [key, value] of url.searchParams) {
-                                if (key === "t") {
-                                    videoStarttime = value;
-                                }
-                            }
-                        }
-                    } catch (error) {
-                        //failed to convert url
-                    }
-
                     // Add iframe.
 
                     const playerVars = {
@@ -737,9 +700,6 @@ const playVideo = {
                             onStateChange: (event) => {
                                 if (event.data === 0 && !videoDuration) {
                                     animateVideoExit(`#${wrapperId}`, exitAnimation, exitDuration, inbetweenAnimation);
-                                    setTimeout(function(){
-                                        sendWebsocketEvent("video-end", {resourceToken: token}); // eslint-disable-line no-undef
-                                    }, millisecondsFromString(exitDuration));
                                 }
                             }
                         }
@@ -757,9 +717,6 @@ const playVideo = {
                     if (videoDuration) {
                         setTimeout(function () {
                             animateVideoExit(`#${wrapperId}`, exitAnimation, exitDuration, inbetweenAnimation);
-                            setTimeout(function(){
-                                sendWebsocketEvent("video-end", {resourceToken: token}); // eslint-disable-line no-undef
-                            }, millisecondsFromString(exitDuration));
                         }, videoDuration);
                     }
                 }

src/backend/effects/builtin/stream-game.js

@@ -3,6 +3,7 @@
 const { EffectCategory } = require('../../../shared/effect-constants');
 const logger = require('../../logwrapper');
 const twitchApi = require("../../twitch-api/api");
+const eventsManager = require("../../events/EventManager");
 
 const model = {
     definition: {
@@ -104,6 +105,9 @@ const model = {
                 await twitchApi.channels.updateChannelInformation({ gameId: category.id });
             }
         }
+
+        const category = (await twitchApi.channels.getChannelInformation()).gameName;
+        eventsManager.triggerEvent("firebot", "category-changed", {category: category});
         return true;
     }
 };

src/backend/effects/builtin/take-screenshot.js

@@ -91,7 +91,7 @@ const clip = {
             <eos-overlay-instance effect="effect" class="setting-padtop"></eos-overlay-instance>
 
         </div>
-        <eos-container pad-top="true"> 
+        <eos-container pad-top="true">
             <div class="effect-info alert alert-info">
                 Note: Screenshots will capture the entirety of the selected display.
             </div>
@@ -204,7 +204,7 @@ const clip = {
                     description: "Screenshot by Firebot"
                 }];
                 const screenshotEmbed = await discordEmbedBuilder.buildScreenshotEmbed(`attachment://${filename}`);
-                discord.sendDiscordMessage(effect.discordChannelId, "A new screenshot was taken!", screenshotEmbed, files);
+                await discord.sendDiscordMessage(effect.discordChannelId, "A new screenshot was taken!", screenshotEmbed, files);
             }
 
             if (effect.showInOverlay) {