2019-11-21 10:52:49 +00:00
|
|
|
import React from "react";
|
2020-06-17 10:19:56 +00:00
|
|
|
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 { InjectedFormProps } from "redux-form";
|
|
|
|
|
import { Form, reduxForm, Field } from "redux-form";
|
2022-09-02 17:15:08 +00:00
|
|
|
import { CREATE_APPLICATION_FORM_NAME } from "@appsmith/constants/forms";
|
2021-03-13 14:24:45 +00:00
|
|
|
import {
|
|
|
|
|
createMessage,
|
|
|
|
|
ERROR_MESSAGE_NAME_EMPTY,
|
|
|
|
|
NAME_SPACE_ERROR,
|
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 { AppState } from "@appsmith/reducers";
|
|
|
|
|
import type { CreateApplicationFormValues } from "./helpers";
|
2019-11-21 10:52:49 +00:00
|
|
|
import {
|
|
|
|
|
createApplicationFormSubmitHandler,
|
2020-10-08 10:32:31 +00:00
|
|
|
CREATE_APPLICATION_FORM_NAME_FIELD,
|
2019-12-16 08:49:10 +00:00
|
|
|
} from "./helpers";
|
2019-11-25 09:15:11 +00:00
|
|
|
import TextField from "components/editorComponents/form/fields/TextField";
|
2019-12-23 12:16:33 +00:00
|
|
|
import FormGroup from "components/editorComponents/form/FormGroup";
|
2020-02-03 10:37:03 +00:00
|
|
|
import FormFooter from "components/editorComponents/form/FormFooter";
|
|
|
|
|
import FormMessage from "components/editorComponents/form/FormMessage";
|
2019-11-07 04:59:40 +00:00
|
|
|
|
2020-06-17 10:19:56 +00:00
|
|
|
type Props = InjectedFormProps<
|
|
|
|
|
CreateApplicationFormValues,
|
2020-11-03 13:05:40 +00:00
|
|
|
{
|
|
|
|
|
onCancel: () => void;
|
2022-06-15 15:37:41 +00:00
|
|
|
workspaceId: string;
|
2020-11-03 13:05:40 +00:00
|
|
|
initialValues: Record<string, unknown>;
|
|
|
|
|
}
|
2020-06-17 10:19:56 +00:00
|
|
|
> & {
|
|
|
|
|
onCancel: () => void;
|
2022-06-15 15:37:41 +00:00
|
|
|
workspaceId: string;
|
2020-11-03 13:05:40 +00:00
|
|
|
initialValues: Record<string, unknown>;
|
2020-06-17 10:19:56 +00:00
|
|
|
};
|
|
|
|
|
|
2020-10-08 10:32:31 +00:00
|
|
|
const validate = (values: CreateApplicationFormValues) => {
|
|
|
|
|
if (!values[CREATE_APPLICATION_FORM_NAME_FIELD]) {
|
2021-03-13 14:24:45 +00:00
|
|
|
return {
|
|
|
|
|
[CREATE_APPLICATION_FORM_NAME_FIELD]: createMessage(
|
|
|
|
|
ERROR_MESSAGE_NAME_EMPTY,
|
|
|
|
|
),
|
|
|
|
|
};
|
2020-10-08 10:32:31 +00:00
|
|
|
} else if (!values[CREATE_APPLICATION_FORM_NAME_FIELD].trim()) {
|
|
|
|
|
return {
|
2021-03-13 14:24:45 +00:00
|
|
|
[CREATE_APPLICATION_FORM_NAME_FIELD]: createMessage(NAME_SPACE_ERROR),
|
2020-10-08 10:32:31 +00:00
|
|
|
};
|
|
|
|
|
}
|
|
|
|
|
return {};
|
|
|
|
|
};
|
|
|
|
|
|
2020-02-03 10:37:03 +00:00
|
|
|
// TODO(abhinav): abstract onCancel out.
|
2020-06-17 10:19:56 +00:00
|
|
|
|
2021-04-28 10:28:39 +00:00
|
|
|
function CreateApplicationForm(props: Props) {
|
2021-05-13 08:35:39 +00:00
|
|
|
const { error, handleSubmit, invalid, pristine, submitting } = props;
|
2019-11-07 04:59:40 +00:00
|
|
|
return (
|
2019-11-21 10:52:49 +00:00
|
|
|
<Form onSubmit={handleSubmit(createApplicationFormSubmitHandler)}>
|
2020-02-03 10:37:03 +00:00
|
|
|
{error && !pristine && <FormMessage intent="danger" message={error} />}
|
2020-02-24 07:52:22 +00:00
|
|
|
<FormGroup intent={error ? "danger" : "none"}>
|
2020-10-08 10:32:31 +00:00
|
|
|
<TextField
|
|
|
|
|
name={CREATE_APPLICATION_FORM_NAME_FIELD}
|
|
|
|
|
placeholder="Name"
|
|
|
|
|
/>
|
2022-06-15 15:37:41 +00:00
|
|
|
<Field component="input" name="workspaceId" type="hidden" />
|
2019-11-21 10:52:49 +00:00
|
|
|
</FormGroup>
|
2020-02-03 10:37:03 +00:00
|
|
|
<FormFooter
|
2021-04-28 10:28:39 +00:00
|
|
|
canSubmit={!invalid}
|
2023-05-19 18:37:06 +00:00
|
|
|
data-testid="t--create-app-submit"
|
2021-04-28 10:28:39 +00:00
|
|
|
divider
|
2020-02-03 10:37:03 +00:00
|
|
|
onCancel={props.onCancel}
|
|
|
|
|
onSubmit={handleSubmit(createApplicationFormSubmitHandler)}
|
2021-04-28 10:28:39 +00:00
|
|
|
size="small"
|
2020-02-03 10:37:03 +00:00
|
|
|
submitOnEnter
|
|
|
|
|
submitText="Submit"
|
|
|
|
|
submitting={submitting && !error}
|
|
|
|
|
/>
|
2019-11-21 10:52:49 +00:00
|
|
|
</Form>
|
2019-11-07 04:59:40 +00:00
|
|
|
);
|
2021-04-28 10:28:39 +00:00
|
|
|
}
|
2019-11-07 04:59:40 +00:00
|
|
|
|
2020-06-17 10:19:56 +00:00
|
|
|
const mapStateToProps = (state: AppState, props: Props): any => {
|
2022-06-15 15:37:41 +00:00
|
|
|
const workspaceId = props.workspaceId;
|
2020-06-17 10:19:56 +00:00
|
|
|
return {
|
2022-06-15 15:37:41 +00:00
|
|
|
initialValues: { workspaceId },
|
2020-06-17 10:19:56 +00:00
|
|
|
};
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
export default connect(mapStateToProps)(
|
|
|
|
|
reduxForm<
|
|
|
|
|
CreateApplicationFormValues,
|
2020-11-03 13:05:40 +00:00
|
|
|
{
|
|
|
|
|
onCancel: () => void;
|
2022-06-15 15:37:41 +00:00
|
|
|
workspaceId: string;
|
2020-11-03 13:05:40 +00:00
|
|
|
initialValues: Record<string, unknown>;
|
|
|
|
|
}
|
2020-06-17 10:19:56 +00:00
|
|
|
>({
|
2020-10-08 10:32:31 +00:00
|
|
|
validate,
|
2020-02-03 10:37:03 +00:00
|
|
|
form: CREATE_APPLICATION_FORM_NAME,
|
|
|
|
|
onSubmit: createApplicationFormSubmitHandler,
|
2020-06-17 10:19:56 +00:00
|
|
|
})(CreateApplicationForm),
|
|
|
|
|
);
|