GH-241 harden review module flows and repair mention/reminder consistency

[vLuckyyy]

No description provided.

[gemini-code-assist]

Summary of Changes

Hello @vLuckyyy, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly hardens the GitHub review module by introducing robust data persistence for review mentions and reminders, ensuring consistent state tracking of pull requests. It refines the handling of GitHub API rate limits for reminder dispatches and enhances the reliability of review-related commands through improved input validation and error handling. These changes collectively contribute to a more stable and accurate review process within the application.

Highlights

• New Review Mention Persistence: Introduced a new database repository (GitHubReviewMentionRepository) to persistently store and manage GitHub review mentions and reminder states, ensuring data consistency across application restarts and improving reminder logic.
• Enhanced GitHub API Rate Limit Handling: Refactored the reminder service to process reminders sequentially with explicit delays, effectively preventing GitHub API rate limit exhaustion during bulk reminder dispatches.
• Improved Command Robustness and Validation: Added comprehensive null checks and input validation across various review-related commands (e.g., /review add, /review request, /review notification), making the module more resilient to invalid user input and misconfigurations.
• Consistent PR Status Tracking: Implemented automatic updates of pull request review statuses (merged/closed) in the new database, ensuring that the system accurately reflects the current state of PRs and avoids sending reminders for completed reviews.
• Streamlined Asynchronous Task Execution: Simplified the execution of background tasks for archiving and mentioning reviewers by removing redundant CompletableFuture.runAsync and scheduler.schedule wrappers, leading to cleaner and more efficient code.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog

• .gitignore
  • Updated the entry for 'database/' to '/database/' to ensure correct exclusion of the database directory.
• src/main/java/com/eternalcode/discordapp/feature/review/GitHubPullRequest.java
  • Modified the GITHUB_PULL_REQUEST_REGEX pattern to correctly parse repository names containing dots ('.') or hyphens ('-').
• src/main/java/com/eternalcode/discordapp/feature/review/GitHubReviewReminderService.java
  • Removed unused Instant import and lastGitHubApiCall field.
  • Refactored processReminders to use a sequential CompletableFuture chain with explicit delays for GitHub API rate limiting, replacing parallel processing.
  • Removed sendReminderAsync and calculateDelayForRateLimit methods.
  • Added a delay helper method for asynchronous delays.
  • Updated sendReminder to directly check PR status without scheduling a separate task.
  • Modified handleClosedOrMergedPR to accept GitHubPullRequest and update the review status in the repository.
  • Removed scheduler.schedule calls from handlePRStatusCheck for hasUserReviewed checks.
• src/main/java/com/eternalcode/discordapp/feature/review/GitHubReviewService.java
  • Added a null check for guild in createReview to prevent errors when used outside a guild context.
  • Integrated mentionRepository.updateReviewStatus calls when archiving merged or closed pull requests to maintain database consistency.
  • Implemented validation for empty GitHub usernames and trimmed input in addUserToSystem.
  • Changed updateUserNotificationType to return a boolean indicating if the update was successful and added a check for user existence.
  • Enhanced isUserExist and getReviewUserByUsername methods to handle null/empty usernames and perform case-insensitive matching for GitHub usernames.
• src/main/java/com/eternalcode/discordapp/feature/review/GitHubReviewTask.java
  • Refactored archiveTask and mentionTask to directly return CompletableFuture from service calls, simplifying asynchronous execution flow.
• src/main/java/com/eternalcode/discordapp/feature/review/command/GitHubReviewCommand.java
  • Removed Permission.MESSAGE_MANAGE from userPermissions, making the command accessible without this specific permission.
• src/main/java/com/eternalcode/discordapp/feature/review/command/child/AddChild.java
  • Added validation to ensure the GitHub username is not empty after trimming, providing an ephemeral error message if it is.
• src/main/java/com/eternalcode/discordapp/feature/review/command/child/ForumTagsIdChild.java
  • Added a null check for the ForumChannel retrieved by ID, providing an ephemeral error message if the channel is not found.
• src/main/java/com/eternalcode/discordapp/feature/review/command/child/ListChild.java
  • Added a constant EMBED_FIELD_LIMIT to manage the number of users displayed in an embed.
  • Handled cases where the list of registered users is empty, providing an appropriate message.
  • Implemented logic to display a footer indicating if the list of users exceeds the embed field limit.
• src/main/java/com/eternalcode/discordapp/feature/review/command/child/NotificationChild.java
  • Added a null check for the notification-type option.
  • Modified the command to check the return value of updateUserNotificationType and provide feedback if the user is not registered.
• src/main/java/com/eternalcode/discordapp/feature/review/command/child/RequestChild.java
  • Removed Permission.MESSAGE_MANAGE from userPermissions.
  • Added a null check for the url option to ensure it is provided.
• src/main/java/com/eternalcode/discordapp/feature/review/database/GitHubReviewMentionRepository.java
  • Added a new interface defining operations for managing GitHub review mentions in a database, including methods for marking mentions, recording reminders, retrieving reminders, finding mentions, and updating review statuses.
• src/main/java/com/eternalcode/discordapp/feature/review/database/GitHubReviewMentionRepositoryImpl.java
  • Added a new implementation of GitHubReviewMentionRepository using ORMLite for database interactions.
  • Implemented methods for marking reviewers as mentioned, checking mention status, recording reminder sends, and retrieving reviewers needing reminders.
  • Included logic for updating the review status of pull requests in the database.
  • Introduced a scheduled cleanup task to remove old merged or closed mentions from the database.
  • Provided utility methods for creating mention keys and handling database exceptions.
• src/main/java/com/eternalcode/discordapp/feature/review/database/GitHubReviewMentionWrapper.java
  • Added a new ORMLite entity class to represent GitHub review mentions in the database.
  • Defined fields for pull request URL, user ID, last mention timestamp, review status, thread ID, and last reminder sent timestamp.
  • Included constructors, getters, setters, and a method to convert to a GitHubReviewMention object.
  • Overrode equals, hashCode, and toString for proper object comparison and representation.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request significantly hardens the review module by improving asynchronous flows, fixing consistency issues with mentions and reminders, and adding persistence for review states. The changes are well-structured and address important aspects like rate limiting and data validation. My review includes suggestions to further enhance efficiency by reducing redundant API calls, improve the robustness of asynchronous operations, and refine the database schema for better maintainability and performance. Overall, this is a quality contribution that makes the review feature much more reliable.