2023-07-06 13:20:31 +00:00
|
|
|
import { all, call, put, spawn, take } from "redux-saga/effects";
|
2023-01-16 11:56:18 +00:00
|
|
|
import { ReduxActionTypes } from "@appsmith/constants/ReduxActionConstants";
|
|
|
|
|
import { MAIN_THREAD_ACTION } from "@appsmith/workers/Evaluation/evalWorkerActions";
|
|
|
|
|
import log from "loglevel";
|
2023-06-23 10:42:27 +00:00
|
|
|
import {
|
|
|
|
|
evalErrorHandler,
|
|
|
|
|
logJSVarMutationEvent,
|
|
|
|
|
} from "../sagas/PostEvaluationSagas";
|
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 { Channel } from "redux-saga";
|
2023-01-16 11:56:18 +00:00
|
|
|
import { storeLogs } from "../sagas/DebuggerSagas";
|
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 {
|
2023-01-28 13:12:11 +00:00
|
|
|
BatchedJSExecutionData,
|
|
|
|
|
BatchedJSExecutionErrors,
|
|
|
|
|
} from "reducers/entityReducers/jsActionsReducer";
|
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 { TMessage } from "utils/MessageUtil";
|
|
|
|
|
import { MessageType } from "utils/MessageUtil";
|
|
|
|
|
import type { ResponsePayload } from "../sagas/EvaluationsSaga";
|
2023-01-16 11:56:18 +00:00
|
|
|
import {
|
|
|
|
|
evalWorker,
|
|
|
|
|
executeTriggerRequestSaga,
|
2023-04-07 07:41:36 +00:00
|
|
|
updateDataTreeHandler,
|
2023-01-16 11:56:18 +00:00
|
|
|
} from "../sagas/EvaluationsSaga";
|
|
|
|
|
import { logJSFunctionExecution } from "@appsmith/sagas/JSFunctionExecutionSaga";
|
|
|
|
|
import { handleStoreOperations } from "./ActionExecution/StoreActionSaga";
|
2023-06-23 10:42:27 +00:00
|
|
|
import type {
|
|
|
|
|
EvalTreeResponseData,
|
|
|
|
|
JSVarMutatedEvents,
|
|
|
|
|
} from "workers/Evaluation/types";
|
2023-02-11 18:33:20 +00:00
|
|
|
import isEmpty from "lodash/isEmpty";
|
2023-10-10 12:32:17 +00:00
|
|
|
import type { UnEvalTree } from "entities/DataTree/dataTreeTypes";
|
2023-07-05 13:34:03 +00:00
|
|
|
import { sortJSExecutionDataByCollectionId } from "workers/Evaluation/JSObject/utils";
|
|
|
|
|
import type { LintTreeSagaRequestData } from "plugins/Linting/types";
|
2023-10-11 07:35:24 +00:00
|
|
|
export interface UpdateDataTreeMessageData {
|
2023-04-07 07:41:36 +00:00
|
|
|
workerResponse: EvalTreeResponseData;
|
|
|
|
|
unevalTree: UnEvalTree;
|
2023-10-11 07:35:24 +00:00
|
|
|
}
|
2023-04-07 07:41:36 +00:00
|
|
|
|
2023-01-16 11:56:18 +00:00
|
|
|
export function* handleEvalWorkerRequestSaga(listenerChannel: Channel<any>) {
|
|
|
|
|
while (true) {
|
|
|
|
|
const request: TMessage<any> = yield take(listenerChannel);
|
|
|
|
|
yield spawn(handleEvalWorkerMessage, request);
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
export function* lintTreeActionHandler(message: any) {
|
|
|
|
|
const { body } = message;
|
|
|
|
|
const { data } = body;
|
2023-07-05 13:34:03 +00:00
|
|
|
const { configTree, unevalTree } = data as LintTreeSagaRequestData;
|
2023-01-16 11:56:18 +00:00
|
|
|
yield put({
|
|
|
|
|
type: ReduxActionTypes.LINT_TREE,
|
|
|
|
|
payload: {
|
2023-04-03 10:41:15 +00:00
|
|
|
unevalTree,
|
|
|
|
|
configTree,
|
2023-01-16 11:56:18 +00:00
|
|
|
},
|
|
|
|
|
});
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
export function* processLogsHandler(message: any) {
|
|
|
|
|
const { body } = message;
|
|
|
|
|
const { data } = body;
|
2023-02-11 18:33:20 +00:00
|
|
|
yield call(storeLogs, data);
|
2023-01-16 11:56:18 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
export function* processJSFunctionExecution(message: any) {
|
|
|
|
|
const { body } = message;
|
2023-01-28 13:12:11 +00:00
|
|
|
const {
|
|
|
|
|
data: { JSExecutionData, JSExecutionErrors },
|
|
|
|
|
} = body;
|
|
|
|
|
const {
|
|
|
|
|
sortedData,
|
|
|
|
|
sortedErrors,
|
|
|
|
|
}: {
|
|
|
|
|
sortedData: BatchedJSExecutionData;
|
|
|
|
|
sortedErrors: BatchedJSExecutionErrors;
|
2023-02-11 18:33:20 +00:00
|
|
|
} = yield* sortJSExecutionDataByCollectionId(
|
2023-01-28 13:12:11 +00:00
|
|
|
JSExecutionData,
|
|
|
|
|
JSExecutionErrors,
|
2023-01-16 11:56:18 +00:00
|
|
|
);
|
2023-01-28 13:12:11 +00:00
|
|
|
if (!isEmpty(sortedData)) {
|
|
|
|
|
yield put({
|
|
|
|
|
type: ReduxActionTypes.SET_JS_FUNCTION_EXECUTION_DATA,
|
|
|
|
|
payload: sortedData,
|
|
|
|
|
});
|
|
|
|
|
}
|
|
|
|
|
if (!isEmpty(sortedErrors)) {
|
|
|
|
|
yield put({
|
|
|
|
|
type: ReduxActionTypes.SET_JS_FUNCTION_EXECUTION_ERRORS,
|
|
|
|
|
payload: sortedErrors,
|
|
|
|
|
});
|
|
|
|
|
}
|
2023-01-16 11:56:18 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
export function* processTriggerHandler(message: any) {
|
|
|
|
|
const { body } = message;
|
|
|
|
|
const { data } = body;
|
|
|
|
|
const { eventType, trigger, triggerMeta } = data;
|
|
|
|
|
const { messageType } = message;
|
|
|
|
|
log.debug({ trigger: data.trigger });
|
|
|
|
|
const result: ResponsePayload = yield call(
|
|
|
|
|
executeTriggerRequestSaga,
|
|
|
|
|
trigger,
|
|
|
|
|
eventType,
|
|
|
|
|
triggerMeta,
|
|
|
|
|
);
|
|
|
|
|
if (messageType === MessageType.REQUEST)
|
|
|
|
|
yield call(evalWorker.respond, message.messageId, result);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
export function* handleEvalWorkerMessage(message: TMessage<any>) {
|
|
|
|
|
const { body } = message;
|
|
|
|
|
const { data, method } = body;
|
|
|
|
|
switch (method) {
|
|
|
|
|
case MAIN_THREAD_ACTION.LINT_TREE: {
|
2023-02-11 18:33:20 +00:00
|
|
|
yield call(lintTreeActionHandler, message);
|
2023-01-16 11:56:18 +00:00
|
|
|
break;
|
|
|
|
|
}
|
|
|
|
|
case MAIN_THREAD_ACTION.PROCESS_LOGS: {
|
2023-02-11 18:33:20 +00:00
|
|
|
yield call(processLogsHandler, message);
|
2023-01-16 11:56:18 +00:00
|
|
|
break;
|
|
|
|
|
}
|
|
|
|
|
case MAIN_THREAD_ACTION.PROCESS_JS_FUNCTION_EXECUTION: {
|
2023-02-11 18:33:20 +00:00
|
|
|
yield call(processJSFunctionExecution, message);
|
2023-01-16 11:56:18 +00:00
|
|
|
break;
|
|
|
|
|
}
|
|
|
|
|
case MAIN_THREAD_ACTION.PROCESS_TRIGGER: {
|
2023-02-11 18:33:20 +00:00
|
|
|
yield call(processTriggerHandler, message);
|
2023-01-16 11:56:18 +00:00
|
|
|
break;
|
|
|
|
|
}
|
|
|
|
|
case MAIN_THREAD_ACTION.PROCESS_STORE_UPDATES: {
|
|
|
|
|
yield call(handleStoreOperations, data);
|
|
|
|
|
break;
|
|
|
|
|
}
|
|
|
|
|
case MAIN_THREAD_ACTION.LOG_JS_FUNCTION_EXECUTION: {
|
2023-07-27 11:07:56 +00:00
|
|
|
yield call(logJSFunctionExecution, message);
|
2023-01-16 11:56:18 +00:00
|
|
|
break;
|
|
|
|
|
}
|
2023-02-11 18:33:20 +00:00
|
|
|
case MAIN_THREAD_ACTION.PROCESS_BATCHED_TRIGGERS: {
|
|
|
|
|
const batchedTriggers = data;
|
|
|
|
|
yield all(
|
|
|
|
|
batchedTriggers.map((data: any) => {
|
|
|
|
|
const { eventType, trigger, triggerMeta } = data;
|
|
|
|
|
return call(
|
|
|
|
|
executeTriggerRequestSaga,
|
|
|
|
|
trigger,
|
|
|
|
|
eventType,
|
|
|
|
|
triggerMeta,
|
|
|
|
|
);
|
|
|
|
|
}),
|
|
|
|
|
);
|
|
|
|
|
break;
|
|
|
|
|
}
|
2023-04-07 07:41:36 +00:00
|
|
|
case MAIN_THREAD_ACTION.UPDATE_DATATREE: {
|
|
|
|
|
const { unevalTree, workerResponse } = data as UpdateDataTreeMessageData;
|
|
|
|
|
yield call(updateDataTreeHandler, {
|
|
|
|
|
evalTreeResponse: workerResponse as EvalTreeResponseData,
|
|
|
|
|
unevalTree,
|
|
|
|
|
requiresLogging: false,
|
|
|
|
|
});
|
2023-06-23 10:42:27 +00:00
|
|
|
break;
|
|
|
|
|
}
|
2023-07-08 14:07:26 +00:00
|
|
|
|
2023-06-23 10:42:27 +00:00
|
|
|
case MAIN_THREAD_ACTION.PROCESS_JS_VAR_MUTATION_EVENTS: {
|
|
|
|
|
const jsVarMutatedEvents: JSVarMutatedEvents = data;
|
|
|
|
|
yield call(logJSVarMutationEvent, jsVarMutatedEvents);
|
2023-04-07 07:41:36 +00:00
|
|
|
}
|
2023-01-16 11:56:18 +00:00
|
|
|
}
|
2023-02-21 04:27:56 +00:00
|
|
|
|
2023-01-16 11:56:18 +00:00
|
|
|
yield call(evalErrorHandler, data?.errors || []);
|
|
|
|
|
}
|