## Description UnEvalTree, dataTree and configTree's entities needs to be extended on EE to accommodate module inputs and different types of modules hence the separation. I have added few more sanity checks in the existing code which were throwing errors/warning on EE. #### PR fixes following issue(s) Fixes # (issue number) #### 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 - Chore (housekeeping or task changes that don't impact user perception) > > > ## 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
186 lines
5.4 KiB
TypeScript
186 lines
5.4 KiB
TypeScript
import type {
|
|
CanvasWidgetsReduxState,
|
|
FlattenedWidgetProps,
|
|
} from "reducers/entityReducers/canvasWidgetsReducer";
|
|
import type {
|
|
WidgetEntity,
|
|
WidgetEntityConfig,
|
|
} from "@appsmith/entities/DataTree/types";
|
|
import type { ConfigTree, DataTree } from "entities/DataTree/dataTreeTypes";
|
|
import { ENTITY_TYPE_VALUE } from "entities/DataTree/dataTreeFactory";
|
|
import { pick } from "lodash";
|
|
import {
|
|
WIDGET_DSL_STRUCTURE_PROPS,
|
|
WIDGET_STATIC_PROPS,
|
|
} from "constants/WidgetConstants";
|
|
import WidgetFactory from "../WidgetProvider/factory";
|
|
import type { WidgetProps } from "widgets/BaseWidget";
|
|
import type { LoadingEntitiesState } from "reducers/evaluationReducers/loadingEntitiesReducer";
|
|
import type { MetaWidgetsReduxState } from "reducers/entityReducers/metaWidgetsReducer";
|
|
import type { WidgetError } from "widgets/BaseWidget";
|
|
import { get } from "lodash";
|
|
import type { DataTreeError } from "utils/DynamicBindingUtils";
|
|
import { EVAL_ERROR_PATH } from "utils/DynamicBindingUtils";
|
|
|
|
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;
|
|
|
|
const widgetProps = {
|
|
...evaluatedStaticProps,
|
|
...evaluatedWidgetConfig,
|
|
...widgetStaticProps,
|
|
} as any;
|
|
widgetProps.errors = widgetErrorsFromStaticProps(evaluatedStaticProps);
|
|
return widgetProps;
|
|
};
|
|
|
|
function widgetErrorsFromStaticProps(props: Record<string, unknown>) {
|
|
/**
|
|
* Evaluation Error Map
|
|
* {
|
|
widgetPropertyName : DataTreeError[]
|
|
}
|
|
*/
|
|
|
|
const evaluationErrorMap = get(props, EVAL_ERROR_PATH, {}) as Record<
|
|
string,
|
|
DataTreeError[]
|
|
>;
|
|
const widgetErrors: WidgetError[] = [];
|
|
|
|
Object.keys(evaluationErrorMap).forEach((propertyPath) => {
|
|
const propertyErrors = evaluationErrorMap[propertyPath];
|
|
|
|
propertyErrors.forEach((evalError) => {
|
|
const widgetError: WidgetError = {
|
|
name: evalError.errorMessage.name,
|
|
message: evalError.errorMessage.message,
|
|
stack: evalError.raw,
|
|
type: "property",
|
|
path: propertyPath,
|
|
};
|
|
|
|
widgetErrors.push(widgetError);
|
|
});
|
|
});
|
|
|
|
return widgetErrors;
|
|
}
|
|
|
|
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_VALUE.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 [];
|
|
}
|
|
|
|
function getWidgetSpecificChildProps(type: string) {
|
|
if (type === "FORM_WIDGET") {
|
|
return ["value", "isDirty", "isValid", "isLoading", "children"];
|
|
}
|
|
}
|