## Description
This PR upgrades Prettier to v2 + enforces TypeScript’s [`import
type`](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-8.html#type-only-imports-and-export)
syntax where applicable. It’s submitted as a separate PR so we can merge
it easily.
As a part of this PR, we reformat the codebase heavily:
- add `import type` everywhere where it’s required, and
- re-format the code to account for Prettier 2’s breaking changes:
https://prettier.io/blog/2020/03/21/2.0.0.html#breaking-changes
This PR is submitted against `release` to make sure all new code by team
members will adhere to new formatting standards, and we’ll have fewer
conflicts when merging `bundle-optimizations` into `release`. (I’ll
merge `release` back into `bundle-optimizations` once this PR is
merged.)
### Why is this needed?
This PR is needed because, for the Lodash optimization from
7cbb12af88,
we need to use `import type`. Otherwise, `babel-plugin-lodash` complains
that `LoDashStatic` is not a lodash function.
However, just using `import type` in the current codebase will give you
this:
<img width="962" alt="Screenshot 2023-03-08 at 17 45 59"
src="https://user-images.githubusercontent.com/2953267/223775744-407afa0c-e8b9-44a1-90f9-b879348da57f.png">
That’s because Prettier 1 can’t parse `import type` at all. To parse it,
we need to upgrade to Prettier 2.
### Why enforce `import type`?
Apart from just enabling `import type` support, this PR enforces
specifying `import type` everywhere it’s needed. (Developers will get
immediate TypeScript and ESLint errors when they forget to do so.)
I’m doing this because I believe `import type` improves DX and makes
refactorings easier.
Let’s say you had a few imports like below. Can you tell which of these
imports will increase the bundle size? (Tip: it’s not all of them!)
```ts
// app/client/src/workers/Linting/utils.ts
import { Position } from "codemirror";
import { LintError as JSHintError, LintOptions } from "jshint";
import { get, isEmpty, isNumber, keys, last, set } from "lodash";
```
It’s pretty hard, right?
What about now?
```ts
// app/client/src/workers/Linting/utils.ts
import type { Position } from "codemirror";
import type { LintError as JSHintError, LintOptions } from "jshint";
import { get, isEmpty, isNumber, keys, last, set } from "lodash";
```
Now, it’s clear that only `lodash` will be bundled.
This helps developers to see which imports are problematic, but it
_also_ helps with refactorings. Now, if you want to see where
`codemirror` is bundled, you can just grep for `import \{.*\} from
"codemirror"` – and you won’t get any type-only imports.
This also helps (some) bundlers. Upon transpiling, TypeScript erases
type-only imports completely. In some environment (not ours), this makes
the bundle smaller, as the bundler doesn’t need to bundle type-only
imports anymore.
## Type of change
- Chore (housekeeping or task changes that don't impact user perception)
## How Has This Been Tested?
This was tested to not break the build.
### 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
- [x] 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
- [x] 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:
- [ ] Test plan has been approved by relevant developers
- [ ] Test plan has been peer reviewed by QA
- [ ] Cypress test cases have been added and approved by either SDET or
manual QA
- [ ] Organized project review call with relevant stakeholders after
Round 1/2 of QA
- [ ] Added Test Plan Approved label after reveiwing all Cypress test
---------
Co-authored-by: Satish Gandham <hello@satishgandham.com>
Co-authored-by: Satish Gandham <satish.iitg@gmail.com>
228 lines
6.9 KiB
TypeScript
228 lines
6.9 KiB
TypeScript
import type { AppState } from "@appsmith/reducers";
|
|
import { createSelector } from "reselect";
|
|
import memoize from "proxy-memoize";
|
|
import type {
|
|
CanvasWidgetsReduxState,
|
|
FlattenedWidgetProps,
|
|
} from "reducers/entityReducers/canvasWidgetsReducer";
|
|
import type { WidgetProps } from "widgets/BaseWidget";
|
|
import _, { omit } from "lodash";
|
|
import type { WidgetType } from "constants/WidgetConstants";
|
|
import { WIDGET_PROPS_TO_SKIP_FROM_EVAL } from "constants/WidgetConstants";
|
|
import type { ActionData } from "reducers/entityReducers/actionsReducer";
|
|
import type { Page } from "@appsmith/constants/ReduxActionConstants";
|
|
import { getActions, getPlugins } from "selectors/entitiesSelector";
|
|
import type { Plugin } from "api/PluginApi";
|
|
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 getWidgetsMeta = (state: AppState) => state.entities.meta;
|
|
|
|
export const getWidgetMetaProps = createSelector(
|
|
[getWidgetsMeta, (_state: AppState, widget: WidgetProps) => widget],
|
|
(metaState, widget: WidgetProps) =>
|
|
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 = (state: AppState, type: WidgetType) => {
|
|
return Object.values(state.entities.canvasWidgets)
|
|
.filter((widget: FlattenedWidgetProps) => widget.type === type)
|
|
.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}"`,
|
|
};
|
|
}),
|
|
);
|
|
|
|
export const getDataTreeForActionCreator = memoize((state: AppState) => {
|
|
const dataTree: DataTreeForActionCreator = {};
|
|
Object.keys(state.evaluations.tree).forEach((key) => {
|
|
const value: any = state.evaluations.tree[key];
|
|
if (value.meta)
|
|
dataTree[key] = {
|
|
meta: value.meta,
|
|
};
|
|
if (value.ENTITY_TYPE)
|
|
dataTree[key] = {
|
|
ENTITY_TYPE: value.ENTITY_TYPE,
|
|
};
|
|
});
|
|
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 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) =>
|
|
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) => {
|
|
const map: Record<string, any> = {};
|
|
|
|
state.entities.pageList.pages.map((page: Page) => {
|
|
map[page.pageName] = page.pageName;
|
|
});
|
|
|
|
return map;
|
|
};
|
|
|
|
export const getWidgetByName = (
|
|
state: AppState,
|
|
widgetName: string,
|
|
): FlattenedWidgetProps | undefined => {
|
|
const widgets = state.entities.canvasWidgets;
|
|
return _.find(
|
|
Object.values(widgets),
|
|
(widget) => widget.widgetName === widgetName,
|
|
);
|
|
};
|
|
|
|
export const getAllPageIds = (state: AppState) => {
|
|
return state.entities.pageList.pages.map((page) => page.pageId);
|
|
};
|
|
|
|
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 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;
|
|
},
|
|
);
|