## Description - Remove the config objects from widget and config maps from the widget factory. - Introduce methods in widget development API to dynamically fetch this items. - freeze the widget configuration. #### PR fixes following issue(s) Fixes https://github.com/appsmithorg/appsmith/issues/26008 > if no issue exists, please create an issue and ask the maintainers about this first > > #### 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 > Please delete options that are not relevant. - Bug fix (non-breaking change which fixes an issue) - New feature (non-breaking change which adds functionality) - Breaking change (fix or feature that would cause existing functionality to not work as expected) - Chore (housekeeping or task changes that don't impact user perception) - This change requires a documentation update > > > ## 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 - [x] 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: - [ ] [Speedbreak features](https://github.com/appsmithorg/TestSmith/wiki/Guidelines-for-test-plans#speedbreakers-) have been covered - [x] 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 - [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
91 lines
2.4 KiB
TypeScript
91 lines
2.4 KiB
TypeScript
import { pick } from "lodash";
|
|
|
|
import type {
|
|
CanvasStructure,
|
|
DSL,
|
|
} from "reducers/uiReducers/pageCanvasStructureReducer";
|
|
import type {
|
|
CanvasWidgetStructure,
|
|
FlattenedWidgetProps,
|
|
} from "WidgetProvider/constants";
|
|
import { WIDGET_DSL_STRUCTURE_PROPS } from "constants/WidgetConstants";
|
|
|
|
type DenormalizeOptions = {
|
|
widgetTypeForHaltingRecursion?: string;
|
|
};
|
|
|
|
export const compareAndGenerateImmutableCanvasStructure = (
|
|
original: CanvasStructure,
|
|
current: DSL,
|
|
) => {
|
|
const newStructure = getCanvasStructureFromDSL(current);
|
|
if (JSON.stringify(newStructure) === JSON.stringify(original)) {
|
|
return original;
|
|
}
|
|
return newStructure;
|
|
};
|
|
|
|
const getCanvasStructureFromDSL = (dsl: DSL): CanvasStructure => {
|
|
let children = dsl.children;
|
|
let structureChildren: CanvasStructure[] | undefined = undefined;
|
|
// Todo(abhinav): abstraction leak
|
|
if (dsl.type === "TABS_WIDGET") {
|
|
if (children && children.length > 0) {
|
|
structureChildren = children.map((childTab) => ({
|
|
widgetName: childTab.tabName,
|
|
widgetId: childTab.widgetId,
|
|
type: "TABS_WIDGET",
|
|
children: childTab.children,
|
|
}));
|
|
}
|
|
} else if (children && children.length === 1) {
|
|
if (children[0].type === "CANVAS_WIDGET") {
|
|
children = children[0].children;
|
|
}
|
|
}
|
|
|
|
return {
|
|
widgetId: dsl.widgetId,
|
|
widgetName: dsl.widgetName,
|
|
type: dsl.type,
|
|
children:
|
|
structureChildren ||
|
|
children?.filter(Boolean).map(getCanvasStructureFromDSL),
|
|
};
|
|
};
|
|
|
|
/**
|
|
* Generate dsl type skeletal structure from widgets
|
|
* @param rootWidgetId
|
|
* @param widgets
|
|
* @returns
|
|
*/
|
|
export function denormalize(
|
|
rootWidgetId: string,
|
|
widgets: Record<string, FlattenedWidgetProps>,
|
|
options?: DenormalizeOptions,
|
|
): CanvasWidgetStructure {
|
|
const { widgetTypeForHaltingRecursion } = options || {};
|
|
const rootWidget = widgets[rootWidgetId];
|
|
let children;
|
|
|
|
/**
|
|
* For certain widget, we do not want to denormalize further,
|
|
* like for the List v2, where a another inner list widget is encountered
|
|
* we would want to halt the recursion.
|
|
* */
|
|
if (widgetTypeForHaltingRecursion !== rootWidget?.type) {
|
|
children = (rootWidget?.children || []).map((childId) =>
|
|
denormalize(childId, widgets, options),
|
|
);
|
|
}
|
|
|
|
const staticProps = Object.keys(WIDGET_DSL_STRUCTURE_PROPS);
|
|
|
|
const structure = pick(rootWidget, staticProps) as CanvasWidgetStructure;
|
|
|
|
structure.children = children;
|
|
|
|
return structure;
|
|
}
|