Allow policy name matching with "_imported" suffix

[RusJaI]

Fixes wso2/api-manager#3593

[coderabbitai]

📝 Walkthrough

Walkthrough

This change updates the policy validation logic in the validatePolicies method within the API provider implementation. The updated logic introduces an additional check that permits a policy name to match when it is appended with "_imported," while still enforcing an exact version match. This modification refines the control flow of policy validation to handle cases where imported policies follow a different naming convention.

Changes

File(s)	Change Summary
components/apimgt/.../APIProviderImpl.java	Modified validatePolicies method to include an additional boolean check for policy names with an appended "_imported". Version validation remains fixed.

Sequence Diagram(s)

sequenceDiagram
    participant Importer as APICTL Import Process
    participant Provider as APIProviderImpl.validatePolicies
    participant Policy as OperationPolicy

    Importer->>Provider: Call validatePolicies(apiPoliciesList, api, tenantDomain)
    Provider->>Policy: Validate policy details
    alt Policy name matches original
        Provider->>Policy: Continue validation
    else Policy name with "_imported" matches
        Provider->>Policy: Continue validation
    else No matching name
        Provider->>Importer: Reject policy validation
    end

Loading

Assessment against linked issues

Objective	Addressed	Explanation
Allow APICTL API import to correctly process policies with an imported name convention [#3593]	✅

Suggested reviewers

• tgtshanika
• chamilaadhi
• tharindu1st
• dushaniw
• Arshardh
• AnuGayan

Tip

⚡🧪 Multi-step agentic review comment chat (experimental)

• We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments.
  - To enable this feature, set early_access to true under in the settings.

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5ee9d1e and a7e74f7.

📒 Files selected for processing (1)

• components/apimgt/org.wso2.carbon.apimgt.impl/src/main/java/org/wso2/carbon/apimgt/impl/APIProviderImpl.java (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (6)

• GitHub Check: build-product (3, group3)
• GitHub Check: build-product (4, group4)
• GitHub Check: build-product (1, group1)
• GitHub Check: run-benchmark-test
• GitHub Check: build-product (2, group2)
• GitHub Check: build-carbon

🔇 Additional comments (1)

components/apimgt/org.wso2.carbon.apimgt.impl/src/main/java/org/wso2/carbon/apimgt/impl/APIProviderImpl.java (1)

1872-1875: Approval: Enhanced policy name validation to support imported policies.

The change introduces flexibility in policy name validation by allowing a match when the policy name has an "_imported" suffix, while still enforcing exact version matching. This properly addresses the issue mentioned in PR #13049, enabling the system to recognize imported policies without requiring name modifications.

✨ 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

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

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.