PromucFlow_constructor/app/client/src/WidgetProvider/factory/registrationHelper.tsx

42 lines
1.4 KiB
TypeScript
Raw Normal View History

chore: Move the widget config to widget class (#26073) ## 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
2023-09-06 12:15:04 +00:00
import React from "react";
import withMeta from "widgets/MetaHOC";
import { withLazyRender } from "widgets/withLazyRender";
import withWidgetProps from "widgets/withWidgetProps";
import { flow, identity } from "lodash";
import * as Sentry from "@sentry/react";
import type { CanvasWidgetStructure } from "WidgetProvider/constants";
import type BaseWidget from "widgets/BaseWidget";
import WidgetFactory from ".";
/*
* Function to create builder for the widgets and register them in widget factory
* Note: Ideally we should do this on the widfactory itself. but introducing the withMeta
* HOC in the widget factory file leads to the circular dependency hence we have
* extracted this into a seperate file to break the circular reference.
*
*/
export const registerWidgets = (widgets: (typeof BaseWidget)[]) => {
const widgetAndBuilders = widgets.map((widget) => {
const { eagerRender, needsMeta } = widget.getConfig();
const ProfiledWidget = flow([
needsMeta ? withMeta : identity,
withWidgetProps,
eagerRender ? identity : withLazyRender,
Sentry.withProfiler,
])(widget);
return [
widget,
(widgetProps: CanvasWidgetStructure) => (
<ProfiledWidget {...widgetProps} key={widgetProps.widgetId} />
),
] as [
typeof BaseWidget,
(widgetProps: CanvasWidgetStructure) => React.ReactNode,
];
});
WidgetFactory.initialize(widgetAndBuilders);
};