2020-04-28 06:52:53 +00:00
|
|
|
import React from "react";
|
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 { ControlProps } from "./BaseControl";
|
|
|
|
|
import BaseControl from "./BaseControl";
|
|
|
|
|
import type { ControlType } from "constants/PropertyControlConstants";
|
|
|
|
|
import type { AppState } from "@appsmith/reducers";
|
2020-10-27 05:02:32 +00:00
|
|
|
import styled from "styled-components";
|
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 { InputType } from "components/constants";
|
2023-05-19 18:37:06 +00:00
|
|
|
import type { InputTypes as DSInputType } from "design-system";
|
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 { WrappedFieldMetaProps, WrappedFieldInputProps } from "redux-form";
|
|
|
|
|
import { Field, formValueSelector } from "redux-form";
|
2023-01-20 14:03:42 +00:00
|
|
|
import { connect } from "react-redux";
|
2023-05-19 18:37:06 +00:00
|
|
|
import { Input } from "design-system";
|
2020-10-27 05:02:32 +00:00
|
|
|
|
2021-02-26 06:58:47 +00:00
|
|
|
export const StyledInfo = styled.span`
|
2020-10-27 05:02:32 +00:00
|
|
|
font-weight: normal;
|
|
|
|
|
line-height: normal;
|
2023-05-19 18:37:06 +00:00
|
|
|
color: var(--ads-v2-color-fg);
|
2020-10-27 05:02:32 +00:00
|
|
|
font-size: 12px;
|
|
|
|
|
margin-left: 1px;
|
|
|
|
|
`;
|
2020-04-28 06:52:53 +00:00
|
|
|
|
2023-01-20 14:03:42 +00:00
|
|
|
const FieldWrapper = styled.div`
|
|
|
|
|
position: relative;
|
2023-02-07 09:34:56 +00:00
|
|
|
min-width: 380px;
|
2023-05-19 18:37:06 +00:00
|
|
|
max-width: 545px;
|
2023-01-20 14:03:42 +00:00
|
|
|
`;
|
2020-04-28 06:52:53 +00:00
|
|
|
|
2023-01-20 14:03:42 +00:00
|
|
|
const SecretDisplayIndicator = styled.input`
|
|
|
|
|
position: absolute;
|
|
|
|
|
top: 0;
|
|
|
|
|
left: 0;
|
|
|
|
|
width: 100%;
|
|
|
|
|
height: 100%;
|
|
|
|
|
display: flex;
|
|
|
|
|
align-items: center;
|
|
|
|
|
padding: 0px var(--ads-spaces-6);
|
|
|
|
|
z-index: 1;
|
|
|
|
|
cursor: text;
|
|
|
|
|
border: none;
|
|
|
|
|
background: none;
|
|
|
|
|
`;
|
|
|
|
|
|
|
|
|
|
const PASSWORD_EXISTS_INDICATOR = "······";
|
2020-04-28 06:52:53 +00:00
|
|
|
|
2021-12-27 12:04:45 +00:00
|
|
|
function renderComponent(
|
|
|
|
|
props: {
|
|
|
|
|
placeholder: string;
|
2023-05-19 18:37:06 +00:00
|
|
|
dataType?: DSInputType;
|
2021-12-27 12:04:45 +00:00
|
|
|
disabled?: boolean;
|
2023-01-20 14:03:42 +00:00
|
|
|
reference: any;
|
2022-10-13 13:29:20 +00:00
|
|
|
validator?: (value: string) => { isValid: boolean; message: string };
|
2021-12-27 12:04:45 +00:00
|
|
|
} & {
|
|
|
|
|
meta: Partial<WrappedFieldMetaProps>;
|
|
|
|
|
input: Partial<WrappedFieldInputProps>;
|
|
|
|
|
},
|
|
|
|
|
) {
|
|
|
|
|
return (
|
2023-05-19 18:37:06 +00:00
|
|
|
<Input
|
|
|
|
|
errorMessage={props.validator?.(props.input.value).message}
|
|
|
|
|
isDisabled={props.disabled || false}
|
|
|
|
|
isValid={props.validator?.(props.input.value).isValid}
|
2021-12-27 12:04:45 +00:00
|
|
|
name={props.input?.name}
|
|
|
|
|
onChange={props.input.onChange}
|
|
|
|
|
placeholder={props.placeholder}
|
2023-01-20 14:03:42 +00:00
|
|
|
ref={props.reference}
|
2023-05-19 18:37:06 +00:00
|
|
|
size="md"
|
|
|
|
|
type={props.dataType}
|
2021-12-27 12:04:45 +00:00
|
|
|
value={props.input.value}
|
|
|
|
|
/>
|
|
|
|
|
);
|
|
|
|
|
}
|
2023-01-20 14:03:42 +00:00
|
|
|
|
2020-04-28 06:52:53 +00:00
|
|
|
class InputTextControl extends BaseControl<InputControlProps> {
|
2023-01-20 14:03:42 +00:00
|
|
|
fieldRef: any;
|
|
|
|
|
|
|
|
|
|
state = {
|
|
|
|
|
secretDisplayVisible: false,
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
constructor(props: InputControlProps) {
|
|
|
|
|
super(props);
|
|
|
|
|
this.fieldRef = React.createRef();
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
onClickSecretDisplayIndicator = () => {
|
|
|
|
|
if (!this.state.secretDisplayVisible) return;
|
|
|
|
|
this.setState({
|
|
|
|
|
secretDisplayVisible: false,
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
if (this.fieldRef.current) this.fieldRef.current?.focus();
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
checkForSecretOverlayIndicator = () => {
|
|
|
|
|
return (
|
|
|
|
|
this.props.dataType === "PASSWORD" &&
|
|
|
|
|
this.props.isSecretExistsPath &&
|
|
|
|
|
this.props.isSecretExistsData
|
|
|
|
|
);
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
onBlur = () => {
|
|
|
|
|
if (
|
|
|
|
|
this.checkForSecretOverlayIndicator() &&
|
|
|
|
|
this.fieldRef.current?.value?.length === 0
|
|
|
|
|
) {
|
|
|
|
|
this.setState({
|
|
|
|
|
secretDisplayVisible: true,
|
|
|
|
|
});
|
|
|
|
|
}
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
componentDidMount() {
|
|
|
|
|
if (this.checkForSecretOverlayIndicator()) {
|
|
|
|
|
this.setState({
|
|
|
|
|
secretDisplayVisible: true,
|
|
|
|
|
});
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2020-04-28 06:52:53 +00:00
|
|
|
render() {
|
|
|
|
|
const {
|
2021-05-13 08:35:39 +00:00
|
|
|
configProperty,
|
2023-01-20 14:03:42 +00:00
|
|
|
customStyles,
|
2021-05-13 08:35:39 +00:00
|
|
|
dataType,
|
|
|
|
|
disabled,
|
2021-12-27 12:04:45 +00:00
|
|
|
encrypted,
|
2020-04-28 06:52:53 +00:00
|
|
|
isValid,
|
|
|
|
|
label,
|
|
|
|
|
placeholderText,
|
2021-05-13 08:35:39 +00:00
|
|
|
propertyValue,
|
2021-02-26 06:58:47 +00:00
|
|
|
subtitle,
|
2021-05-13 08:35:39 +00:00
|
|
|
validationMessage,
|
2022-10-13 13:29:20 +00:00
|
|
|
validator,
|
2020-04-28 06:52:53 +00:00
|
|
|
} = this.props;
|
|
|
|
|
|
|
|
|
|
return (
|
2023-05-19 18:37:06 +00:00
|
|
|
<FieldWrapper data-testid={configProperty} style={customStyles || {}}>
|
2023-01-20 14:03:42 +00:00
|
|
|
{this.state.secretDisplayVisible && (
|
|
|
|
|
<SecretDisplayIndicator
|
|
|
|
|
onClick={this.onClickSecretDisplayIndicator}
|
|
|
|
|
onFocus={this.onClickSecretDisplayIndicator}
|
|
|
|
|
type="password"
|
|
|
|
|
value={PASSWORD_EXISTS_INDICATOR}
|
|
|
|
|
/>
|
|
|
|
|
)}
|
|
|
|
|
<Field
|
|
|
|
|
asyncControl
|
|
|
|
|
component={renderComponent}
|
|
|
|
|
dataType={this.getType(dataType)}
|
|
|
|
|
disabled={disabled || false}
|
|
|
|
|
encrypted={encrypted}
|
|
|
|
|
isValid={isValid}
|
|
|
|
|
label={label}
|
|
|
|
|
name={configProperty}
|
|
|
|
|
onBlur={this.onBlur}
|
|
|
|
|
onFocus={this.onClickSecretDisplayIndicator}
|
|
|
|
|
placeholder={this.state.secretDisplayVisible ? "" : placeholderText}
|
|
|
|
|
reference={this.fieldRef}
|
|
|
|
|
subtitle={subtitle}
|
|
|
|
|
validationMessage={validationMessage}
|
|
|
|
|
validator={validator}
|
|
|
|
|
value={propertyValue}
|
|
|
|
|
/>
|
|
|
|
|
</FieldWrapper>
|
2020-04-28 06:52:53 +00:00
|
|
|
);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
getType(dataType: InputType | undefined) {
|
|
|
|
|
switch (dataType) {
|
|
|
|
|
case "PASSWORD":
|
|
|
|
|
return "password";
|
2023-05-19 18:37:06 +00:00
|
|
|
case "CURRENCY":
|
|
|
|
|
case "INTEGER":
|
|
|
|
|
case "PHONE_NUMBER":
|
2020-04-28 06:52:53 +00:00
|
|
|
case "NUMBER":
|
|
|
|
|
return "number";
|
|
|
|
|
default:
|
|
|
|
|
return "text";
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
getControlType(): ControlType {
|
|
|
|
|
return "INPUT_TEXT";
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
export interface InputControlProps extends ControlProps {
|
|
|
|
|
placeholderText: string;
|
|
|
|
|
inputType?: InputType;
|
|
|
|
|
dataType?: InputType;
|
2021-02-26 06:58:47 +00:00
|
|
|
subtitle?: string;
|
2020-10-27 05:02:32 +00:00
|
|
|
encrypted?: boolean;
|
2021-02-26 06:58:47 +00:00
|
|
|
disabled?: boolean;
|
2022-10-13 13:29:20 +00:00
|
|
|
validator?: (value: string) => { isValid: boolean; message: string };
|
2023-01-20 14:03:42 +00:00
|
|
|
isSecretExistsData?: boolean;
|
2020-04-28 06:52:53 +00:00
|
|
|
}
|
|
|
|
|
|
2023-01-20 14:03:42 +00:00
|
|
|
const mapStateToProps = (state: AppState, props: InputControlProps) => {
|
|
|
|
|
const valueSelector = formValueSelector(props.formName);
|
|
|
|
|
let isSecretExistsData;
|
|
|
|
|
if (props.isSecretExistsPath) {
|
|
|
|
|
isSecretExistsData = valueSelector(state, props.isSecretExistsPath);
|
|
|
|
|
}
|
|
|
|
|
return {
|
|
|
|
|
isSecretExistsData,
|
|
|
|
|
};
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
export default connect(mapStateToProps)(InputTextControl);
|