2020-12-17 07:03:59 +00:00
|
|
|
import React from "react";
|
|
|
|
|
import { Link, useLocation } from "react-router-dom";
|
2022-12-09 14:43:47 +00:00
|
|
|
import { connect, useSelector } from "react-redux";
|
2020-12-17 07:03:59 +00:00
|
|
|
import { getCurrentUser } from "selectors/usersSelectors";
|
|
|
|
|
import styled from "styled-components";
|
|
|
|
|
import StyledHeader from "components/designSystems/appsmith/StyledHeader";
|
2024-08-06 14:52:22 +00:00
|
|
|
import type { AppState } from "ee/reducers";
|
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 { User } from "constants/userConstants";
|
|
|
|
|
import { ANONYMOUS_USERNAME } from "constants/userConstants";
|
2020-12-17 07:03:59 +00:00
|
|
|
import { AUTH_LOGIN_URL, APPLICATIONS_URL } from "constants/routes";
|
|
|
|
|
import Button from "components/editorComponents/Button";
|
|
|
|
|
import ProfileDropdown from "./ProfileDropdown";
|
|
|
|
|
import { flushErrorsAndRedirect, flushErrors } from "actions/errorActions";
|
|
|
|
|
import { getSafeCrash } from "selectors/errorSelectors";
|
2022-12-09 14:43:47 +00:00
|
|
|
import { Indices } from "constants/Layers";
|
2024-08-06 14:52:22 +00:00
|
|
|
import { getTenantConfig } from "ee/selectors/tenantSelectors";
|
2023-03-23 11:41:58 +00:00
|
|
|
import { getSelectedAppTheme } from "selectors/appThemingSelectors";
|
|
|
|
|
import { NAVIGATION_SETTINGS } from "constants/AppConstants";
|
|
|
|
|
import { get } from "lodash";
|
2024-08-06 14:52:22 +00:00
|
|
|
import { getAssetUrl } from "ee/utils/airgapHelpers";
|
|
|
|
|
import { getCurrentApplication } from "ee/selectors/applicationSelectors";
|
2020-12-17 07:03:59 +00:00
|
|
|
|
|
|
|
|
const StyledPageHeader = styled(StyledHeader)`
|
2022-12-09 14:43:47 +00:00
|
|
|
box-shadow: none;
|
|
|
|
|
justify-content: normal;
|
|
|
|
|
background: white;
|
2020-12-17 07:03:59 +00:00
|
|
|
height: 48px;
|
|
|
|
|
color: white;
|
|
|
|
|
position: fixed;
|
|
|
|
|
top: 0;
|
2022-12-09 14:43:47 +00:00
|
|
|
z-index: ${Indices.Layer9};
|
2023-05-19 18:37:06 +00:00
|
|
|
border-bottom: 1px solid var(--ads-v2-color-border);
|
2020-12-17 07:03:59 +00:00
|
|
|
`;
|
|
|
|
|
|
|
|
|
|
const HeaderSection = styled.div`
|
|
|
|
|
display: flex;
|
|
|
|
|
flex: 1;
|
|
|
|
|
align-items: center;
|
|
|
|
|
`;
|
|
|
|
|
|
|
|
|
|
const StyledDropDownContainer = styled.div``;
|
|
|
|
|
|
2023-10-11 07:35:24 +00:00
|
|
|
interface ErrorPageHeaderProps {
|
2020-12-17 07:03:59 +00:00
|
|
|
user?: User;
|
2024-07-31 15:41:28 +00:00
|
|
|
// TODO: Fix this the next time the file is edited
|
|
|
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
2020-12-17 07:03:59 +00:00
|
|
|
flushErrors?: any;
|
2024-07-31 15:41:28 +00:00
|
|
|
// TODO: Fix this the next time the file is edited
|
|
|
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
2020-12-17 07:03:59 +00:00
|
|
|
flushErrorsAndRedirect?: any;
|
|
|
|
|
safeCrash: boolean;
|
2023-10-11 07:35:24 +00:00
|
|
|
}
|
2020-12-17 07:03:59 +00:00
|
|
|
|
2021-04-28 10:28:39 +00:00
|
|
|
export function ErrorPageHeader(props: ErrorPageHeaderProps) {
|
2021-05-13 08:35:39 +00:00
|
|
|
const { flushErrors, flushErrorsAndRedirect, safeCrash, user } = props;
|
2020-12-17 07:03:59 +00:00
|
|
|
const location = useLocation();
|
2022-12-09 14:43:47 +00:00
|
|
|
const tenantConfig = useSelector(getTenantConfig);
|
2020-12-17 07:03:59 +00:00
|
|
|
const queryParams = new URLSearchParams(location.search);
|
|
|
|
|
let loginUrl = AUTH_LOGIN_URL;
|
2021-05-18 05:52:54 +00:00
|
|
|
const redirectUrl = queryParams.get("redirectUrl");
|
|
|
|
|
if (redirectUrl != null) {
|
|
|
|
|
loginUrl += `?redirectUrl=${encodeURIComponent(redirectUrl)}`;
|
2020-12-17 07:03:59 +00:00
|
|
|
}
|
2023-03-23 11:41:58 +00:00
|
|
|
const selectedTheme = useSelector(getSelectedAppTheme);
|
|
|
|
|
const currentApplicationDetails = useSelector(getCurrentApplication);
|
|
|
|
|
const navColorStyle =
|
|
|
|
|
currentApplicationDetails?.applicationDetail?.navigationSetting
|
|
|
|
|
?.colorStyle || NAVIGATION_SETTINGS.COLOR_STYLE.LIGHT;
|
|
|
|
|
const primaryColor = get(
|
|
|
|
|
selectedTheme,
|
|
|
|
|
"properties.colors.primaryColor",
|
|
|
|
|
"inherit",
|
|
|
|
|
);
|
2020-12-17 07:03:59 +00:00
|
|
|
|
|
|
|
|
return (
|
|
|
|
|
<StyledPageHeader>
|
|
|
|
|
<HeaderSection>
|
2022-12-09 14:43:47 +00:00
|
|
|
{tenantConfig.brandLogoUrl && (
|
|
|
|
|
<Link
|
|
|
|
|
className="t--appsmith-logo"
|
|
|
|
|
onClick={() => {
|
|
|
|
|
if (safeCrash) flushErrors();
|
|
|
|
|
}}
|
|
|
|
|
to={APPLICATIONS_URL}
|
|
|
|
|
>
|
2023-04-10 07:02:31 +00:00
|
|
|
<img
|
|
|
|
|
alt="Logo"
|
|
|
|
|
className="h-6"
|
|
|
|
|
src={getAssetUrl(tenantConfig.brandLogoUrl)}
|
|
|
|
|
/>
|
2022-12-09 14:43:47 +00:00
|
|
|
</Link>
|
|
|
|
|
)}
|
2020-12-17 07:03:59 +00:00
|
|
|
</HeaderSection>
|
|
|
|
|
{user && (
|
|
|
|
|
<StyledDropDownContainer>
|
|
|
|
|
{user.username === ANONYMOUS_USERNAME ? (
|
|
|
|
|
<Button
|
|
|
|
|
filled
|
|
|
|
|
intent={"primary"}
|
|
|
|
|
onClick={() => {
|
|
|
|
|
flushErrorsAndRedirect(loginUrl);
|
|
|
|
|
}}
|
2021-04-28 10:28:39 +00:00
|
|
|
size="small"
|
|
|
|
|
text="Sign In"
|
2020-12-17 07:03:59 +00:00
|
|
|
/>
|
|
|
|
|
) : (
|
2021-12-02 05:56:41 +00:00
|
|
|
<ProfileDropdown
|
|
|
|
|
name={user.name}
|
2023-03-23 11:41:58 +00:00
|
|
|
navColorStyle={navColorStyle}
|
2021-12-02 05:56:41 +00:00
|
|
|
photoId={user?.photoId}
|
2023-03-23 11:41:58 +00:00
|
|
|
primaryColor={primaryColor}
|
2021-12-02 05:56:41 +00:00
|
|
|
userName={user.username}
|
|
|
|
|
/>
|
2020-12-17 07:03:59 +00:00
|
|
|
)}
|
|
|
|
|
</StyledDropDownContainer>
|
|
|
|
|
)}
|
|
|
|
|
</StyledPageHeader>
|
|
|
|
|
);
|
2021-04-28 10:28:39 +00:00
|
|
|
}
|
2020-12-17 07:03:59 +00:00
|
|
|
|
|
|
|
|
const mapStateToProps = (state: AppState) => ({
|
|
|
|
|
user: getCurrentUser(state),
|
|
|
|
|
safeCrash: getSafeCrash(state),
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
export default connect(mapStateToProps, {
|
|
|
|
|
flushErrors,
|
|
|
|
|
flushErrorsAndRedirect,
|
|
|
|
|
})(ErrorPageHeader);
|