PromucFlow_constructor/app/client/src/ce/sagas/ApiCallerSagas.ts

41 lines
1.3 KiB
TypeScript
Raw Normal View History

import JSActionAPI from "ee/api/JSActionAPI";
chore: module editor api refactor (#28261) ## Description The `updateActionAPICall` is overridden in EE to call a different api for action update #### PR fixes following issue(s) For appsmithorg/appsmith-ee#2717 > if no issue exists, please create an issue and ask the maintainers about this first > > #### Media > A video or a GIF is preferred. when using Loom, don’t embed because it looks like it’s a GIF. instead, just link to the video > > #### Type of change - Chore (housekeeping or task changes that don't impact user perception) ## Testing > #### How Has This Been Tested? > Please describe the tests that you ran to verify your changes. Also list any relevant details for your test configuration. > Delete anything that is not relevant - [ ] Manual - [ ] JUnit - [ ] Jest - [ ] Cypress > > #### Test Plan > Add Testsmith test cases links that relate to this PR > > #### Issues raised during DP testing > Link issues raised during DP testing for better visiblity and tracking (copy link from comments dropped on this PR) > > > ## Checklist: #### Dev activity - [ ] My code follows the style guidelines of this project - [ ] I have performed a self-review of my own code - [ ] I have commented my code, particularly in hard-to-understand areas - [ ] I have made corresponding changes to the documentation - [ ] My changes generate no new warnings - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] New and existing unit tests pass locally with my changes - [ ] PR is being merged under a feature flag #### QA activity: - [ ] [Speedbreak features](https://github.com/appsmithorg/TestSmith/wiki/Guidelines-for-test-plans#speedbreakers-) have been covered - [ ] Test plan covers all impacted features and [areas of interest](https://github.com/appsmithorg/TestSmith/wiki/Guidelines-for-test-plans#areas-of-interest-) - [ ] Test plan has been peer reviewed by project stakeholders and other QA members - [ ] Manually tested functionality on DP - [ ] We had an implementation alignment call with stakeholders post QA Round 2 - [ ] Cypress test cases have been added and approved by SDET/manual QA - [ ] Added `Test Plan Approved` label after Cypress tests were reviewed - [ ] Added `Test Plan Approved` label after JUnit tests were reviewed
2023-10-20 11:36:39 +00:00
import ActionAPI from "api/ActionAPI";
import type { ApiResponse } from "api/ApiResponses";
import type { Action } from "entities/Action";
chore: Split JS collection update api call to override for modules (#34009) ## Description The API call is moved to a saga called `updateJSCollectionAPICall` whose role is to identify whom this JS collection belongs to `Page` / `Module` / `Workflow` and then call the correct API. In the context of CE, it just calls the existing `updateJSCollection` but in EE this saga (`updateJSCollectionAPICall`) is extended and does the checking mentioned above. For more info on extension check the [EE PR](https://github.com/appsmithorg/appsmith-ee/pull/4356) Fixes https://github.com/appsmithorg/appsmith/issues/34008 ## Automation /ok-to-test tags="@tag.All" ### :mag: Cypress test results <!-- This is an auto-generated comment: Cypress test results --> > [!TIP] > 🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉 > Workflow run: <https://github.com/appsmithorg/appsmith/actions/runs/9465185887> > Commit: 5e0214b97de20cf1b9042717fdb578f872c2c7d3 > Cypress dashboard url: <a href="https://internal.appsmith.com/app/cypress-dashboard/rundetails-65890b3c81d7400d08fa9ee5?branch=master&workflowId=9465185887&attempt=1" target="_blank">Click here!</a> <!-- end of auto-generated comment: Cypress test results --> ## Communication Should the DevRel and Marketing teams inform users about this change? - [ ] Yes - [ ] No <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **Tests** - Added test cases for the `updateJSCollectionAPICall` function. - Updated `pageId` constant in `pasteSagas.test.ts` for improved readability and consistency. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Ashok Kumar M <35134347+marks0351@users.noreply.github.com>
2024-06-11 13:55:34 +00:00
import type { JSCollection } from "entities/JSCollection";
chore: module editor api refactor (#28261) ## Description The `updateActionAPICall` is overridden in EE to call a different api for action update #### PR fixes following issue(s) For appsmithorg/appsmith-ee#2717 > if no issue exists, please create an issue and ask the maintainers about this first > > #### Media > A video or a GIF is preferred. when using Loom, don’t embed because it looks like it’s a GIF. instead, just link to the video > > #### Type of change - Chore (housekeeping or task changes that don't impact user perception) ## Testing > #### How Has This Been Tested? > Please describe the tests that you ran to verify your changes. Also list any relevant details for your test configuration. > Delete anything that is not relevant - [ ] Manual - [ ] JUnit - [ ] Jest - [ ] Cypress > > #### Test Plan > Add Testsmith test cases links that relate to this PR > > #### Issues raised during DP testing > Link issues raised during DP testing for better visiblity and tracking (copy link from comments dropped on this PR) > > > ## Checklist: #### Dev activity - [ ] My code follows the style guidelines of this project - [ ] I have performed a self-review of my own code - [ ] I have commented my code, particularly in hard-to-understand areas - [ ] I have made corresponding changes to the documentation - [ ] My changes generate no new warnings - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] New and existing unit tests pass locally with my changes - [ ] PR is being merged under a feature flag #### QA activity: - [ ] [Speedbreak features](https://github.com/appsmithorg/TestSmith/wiki/Guidelines-for-test-plans#speedbreakers-) have been covered - [ ] Test plan covers all impacted features and [areas of interest](https://github.com/appsmithorg/TestSmith/wiki/Guidelines-for-test-plans#areas-of-interest-) - [ ] Test plan has been peer reviewed by project stakeholders and other QA members - [ ] Manually tested functionality on DP - [ ] We had an implementation alignment call with stakeholders post QA Round 2 - [ ] Cypress test cases have been added and approved by SDET/manual QA - [ ] Added `Test Plan Approved` label after Cypress tests were reviewed - [ ] Added `Test Plan Approved` label after JUnit tests were reviewed
2023-10-20 11:36:39 +00:00
/**
* DO NOT ADD any additional code/functionality in this saga. This function is overridden in EE to
* use a different API for update action under the package editor.
* The purpose of this saga is only to call the appropriate API and return the result
* @param action Action
* @returns Action
*/
export function* updateActionAPICall(action: Action) {
try {
const response: ApiResponse<Action> = yield ActionAPI.updateAction(action);
return response;
} catch (e) {
throw e;
}
}
chore: Split JS collection update api call to override for modules (#34009) ## Description The API call is moved to a saga called `updateJSCollectionAPICall` whose role is to identify whom this JS collection belongs to `Page` / `Module` / `Workflow` and then call the correct API. In the context of CE, it just calls the existing `updateJSCollection` but in EE this saga (`updateJSCollectionAPICall`) is extended and does the checking mentioned above. For more info on extension check the [EE PR](https://github.com/appsmithorg/appsmith-ee/pull/4356) Fixes https://github.com/appsmithorg/appsmith/issues/34008 ## Automation /ok-to-test tags="@tag.All" ### :mag: Cypress test results <!-- This is an auto-generated comment: Cypress test results --> > [!TIP] > 🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉 > Workflow run: <https://github.com/appsmithorg/appsmith/actions/runs/9465185887> > Commit: 5e0214b97de20cf1b9042717fdb578f872c2c7d3 > Cypress dashboard url: <a href="https://internal.appsmith.com/app/cypress-dashboard/rundetails-65890b3c81d7400d08fa9ee5?branch=master&workflowId=9465185887&attempt=1" target="_blank">Click here!</a> <!-- end of auto-generated comment: Cypress test results --> ## Communication Should the DevRel and Marketing teams inform users about this change? - [ ] Yes - [ ] No <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **Tests** - Added test cases for the `updateJSCollectionAPICall` function. - Updated `pageId` constant in `pasteSagas.test.ts` for improved readability and consistency. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Ashok Kumar M <35134347+marks0351@users.noreply.github.com>
2024-06-11 13:55:34 +00:00
/**
* DO NOT ADD any additional code/functionality in this saga. This function is overridden in EE to
* use a different API for update jsCollection under the package editor.
* The purpose of this saga is only to call the appropriate API and return the result
* @param action Action
* @returns Action
*/
export function* updateJSCollectionAPICall(jsCollection: JSCollection) {
try {
const response: ApiResponse<JSCollection> =
yield JSActionAPI.updateJSCollection(jsCollection);
return response;
} catch (e) {
throw e;
}
}