PromucFlow_constructor/app/client/src/sagas/selectors.tsx
Ashit Rath 078cd2921d
chore: Enable meta modal widgets to render in canvas (#39652)
## Description
This PR adds support for modals within UI modules. Modals within UI
modules are created as meta widgets and modal meta widgets were not
supported.

### Changes
1. Canvas Rendering Enhancement:
- Modified FixedLayoutEditorCanvas and FixedLayoutViewerCanvas to
include meta widget children in the canvas rendering

2. Modal Widget Improvements:
    - Updated ModalWidget to handle meta widget children structures

3. Selectors:
- Created new selector getModalWidgetByName to find modals in both
regular widgets and meta widgets
    - Enhanced getWidgetIdsByType to include meta widgets in the search
    - Updated modal-related sagas to use the new selectors

4. Main Container Widget Support:
- Modified withWidgetProps to allow the main container widget to access
meta widget children even when hasMetaWidgets is false

Fixes https://github.com/appsmithorg/appsmith/issues/39287

## Automation

/ok-to-test tags="@tag.All"

### 🔍 Cypress test results
<!-- This is an auto-generated comment: Cypress test results  -->
> [!TIP]
> 🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
> Workflow run:
<https://github.com/appsmithorg/appsmith/actions/runs/13829067577>
> Commit: 15cde006ab4268e2ce9b5574dbd9be57a37287c4
> <a
href="https://internal.appsmith.com/app/cypress-dashboard/rundetails-65890b3c81d7400d08fa9ee5?branch=master&workflowId=13829067577&attempt=2"
target="_blank">Cypress dashboard</a>.
> Tags: `@tag.All`
> Spec:
> <hr>Thu, 13 Mar 2025 11:09:59 UTC
<!-- end of auto-generated comment: Cypress test results  -->


## Communication
Should the DevRel and Marketing teams inform users about this change?
- [ ] Yes
- [ ] No


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

- **Bug Fixes**
- Improved canvas rendering responsiveness, ensuring interface elements
update correctly with layout changes.
- Enhanced modal display behavior by refining widget retrieval,
resulting in more consistent interactions.

- **New Features**
- Introduced an optional modal configuration to better support
alternative widget structures.
- Updated child component handling to accommodate new meta widget
conditions within the main interface.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2025-03-13 17:08:56 +05:30

316 lines
9.1 KiB
TypeScript

import type { AppState } from "ee/reducers";
import { createSelector } from "reselect";
import memoize from "proxy-memoize";
import type {
CanvasWidgetsReduxState,
FlattenedWidgetProps,
} from "ee/reducers/entityReducers/canvasWidgetsReducer";
import type { WidgetProps } from "widgets/BaseWidget";
import _, { defaults, omit } from "lodash";
import type { WidgetType } from "constants/WidgetConstants";
import { WIDGET_PROPS_TO_SKIP_FROM_EVAL } from "constants/WidgetConstants";
import type { ActionData } from "ee/reducers/entityReducers/actionsReducer";
import type { Page } from "entities/Page";
import { getActions, getPlugins } from "ee/selectors/entitiesSelector";
import type { Plugin } from "entities/Plugin";
import type { DragDetails } from "reducers/uiReducers/dragResizeReducer";
import type { DataTreeForActionCreator } from "components/editorComponents/ActionCreator/types";
import type { MetaWidgetsReduxState } from "reducers/entityReducers/metaWidgetsReducer";
export const getWidgets = (state: AppState): CanvasWidgetsReduxState => {
return state.entities.canvasWidgets;
};
export const getWidgetsByName = createSelector(getWidgets, (widgets) => {
return _.keyBy(widgets, "widgetName");
});
export const getWidgetsForEval = createSelector(getWidgets, (widgets) => {
const widgetForEval: CanvasWidgetsReduxState = {};
for (const key of Object.keys(widgets)) {
widgetForEval[key] = omit(
widgets[key],
Object.keys(WIDGET_PROPS_TO_SKIP_FROM_EVAL),
) as FlattenedWidgetProps;
}
return widgetForEval;
});
export const getMetaWidgets = (state: AppState): MetaWidgetsReduxState => {
return state.entities.metaWidgets;
};
export const getCanvasAndMetaWidgets = createSelector(
getWidgets,
getMetaWidgets,
(canvasWidget, metaWidget) => defaults({}, canvasWidget, metaWidget),
);
export const getWidgetsMeta = (state: AppState) => state.entities.meta;
export const getIsMobileBreakPoint = (state: AppState) =>
state.ui.mainCanvas.isMobile;
export const getWidgetMetaProps = createSelector(
[getWidgetsMeta, (_state: AppState, widget: WidgetProps) => widget],
(metaState, widget: WidgetProps) => {
return metaState[widget.metaWidgetId || widget.widgetId];
},
);
export const getWidgetByID = (widgetId: string) => {
return createSelector(
getWidgets,
(canvasWidgets: { [widgetId: string]: FlattenedWidgetProps }) => {
return canvasWidgets[widgetId];
},
);
};
export const getWidget = (state: AppState, widgetId: string): WidgetProps => {
return state.entities.canvasWidgets[widgetId];
};
export const getWidgetIdsByType = createSelector(
getWidgets,
getMetaWidgets,
(_state: AppState, widgetType: WidgetType) => widgetType,
(canvasWidgets, metaWidgets, widgetType) => {
const canvasWidgetIds = Object.values(canvasWidgets)
.filter((widget: FlattenedWidgetProps) => widget.type === widgetType)
.map((widget: FlattenedWidgetProps) => widget.widgetId);
const metaWidgetIds = Object.values(metaWidgets)
.filter((widget: FlattenedWidgetProps) => widget.type === widgetType)
.map((widget: FlattenedWidgetProps) => widget.widgetId);
return [...canvasWidgetIds, ...metaWidgetIds];
},
);
export const getAllDetachedWidgetIds = memoize(
(canvasWidgets: CanvasWidgetsReduxState) => {
return Object.values(canvasWidgets)
.filter((widget: FlattenedWidgetProps) => !!widget.detachFromLayout)
.map((widget: FlattenedWidgetProps) => widget.widgetId);
},
);
export const getWidgetOptionsTree = memoize((state: AppState) =>
Object.values(state.entities.canvasWidgets)
.filter((w) => w.type !== "CANVAS_WIDGET" && w.type !== "BUTTON_WIDGET")
.map((w) => {
return {
label: w.widgetName,
id: w.widgetName,
value: `"${w.widgetName}"`,
type: w.type,
};
}),
);
export const getDataTreeForActionCreator = memoize((state: AppState) => {
const dataTree: DataTreeForActionCreator = {};
Object.keys(state.evaluations.tree).forEach((key) => {
// TODO: Fix this the next time the file is edited
// eslint-disable-next-line @typescript-eslint/no-explicit-any
const value: any = state.evaluations.tree[key];
dataTree[key] = {
meta: value?.meta || null,
ENTITY_TYPE: value?.ENTITY_TYPE || null,
type: value?.type || null,
};
});
return dataTree;
});
export const getEditorConfigs = (
state: AppState,
): { applicationId: string; pageId: string; layoutId: string } | undefined => {
const pageId = state.entities.pageList.currentPageId;
const layoutId = state.ui.editor.currentLayoutId;
const applicationId = state.ui.applications.currentApplication?.id;
if (!pageId || !layoutId || !applicationId) return undefined;
return { pageId, layoutId, applicationId };
};
export const getDefaultPageId = (state: AppState): string =>
state.entities.pageList.defaultPageId;
export const getDefaultBasePageId = (state: AppState): string =>
state.entities.pageList.defaultBasePageId;
export const getExistingWidgetNames = createSelector(
getWidgets,
(widgets: { [widgetId: string]: FlattenedWidgetProps }) => {
return Object.values(widgets).map((widget) => widget.widgetName);
},
);
export const currentPageId = (state: AppState) => {
return state.entities.pageList.currentPageId;
};
export const getExistingActionNames = createSelector(
getActions,
currentPageId,
(actions: ActionData[], pageId?: string) => {
return _.compact(
actions.map((action: ActionData) => {
return action.config.pageId === pageId ? action.config.name : undefined;
}),
);
},
);
export const getPluginIdToImageLocation = createSelector(
getPlugins,
(plugins) =>
// TODO: Fix this the next time the file is edited
// eslint-disable-next-line @typescript-eslint/no-explicit-any
plugins.reduce((acc: any, p: Plugin) => {
acc[p.id] = p.iconLocation;
return acc;
}, {}),
);
/**
* returns a objects of existing page name in data tree
*
* @param state
*/
export const getExistingPageNames = (state: AppState) => {
// TODO: Fix this the next time the file is edited
// eslint-disable-next-line @typescript-eslint/no-explicit-any
const map: Record<string, any> = {};
state.entities.pageList.pages.map((page: Page) => {
map[page.pageName] = page.pageName;
});
return map;
};
export const getWidgetByName = createSelector(
getWidgets,
getMetaWidgets,
(state: AppState, widgetName: string) => widgetName,
(widgets, metaWidgets, widgetName) => {
for (const widget of Object.values(widgets)) {
if (widget.widgetName === widgetName) {
return widget;
}
}
for (const widget of Object.values(metaWidgets)) {
if (widget.widgetName === widgetName) {
return widget;
}
}
return null;
},
);
export const getAllPageIdentities = (state: AppState) => {
return state.entities.pageList.pages.map((page) => ({
pageId: page.pageId,
basePageId: page.basePageId,
}));
};
export const getPluginIdOfPackageName = (
state: AppState,
name: string,
): string | undefined => {
const plugins = state.entities.plugins.list;
const plugin = plugins.find((plugin) => plugin.packageName === name);
if (plugin) return plugin.id;
return undefined;
};
export const getDragDetails = (state: AppState) => {
return state.ui.widgetDragResize.dragDetails;
};
export const getIsNewWidgetBeingDragged = (state: AppState) => {
const { isDragging } = state.ui.widgetDragResize;
if (!isDragging) return false;
const dragDetails: DragDetails = getDragDetails(state);
const { dragGroupActualParent: dragParent, newWidget } = dragDetails;
return !!newWidget && !dragParent;
};
export const isCurrentCanvasDragging = createSelector(
(state: AppState) => state.ui.widgetDragResize.isDragging,
getDragDetails,
(state: AppState, canvasId: string) => canvasId,
(isDragging: boolean, dragDetails: DragDetails, canvasId: string) => {
return dragDetails?.draggedOn === canvasId && isDragging;
},
);
export const getSelectedWidget = (
state: AppState,
): FlattenedWidgetProps | undefined => {
const selectedWidgetId = state.ui.widgetDragResize.lastSelectedWidget;
if (!selectedWidgetId) return;
return state.entities.canvasWidgets[selectedWidgetId];
};
export const getFocusedWidget = (state: AppState) => {
const focusedWidgetId = state.ui.widgetDragResize.focusedWidget;
if (!focusedWidgetId) return;
return state.entities.canvasWidgets[focusedWidgetId];
};
export const getWidgetImmediateChildren = createSelector(
getWidget,
(widget: WidgetProps) => {
const childrenIds: string[] = [];
if (widget === undefined) {
return [];
}
const { children = [] } = widget;
if (children && children.length) {
for (const childIndex in children) {
if (children.hasOwnProperty(childIndex)) {
const child = children[childIndex];
childrenIds.push(child);
}
}
}
return childrenIds;
},
);
export const getPluginIdToPlugin = createSelector(getPlugins, (plugins) =>
plugins.reduce((acc: Record<string, Plugin>, p: Plugin) => {
acc[p.id] = p;
return acc;
}, {}),
);