Protei/PromucFlow_constructor
2
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity
f48972b81c
PromucFlow_constructor/app/client/src/reflow/tests/reflowHelpers.test.js
Ivan Akulov 424d2f6965
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
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>
2023-03-16 17:11:47 +05:30

622 lines
14 KiB
JavaScript
Raw Blame History

import {
HORIZONTAL_RESIZE_MIN_LIMIT,
ReflowDirection,
VERTICAL_RESIZE_MIN_LIMIT,
} from "reflow/reflowTypes";
import { getAccessor } from "reflow/reflowUtils";
import {
getCollisionTree,
getMovementMap,
getModifiedArgumentsForCollisionTree,
getHorizontalSpaceMovement,
getVerticalSpaceMovement,
} from "../reflowHelpers";
describe("Test reflow helper methods", () => {
describe("Test getCollisionTree method", () => {
const occupiedSpacesMap = {
1: {
top: 30,
left: 20,
right: 80,
bottom: 50,
id: "1",
},
2: {
top: 50,
left: 40,
right: 90,
bottom: 70,
id: "2",
},
3: {
top: 50,
left: 10,
right: 40,
bottom: 70,
id: "3",
},
4: {
top: 75,
left: 20,
right: 60,
bottom: 95,
id: "4",
},
5: {
top: 95,
left: 20,
right: 80,
bottom: 130,
id: "5",
},
6: {
id: "6",
top: 5,
left: 70,
right: 110,
bottom: 25,
},
};
const gridProps = {
parentRowSpace: 10,
parentColumnSpace: 10,
maxGridColumns: 200,
};
it("it should return a collision Tree for multiple directions", () => {
const newSpacePositions = [
{
id: "0",
top: 10,
left: 20,
right: 80,
bottom: 40,
},
];
const collidingSpacesMap = {
1: {
top: 30,
left: 20,
right: 80,
bottom: 50,
id: "1",
collidingValue: 35,
collidingId: "0",
direction: ReflowDirection.BOTTOM,
},
6: {
id: "6",
top: 5,
left: 70,
right: 110,
bottom: 25,
collidingValue: 80,
collidingId: "0",
direction: ReflowDirection.RIGHT,
},
};
const collisionTrees = [
{
bottom: 50,
children: {
2: {
bottom: 70,
children: {},
collidingId: "1",
collidingValue: 55,
direction: ReflowDirection.BOTTOM,
id: "2",
isHorizontal: false,
left: 40,
order: 1,
right: 90,
top: 50,
},
3: {
bottom: 70,
children: {},
collidingId: "1",
collidingValue: 55,
direction: ReflowDirection.BOTTOM,
id: "3",
isHorizontal: false,
left: 10,
order: 2,
right: 40,
top: 50,
},
},
collidingId: "0",
collidingValue: 35,
direction: ReflowDirection.BOTTOM,
id: "1",
left: 20,
right: 80,
top: 30,
},
{
id: "6",
top: 5,
left: 70,
right: 110,
children: {},
bottom: 25,
collidingValue: 80,
collidingId: "0",
direction: ReflowDirection.RIGHT,
},
];
expect(
getCollisionTree(
newSpacePositions,
Object.values(occupiedSpacesMap),
occupiedSpacesMap,
occupiedSpacesMap,
Object.values(collidingSpacesMap),
ReflowDirection.BOTTOM,
false,
collidingSpacesMap,
gridProps,
{},
{},
).collisionTrees,
).toEqual(collisionTrees);
});
it("it should return a collision Tree for multiple dragging spaces, It should create a new branch in tree if one of the branch nodes are overlapping with another dragging space", () => {
const newSpacePositions = [
{
id: "0",
top: 10,
left: 20,
right: 80,
bottom: 40,
},
{
id: "0.5",
top: 85,
left: 20,
right: 80,
bottom: 110,
},
];
const collidingSpacesMap = {
1: {
top: 30,
left: 20,
right: 80,
bottom: 50,
id: "1",
collidingValue: 40,
collidingId: "0",
direction: ReflowDirection.BOTTOM,
},
};
const collisionTrees = [
{
bottom: 50,
children: {
2: {
bottom: 70,
children: {},
collidingId: "1",
collidingValue: 60,
direction: ReflowDirection.BOTTOM,
id: "2",
isHorizontal: false,
left: 40,
order: 1,
right: 90,
top: 50,
},
3: {
bottom: 70,
children: {},
collidingId: "1",
collidingValue: 60,
direction: ReflowDirection.BOTTOM,
id: "3",
isHorizontal: false,
left: 10,
order: 2,
right: 40,
top: 50,
},
},
collidingId: "0",
collidingValue: 40,
direction: ReflowDirection.BOTTOM,
id: "1",
left: 20,
right: 80,
top: 30,
},
{
bottom: 95,
children: {
5: {
bottom: 130,
children: {},
collidingId: "4",
collidingValue: 130,
direction: "BOTTOM",
id: "5",
isHorizontal: false,
left: 20,
order: 1,
right: 80,
top: 95,
},
},
collidingId: "0.5",
collidingValue: 110,
direction: "BOTTOM",
id: "4",
isHorizontal: false,
left: 20,
order: 0,
right: 60,
top: 75,
},
];
expect(
getCollisionTree(
newSpacePositions,
Object.values(occupiedSpacesMap),
occupiedSpacesMap,
occupiedSpacesMap,
Object.values(collidingSpacesMap),
ReflowDirection.BOTTOM,
false,
collidingSpacesMap,
gridProps,
{},
{},
).collisionTrees,
).toEqual(collisionTrees);
});
});
describe("test getMovementMap method", () => {
const occupiedSpacesMap = {
1: {
top: 30,
left: 20,
right: 80,
bottom: 50,
id: "1",
},
2: {
top: 50,
left: 40,
right: 90,
bottom: 70,
id: "2",
},
3: {
top: 50,
left: 10,
right: 40,
bottom: 70,
id: "3",
},
4: {
top: 75,
left: 20,
right: 60,
bottom: 95,
id: "4",
},
5: {
top: 95,
left: 20,
right: 80,
bottom: 130,
id: "5",
},
6: {
id: "6",
top: 5,
left: 70,
right: 110,
bottom: 25,
},
};
const gridProps = {
parentRowSpace: 10,
parentColumnSpace: 10,
maxGridColumns: 200,
};
const delta = {
X: 20,
Y: 20,
};
it("should return movement map", () => {
const newSpacePositionMap = {
0: {
id: "0",
top: 10,
left: 20,
right: 80,
bottom: 40,
},
};
const collidingSpacesMap = {
1: {
top: 30,
left: 20,
right: 80,
bottom: 50,
id: "1",
collidingValue: 35,
collidingId: "0",
direction: ReflowDirection.BOTTOM,
},
6: {
id: "6",
top: 5,
left: 70,
right: 110,
bottom: 25,
collidingValue: 80,
collidingId: "0",
direction: ReflowDirection.RIGHT,
},
};
const movementMap = {
1: {
Y: 50,
dimensionYBeforeCollision: -5,
directionY: "BOTTOM",
height: 200,
maxY: Infinity,
verticalOccupiedLength: VERTICAL_RESIZE_MIN_LIMIT,
verticalEmptySpaces: 0,
verticalMaxOccupiedSpace: 20,
},
2: {
Y: 50,
dimensionYBeforeCollision: -5,
directionY: "BOTTOM",
height: 200,
maxY: Infinity,
verticalOccupiedLength: 0,
verticalEmptySpaces: 0,
verticalMaxOccupiedSpace: 0,
},
3: {
Y: 50,
dimensionYBeforeCollision: -5,
directionY: "BOTTOM",
height: 200,
maxY: Infinity,
verticalOccupiedLength: 0,
verticalEmptySpaces: 0,
verticalMaxOccupiedSpace: 0,
},
6: {
X: 100,
dimensionXBeforeCollision: -10,
directionX: "RIGHT",
horizontalOccupiedLength: 0,
horizontalEmptySpaces: -46,
horizontalMaxOccupiedSpace: 0,
maxX: 900,
width: 400,
},
};
expect(
getMovementMap(
Object.values(newSpacePositionMap),
newSpacePositionMap,
Object.values(occupiedSpacesMap),
occupiedSpacesMap,
occupiedSpacesMap,
Object.values(collidingSpacesMap),
collidingSpacesMap,
gridProps,
delta,
true,
ReflowDirection.BOTTOM,
false,
{},
).movementMap,
).toEqual(movementMap);
});
});
describe("test getModifiedArgumentsForCollisionTree method", () => {
const occupiedSpacesMap = {
1: {
top: 30,
left: 20,
right: 80,
bottom: 50,
id: "1",
},
2: {
top: 50,
left: 40,
right: 90,
bottom: 70,
id: "2",
},
3: {
top: 50,
left: 10,
right: 40,
bottom: 70,
id: "3",
},
4: {
top: 75,
left: 20,
right: 60,
bottom: 95,
id: "4",
},
5: {
top: 95,
left: 20,
right: 80,
bottom: 130,
id: "5",
},
};
const collidingSpace = {
top: 30,
left: 20,
right: 80,
bottom: 50,
id: "1",
collidingValue: 40,
collidingId: "0",
direction: ReflowDirection.BOTTOM,
};
const gridProps = {
parentRowSpace: 10,
parentColumnSpace: 10,
maxGridCOLUMNS: 200,
};
it("should return the same values if colliding in the same direction as parent", () => {
const currentAccessors = getAccessor(ReflowDirection.BOTTOM),
currentDirection = ReflowDirection.BOTTOM;
expect(
getModifiedArgumentsForCollisionTree(
collidingSpace,
Object.values(occupiedSpacesMap),
occupiedSpacesMap,
occupiedSpacesMap,
currentDirection,
false,
),
).toEqual({
currentOccSpacesMap: occupiedSpacesMap,
currentAccessors,
currentDirection,
currentOccSpaces: Object.values(occupiedSpacesMap),
currentCollidingSpace: collidingSpace,
});
});
it("should return modified values for other direction, based on previous movementMap", () => {
const currentAccessors = getAccessor(ReflowDirection.BOTTOM),
currentDirection = ReflowDirection.BOTTOM;
const prevMovementMap = {
1: {
Y: 250,
height: 200,
},
3: {
X: 100,
width: 300,
},
5: {
X: 170,
Y: 210,
width: 400,
height: 300,
},
};
const currentOccSpacesMap = {
...occupiedSpacesMap,
3: {
...occupiedSpacesMap["3"],
left: 20,
right: 50,
},
5: {
...occupiedSpacesMap["5"],
left: 37,
right: 77,
},
};
expect(
getModifiedArgumentsForCollisionTree(
collidingSpace,
Object.values(occupiedSpacesMap),
occupiedSpacesMap,
occupiedSpacesMap,
ReflowDirection.RIGHT,
true,
prevMovementMap,
gridProps,
),
).toEqual({
currentOccSpacesMap,
currentAccessors,
currentDirection,
currentOccSpaces: Object.values(currentOccSpacesMap),
currentCollidingSpace: collidingSpace,
});
});
});
describe("test getHorizontalSpaceMovement and getVerticalSpaceMovement methods", () => {
const collisionTree = {
top: 30,
left: 20,
right: 50,
bottom: 50,
id: "1",
collidingValue: 40,
collidingId: "0",
direction: ReflowDirection.BOTTOM,
},
gridProps = {
parentRowSpace: 10,
parentColumnSpace: 10,
maxGridColumns: 64,
},
delta = {
X: 20,
Y: 20,
};
it("should return Horizontal Movement Metrics", () => {
expect(
getHorizontalSpaceMovement(
collisionTree,
gridProps,
ReflowDirection.RIGHT,
20,
3 * HORIZONTAL_RESIZE_MIN_LIMIT,
-10,
7,
7,
delta,
true,
),
).toEqual({
X: 30,
dimensionXBeforeCollision: -10,
directionX: "RIGHT",
horizontalOccupiedLength: 3 * HORIZONTAL_RESIZE_MIN_LIMIT,
horizontalEmptySpaces: 7,
horizontalMaxOccupiedSpace: 20,
maxX: 80,
width: 300,
});
});
it("should return Vertical Movement Metrics", () => {
expect(
getVerticalSpaceMovement(
collisionTree,
gridProps,
ReflowDirection.BOTTOM,
20,
3 * VERTICAL_RESIZE_MIN_LIMIT,
-10,
7,
7,
delta,
true,
),
).toEqual({
Y: 30,
dimensionYBeforeCollision: -10,
directionY: "BOTTOM",
height: 200,
maxY: Infinity,
verticalOccupiedLength: 3 * VERTICAL_RESIZE_MIN_LIMIT,
verticalEmptySpaces: 7,
verticalMaxOccupiedSpace: 20,
});
});
});
});
Reference in New Issue View Git Blame Copy Permalink