mjfwebb / twitch-bot

Twitch Chat bot with overlays, custom commands, TTS, sounds, rewards, API integrations and more!
MIT License
27 stars 7 forks source link

7TV Emote Fixes #477

Closed 6lr61 closed 3 months ago

6lr61 commented 3 months ago

Extended the 7TV websocket support to handle updated messages.

An update removes the old emotes from the overlay. This may or may not be desirable.

Tested with the client locally.

coderabbitai[bot] commented 3 months ago

Walkthrough

The enhancement focuses on improving the handling of emote updates within the runSevenTVWebsocket function. The update introduces additional conditions to better manage the lifecycle of emotes, specifically by addressing both updated and removed emotes more comprehensively in the iteration process. Additionally, in the loadEmotes.ts file, the quality of displayed emotes has been enhanced by selecting the largest emote for better visual experience.

Changes

File Change Summary
.../sevenTV/sevenTVWebsocket.ts
.../chat/loadEmotes.ts
Enhanced the handling of emote updates in runSevenTVWebsocket by including conditions for updated emotes in addition to existing ones for added and pushed emotes. Updated the handling of removed emotes by iterating over updated emotes along with removed and pulled emotes. Improved addSevenTVEmote in loadEmotes.ts to select the largest emote for better quality, specifically looking for '3x.webp' or '3x.avif' files.

Recent Review Details **Configuration used: CodeRabbit UI**
Commits Files that changed from the base of the PR and between d3c978602db30d75cb02e0d8cd699b6731f8cbed and 40052478200ace153144e6a2def9d2c68c68d3e7.
Files selected for processing (1) * server/src/chat/loadEmotes.ts (1 hunks)
Additional comments not posted (2)
server/src/chat/loadEmotes.ts (2)
`105-106`: Consider simplifying the file selection logic. The current implementation uses a hard-coded check for '3x.webp' or '3x.avif'. Consider using a more flexible approach that selects the largest available file based on a sorted list of file sizes. This would make the code more adaptable to changes in file naming conventions or additional file types. --- `102-109`: > :memo: **NOTE** > This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [106-125] Optimize the repeated code for setting emote properties. The properties for `sevenTVEmotesForClient` are set in two places within the `addSevenTVEmote` function, leading to code duplication. Consider refactoring this into a separate function or method that can be called with the necessary parameters. ```diff + function setEmoteProperties(emoteData, file) { + const imageUrl = `${emoteData.host.url}/${file.name}`; + sevenTVEmotesForClient[emoteData.name] = { + origin: 'sevenTV', + src: imageUrl, + width: file.width, + height: file.height, + modifier: false, + hidden: false, + modifierFlags: emoteData.flags, + id: emoteData.id, + name, + }; + } - // Duplicate code block here + setEmoteProperties(emoteData, file); ```
--- Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?
Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.