PromucFlow_constructor/app/client/src/sagas/BatchSagas.tsx

91 lines
2.7 KiB
TypeScript
Raw Normal View History

/* eslint-disable @typescript-eslint/ban-ts-comment */
2020-04-17 16:15:09 +00:00
import _ from "lodash";
import { put, debounce, takeEvery, all } from "redux-saga/effects";
chore: upgrade to prettier v2 + enforce import types (#21013)Co-authored-by: Satish Gandham <hello@satishgandham.com> Co-authored-by: Satish Gandham <satish.iitg@gmail.com> ## Description This PR upgrades Prettier to v2 + enforces TypeScript’s [`import type`](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-8.html#type-only-imports-and-export) syntax where applicable. It’s submitted as a separate PR so we can merge it easily. As a part of this PR, we reformat the codebase heavily: - add `import type` everywhere where it’s required, and - re-format the code to account for Prettier 2’s breaking changes: https://prettier.io/blog/2020/03/21/2.0.0.html#breaking-changes This PR is submitted against `release` to make sure all new code by team members will adhere to new formatting standards, and we’ll have fewer conflicts when merging `bundle-optimizations` into `release`. (I’ll merge `release` back into `bundle-optimizations` once this PR is merged.) ### Why is this needed? This PR is needed because, for the Lodash optimization from https://github.com/appsmithorg/appsmith/commit/7cbb12af886621256224be0c93e6a465dd710ad3, we need to use `import type`. Otherwise, `babel-plugin-lodash` complains that `LoDashStatic` is not a lodash function. However, just using `import type` in the current codebase will give you this: <img width="962" alt="Screenshot 2023-03-08 at 17 45 59" src="https://user-images.githubusercontent.com/2953267/223775744-407afa0c-e8b9-44a1-90f9-b879348da57f.png"> That’s because Prettier 1 can’t parse `import type` at all. To parse it, we need to upgrade to Prettier 2. ### Why enforce `import type`? Apart from just enabling `import type` support, this PR enforces specifying `import type` everywhere it’s needed. (Developers will get immediate TypeScript and ESLint errors when they forget to do so.) I’m doing this because I believe `import type` improves DX and makes refactorings easier. Let’s say you had a few imports like below. Can you tell which of these imports will increase the bundle size? (Tip: it’s not all of them!) ```ts // app/client/src/workers/Linting/utils.ts import { Position } from "codemirror"; import { LintError as JSHintError, LintOptions } from "jshint"; import { get, isEmpty, isNumber, keys, last, set } from "lodash"; ``` It’s pretty hard, right? What about now? ```ts // app/client/src/workers/Linting/utils.ts import type { Position } from "codemirror"; import type { LintError as JSHintError, LintOptions } from "jshint"; import { get, isEmpty, isNumber, keys, last, set } from "lodash"; ``` Now, it’s clear that only `lodash` will be bundled. This helps developers to see which imports are problematic, but it _also_ helps with refactorings. Now, if you want to see where `codemirror` is bundled, you can just grep for `import \{.*\} from "codemirror"` – and you won’t get any type-only imports. This also helps (some) bundlers. Upon transpiling, TypeScript erases type-only imports completely. In some environment (not ours), this makes the bundle smaller, as the bundler doesn’t need to bundle type-only imports anymore. ## Type of change - Chore (housekeeping or task changes that don't impact user perception) ## How Has This Been Tested? This was tested to not break the build. ### 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 - [x] 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 - [x] 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: - [ ] Test plan has been approved by relevant developers - [ ] Test plan has been peer reviewed by QA - [ ] Cypress test cases have been added and approved by either SDET or manual QA - [ ] Organized project review call with relevant stakeholders after Round 1/2 of QA - [ ] Added Test Plan Approved label after reveiwing all Cypress test --------- Co-authored-by: Satish Gandham <hello@satishgandham.com> Co-authored-by: Satish Gandham <satish.iitg@gmail.com>
2023-03-16 11:41:47 +00:00
import type { ReduxAction } from "@appsmith/constants/ReduxActionConstants";
import { ReduxActionTypes } from "@appsmith/constants/ReduxActionConstants";
import { batchActionSuccess } from "actions/batchActions";
import * as log from "loglevel";
2020-04-13 08:24:13 +00:00
2020-04-17 16:15:09 +00:00
const BATCH_PRIORITY = {
[ReduxActionTypes.META_UPDATE_DEBOUNCED_EVAL]: {
priority: 0,
needsSaga: false,
},
[ReduxActionTypes.SET_META_PROP_AND_EVAL]: {
2020-04-17 16:15:09 +00:00
priority: 0,
needsSaga: false,
},
[ReduxActionTypes.RESET_WIDGET_META]: {
priority: 0,
needsSaga: false,
},
fix: reset widget to default value after setter method (#29151) ## Description This PR ensures that widgets are reset to their default value after the `setValue` setter method is used to set its value #### PR fixes following issue(s) Fixes #27119 #### 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 > Please delete options that are not relevant. - Bug fix (non-breaking change which fixes an issue) - New feature (non-breaking change which adds functionality) - Breaking change (fix or feature that would cause existing functionality to not work as expected) - Chore (housekeeping or task changes that don't impact user perception) - This change requires a documentation update > > > ## 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 <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **New Features** - Implemented a new reset functionality for widgets, allowing users to revert to default values after changes. - Enhanced widget meta updates with a new reset action. - **Bug Fixes** - Added test cases to ensure widget reset functionality works as expected, even after asynchronous operations. - **Refactor** - Refactored evaluation logic to improve handling of widget meta updates and resets. - Improved action execution logic for resetting widget properties. - **Tests** - Expanded end-to-end regression tests to cover new reset widget functionality. - **Documentation** - Updated internal documentation to reflect new action types and evaluation processes related to widget meta updates. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Druthi Polisetty <druthi@appsmith.com>
2023-12-08 10:16:31 +00:00
[ReduxActionTypes.RESET_WIDGET_META_UPDATES]: {
priority: 0,
needsSaga: false,
},
2020-04-17 16:15:09 +00:00
[ReduxActionTypes.UPDATE_WIDGET_PROPERTY]: {
priority: 0,
needsSaga: false,
},
[ReduxActionTypes.EXECUTE_TRIGGER_REQUEST]: {
2020-04-17 16:15:09 +00:00
priority: 1,
needsSaga: true,
},
[ReduxActionTypes.EXECUTE_PAGE_LOAD_ACTIONS]: {
priority: 1,
needsSaga: true,
},
[ReduxActionTypes.UPDATE_ACTION_PROPERTY]: {
2020-07-28 10:41:51 +00:00
priority: 0,
needsSaga: false,
},
2020-07-28 10:41:51 +00:00
[ReduxActionTypes.UPDATE_ACTION_INIT]: {
priority: 1,
needsSaga: true,
},
2020-04-17 16:15:09 +00:00
};
// TODO: Fix this the next time the file is edited
// eslint-disable-next-line @typescript-eslint/no-explicit-any
2020-04-17 16:15:09 +00:00
const batches: ReduxAction<any>[][] = [];
// TODO: Fix this the next time the file is edited
// eslint-disable-next-line @typescript-eslint/no-explicit-any
2020-04-13 08:24:13 +00:00
function* storeUpdatesSaga(action: ReduxAction<ReduxAction<any>>) {
2020-04-17 16:15:09 +00:00
try {
const priority = BATCH_PRIORITY[action.payload.type].priority;
const currentPriorityBatch = batches[priority] || [];
currentPriorityBatch.push(action.payload);
_.set(batches, `[${priority}]`, currentPriorityBatch);
yield put({ type: ReduxActionTypes.EXECUTE_BATCH });
} catch (e) {
log.error(`${action.payload.type} action priority not set`);
2020-04-17 16:15:09 +00:00
}
2020-04-13 08:24:13 +00:00
}
function* executeBatchSaga() {
2020-04-17 16:15:09 +00:00
for (let priority = 0; priority < batches.length; priority++) {
const batch = batches[priority];
if (Array.isArray(batch) && batch.length) {
2020-12-24 04:32:25 +00:00
const needsSaga = batch.filter((b) => BATCH_PRIORITY[b.type].needsSaga);
const canBatch = batch.filter((b) => !BATCH_PRIORITY[b.type].needsSaga);
2020-04-17 16:15:09 +00:00
batches[priority] = [];
// @ts-expect-error: Types are not available
2020-04-17 16:15:09 +00:00
yield put(canBatch);
if (needsSaga.length) {
for (const sagaAction of needsSaga) {
yield put(sagaAction);
}
}
yield put(batchActionSuccess(batch));
2020-04-17 16:15:09 +00:00
}
}
2020-04-13 08:24:13 +00:00
}
export default function* root() {
2020-04-17 16:15:09 +00:00
yield all([
debounce(20, ReduxActionTypes.EXECUTE_BATCH, executeBatchSaga),
takeEvery(ReduxActionTypes.BATCHED_UPDATE, storeUpdatesSaga),
]);
2020-04-13 08:24:13 +00:00
}