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 {
|
2022-12-26 05:19:02 +00:00
|
|
|
DataTree,
|
2023-03-20 11:04:02 +00:00
|
|
|
AppsmithEntity,
|
2022-12-26 05:19:02 +00:00
|
|
|
} from "entities/DataTree/dataTreeFactory";
|
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 { ENTITY_TYPE } from "entities/DataTree/dataTreeFactory";
|
2022-12-08 12:16:41 +00:00
|
|
|
import { createSelector } from "reselect";
|
|
|
|
|
import {
|
|
|
|
|
getActionsForCurrentPage,
|
2023-03-21 05:09:43 +00:00
|
|
|
getJSCollections,
|
2022-12-08 12:16:41 +00:00
|
|
|
getPlugins,
|
|
|
|
|
} from "selectors/entitiesSelector";
|
|
|
|
|
import { getWidgets } from "sagas/selectors";
|
|
|
|
|
import { getCurrentPageId } from "selectors/editorSelectors";
|
|
|
|
|
import { getActionConfig } from "pages/Editor/Explorer/Actions/helpers";
|
2023-02-21 13:38:16 +00:00
|
|
|
import { jsCollectionIdURL, widgetURL } from "RouteBuilder";
|
2022-12-26 05:19:02 +00:00
|
|
|
import { getDataTree } from "selectors/dataTreeSelectors";
|
2023-02-17 16:03:34 +00:00
|
|
|
import { getActionChildrenNavData } from "utils/NavigationSelector/ActionChildren";
|
|
|
|
|
import { createNavData } from "utils/NavigationSelector/common";
|
|
|
|
|
import { getWidgetChildrenNavData } from "utils/NavigationSelector/WidgetChildren";
|
|
|
|
|
import { getJsChildrenNavData } from "utils/NavigationSelector/JsChildren";
|
|
|
|
|
import { getAppsmithNavData } from "utils/NavigationSelector/AppsmithNavData";
|
2023-03-21 05:09:43 +00:00
|
|
|
import { isJSObject } from "ce/workers/Evaluation/evaluationUtils";
|
2022-12-08 12:16:41 +00:00
|
|
|
|
2022-12-26 05:19:02 +00:00
|
|
|
export type NavigationData = {
|
|
|
|
|
name: string;
|
|
|
|
|
id: string;
|
|
|
|
|
type: ENTITY_TYPE;
|
|
|
|
|
url: string | undefined;
|
|
|
|
|
navigable: boolean;
|
2023-02-17 16:03:34 +00:00
|
|
|
children: EntityNavigationData;
|
|
|
|
|
peekable: boolean;
|
|
|
|
|
peekData?: unknown;
|
|
|
|
|
key?: string;
|
2022-12-26 05:19:02 +00:00
|
|
|
};
|
|
|
|
|
export type EntityNavigationData = Record<string, NavigationData>;
|
2022-12-08 12:16:41 +00:00
|
|
|
|
|
|
|
|
export const getEntitiesForNavigation = createSelector(
|
|
|
|
|
getActionsForCurrentPage,
|
|
|
|
|
getPlugins,
|
2023-03-21 05:09:43 +00:00
|
|
|
getJSCollections,
|
2022-12-08 12:16:41 +00:00
|
|
|
getWidgets,
|
|
|
|
|
getCurrentPageId,
|
2022-12-26 05:19:02 +00:00
|
|
|
getDataTree,
|
2023-03-21 05:09:43 +00:00
|
|
|
(_: any, entityName: string | undefined) => entityName,
|
|
|
|
|
(
|
|
|
|
|
actions,
|
|
|
|
|
plugins,
|
|
|
|
|
jsActions,
|
|
|
|
|
widgets,
|
|
|
|
|
pageId,
|
|
|
|
|
dataTree: DataTree,
|
|
|
|
|
entityName: string | undefined,
|
|
|
|
|
) => {
|
|
|
|
|
// data tree retriggers this
|
|
|
|
|
jsActions = jsActions.filter((a) => a.config.pageId === pageId);
|
2022-12-08 12:16:41 +00:00
|
|
|
const navigationData: EntityNavigationData = {};
|
2023-03-16 00:50:58 +00:00
|
|
|
if (!dataTree) return navigationData;
|
2022-12-08 12:16:41 +00:00
|
|
|
|
|
|
|
|
actions.forEach((action) => {
|
|
|
|
|
const plugin = plugins.find(
|
|
|
|
|
(plugin) => plugin.id === action.config.pluginId,
|
|
|
|
|
);
|
|
|
|
|
const config = getActionConfig(action.config.pluginType);
|
2023-03-21 05:09:43 +00:00
|
|
|
// dataTree used to get entityDefinitions and peekData
|
2023-02-17 16:03:34 +00:00
|
|
|
const result = getActionChildrenNavData(action, dataTree);
|
2022-12-15 04:06:13 +00:00
|
|
|
if (!config) return;
|
2023-02-17 16:03:34 +00:00
|
|
|
navigationData[action.config.name] = createNavData({
|
2022-12-08 12:16:41 +00:00
|
|
|
id: action.config.id,
|
2023-02-17 16:03:34 +00:00
|
|
|
name: action.config.name,
|
2022-12-08 12:16:41 +00:00
|
|
|
type: ENTITY_TYPE.ACTION,
|
2022-12-15 04:06:13 +00:00
|
|
|
url: config.getURL(
|
2022-12-08 12:16:41 +00:00
|
|
|
pageId,
|
|
|
|
|
action.config.id,
|
|
|
|
|
action.config.pluginType,
|
|
|
|
|
plugin,
|
|
|
|
|
),
|
2023-02-17 16:03:34 +00:00
|
|
|
peekable: true,
|
|
|
|
|
peekData: result?.peekData,
|
|
|
|
|
children: result?.childNavData || {},
|
|
|
|
|
});
|
2022-12-08 12:16:41 +00:00
|
|
|
});
|
|
|
|
|
|
|
|
|
|
jsActions.forEach((jsAction) => {
|
2023-03-21 05:09:43 +00:00
|
|
|
// dataTree for null check and peekData
|
2023-02-17 16:03:34 +00:00
|
|
|
const result = getJsChildrenNavData(jsAction, pageId, dataTree);
|
|
|
|
|
navigationData[jsAction.config.name] = createNavData({
|
2022-12-08 12:16:41 +00:00
|
|
|
id: jsAction.config.id,
|
2023-02-17 16:03:34 +00:00
|
|
|
name: jsAction.config.name,
|
2022-12-08 12:16:41 +00:00
|
|
|
type: ENTITY_TYPE.JSACTION,
|
|
|
|
|
url: jsCollectionIdURL({ pageId, collectionId: jsAction.config.id }),
|
2023-02-17 16:03:34 +00:00
|
|
|
peekable: true,
|
|
|
|
|
peekData: result?.peekData,
|
|
|
|
|
children: result?.childNavData || {},
|
|
|
|
|
});
|
2022-12-08 12:16:41 +00:00
|
|
|
});
|
|
|
|
|
|
|
|
|
|
Object.values(widgets).forEach((widget) => {
|
2023-03-21 05:09:43 +00:00
|
|
|
// dataTree to get entityDefinitions, for url (can use getWidgetByName?) and peekData
|
2023-02-17 16:03:34 +00:00
|
|
|
const result = getWidgetChildrenNavData(widget, dataTree, pageId);
|
|
|
|
|
navigationData[widget.widgetName] = createNavData({
|
2022-12-08 12:16:41 +00:00
|
|
|
id: widget.widgetId,
|
2023-02-17 16:03:34 +00:00
|
|
|
name: widget.widgetName,
|
2022-12-08 12:16:41 +00:00
|
|
|
type: ENTITY_TYPE.WIDGET,
|
2023-02-21 13:38:16 +00:00
|
|
|
url: widgetURL({ pageId, selectedWidgets: [widget.widgetId] }),
|
2023-02-17 16:03:34 +00:00
|
|
|
peekable: true,
|
|
|
|
|
peekData: result?.peekData,
|
|
|
|
|
children: result?.childNavData || {},
|
|
|
|
|
});
|
2022-12-08 12:16:41 +00:00
|
|
|
});
|
2023-03-21 05:09:43 +00:00
|
|
|
// dataTree to get entity definitions and peekData
|
2023-02-17 16:03:34 +00:00
|
|
|
navigationData["appsmith"] = getAppsmithNavData(
|
2023-03-20 11:04:02 +00:00
|
|
|
dataTree.appsmith as AppsmithEntity,
|
2023-02-17 16:03:34 +00:00
|
|
|
);
|
2023-03-21 05:09:43 +00:00
|
|
|
if (
|
|
|
|
|
entityName &&
|
|
|
|
|
isJSObject(dataTree[entityName]) &&
|
|
|
|
|
entityName in navigationData
|
|
|
|
|
) {
|
|
|
|
|
return {
|
|
|
|
|
...navigationData,
|
|
|
|
|
this: navigationData[entityName],
|
|
|
|
|
};
|
|
|
|
|
}
|
2022-12-08 12:16:41 +00:00
|
|
|
return navigationData;
|
|
|
|
|
},
|
|
|
|
|
);
|