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 { Log } from "entities/AppsmithConsole";
|
2024-08-06 14:52:22 +00:00
|
|
|
import type { WidgetEntity } from "ee/entities/DataTree/types";
|
2023-10-10 12:32:17 +00:00
|
|
|
import type { DataTree } from "entities/DataTree/dataTreeTypes";
|
2022-08-04 12:51:54 +00:00
|
|
|
import { isEmpty } from "lodash";
|
2024-08-06 14:52:22 +00:00
|
|
|
import type { AppState } from "ee/reducers";
|
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 { CanvasWidgetsReduxState } from "reducers/entityReducers/canvasWidgetsReducer";
|
2021-08-25 04:34:42 +00:00
|
|
|
import { createSelector } from "reselect";
|
2022-07-18 03:25:32 +00:00
|
|
|
import { getWidgets } from "sagas/selectors";
|
2023-02-14 16:07:31 +00:00
|
|
|
import {
|
|
|
|
|
shouldSuppressDebuggerError,
|
|
|
|
|
isWidget,
|
2024-08-06 14:52:22 +00:00
|
|
|
} from "ee/workers/Evaluation/evaluationUtils";
|
2022-07-18 03:25:32 +00:00
|
|
|
import { getDataTree } from "./dataTreeSelectors";
|
2024-12-31 12:16:11 +00:00
|
|
|
import { combinedPreviewModeSelector } from "./editorSelectors";
|
2024-02-29 06:23:57 +00:00
|
|
|
import type { CanvasDebuggerState } from "reducers/uiReducers/debuggerReducer";
|
2022-08-04 12:51:54 +00:00
|
|
|
|
2023-10-11 07:35:24 +00:00
|
|
|
interface ErrorObejct {
|
2022-08-04 12:51:54 +00:00
|
|
|
[k: string]: Log;
|
2023-10-11 07:35:24 +00:00
|
|
|
}
|
2022-08-04 12:51:54 +00:00
|
|
|
|
2021-04-23 13:50:55 +00:00
|
|
|
export const getDebuggerErrors = (state: AppState) => state.ui.debugger.errors;
|
2021-08-25 04:34:42 +00:00
|
|
|
export const hideErrors = (state: AppState) => state.ui.debugger.hideErrors;
|
2022-08-04 12:51:54 +00:00
|
|
|
const emptyErrorObejct: ErrorObejct = {};
|
|
|
|
|
|
2021-08-25 04:34:42 +00:00
|
|
|
export const getFilteredErrors = createSelector(
|
|
|
|
|
getDebuggerErrors,
|
|
|
|
|
hideErrors,
|
2022-07-18 03:25:32 +00:00
|
|
|
getWidgets,
|
|
|
|
|
getDataTree,
|
|
|
|
|
(errors, hideErrors, canvasWidgets, dataTree: DataTree) => {
|
2022-08-04 12:51:54 +00:00
|
|
|
if (hideErrors) return emptyErrorObejct;
|
2024-09-18 16:35:28 +00:00
|
|
|
|
2022-08-04 12:51:54 +00:00
|
|
|
if (isEmpty(errors)) return emptyErrorObejct;
|
2021-08-25 04:34:42 +00:00
|
|
|
|
2022-07-18 03:25:32 +00:00
|
|
|
const alwaysShowEntities: Record<string, boolean> = {};
|
2024-09-18 16:35:28 +00:00
|
|
|
|
2022-07-18 03:25:32 +00:00
|
|
|
Object.entries(errors).forEach(([, error]) => {
|
|
|
|
|
const entity = error?.source?.name && dataTree[error.source.name];
|
2024-09-18 16:35:28 +00:00
|
|
|
|
2022-07-18 03:25:32 +00:00
|
|
|
if (
|
|
|
|
|
entity &&
|
|
|
|
|
isWidget(entity) &&
|
|
|
|
|
error.source?.propertyPath === "isVisible"
|
|
|
|
|
) {
|
|
|
|
|
alwaysShowEntities[error.source.id] = true;
|
|
|
|
|
}
|
|
|
|
|
});
|
|
|
|
|
const filteredErrors = Object.fromEntries(
|
|
|
|
|
Object.entries(errors).filter(([, error]) => {
|
|
|
|
|
const entity = error?.source?.name && dataTree[error.source.name];
|
2024-09-18 16:35:28 +00:00
|
|
|
|
2022-07-18 03:25:32 +00:00
|
|
|
// filter error - when widget or parent widget is hidden
|
|
|
|
|
// parent widgets e.g. modal, tab, container
|
|
|
|
|
if (entity && isWidget(entity)) {
|
2023-10-16 09:23:47 +00:00
|
|
|
const widgetEntity = entity as WidgetEntity;
|
2024-09-18 16:35:28 +00:00
|
|
|
|
2023-10-16 09:23:47 +00:00
|
|
|
if (shouldSuppressDebuggerError(widgetEntity)) {
|
2023-02-14 16:07:31 +00:00
|
|
|
return false;
|
|
|
|
|
}
|
2024-09-18 16:35:28 +00:00
|
|
|
|
2023-10-16 09:23:47 +00:00
|
|
|
if (!hasParentWidget(widgetEntity)) {
|
|
|
|
|
return widgetEntity.isVisible
|
2022-07-18 03:25:32 +00:00
|
|
|
? true
|
2023-10-16 09:23:47 +00:00
|
|
|
: alwaysShowEntities[widgetEntity.widgetId];
|
2022-07-18 03:25:32 +00:00
|
|
|
} else {
|
|
|
|
|
const isParentWidgetVisible = isParentVisible(
|
2023-10-16 09:23:47 +00:00
|
|
|
widgetEntity,
|
2022-07-18 03:25:32 +00:00
|
|
|
canvasWidgets,
|
|
|
|
|
dataTree,
|
|
|
|
|
);
|
2024-09-18 16:35:28 +00:00
|
|
|
|
2023-10-16 09:23:47 +00:00
|
|
|
return widgetEntity.isVisible
|
2022-07-18 03:25:32 +00:00
|
|
|
? isParentWidgetVisible
|
2023-10-16 09:23:47 +00:00
|
|
|
: isParentWidgetVisible &&
|
|
|
|
|
alwaysShowEntities[widgetEntity.widgetId];
|
2022-07-18 03:25:32 +00:00
|
|
|
}
|
|
|
|
|
}
|
2024-09-18 16:35:28 +00:00
|
|
|
|
2022-07-18 03:25:32 +00:00
|
|
|
return true;
|
|
|
|
|
}),
|
|
|
|
|
);
|
2024-09-18 16:35:28 +00:00
|
|
|
|
2022-07-18 03:25:32 +00:00
|
|
|
return filteredErrors;
|
2021-08-25 04:34:42 +00:00
|
|
|
},
|
|
|
|
|
);
|
2022-07-18 03:25:32 +00:00
|
|
|
|
|
|
|
|
export const isParentVisible = (
|
2023-03-20 11:04:02 +00:00
|
|
|
currentWidgetData: WidgetEntity,
|
2022-07-18 03:25:32 +00:00
|
|
|
canvasWidgets: CanvasWidgetsReduxState,
|
|
|
|
|
dataTree: DataTree,
|
|
|
|
|
): boolean => {
|
|
|
|
|
const isWidgetVisible = !!currentWidgetData.isVisible;
|
2024-09-18 16:35:28 +00:00
|
|
|
|
2022-07-18 03:25:32 +00:00
|
|
|
if (!hasParentWidget(currentWidgetData)) {
|
|
|
|
|
return isWidgetVisible;
|
|
|
|
|
}
|
2024-09-18 16:35:28 +00:00
|
|
|
|
2022-07-18 03:25:32 +00:00
|
|
|
const parentWidget = canvasWidgets[currentWidgetData.parentId as string];
|
2024-09-18 16:35:28 +00:00
|
|
|
|
2022-07-18 03:25:32 +00:00
|
|
|
if (!parentWidget) return isWidgetVisible;
|
|
|
|
|
|
2023-03-20 11:04:02 +00:00
|
|
|
const parentWidgetData = dataTree[parentWidget.widgetName] as WidgetEntity;
|
2024-09-18 16:35:28 +00:00
|
|
|
|
2022-07-18 03:25:32 +00:00
|
|
|
if (!parentWidgetData) return isWidgetVisible;
|
|
|
|
|
|
|
|
|
|
switch (parentWidgetData.type) {
|
|
|
|
|
// check for widget types instead of harcoded string
|
|
|
|
|
case "TABS_WIDGET":
|
|
|
|
|
// need type for selectedTab and tabName
|
|
|
|
|
const isTabContentVisible =
|
|
|
|
|
!!parentWidgetData.isVisible &&
|
|
|
|
|
parentWidgetData.selectedTab === currentWidgetData.tabName;
|
2024-09-18 16:35:28 +00:00
|
|
|
|
2022-07-18 03:25:32 +00:00
|
|
|
return isTabContentVisible
|
|
|
|
|
? isParentVisible(parentWidgetData, canvasWidgets, dataTree)
|
|
|
|
|
: false;
|
|
|
|
|
case "MODAL_WIDGET":
|
|
|
|
|
return !!parentWidgetData.isVisible;
|
|
|
|
|
default:
|
|
|
|
|
return parentWidgetData.isVisible
|
|
|
|
|
? isParentVisible(parentWidgetData, canvasWidgets, dataTree)
|
|
|
|
|
: false;
|
|
|
|
|
}
|
|
|
|
|
};
|
|
|
|
|
|
2023-03-20 11:04:02 +00:00
|
|
|
export const hasParentWidget = (widget: WidgetEntity) =>
|
2022-07-18 03:25:32 +00:00
|
|
|
widget.parentId && widget.parentId !== "0";
|
|
|
|
|
|
2021-09-15 14:01:32 +00:00
|
|
|
export const getMessageCount = createSelector(getFilteredErrors, (errors) => {
|
2023-02-18 12:55:46 +00:00
|
|
|
let errorsCount = 0;
|
|
|
|
|
|
|
|
|
|
// count number of messages in each error.
|
|
|
|
|
// This logic is required because each messages in error is rendered separately.
|
|
|
|
|
Object.values(errors).forEach((error) => {
|
|
|
|
|
if (error.messages) {
|
|
|
|
|
errorsCount += error.messages.length;
|
|
|
|
|
}
|
|
|
|
|
});
|
|
|
|
|
// count number of warnings.
|
|
|
|
|
const warningsCount = Object.keys(errors).filter((key: string) =>
|
2021-09-15 14:01:32 +00:00
|
|
|
key.includes("warning"),
|
|
|
|
|
).length;
|
2024-09-18 16:35:28 +00:00
|
|
|
|
2023-02-18 12:55:46 +00:00
|
|
|
errorsCount = errorsCount - warningsCount;
|
2024-09-18 16:35:28 +00:00
|
|
|
|
2021-09-15 14:01:32 +00:00
|
|
|
return { errors: errorsCount, warnings: warningsCount };
|
|
|
|
|
});
|
2021-10-07 06:53:58 +00:00
|
|
|
|
2023-04-10 12:59:14 +00:00
|
|
|
// get selected tab in debugger.
|
|
|
|
|
export const getDebuggerSelectedTab = (state: AppState) =>
|
|
|
|
|
state.ui.debugger.context.selectedDebuggerTab;
|
|
|
|
|
|
2023-08-09 09:49:32 +00:00
|
|
|
export const getDebuggerSelectedFilter = (state: AppState) =>
|
|
|
|
|
state.ui.debugger.context.selectedDebuggerFilter;
|
|
|
|
|
|
2023-04-10 12:59:14 +00:00
|
|
|
export const getResponsePaneHeight = (state: AppState) =>
|
|
|
|
|
state.ui.debugger.context.responseTabHeight;
|
|
|
|
|
|
|
|
|
|
export const getErrorCount = (state: AppState) =>
|
|
|
|
|
state.ui.debugger.context.errorCount;
|
|
|
|
|
|
|
|
|
|
export const getScrollPosition = (state: AppState) =>
|
|
|
|
|
state.ui.debugger.context.scrollPosition;
|
|
|
|
|
|
|
|
|
|
export const getDebuggerContext = (state: AppState) =>
|
|
|
|
|
state.ui.debugger.context;
|
2023-04-12 17:08:55 +00:00
|
|
|
|
2024-02-29 06:23:57 +00:00
|
|
|
export const getDebuggerOpen = (state: AppState) => state.ui.debugger.isOpen;
|
|
|
|
|
|
2023-11-03 17:13:36 +00:00
|
|
|
export const showDebuggerFlag = createSelector(
|
2024-02-29 06:23:57 +00:00
|
|
|
getDebuggerOpen,
|
2024-12-31 12:16:11 +00:00
|
|
|
combinedPreviewModeSelector,
|
2023-11-03 17:13:36 +00:00
|
|
|
(isOpen, isPreview) => isOpen && !isPreview,
|
|
|
|
|
);
|
2024-02-29 06:23:57 +00:00
|
|
|
|
|
|
|
|
export const getCanvasDebuggerState = createSelector(
|
|
|
|
|
showDebuggerFlag,
|
|
|
|
|
getDebuggerContext,
|
|
|
|
|
(openState, context): CanvasDebuggerState => {
|
|
|
|
|
return {
|
|
|
|
|
open: openState,
|
|
|
|
|
selectedTab: context.selectedDebuggerTab,
|
|
|
|
|
responseTabHeight: context.responseTabHeight,
|
|
|
|
|
};
|
|
|
|
|
},
|
|
|
|
|
);
|
2025-01-03 12:35:09 +00:00
|
|
|
|
|
|
|
|
export const getDebuggerStateInspectorSelectedItem = (state: AppState) =>
|
|
|
|
|
state.ui.debugger.stateInspector.selectedItem;
|