2022-08-22 17:57:07 +00:00
|
|
|
import React, { useState } from "react";
|
|
|
|
|
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 { DebouncedFunc } from "lodash";
|
2022-08-22 17:57:07 +00:00
|
|
|
import {
|
|
|
|
|
Button,
|
|
|
|
|
Menu,
|
|
|
|
|
MenuItem,
|
2023-05-19 18:37:06 +00:00
|
|
|
MenuContent,
|
|
|
|
|
MenuTrigger,
|
|
|
|
|
SearchInput,
|
|
|
|
|
Tooltip,
|
|
|
|
|
} from "design-system";
|
2022-08-22 17:57:07 +00:00
|
|
|
import { HeaderWrapper } from "pages/Settings/components";
|
2023-05-19 18:37:06 +00:00
|
|
|
import { SettingsHeader } from "components/utils/helperComponents";
|
2022-08-22 17:57:07 +00:00
|
|
|
import { ARE_YOU_SURE, createMessage } from "@appsmith/constants/messages";
|
|
|
|
|
import { useMediaQuery } from "react-responsive";
|
|
|
|
|
|
|
|
|
|
type PageHeaderProps = {
|
|
|
|
|
buttonText?: string;
|
|
|
|
|
searchPlaceholder: string;
|
|
|
|
|
onButtonClick?: () => void;
|
|
|
|
|
onSearch?: DebouncedFunc<(search: string) => void>;
|
2023-05-19 18:37:06 +00:00
|
|
|
pageMenuItems: any[];
|
2022-08-22 17:57:07 +00:00
|
|
|
title?: string;
|
|
|
|
|
showMoreOptions?: boolean;
|
2022-12-22 17:40:56 +00:00
|
|
|
showSearchNButton?: boolean;
|
2022-08-22 17:57:07 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
|
|
const Container = styled.div<{ isMobile?: boolean }>`
|
|
|
|
|
display: flex;
|
|
|
|
|
justify-content: space-between;
|
|
|
|
|
align-items: center;
|
|
|
|
|
gap: 24px;
|
|
|
|
|
flex-wrap: ${(props) => (props.isMobile ? "wrap" : "nowrap")};
|
2023-05-19 18:37:06 +00:00
|
|
|
min-height: 36px;
|
2022-08-22 17:57:07 +00:00
|
|
|
`;
|
|
|
|
|
|
|
|
|
|
const SearchWrapper = styled.div`
|
|
|
|
|
width: 100%;
|
|
|
|
|
`;
|
|
|
|
|
|
|
|
|
|
const ActionsWrapper = styled.div`
|
|
|
|
|
display: flex;
|
|
|
|
|
align-items: center;
|
|
|
|
|
width: 100%;
|
|
|
|
|
|
2023-05-19 18:37:06 +00:00
|
|
|
.actions-icon {
|
2022-08-22 17:57:07 +00:00
|
|
|
margin-left: 12px;
|
|
|
|
|
}
|
|
|
|
|
`;
|
|
|
|
|
|
|
|
|
|
export function SettingsPageHeader(props: PageHeaderProps) {
|
|
|
|
|
const [showConfirmationText, setShowConfirmationText] = useState(false);
|
|
|
|
|
const [showOptions, setShowOptions] = useState(false);
|
|
|
|
|
|
|
|
|
|
const {
|
|
|
|
|
buttonText,
|
|
|
|
|
onSearch,
|
|
|
|
|
pageMenuItems,
|
|
|
|
|
searchPlaceholder,
|
|
|
|
|
showMoreOptions,
|
2022-12-22 17:40:56 +00:00
|
|
|
showSearchNButton = true,
|
2022-08-22 17:57:07 +00:00
|
|
|
title,
|
|
|
|
|
} = props;
|
|
|
|
|
|
|
|
|
|
const handleSearch = (search: string) => {
|
|
|
|
|
onSearch?.(search.toLocaleUpperCase());
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
const onOptionSelect = (
|
|
|
|
|
e: React.MouseEvent<Element, MouseEvent>,
|
2023-05-19 18:37:06 +00:00
|
|
|
menuItem: any,
|
2022-08-22 17:57:07 +00:00
|
|
|
) => {
|
|
|
|
|
if (menuItem.label === "delete") {
|
|
|
|
|
setShowOptions(true);
|
|
|
|
|
setShowConfirmationText(true);
|
|
|
|
|
showConfirmationText && menuItem?.onSelect?.(e, "delete");
|
|
|
|
|
} else if (menuItem.label === "rename") {
|
|
|
|
|
setShowOptions(false);
|
|
|
|
|
} else {
|
|
|
|
|
setShowConfirmationText(false);
|
|
|
|
|
setShowOptions(false);
|
|
|
|
|
menuItem?.onSelect?.(e, "other");
|
|
|
|
|
}
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
const isMobile: boolean = useMediaQuery({ maxWidth: 767 });
|
|
|
|
|
|
|
|
|
|
return (
|
|
|
|
|
<Container isMobile={isMobile}>
|
|
|
|
|
<HeaderWrapper margin={`0px`}>
|
2023-05-19 18:37:06 +00:00
|
|
|
<Tooltip
|
2023-03-23 09:33:14 +00:00
|
|
|
content={title}
|
2023-05-19 18:37:06 +00:00
|
|
|
isDisabled={title && title.length < 32 ? true : false}
|
2023-03-23 09:33:14 +00:00
|
|
|
>
|
2023-05-19 18:37:06 +00:00
|
|
|
<SettingsHeader
|
|
|
|
|
data-testid="t--page-title"
|
|
|
|
|
kind="heading-m"
|
|
|
|
|
renderAs="h2"
|
|
|
|
|
>
|
|
|
|
|
{title}
|
|
|
|
|
</SettingsHeader>
|
|
|
|
|
</Tooltip>
|
2022-08-22 17:57:07 +00:00
|
|
|
</HeaderWrapper>
|
|
|
|
|
<Container isMobile={isMobile}>
|
|
|
|
|
<SearchWrapper>
|
2022-12-22 17:40:56 +00:00
|
|
|
{onSearch && showSearchNButton && (
|
2023-05-19 18:37:06 +00:00
|
|
|
<SearchInput
|
|
|
|
|
UNSAFE_width={isMobile ? "100%" : "376px"}
|
2022-08-22 17:57:07 +00:00
|
|
|
className="search-input"
|
|
|
|
|
data-testid={"t--search-input"}
|
|
|
|
|
onChange={handleSearch}
|
|
|
|
|
placeholder={searchPlaceholder}
|
2023-05-19 18:37:06 +00:00
|
|
|
size="md"
|
2022-08-22 17:57:07 +00:00
|
|
|
/>
|
|
|
|
|
)}
|
|
|
|
|
</SearchWrapper>
|
|
|
|
|
<ActionsWrapper>
|
2022-12-22 17:40:56 +00:00
|
|
|
{buttonText && showSearchNButton && (
|
2023-05-19 18:37:06 +00:00
|
|
|
<Button
|
2022-08-22 17:57:07 +00:00
|
|
|
data-testid={"t--page-header-input"}
|
|
|
|
|
onClick={props.onButtonClick}
|
2023-05-19 18:37:06 +00:00
|
|
|
size="md"
|
|
|
|
|
>
|
|
|
|
|
{buttonText}
|
|
|
|
|
</Button>
|
2022-08-22 17:57:07 +00:00
|
|
|
)}
|
|
|
|
|
{showMoreOptions && (
|
|
|
|
|
<Menu
|
2023-05-19 18:37:06 +00:00
|
|
|
onOpenChange={(open: boolean) => {
|
|
|
|
|
if (showOptions) {
|
|
|
|
|
setShowOptions(open);
|
|
|
|
|
showConfirmationText && setShowConfirmationText(false);
|
|
|
|
|
}
|
2022-08-22 17:57:07 +00:00
|
|
|
}}
|
2023-05-19 18:37:06 +00:00
|
|
|
open={showOptions}
|
|
|
|
|
>
|
|
|
|
|
<MenuTrigger>
|
|
|
|
|
<Button
|
2022-08-22 17:57:07 +00:00
|
|
|
className="actions-icon"
|
|
|
|
|
data-testid="t--page-header-actions"
|
2023-05-19 18:37:06 +00:00
|
|
|
isIconButton
|
|
|
|
|
kind="tertiary"
|
2022-08-22 17:57:07 +00:00
|
|
|
onClick={() => setShowOptions(!showOptions)}
|
2023-05-19 18:37:06 +00:00
|
|
|
size="md"
|
|
|
|
|
startIcon="more-2-fill"
|
2022-08-22 17:57:07 +00:00
|
|
|
/>
|
2023-05-19 18:37:06 +00:00
|
|
|
</MenuTrigger>
|
|
|
|
|
<MenuContent align="end">
|
|
|
|
|
{pageMenuItems &&
|
|
|
|
|
pageMenuItems.map((menuItem) => (
|
|
|
|
|
<MenuItem
|
|
|
|
|
className={`${menuItem.className} ${
|
|
|
|
|
menuItem.label === "delete" ? "error-menuitem" : ""
|
|
|
|
|
}`}
|
|
|
|
|
data-testid={`t--${menuItem.className}`}
|
|
|
|
|
key={menuItem.text}
|
|
|
|
|
onClick={(e: React.MouseEvent) => {
|
|
|
|
|
onOptionSelect(e, menuItem);
|
|
|
|
|
}}
|
|
|
|
|
startIcon={menuItem.icon}
|
|
|
|
|
>
|
|
|
|
|
{showConfirmationText && menuItem.label === "delete"
|
2022-08-22 17:57:07 +00:00
|
|
|
? createMessage(ARE_YOU_SURE)
|
2023-05-19 18:37:06 +00:00
|
|
|
: menuItem.text}
|
|
|
|
|
</MenuItem>
|
|
|
|
|
))}
|
|
|
|
|
</MenuContent>
|
2022-08-22 17:57:07 +00:00
|
|
|
</Menu>
|
|
|
|
|
)}
|
|
|
|
|
</ActionsWrapper>
|
|
|
|
|
</Container>
|
|
|
|
|
</Container>
|
|
|
|
|
);
|
|
|
|
|
}
|