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 { DataTree } from "entities/DataTree/dataTreeFactory";
|
|
|
|
|
import type { CanvasWidgetsReduxState } from "reducers/entityReducers/canvasWidgetsReducer";
|
|
|
|
|
import type { MetaWidgetsReduxState } from "reducers/entityReducers/metaWidgetsReducer";
|
2022-08-19 10:10:36 +00:00
|
|
|
import { buildChildWidgetTree } from "./widgetRenderUtils";
|
|
|
|
|
|
|
|
|
|
describe("test EditorUtils methods", () => {
|
|
|
|
|
describe("should test buildChildWidgetTree method", () => {
|
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
|
|
|
const metaWidgets = {
|
2023-02-14 16:07:31 +00:00
|
|
|
"1_meta": {
|
|
|
|
|
children: ["2_meta"],
|
|
|
|
|
type: "CANVAS",
|
|
|
|
|
widgetId: "1_meta",
|
|
|
|
|
parentId: "2",
|
|
|
|
|
topRow: 0,
|
|
|
|
|
bottomRow: 100,
|
|
|
|
|
widgetName: "meta_one",
|
|
|
|
|
},
|
|
|
|
|
"2_meta": {
|
|
|
|
|
children: [],
|
|
|
|
|
type: "INPUT_WIDGET",
|
|
|
|
|
widgetId: "2_meta",
|
|
|
|
|
parentId: "1_meta",
|
|
|
|
|
topRow: 0,
|
|
|
|
|
bottomRow: 10,
|
|
|
|
|
widgetName: "meta_two",
|
|
|
|
|
},
|
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
|
|
|
} as unknown as MetaWidgetsReduxState;
|
|
|
|
|
const canvasWidgets = {
|
2022-08-19 10:10:36 +00:00
|
|
|
"1": {
|
|
|
|
|
children: ["2"],
|
|
|
|
|
type: "FORM_WIDGET",
|
|
|
|
|
widgetId: "1",
|
|
|
|
|
parentId: "0",
|
|
|
|
|
topRow: 0,
|
|
|
|
|
bottomRow: 10,
|
|
|
|
|
widgetName: "one",
|
|
|
|
|
},
|
|
|
|
|
"2": {
|
2023-02-14 16:07:31 +00:00
|
|
|
children: ["3", "4", "1_meta"],
|
2022-08-19 10:10:36 +00:00
|
|
|
type: "CANVAS",
|
|
|
|
|
widgetId: "2",
|
|
|
|
|
parentId: "1",
|
|
|
|
|
topRow: 0,
|
|
|
|
|
bottomRow: 100,
|
|
|
|
|
widgetName: "two",
|
|
|
|
|
},
|
|
|
|
|
"3": {
|
|
|
|
|
children: [],
|
|
|
|
|
type: "TEXT",
|
|
|
|
|
widgetId: "3",
|
|
|
|
|
parentId: "2",
|
|
|
|
|
topRow: 4,
|
|
|
|
|
bottomRow: 5,
|
|
|
|
|
widgetName: "three",
|
|
|
|
|
},
|
|
|
|
|
"4": {
|
|
|
|
|
children: [],
|
|
|
|
|
type: "BUTTON",
|
|
|
|
|
widgetId: "4",
|
|
|
|
|
parentId: "2",
|
|
|
|
|
topRow: 6,
|
|
|
|
|
bottomRow: 18,
|
|
|
|
|
widgetName: "four",
|
|
|
|
|
},
|
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
|
|
|
} as unknown as CanvasWidgetsReduxState;
|
2022-08-19 10:10:36 +00:00
|
|
|
|
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
|
|
|
const dataTree = {
|
2022-08-19 10:10:36 +00:00
|
|
|
one: {
|
|
|
|
|
children: ["2"],
|
|
|
|
|
type: "FORM_WIDGET",
|
|
|
|
|
widgetId: "1",
|
|
|
|
|
parentId: "0",
|
|
|
|
|
topRow: 0,
|
|
|
|
|
bottomRow: 10,
|
|
|
|
|
widgetName: "one",
|
|
|
|
|
skipForFormWidget: "test",
|
|
|
|
|
value: "test",
|
|
|
|
|
isDirty: true,
|
|
|
|
|
isValid: true,
|
|
|
|
|
},
|
|
|
|
|
two: {
|
2023-02-14 16:07:31 +00:00
|
|
|
children: ["3", "4", "1_meta"],
|
2022-08-19 10:10:36 +00:00
|
|
|
type: "CANVAS",
|
|
|
|
|
widgetId: "2",
|
|
|
|
|
parentId: "1",
|
|
|
|
|
topRow: 0,
|
|
|
|
|
bottomRow: 100,
|
|
|
|
|
widgetName: "two",
|
|
|
|
|
skipForFormWidget: "test",
|
|
|
|
|
value: "test",
|
|
|
|
|
isDirty: true,
|
|
|
|
|
isValid: true,
|
|
|
|
|
},
|
|
|
|
|
three: {
|
|
|
|
|
children: [],
|
|
|
|
|
type: "TEXT",
|
|
|
|
|
widgetId: "3",
|
|
|
|
|
parentId: "2",
|
|
|
|
|
topRow: 4,
|
|
|
|
|
bottomRow: 5,
|
|
|
|
|
widgetName: "three",
|
|
|
|
|
skipForFormWidget: "test",
|
|
|
|
|
value: "test",
|
|
|
|
|
isDirty: true,
|
|
|
|
|
isValid: true,
|
|
|
|
|
},
|
|
|
|
|
four: {
|
|
|
|
|
children: [],
|
|
|
|
|
type: "BUTTON",
|
|
|
|
|
widgetId: "4",
|
|
|
|
|
parentId: "2",
|
|
|
|
|
topRow: 6,
|
|
|
|
|
bottomRow: 18,
|
|
|
|
|
widgetName: "four",
|
|
|
|
|
skipForFormWidget: "test",
|
|
|
|
|
value: "test",
|
|
|
|
|
isDirty: true,
|
|
|
|
|
isValid: true,
|
|
|
|
|
},
|
2023-02-14 16:07:31 +00:00
|
|
|
meta_one: {
|
|
|
|
|
skipForFormWidget: "test",
|
|
|
|
|
children: ["1_meta"],
|
|
|
|
|
type: "CANVAS",
|
|
|
|
|
widgetId: "1_meta",
|
|
|
|
|
parentId: "2",
|
|
|
|
|
topRow: 0,
|
|
|
|
|
bottomRow: 100,
|
|
|
|
|
widgetName: "meta_one",
|
|
|
|
|
},
|
|
|
|
|
meta_two: {
|
|
|
|
|
children: [],
|
|
|
|
|
type: "INPUT_WIDGET",
|
|
|
|
|
widgetId: "meta_two",
|
|
|
|
|
parentId: "meta_1",
|
|
|
|
|
topRow: 0,
|
|
|
|
|
bottomRow: 10,
|
|
|
|
|
widgetName: "two",
|
|
|
|
|
skipForFormWidget: "test",
|
|
|
|
|
value: "test",
|
|
|
|
|
isDirty: true,
|
|
|
|
|
isValid: true,
|
|
|
|
|
},
|
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
|
|
|
} as unknown as DataTree;
|
2022-08-19 10:10:36 +00:00
|
|
|
|
|
|
|
|
it("should return a complete childwidgets Tree", () => {
|
|
|
|
|
const childWidgetTree = [
|
|
|
|
|
{
|
|
|
|
|
bottomRow: 5,
|
|
|
|
|
children: [],
|
|
|
|
|
skipForFormWidget: "test",
|
|
|
|
|
isDirty: true,
|
|
|
|
|
isLoading: false,
|
|
|
|
|
isValid: true,
|
|
|
|
|
parentId: "2",
|
|
|
|
|
topRow: 4,
|
|
|
|
|
type: "TEXT",
|
|
|
|
|
value: "test",
|
|
|
|
|
widgetId: "3",
|
|
|
|
|
widgetName: "three",
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
bottomRow: 18,
|
|
|
|
|
children: [],
|
|
|
|
|
skipForFormWidget: "test",
|
|
|
|
|
isDirty: true,
|
|
|
|
|
isLoading: false,
|
|
|
|
|
isValid: true,
|
|
|
|
|
parentId: "2",
|
|
|
|
|
topRow: 6,
|
|
|
|
|
type: "BUTTON",
|
|
|
|
|
value: "test",
|
|
|
|
|
widgetId: "4",
|
|
|
|
|
widgetName: "four",
|
|
|
|
|
},
|
2023-02-14 16:07:31 +00:00
|
|
|
{
|
|
|
|
|
type: "CANVAS",
|
|
|
|
|
isLoading: false,
|
|
|
|
|
widgetId: "1_meta",
|
|
|
|
|
parentId: "2",
|
|
|
|
|
topRow: 0,
|
|
|
|
|
bottomRow: 100,
|
|
|
|
|
widgetName: "meta_one",
|
|
|
|
|
skipForFormWidget: "test",
|
|
|
|
|
children: [
|
|
|
|
|
{
|
|
|
|
|
isDirty: true,
|
|
|
|
|
isLoading: false,
|
|
|
|
|
isValid: true,
|
|
|
|
|
value: "test",
|
|
|
|
|
children: [],
|
|
|
|
|
type: "INPUT_WIDGET",
|
|
|
|
|
widgetId: "2_meta",
|
|
|
|
|
parentId: "1_meta",
|
|
|
|
|
topRow: 0,
|
|
|
|
|
bottomRow: 10,
|
|
|
|
|
widgetName: "meta_two",
|
|
|
|
|
skipForFormWidget: "test",
|
|
|
|
|
},
|
|
|
|
|
],
|
|
|
|
|
},
|
2022-08-19 10:10:36 +00:00
|
|
|
];
|
|
|
|
|
|
|
|
|
|
expect(
|
|
|
|
|
buildChildWidgetTree(
|
|
|
|
|
canvasWidgets,
|
2023-02-14 16:07:31 +00:00
|
|
|
metaWidgets,
|
2022-08-19 10:10:36 +00:00
|
|
|
dataTree,
|
|
|
|
|
new Set<string>("one"),
|
2023-03-20 11:04:02 +00:00
|
|
|
{},
|
2022-08-19 10:10:36 +00:00
|
|
|
"2",
|
|
|
|
|
),
|
|
|
|
|
).toEqual(childWidgetTree);
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it("should return a partial childwidgets Tree with properties specified", () => {
|
|
|
|
|
const childWidgetTree = [
|
|
|
|
|
{
|
|
|
|
|
bottomRow: 100,
|
|
|
|
|
children: [
|
|
|
|
|
{
|
|
|
|
|
bottomRow: 5,
|
|
|
|
|
children: [],
|
|
|
|
|
isDirty: true,
|
|
|
|
|
isLoading: false,
|
|
|
|
|
isValid: true,
|
|
|
|
|
parentId: "2",
|
|
|
|
|
topRow: 4,
|
|
|
|
|
type: "TEXT",
|
|
|
|
|
value: "test",
|
|
|
|
|
widgetId: "3",
|
|
|
|
|
widgetName: "three",
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
bottomRow: 18,
|
|
|
|
|
children: [],
|
|
|
|
|
isDirty: true,
|
|
|
|
|
isLoading: false,
|
|
|
|
|
isValid: true,
|
|
|
|
|
parentId: "2",
|
|
|
|
|
topRow: 6,
|
|
|
|
|
type: "BUTTON",
|
|
|
|
|
value: "test",
|
|
|
|
|
widgetId: "4",
|
|
|
|
|
widgetName: "four",
|
|
|
|
|
},
|
2023-02-14 16:07:31 +00:00
|
|
|
{
|
|
|
|
|
isLoading: false,
|
|
|
|
|
parentId: "2",
|
|
|
|
|
topRow: 0,
|
|
|
|
|
type: "CANVAS",
|
|
|
|
|
widgetId: "1_meta",
|
|
|
|
|
bottomRow: 100,
|
|
|
|
|
widgetName: "meta_one",
|
|
|
|
|
children: [
|
|
|
|
|
{
|
|
|
|
|
isDirty: true,
|
|
|
|
|
isLoading: false,
|
|
|
|
|
isValid: true,
|
|
|
|
|
value: "test",
|
|
|
|
|
children: [],
|
|
|
|
|
type: "INPUT_WIDGET",
|
|
|
|
|
widgetId: "2_meta",
|
|
|
|
|
parentId: "1_meta",
|
|
|
|
|
topRow: 0,
|
|
|
|
|
bottomRow: 10,
|
|
|
|
|
widgetName: "meta_two",
|
|
|
|
|
},
|
|
|
|
|
],
|
|
|
|
|
},
|
2022-08-19 10:10:36 +00:00
|
|
|
],
|
|
|
|
|
isDirty: true,
|
|
|
|
|
isLoading: false,
|
|
|
|
|
isValid: true,
|
|
|
|
|
parentId: "1",
|
|
|
|
|
topRow: 0,
|
|
|
|
|
type: "CANVAS",
|
|
|
|
|
value: "test",
|
|
|
|
|
widgetId: "2",
|
|
|
|
|
widgetName: "two",
|
|
|
|
|
},
|
|
|
|
|
];
|
|
|
|
|
|
|
|
|
|
expect(
|
|
|
|
|
buildChildWidgetTree(
|
|
|
|
|
canvasWidgets,
|
2023-02-14 16:07:31 +00:00
|
|
|
metaWidgets,
|
2022-08-19 10:10:36 +00:00
|
|
|
dataTree,
|
|
|
|
|
new Set<string>("two"),
|
2023-03-20 11:04:02 +00:00
|
|
|
{},
|
2022-08-19 10:10:36 +00:00
|
|
|
"1",
|
|
|
|
|
),
|
|
|
|
|
).toEqual(childWidgetTree);
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it("should return a partial childwidgets Tree with just loading widgets", () => {
|
|
|
|
|
const childWidgetTree = [
|
|
|
|
|
{
|
|
|
|
|
ENTITY_TYPE: "WIDGET",
|
|
|
|
|
bindingPaths: {},
|
|
|
|
|
bottomRow: 100,
|
|
|
|
|
children: [
|
|
|
|
|
{
|
|
|
|
|
ENTITY_TYPE: "WIDGET",
|
|
|
|
|
bindingPaths: {},
|
|
|
|
|
bottomRow: 5,
|
|
|
|
|
children: [],
|
|
|
|
|
isLoading: false,
|
|
|
|
|
logBlackList: {},
|
|
|
|
|
meta: {},
|
|
|
|
|
overridingPropertyPaths: {},
|
|
|
|
|
parentId: "2",
|
|
|
|
|
privateWidgets: {},
|
|
|
|
|
propertyOverrideDependency: {},
|
|
|
|
|
reactivePaths: {},
|
|
|
|
|
topRow: 4,
|
|
|
|
|
triggerPaths: {},
|
|
|
|
|
type: undefined,
|
|
|
|
|
validationPaths: {},
|
|
|
|
|
widgetId: "3",
|
|
|
|
|
widgetName: "three",
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
ENTITY_TYPE: "WIDGET",
|
|
|
|
|
bindingPaths: {},
|
|
|
|
|
bottomRow: 18,
|
|
|
|
|
children: [],
|
|
|
|
|
isLoading: false,
|
|
|
|
|
logBlackList: {},
|
|
|
|
|
meta: {},
|
|
|
|
|
overridingPropertyPaths: {},
|
|
|
|
|
parentId: "2",
|
|
|
|
|
privateWidgets: {},
|
|
|
|
|
propertyOverrideDependency: {},
|
|
|
|
|
reactivePaths: {},
|
|
|
|
|
topRow: 6,
|
|
|
|
|
triggerPaths: {},
|
|
|
|
|
type: undefined,
|
|
|
|
|
validationPaths: {},
|
|
|
|
|
widgetId: "4",
|
|
|
|
|
widgetName: "four",
|
|
|
|
|
},
|
2023-02-14 16:07:31 +00:00
|
|
|
{
|
|
|
|
|
ENTITY_TYPE: "WIDGET",
|
|
|
|
|
bindingPaths: {},
|
|
|
|
|
bottomRow: 100,
|
|
|
|
|
isLoading: false,
|
|
|
|
|
logBlackList: {},
|
|
|
|
|
meta: {},
|
|
|
|
|
overridingPropertyPaths: {},
|
|
|
|
|
parentId: "2",
|
|
|
|
|
privateWidgets: {},
|
|
|
|
|
propertyOverrideDependency: {},
|
|
|
|
|
reactivePaths: {},
|
|
|
|
|
topRow: 0,
|
|
|
|
|
triggerPaths: {},
|
|
|
|
|
type: undefined,
|
|
|
|
|
validationPaths: {},
|
|
|
|
|
widgetId: "1_meta",
|
|
|
|
|
widgetName: "meta_one",
|
|
|
|
|
children: [
|
|
|
|
|
{
|
|
|
|
|
ENTITY_TYPE: "WIDGET",
|
|
|
|
|
bindingPaths: {},
|
|
|
|
|
bottomRow: 10,
|
|
|
|
|
children: [],
|
|
|
|
|
isLoading: false,
|
|
|
|
|
logBlackList: {},
|
|
|
|
|
meta: {},
|
|
|
|
|
overridingPropertyPaths: {},
|
|
|
|
|
parentId: "1_meta",
|
|
|
|
|
privateWidgets: {},
|
|
|
|
|
propertyOverrideDependency: {},
|
|
|
|
|
reactivePaths: {},
|
|
|
|
|
topRow: 0,
|
|
|
|
|
triggerPaths: {},
|
|
|
|
|
type: undefined,
|
|
|
|
|
validationPaths: {},
|
|
|
|
|
widgetId: "2_meta",
|
|
|
|
|
widgetName: "meta_two",
|
|
|
|
|
},
|
|
|
|
|
],
|
|
|
|
|
},
|
2022-08-19 10:10:36 +00:00
|
|
|
],
|
|
|
|
|
isLoading: false,
|
|
|
|
|
logBlackList: {},
|
|
|
|
|
meta: {},
|
|
|
|
|
overridingPropertyPaths: {},
|
|
|
|
|
parentId: "1",
|
|
|
|
|
privateWidgets: {},
|
|
|
|
|
propertyOverrideDependency: {},
|
|
|
|
|
reactivePaths: {},
|
|
|
|
|
topRow: 0,
|
|
|
|
|
triggerPaths: {},
|
|
|
|
|
type: undefined,
|
|
|
|
|
validationPaths: {},
|
|
|
|
|
widgetId: "2",
|
|
|
|
|
widgetName: "two",
|
|
|
|
|
},
|
|
|
|
|
];
|
|
|
|
|
expect(
|
2023-02-14 16:07:31 +00:00
|
|
|
buildChildWidgetTree(
|
|
|
|
|
canvasWidgets,
|
|
|
|
|
metaWidgets,
|
|
|
|
|
{},
|
|
|
|
|
new Set<string>("one"),
|
2023-03-20 11:04:02 +00:00
|
|
|
{},
|
2023-02-14 16:07:31 +00:00
|
|
|
"1",
|
|
|
|
|
),
|
2022-08-19 10:10:36 +00:00
|
|
|
).toEqual(childWidgetTree);
|
|
|
|
|
});
|
|
|
|
|
});
|
|
|
|
|
});
|