PromucFlow_constructor/app/client/src/widgets/ButtonWidget/component/index.tsx
Ivan Akulov 424d2f6965
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
7cbb12af88,
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 17:11:47 +05:30

485 lines
13 KiB
TypeScript

import React, { useRef, useState } from "react";
import styled, { createGlobalStyle, css } from "styled-components";
import Interweave from "interweave";
import type { IButtonProps, MaybeElement } from "@blueprintjs/core";
import { Button, Alignment, Position, Classes } from "@blueprintjs/core";
import { Popover2 } from "@blueprintjs/popover2";
import type { IconName } from "@blueprintjs/icons";
import type { ComponentProps } from "widgets/BaseComponent";
import { useScript, ScriptStatus, AddScriptTo } from "utils/hooks/useScript";
import {
GOOGLE_RECAPTCHA_KEY_ERROR,
GOOGLE_RECAPTCHA_DOMAIN_ERROR,
createMessage,
} from "@appsmith/constants/messages";
import { Toaster, Variant } from "design-system-old";
import ReCAPTCHA from "react-google-recaptcha";
import { Colors } from "constants/Colors";
import _ from "lodash";
import type {
ButtonPlacement,
ButtonVariant,
RecaptchaType,
} from "components/constants";
import { ButtonVariantTypes, RecaptchaTypes } from "components/constants";
import {
getCustomBackgroundColor,
getCustomBorderColor,
getCustomJustifyContent,
getAlignText,
getComplementaryGrayscaleColor,
} from "widgets/WidgetUtils";
import { DragContainer } from "./DragContainer";
import { buttonHoverActiveStyles } from "./utils";
import type { ThemeProp } from "widgets/constants";
const RecaptchaWrapper = styled.div`
position: relative;
.grecaptcha-badge {
visibility: hidden;
}
`;
const ToolTipWrapper = styled.div`
height: 100%;
&& .bp3-popover2-target {
height: 100%;
width: 100%;
& > div {
height: 100%;
}
}
`;
const TooltipStyles = createGlobalStyle`
.btnTooltipContainer {
.bp3-popover2-content {
max-width: 350px;
overflow-wrap: anywhere;
padding: 10px 12px;
border-radius: 0px;
}
}
`;
const buttonBaseStyle = css<ThemeProp & ButtonStyleProps>`
height: 100%;
background-image: none !important;
font-weight: ${(props) => props.theme.fontWeights[2]};
outline: none;
padding: 0px 10px;
gap: 8px;
&:hover,
&:active,
&:focus {
${buttonHoverActiveStyles}
}
${({ buttonColor, buttonVariant, theme }) => `
background: ${
getCustomBackgroundColor(buttonVariant, buttonColor) !== "none"
? getCustomBackgroundColor(buttonVariant, buttonColor)
: buttonVariant === ButtonVariantTypes.PRIMARY
? theme.colors.button.primary.primary.bgColor
: "none"
} !important;
&:disabled, &.${Classes.DISABLED} {
cursor: not-allowed;
background-color: ${
buttonVariant !== ButtonVariantTypes.TERTIARY &&
"var(--wds-color-bg-disabled)"
} !important;
color: var(--wds-color-text-disabled) !important;
box-shadow: none !important;
pointer-events: none;
border-color: var(--wds-color-border-disabled) !important;
> span {
color: var(--wds-color-text-disabled) !important;
}
}
border: ${
getCustomBorderColor(buttonVariant, buttonColor) !== "none"
? `1px solid ${getCustomBorderColor(buttonVariant, buttonColor)}`
: buttonVariant === ButtonVariantTypes.SECONDARY
? `1px solid ${theme.colors.button.primary.secondary.borderColor}`
: "none"
} !important;
& > * {
margin-right: 0;
}
& > span {
max-height: 100%;
max-width: 99%;
text-overflow: ellipsis;
overflow: hidden;
display: -webkit-box;
-webkit-line-clamp: 1;
-webkit-box-orient: vertical;
line-height: normal;
color: ${
buttonVariant === ButtonVariantTypes.PRIMARY
? getComplementaryGrayscaleColor(buttonColor)
: getCustomBackgroundColor(ButtonVariantTypes.PRIMARY, buttonColor)
} !important;
}
`}
border-radius: ${({ borderRadius }) => borderRadius};
box-shadow: ${({ boxShadow }) => `${boxShadow ?? "none"}`} !important;
${({ placement }) =>
placement
? `
justify-content: ${getCustomJustifyContent(placement)};
& > span.bp3-button-text {
flex: unset !important;
}
`
: ""}
`;
export const StyledButton = styled((props) => (
<Button
{..._.omit(props, [
"borderRadius",
"boxShadow",
"boxShadowColor",
"buttonColor",
"buttonVariant",
])}
/>
))<ThemeProp & ButtonStyleProps>`
${buttonBaseStyle}
`;
export type ButtonStyleProps = {
buttonColor?: string;
buttonVariant?: ButtonVariant;
boxShadow?: string;
boxShadowColor?: string;
borderRadius?: string;
iconName?: IconName;
iconAlign?: Alignment;
placement?: ButtonPlacement;
};
// To be used in any other part of the app
export function BaseButton(props: IButtonProps & ButtonStyleProps) {
const {
borderRadius,
boxShadow,
boxShadowColor,
buttonColor,
buttonVariant,
className,
disabled,
icon,
iconAlign,
iconName,
loading,
onClick,
placement,
rightIcon,
text,
} = props;
const isRightAlign = iconAlign === Alignment.RIGHT;
return (
<DragContainer
buttonColor={buttonColor}
buttonVariant={buttonVariant}
disabled={disabled}
loading={loading}
onClick={onClick}
showInAllModes
>
<StyledButton
alignText={getAlignText(isRightAlign, iconName)}
borderRadius={borderRadius}
boxShadow={boxShadow}
boxShadowColor={boxShadowColor}
buttonColor={buttonColor}
buttonVariant={buttonVariant}
className={className}
data-test-variant={buttonVariant}
disabled={disabled}
fill
icon={isRightAlign ? icon : iconName || icon}
loading={loading}
onClick={onClick}
placement={placement}
rightIcon={isRightAlign ? iconName || rightIcon : rightIcon}
text={text}
/>
</DragContainer>
);
}
BaseButton.defaultProps = {
buttonColor: Colors.GREEN,
buttonVariant: ButtonVariantTypes.PRIMARY,
disabled: false,
text: "Button Text",
minimal: true,
};
export enum ButtonType {
SUBMIT = "submit",
RESET = "reset",
BUTTON = "button",
}
interface RecaptchaProps {
googleRecaptchaKey?: string;
clickWithRecaptcha: (token: string) => void;
handleRecaptchaV2Loading?: (isLoading: boolean) => void;
recaptchaType?: RecaptchaType;
}
interface ButtonComponentProps extends ComponentProps {
text?: string;
icon?: IconName | MaybeElement;
tooltip?: string;
onClick?: (event: React.MouseEvent<HTMLElement>) => void;
isDisabled?: boolean;
isLoading: boolean;
rightIcon?: IconName | MaybeElement;
type: ButtonType;
buttonColor?: string;
buttonVariant?: ButtonVariant;
borderRadius?: string;
boxShadow?: string;
boxShadowColor?: string;
iconName?: IconName;
iconAlign?: Alignment;
placement?: ButtonPlacement;
className?: string;
}
type RecaptchaV2ComponentPropType = {
children: any;
className?: string;
isDisabled?: boolean;
recaptchaType?: RecaptchaType;
isLoading: boolean;
handleError: (event: React.MouseEvent<HTMLElement>, error: string) => void;
};
function RecaptchaV2Component(
props: RecaptchaV2ComponentPropType & RecaptchaProps,
) {
const recaptchaRef = useRef<ReCAPTCHA>(null);
const [isInvalidKey, setInvalidKey] = useState(false);
const handleRecaptchaLoading = (isloading: boolean) => {
props.handleRecaptchaV2Loading && props.handleRecaptchaV2Loading(isloading);
};
const handleBtnClick = async (event: React.MouseEvent<HTMLElement>) => {
if (props.isDisabled) return;
if (props.isLoading) return;
if (isInvalidKey) {
// Handle incorrent google recaptcha site key
props.handleError(event, createMessage(GOOGLE_RECAPTCHA_KEY_ERROR));
} else {
handleRecaptchaLoading(true);
try {
await recaptchaRef?.current?.reset();
const token = await recaptchaRef?.current?.executeAsync();
if (token) {
props.clickWithRecaptcha(token);
} else {
// Handle incorrent google recaptcha site key
props.handleError(event, createMessage(GOOGLE_RECAPTCHA_KEY_ERROR));
}
handleRecaptchaLoading(false);
} catch (err) {
handleRecaptchaLoading(false);
// Handle error due to google recaptcha key of different domain
props.handleError(event, createMessage(GOOGLE_RECAPTCHA_DOMAIN_ERROR));
}
}
};
return (
<RecaptchaWrapper className={props.className} onClick={handleBtnClick}>
{props.children}
<ReCAPTCHA
onErrored={() => setInvalidKey(true)}
ref={recaptchaRef}
sitekey={props.googleRecaptchaKey || ""}
size="invisible"
/>
</RecaptchaWrapper>
);
}
type RecaptchaV3ComponentPropType = {
children: any;
className?: string;
isDisabled?: boolean;
recaptchaType?: RecaptchaType;
isLoading: boolean;
handleError: (event: React.MouseEvent<HTMLElement>, error: string) => void;
};
function RecaptchaV3Component(
props: RecaptchaV3ComponentPropType & RecaptchaProps,
) {
// Check if a string is a valid JSON string
const checkValidJson = (inputString: string): boolean => {
return !inputString.includes('"');
};
const handleBtnClick = (event: React.MouseEvent<HTMLElement>) => {
if (props.isDisabled) return;
if (props.isLoading) return;
if (status === ScriptStatus.READY) {
(window as any).grecaptcha.ready(() => {
try {
(window as any).grecaptcha
.execute(props.googleRecaptchaKey, {
action: "submit",
})
.then((token: any) => {
props.clickWithRecaptcha(token);
})
.catch(() => {
// Handle incorrent google recaptcha site key
props.handleError(
event,
createMessage(GOOGLE_RECAPTCHA_KEY_ERROR),
);
});
} catch (err) {
// Handle error due to google recaptcha key of different domain
props.handleError(
event,
createMessage(GOOGLE_RECAPTCHA_DOMAIN_ERROR),
);
}
});
}
};
let validGoogleRecaptchaKey = props.googleRecaptchaKey;
if (validGoogleRecaptchaKey && !checkValidJson(validGoogleRecaptchaKey)) {
validGoogleRecaptchaKey = undefined;
}
const status = useScript(
`https://www.google.com/recaptcha/api.js?render=${validGoogleRecaptchaKey}`,
AddScriptTo.HEAD,
);
return (
<div className={props.className} onClick={handleBtnClick}>
{props.children}
</div>
);
}
const Wrapper = styled.div`
height: 100%;
`;
function BtnWrapper(
props: {
children: any;
className?: string;
isDisabled?: boolean;
isLoading: boolean;
onClick?: (event: React.MouseEvent<HTMLElement>) => void;
} & RecaptchaProps,
) {
if (!props.googleRecaptchaKey) {
return (
<Wrapper
className={props.className}
onClick={(e: React.MouseEvent<HTMLElement>) =>
props.onClick && !props.isLoading && props.onClick(e)
}
>
{props.children}
</Wrapper>
);
} else {
const handleError = (
event: React.MouseEvent<HTMLElement>,
error: string,
) => {
Toaster.show({
text: error,
variant: Variant.danger,
});
props.onClick && !props.isLoading && props.onClick(event);
};
if (props.recaptchaType === RecaptchaTypes.V2) {
return <RecaptchaV2Component {...props} handleError={handleError} />;
} else {
return <RecaptchaV3Component {...props} handleError={handleError} />;
}
}
}
// To be used with the canvas
function ButtonComponent(props: ButtonComponentProps & RecaptchaProps) {
const btnWrapper = (
<BtnWrapper
className={props.className}
clickWithRecaptcha={props.clickWithRecaptcha}
googleRecaptchaKey={props.googleRecaptchaKey}
handleRecaptchaV2Loading={props.handleRecaptchaV2Loading}
isDisabled={props.isDisabled}
isLoading={props.isLoading}
onClick={props.onClick}
recaptchaType={props.recaptchaType}
>
<BaseButton
borderRadius={props.borderRadius}
boxShadow={props.boxShadow}
boxShadowColor={props.boxShadowColor}
buttonColor={props.buttonColor}
buttonVariant={props.buttonVariant}
disabled={props.isDisabled}
icon={props.icon}
iconAlign={props.iconAlign}
iconName={props.iconName}
loading={props.isLoading}
placement={props.placement}
rightIcon={props.rightIcon}
text={props.text}
type={props.type}
/>
</BtnWrapper>
);
if (props.tooltip) {
return (
<ToolTipWrapper>
<TooltipStyles />
<Popover2
autoFocus={false}
content={<Interweave content={props.tooltip} />}
hoverOpenDelay={200}
interactionKind="hover"
portalClassName="btnTooltipContainer"
position={Position.TOP}
>
{btnWrapper}
</Popover2>
</ToolTipWrapper>
);
} else {
return btnWrapper;
}
}
export default ButtonComponent;