424d2f6965
## 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>
467 lines
14 KiB
TypeScript
467 lines
14 KiB
TypeScript
import { FLEXBOX_PADDING, RenderModes } from "constants/WidgetConstants";
|
|
import {
|
|
FlexLayerAlignment,
|
|
ResponsiveBehavior,
|
|
} from "utils/autoLayout/constants";
|
|
import type { HighlightInfo } from "./autoLayoutTypes";
|
|
import { getWidgetHeight } from "./flexWidgetUtils";
|
|
import type { VerticalHighlightsPayload } from "./highlightUtils";
|
|
import {
|
|
deriveHighlightsFromLayers,
|
|
generateHighlightsForAlignment,
|
|
generateVerticalHighlights,
|
|
} from "./highlightUtils";
|
|
|
|
describe("test HighlightUtils methods", () => {
|
|
describe("test deriveHighlightsFromLayers method", () => {
|
|
it("should generate horizontal highlights for empty canvas", () => {
|
|
const widgets = {
|
|
"1": {
|
|
widgetId: "1",
|
|
leftColumn: 0,
|
|
rightColumn: 64,
|
|
alignment: FlexLayerAlignment.Start,
|
|
topRow: 0,
|
|
bottomRow: 70,
|
|
type: "CANVAS_WIDGET",
|
|
widgetName: "Canvas1",
|
|
renderMode: RenderModes.CANVAS,
|
|
version: 1,
|
|
parentColumnSpace: 1,
|
|
parentRowSpace: 1,
|
|
isLoading: false,
|
|
mobileTopRow: 0,
|
|
mobileBottomRow: 70,
|
|
mobileLeftColumn: 0,
|
|
mobileRightColumn: 640,
|
|
responsiveBehavior: ResponsiveBehavior.Fill,
|
|
parentId: "",
|
|
flexLayers: [],
|
|
children: [],
|
|
},
|
|
};
|
|
const highlights: HighlightInfo[] = deriveHighlightsFromLayers(
|
|
widgets,
|
|
"1",
|
|
9.875,
|
|
);
|
|
expect(highlights.length).toEqual(3);
|
|
expect(highlights[0].isVertical).toBeFalsy;
|
|
// width of each horizontal highlight = container width / 3 - padding.
|
|
expect(Math.round(highlights[0].width)).toEqual(211);
|
|
expect(highlights[0].height).toEqual(4);
|
|
// x position of each horizontal highlight = (container width / 3) * index + padding.
|
|
expect(Math.round(highlights[1].posX)).toEqual(215);
|
|
expect(Math.round(highlights[2].posX)).toEqual(425);
|
|
});
|
|
it("should add horizontal heights before every layer and below the last layer", () => {
|
|
const widgets = {
|
|
"1": {
|
|
widgetId: "1",
|
|
leftColumn: 0,
|
|
rightColumn: 64,
|
|
alignment: FlexLayerAlignment.Start,
|
|
topRow: 0,
|
|
bottomRow: 70,
|
|
type: "CANVAS_WIDGET",
|
|
widgetName: "Canvas1",
|
|
renderMode: RenderModes.CANVAS,
|
|
version: 1,
|
|
parentColumnSpace: 1,
|
|
parentRowSpace: 1,
|
|
isLoading: false,
|
|
mobileTopRow: 0,
|
|
mobileBottomRow: 70,
|
|
mobileLeftColumn: 0,
|
|
mobileRightColumn: 640,
|
|
responsiveBehavior: ResponsiveBehavior.Fill,
|
|
parentId: "",
|
|
flexLayers: [
|
|
{ children: [{ id: "2", align: FlexLayerAlignment.Start }] },
|
|
],
|
|
children: ["2"],
|
|
},
|
|
"2": {
|
|
widgetId: "2",
|
|
leftColumn: 0,
|
|
rightColumn: 16,
|
|
alignment: FlexLayerAlignment.Start,
|
|
topRow: 0,
|
|
bottomRow: 4,
|
|
type: "BUTTON_WIDGET",
|
|
widgetName: "Button1",
|
|
renderMode: RenderModes.CANVAS,
|
|
version: 1,
|
|
parentColumnSpace: 1.546875,
|
|
parentRowSpace: 10,
|
|
isLoading: false,
|
|
mobileTopRow: 0,
|
|
mobileBottomRow: 4,
|
|
mobileLeftColumn: 0,
|
|
mobileRightColumn: 16,
|
|
responsiveBehavior: ResponsiveBehavior.Hug,
|
|
parentId: "1",
|
|
},
|
|
};
|
|
const highlights: HighlightInfo[] = deriveHighlightsFromLayers(
|
|
widgets,
|
|
"1",
|
|
10,
|
|
);
|
|
expect(highlights.length).toEqual(10);
|
|
expect(
|
|
highlights[0].isVertical ||
|
|
highlights[1].isVertical ||
|
|
highlights[2].isVertical,
|
|
).toBeFalsy;
|
|
expect(
|
|
highlights[7].isVertical ||
|
|
highlights[8].isVertical ||
|
|
highlights[9].isVertical,
|
|
).toBeFalsy;
|
|
|
|
expect(highlights[0].posY).toEqual(FLEXBOX_PADDING);
|
|
expect(highlights[7].posY).toEqual(
|
|
highlights[0].posY +
|
|
(widgets["2"].bottomRow - widgets["2"].topRow) *
|
|
widgets["2"].parentRowSpace,
|
|
);
|
|
|
|
expect(highlights[0].layerIndex).toEqual(0);
|
|
expect(highlights[0].isNewLayer).toBeTruthy;
|
|
expect(highlights[7].layerIndex).toEqual(1);
|
|
expect(highlights[7].isNewLayer).toBeTruthy;
|
|
});
|
|
});
|
|
|
|
describe("test generateHighlightsForAlignment method", () => {
|
|
it("should add vertical highlights before every widget in the alignment, and at the end of the last widget", () => {
|
|
const children = [
|
|
{
|
|
widgetId: "2",
|
|
leftColumn: 0,
|
|
rightColumn: 16,
|
|
alignment: FlexLayerAlignment.Start,
|
|
topRow: 0,
|
|
bottomRow: 4,
|
|
type: "BUTTON_WIDGET",
|
|
widgetName: "Button1",
|
|
renderMode: RenderModes.CANVAS,
|
|
version: 1,
|
|
parentColumnSpace: 10,
|
|
parentRowSpace: 10,
|
|
isLoading: false,
|
|
mobileTopRow: 0,
|
|
mobileBottomRow: 4,
|
|
mobileLeftColumn: 0,
|
|
mobileRightColumn: 16,
|
|
responsiveBehavior: ResponsiveBehavior.Hug,
|
|
parentId: "1",
|
|
},
|
|
];
|
|
const result: HighlightInfo[] = generateHighlightsForAlignment({
|
|
arr: children,
|
|
childCount: 0,
|
|
layerIndex: 0,
|
|
alignment: FlexLayerAlignment.Start,
|
|
maxHeight: 40,
|
|
offsetTop: 4,
|
|
parentColumnSpace: 10,
|
|
avoidInitialHighlight: false,
|
|
isMobile: false,
|
|
startPosition: 0,
|
|
canvasId: "1",
|
|
});
|
|
expect(result.length).toEqual(2);
|
|
expect(result[0].posX).toEqual(2);
|
|
expect(result[0].posY).toEqual(4);
|
|
expect(result[0].width).toEqual(4);
|
|
expect(result[0].height).toEqual(
|
|
getWidgetHeight(children[0], false) * children[0].parentRowSpace,
|
|
);
|
|
|
|
expect(result[1].posX).toEqual(
|
|
children[0].rightColumn * children[0].parentColumnSpace +
|
|
FLEXBOX_PADDING / 2,
|
|
);
|
|
expect(result[1].isNewLayer).toBeFalsy;
|
|
expect(result[1].isVertical).toBeTruthy;
|
|
expect(result[1].layerIndex).toEqual(0);
|
|
});
|
|
it("should create vertical highlights as tall as the tallest child in the row", () => {
|
|
const children = [
|
|
{
|
|
widgetId: "2",
|
|
leftColumn: 0,
|
|
rightColumn: 16,
|
|
alignment: FlexLayerAlignment.Start,
|
|
topRow: 0,
|
|
bottomRow: 4,
|
|
type: "BUTTON_WIDGET",
|
|
widgetName: "Button1",
|
|
renderMode: RenderModes.CANVAS,
|
|
version: 1,
|
|
parentColumnSpace: 10,
|
|
parentRowSpace: 10,
|
|
isLoading: false,
|
|
mobileTopRow: 0,
|
|
mobileBottomRow: 4,
|
|
mobileLeftColumn: 0,
|
|
mobileRightColumn: 16,
|
|
responsiveBehavior: ResponsiveBehavior.Hug,
|
|
parentId: "1",
|
|
},
|
|
{
|
|
widgetId: "3",
|
|
leftColumn: 0,
|
|
rightColumn: 16,
|
|
alignment: FlexLayerAlignment.Start,
|
|
topRow: 0,
|
|
bottomRow: 6,
|
|
type: "BUTTON_WIDGET",
|
|
widgetName: "Button2",
|
|
renderMode: RenderModes.CANVAS,
|
|
version: 1,
|
|
parentColumnSpace: 10,
|
|
parentRowSpace: 10,
|
|
isLoading: false,
|
|
mobileTopRow: 0,
|
|
mobileBottomRow: 6,
|
|
mobileLeftColumn: 0,
|
|
mobileRightColumn: 16,
|
|
responsiveBehavior: ResponsiveBehavior.Hug,
|
|
parentId: "1",
|
|
},
|
|
];
|
|
const result: HighlightInfo[] = generateHighlightsForAlignment({
|
|
arr: children,
|
|
childCount: 0,
|
|
layerIndex: 0,
|
|
alignment: FlexLayerAlignment.Start,
|
|
maxHeight:
|
|
getWidgetHeight(children[1], false) * children[1].parentRowSpace,
|
|
offsetTop: 4,
|
|
parentColumnSpace: 10,
|
|
|
|
avoidInitialHighlight: false,
|
|
isMobile: false,
|
|
startPosition: 0,
|
|
canvasId: "1",
|
|
});
|
|
expect(result.length).toEqual(3);
|
|
expect(result[0].height).toEqual(
|
|
getWidgetHeight(children[1], false) * children[1].parentRowSpace,
|
|
);
|
|
});
|
|
it("should not render initial highlight is avoidInitialHighlight is true", () => {
|
|
const result: HighlightInfo[] = generateHighlightsForAlignment({
|
|
arr: [],
|
|
childCount: 0,
|
|
layerIndex: 0,
|
|
alignment: FlexLayerAlignment.Start,
|
|
maxHeight: 40,
|
|
offsetTop: 4,
|
|
parentColumnSpace: 10,
|
|
|
|
avoidInitialHighlight: true,
|
|
isMobile: false,
|
|
startPosition: 0,
|
|
canvasId: "1",
|
|
});
|
|
expect(result.length).toEqual(0);
|
|
});
|
|
});
|
|
|
|
describe("test generateVerticalHighlights method", () => {
|
|
it("should not render initial highlight for an empty center alignment if one of the other alignments are encroaching its space", () => {
|
|
const widgets = {
|
|
"1": {
|
|
widgetId: "1",
|
|
leftColumn: 0,
|
|
rightColumn: 64,
|
|
alignment: FlexLayerAlignment.Start,
|
|
topRow: 0,
|
|
bottomRow: 70,
|
|
type: "CANVAS_WIDGET",
|
|
widgetName: "Canvas1",
|
|
renderMode: RenderModes.CANVAS,
|
|
version: 1,
|
|
parentColumnSpace: 1,
|
|
parentRowSpace: 1,
|
|
isLoading: false,
|
|
mobileTopRow: 0,
|
|
mobileBottomRow: 70,
|
|
mobileLeftColumn: 0,
|
|
mobileRightColumn: 640,
|
|
responsiveBehavior: ResponsiveBehavior.Fill,
|
|
parentId: "",
|
|
flexLayers: [
|
|
{
|
|
children: [
|
|
{ id: "2", align: FlexLayerAlignment.Start },
|
|
{ id: "3", align: FlexLayerAlignment.Start },
|
|
],
|
|
},
|
|
],
|
|
children: ["2", "3"],
|
|
},
|
|
"2": {
|
|
widgetId: "2",
|
|
leftColumn: 0,
|
|
rightColumn: 16,
|
|
alignment: FlexLayerAlignment.Start,
|
|
topRow: 0,
|
|
bottomRow: 4,
|
|
type: "BUTTON_WIDGET",
|
|
widgetName: "Button1",
|
|
renderMode: RenderModes.CANVAS,
|
|
version: 1,
|
|
parentColumnSpace: 10,
|
|
parentRowSpace: 10,
|
|
isLoading: false,
|
|
mobileTopRow: 0,
|
|
mobileBottomRow: 4,
|
|
mobileLeftColumn: 0,
|
|
mobileRightColumn: 16,
|
|
responsiveBehavior: ResponsiveBehavior.Hug,
|
|
parentId: "1",
|
|
},
|
|
"3": {
|
|
widgetId: "3",
|
|
leftColumn: 16,
|
|
rightColumn: 26,
|
|
alignment: FlexLayerAlignment.Start,
|
|
topRow: 0,
|
|
bottomRow: 6,
|
|
type: "BUTTON_WIDGET",
|
|
widgetName: "Button2",
|
|
renderMode: RenderModes.CANVAS,
|
|
version: 1,
|
|
parentColumnSpace: 10,
|
|
parentRowSpace: 10,
|
|
isLoading: false,
|
|
mobileTopRow: 0,
|
|
mobileBottomRow: 6,
|
|
mobileLeftColumn: 16,
|
|
mobileRightColumn: 26,
|
|
responsiveBehavior: ResponsiveBehavior.Hug,
|
|
parentId: "1",
|
|
},
|
|
};
|
|
const result: VerticalHighlightsPayload = generateVerticalHighlights({
|
|
widgets,
|
|
layer: widgets["1"].flexLayers[0],
|
|
childCount: 0,
|
|
layerIndex: 0,
|
|
offsetTop: 4,
|
|
|
|
canvasId: "1",
|
|
columnSpace: 10,
|
|
draggedWidgets: [],
|
|
isMobile: false,
|
|
});
|
|
expect(result.highlights.length).toEqual(4);
|
|
expect(result.childCount).toEqual(2);
|
|
});
|
|
it("should not render highlights for flex wrapped alignments that span multiple rows", () => {
|
|
const widgets = {
|
|
"1": {
|
|
widgetId: "1",
|
|
leftColumn: 0,
|
|
rightColumn: 64,
|
|
alignment: FlexLayerAlignment.Start,
|
|
topRow: 0,
|
|
bottomRow: 70,
|
|
type: "CANVAS_WIDGET",
|
|
widgetName: "Canvas1",
|
|
renderMode: RenderModes.CANVAS,
|
|
version: 1,
|
|
parentColumnSpace: 1,
|
|
parentRowSpace: 1,
|
|
isLoading: false,
|
|
mobileTopRow: 0,
|
|
mobileBottomRow: 70,
|
|
mobileLeftColumn: 0,
|
|
mobileRightColumn: 640,
|
|
responsiveBehavior: ResponsiveBehavior.Fill,
|
|
parentId: "",
|
|
flexLayers: [
|
|
{
|
|
children: [
|
|
{ id: "2", align: FlexLayerAlignment.Start },
|
|
{ id: "3", align: FlexLayerAlignment.Start },
|
|
],
|
|
},
|
|
],
|
|
children: ["2", "3"],
|
|
},
|
|
"2": {
|
|
widgetId: "2",
|
|
leftColumn: 0,
|
|
rightColumn: 16,
|
|
alignment: FlexLayerAlignment.Start,
|
|
topRow: 0,
|
|
bottomRow: 4,
|
|
type: "BUTTON_WIDGET",
|
|
widgetName: "Button1",
|
|
renderMode: RenderModes.CANVAS,
|
|
version: 1,
|
|
parentColumnSpace: 10,
|
|
parentRowSpace: 10,
|
|
isLoading: false,
|
|
mobileTopRow: 0,
|
|
mobileBottomRow: 4,
|
|
mobileLeftColumn: 0,
|
|
mobileRightColumn: 16,
|
|
responsiveBehavior: ResponsiveBehavior.Hug,
|
|
parentId: "1",
|
|
},
|
|
"3": {
|
|
widgetId: "3",
|
|
leftColumn: 16,
|
|
rightColumn: 64,
|
|
alignment: FlexLayerAlignment.Start,
|
|
topRow: 0,
|
|
bottomRow: 6,
|
|
type: "INPUT_WIDGET",
|
|
widgetName: "Button2",
|
|
renderMode: RenderModes.CANVAS,
|
|
version: 1,
|
|
parentColumnSpace: 10,
|
|
parentRowSpace: 10,
|
|
isLoading: false,
|
|
mobileTopRow: 4,
|
|
mobileBottomRow: 10,
|
|
mobileLeftColumn: 0,
|
|
mobileRightColumn: 64,
|
|
responsiveBehavior: ResponsiveBehavior.Fill,
|
|
parentId: "1",
|
|
},
|
|
};
|
|
const result: VerticalHighlightsPayload = generateVerticalHighlights({
|
|
widgets,
|
|
layer: widgets["1"].flexLayers[0],
|
|
childCount: 0,
|
|
layerIndex: 0,
|
|
offsetTop: 4,
|
|
canvasId: "1",
|
|
columnSpace: 9.875,
|
|
draggedWidgets: [],
|
|
isMobile: true,
|
|
});
|
|
expect(result.highlights.length).toEqual(3);
|
|
expect(result.highlights[1].posY).toEqual(
|
|
widgets["3"].mobileTopRow * widgets["3"].parentRowSpace +
|
|
FLEXBOX_PADDING,
|
|
);
|
|
expect(result.highlights[1].height).toEqual(60);
|
|
expect(result.highlights[2].posX).toEqual(634);
|
|
expect(result.highlights[2].posY).toEqual(
|
|
widgets["3"].mobileTopRow * widgets["3"].parentRowSpace +
|
|
FLEXBOX_PADDING,
|
|
);
|
|
expect(result.childCount).toEqual(2);
|
|
});
|
|
});
|
|
});
|