2023-10-02 19:41:05 +00:00
|
|
|
import { FlexLayerAlignment } from "layoutSystems/common/utils/constants";
|
2023-03-04 07:25:54 +00:00
|
|
|
import { isArray } from "lodash";
|
chore: upgrade to prettier v2 + enforce import types (#21013)Co-authored-by: Satish Gandham <hello@satishgandham.com> Co-authored-by: Satish Gandham <satish.iitg@gmail.com>
## 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
https://github.com/appsmithorg/appsmith/commit/7cbb12af886621256224be0c93e6a465dd710ad3,
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>
2023-03-16 11:41:47 +00:00
|
|
|
import type { CanvasWidgetsReduxState } from "reducers/entityReducers/canvasWidgetsReducer";
|
2023-03-04 07:25:54 +00:00
|
|
|
import { updateWidgetPositions } from "./positionUtils";
|
2023-10-02 19:41:05 +00:00
|
|
|
import type { FlexLayer, LayerChild } from "./types";
|
2023-03-04 07:25:54 +00:00
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Transform movedWidgets to FlexLayer format,
|
|
|
|
|
* and determine if the new widgets have a fill child.
|
|
|
|
|
* @param movedWidgets
|
|
|
|
|
* @param allWidgets
|
|
|
|
|
* @param alignment
|
|
|
|
|
* @returns FlexLayer
|
|
|
|
|
*/
|
|
|
|
|
export function createFlexLayer(
|
|
|
|
|
movedWidgets: string[],
|
|
|
|
|
allWidgets: CanvasWidgetsReduxState,
|
|
|
|
|
alignment: FlexLayerAlignment,
|
|
|
|
|
): FlexLayer {
|
|
|
|
|
const children = [];
|
|
|
|
|
if (movedWidgets && movedWidgets.length) {
|
|
|
|
|
for (const id of movedWidgets) {
|
|
|
|
|
const widget = allWidgets[id];
|
|
|
|
|
if (!widget) continue;
|
|
|
|
|
children.push({ id, align: alignment });
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
return { children };
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Remove moved widgets from current layers.
|
|
|
|
|
* Return non-empty layers.
|
|
|
|
|
* @param allWidgets
|
|
|
|
|
* @param movedWidgets
|
|
|
|
|
* @param flexLayers
|
|
|
|
|
* @returns FlexLayer[]
|
|
|
|
|
*/
|
|
|
|
|
export function removeWidgetsFromCurrentLayers(
|
|
|
|
|
movedWidgets: string[],
|
|
|
|
|
flexLayers: FlexLayer[],
|
|
|
|
|
): FlexLayer[] {
|
|
|
|
|
if (!flexLayers || !flexLayers.length) return [];
|
|
|
|
|
return flexLayers?.reduce((acc: FlexLayer[], layer: FlexLayer) => {
|
|
|
|
|
const children = layer.children.filter(
|
|
|
|
|
(each: LayerChild) => movedWidgets.indexOf(each.id) === -1,
|
|
|
|
|
);
|
|
|
|
|
if (children.length) {
|
|
|
|
|
acc.push({
|
|
|
|
|
...layer,
|
|
|
|
|
children,
|
|
|
|
|
});
|
|
|
|
|
}
|
|
|
|
|
return acc;
|
|
|
|
|
}, []);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* For all moved widgets,
|
|
|
|
|
* delete relationship with previous parent and
|
|
|
|
|
* add relationship with new parent
|
|
|
|
|
* @param movedWidgets
|
|
|
|
|
* @param widgets
|
|
|
|
|
* @param parentId
|
|
|
|
|
* @returns widgets
|
|
|
|
|
*/
|
|
|
|
|
export function updateRelationships(
|
|
|
|
|
movedWidgets: string[],
|
|
|
|
|
allWidgets: CanvasWidgetsReduxState,
|
|
|
|
|
parentId: string,
|
|
|
|
|
onlyUpdateFlexLayers = false,
|
|
|
|
|
isMobile = false,
|
2023-04-07 13:51:35 +00:00
|
|
|
mainCanvasWidth: number,
|
2023-05-11 04:45:14 +00:00
|
|
|
metaProps?: Record<string, any>,
|
2023-03-04 07:25:54 +00:00
|
|
|
): CanvasWidgetsReduxState {
|
|
|
|
|
const widgets = { ...allWidgets };
|
|
|
|
|
// Check if parent has changed
|
|
|
|
|
const orphans = movedWidgets.filter(
|
|
|
|
|
(item) => widgets[item].parentId !== parentId,
|
|
|
|
|
);
|
|
|
|
|
const prevParents: string[] = [];
|
|
|
|
|
if (orphans && orphans.length) {
|
|
|
|
|
//parent has changed
|
|
|
|
|
orphans.forEach((item) => {
|
|
|
|
|
// remove from previous parent
|
|
|
|
|
const prevParentId = widgets[item].parentId;
|
|
|
|
|
if (prevParentId !== undefined) {
|
|
|
|
|
prevParents.push(prevParentId);
|
|
|
|
|
const prevParent = Object.assign({}, widgets[prevParentId]);
|
|
|
|
|
if (isArray(prevParent.children)) {
|
|
|
|
|
const updatedPrevParent = {
|
|
|
|
|
...prevParent,
|
|
|
|
|
children: onlyUpdateFlexLayers
|
|
|
|
|
? prevParent.children
|
|
|
|
|
: prevParent.children.filter((each) => each !== item),
|
|
|
|
|
flexLayers:
|
|
|
|
|
prevParent.flexLayers !== undefined &&
|
|
|
|
|
removeWidgetsFromCurrentLayers(
|
|
|
|
|
movedWidgets,
|
|
|
|
|
prevParent.flexLayers,
|
|
|
|
|
),
|
|
|
|
|
};
|
|
|
|
|
widgets[prevParentId] = updatedPrevParent;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// add to new parent
|
|
|
|
|
if (!onlyUpdateFlexLayers) {
|
|
|
|
|
widgets[item] = {
|
|
|
|
|
...widgets[item],
|
|
|
|
|
parentId: parentId,
|
|
|
|
|
};
|
|
|
|
|
}
|
|
|
|
|
});
|
|
|
|
|
}
|
|
|
|
|
if (prevParents.length) {
|
|
|
|
|
for (const id of prevParents) {
|
2023-04-07 13:51:35 +00:00
|
|
|
const updatedWidgets = updateWidgetPositions(
|
|
|
|
|
widgets,
|
|
|
|
|
id,
|
|
|
|
|
isMobile,
|
|
|
|
|
mainCanvasWidth,
|
2023-05-11 04:45:14 +00:00
|
|
|
false,
|
|
|
|
|
metaProps,
|
2023-04-07 13:51:35 +00:00
|
|
|
);
|
2023-03-04 07:25:54 +00:00
|
|
|
return updatedWidgets;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
return widgets;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
2023-06-09 08:52:27 +00:00
|
|
|
* If widgets are dropped into a new vertical position in an auto-layout canvas,
|
2023-03-04 07:25:54 +00:00
|
|
|
* then add a new FlexLayer to contain the new widgets.
|
|
|
|
|
* Use the layerIndex to add the new layer at the right position.
|
|
|
|
|
* @param newLayer | FlexLayer
|
|
|
|
|
* @param allWidgets | CanvasWidgetsReduxState
|
|
|
|
|
* @param parentId | string
|
|
|
|
|
* @param layers | FlexLayer[]
|
|
|
|
|
* @param layerIndex | number
|
|
|
|
|
* @returns CanvasWidgetsReduxState
|
|
|
|
|
*/
|
|
|
|
|
export function addNewLayer(
|
|
|
|
|
newLayer: FlexLayer,
|
|
|
|
|
allWidgets: CanvasWidgetsReduxState,
|
|
|
|
|
parentId: string,
|
|
|
|
|
layers: FlexLayer[],
|
|
|
|
|
layerIndex = 0,
|
|
|
|
|
): CanvasWidgetsReduxState {
|
|
|
|
|
const widgets: CanvasWidgetsReduxState = Object.assign({}, allWidgets);
|
|
|
|
|
const canvas = widgets[parentId];
|
|
|
|
|
|
|
|
|
|
const pos = layerIndex > layers.length ? layers.length : layerIndex;
|
|
|
|
|
|
|
|
|
|
const updatedCanvas = {
|
|
|
|
|
...canvas,
|
|
|
|
|
flexLayers: [...layers.slice(0, pos), newLayer, ...layers.slice(pos)],
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
const updatedWidgets = {
|
|
|
|
|
...widgets,
|
|
|
|
|
[parentId]: updatedCanvas,
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
return updatedWidgets;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
*
|
|
|
|
|
* @param newLayer | FlexLayer : FlexLayer comprised of the moved widgets and selected alignment.
|
|
|
|
|
* @param allWidgets | CanvasWidgetsReduxState
|
|
|
|
|
* @param parentId | string : new parentId
|
|
|
|
|
* @param layers | FlexLayer[] : flexLayers of new parent.
|
|
|
|
|
* @param layerIndex | number : index of existing layer to add the moved widgets to.
|
|
|
|
|
* @param rowIndex | number : starting index of the moved widgets within an alignment in the selected layer.
|
|
|
|
|
* @returns CanvasWidgetsReduxState
|
|
|
|
|
*/
|
|
|
|
|
export function updateExistingLayer(
|
|
|
|
|
newLayer: FlexLayer,
|
|
|
|
|
allWidgets: CanvasWidgetsReduxState,
|
|
|
|
|
parentId: string,
|
|
|
|
|
layers: FlexLayer[],
|
|
|
|
|
layerIndex = 0,
|
|
|
|
|
rowIndex: number,
|
|
|
|
|
): CanvasWidgetsReduxState {
|
|
|
|
|
try {
|
|
|
|
|
const widgets: CanvasWidgetsReduxState = { ...allWidgets };
|
|
|
|
|
const canvas = widgets[parentId];
|
|
|
|
|
if (!canvas || !newLayer) return widgets;
|
|
|
|
|
|
|
|
|
|
const map: { [key: string]: LayerChild[] } = {
|
|
|
|
|
[FlexLayerAlignment.Start]: [],
|
|
|
|
|
[FlexLayerAlignment.Center]: [],
|
|
|
|
|
[FlexLayerAlignment.End]: [],
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
for (const child of layers[layerIndex]?.children) {
|
|
|
|
|
map[child.align] = [...map[child.align], child];
|
|
|
|
|
}
|
|
|
|
|
const alignment = newLayer.children[0].align;
|
|
|
|
|
map[alignment] = [
|
|
|
|
|
...map[alignment].slice(0, rowIndex),
|
|
|
|
|
...newLayer?.children,
|
|
|
|
|
...map[alignment].slice(rowIndex),
|
|
|
|
|
];
|
|
|
|
|
|
|
|
|
|
// merge the selected layer with the new layer.
|
|
|
|
|
const selectedLayer = {
|
|
|
|
|
...layers[layerIndex],
|
|
|
|
|
children: [
|
|
|
|
|
...map[FlexLayerAlignment.Start],
|
|
|
|
|
...map[FlexLayerAlignment.Center],
|
|
|
|
|
...map[FlexLayerAlignment.End],
|
|
|
|
|
],
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
const updatedCanvas = {
|
|
|
|
|
...canvas,
|
|
|
|
|
flexLayers: [
|
|
|
|
|
...layers.slice(0, layerIndex),
|
|
|
|
|
selectedLayer,
|
|
|
|
|
...layers.slice(layerIndex + 1),
|
|
|
|
|
],
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
const updatedWidgets = { ...widgets, [parentId]: updatedCanvas };
|
|
|
|
|
return updatedWidgets;
|
|
|
|
|
} catch (e) {
|
|
|
|
|
// console.error("#### update existing layer error", e);
|
|
|
|
|
return allWidgets;
|
|
|
|
|
}
|
|
|
|
|
}
|