2022-05-04 09:45:57 +00:00
|
|
|
import React, { useState, useEffect, useRef } 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 {
|
2022-05-04 09:45:57 +00:00
|
|
|
ApplicationPayload,
|
2022-06-21 13:57:34 +00:00
|
|
|
Page,
|
2022-05-04 09:45:57 +00:00
|
|
|
} from "@appsmith/constants/ReduxActionConstants";
|
2023-03-23 11:41:58 +00:00
|
|
|
import { getAppMode } from "selectors/applicationSelectors";
|
2022-05-04 09:45:57 +00:00
|
|
|
import { useSelector } from "react-redux";
|
|
|
|
|
import classNames from "classnames";
|
|
|
|
|
import PrimaryCTA from "./PrimaryCTA";
|
2022-06-15 15:37:41 +00:00
|
|
|
import { getCurrentWorkspaceId } from "@appsmith/selectors/workspaceSelectors";
|
2022-05-04 09:45:57 +00:00
|
|
|
import { getSelectedAppTheme } from "selectors/appThemingSelectors";
|
|
|
|
|
import BrandingBadge from "./BrandingBadgeMobile";
|
|
|
|
|
import { getAppViewHeaderHeight } from "selectors/appViewSelectors";
|
|
|
|
|
import { useOnClickOutside } from "utils/hooks/useOnClickOutside";
|
2022-07-11 04:06:29 +00:00
|
|
|
import { useHref } from "pages/Editor/utils";
|
|
|
|
|
import { APP_MODE } from "entities/App";
|
|
|
|
|
import { builderURL, viewerURL } from "RouteBuilder";
|
|
|
|
|
import { trimQueryString } from "utils/helpers";
|
2022-12-23 04:31:46 +00:00
|
|
|
import { getAppsmithConfigs } from "@appsmith/configs";
|
2023-03-23 11:41:58 +00:00
|
|
|
import type { NavigationSetting } from "constants/AppConstants";
|
|
|
|
|
import { NAVIGATION_SETTINGS } from "constants/AppConstants";
|
|
|
|
|
import { get } from "lodash";
|
|
|
|
|
import { PageMenuContainer, StyledNavLink } from "./PageMenu.styled";
|
|
|
|
|
import { StyledCtaContainer } from "./Navigation/Sidebar.styled";
|
|
|
|
|
import ShareButton from "./Navigation/components/ShareButton";
|
2022-12-23 04:31:46 +00:00
|
|
|
|
2023-03-23 11:41:58 +00:00
|
|
|
type NavigationProps = {
|
2022-05-04 09:45:57 +00:00
|
|
|
isOpen?: boolean;
|
|
|
|
|
application?: ApplicationPayload;
|
2022-06-21 13:57:34 +00:00
|
|
|
pages: Page[];
|
2022-05-04 09:45:57 +00:00
|
|
|
url?: string;
|
|
|
|
|
setMenuOpen?: (shouldOpen: boolean) => void;
|
|
|
|
|
headerRef?: React.RefObject<HTMLDivElement>;
|
|
|
|
|
};
|
|
|
|
|
|
2023-03-23 11:41:58 +00:00
|
|
|
export function PageMenu(props: NavigationProps) {
|
2022-05-04 09:45:57 +00:00
|
|
|
const { application, headerRef, isOpen, pages, setMenuOpen } = props;
|
|
|
|
|
const menuRef = useRef<any>();
|
|
|
|
|
const selectedTheme = useSelector(getSelectedAppTheme);
|
2022-06-15 15:37:41 +00:00
|
|
|
const workspaceID = useSelector(getCurrentWorkspaceId);
|
2022-05-04 09:45:57 +00:00
|
|
|
const headerHeight = useSelector(getAppViewHeaderHeight);
|
|
|
|
|
const [query, setQuery] = useState("");
|
2022-07-28 08:38:37 +00:00
|
|
|
const { hideWatermark } = getAppsmithConfigs();
|
2023-03-23 11:41:58 +00:00
|
|
|
const navColorStyle =
|
|
|
|
|
application?.applicationDetail?.navigationSetting?.colorStyle ||
|
|
|
|
|
NAVIGATION_SETTINGS.COLOR_STYLE.LIGHT;
|
|
|
|
|
const primaryColor = get(
|
|
|
|
|
selectedTheme,
|
|
|
|
|
"properties.colors.primaryColor",
|
|
|
|
|
"inherit",
|
|
|
|
|
);
|
|
|
|
|
|
|
|
|
|
const closeMenu = () => {
|
|
|
|
|
if (typeof setMenuOpen === "function") {
|
|
|
|
|
setMenuOpen?.(false);
|
|
|
|
|
}
|
|
|
|
|
};
|
2022-05-04 09:45:57 +00:00
|
|
|
|
|
|
|
|
// hide menu on click outside
|
|
|
|
|
useOnClickOutside(
|
|
|
|
|
[menuRef, headerRef as React.RefObject<HTMLDivElement>],
|
|
|
|
|
() => {
|
2023-03-23 11:41:58 +00:00
|
|
|
closeMenu();
|
2022-05-04 09:45:57 +00:00
|
|
|
},
|
|
|
|
|
);
|
|
|
|
|
|
|
|
|
|
useEffect(() => {
|
|
|
|
|
setQuery(window.location.search);
|
|
|
|
|
}, [location.search]);
|
|
|
|
|
|
|
|
|
|
// Mark default page as first page
|
|
|
|
|
const appPages = pages;
|
|
|
|
|
if (appPages.length > 1) {
|
|
|
|
|
appPages.forEach((item, i) => {
|
|
|
|
|
if (item.isDefault) {
|
|
|
|
|
appPages.splice(i, 1);
|
|
|
|
|
appPages.unshift(item);
|
|
|
|
|
}
|
|
|
|
|
});
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
return (
|
|
|
|
|
<>
|
|
|
|
|
{/* BG OVERLAY */}
|
|
|
|
|
<div
|
|
|
|
|
className={classNames({
|
2022-06-21 13:57:34 +00:00
|
|
|
"fixed h-full w-full bg-black/30 transform transition-all": true,
|
2022-05-04 09:45:57 +00:00
|
|
|
"opacity-0 hidden": !isOpen,
|
|
|
|
|
"opacity-100": isOpen,
|
|
|
|
|
})}
|
2023-03-23 11:41:58 +00:00
|
|
|
onClick={closeMenu}
|
2022-05-04 09:45:57 +00:00
|
|
|
style={{
|
|
|
|
|
height: `calc(100% - ${headerHeight})`,
|
|
|
|
|
}}
|
|
|
|
|
/>
|
|
|
|
|
{/* MAIN CONTAINER */}
|
2023-03-23 11:41:58 +00:00
|
|
|
<PageMenuContainer
|
2022-05-04 09:45:57 +00:00
|
|
|
className={classNames({
|
2023-03-23 11:41:58 +00:00
|
|
|
"fixed flex flex-col w-7/12 transform transition-all duration-400":
|
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
|
|
|
true,
|
2022-05-04 09:45:57 +00:00
|
|
|
"-left-full": !isOpen,
|
|
|
|
|
"left-0": isOpen,
|
|
|
|
|
})}
|
2023-03-23 11:41:58 +00:00
|
|
|
navColorStyle={navColorStyle}
|
|
|
|
|
primaryColor={primaryColor}
|
2022-07-28 08:38:37 +00:00
|
|
|
ref={menuRef}
|
2022-05-04 09:45:57 +00:00
|
|
|
style={{
|
|
|
|
|
height: `calc(100% - ${headerHeight}px)`,
|
|
|
|
|
}}
|
|
|
|
|
>
|
2023-03-23 11:41:58 +00:00
|
|
|
<div className="flex-grow py-3 overflow-y-auto page-list-container">
|
2022-05-04 09:45:57 +00:00
|
|
|
{appPages.map((page) => (
|
2023-03-23 11:41:58 +00:00
|
|
|
<PageNavLink
|
|
|
|
|
closeMenu={closeMenu}
|
|
|
|
|
key={page.pageId}
|
|
|
|
|
navColorStyle={navColorStyle}
|
|
|
|
|
page={page}
|
|
|
|
|
primaryColor={primaryColor}
|
|
|
|
|
query={query}
|
|
|
|
|
/>
|
2022-05-04 09:45:57 +00:00
|
|
|
))}
|
|
|
|
|
</div>
|
2023-03-23 11:41:58 +00:00
|
|
|
<div className="py-3 border-t">
|
2022-05-04 09:45:57 +00:00
|
|
|
{application && (
|
2023-03-23 11:41:58 +00:00
|
|
|
<StyledCtaContainer>
|
|
|
|
|
<ShareButton
|
|
|
|
|
currentApplicationDetails={application}
|
|
|
|
|
currentWorkspaceId={workspaceID}
|
|
|
|
|
insideSidebar
|
|
|
|
|
/>
|
|
|
|
|
|
|
|
|
|
{isOpen && (
|
|
|
|
|
<PrimaryCTA
|
|
|
|
|
className="t--back-to-editor--mobile"
|
|
|
|
|
insideSidebar
|
|
|
|
|
navColorStyle={navColorStyle}
|
|
|
|
|
primaryColor={primaryColor}
|
|
|
|
|
url={props.url}
|
2022-05-04 09:45:57 +00:00
|
|
|
/>
|
2023-03-23 11:41:58 +00:00
|
|
|
)}
|
|
|
|
|
|
|
|
|
|
{!hideWatermark && (
|
|
|
|
|
<a
|
|
|
|
|
className="flex hover:no-underline mt-2"
|
|
|
|
|
href="https://appsmith.com"
|
|
|
|
|
rel="noreferrer"
|
|
|
|
|
target="_blank"
|
|
|
|
|
>
|
|
|
|
|
<BrandingBadge />
|
|
|
|
|
</a>
|
|
|
|
|
)}
|
|
|
|
|
</StyledCtaContainer>
|
2022-07-28 08:38:37 +00:00
|
|
|
)}
|
2022-05-04 09:45:57 +00:00
|
|
|
</div>
|
2023-03-23 11:41:58 +00:00
|
|
|
</PageMenuContainer>
|
2022-05-04 09:45:57 +00:00
|
|
|
</>
|
|
|
|
|
);
|
|
|
|
|
}
|
|
|
|
|
|
2023-03-23 11:41:58 +00:00
|
|
|
function PageNavLink({
|
|
|
|
|
closeMenu,
|
|
|
|
|
navColorStyle,
|
|
|
|
|
page,
|
|
|
|
|
primaryColor,
|
|
|
|
|
query,
|
|
|
|
|
}: {
|
|
|
|
|
page: Page;
|
|
|
|
|
query: string;
|
|
|
|
|
closeMenu: () => void;
|
|
|
|
|
primaryColor: string;
|
|
|
|
|
navColorStyle: NavigationSetting["colorStyle"];
|
|
|
|
|
}) {
|
2022-07-11 04:06:29 +00:00
|
|
|
const appMode = useSelector(getAppMode);
|
|
|
|
|
const selectedTheme = useSelector(getSelectedAppTheme);
|
|
|
|
|
const pathname = useHref(
|
|
|
|
|
appMode === APP_MODE.PUBLISHED ? viewerURL : builderURL,
|
|
|
|
|
{ pageId: page.pageId },
|
|
|
|
|
);
|
|
|
|
|
|
|
|
|
|
return (
|
2023-03-23 11:41:58 +00:00
|
|
|
<StyledNavLink
|
2022-07-11 04:06:29 +00:00
|
|
|
activeClassName="border-r-3 font-semibold"
|
|
|
|
|
activeStyle={{
|
|
|
|
|
borderColor: selectedTheme.properties.colors.primaryColor,
|
|
|
|
|
}}
|
2023-03-23 11:41:58 +00:00
|
|
|
className="flex flex-col px-4 py-2 no-underline border-transparent border-r-3 hover:no-underline"
|
2022-07-11 04:06:29 +00:00
|
|
|
key={page.pageId}
|
2023-03-23 11:41:58 +00:00
|
|
|
navColorStyle={navColorStyle}
|
|
|
|
|
onClick={closeMenu}
|
|
|
|
|
primaryColor={primaryColor}
|
2022-07-11 04:06:29 +00:00
|
|
|
to={{
|
|
|
|
|
pathname: trimQueryString(pathname),
|
|
|
|
|
search: query,
|
|
|
|
|
}}
|
|
|
|
|
>
|
|
|
|
|
{page.pageName}
|
2023-03-23 11:41:58 +00:00
|
|
|
</StyledNavLink>
|
2022-07-11 04:06:29 +00:00
|
|
|
);
|
|
|
|
|
}
|
|
|
|
|
|
2022-05-04 09:45:57 +00:00
|
|
|
export default PageMenu;
|