Skip to content

GH-930 Add private chat toggle placeholder. #931

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

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

Conversation

vLuckyyy
Copy link
Member

Fixes: #930

@vLuckyyy vLuckyyy added the ✅ needs testing Issue needs verification. label Apr 16, 2025
Copy link
Contributor

coderabbitai bot commented Apr 16, 2025

Walkthrough

This update introduces a new way to show the status of private messages using placeholders. A new class is added to handle the setup for these placeholders. When the system starts, it registers two placeholders: one shows if private messages are enabled or disabled as "true" or "false," and the other gives a formatted message, like "Enabled" or "Disabled," in the player's language. The code also adds new fields and methods to handle these messages in both English and Polish. An extra helper class is included to manage the asynchronous fetching and formatting of the placeholder values.

Assessment against linked issues

Objective Addressed Explanation
Add a placeholder for the /msgtoggle command. i.e: %eternalcore_msgtoggle% (#930)

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)
  • We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.
✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (2)
eternalcore-core/src/main/java/com/eternalcode/core/placeholder/AsyncPlaceholderValue.java (1)

16-28: Consider adding JavaDoc comments for better clarity.

Adding some documentation would help other developers understand how this class works and when to use it.

eternalcore-core/src/main/java/com/eternalcode/core/feature/privatechat/PrivateChatPlaceholderSetup.java (1)

38-43: Consider adding error logging

While AsyncPlaceholderValue handles errors by showing an error message, it would be helpful to also log these errors for debugging.

 CompletableFuture<PrivateChatState> stateFuture = this.privateChatStateService.getChatState(playerId);
+// Consider adding .exceptionally() handler for logging errors
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between da18b63 and 1ab4405.

📒 Files selected for processing (5)
  • eternalcore-core/src/main/java/com/eternalcode/core/feature/privatechat/PrivateChatPlaceholderSetup.java (1 hunks)
  • eternalcore-core/src/main/java/com/eternalcode/core/feature/privatechat/messages/ENPrivateMessages.java (1 hunks)
  • eternalcore-core/src/main/java/com/eternalcode/core/feature/privatechat/messages/PLPrivateChatMessages.java (1 hunks)
  • eternalcore-core/src/main/java/com/eternalcode/core/feature/privatechat/messages/PrivateChatMessages.java (1 hunks)
  • eternalcore-core/src/main/java/com/eternalcode/core/placeholder/AsyncPlaceholderValue.java (1 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (1)
eternalcore-core/src/main/java/com/eternalcode/core/feature/privatechat/PrivateChatPlaceholderSetup.java (1)
eternalcore-core/src/main/java/com/eternalcode/core/placeholder/AsyncPlaceholderValue.java (1)
  • AsyncPlaceholderValue (6-29)
🔇 Additional comments (9)
eternalcore-core/src/main/java/com/eternalcode/core/placeholder/AsyncPlaceholderValue.java (1)

1-29: Nice implementation of the placeholder value handler.

This class provides a simple way to display placeholder values that need to be loaded asynchronously. It handles loading states, errors, and formatting nicely.

eternalcore-core/src/main/java/com/eternalcode/core/feature/privatechat/messages/PrivateChatMessages.java (1)

28-31: Good addition of placeholder methods.

These methods will make it easy to get localized text for private message toggle status.

eternalcore-core/src/main/java/com/eternalcode/core/feature/privatechat/messages/ENPrivateMessages.java (1)

61-62: Good implementation with clear color coding.

The green/red colors make it easy to understand the status at a glance.

eternalcore-core/src/main/java/com/eternalcode/core/feature/privatechat/messages/PLPrivateChatMessages.java (1)

62-63: Good Polish translation with matching colors.

The translations are appropriate and maintain the same color scheme as the English version.

eternalcore-core/src/main/java/com/eternalcode/core/feature/privatechat/PrivateChatPlaceholderSetup.java (5)

1-19: Nice job organizing the imports and class structure!

The class is properly set up as a controller with the necessary imports. Good use of the dependency injection pattern with the @Controller annotation.


21-31: Constructor looks good!

You've correctly injected the services needed for this feature. The code follows the project's dependency injection pattern with the @Inject annotation.


33-45: Good implementation of the basic placeholder!

The registration and implementation of the eternalcore_msgtoggle placeholder looks clean. Good job using AsyncPlaceholderValue to handle the asynchronous state retrieval.


47-61: Formatted placeholder implementation looks good!

This nicely handles both the asynchronous state retrieval and proper translation. Good job making sure it's user-friendly with the formatted output.


36-44: Check if naming follows conventions

Verify that the placeholder name eternalcore_msgtoggle follows the same naming pattern as other placeholders in your system.

Comment on lines +37 to +38
UUID playerId = targetPlayer.getUniqueId();
CompletableFuture<PrivateChatState> stateFuture = this.privateChatStateService.getChatState(playerId);
Copy link
Contributor

Choose a reason for hiding this comment

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

Just inline

Suggested change
UUID playerId = targetPlayer.getUniqueId();
CompletableFuture<PrivateChatState> stateFuture = this.privateChatStateService.getChatState(playerId);
CompletableFuture<PrivateChatState> stateFuture = this.privateChatStateService.getChatState(targetPlayer.getUniqueId());

Comment on lines +49 to +51
UUID playerId = targetPlayer.getUniqueId();
Translation messages = this.translationManager.getMessages(playerId);
CompletableFuture<PrivateChatState> stateFuture = this.privateChatStateService.getChatState(playerId);
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
UUID playerId = targetPlayer.getUniqueId();
Translation messages = this.translationManager.getMessages(playerId);
CompletableFuture<PrivateChatState> stateFuture = this.privateChatStateService.getChatState(playerId);
UUID playerId = targetPlayer.getUniqueId();
Translation messages = this.translationManager.getMessages(playerId);
CompletableFuture<PrivateChatState> stateFuture = this.privateChatStateService.getChatState(playerId);

}

@Override
public String toString() {
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't think that this name is good. I would suggest change to maybe "getValue" or smth like this.

Suggested change
public String toString() {
public String getValue() {

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
✅ needs testing Issue needs verification.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add a placeholder for the /msgtoggle command. i.e: %eternalcore_msgtoggle%
2 participants