search

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

Fix: follow event subscription now uses version 2 #481

Closed mjfwebb closed 2 months ago

mjfwebb commented 2 months ago

The follow event requires an additional scope moderator:read:followers and the moderator_user_id to be sent. We use the same value as the broadcaster ID.

Summary by CodeRabbit

coderabbitai[bot] commented 2 months ago

Walkthrough

The recent updates focus on enhancing Twitch integration. Documentation now includes an additional scope requirement for reading moderator followers. In the codebase, the eventSubscribe function has been updated to accept a version parameter, enhancing flexibility. Additionally, the follow subscription function now includes a moderator user ID and specifies a newer version, aligning with the updated eventSubscribe function.

Changes

File Path Change Summary
docs/CONFIGURATION.md Added moderator:read:followers scope to Twitch requirements
.../event-sub/subscribers/eventSubscribe.ts Added optional version parameter with default '1'
.../event-sub/subscribers/subscribeToFollows.ts Added moderator_user_id and version '2' to parameters
Recent Review Details **Configuration used: CodeRabbit UI**
Commits Files that changed from the base of the PR and between 01ca4078f4a7b2090613cdbdc21c22255a286eac and 493e4b35ab5b0d0a8ba705babddaad3f8e03531c.
Files selected for processing (3) * docs/CONFIGURATION.md (1 hunks) * server/src/handlers/twitch/event-sub/subscribers/eventSubscribe.ts (1 hunks) * server/src/handlers/twitch/event-sub/subscribers/subscribeToFollows.ts (1 hunks)
Additional comments not posted (4)
server/src/handlers/twitch/event-sub/subscribers/subscribeToFollows.ts (1)
`9-17`: Ensure that the `moderator_user_id` is correctly set to the broadcaster's ID as intended.
server/src/handlers/twitch/event-sub/subscribers/eventSubscribe.ts (2)
`7-7`: The addition of the `version` parameter with a default value of '1' enhances flexibility in handling different versions of event subscriptions. --- `14-14`: Ensure that the `version` parameter is correctly passed to the API request body.
docs/CONFIGURATION.md (1)
`13-13`: The addition of the `moderator:read:followers` scope correctly reflects the updated permissions required by the Twitch API.
--- 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.