## Description We are constraining the diff between the old dataTree and the newDataTree to its only affected nodes. The affected nodes list is the evalOrder, unevalUpdates and updatedValuePaths (which represents localStorage and setter updates). Through limiting the diff to the affected node list this should help in reducing the diff computation latency and overall improve the performance of each evaluation cycle. We are also cleaning up code related to compressing and decompressing updates since we deprecated that functionality. Fixes #31272 ## Automation /ok-to-test tags="@tag.All" ### 🔍 Cypress test results <!-- This is an auto-generated comment: Cypress test results --> > [!IMPORTANT] > Workflow run: <https://github.com/appsmithorg/appsmith/actions/runs/8447023192> > Commit: `cb925afbb99577947fbc7233a35e4454223b402a` > Cypress dashboard url: <a href="https://internal.appsmith.com/app/cypress-dashboard/rundetails-65890b3c81d7400d08fa9ee5?branch=master&workflowId=8447023192&attempt=2" target="_blank">Click here!</a> > All cypress tests have passed 🎉🎉🎉 <!-- end of auto-generated comment: Cypress test results --> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **New Features** - Introduced new logic for handling widget state updates efficiently. - Enhanced evaluation logic to support optimized diff updates and serialization. - Improved data tree generation for error handling and evaluation order. - **Bug Fixes** - Addressed issues in generating optimized updates for large collections and handling `undefined` values. - Fixed Cypress tests in the "PgAdmin Clone App" spec for more reliable interaction with UI elements. - **Refactor** - Simplified the logic for widget state cleanup and evaluation paths handling. - Removed unused variables and functions related to widget meta properties and evaluation paths. - **Tests** - Added new spec file `PgAdmin_spec.js` to Cypress limited tests for client-side regression testing. - **Chores** - Updated type imports across various files to reflect changes in evaluation logic. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
122 lines
3.5 KiB
TypeScript
122 lines
3.5 KiB
TypeScript
import type { ReduxAction } from "@appsmith/constants/ReduxActionConstants";
|
|
import { ReduxActionTypes } from "@appsmith/constants/ReduxActionConstants";
|
|
import { intersection } from "lodash";
|
|
import type { DependencyMap } from "utils/DynamicBindingUtils";
|
|
import type { QueryActionConfig } from "entities/Action";
|
|
import type { DatasourceConfiguration } from "entities/Datasource";
|
|
import type { DiffWithNewTreeState } from "workers/Evaluation/helpers";
|
|
import {
|
|
EVALUATE_REDUX_ACTIONS,
|
|
EVAL_AND_LINT_REDUX_ACTIONS,
|
|
LINT_REDUX_ACTIONS,
|
|
LOG_REDUX_ACTIONS,
|
|
} from "@appsmith/actions/evaluationActionsList";
|
|
|
|
export const shouldTriggerEvaluation = (action: ReduxAction<unknown>) => {
|
|
return (
|
|
shouldProcessAction(action) && EVALUATE_REDUX_ACTIONS.includes(action.type)
|
|
);
|
|
};
|
|
export const shouldTriggerLinting = (action: ReduxAction<unknown>) => {
|
|
return shouldProcessAction(action) && !!LINT_REDUX_ACTIONS[action.type];
|
|
};
|
|
|
|
export const getAllActionTypes = (action: ReduxAction<unknown>) => {
|
|
if (
|
|
action.type === ReduxActionTypes.BATCH_UPDATES_SUCCESS &&
|
|
Array.isArray(action.payload)
|
|
) {
|
|
const batchedActionTypes = action.payload.map(
|
|
(batchedAction) => batchedAction.type as string,
|
|
);
|
|
return batchedActionTypes;
|
|
}
|
|
return [action.type];
|
|
};
|
|
|
|
export const shouldProcessAction = (action: ReduxAction<unknown>) => {
|
|
const actionTypes = getAllActionTypes(action);
|
|
|
|
return intersection(EVAL_AND_LINT_REDUX_ACTIONS, actionTypes).length > 0;
|
|
};
|
|
|
|
export function shouldLog(action: ReduxAction<unknown>) {
|
|
if (
|
|
action.type === ReduxActionTypes.BATCH_UPDATES_SUCCESS &&
|
|
Array.isArray(action.payload)
|
|
) {
|
|
const batchedActionTypes = action.payload.map(
|
|
(batchedAction) => batchedAction.type,
|
|
);
|
|
return batchedActionTypes.some(
|
|
(actionType) => LOG_REDUX_ACTIONS[actionType],
|
|
);
|
|
}
|
|
|
|
return LOG_REDUX_ACTIONS[action.type];
|
|
}
|
|
|
|
export const setEvaluatedTree = (
|
|
updates: DiffWithNewTreeState[],
|
|
): ReduxAction<{ updates: DiffWithNewTreeState[] }> => {
|
|
return {
|
|
type: ReduxActionTypes.SET_EVALUATED_TREE,
|
|
payload: { updates },
|
|
};
|
|
};
|
|
|
|
export const setDependencyMap = (
|
|
inverseDependencyMap: DependencyMap,
|
|
): ReduxAction<{ inverseDependencyMap: DependencyMap }> => {
|
|
return {
|
|
type: ReduxActionTypes.SET_EVALUATION_INVERSE_DEPENDENCY_MAP,
|
|
payload: { inverseDependencyMap },
|
|
};
|
|
};
|
|
|
|
// Called when a form is being setup, for setting up the base condition evaluations for the form
|
|
export const initFormEvaluations = (
|
|
editorConfig: any,
|
|
settingConfig: any,
|
|
formId: string,
|
|
) => {
|
|
return {
|
|
type: ReduxActionTypes.INIT_FORM_EVALUATION,
|
|
payload: { editorConfig, settingConfig, formId },
|
|
};
|
|
};
|
|
|
|
// Called when there is change in the data of the form, re evaluates the whole form
|
|
export const startFormEvaluations = (
|
|
formId: string,
|
|
formData: QueryActionConfig,
|
|
datasourceId: string,
|
|
pluginId: string,
|
|
actionDiffPath?: string,
|
|
hasRouteChanged?: boolean,
|
|
datasourceConfiguration?: DatasourceConfiguration,
|
|
) => {
|
|
return {
|
|
type: ReduxActionTypes.RUN_FORM_EVALUATION,
|
|
payload: {
|
|
formId,
|
|
actionConfiguration: formData,
|
|
datasourceId,
|
|
pluginId,
|
|
actionDiffPath,
|
|
hasRouteChanged,
|
|
datasourceConfiguration,
|
|
},
|
|
};
|
|
};
|
|
|
|
// These actions require the entire tree to be re-evaluated
|
|
const FORCE_EVAL_ACTIONS = {
|
|
[ReduxActionTypes.INSTALL_LIBRARY_SUCCESS]: true,
|
|
[ReduxActionTypes.UNINSTALL_LIBRARY_SUCCESS]: true,
|
|
};
|
|
|
|
export const shouldForceEval = (action: ReduxAction<unknown>) => {
|
|
return !!FORCE_EVAL_ACTIONS[action.type];
|
|
};
|