PromucFlow_constructor/app/client/src/entities/DataTree/dataTreeWidget.ts
Rishabh Rathod 7a484fc027
fix: meta changes (non-default) also update metaHOC state (#10734)
* Reset metaHOC state on widget reset

* Pass all meta values for metaHOC reset logic

* pass only metaReducer values in meta

* fix unit test

* Add test
2022-02-26 02:16:04 +05:30

147 lines
4.8 KiB
TypeScript

import WidgetFactory from "utils/WidgetFactory";
import { getAllPathsFromPropertyConfig } from "entities/Widget/utils";
import { getEntityDynamicBindingPathList } from "utils/DynamicBindingUtils";
import _ from "lodash";
import { FlattenedWidgetProps } from "reducers/entityReducers/canvasWidgetsReducer";
import { setOverridingProperty } from "./utils";
import {
OverridingPropertyPaths,
PropertyOverrideDependency,
OverridingPropertyType,
DataTreeWidget,
ENTITY_TYPE,
} from "./dataTreeFactory";
export const generateDataTreeWidget = (
widget: FlattenedWidgetProps,
widgetMetaProps: Record<string, unknown> = {},
): DataTreeWidget => {
const derivedProps: any = {};
const blockedDerivedProps: Record<string, true> = {};
const unInitializedDefaultProps: Record<string, undefined> = {};
const propertyOverrideDependency: PropertyOverrideDependency = {};
const overridingPropertyPaths: OverridingPropertyPaths = {};
const defaultMetaProps = WidgetFactory.getWidgetMetaPropertiesMap(
widget.type,
);
const derivedPropertyMap = WidgetFactory.getWidgetDerivedPropertiesMap(
widget.type,
);
const defaultProps = WidgetFactory.getWidgetDefaultPropertiesMap(widget.type);
const propertyPaneConfigs = WidgetFactory.getWidgetPropertyPaneConfig(
widget.type,
);
const dynamicBindingPathList = getEntityDynamicBindingPathList(widget);
// Ensure all dynamic bindings are strings as they will be evaluated
dynamicBindingPathList.forEach((dynamicPath) => {
const propertyPath = dynamicPath.key;
const propertyValue = _.get(widget, propertyPath);
if (_.isObject(propertyValue)) {
// Stringify this because composite controls may have bindings in the sub controls
_.set(widget, propertyPath, JSON.stringify(propertyValue));
}
});
// Derived props are stored in different maps for further treatment
Object.keys(derivedPropertyMap).forEach((propertyName) => {
// TODO regex is too greedy
// Replace the references to `this` with the widget name reference
// in the derived property bindings
derivedProps[propertyName] = derivedPropertyMap[propertyName].replace(
/this./g,
`${widget.widgetName}.`,
);
// Add these to the dynamicBindingPathList as well
dynamicBindingPathList.push({
key: propertyName,
});
});
Object.keys(derivedProps).forEach((propertyName) => {
// Do not log errors for the derived property bindings
blockedDerivedProps[propertyName] = true;
});
const overridingMetaPropsMap: Record<string, boolean> = {};
Object.entries(defaultProps).forEach(
([propertyName, defaultPropertyName]) => {
if (!(defaultPropertyName in widget)) {
unInitializedDefaultProps[defaultPropertyName] = undefined;
}
// defaultProperty on eval needs to override the widget's property eg: defaultText overrides text
setOverridingProperty({
propertyOverrideDependency,
overridingPropertyPaths,
value: defaultPropertyName,
key: propertyName,
type: OverridingPropertyType.DEFAULT,
});
if (propertyName in defaultMetaProps) {
// Overriding properties will override the values of a property when evaluated
setOverridingProperty({
propertyOverrideDependency,
overridingPropertyPaths,
value: `meta.${propertyName}`,
key: propertyName,
type: OverridingPropertyType.META,
});
overridingMetaPropsMap[propertyName] = true;
}
},
);
const overridingMetaProps: Record<string, unknown> = {};
// overridingMetaProps has all meta property value either from metaReducer or default set by widget whose dependent property also has default property.
Object.entries(defaultMetaProps).forEach(([key, value]) => {
if (overridingMetaPropsMap[key]) {
overridingMetaProps[key] =
key in widgetMetaProps ? widgetMetaProps[key] : value;
}
});
const {
bindingPaths,
triggerPaths,
validationPaths,
} = getAllPathsFromPropertyConfig(widget, propertyPaneConfigs, {
...derivedPropertyMap,
...defaultMetaProps,
...unInitializedDefaultProps,
..._.keyBy(dynamicBindingPathList, "key"),
...overridingPropertyPaths,
});
return {
...widget,
...unInitializedDefaultProps,
...defaultMetaProps,
...widgetMetaProps,
...derivedProps,
defaultProps,
defaultMetaProps: Object.keys(defaultMetaProps),
dynamicBindingPathList,
logBlackList: {
...widget.logBlackList,
...blockedDerivedProps,
},
meta: {
...overridingMetaProps,
...widgetMetaProps,
},
propertyOverrideDependency,
overridingPropertyPaths,
bindingPaths,
triggerPaths,
validationPaths,
ENTITY_TYPE: ENTITY_TYPE.WIDGET,
privateWidgets: {
...widget.privateWidgets,
},
};
};