Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix ChatInputEvent message assignment #1127

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

ZANX3Y
Copy link
Contributor

@ZANX3Y ZANX3Y commented Feb 28, 2025

Description

Previously, the modified message from ChatInputEvent would not be reassigned correctly in ChatHudMixin after it was modified.
Only AntiSpamHack was affected by this issue.

Copy link

coderabbitai bot commented Feb 28, 2025

Walkthrough

The pull request modifies the onAddMessage method in the ChatHudMixin class. The method signature now renames the Text message parameter to Text messageDontUse and introduces a new local reference parameter for the message with the annotation @Local(argsOnly = true) LocalRef<Text> message, along with a similar change for the indicator. Inside the method, the retrieval of the message content is updated from using the direct variable to calling get() on the local reference by replacing message with message.get(). Additionally, assignment to the message content is changed from direct assignment to using the set() method on the local reference. Similar modifications are also applied to the call of modifyIndicator to ensure consistent access via the local reference.

Suggested labels

type:bugfix


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 407deae and 304b9cd.

📒 Files selected for processing (1)
  • src/main/java/net/wurstclient/mixin/ChatHudMixin.java (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: build
🔇 Additional comments (4)
src/main/java/net/wurstclient/mixin/ChatHudMixin.java (4)

42-46: Method signature improved to correctly modify injected parameters

The parameter change from direct Text message to LocalRef<Text> message with the @Local(argsOnly = true) annotation is crucial. This properly captures references to the original method's parameters, allowing the mixin to modify them in a way that persists after the injection. The suffix "DontUse" on direct parameters is a good pattern to prevent accidentally using the wrong variable.


48-49: Correct access to message content via LocalRef

Using message.get() to retrieve the message content is the proper way to access the value when working with LocalRef. This change ensures the code is working with the current message value.


58-58: Fixed message assignment mechanism

This is the critical fix mentioned in the PR description. Previously, assigning directly to message would only modify the local variable and not affect the actual parameter used by the original method. Using message.set() correctly updates the reference that will be used after this injected code completes.


59-60: Consistent use of LocalRef for indicator modification

The indicator modification now properly uses message.get() and indicator.get() to access current values. This ensures that any modifications made earlier in the method (like at line 58) are properly reflected when modifying the indicator.

✨ Finishing Touches
  • 📝 Generate Docstrings

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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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 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 for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Member

@Alexander01998 Alexander01998 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, I see what you mean. AntiSpam isn't adding the message counters anymore.

Thanks for the fix! I can confirm this works and will make sure it gets included in v7.47.

@Alexander01998 Alexander01998 added type:bugfix This can be released as a patch. category:chat labels Feb 28, 2025
@Alexander01998 Alexander01998 added this to the v7.47 milestone Feb 28, 2025
Alexander01998 added a commit that referenced this pull request Feb 28, 2025
@Alexander01998 Alexander01998 added the status:merged This pull request has been merged, even if GitHub says otherwise. label Feb 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
category:chat status:merged This pull request has been merged, even if GitHub says otherwise. type:bugfix This can be released as a patch.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants