## Description This PR introduces a new architecture, making evaluation and linting independent. <img width="500" alt="Screenshot 2023-07-04 at 17 24 40" src="https://github.com/appsmithorg/appsmith/assets/46670083/00b1eab9-cd79-4442-b51a-5345c2d6c4da"> In the previous architecture, one dependency graph was used to hold the relationship between entities in the application and subsequently, the "evaluation order" and "paths to lint" were generated. Although similar, the dependency graph required for evaluation and linting differ. For example, trigger fields should not depend on any other entity/entity path in the eval's dependency graph since they are not reactive. This is not the case for the linting dependency graph. ## Performance - This PR introduces "lint only" actions. These actions trigger linting, but not evaluation. For example, UPDATE_JS_ACTION_BODY_INIT (which is fired immediately after a user edits the body of a JS Object). Since linting fires without waiting for a successful update on the server, **response time decreases by 40%** (from 2s to 1.2s). - Reduction in time taken to generate paths requiring linting. <img width="715" alt="Screenshot 2023-07-04 at 18 10 52" src="https://github.com/appsmithorg/appsmith/assets/46670083/d73a4bfc-de73-4fa7-bdca-af1e5d8ce8a1"> #### PR fixes following issue(s) Fixes #23447 Fixes #23166 Fixes #24194 Fixes #23720 Fixes #23868 Fixes #21895 Latest DP: https://appsmith-r3f9e325p-get-appsmith.vercel.app/ #### Type of change - Chore (housekeeping or task changes that don't impact user perception) ## Testing > #### How Has This Been Tested? - [x] Manual - [ ] Jest - [ ] Cypress > > #### Test Plan https://github.com/appsmithorg/appsmith/pull/23865#issuecomment-1606738633 > > #### Issues raised during DP testing https://github.com/appsmithorg/appsmith/pull/23865#issuecomment-1608779227 response: https://github.com/appsmithorg/appsmith/pull/23865#issuecomment-1619677033 > > > ## 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/Test-plan-implementation#speedbreaker-features-to-consider-for-every-change) have been covered - [ ] Test plan covers all impacted features and [areas of interest](https://github.com/appsmithorg/TestSmith/wiki/Guidelines-for-test-plans/_edit#areas-of-interest) - [x] Test plan has been peer reviewed by project stakeholders and other QA members - [x] 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 --------- Co-authored-by: arunvjn <arun@appsmith.com> Co-authored-by: Ivan Akulov <mail@iamakulov.com>
183 lines
5.4 KiB
TypeScript
183 lines
5.4 KiB
TypeScript
import { all, call, put, spawn, take } from "redux-saga/effects";
|
|
import { ReduxActionTypes } from "@appsmith/constants/ReduxActionConstants";
|
|
import { MAIN_THREAD_ACTION } from "@appsmith/workers/Evaluation/evalWorkerActions";
|
|
import log from "loglevel";
|
|
import {
|
|
evalErrorHandler,
|
|
logJSVarMutationEvent,
|
|
} from "../sagas/PostEvaluationSagas";
|
|
import type { Channel } from "redux-saga";
|
|
import { storeLogs } from "../sagas/DebuggerSagas";
|
|
import type {
|
|
BatchedJSExecutionData,
|
|
BatchedJSExecutionErrors,
|
|
} from "reducers/entityReducers/jsActionsReducer";
|
|
import type { TMessage } from "utils/MessageUtil";
|
|
import { MessageType } from "utils/MessageUtil";
|
|
import type { ResponsePayload } from "../sagas/EvaluationsSaga";
|
|
import {
|
|
evalWorker,
|
|
executeTriggerRequestSaga,
|
|
updateDataTreeHandler,
|
|
} from "../sagas/EvaluationsSaga";
|
|
import { logJSFunctionExecution } from "@appsmith/sagas/JSFunctionExecutionSaga";
|
|
import { handleStoreOperations } from "./ActionExecution/StoreActionSaga";
|
|
import type {
|
|
EvalTreeResponseData,
|
|
JSVarMutatedEvents,
|
|
} from "workers/Evaluation/types";
|
|
import isEmpty from "lodash/isEmpty";
|
|
import type { UnEvalTree } from "entities/DataTree/dataTreeFactory";
|
|
import { sortJSExecutionDataByCollectionId } from "workers/Evaluation/JSObject/utils";
|
|
import type { LintTreeSagaRequestData } from "plugins/Linting/types";
|
|
import AnalyticsUtil from "utils/AnalyticsUtil";
|
|
export type UpdateDataTreeMessageData = {
|
|
workerResponse: EvalTreeResponseData;
|
|
unevalTree: UnEvalTree;
|
|
};
|
|
|
|
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;
|
|
const { configTree, unevalTree } = data as LintTreeSagaRequestData;
|
|
yield put({
|
|
type: ReduxActionTypes.LINT_TREE,
|
|
payload: {
|
|
unevalTree,
|
|
configTree,
|
|
},
|
|
});
|
|
}
|
|
|
|
export function* processLogsHandler(message: any) {
|
|
const { body } = message;
|
|
const { data } = body;
|
|
yield call(storeLogs, data);
|
|
}
|
|
|
|
export function* processJSFunctionExecution(message: any) {
|
|
const { body } = message;
|
|
const {
|
|
data: { JSExecutionData, JSExecutionErrors },
|
|
} = body;
|
|
const {
|
|
sortedData,
|
|
sortedErrors,
|
|
}: {
|
|
sortedData: BatchedJSExecutionData;
|
|
sortedErrors: BatchedJSExecutionErrors;
|
|
} = yield* sortJSExecutionDataByCollectionId(
|
|
JSExecutionData,
|
|
JSExecutionErrors,
|
|
);
|
|
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,
|
|
});
|
|
}
|
|
}
|
|
|
|
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* handleJSExecutionLog(data: TMessage<{ data: string[] }>) {
|
|
const {
|
|
body: { data: executedFns },
|
|
} = data;
|
|
|
|
for (const executedFn of executedFns) {
|
|
AnalyticsUtil.logEvent("EXECUTE_ACTION", {
|
|
type: "JS",
|
|
name: executedFn,
|
|
});
|
|
}
|
|
yield call(logJSFunctionExecution, data);
|
|
}
|
|
|
|
export function* handleEvalWorkerMessage(message: TMessage<any>) {
|
|
const { body } = message;
|
|
const { data, method } = body;
|
|
switch (method) {
|
|
case MAIN_THREAD_ACTION.LINT_TREE: {
|
|
yield call(lintTreeActionHandler, message);
|
|
break;
|
|
}
|
|
case MAIN_THREAD_ACTION.PROCESS_LOGS: {
|
|
yield call(processLogsHandler, message);
|
|
break;
|
|
}
|
|
case MAIN_THREAD_ACTION.PROCESS_JS_FUNCTION_EXECUTION: {
|
|
yield call(processJSFunctionExecution, message);
|
|
break;
|
|
}
|
|
case MAIN_THREAD_ACTION.PROCESS_TRIGGER: {
|
|
yield call(processTriggerHandler, message);
|
|
break;
|
|
}
|
|
case MAIN_THREAD_ACTION.PROCESS_STORE_UPDATES: {
|
|
yield call(handleStoreOperations, data);
|
|
break;
|
|
}
|
|
case MAIN_THREAD_ACTION.LOG_JS_FUNCTION_EXECUTION: {
|
|
yield call(handleJSExecutionLog, message);
|
|
break;
|
|
}
|
|
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;
|
|
}
|
|
case MAIN_THREAD_ACTION.UPDATE_DATATREE: {
|
|
const { unevalTree, workerResponse } = data as UpdateDataTreeMessageData;
|
|
yield call(updateDataTreeHandler, {
|
|
evalTreeResponse: workerResponse as EvalTreeResponseData,
|
|
unevalTree,
|
|
requiresLogging: false,
|
|
});
|
|
break;
|
|
}
|
|
case MAIN_THREAD_ACTION.PROCESS_JS_VAR_MUTATION_EVENTS: {
|
|
const jsVarMutatedEvents: JSVarMutatedEvents = data;
|
|
yield call(logJSVarMutationEvent, jsVarMutatedEvents);
|
|
}
|
|
}
|
|
|
|
yield call(evalErrorHandler, data?.errors || []);
|
|
}
|