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

add namespaces check in synchronization configuration feature #5192

Merged

Conversation

nobodyiam
Copy link
Member

@nobodyiam nobodyiam commented Aug 3, 2024

What's the purpose of this PR

add namespaces check in synchronization configuration feature

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

  • New Features

    • Enhanced validation logic for updating items, ensuring synchronization validity before proceeding with updates.
    • Introduced a method to validate synchronization criteria against specified namespaces.
  • Bug Fixes

    • Improved robustness of the update process to prevent invalid synchronization operations.

@dosubot dosubot bot added the size:S This PR changes 10-29 lines, ignoring generated files. label Aug 3, 2024
Copy link
Contributor

coderabbitai bot commented Aug 3, 2024

Walkthrough

The recent changes enhance the synchronization validation logic within the ItemController and NamespaceSyncModel classes. The update method now includes an additional validity check for synchronization to specific namespaces, improving error handling during update operations. A new method, syncToNamespacesValid, has been added to NamespaceSyncModel, ensuring synchronization criteria are thoroughly validated before proceeding.

Changes

File Path Change Summary
apollo-portal/src/main/java/com/ctrip/framework/apollo/portal/controller/ItemController.java Enhanced update method to include a check for synchronization validity using model.syncToNamespacesValid(appId, namespaceName).
apollo-portal/src/main/java/com/ctrip/framework/apollo/portal/entity/model/NamespaceSyncModel.java Added syncToNamespacesValid method for validating synchronization against NamespaceIdentifier objects.

Poem

In the code where bunnies hop,
Validations now won’t stop!
Sync to namespaces, oh so bright,
Ensures our changes feel just right.
With every check, we leap and cheer,
Robust and ready, never fear! 🐇✨


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>.
    • 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.
    • @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 as 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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: 2

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 49bd8cc and a71a904.

Files selected for processing (2)
  • apollo-portal/src/main/java/com/ctrip/framework/apollo/portal/controller/ItemController.java (1 hunks)
  • apollo-portal/src/main/java/com/ctrip/framework/apollo/portal/entity/model/NamespaceSyncModel.java (1 hunks)

@@ -195,7 +195,7 @@ public List<ItemDiffs> diff(@RequestBody NamespaceSyncModel model) {
@PutMapping(value = "/apps/{appId}/namespaces/{namespaceName}/items", consumes = {"application/json"})
public ResponseEntity<Void> update(@PathVariable String appId, @PathVariable String namespaceName,
@RequestBody NamespaceSyncModel model) {
checkModel(!model.isInvalid());
checkModel(!model.isInvalid() && model.syncToNamespacesValid(appId, namespaceName));
Copy link
Contributor

Choose a reason for hiding this comment

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

LGTM! Add unit tests to verify the new validation logic.

The code changes are approved. Ensure to add unit tests to verify the new validation logic in the update method.

Do you want me to generate the unit testing code or open a GitHub issue to track this task?

@nobodyiam nobodyiam force-pushed the fix-unauthorized-access-issue branch from a71a904 to 621c151 Compare August 3, 2024 14:13
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: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between a71a904 and 621c151.

Files selected for processing (2)
  • apollo-portal/src/main/java/com/ctrip/framework/apollo/portal/controller/ItemController.java (1 hunks)
  • apollo-portal/src/main/java/com/ctrip/framework/apollo/portal/entity/model/NamespaceSyncModel.java (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • apollo-portal/src/main/java/com/ctrip/framework/apollo/portal/controller/ItemController.java

Comment on lines +44 to +52
public boolean syncToNamespacesValid(String appId, String namespaceName) {
for (NamespaceIdentifier namespaceIdentifier : syncToNamespaces) {
if (appId.equals(namespaceIdentifier.getAppId()) && namespaceName.equals(
namespaceIdentifier.getNamespaceName())) {
continue;
}
return false;
}
return true;
Copy link
Contributor

Choose a reason for hiding this comment

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

Consider using stream and allMatch for better readability.

The current implementation is functional but can be improved for readability and conciseness.

public boolean syncToNamespacesValid(String appId, String namespaceName) {
  return syncToNamespaces.stream()
    .allMatch(namespaceIdentifier -> appId.equals(namespaceIdentifier.getAppId()) && namespaceName.equals(namespaceIdentifier.getNamespaceName()));
}

@nobodyiam nobodyiam requested a review from a team August 3, 2024 14:17
@nobodyiam nobodyiam merged commit f55b419 into apolloconfig:master Aug 10, 2024
7 of 8 checks passed
@nobodyiam nobodyiam deleted the fix-unauthorized-access-issue branch August 10, 2024 11:48
@github-actions github-actions bot locked and limited conversation to collaborators Aug 10, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
size:S This PR changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant