2022-09-04 11:58:05 +00:00
|
|
|
import { Severity, ENTITY_TYPE, LOG_CATEGORY } from "entities/AppsmithConsole";
|
2023-02-18 12:55:46 +00:00
|
|
|
import LOG_TYPE from "entities/AppsmithConsole/logtype";
|
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";
|
2022-07-18 03:25:32 +00:00
|
|
|
import { PropertyEvaluationErrorType } from "utils/DynamicBindingUtils";
|
|
|
|
|
import { getFilteredErrors } from "./debuggerSelectors";
|
|
|
|
|
|
|
|
|
|
describe("getFilteredErrors", () => {
|
|
|
|
|
it("hides error from hidden widget in main canvas", () => {
|
|
|
|
|
const TestData = {
|
|
|
|
|
debuggerErrors: {
|
|
|
|
|
"main_input_id-defaultText": {
|
|
|
|
|
id: "main_input_id-defaultText",
|
2023-02-18 12:55:46 +00:00
|
|
|
logType: LOG_TYPE.EVAL_ERROR,
|
2022-07-18 03:25:32 +00:00
|
|
|
text: "The value at defaultText is invalid",
|
|
|
|
|
messages: [
|
|
|
|
|
{
|
2023-02-18 12:55:46 +00:00
|
|
|
message: {
|
|
|
|
|
name: "TypeError",
|
|
|
|
|
message:
|
|
|
|
|
"Cannot read properties of undefined (reading 'users')",
|
|
|
|
|
},
|
2022-07-18 03:25:32 +00:00
|
|
|
type: PropertyEvaluationErrorType.PARSE,
|
|
|
|
|
},
|
|
|
|
|
],
|
|
|
|
|
source: {
|
|
|
|
|
id: "main_input_id",
|
|
|
|
|
name: "main_input",
|
|
|
|
|
type: ENTITY_TYPE.WIDGET,
|
|
|
|
|
propertyPath: "defaultText",
|
|
|
|
|
},
|
|
|
|
|
state: {
|
|
|
|
|
defaultText: "",
|
|
|
|
|
},
|
|
|
|
|
analytics: {
|
|
|
|
|
widgetType: "INPUT_WIDGET_V2",
|
|
|
|
|
},
|
|
|
|
|
severity: Severity.ERROR,
|
|
|
|
|
timestamp: "02:40:10",
|
2022-09-04 11:58:05 +00:00
|
|
|
category: LOG_CATEGORY.PLATFORM_GENERATED,
|
2022-07-18 03:25:32 +00:00
|
|
|
},
|
|
|
|
|
},
|
|
|
|
|
canvasWidgets: {
|
|
|
|
|
main_input_id: {
|
|
|
|
|
widgetName: "main_input",
|
|
|
|
|
type: "INPUT_WIDGET_V2",
|
|
|
|
|
widgetId: "main_input_id",
|
|
|
|
|
parentId: "0",
|
|
|
|
|
},
|
|
|
|
|
},
|
|
|
|
|
dataTree: {
|
|
|
|
|
main_input: {
|
|
|
|
|
isVisible: false,
|
|
|
|
|
parentId: "0",
|
|
|
|
|
widgetId: "main_input_id",
|
|
|
|
|
type: "INPUT_WIDGET_V2",
|
|
|
|
|
ENTITY_TYPE: ENTITY_TYPE.WIDGET,
|
|
|
|
|
},
|
|
|
|
|
},
|
|
|
|
|
expectedResult: {},
|
|
|
|
|
};
|
|
|
|
|
const result = getFilteredErrors.resultFunc(
|
|
|
|
|
TestData.debuggerErrors,
|
|
|
|
|
false,
|
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
|
|
|
TestData.canvasWidgets as unknown as CanvasWidgetsReduxState,
|
|
|
|
|
TestData.dataTree as unknown as DataTree,
|
2022-07-18 03:25:32 +00:00
|
|
|
);
|
|
|
|
|
expect(result).toStrictEqual(TestData.expectedResult);
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it("hides error from widget in closed modal", () => {
|
|
|
|
|
const TestData = {
|
|
|
|
|
debuggerErrors: {
|
|
|
|
|
"modal_input-defaultText": {
|
|
|
|
|
id: "modal_input-defaultText",
|
2023-02-18 12:55:46 +00:00
|
|
|
logType: LOG_TYPE.EVAL_ERROR,
|
2022-07-18 03:25:32 +00:00
|
|
|
text: "The value at defaultText is invalid",
|
|
|
|
|
messages: [
|
|
|
|
|
{
|
2023-02-18 12:55:46 +00:00
|
|
|
message: {
|
|
|
|
|
name: "TypeError",
|
|
|
|
|
message:
|
|
|
|
|
"Cannot read properties of undefined (reading 'users')",
|
|
|
|
|
},
|
2022-07-18 03:25:32 +00:00
|
|
|
type: PropertyEvaluationErrorType.PARSE,
|
|
|
|
|
},
|
|
|
|
|
],
|
|
|
|
|
source: {
|
|
|
|
|
id: "modal_input",
|
|
|
|
|
name: "ModalInput",
|
|
|
|
|
type: ENTITY_TYPE.WIDGET,
|
|
|
|
|
propertyPath: "defaultText",
|
|
|
|
|
},
|
|
|
|
|
state: {
|
|
|
|
|
defaultText: "",
|
|
|
|
|
},
|
|
|
|
|
analytics: {
|
|
|
|
|
widgetType: "INPUT_WIDGET_V2",
|
|
|
|
|
},
|
|
|
|
|
severity: Severity.ERROR,
|
2022-09-04 11:58:05 +00:00
|
|
|
category: LOG_CATEGORY.PLATFORM_GENERATED,
|
2022-07-18 03:25:32 +00:00
|
|
|
timestamp: "02:40:10",
|
|
|
|
|
},
|
|
|
|
|
},
|
|
|
|
|
canvasWidgets: {
|
|
|
|
|
modal_input: {
|
|
|
|
|
widgetName: "ModalInput",
|
|
|
|
|
type: "INPUT_WIDGET_V2",
|
|
|
|
|
widgetId: "modal_input",
|
|
|
|
|
parentId: "modal_canvas_id",
|
|
|
|
|
},
|
|
|
|
|
modal_canvas_id: {
|
|
|
|
|
widgetName: "ModalCanvas",
|
|
|
|
|
type: "CANVAS_WIDGET",
|
|
|
|
|
widgetId: "modal_canvas_id",
|
|
|
|
|
parentId: "modal1_id",
|
|
|
|
|
},
|
|
|
|
|
modal1_id: {
|
|
|
|
|
widgetName: "Modal1",
|
|
|
|
|
type: "MODAL_WIDGET",
|
|
|
|
|
widgetId: "modal1_id",
|
|
|
|
|
parentId: "0",
|
|
|
|
|
},
|
|
|
|
|
},
|
|
|
|
|
dataTree: {
|
|
|
|
|
ModalInput: {
|
|
|
|
|
isVisible: true,
|
|
|
|
|
parentId: "modal_canvas_id",
|
|
|
|
|
widgetId: "modal_input",
|
|
|
|
|
type: "INPUT_WIDGET_V2",
|
|
|
|
|
ENTITY_TYPE: ENTITY_TYPE.WIDGET,
|
|
|
|
|
},
|
|
|
|
|
ModalCanvas: {
|
|
|
|
|
isVisible: true,
|
|
|
|
|
type: "CANVAS_WIDGET",
|
|
|
|
|
widgetId: "modal_canvas_id",
|
|
|
|
|
parentId: "modal1_id",
|
|
|
|
|
ENTITY_TYPE: ENTITY_TYPE.WIDGET,
|
|
|
|
|
},
|
|
|
|
|
Modal1: {
|
|
|
|
|
isVisible: false,
|
|
|
|
|
type: "MODAL_WIDGET",
|
|
|
|
|
widgetId: "modal1_id",
|
|
|
|
|
parentId: "0",
|
|
|
|
|
ENTITY_TYPE: ENTITY_TYPE.WIDGET,
|
|
|
|
|
},
|
|
|
|
|
},
|
|
|
|
|
expectedResult: {},
|
|
|
|
|
};
|
|
|
|
|
const result = getFilteredErrors.resultFunc(
|
|
|
|
|
TestData.debuggerErrors,
|
|
|
|
|
false,
|
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
|
|
|
TestData.canvasWidgets as unknown as CanvasWidgetsReduxState,
|
|
|
|
|
TestData.dataTree as unknown as DataTree,
|
2022-07-18 03:25:32 +00:00
|
|
|
);
|
|
|
|
|
expect(result).toStrictEqual(TestData.expectedResult);
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it("hides error from widget in non-active tab", () => {
|
|
|
|
|
const TestData = {
|
|
|
|
|
debuggerErrors: {
|
|
|
|
|
"tab2_input-defaultText": {
|
|
|
|
|
id: "tab2_input-defaultText",
|
2023-02-18 12:55:46 +00:00
|
|
|
logType: LOG_TYPE.EVAL_ERROR,
|
2022-07-18 03:25:32 +00:00
|
|
|
text: "The value at defaultText is invalid",
|
|
|
|
|
messages: [
|
|
|
|
|
{
|
2023-02-18 12:55:46 +00:00
|
|
|
message: {
|
|
|
|
|
name: "TypeError",
|
|
|
|
|
message:
|
|
|
|
|
"Cannot read properties of undefined (reading 'users')",
|
|
|
|
|
},
|
2022-07-18 03:25:32 +00:00
|
|
|
type: PropertyEvaluationErrorType.PARSE,
|
|
|
|
|
},
|
|
|
|
|
],
|
|
|
|
|
source: {
|
|
|
|
|
id: "tab2_input",
|
|
|
|
|
name: "Tab2Input",
|
|
|
|
|
type: ENTITY_TYPE.WIDGET,
|
|
|
|
|
propertyPath: "defaultText",
|
|
|
|
|
},
|
|
|
|
|
state: {
|
|
|
|
|
defaultText: "",
|
|
|
|
|
},
|
|
|
|
|
analytics: {
|
|
|
|
|
widgetType: "INPUT_WIDGET_V2",
|
|
|
|
|
},
|
|
|
|
|
severity: Severity.ERROR,
|
2022-09-04 11:58:05 +00:00
|
|
|
category: LOG_CATEGORY.PLATFORM_GENERATED,
|
2022-07-18 03:25:32 +00:00
|
|
|
timestamp: "02:40:10",
|
|
|
|
|
},
|
|
|
|
|
},
|
|
|
|
|
canvasWidgets: {
|
|
|
|
|
tab1_id: {
|
|
|
|
|
tabId: "tab1",
|
|
|
|
|
widgetName: "Tab1Canvas",
|
|
|
|
|
type: "CANVAS_WIDGET",
|
|
|
|
|
tabName: "Tab 1",
|
|
|
|
|
widgetId: "tab1_id",
|
|
|
|
|
parentId: "tabs_widget_id",
|
|
|
|
|
},
|
|
|
|
|
tab2_input: {
|
|
|
|
|
widgetName: "Tab2Input",
|
|
|
|
|
type: "INPUT_WIDGET_V2",
|
|
|
|
|
widgetId: "tab2_input",
|
|
|
|
|
parentId: "tab2_id",
|
|
|
|
|
},
|
|
|
|
|
tab2_id: {
|
|
|
|
|
tabId: "tab2",
|
|
|
|
|
widgetName: "Tab2Canvas",
|
|
|
|
|
type: "CANVAS_WIDGET",
|
|
|
|
|
tabName: "Tab 2",
|
|
|
|
|
widgetId: "tab2_id",
|
|
|
|
|
parentId: "tabs_widget_id",
|
|
|
|
|
},
|
|
|
|
|
tabs_widget_id: {
|
|
|
|
|
widgetName: "Tabs1",
|
|
|
|
|
type: "TABS_WIDGET",
|
|
|
|
|
widgetId: "tabs_widget_id",
|
|
|
|
|
defaultTab: "Tab 1",
|
|
|
|
|
parentId: "0",
|
|
|
|
|
},
|
|
|
|
|
},
|
|
|
|
|
dataTree: {
|
|
|
|
|
Tab1Canvas: {
|
|
|
|
|
tabId: "tab1",
|
|
|
|
|
type: "CANVAS_WIDGET",
|
|
|
|
|
tabName: "Tab 1",
|
|
|
|
|
widgetId: "tab1_id",
|
|
|
|
|
isVisible: true,
|
|
|
|
|
parentId: "tabs_widget_id",
|
|
|
|
|
ENTITY_TYPE: "WIDGET",
|
|
|
|
|
},
|
|
|
|
|
Tab2Input: {
|
|
|
|
|
type: "INPUT_WIDGET_V2",
|
|
|
|
|
widgetId: "tab2_input",
|
|
|
|
|
isVisible: true,
|
|
|
|
|
parentId: "tab2_id",
|
|
|
|
|
ENTITY_TYPE: "WIDGET",
|
|
|
|
|
},
|
|
|
|
|
Tab2Canvas: {
|
|
|
|
|
tabId: "tab2",
|
|
|
|
|
tabName: "Tab 2",
|
|
|
|
|
widgetId: "tab2_id",
|
|
|
|
|
isVisible: true,
|
|
|
|
|
parentId: "tabs_widget_id",
|
|
|
|
|
ENTITY_TYPE: "WIDGET",
|
|
|
|
|
},
|
|
|
|
|
Tabs1: {
|
|
|
|
|
isVisible: true,
|
|
|
|
|
widgetName: "Tabs1",
|
|
|
|
|
type: "TABS_WIDGET",
|
|
|
|
|
widgetId: "tabs_widget_id",
|
|
|
|
|
defaultTab: "Tab 1",
|
|
|
|
|
parentId: "0",
|
|
|
|
|
selectedTab: "Tab 1",
|
|
|
|
|
ENTITY_TYPE: "WIDGET",
|
|
|
|
|
},
|
|
|
|
|
},
|
|
|
|
|
expectedResult: {},
|
|
|
|
|
};
|
|
|
|
|
const result = getFilteredErrors.resultFunc(
|
|
|
|
|
TestData.debuggerErrors,
|
|
|
|
|
false,
|
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
|
|
|
TestData.canvasWidgets as unknown as CanvasWidgetsReduxState,
|
|
|
|
|
TestData.dataTree as unknown as DataTree,
|
2022-07-18 03:25:32 +00:00
|
|
|
);
|
|
|
|
|
expect(result).toStrictEqual(TestData.expectedResult);
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it("hides error from widget in active tab (hidden tab widget)", () => {
|
|
|
|
|
const TestData = {
|
|
|
|
|
debuggerErrors: {
|
|
|
|
|
"tab2_input-defaultText": {
|
|
|
|
|
id: "tab2_input-defaultText",
|
2023-02-18 12:55:46 +00:00
|
|
|
logType: LOG_TYPE.EVAL_ERROR,
|
2022-07-18 03:25:32 +00:00
|
|
|
text: "The value at defaultText is invalid",
|
|
|
|
|
messages: [
|
|
|
|
|
{
|
2023-02-18 12:55:46 +00:00
|
|
|
message: {
|
|
|
|
|
name: "TypeError",
|
|
|
|
|
message:
|
|
|
|
|
"Cannot read properties of undefined (reading 'users')",
|
|
|
|
|
},
|
2022-07-18 03:25:32 +00:00
|
|
|
type: PropertyEvaluationErrorType.PARSE,
|
|
|
|
|
},
|
|
|
|
|
],
|
|
|
|
|
source: {
|
|
|
|
|
id: "tab2_input",
|
|
|
|
|
name: "Tab2Input",
|
|
|
|
|
type: ENTITY_TYPE.WIDGET,
|
|
|
|
|
propertyPath: "defaultText",
|
|
|
|
|
},
|
|
|
|
|
state: {
|
|
|
|
|
defaultText: "",
|
|
|
|
|
},
|
|
|
|
|
analytics: {
|
|
|
|
|
widgetType: "INPUT_WIDGET_V2",
|
|
|
|
|
},
|
|
|
|
|
severity: Severity.ERROR,
|
2022-09-04 11:58:05 +00:00
|
|
|
category: LOG_CATEGORY.PLATFORM_GENERATED,
|
2022-07-18 03:25:32 +00:00
|
|
|
timestamp: "02:40:10",
|
|
|
|
|
},
|
|
|
|
|
},
|
|
|
|
|
canvasWidgets: {
|
|
|
|
|
tab1_id: {
|
|
|
|
|
tabId: "tab1",
|
|
|
|
|
widgetName: "Tab1Canvas",
|
|
|
|
|
type: "CANVAS_WIDGET",
|
|
|
|
|
tabName: "Tab 1",
|
|
|
|
|
widgetId: "tab1_id",
|
|
|
|
|
parentId: "tabs_widget_id",
|
|
|
|
|
},
|
|
|
|
|
tab2_input: {
|
|
|
|
|
widgetName: "Tab2Input",
|
|
|
|
|
type: "INPUT_WIDGET_V2",
|
|
|
|
|
widgetId: "tab2_input",
|
|
|
|
|
parentId: "tab2_id",
|
|
|
|
|
},
|
|
|
|
|
tab2_id: {
|
|
|
|
|
tabId: "tab2",
|
|
|
|
|
widgetName: "Tab2Canvas",
|
|
|
|
|
type: "CANVAS_WIDGET",
|
|
|
|
|
tabName: "Tab 2",
|
|
|
|
|
widgetId: "tab2_id",
|
|
|
|
|
parentId: "tabs_widget_id",
|
|
|
|
|
},
|
|
|
|
|
tabs_widget_id: {
|
|
|
|
|
widgetName: "Tabs1",
|
|
|
|
|
type: "TABS_WIDGET",
|
|
|
|
|
widgetId: "tabs_widget_id",
|
|
|
|
|
defaultTab: "Tab 1",
|
|
|
|
|
parentId: "0",
|
|
|
|
|
},
|
|
|
|
|
},
|
|
|
|
|
dataTree: {
|
|
|
|
|
Tab1Canvas: {
|
|
|
|
|
tabId: "tab1",
|
|
|
|
|
type: "CANVAS_WIDGET",
|
|
|
|
|
tabName: "Tab 1",
|
|
|
|
|
widgetId: "tab1_id",
|
|
|
|
|
isVisible: true,
|
|
|
|
|
parentId: "tabs_widget_id",
|
|
|
|
|
ENTITY_TYPE: "WIDGET",
|
|
|
|
|
},
|
|
|
|
|
Tab2Input: {
|
|
|
|
|
type: "INPUT_WIDGET_V2",
|
|
|
|
|
widgetId: "tab2_input",
|
|
|
|
|
isVisible: true,
|
|
|
|
|
parentId: "tab2_id",
|
|
|
|
|
ENTITY_TYPE: "WIDGET",
|
|
|
|
|
},
|
|
|
|
|
Tab2Canvas: {
|
|
|
|
|
tabId: "tab2",
|
|
|
|
|
tabName: "Tab 2",
|
|
|
|
|
widgetId: "tab2_id",
|
|
|
|
|
isVisible: true,
|
|
|
|
|
parentId: "tabs_widget_id",
|
|
|
|
|
ENTITY_TYPE: "WIDGET",
|
|
|
|
|
},
|
|
|
|
|
Tabs1: {
|
|
|
|
|
isVisible: false,
|
|
|
|
|
widgetName: "Tabs1",
|
|
|
|
|
type: "TABS_WIDGET",
|
|
|
|
|
widgetId: "tabs_widget_id",
|
|
|
|
|
defaultTab: "Tab 1",
|
|
|
|
|
parentId: "0",
|
|
|
|
|
selectedTab: "Tab 2",
|
|
|
|
|
ENTITY_TYPE: "WIDGET",
|
|
|
|
|
},
|
|
|
|
|
},
|
|
|
|
|
expectedResult: {},
|
|
|
|
|
};
|
|
|
|
|
const result = getFilteredErrors.resultFunc(
|
|
|
|
|
TestData.debuggerErrors,
|
|
|
|
|
false,
|
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
|
|
|
TestData.canvasWidgets as unknown as CanvasWidgetsReduxState,
|
|
|
|
|
TestData.dataTree as unknown as DataTree,
|
2022-07-18 03:25:32 +00:00
|
|
|
);
|
|
|
|
|
expect(result).toStrictEqual(TestData.expectedResult);
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it("hides error from widget in active tab (tab widget inside hidden container)", () => {
|
|
|
|
|
const TestData = {
|
|
|
|
|
debuggerErrors: {
|
|
|
|
|
"tab2_input-defaultText": {
|
|
|
|
|
id: "tab2_input-defaultText",
|
2023-02-18 12:55:46 +00:00
|
|
|
logType: LOG_TYPE.EVAL_ERROR,
|
2022-07-18 03:25:32 +00:00
|
|
|
text: "The value at defaultText is invalid",
|
|
|
|
|
messages: [
|
|
|
|
|
{
|
2023-02-18 12:55:46 +00:00
|
|
|
message: {
|
|
|
|
|
name: "TypeError",
|
|
|
|
|
message:
|
|
|
|
|
"Cannot read properties of undefined (reading 'users')",
|
|
|
|
|
},
|
2022-07-18 03:25:32 +00:00
|
|
|
type: PropertyEvaluationErrorType.PARSE,
|
|
|
|
|
},
|
|
|
|
|
],
|
|
|
|
|
source: {
|
|
|
|
|
id: "tab2_input",
|
|
|
|
|
name: "Tab2Input",
|
|
|
|
|
type: ENTITY_TYPE.WIDGET,
|
|
|
|
|
propertyPath: "defaultText",
|
|
|
|
|
},
|
|
|
|
|
state: {
|
|
|
|
|
defaultText: "",
|
|
|
|
|
},
|
|
|
|
|
analytics: {
|
|
|
|
|
widgetType: "INPUT_WIDGET_V2",
|
|
|
|
|
},
|
|
|
|
|
severity: Severity.ERROR,
|
2022-09-04 11:58:05 +00:00
|
|
|
category: LOG_CATEGORY.PLATFORM_GENERATED,
|
2022-07-18 03:25:32 +00:00
|
|
|
timestamp: "02:40:10",
|
|
|
|
|
},
|
|
|
|
|
},
|
|
|
|
|
canvasWidgets: {
|
|
|
|
|
tab1_id: {
|
|
|
|
|
tabId: "tab1",
|
|
|
|
|
widgetName: "Tab1Canvas",
|
|
|
|
|
type: "CANVAS_WIDGET",
|
|
|
|
|
tabName: "Tab 1",
|
|
|
|
|
widgetId: "tab1_id",
|
|
|
|
|
parentId: "tabs_widget_id",
|
|
|
|
|
},
|
|
|
|
|
tab2_input: {
|
|
|
|
|
widgetName: "Tab2Input",
|
|
|
|
|
type: "INPUT_WIDGET_V2",
|
|
|
|
|
widgetId: "tab2_input",
|
|
|
|
|
parentId: "tab2_id",
|
|
|
|
|
},
|
|
|
|
|
tab2_id: {
|
|
|
|
|
tabId: "tab2",
|
|
|
|
|
widgetName: "Tab2Canvas",
|
|
|
|
|
type: "CANVAS_WIDGET",
|
|
|
|
|
tabName: "Tab 2",
|
|
|
|
|
widgetId: "tab2_id",
|
|
|
|
|
parentId: "tabs_widget_id",
|
|
|
|
|
},
|
|
|
|
|
tabs_widget_id: {
|
|
|
|
|
widgetName: "Tabs1",
|
|
|
|
|
type: "TABS_WIDGET",
|
|
|
|
|
widgetId: "tabs_widget_id",
|
|
|
|
|
defaultTab: "Tab 1",
|
|
|
|
|
parentId: "canvas_widget_id",
|
|
|
|
|
},
|
|
|
|
|
canvas_widget_id: {
|
|
|
|
|
widgetName: "ContainerCanvas",
|
|
|
|
|
type: "CANVAS_WIDGET",
|
|
|
|
|
widgetId: "canvas_widget_id",
|
|
|
|
|
parentId: "container1_id",
|
|
|
|
|
},
|
|
|
|
|
container1_id: {
|
|
|
|
|
widgetName: "Container1",
|
|
|
|
|
type: "CONTAINER_WIDGET",
|
|
|
|
|
widgetId: "container1_id",
|
|
|
|
|
parentId: "0",
|
|
|
|
|
},
|
|
|
|
|
},
|
|
|
|
|
dataTree: {
|
|
|
|
|
Tab1Canvas: {
|
|
|
|
|
tabId: "tab1",
|
|
|
|
|
type: "CANVAS_WIDGET",
|
|
|
|
|
tabName: "Tab 1",
|
|
|
|
|
widgetId: "tab1_id",
|
|
|
|
|
isVisible: true,
|
|
|
|
|
parentId: "tabs_widget_id",
|
|
|
|
|
ENTITY_TYPE: "WIDGET",
|
|
|
|
|
},
|
|
|
|
|
Tab2Input: {
|
|
|
|
|
type: "INPUT_WIDGET_V2",
|
|
|
|
|
widgetId: "tab2_input",
|
|
|
|
|
isVisible: true,
|
|
|
|
|
parentId: "tab2_id",
|
|
|
|
|
ENTITY_TYPE: "WIDGET",
|
|
|
|
|
},
|
|
|
|
|
Tab2Canvas: {
|
|
|
|
|
tabId: "tab2",
|
|
|
|
|
tabName: "Tab 2",
|
|
|
|
|
widgetId: "tab2_id",
|
|
|
|
|
isVisible: true,
|
|
|
|
|
parentId: "tabs_widget_id",
|
|
|
|
|
ENTITY_TYPE: "WIDGET",
|
|
|
|
|
},
|
|
|
|
|
Tabs1: {
|
|
|
|
|
isVisible: true,
|
|
|
|
|
widgetName: "Tabs1",
|
|
|
|
|
type: "TABS_WIDGET",
|
|
|
|
|
widgetId: "tabs_widget_id",
|
|
|
|
|
defaultTab: "Tab 1",
|
|
|
|
|
parentId: "canvas_widget_id",
|
|
|
|
|
selectedTab: "Tab 2",
|
|
|
|
|
ENTITY_TYPE: "WIDGET",
|
|
|
|
|
},
|
|
|
|
|
ContainerCanvas: {
|
|
|
|
|
type: "CANVAS_WIDGET",
|
|
|
|
|
widgetId: "canvas_widget_id",
|
|
|
|
|
isVisible: true,
|
|
|
|
|
parentId: "container1_id",
|
|
|
|
|
ENTITY_TYPE: "WIDGET",
|
|
|
|
|
},
|
|
|
|
|
Container1: {
|
|
|
|
|
type: "CONTAINER_WIDGET",
|
|
|
|
|
widgetId: "container1_id",
|
|
|
|
|
isVisible: false,
|
|
|
|
|
parentId: "0",
|
|
|
|
|
ENTITY_TYPE: "WIDGET",
|
|
|
|
|
},
|
|
|
|
|
},
|
|
|
|
|
expectedResult: {},
|
|
|
|
|
};
|
|
|
|
|
const result = getFilteredErrors.resultFunc(
|
|
|
|
|
TestData.debuggerErrors,
|
|
|
|
|
false,
|
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
|
|
|
TestData.canvasWidgets as unknown as CanvasWidgetsReduxState,
|
|
|
|
|
TestData.dataTree as unknown as DataTree,
|
2022-07-18 03:25:32 +00:00
|
|
|
);
|
|
|
|
|
expect(result).toStrictEqual(TestData.expectedResult);
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it("hides error from widget in hidden container", () => {
|
|
|
|
|
const TestData = {
|
|
|
|
|
debuggerErrors: {
|
|
|
|
|
"container1_input_id-defaultText": {
|
|
|
|
|
id: "container1_input_id-defaultText",
|
2023-02-18 12:55:46 +00:00
|
|
|
logType: LOG_TYPE.EVAL_ERROR,
|
2022-07-18 03:25:32 +00:00
|
|
|
text: "The value at defaultText is invalid",
|
|
|
|
|
messages: [
|
|
|
|
|
{
|
2023-02-18 12:55:46 +00:00
|
|
|
message: {
|
|
|
|
|
name: "TypeError",
|
|
|
|
|
message:
|
|
|
|
|
"Cannot read properties of undefined (reading 'users')",
|
|
|
|
|
},
|
2022-07-18 03:25:32 +00:00
|
|
|
type: PropertyEvaluationErrorType.PARSE,
|
|
|
|
|
},
|
|
|
|
|
],
|
|
|
|
|
source: {
|
|
|
|
|
id: "container1_input_id",
|
|
|
|
|
name: "container1_input",
|
|
|
|
|
type: ENTITY_TYPE.WIDGET,
|
|
|
|
|
propertyPath: "defaultText",
|
|
|
|
|
},
|
|
|
|
|
state: {
|
|
|
|
|
defaultText: "",
|
|
|
|
|
},
|
|
|
|
|
analytics: {
|
|
|
|
|
widgetType: "INPUT_WIDGET_V2",
|
|
|
|
|
},
|
|
|
|
|
severity: Severity.ERROR,
|
2022-09-04 11:58:05 +00:00
|
|
|
category: LOG_CATEGORY.PLATFORM_GENERATED,
|
2022-07-18 03:25:32 +00:00
|
|
|
timestamp: "02:40:10",
|
|
|
|
|
},
|
|
|
|
|
},
|
|
|
|
|
canvasWidgets: {
|
|
|
|
|
container1_input_id: {
|
|
|
|
|
widgetName: "container1_input",
|
|
|
|
|
type: "INPUT_WIDGET_V2",
|
|
|
|
|
widgetId: "container1_input_id",
|
|
|
|
|
parentId: "canvas_widget_id",
|
|
|
|
|
},
|
|
|
|
|
canvas_widget_id: {
|
|
|
|
|
widgetName: "ContainerCanvas",
|
|
|
|
|
type: "CANVAS_WIDGET",
|
|
|
|
|
widgetId: "canvas_widget_id",
|
|
|
|
|
parentId: "container1_id",
|
|
|
|
|
},
|
|
|
|
|
container1_id: {
|
|
|
|
|
widgetName: "Container1",
|
|
|
|
|
type: "CONTAINER_WIDGET",
|
|
|
|
|
widgetId: "container1_id",
|
|
|
|
|
parentId: "0",
|
|
|
|
|
},
|
|
|
|
|
},
|
|
|
|
|
dataTree: {
|
|
|
|
|
container1_input: {
|
|
|
|
|
type: "INPUT_WIDGET_V2",
|
|
|
|
|
widgetId: "container1_input_id",
|
|
|
|
|
isVisible: true,
|
|
|
|
|
parentId: "canvas_widget_id",
|
|
|
|
|
ENTITY_TYPE: "WIDGET",
|
|
|
|
|
},
|
|
|
|
|
ContainerCanvas: {
|
|
|
|
|
type: "CANVAS_WIDGET",
|
|
|
|
|
widgetId: "canvas_widget_id",
|
|
|
|
|
isVisible: true,
|
|
|
|
|
parentId: "container1_id",
|
|
|
|
|
ENTITY_TYPE: "WIDGET",
|
|
|
|
|
},
|
|
|
|
|
Container1: {
|
|
|
|
|
type: "CONTAINER_WIDGET",
|
|
|
|
|
widgetId: "container1_id",
|
|
|
|
|
isVisible: false,
|
|
|
|
|
parentId: "0",
|
|
|
|
|
ENTITY_TYPE: "WIDGET",
|
|
|
|
|
},
|
|
|
|
|
},
|
|
|
|
|
expectedResult: {},
|
|
|
|
|
};
|
|
|
|
|
const result = getFilteredErrors.resultFunc(
|
|
|
|
|
TestData.debuggerErrors,
|
|
|
|
|
false,
|
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
|
|
|
TestData.canvasWidgets as unknown as CanvasWidgetsReduxState,
|
|
|
|
|
TestData.dataTree as unknown as DataTree,
|
2022-07-18 03:25:32 +00:00
|
|
|
);
|
|
|
|
|
expect(result).toStrictEqual(TestData.expectedResult);
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it("shows error for widget with faulty binding for isVisible prop", () => {
|
|
|
|
|
const TestData = {
|
|
|
|
|
debuggerErrors: {
|
|
|
|
|
"main_input_id-isVisible": {
|
|
|
|
|
id: "main_input_id-isVisible",
|
2023-02-18 12:55:46 +00:00
|
|
|
logType: LOG_TYPE.EVAL_ERROR,
|
2022-07-18 03:25:32 +00:00
|
|
|
text: "The value at isVisible is invalid",
|
|
|
|
|
messages: [
|
|
|
|
|
{
|
2023-02-18 12:55:46 +00:00
|
|
|
message: {
|
|
|
|
|
name: "TypeError",
|
|
|
|
|
message:
|
|
|
|
|
"Cannot read properties of undefined (reading 'users')",
|
|
|
|
|
},
|
2022-07-18 03:25:32 +00:00
|
|
|
type: PropertyEvaluationErrorType.PARSE,
|
|
|
|
|
},
|
|
|
|
|
],
|
|
|
|
|
source: {
|
|
|
|
|
id: "main_input_id",
|
|
|
|
|
name: "main_input",
|
|
|
|
|
type: ENTITY_TYPE.WIDGET,
|
|
|
|
|
propertyPath: "isVisible",
|
|
|
|
|
},
|
|
|
|
|
state: {
|
|
|
|
|
isVisible: "{{users}}",
|
|
|
|
|
},
|
|
|
|
|
analytics: {
|
|
|
|
|
widgetType: "INPUT_WIDGET_V2",
|
|
|
|
|
},
|
|
|
|
|
severity: Severity.ERROR,
|
2022-09-04 11:58:05 +00:00
|
|
|
category: LOG_CATEGORY.PLATFORM_GENERATED,
|
2022-07-18 03:25:32 +00:00
|
|
|
timestamp: "02:40:10",
|
|
|
|
|
},
|
|
|
|
|
},
|
|
|
|
|
canvasWidgets: {
|
|
|
|
|
main_input_id: {
|
|
|
|
|
widgetName: "main_input",
|
|
|
|
|
type: "INPUT_WIDGET_V2",
|
|
|
|
|
widgetId: "main_input_id",
|
|
|
|
|
parentId: "0",
|
|
|
|
|
},
|
|
|
|
|
},
|
|
|
|
|
dataTree: {
|
|
|
|
|
main_input: {
|
|
|
|
|
isVisible: false,
|
|
|
|
|
parentId: "0",
|
|
|
|
|
widgetId: "main_input_id",
|
|
|
|
|
type: "INPUT_WIDGET_V2",
|
|
|
|
|
ENTITY_TYPE: ENTITY_TYPE.WIDGET,
|
|
|
|
|
},
|
|
|
|
|
},
|
|
|
|
|
expectedResult: {
|
|
|
|
|
"main_input_id-isVisible": {
|
|
|
|
|
id: "main_input_id-isVisible",
|
2023-02-18 12:55:46 +00:00
|
|
|
logType: LOG_TYPE.EVAL_ERROR,
|
2022-09-04 11:58:05 +00:00
|
|
|
category: LOG_CATEGORY.PLATFORM_GENERATED,
|
2022-07-18 03:25:32 +00:00
|
|
|
text: "The value at isVisible is invalid",
|
|
|
|
|
messages: [
|
|
|
|
|
{
|
2023-02-18 12:55:46 +00:00
|
|
|
message: {
|
|
|
|
|
name: "TypeError",
|
|
|
|
|
message:
|
|
|
|
|
"Cannot read properties of undefined (reading 'users')",
|
|
|
|
|
},
|
2022-07-18 03:25:32 +00:00
|
|
|
type: PropertyEvaluationErrorType.PARSE,
|
|
|
|
|
},
|
|
|
|
|
],
|
|
|
|
|
source: {
|
|
|
|
|
id: "main_input_id",
|
|
|
|
|
name: "main_input",
|
|
|
|
|
type: ENTITY_TYPE.WIDGET,
|
|
|
|
|
propertyPath: "isVisible",
|
|
|
|
|
},
|
|
|
|
|
state: {
|
|
|
|
|
isVisible: "{{users}}",
|
|
|
|
|
},
|
|
|
|
|
analytics: {
|
|
|
|
|
widgetType: "INPUT_WIDGET_V2",
|
|
|
|
|
},
|
|
|
|
|
severity: Severity.ERROR,
|
|
|
|
|
timestamp: "02:40:10",
|
|
|
|
|
},
|
|
|
|
|
},
|
|
|
|
|
};
|
|
|
|
|
const result = getFilteredErrors.resultFunc(
|
|
|
|
|
TestData.debuggerErrors,
|
|
|
|
|
false,
|
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
|
|
|
TestData.canvasWidgets as unknown as CanvasWidgetsReduxState,
|
|
|
|
|
TestData.dataTree as unknown as DataTree,
|
2022-07-18 03:25:32 +00:00
|
|
|
);
|
|
|
|
|
expect(result).toStrictEqual(TestData.expectedResult);
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it("shows error for widget with faulty binding for isVisible prop (visible parent container)", () => {
|
|
|
|
|
const TestData = {
|
|
|
|
|
debuggerErrors: {
|
|
|
|
|
"container1_input_id-isVisible": {
|
|
|
|
|
id: "container1_input_id-isVisible",
|
2023-02-18 12:55:46 +00:00
|
|
|
logType: LOG_TYPE.EVAL_ERROR,
|
2022-07-18 03:25:32 +00:00
|
|
|
text: "The value at isVisible is invalid",
|
|
|
|
|
messages: [
|
|
|
|
|
{
|
2023-02-18 12:55:46 +00:00
|
|
|
message: {
|
|
|
|
|
name: "TypeError",
|
|
|
|
|
message:
|
|
|
|
|
"Cannot read properties of undefined (reading 'users')",
|
|
|
|
|
},
|
2022-07-18 03:25:32 +00:00
|
|
|
type: PropertyEvaluationErrorType.PARSE,
|
|
|
|
|
},
|
|
|
|
|
],
|
|
|
|
|
source: {
|
|
|
|
|
id: "container1_input_id",
|
|
|
|
|
name: "container1_input",
|
|
|
|
|
type: ENTITY_TYPE.WIDGET,
|
|
|
|
|
propertyPath: "isVisible",
|
|
|
|
|
},
|
|
|
|
|
state: {
|
|
|
|
|
isVisible: "{{users}}",
|
|
|
|
|
},
|
|
|
|
|
analytics: {
|
|
|
|
|
widgetType: "INPUT_WIDGET_V2",
|
|
|
|
|
},
|
|
|
|
|
severity: Severity.ERROR,
|
2022-09-04 11:58:05 +00:00
|
|
|
category: LOG_CATEGORY.PLATFORM_GENERATED,
|
2022-07-18 03:25:32 +00:00
|
|
|
timestamp: "02:40:10",
|
|
|
|
|
},
|
|
|
|
|
},
|
|
|
|
|
canvasWidgets: {
|
|
|
|
|
container1_input_id: {
|
|
|
|
|
widgetName: "container1_input",
|
|
|
|
|
type: "INPUT_WIDGET_V2",
|
|
|
|
|
widgetId: "container1_input_id",
|
|
|
|
|
parentId: "canvas_widget_id",
|
|
|
|
|
},
|
|
|
|
|
canvas_widget_id: {
|
|
|
|
|
widgetName: "ContainerCanvas",
|
|
|
|
|
type: "CANVAS_WIDGET",
|
|
|
|
|
widgetId: "canvas_widget_id",
|
|
|
|
|
parentId: "container1_id",
|
|
|
|
|
},
|
|
|
|
|
container1_id: {
|
|
|
|
|
widgetName: "Container1",
|
|
|
|
|
type: "CONTAINER_WIDGET",
|
|
|
|
|
widgetId: "container1_id",
|
|
|
|
|
parentId: "0",
|
|
|
|
|
},
|
|
|
|
|
},
|
|
|
|
|
dataTree: {
|
|
|
|
|
container1_input: {
|
|
|
|
|
type: "INPUT_WIDGET_V2",
|
|
|
|
|
widgetId: "container1_input_id",
|
|
|
|
|
isVisible: false,
|
|
|
|
|
parentId: "canvas_widget_id",
|
|
|
|
|
ENTITY_TYPE: "WIDGET",
|
|
|
|
|
},
|
|
|
|
|
ContainerCanvas: {
|
|
|
|
|
type: "CANVAS_WIDGET",
|
|
|
|
|
widgetId: "canvas_widget_id",
|
|
|
|
|
isVisible: true,
|
|
|
|
|
parentId: "container1_id",
|
|
|
|
|
ENTITY_TYPE: "WIDGET",
|
|
|
|
|
},
|
|
|
|
|
Container1: {
|
|
|
|
|
type: "CONTAINER_WIDGET",
|
|
|
|
|
widgetId: "container1_id",
|
|
|
|
|
isVisible: true,
|
|
|
|
|
parentId: "0",
|
|
|
|
|
ENTITY_TYPE: "WIDGET",
|
|
|
|
|
},
|
|
|
|
|
},
|
|
|
|
|
expectedResult: {
|
|
|
|
|
"container1_input_id-isVisible": {
|
|
|
|
|
id: "container1_input_id-isVisible",
|
2023-02-18 12:55:46 +00:00
|
|
|
logType: LOG_TYPE.EVAL_ERROR,
|
2022-07-18 03:25:32 +00:00
|
|
|
text: "The value at isVisible is invalid",
|
|
|
|
|
messages: [
|
|
|
|
|
{
|
2023-02-18 12:55:46 +00:00
|
|
|
message: {
|
|
|
|
|
name: "TypeError",
|
|
|
|
|
message:
|
|
|
|
|
"Cannot read properties of undefined (reading 'users')",
|
|
|
|
|
},
|
2022-07-18 03:25:32 +00:00
|
|
|
type: PropertyEvaluationErrorType.PARSE,
|
|
|
|
|
},
|
|
|
|
|
],
|
|
|
|
|
source: {
|
|
|
|
|
id: "container1_input_id",
|
|
|
|
|
name: "container1_input",
|
|
|
|
|
type: ENTITY_TYPE.WIDGET,
|
|
|
|
|
propertyPath: "isVisible",
|
|
|
|
|
},
|
|
|
|
|
state: {
|
|
|
|
|
isVisible: "{{users}}",
|
|
|
|
|
},
|
|
|
|
|
analytics: {
|
|
|
|
|
widgetType: "INPUT_WIDGET_V2",
|
|
|
|
|
},
|
|
|
|
|
severity: Severity.ERROR,
|
2022-09-04 11:58:05 +00:00
|
|
|
|
|
|
|
|
category: LOG_CATEGORY.PLATFORM_GENERATED,
|
2022-07-18 03:25:32 +00:00
|
|
|
timestamp: "02:40:10",
|
|
|
|
|
},
|
|
|
|
|
},
|
|
|
|
|
};
|
|
|
|
|
const result = getFilteredErrors.resultFunc(
|
|
|
|
|
TestData.debuggerErrors,
|
|
|
|
|
false,
|
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
|
|
|
TestData.canvasWidgets as unknown as CanvasWidgetsReduxState,
|
|
|
|
|
TestData.dataTree as unknown as DataTree,
|
2022-07-18 03:25:32 +00:00
|
|
|
);
|
|
|
|
|
expect(result).toStrictEqual(TestData.expectedResult);
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it("hides error for widget with faulty binding for isVisible prop (hidden parent container)", () => {
|
|
|
|
|
const TestData = {
|
|
|
|
|
debuggerErrors: {
|
|
|
|
|
"container1_input_id-isVisible": {
|
|
|
|
|
id: "container1_input_id-isVisible",
|
2023-02-18 12:55:46 +00:00
|
|
|
logType: LOG_TYPE.EVAL_ERROR,
|
2022-07-18 03:25:32 +00:00
|
|
|
text: "The value at isVisible is invalid",
|
|
|
|
|
messages: [
|
|
|
|
|
{
|
2023-02-18 12:55:46 +00:00
|
|
|
message: {
|
|
|
|
|
name: "TypeError",
|
|
|
|
|
message:
|
|
|
|
|
"Cannot read properties of undefined (reading 'users')",
|
|
|
|
|
},
|
2022-07-18 03:25:32 +00:00
|
|
|
type: PropertyEvaluationErrorType.PARSE,
|
|
|
|
|
},
|
|
|
|
|
],
|
|
|
|
|
source: {
|
|
|
|
|
id: "container1_input_id",
|
|
|
|
|
name: "container1_input",
|
|
|
|
|
type: ENTITY_TYPE.WIDGET,
|
|
|
|
|
propertyPath: "isVisible",
|
|
|
|
|
},
|
|
|
|
|
state: {
|
|
|
|
|
isVisible: "{{users}}",
|
|
|
|
|
},
|
|
|
|
|
analytics: {
|
|
|
|
|
widgetType: "INPUT_WIDGET_V2",
|
|
|
|
|
},
|
|
|
|
|
severity: Severity.ERROR,
|
2022-09-04 11:58:05 +00:00
|
|
|
category: LOG_CATEGORY.PLATFORM_GENERATED,
|
2022-07-18 03:25:32 +00:00
|
|
|
timestamp: "02:40:10",
|
|
|
|
|
},
|
|
|
|
|
},
|
|
|
|
|
canvasWidgets: {
|
|
|
|
|
container1_input_id: {
|
|
|
|
|
widgetName: "container1_input",
|
|
|
|
|
type: "INPUT_WIDGET_V2",
|
|
|
|
|
widgetId: "container1_input_id",
|
|
|
|
|
parentId: "canvas_widget_id",
|
|
|
|
|
},
|
|
|
|
|
canvas_widget_id: {
|
|
|
|
|
widgetName: "ContainerCanvas",
|
|
|
|
|
type: "CANVAS_WIDGET",
|
|
|
|
|
widgetId: "canvas_widget_id",
|
|
|
|
|
parentId: "container1_id",
|
|
|
|
|
},
|
|
|
|
|
container1_id: {
|
|
|
|
|
widgetName: "Container1",
|
|
|
|
|
type: "CONTAINER_WIDGET",
|
|
|
|
|
widgetId: "container1_id",
|
|
|
|
|
parentId: "0",
|
|
|
|
|
},
|
|
|
|
|
},
|
|
|
|
|
dataTree: {
|
|
|
|
|
container1_input: {
|
|
|
|
|
type: "INPUT_WIDGET_V2",
|
|
|
|
|
widgetId: "container1_input_id",
|
|
|
|
|
isVisible: false,
|
|
|
|
|
parentId: "canvas_widget_id",
|
|
|
|
|
ENTITY_TYPE: "WIDGET",
|
|
|
|
|
},
|
|
|
|
|
ContainerCanvas: {
|
|
|
|
|
type: "CANVAS_WIDGET",
|
|
|
|
|
widgetId: "canvas_widget_id",
|
|
|
|
|
isVisible: true,
|
|
|
|
|
parentId: "container1_id",
|
|
|
|
|
ENTITY_TYPE: "WIDGET",
|
|
|
|
|
},
|
|
|
|
|
Container1: {
|
|
|
|
|
type: "CONTAINER_WIDGET",
|
|
|
|
|
widgetId: "container1_id",
|
|
|
|
|
isVisible: false,
|
|
|
|
|
parentId: "0",
|
|
|
|
|
ENTITY_TYPE: "WIDGET",
|
|
|
|
|
},
|
|
|
|
|
},
|
|
|
|
|
expectedResult: {},
|
|
|
|
|
};
|
|
|
|
|
const result = getFilteredErrors.resultFunc(
|
|
|
|
|
TestData.debuggerErrors,
|
|
|
|
|
false,
|
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
|
|
|
TestData.canvasWidgets as unknown as CanvasWidgetsReduxState,
|
|
|
|
|
TestData.dataTree as unknown as DataTree,
|
2022-07-18 03:25:32 +00:00
|
|
|
);
|
|
|
|
|
expect(result).toStrictEqual(TestData.expectedResult);
|
|
|
|
|
});
|
|
|
|
|
});
|