2020-08-27 15:39:16 +00:00
|
|
|
import React from "react";
|
|
|
|
|
import { connect } from "react-redux";
|
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 { AppState } from "@appsmith/reducers";
|
2021-12-15 11:51:57 +00:00
|
|
|
import { Keys } from "@blueprintjs/core";
|
2020-08-27 15:39:16 +00:00
|
|
|
import {
|
2022-02-18 06:58:36 +00:00
|
|
|
showActionConfirmationModal,
|
|
|
|
|
cancelActionConfirmationModal,
|
|
|
|
|
acceptActionConfirmationModal,
|
2021-08-27 09:25:28 +00:00
|
|
|
} from "actions/pluginActionActions";
|
2023-05-19 18:37:06 +00:00
|
|
|
import {
|
|
|
|
|
Button,
|
|
|
|
|
Modal,
|
|
|
|
|
ModalBody,
|
|
|
|
|
ModalContent,
|
|
|
|
|
ModalFooter,
|
|
|
|
|
ModalHeader,
|
|
|
|
|
} from "design-system";
|
2021-11-01 04:54:06 +00:00
|
|
|
import {
|
|
|
|
|
createMessage,
|
|
|
|
|
QUERY_CONFIRMATION_MODAL_MESSAGE,
|
2022-02-11 18:08:46 +00:00
|
|
|
} from "@appsmith/constants/messages";
|
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 { ModalInfo } from "reducers/uiReducers/modalActionReducer";
|
2020-08-27 15:39:16 +00:00
|
|
|
|
|
|
|
|
type Props = {
|
2022-02-28 17:37:21 +00:00
|
|
|
modals: ModalInfo[];
|
2020-08-27 15:39:16 +00:00
|
|
|
dispatch: any;
|
|
|
|
|
};
|
|
|
|
|
|
2022-02-18 06:58:36 +00:00
|
|
|
class RequestConfirmationModal extends React.Component<Props> {
|
2021-12-15 11:51:57 +00:00
|
|
|
addEventListener = () => {
|
|
|
|
|
document.addEventListener("keydown", this.onKeyUp);
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
removeEventListener = () => {
|
|
|
|
|
document.removeEventListener("keydown", this.onKeyUp);
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
onKeyUp = (event: KeyboardEvent) => {
|
2022-03-08 13:55:13 +00:00
|
|
|
// Sometimes calling the shortcut keys "Cmd + Enter" also triggers the onConfirm function below
|
|
|
|
|
// so We check if no multiple keys are being pressed currently before executing this block of code.
|
|
|
|
|
if (!(event.metaKey || event.ctrlKey) && event.keyCode === Keys.ENTER) {
|
2022-02-28 17:37:21 +00:00
|
|
|
// please note: due to the way the state is being updated, the last action will always correspond to the right Action Modal.
|
|
|
|
|
// this is not a bug.
|
|
|
|
|
this.onConfirm(this.props.modals[this.props.modals.length - 1]);
|
2021-12-15 11:51:57 +00:00
|
|
|
}
|
|
|
|
|
};
|
|
|
|
|
|
2022-02-28 17:37:21 +00:00
|
|
|
onConfirm = (modalInfo: ModalInfo) => {
|
2021-12-15 11:51:57 +00:00
|
|
|
const { dispatch } = this.props;
|
2022-02-28 17:37:21 +00:00
|
|
|
dispatch(acceptActionConfirmationModal(modalInfo.name));
|
|
|
|
|
this.handleClose(modalInfo);
|
2021-12-15 11:51:57 +00:00
|
|
|
};
|
|
|
|
|
|
2022-02-28 17:37:21 +00:00
|
|
|
handleClose = (modalInfo: ModalInfo) => {
|
2021-12-15 11:51:57 +00:00
|
|
|
const { dispatch } = this.props;
|
2022-02-28 17:37:21 +00:00
|
|
|
dispatch(showActionConfirmationModal({ ...modalInfo, modalOpen: false }));
|
|
|
|
|
dispatch(cancelActionConfirmationModal(modalInfo.name));
|
2021-12-15 11:51:57 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
|
|
componentDidUpdate() {
|
2022-02-28 17:37:21 +00:00
|
|
|
const { modals } = this.props;
|
|
|
|
|
if (!!modals) {
|
2021-12-15 11:51:57 +00:00
|
|
|
this.addEventListener();
|
|
|
|
|
} else {
|
|
|
|
|
this.removeEventListener();
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2020-08-27 15:39:16 +00:00
|
|
|
render() {
|
2022-02-28 17:37:21 +00:00
|
|
|
const { dispatch, modals } = this.props;
|
2020-08-27 15:39:16 +00:00
|
|
|
|
2022-03-25 08:22:23 +00:00
|
|
|
// making sure that only modals that are set to be open are eventually opened.
|
|
|
|
|
// basically filters out modals that have already been opened and prevents it from flashing after other modals have been confirmed.
|
2023-05-19 18:37:06 +00:00
|
|
|
const modalsToBeOpened = modals.filter((modal) => modal.modalOpen);
|
2022-03-25 08:22:23 +00:00
|
|
|
|
2020-08-27 15:39:16 +00:00
|
|
|
return (
|
2022-02-28 17:37:21 +00:00
|
|
|
<>
|
2023-05-19 18:37:06 +00:00
|
|
|
{modalsToBeOpened.map((modalInfo: ModalInfo) => (
|
|
|
|
|
<Modal
|
|
|
|
|
key={modalInfo.name}
|
|
|
|
|
onOpenChange={() => this.handleClose(modalInfo)}
|
|
|
|
|
open={modalInfo?.modalOpen}
|
2022-02-28 17:37:21 +00:00
|
|
|
>
|
2023-05-19 18:37:06 +00:00
|
|
|
<ModalContent
|
|
|
|
|
data-testid="t--query-run-confirmation-modal"
|
|
|
|
|
style={{ width: "600px" }}
|
|
|
|
|
>
|
|
|
|
|
<ModalHeader>Confirmation dialog</ModalHeader>
|
|
|
|
|
<ModalBody>
|
|
|
|
|
{createMessage(QUERY_CONFIRMATION_MODAL_MESSAGE)}{" "}
|
|
|
|
|
<b>{modalInfo.name}</b> ?
|
|
|
|
|
</ModalBody>
|
|
|
|
|
<ModalFooter>
|
|
|
|
|
<Button
|
|
|
|
|
kind="secondary"
|
|
|
|
|
onClick={() => {
|
|
|
|
|
dispatch(cancelActionConfirmationModal(modalInfo.name));
|
|
|
|
|
this.handleClose(modalInfo);
|
|
|
|
|
}}
|
|
|
|
|
size="md"
|
|
|
|
|
>
|
|
|
|
|
No
|
|
|
|
|
</Button>
|
|
|
|
|
<Button
|
|
|
|
|
kind="primary"
|
|
|
|
|
onClick={() => this.onConfirm(modalInfo)}
|
|
|
|
|
size="md"
|
|
|
|
|
>
|
|
|
|
|
Yes
|
|
|
|
|
</Button>
|
|
|
|
|
</ModalFooter>
|
|
|
|
|
</ModalContent>
|
|
|
|
|
</Modal>
|
2022-02-28 17:37:21 +00:00
|
|
|
))}
|
|
|
|
|
</>
|
2020-08-27 15:39:16 +00:00
|
|
|
);
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
const mapStateToProps = (state: AppState) => ({
|
2022-02-28 17:37:21 +00:00
|
|
|
modals: state.ui.modalAction.modals,
|
2020-08-27 15:39:16 +00:00
|
|
|
});
|
|
|
|
|
|
2022-02-18 06:58:36 +00:00
|
|
|
export default connect(mapStateToProps)(RequestConfirmationModal);
|