PromucFlow_constructor/app/client/src/sagas/WidgetSelectUtils.test.ts
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

189 lines
4.9 KiB
TypeScript

import type { CanvasWidgetsReduxState } from "reducers/entityReducers/canvasWidgetsReducer";
import {
deselectAll,
pushPopWidgetSelection,
selectMultipleWidgets,
selectOneWidget,
shiftSelectWidgets,
unselectWidget,
} from "./WidgetSelectUtils";
describe("Wigdet selection methods", () => {
const allWidgetsMock: CanvasWidgetsReduxState = {
widgetId1: {
widgetId: "widgetId1",
parentId: "0",
type: "BUTTON_WIDGET",
widgetName: "Button1",
version: 0,
renderMode: "CANVAS",
parentColumnSpace: 0,
parentRowSpace: 0,
leftColumn: 0,
rightColumn: 0,
topRow: 0,
bottomRow: 0,
isLoading: false,
},
widgetId2: {
widgetId: "widgetId2",
parentId: "0",
type: "BUTTON_WIDGET",
widgetName: "Button2",
version: 0,
renderMode: "CANVAS",
parentColumnSpace: 0,
parentRowSpace: 0,
leftColumn: 0,
rightColumn: 0,
topRow: 0,
bottomRow: 0,
isLoading: false,
},
widgetId3: {
widgetId: "widgetId3",
parentId: "1",
type: "BUTTON_WIDGET",
widgetName: "Button3",
version: 0,
renderMode: "CANVAS",
parentColumnSpace: 0,
parentRowSpace: 0,
leftColumn: 0,
rightColumn: 0,
topRow: 0,
bottomRow: 0,
isLoading: false,
},
};
describe("Deselect", () => {
it("returns an empty selection", () => {
const result = deselectAll([]);
expect(result).toStrictEqual([]);
});
it("will error out when request has any widgets", () => {
expect(() => deselectAll(["any"])).toThrow("Wrong payload supplied");
});
});
describe("Select One", () => {
it("returns a selection", () => {
const result = selectOneWidget(["widgetId"]);
expect(result).toStrictEqual(["widgetId"]);
});
it("will error out when wrong payload supplied", () => {
expect(() => selectOneWidget([])).toThrow("Wrong payload supplied");
expect(() => selectOneWidget(["widgetId1", "widgetId2"])).toThrow(
"Wrong payload supplied",
);
});
});
describe("Select Multiple", () => {
it("returns a selection", () => {
const result = selectMultipleWidgets(
["widgetId1", "widgetId2"],
allWidgetsMock,
);
expect(result).toStrictEqual(["widgetId1", "widgetId2"]);
});
it("returns no selection if widgets are not siblings", () => {
const result = selectMultipleWidgets(
["widgetId1", "widgetId3"],
allWidgetsMock,
);
expect(result).toBeUndefined();
});
});
describe("Shift Select", () => {
it("forward selection", () => {
const result = shiftSelectWidgets(
["w5"],
["w1", "w2", "w3", "w4", "w5"],
["w1"],
"w1",
);
expect(result).toStrictEqual(["w1", "w5", "w2", "w3", "w4"]);
});
it("backwards selection", () => {
const result = shiftSelectWidgets(
["w2"],
["w1", "w2", "w3", "w4", "w5"],
["w5"],
"w5",
);
expect(result).toStrictEqual(["w5", "w2", "w3", "w4"]);
});
it("appended selection on overlap", () => {
const result = shiftSelectWidgets(
["w1"],
["w1", "w2", "w3", "w4", "w5"],
["w5", "w3"],
"w5",
);
expect(result).toStrictEqual(["w5", "w3", "w1", "w2", "w4"]);
});
it("a single selection when last selected is not a sibling", () => {
const result = shiftSelectWidgets(
["w2"],
["w1", "w2", "w3", "w4", "w5"],
["w7"],
"w7",
);
expect(result).toStrictEqual(["w2"]);
});
it("unselect when already selected", () => {
const result = shiftSelectWidgets(
["w2"],
["w1", "w2", "w3", "w4", "w5"],
["w1", "w2"],
"w2",
);
expect(result).toStrictEqual(["w1"]);
});
});
describe("Push Pop Select", () => {
it("adds a selection", () => {
const result = pushPopWidgetSelection(
["w1"],
["w2", "w3"],
["w1", "w2", "w3"],
);
expect(result).toStrictEqual(["w2", "w3", "w1"]);
});
it("removes a selection", () => {
const result = pushPopWidgetSelection(
["w1"],
["w2", "w1"],
["w1", "w2", "w3"],
);
expect(result).toStrictEqual(["w2"]);
});
it("removes other if new selection is not a sibling", () => {
const result = pushPopWidgetSelection(["w1"], ["w3", "w4"], ["w1", "w2"]);
expect(result).toStrictEqual(["w1"]);
});
});
describe("UnSelect", () => {
it("returns selection without the widget", () => {
const result = unselectWidget(["w1"], ["w1", "w2", "w3"]);
expect(result).toStrictEqual(["w2", "w3"]);
});
it("returns selection even if not selected", () => {
const result = unselectWidget(["w1"], ["w2", "w3"]);
expect(result).toStrictEqual(["w2", "w3"]);
});
});
});