## Description This is the second phase of the split data tree. In the previous version, we collected all config paths in each entity and put them in the `__config__` property. All those config properties do get inserted into final data tree which we don't need at all. As part of this change, we will be creating another tree i.e **'configTree'** which will contain all config of each entity. unEvalTree is split into 2 trees => 1. unEvalTree 2. configTree Example: previous unEvalTree Api1 content <img width="1766" alt="image" src="https://user-images.githubusercontent.com/7846888/215990868-0b095421-e7b8-44bc-89aa-065b35e237d6.png"> After this change unEvalTree Api1 content <img width="1758" alt="image" src="https://user-images.githubusercontent.com/7846888/215991045-506fb10a-645a-4aad-8e77-0f3786a86977.png"> Note- above example doesn't have '__config__' property configTree Api1 content <img width="1760" alt="image" src="https://user-images.githubusercontent.com/7846888/215991169-a2e03443-5d6a-4ff1-97c5-a12593e46395.png"> ## Type of change - Chore (housekeeping or task changes that don't impact user perception) - #11351 ## How Has This Been Tested? - Manual - 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: - [ ] 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: Aishwarya UR <aishwarya@appsmith.com>
167 lines
4.8 KiB
TypeScript
167 lines
4.8 KiB
TypeScript
import type {
|
|
CanvasWidgetsReduxState,
|
|
FlattenedWidgetProps,
|
|
} from "reducers/entityReducers/canvasWidgetsReducer";
|
|
import type {
|
|
ConfigTree,
|
|
DataTree,
|
|
WidgetEntity,
|
|
WidgetEntityConfig,
|
|
} from "entities/DataTree/dataTreeFactory";
|
|
import { ENTITY_TYPE } from "entities/DataTree/dataTreeFactory";
|
|
import { pick } from "lodash";
|
|
import {
|
|
WIDGET_DSL_STRUCTURE_PROPS,
|
|
WIDGET_STATIC_PROPS,
|
|
} from "constants/WidgetConstants";
|
|
import WidgetFactory from "./WidgetFactory";
|
|
import type { WidgetProps } from "widgets/BaseWidget";
|
|
import type { LoadingEntitiesState } from "reducers/evaluationReducers/loadingEntitiesReducer";
|
|
import type { MetaWidgetsReduxState } from "reducers/entityReducers/metaWidgetsReducer";
|
|
|
|
export const createCanvasWidget = (
|
|
canvasWidget: FlattenedWidgetProps,
|
|
evaluatedWidget: WidgetEntity,
|
|
evaluatedWidgetConfig: WidgetEntityConfig,
|
|
specificChildProps?: string[],
|
|
) => {
|
|
/**
|
|
* WIDGET_DSL_STRUCTURE_PROPS is required for Building the List widget meta widgets
|
|
* requiresFlatWidgetChildren and hasMetaWidgets are the keys required.
|
|
*/
|
|
|
|
const widgetStaticProps = pick(canvasWidget, [
|
|
...Object.keys({ ...WIDGET_STATIC_PROPS, ...WIDGET_DSL_STRUCTURE_PROPS }),
|
|
...(canvasWidget.additionalStaticProps || []),
|
|
]);
|
|
|
|
//Pick required only contents for specific widgets
|
|
const evaluatedStaticProps = specificChildProps
|
|
? pick(evaluatedWidget, specificChildProps)
|
|
: evaluatedWidget;
|
|
|
|
return {
|
|
...evaluatedStaticProps,
|
|
...evaluatedWidgetConfig,
|
|
...widgetStaticProps,
|
|
} as any;
|
|
};
|
|
|
|
const WidgetTypes = WidgetFactory.widgetTypes;
|
|
export const createLoadingWidget = (
|
|
canvasWidget: FlattenedWidgetProps,
|
|
): WidgetEntity => {
|
|
const widgetStaticProps = pick(
|
|
canvasWidget,
|
|
Object.keys(WIDGET_STATIC_PROPS),
|
|
) as WidgetProps;
|
|
return {
|
|
...widgetStaticProps,
|
|
type: WidgetTypes.SKELETON_WIDGET,
|
|
ENTITY_TYPE: ENTITY_TYPE.WIDGET,
|
|
bindingPaths: {},
|
|
reactivePaths: {},
|
|
triggerPaths: {},
|
|
validationPaths: {},
|
|
logBlackList: {},
|
|
isLoading: true,
|
|
propertyOverrideDependency: {},
|
|
overridingPropertyPaths: {},
|
|
privateWidgets: {},
|
|
meta: {},
|
|
};
|
|
};
|
|
|
|
/**
|
|
* Method to build a child widget tree
|
|
* This method is used to build the child widgets array for widgets like Form, or List widget,
|
|
* That need to know the state of its child or grandChild to derive properties
|
|
* This can be replaced with deived properties of the individual widgets
|
|
*
|
|
* @param canvasWidgets
|
|
* @param evaluatedDataTree
|
|
* @param loadingEntities
|
|
* @param widgetId
|
|
* @param requiredWidgetProps
|
|
* @returns
|
|
*/
|
|
export function buildChildWidgetTree(
|
|
canvasWidgets: CanvasWidgetsReduxState,
|
|
metaWidgets: MetaWidgetsReduxState,
|
|
evaluatedDataTree: DataTree,
|
|
loadingEntities: LoadingEntitiesState,
|
|
configTree: ConfigTree,
|
|
widgetId: string,
|
|
requiredWidgetProps?: string[],
|
|
) {
|
|
const parentWidget = canvasWidgets[widgetId] || metaWidgets[widgetId];
|
|
|
|
// specificChildProps are the only properties required by the parent to derive it's properties
|
|
const specificChildProps =
|
|
requiredWidgetProps || getWidgetSpecificChildProps(parentWidget.type);
|
|
|
|
if (parentWidget.children) {
|
|
return parentWidget.children.map((childWidgetId) => {
|
|
const childWidget =
|
|
canvasWidgets[childWidgetId] || metaWidgets[childWidgetId];
|
|
const evaluatedWidget = evaluatedDataTree[
|
|
childWidget.widgetName
|
|
] as WidgetEntity;
|
|
const evaluatedWidgetConfig = configTree[
|
|
childWidget.widgetName
|
|
] as WidgetEntityConfig;
|
|
const widget = evaluatedWidget
|
|
? createCanvasWidget(
|
|
childWidget,
|
|
evaluatedWidget,
|
|
evaluatedWidgetConfig,
|
|
specificChildProps,
|
|
)
|
|
: createLoadingWidget(childWidget);
|
|
|
|
widget.isLoading = loadingEntities.has(childWidget.widgetName);
|
|
|
|
if (widget?.children?.length > 0) {
|
|
widget.children = buildChildWidgetTree(
|
|
canvasWidgets,
|
|
metaWidgets,
|
|
evaluatedDataTree,
|
|
loadingEntities,
|
|
configTree,
|
|
childWidgetId,
|
|
specificChildProps,
|
|
);
|
|
}
|
|
|
|
return widget;
|
|
});
|
|
}
|
|
|
|
return [];
|
|
}
|
|
|
|
export function buildFlattenedChildCanvasWidgets(
|
|
canvasWidgets: CanvasWidgetsReduxState,
|
|
parentWidgetId: string,
|
|
flattenedChildCanvasWidgets: Record<string, FlattenedWidgetProps> = {},
|
|
) {
|
|
const parentWidget = canvasWidgets[parentWidgetId];
|
|
parentWidget?.children?.forEach((childId) => {
|
|
flattenedChildCanvasWidgets[childId] = canvasWidgets[childId];
|
|
|
|
buildFlattenedChildCanvasWidgets(
|
|
canvasWidgets,
|
|
childId,
|
|
flattenedChildCanvasWidgets,
|
|
);
|
|
});
|
|
|
|
return flattenedChildCanvasWidgets;
|
|
}
|
|
|
|
function getWidgetSpecificChildProps(type: string) {
|
|
if (type === "FORM_WIDGET") {
|
|
return ["value", "isDirty", "isValid", "isLoading", "children"];
|
|
}
|
|
}
|