fix: Migration to v4 engine : flows on deprecated plans not visible anymore#15985
fix: Migration to v4 engine : flows on deprecated plans not visible anymore#15985bmouhaimen wants to merge 1 commit into4.10.xfrom
Conversation
Summary of ChangesHello, I'm Gemini Code Assist1! 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 addresses a critical visibility issue within the v4 engine's Policy Studio, where flows linked to deprecated API plans were unintentionally excluded. By adjusting the API service call to explicitly include deprecated plans, the system now correctly displays all relevant flows, enhancing the user experience and ensuring that no plan-related configurations are overlooked. Highlights
Using Gemini Code AssistThe 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
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 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. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the API plan fetching mechanism to include 'DEPRECATED' plans in addition to 'PUBLISHED' plans, affecting both the ApiV4PolicyStudioDesignComponent and its associated test. Feedback suggests improving code maintainability by replacing the hardcoded plan status strings with shared constants or enums in both the component and its test, to prevent issues if statuses change in the future.
| httpTestingController | ||
| .expectOne({ | ||
| url: `${CONSTANTS_TESTING.env.v2BaseURL}/apis/${apiId}/plans?page=1&perPage=9999&statuses=PUBLISHED`, | ||
| url: `${CONSTANTS_TESTING.env.v2BaseURL}/apis/${apiId}/plans?page=1&perPage=9999&statuses=PUBLISHED,DEPRECATED`, |
There was a problem hiding this comment.
To avoid magic strings and ensure consistency between the test and the component, it would be better to use a shared constant for the plan statuses. The test could then build the expected URL using this constant, for example statuses=${planStatuses.join(',')}. This prevents the test from breaking if the statuses in the component are changed.
| this.connectorPluginsV2Service.listEndpointPlugins(), | ||
| this.apiPlanV2Service | ||
| .list(this.activatedRoute.snapshot.params.apiId, undefined, ['PUBLISHED'], undefined, undefined, 1, 9999) | ||
| .list(this.activatedRoute.snapshot.params.apiId, undefined, ['PUBLISHED', 'DEPRECATED'], undefined, undefined, 1, 9999) |
There was a problem hiding this comment.
To improve maintainability and avoid using magic strings, consider defining ['PUBLISHED', 'DEPRECATED'] as a constant. If an enum for plan statuses already exists in the codebase, it would be preferable to use it here. This would make the code more readable and easier to update in the future.
1 participant
Migration to v4 engine : flows on deprecated plans not visible anymore
https://gravitee.atlassian.net/browse/APIM-13302