2022-12-20 09:49:09 +00:00
|
|
|
import React, { useRef } from "react";
|
2021-09-12 16:36:43 +00:00
|
|
|
import styled from "styled-components";
|
|
|
|
|
import { connect } from "react-redux";
|
|
|
|
|
import DetailsForm from "./DetailsForm";
|
|
|
|
|
import {
|
2022-12-20 09:49:09 +00:00
|
|
|
WELCOME_FORM_USECASE_FIELD_NAME,
|
2021-09-12 16:36:43 +00:00
|
|
|
WELCOME_FORM_EMAIL_FIELD_NAME,
|
|
|
|
|
WELCOME_FORM_NAME,
|
|
|
|
|
WELCOME_FORM_NAME_FIELD_NAME,
|
|
|
|
|
WELCOME_FORM_PASSWORD_FIELD_NAME,
|
|
|
|
|
WELCOME_FORM_ROLE_FIELD_NAME,
|
|
|
|
|
WELCOME_FORM_ROLE_NAME_FIELD_NAME,
|
|
|
|
|
WELCOME_FORM_VERIFY_PASSWORD_FIELD_NAME,
|
2022-12-20 09:49:09 +00:00
|
|
|
WELCOME_FORM_CUSTOM_USECASE_FIELD_NAME,
|
2022-09-02 17:15:08 +00:00
|
|
|
} from "@appsmith/constants/forms";
|
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 { FormErrors, InjectedFormProps } from "redux-form";
|
|
|
|
|
import { formValueSelector, getFormSyncErrors, reduxForm } from "redux-form";
|
2021-09-12 16:36:43 +00:00
|
|
|
import { isEmail, isStrongPassword } from "utils/formhelpers";
|
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";
|
2022-01-07 06:08:17 +00:00
|
|
|
import { SUPER_USER_SUBMIT_PATH } from "@appsmith/constants/ApiConstants";
|
2022-12-20 09:49:09 +00:00
|
|
|
import { useState } from "react";
|
2023-04-20 09:27:41 +00:00
|
|
|
import { isAirgapped } from "@appsmith/utils/airgapHelpers";
|
2021-09-12 16:36:43 +00:00
|
|
|
|
|
|
|
|
const PageWrapper = styled.div`
|
|
|
|
|
width: 100%;
|
|
|
|
|
display: flex;
|
2023-05-25 18:21:56 +00:00
|
|
|
justify-content: start;
|
2021-09-17 10:01:42 +00:00
|
|
|
overflow: auto;
|
|
|
|
|
position: relative;
|
|
|
|
|
z-index: 100;
|
2021-09-12 16:36:43 +00:00
|
|
|
`;
|
|
|
|
|
|
2023-05-25 18:21:56 +00:00
|
|
|
const SetupFormContainer = styled.div``;
|
2021-09-12 16:36:43 +00:00
|
|
|
|
|
|
|
|
const SetupStep = styled.div<{ active: boolean }>`
|
|
|
|
|
display: ${(props) => (props.active ? "block" : "none")};
|
|
|
|
|
`;
|
|
|
|
|
|
|
|
|
|
const SpaceFiller = styled.div`
|
|
|
|
|
height: 100px;
|
|
|
|
|
`;
|
|
|
|
|
|
|
|
|
|
export type DetailsFormValues = {
|
2023-05-25 18:21:56 +00:00
|
|
|
firstName?: string;
|
|
|
|
|
lastName?: string;
|
2021-09-12 16:36:43 +00:00
|
|
|
email?: string;
|
|
|
|
|
password?: string;
|
|
|
|
|
verifyPassword?: string;
|
|
|
|
|
role?: string;
|
|
|
|
|
useCase?: string;
|
2022-02-19 06:26:10 +00:00
|
|
|
custom_useCase?: string;
|
2021-09-12 16:36:43 +00:00
|
|
|
role_name?: string;
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
const validate = (values: DetailsFormValues) => {
|
|
|
|
|
const errors: DetailsFormValues = {};
|
2023-05-25 18:21:56 +00:00
|
|
|
if (!values.firstName) {
|
|
|
|
|
errors.firstName = "This field is required.";
|
2021-09-12 16:36:43 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if (!values.email || !isEmail(values.email)) {
|
2023-05-25 18:21:56 +00:00
|
|
|
errors.email = "Enter a valid email address.";
|
2021-09-12 16:36:43 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if (!values.password || !isStrongPassword(values.password)) {
|
2023-05-25 18:21:56 +00:00
|
|
|
errors.password = "Please enter a strong password.";
|
2021-09-12 16:36:43 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if (!values.verifyPassword || values.password != values.verifyPassword) {
|
2023-05-25 18:21:56 +00:00
|
|
|
errors.verifyPassword = "Passwords don't match.";
|
2021-09-12 16:36:43 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if (!values.role) {
|
|
|
|
|
errors.role = "Please select a role";
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if (values.role == "other" && !values.role_name) {
|
|
|
|
|
errors.role_name = "Please enter a role";
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if (!values.useCase) {
|
|
|
|
|
errors.useCase = "Please select a use case";
|
|
|
|
|
}
|
|
|
|
|
|
2022-02-19 06:26:10 +00:00
|
|
|
if (values.useCase === "other" && !values.custom_useCase)
|
|
|
|
|
errors.custom_useCase = "Please enter a use case";
|
|
|
|
|
|
2021-09-12 16:36:43 +00:00
|
|
|
return errors;
|
|
|
|
|
};
|
|
|
|
|
|
2022-04-13 10:07:11 +00:00
|
|
|
export type SetupFormProps = DetailsFormValues & {
|
|
|
|
|
formSyncErrors?: FormErrors<string, string>;
|
|
|
|
|
} & InjectedFormProps<
|
|
|
|
|
DetailsFormValues,
|
|
|
|
|
{
|
|
|
|
|
formSyncErrors?: FormErrors<string, string>;
|
|
|
|
|
}
|
|
|
|
|
>;
|
|
|
|
|
|
|
|
|
|
function SetupForm(props: SetupFormProps) {
|
2021-09-12 16:36:43 +00:00
|
|
|
const signupURL = `/api/v1/${SUPER_USER_SUBMIT_PATH}`;
|
|
|
|
|
const [showDetailsForm, setShowDetailsForm] = useState(true);
|
|
|
|
|
const formRef = useRef<HTMLFormElement>(null);
|
2023-05-25 18:21:56 +00:00
|
|
|
const isAirgappedFlag = isAirgapped();
|
|
|
|
|
|
2021-09-12 16:36:43 +00:00
|
|
|
const onSubmit = () => {
|
|
|
|
|
const form: HTMLFormElement = formRef.current as HTMLFormElement;
|
|
|
|
|
const verifyPassword: HTMLInputElement = document.querySelector(
|
|
|
|
|
`[name="verifyPassword"]`,
|
|
|
|
|
) as HTMLInputElement;
|
2023-05-25 18:21:56 +00:00
|
|
|
verifyPassword.removeAttribute("name");
|
|
|
|
|
|
|
|
|
|
const firstName: HTMLInputElement = document.querySelector(
|
|
|
|
|
`[name="firstName"]`,
|
|
|
|
|
) as HTMLInputElement;
|
|
|
|
|
|
|
|
|
|
const lastName: HTMLInputElement = document.querySelector(
|
|
|
|
|
`[name="lastName"]`,
|
|
|
|
|
) as HTMLInputElement;
|
|
|
|
|
|
|
|
|
|
if (firstName && lastName) {
|
|
|
|
|
const fullName = document.createElement("input");
|
|
|
|
|
fullName.type = "text";
|
|
|
|
|
fullName.name = "name";
|
|
|
|
|
fullName.style.display = "none";
|
|
|
|
|
fullName.value = `${firstName.value} ${lastName.value}`;
|
|
|
|
|
form.appendChild(fullName);
|
|
|
|
|
}
|
|
|
|
|
|
2021-09-12 16:36:43 +00:00
|
|
|
const roleInput = document.createElement("input");
|
|
|
|
|
verifyPassword.removeAttribute("name");
|
|
|
|
|
roleInput.type = "text";
|
|
|
|
|
roleInput.name = "role";
|
|
|
|
|
roleInput.style.display = "none";
|
2022-02-19 06:26:10 +00:00
|
|
|
if (props.role !== "other") {
|
2021-09-12 16:36:43 +00:00
|
|
|
roleInput.value = props.role as string;
|
|
|
|
|
} else {
|
|
|
|
|
roleInput.value = props.role_name as string;
|
|
|
|
|
}
|
|
|
|
|
form.appendChild(roleInput);
|
|
|
|
|
const useCaseInput = document.createElement("input");
|
|
|
|
|
useCaseInput.type = "text";
|
|
|
|
|
useCaseInput.name = "useCase";
|
|
|
|
|
useCaseInput.style.display = "none";
|
2022-02-19 06:26:10 +00:00
|
|
|
if (props.useCase !== "other") {
|
|
|
|
|
useCaseInput.value = props.useCase as string;
|
|
|
|
|
} else {
|
|
|
|
|
useCaseInput.value = props.custom_useCase as string;
|
|
|
|
|
}
|
2021-09-12 16:36:43 +00:00
|
|
|
form.appendChild(useCaseInput);
|
2023-05-25 18:21:56 +00:00
|
|
|
const anonymousDataInput = document.createElement("input");
|
|
|
|
|
anonymousDataInput.type = "checkbox";
|
|
|
|
|
anonymousDataInput.value = isAirgappedFlag ? "false" : "true";
|
|
|
|
|
anonymousDataInput.checked = isAirgappedFlag ? false : true;
|
|
|
|
|
anonymousDataInput.name = "allowCollectingAnonymousData";
|
|
|
|
|
anonymousDataInput.style.display = "none";
|
|
|
|
|
form.appendChild(anonymousDataInput);
|
|
|
|
|
const signupForNewsletter: HTMLInputElement = document.querySelector(
|
|
|
|
|
`[name="signupForNewsletter"]`,
|
|
|
|
|
) as HTMLInputElement;
|
|
|
|
|
if (signupForNewsletter)
|
|
|
|
|
signupForNewsletter.value = signupForNewsletter.checked.toString();
|
2021-09-12 16:36:43 +00:00
|
|
|
return true;
|
|
|
|
|
};
|
|
|
|
|
|
2022-04-13 10:07:11 +00:00
|
|
|
const onKeyDown = (event: React.KeyboardEvent<HTMLFormElement>) => {
|
|
|
|
|
if (event.key === "Enter") {
|
|
|
|
|
if (props.valid) {
|
|
|
|
|
if (showDetailsForm) {
|
|
|
|
|
// If we are on the details page we do not want to submit the form
|
|
|
|
|
// instead we move the user to the next page
|
|
|
|
|
event.preventDefault();
|
|
|
|
|
onNext();
|
|
|
|
|
}
|
|
|
|
|
} else {
|
|
|
|
|
// The fields to be marked as touched so that we can display the errors
|
|
|
|
|
const toTouch = [];
|
|
|
|
|
// We fetch the fields which are invalid
|
|
|
|
|
for (const key in props.formSyncErrors) {
|
|
|
|
|
props.formSyncErrors.hasOwnProperty(key) && toTouch.push(key);
|
|
|
|
|
}
|
|
|
|
|
props.touch(...toTouch);
|
|
|
|
|
// prevent submitting the form on enter if the values are invalid
|
|
|
|
|
event.preventDefault();
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
const onNext = () => {
|
|
|
|
|
setShowDetailsForm(false);
|
|
|
|
|
};
|
|
|
|
|
|
2021-09-12 16:36:43 +00:00
|
|
|
return (
|
|
|
|
|
<PageWrapper>
|
|
|
|
|
<SetupFormContainer>
|
|
|
|
|
<form
|
|
|
|
|
action={signupURL}
|
2022-04-13 10:07:11 +00:00
|
|
|
data-testid="super-user-form"
|
2021-09-12 16:36:43 +00:00
|
|
|
id="super-user-form"
|
|
|
|
|
method="POST"
|
2022-04-13 10:07:11 +00:00
|
|
|
onKeyDown={onKeyDown}
|
2021-09-12 16:36:43 +00:00
|
|
|
onSubmit={onSubmit}
|
|
|
|
|
ref={formRef}
|
|
|
|
|
>
|
|
|
|
|
<SetupStep active={showDetailsForm}>
|
2023-05-25 18:21:56 +00:00
|
|
|
<DetailsForm {...props} onNext={onNext} />
|
2021-09-12 16:36:43 +00:00
|
|
|
</SetupStep>
|
|
|
|
|
</form>
|
|
|
|
|
<SpaceFiller />
|
|
|
|
|
</SetupFormContainer>
|
|
|
|
|
</PageWrapper>
|
|
|
|
|
);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
const selector = formValueSelector(WELCOME_FORM_NAME);
|
|
|
|
|
export default connect((state: AppState) => {
|
|
|
|
|
return {
|
|
|
|
|
name: selector(state, WELCOME_FORM_NAME_FIELD_NAME),
|
|
|
|
|
email: selector(state, WELCOME_FORM_EMAIL_FIELD_NAME),
|
|
|
|
|
password: selector(state, WELCOME_FORM_PASSWORD_FIELD_NAME),
|
|
|
|
|
verify_password: selector(state, WELCOME_FORM_VERIFY_PASSWORD_FIELD_NAME),
|
|
|
|
|
role: selector(state, WELCOME_FORM_ROLE_FIELD_NAME),
|
|
|
|
|
role_name: selector(state, WELCOME_FORM_ROLE_NAME_FIELD_NAME),
|
|
|
|
|
useCase: selector(state, WELCOME_FORM_USECASE_FIELD_NAME),
|
2022-02-19 06:26:10 +00:00
|
|
|
custom_useCase: selector(state, WELCOME_FORM_CUSTOM_USECASE_FIELD_NAME),
|
2022-04-13 10:07:11 +00:00
|
|
|
formSyncErrors: getFormSyncErrors(WELCOME_FORM_NAME)(state),
|
2021-09-12 16:36:43 +00:00
|
|
|
};
|
|
|
|
|
}, null)(
|
2022-04-13 10:07:11 +00:00
|
|
|
reduxForm<DetailsFormValues, { formSyncErrors?: FormErrors<string, string> }>(
|
|
|
|
|
{
|
|
|
|
|
validate,
|
|
|
|
|
form: WELCOME_FORM_NAME,
|
|
|
|
|
touchOnBlur: true,
|
|
|
|
|
},
|
|
|
|
|
)(SetupForm),
|
2021-09-12 16:36:43 +00:00
|
|
|
);
|