Modify implementation to allow an API and a Common policies with same and version #12660
Conversation
RusJaI
changed the title
RusJaI
changed the title
RusJaI
force-pushed
the
master
branch
4 times, most recently
from
7b1a258 to
0a6e19d
Compare
RusJaI
requested review from
tharindu1st,
AnuGayan,
chamilaadhi,
Arshardh,
dushaniw and
tgtshanika
as code owners
.../apimgt/org.wso2.carbon.apimgt.api/src/main/java/org/wso2/carbon/apimgt/api/APIProvider.java
Show resolved
Hide resolved
...g.wso2.carbon.apimgt.api/src/main/java/org/wso2/carbon/apimgt/api/model/OperationPolicy.java
Outdated
Show resolved
Hide resolved
...t/org.wso2.carbon.apimgt.impl/src/main/java/org/wso2/carbon/apimgt/impl/APIProviderImpl.java
Outdated
Show resolved
Hide resolved
...t/org.wso2.carbon.apimgt.impl/src/main/java/org/wso2/carbon/apimgt/impl/APIProviderImpl.java
Outdated
Show resolved
Hide resolved
...t/org.wso2.carbon.apimgt.impl/src/main/java/org/wso2/carbon/apimgt/impl/APIProviderImpl.java
Show resolved
Hide resolved
...t/org.wso2.carbon.apimgt.impl/src/main/java/org/wso2/carbon/apimgt/impl/APIProviderImpl.java
Outdated
Show resolved
Hide resolved
...t/org.wso2.carbon.apimgt.impl/src/main/java/org/wso2/carbon/apimgt/impl/APIProviderImpl.java
Outdated
Show resolved
Hide resolved
| if (policyData != null) { | ||
| policySpec = policyData.getSpecification(); | ||
| appliedPolicy.setPolicyId(policyData.getPolicyId()); | ||
| if (policyType == null || ImportExportConstants.POLICY_TYPE_API.equalsIgnoreCase(policyType)) { |
There was a problem hiding this comment.
Why do we check null or api type here? Also, don't we have to consider the else case here?
| if (policyData != null) { | ||
| policySpec = policyData.getSpecification(); | ||
| appliedPolicy.setPolicyId(policyData.getPolicyId()); | ||
| if (policyType == null || ImportExportConstants.POLICY_TYPE_COMMON.equalsIgnoreCase(policyType)) { |
There was a problem hiding this comment.
Same here. Why do we have the null or common check and no else conditions?
There was a problem hiding this comment.
if policy is not found in the project, policy can be referenced from an existing policy. That logic is performed here.
(When importing an API which has been exported from a previous APIM version which doesn't have policy support, the default policy type is set to null.)
In the process of finding policy among existing policies :
- check if the policy is within API Specific operational policies. this check is made for the policies which the type is 'api' or not defined which is filtered by null check
- check if the policy is within Common operational policies. this check is made for the policies which the type is 'common' or not defined which is filtered by null check
| if (policyType == null | ||
| || ImportExportConstants.POLICY_TYPE_API.equalsIgnoreCase(policyType)) { | ||
| policyData = provider.getAPISpecificOperationPolicyByPolicyName(policy.getPolicyName(), | ||
| policy.getPolicyVersion(), api.getUuid(), null, | ||
| tenantDomain, false); | ||
| } |
There was a problem hiding this comment.
Please add a comment to explain why we do this null or 'api' check.
There was a problem hiding this comment.
this method is used to validate the provided policy list and return the validated list. if the policy spec is not there, then it checks whether the policy has been referenced. if the policy type is not defined or defined as an api level policy, it fetches the policy data. If the policyData is null , which means there's no API Specific policy with the provided details. Then it's checked within common policies.
…policies while initial loading
… an api and is exported from that env but common policy is not in the env where the api is imported
…h are exported from previous U2 levels
…same name and version and is attached to the API already
Public fix of https://github.com/wso2-enterprise/wso2-apim-internal/issues/7352
Previously when exporting an API which has an API policy (ex :policy1) and common policy (ex : policy1) with the same name and version, only one of them is exported. The import flow also didn't allow to import those policies. The PR fixes the above.