2022-08-04 05:40:44 +00:00
|
|
|
import { createReducer } from "utils/ReducerUtils";
|
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 { ReduxAction } from "@appsmith/constants/ReduxActionConstants";
|
2020-04-29 11:58:02 +00:00
|
|
|
import {
|
|
|
|
|
ReduxActionTypes,
|
|
|
|
|
ReduxActionErrorTypes,
|
2022-04-12 10:50:01 +00:00
|
|
|
} from "@appsmith/constants/ReduxActionConstants";
|
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 { DefaultPlugin, Plugin } from "api/PluginApi";
|
|
|
|
|
import type {
|
2021-03-30 05:29:03 +00:00
|
|
|
PluginFormPayloadWithId,
|
|
|
|
|
PluginFormsPayload,
|
2021-07-29 08:13:10 +00:00
|
|
|
GetPluginFormConfigRequest,
|
2021-03-30 05:29:03 +00:00
|
|
|
} from "actions/pluginActions";
|
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 {
|
2021-08-26 05:37:07 +00:00
|
|
|
FormEditorConfigs,
|
|
|
|
|
FormSettingsConfigs,
|
|
|
|
|
FormDependencyConfigs,
|
2022-03-30 13:11:25 +00:00
|
|
|
FormDatasourceButtonConfigs,
|
2021-08-26 05:37:07 +00:00
|
|
|
} from "utils/DynamicBindingUtils";
|
2020-04-29 09:23:23 +00:00
|
|
|
|
2019-11-29 05:22:49 +00:00
|
|
|
export interface PluginDataState {
|
|
|
|
|
list: Plugin[];
|
2022-03-03 10:56:53 +00:00
|
|
|
defaultPluginList: DefaultPlugin[];
|
2019-11-29 05:22:49 +00:00
|
|
|
loading: boolean;
|
2020-10-12 13:06:05 +00:00
|
|
|
formConfigs: Record<string, any[]>;
|
2021-08-26 05:37:07 +00:00
|
|
|
editorConfigs: FormEditorConfigs;
|
|
|
|
|
settingConfigs: FormSettingsConfigs;
|
|
|
|
|
dependencies: FormDependencyConfigs;
|
2022-03-30 13:11:25 +00:00
|
|
|
datasourceFormButtonConfigs: FormDatasourceButtonConfigs;
|
2021-07-29 08:13:10 +00:00
|
|
|
fetchingSinglePluginForm: Record<string, boolean>;
|
2022-03-03 10:56:53 +00:00
|
|
|
fetchingDefaultPlugins: boolean;
|
2019-11-29 05:22:49 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
const initialState: PluginDataState = {
|
|
|
|
|
list: [],
|
2022-03-03 10:56:53 +00:00
|
|
|
defaultPluginList: [],
|
2019-11-29 05:22:49 +00:00
|
|
|
loading: false,
|
2020-04-29 09:23:23 +00:00
|
|
|
formConfigs: {},
|
2020-08-12 06:27:35 +00:00
|
|
|
editorConfigs: {},
|
2021-02-23 08:27:37 +00:00
|
|
|
settingConfigs: {},
|
2022-03-30 13:11:25 +00:00
|
|
|
datasourceFormButtonConfigs: {},
|
2021-04-26 05:41:32 +00:00
|
|
|
dependencies: {},
|
2021-07-29 08:13:10 +00:00
|
|
|
fetchingSinglePluginForm: {},
|
2022-03-03 10:56:53 +00:00
|
|
|
fetchingDefaultPlugins: false,
|
2019-11-29 05:22:49 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
|
|
const pluginsReducer = createReducer(initialState, {
|
|
|
|
|
[ReduxActionTypes.FETCH_PLUGINS_REQUEST]: (state: PluginDataState) => {
|
|
|
|
|
return { ...state, loading: true };
|
|
|
|
|
},
|
|
|
|
|
[ReduxActionTypes.FETCH_PLUGINS_SUCCESS]: (
|
|
|
|
|
state: PluginDataState,
|
|
|
|
|
action: ReduxAction<Plugin[]>,
|
|
|
|
|
) => {
|
|
|
|
|
return {
|
|
|
|
|
...state,
|
|
|
|
|
loading: false,
|
|
|
|
|
list: action.payload,
|
|
|
|
|
};
|
|
|
|
|
},
|
2020-08-19 09:21:32 +00:00
|
|
|
[ReduxActionErrorTypes.FETCH_PLUGINS_ERROR]: (state: PluginDataState) => {
|
2019-11-29 05:22:49 +00:00
|
|
|
return {
|
|
|
|
|
...state,
|
|
|
|
|
loading: false,
|
|
|
|
|
};
|
|
|
|
|
},
|
2021-03-30 05:29:03 +00:00
|
|
|
[ReduxActionTypes.FETCH_PLUGIN_FORM_CONFIGS_SUCCESS]: (
|
|
|
|
|
state: PluginDataState,
|
|
|
|
|
action: ReduxAction<PluginFormsPayload>,
|
|
|
|
|
) => {
|
2020-04-29 09:23:23 +00:00
|
|
|
return {
|
|
|
|
|
...state,
|
2021-03-30 05:29:03 +00:00
|
|
|
...action.payload,
|
2020-04-29 09:23:23 +00:00
|
|
|
};
|
|
|
|
|
},
|
2021-07-29 08:13:10 +00:00
|
|
|
[ReduxActionTypes.GET_PLUGIN_FORM_CONFIG_INIT]: (
|
|
|
|
|
state: PluginDataState,
|
|
|
|
|
action: ReduxAction<GetPluginFormConfigRequest>,
|
|
|
|
|
) => {
|
|
|
|
|
return {
|
|
|
|
|
...state,
|
|
|
|
|
fetchingSinglePluginForm: {
|
|
|
|
|
...state.fetchingSinglePluginForm,
|
|
|
|
|
[action.payload.id]: true,
|
|
|
|
|
},
|
|
|
|
|
};
|
|
|
|
|
},
|
2020-04-29 09:23:23 +00:00
|
|
|
[ReduxActionTypes.FETCH_PLUGIN_FORM_SUCCESS]: (
|
|
|
|
|
state: PluginDataState,
|
2021-03-30 05:29:03 +00:00
|
|
|
action: ReduxAction<PluginFormPayloadWithId>,
|
2020-04-29 09:23:23 +00:00
|
|
|
) => {
|
|
|
|
|
return {
|
|
|
|
|
...state,
|
2021-07-29 08:13:10 +00:00
|
|
|
fetchingSinglePluginForm: {
|
|
|
|
|
...state.fetchingSinglePluginForm,
|
|
|
|
|
[action.payload.id]: false,
|
|
|
|
|
},
|
2020-04-29 09:23:23 +00:00
|
|
|
formConfigs: {
|
|
|
|
|
...state.formConfigs,
|
|
|
|
|
[action.payload.id]: action.payload.form,
|
|
|
|
|
},
|
2020-08-12 06:27:35 +00:00
|
|
|
editorConfigs: {
|
|
|
|
|
...state.editorConfigs,
|
|
|
|
|
[action.payload.id]: action.payload.editor,
|
|
|
|
|
},
|
2021-02-23 08:27:37 +00:00
|
|
|
settingConfigs: {
|
|
|
|
|
...state.settingConfigs,
|
|
|
|
|
[action.payload.id]: action.payload.setting,
|
|
|
|
|
},
|
2022-03-30 13:11:25 +00:00
|
|
|
datasourceFormButtonConfigs: {
|
|
|
|
|
...state.datasourceFormButtonConfigs,
|
|
|
|
|
[action.payload.id]: action.payload.formButton,
|
|
|
|
|
},
|
2020-04-29 09:23:23 +00:00
|
|
|
};
|
|
|
|
|
},
|
2021-07-29 08:13:10 +00:00
|
|
|
[ReduxActionErrorTypes.FETCH_PLUGIN_FORM_ERROR]: (
|
|
|
|
|
state: PluginDataState,
|
|
|
|
|
action: ReduxAction<GetPluginFormConfigRequest>,
|
|
|
|
|
) => {
|
|
|
|
|
return {
|
|
|
|
|
...state,
|
|
|
|
|
fetchingSinglePluginForm: {
|
|
|
|
|
...state.fetchingSinglePluginForm,
|
|
|
|
|
[action.payload.id]: false,
|
|
|
|
|
},
|
|
|
|
|
};
|
|
|
|
|
},
|
2022-03-03 10:56:53 +00:00
|
|
|
[ReduxActionTypes.GET_DEFAULT_PLUGINS_REQUEST]: (state: PluginDataState) => {
|
|
|
|
|
return {
|
|
|
|
|
...state,
|
|
|
|
|
fetchingDefaultPlugins: true,
|
|
|
|
|
};
|
|
|
|
|
},
|
|
|
|
|
[ReduxActionTypes.GET_DEFAULT_PLUGINS_SUCCESS]: (
|
|
|
|
|
state: PluginDataState,
|
|
|
|
|
action: ReduxAction<DefaultPlugin[]>,
|
|
|
|
|
) => {
|
|
|
|
|
return {
|
|
|
|
|
...state,
|
|
|
|
|
fetchingDefaultPlugins: false,
|
|
|
|
|
defaultPluginList: action.payload,
|
|
|
|
|
};
|
|
|
|
|
},
|
2019-11-29 05:22:49 +00:00
|
|
|
});
|
|
|
|
|
|
|
|
|
|
export default pluginsReducer;
|