Fix the role permission deletion issue when appid contains '_'

[nobodyiam]

What's the purpose of this PR

Fix the role permission deletion issue when appid contains '_'

Which issue(s) this PR fixes:

Fixes #5143

Brief changelog

• escape the appid used in roles and permissions queries
• use like operator to match the escaped appid in used in roles and permissions queries

Follow this checklist to help us incorporate your contribution quickly and easily:

• Read the Contributing Guide before making this pull request.
• Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
• Write necessary unit tests to verify the code.
• Run mvn clean test to make sure this pull request doesn't break anything.
• Update the CHANGES log.

Summary by CodeRabbit

• Bug Fixes

  • Resolved issue with role permission deletion for appid containing underscores (_).

• Improvements

  • Enhanced query conditions to improve flexibility by using LIKE instead of = for targetId and role names.
  • Improved handling of appid by escaping underscores for more accurate query results.

[coderabbitai]

Walkthrough

Version 2.3.0 of Apollo addresses a critical issue with role permission deletions when appid contains an underscore (_). The changes primarily involve modifying query conditions in repository classes to use LIKE instead of = and escaping underscores in appid to prevent misinterpretation in MySQL queries.

Changes

File Path	Change Summary
CHANGES.md	Documented the fix for role permission deletion issue with appid containing underscores.
.../repository/PermissionRepository.java	Modified query conditions to use LIKE instead of = for targetId and added additional conditions.
.../repository/RoleRepository.java	Changed query conditions to use LIKE instead of direct equality comparisons for role names.
.../spi/defaultimpl/DefaultRolePermissionService.java	Added import for EscapeCharacter and modified methods to escape appid using EscapeCharacter.DEFAULT.escape(appId).

Assessment against linked issues

Objective	Addressed	Explanation
Fix role permission deletion issue when appid contains an underscore (_) (#5143)	✅

In fields where underscores lie,
Permissions now won't go awry.
With LIKE and escape in place,
Apollo's roles keep their grace.
Bugs fixed, the code refined,
Peace of mind, you'll surely find.

Tip

New Features and Improvements

Review Settings

Introduced new personality profiles for code reviews. Users can now select between "Chill" and "Assertive" review tones to tailor feedback styles according to their preferences. The "Assertive" profile posts more comments and nitpicks the code more aggressively, while the "Chill" profile is more relaxed and posts fewer comments.

AST-based Instructions

CodeRabbit offers customizing reviews based on the Abstract Syntax Tree (AST) pattern matching. Read more about AST-based instructions in the documentation.

Community-driven AST-based Rules

We are kicking off a community-driven initiative to create and share AST-based rules. Users can now contribute their AST-based rules to detect security vulnerabilities, code smells, and anti-patterns. Please see the ast-grep-essentials repository for more information.

New Static Analysis Tools

We are continually expanding our support for static analysis tools. We have added support for biome, hadolint, and ast-grep. Update the settings in your .coderabbit.yaml file or head over to the settings page to enable or disable the tools you want to use.

Tone Settings

Users can now customize CodeRabbit to review code in the style of their favorite characters or personalities. Here are some of our favorite examples:

• Mr. T: "You must talk like Mr. T in all your code reviews. I pity the fool who doesn't!"
• Pirate: "Arr, matey! Ye must talk like a pirate in all yer code reviews. Yarrr!"
• Snarky: "You must be snarky in all your code reviews. Snark, snark, snark!"

Revamped Settings Page

We have redesigned the settings page for a more intuitive layout, enabling users to find and adjust settings quickly. This change was long overdue; it not only improves the user experience but also allows our development team to add more settings in the future with ease. Going forward, the changes to .coderabbit.yaml will be reflected in the settings page, and vice versa.

Miscellaneous

• Turn off free summarization: You can switch off free summarization of PRs opened by users not on a paid plan using the enable_free_tier setting.
• Knowledge-base scope: You can now set the scope of the knowledge base to either the repository (local) or the organization (global) level using the knowledge_base setting. In addition, you can specify Jira project keys and Linear team keys to limit the knowledge base scope for those integrations.
• High-level summary placement: You can now customize the location of the high-level summary in the PR description using the high_level_summary_placeholder setting (default @coderabbitai summary).
• Revamped request changes workflow: You can now configure CodeRabbit to auto-approve or request changes on PRs based on the review feedback using the request_changes_workflow setting.

---

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
• Mastodon
• Reddit
• LinkedIn

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>.
  • 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 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.

[coderabbitai]

Actionable comments posted: 1

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 39cd381 and dd4e3a7.

Files selected for processing (4)

• CHANGES.md (1 hunks)
• apollo-portal/src/main/java/com/ctrip/framework/apollo/portal/repository/PermissionRepository.java (1 hunks)
• apollo-portal/src/main/java/com/ctrip/framework/apollo/portal/repository/RoleRepository.java (1 hunks)
• apollo-portal/src/main/java/com/ctrip/framework/apollo/portal/spi/defaultimpl/DefaultRolePermissionService.java (3 hunks)

Additional Context Used

Markdownlint (2)

CHANGES.md (2)

1: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

---

8: null
Lists should be surrounded by blank lines

Additional comments not posted (3)

apollo-portal/src/main/java/com/ctrip/framework/apollo/portal/repository/RoleRepository.java (1)

35-38: The changes to use the LIKE operator in SQL queries are appropriate for handling special characters in appId. Consider adding comments explaining why LIKE is used here for future maintainability.

Also applies to: 41-44

apollo-portal/src/main/java/com/ctrip/framework/apollo/portal/repository/PermissionRepository.java (1)

43-47: The modifications to the SQL queries using the LIKE operator are correctly implemented to handle special characters in appId. Adding explanatory comments could enhance understanding and maintainability.

apollo-portal/src/main/java/com/ctrip/framework/apollo/portal/spi/defaultimpl/DefaultRolePermissionService.java (1)

Line range hint 290-318: The addition of escaping appId in the deletion methods is a crucial fix for handling special characters. Consider adding comments to explain the use of EscapeCharacter.DEFAULT.escape(appId) for future reference.