2022-06-06 03:56:14 +00:00
|
|
|
import React, { useMemo } 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 { RouteComponentProps } from "react-router-dom";
|
|
|
|
|
import { Link, withRouter } from "react-router-dom";
|
2022-06-06 03:56:14 +00:00
|
|
|
import { useSelector } from "react-redux";
|
2020-02-26 12:44:56 +00:00
|
|
|
import { getIsFetchingPage } from "selectors/appViewSelectors";
|
2020-01-16 11:46:21 +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 { AppViewerRouteParams } from "constants/routes";
|
2019-11-22 14:02:55 +00:00
|
|
|
import { theme } from "constants/DefaultTheme";
|
2021-08-31 07:57:22 +00:00
|
|
|
import { Icon, NonIdealState, Spinner } from "@blueprintjs/core";
|
2019-11-22 14:02:55 +00:00
|
|
|
import Centered from "components/designSystems/appsmith/CenteredWrapper";
|
|
|
|
|
import AppPage from "./AppPage";
|
2022-08-19 10:10:36 +00:00
|
|
|
import { getCanvasWidth, getCurrentPageName } from "selectors/editorSelectors";
|
2022-02-18 06:58:36 +00:00
|
|
|
import RequestConfirmationModal from "pages/Editor/RequestConfirmationModal";
|
2023-03-29 17:07:06 +00:00
|
|
|
import { getCurrentApplication } from "@appsmith/selectors/applicationSelectors";
|
2020-10-22 12:08:51 +00:00
|
|
|
import {
|
|
|
|
|
isPermitted,
|
|
|
|
|
PERMISSION_TYPE,
|
2022-10-20 06:03:33 +00:00
|
|
|
} from "@appsmith/utils/permissionHelpers";
|
2022-03-25 10:43:26 +00:00
|
|
|
import { builderURL } from "RouteBuilder";
|
2022-08-19 10:10:36 +00:00
|
|
|
import { getCanvasWidgetsStructure } from "selectors/entitiesSelector";
|
2022-09-02 09:16:30 +00:00
|
|
|
import equal from "fast-deep-equal/es6";
|
2019-11-22 14:02:55 +00:00
|
|
|
|
2022-08-09 17:10:10 +00:00
|
|
|
const Section = styled.section`
|
2022-05-04 09:45:57 +00:00
|
|
|
height: 100%;
|
2022-08-09 17:10:10 +00:00
|
|
|
width: 100%;
|
2021-06-17 07:37:27 +00:00
|
|
|
margin: 0 auto;
|
2020-01-16 11:46:21 +00:00
|
|
|
position: relative;
|
|
|
|
|
overflow-x: auto;
|
|
|
|
|
overflow-y: auto;
|
|
|
|
|
`;
|
2019-11-22 14:02:55 +00:00
|
|
|
|
2022-05-04 09:45:57 +00:00
|
|
|
type AppViewerPageContainerProps = RouteComponentProps<AppViewerRouteParams>;
|
|
|
|
|
|
|
|
|
|
function AppViewerPageContainer(props: AppViewerPageContainerProps) {
|
|
|
|
|
const currentPageName = useSelector(getCurrentPageName);
|
2022-09-02 09:16:30 +00:00
|
|
|
const widgetsStructure = useSelector(getCanvasWidgetsStructure, equal);
|
2022-08-19 10:10:36 +00:00
|
|
|
const canvasWidth = useSelector(getCanvasWidth);
|
2022-05-04 09:45:57 +00:00
|
|
|
const isFetchingPage = useSelector(getIsFetchingPage);
|
|
|
|
|
const currentApplication = useSelector(getCurrentApplication);
|
|
|
|
|
const { match } = props;
|
|
|
|
|
|
|
|
|
|
// get appsmith editr link
|
|
|
|
|
const appsmithEditorLink = useMemo(() => {
|
2020-10-22 12:08:51 +00:00
|
|
|
if (
|
2022-05-04 09:45:57 +00:00
|
|
|
currentApplication?.userPermissions &&
|
2020-10-22 12:08:51 +00:00
|
|
|
isPermitted(
|
2022-05-04 09:45:57 +00:00
|
|
|
currentApplication?.userPermissions,
|
2020-10-22 12:08:51 +00:00
|
|
|
PERMISSION_TYPE.MANAGE_APPLICATION,
|
|
|
|
|
)
|
|
|
|
|
) {
|
2022-05-04 09:45:57 +00:00
|
|
|
return (
|
2020-10-22 12:08:51 +00:00
|
|
|
<p>
|
|
|
|
|
Please add widgets to this page in the
|
|
|
|
|
<Link
|
2022-03-25 10:43:26 +00:00
|
|
|
to={builderURL({
|
2022-05-04 09:45:57 +00:00
|
|
|
pageId: props.match.params.pageId as string,
|
2021-10-18 14:03:44 +00:00
|
|
|
})}
|
2020-10-22 12:08:51 +00:00
|
|
|
>
|
|
|
|
|
Appsmith Editor
|
|
|
|
|
</Link>
|
|
|
|
|
</p>
|
|
|
|
|
);
|
|
|
|
|
}
|
2022-05-04 09:45:57 +00:00
|
|
|
}, [currentApplication?.userPermissions]);
|
|
|
|
|
|
|
|
|
|
const pageNotFound = (
|
|
|
|
|
<Centered>
|
|
|
|
|
<NonIdealState
|
|
|
|
|
description={appsmithEditorLink}
|
|
|
|
|
icon={
|
|
|
|
|
<Icon
|
|
|
|
|
color={theme.colors.primaryOld}
|
|
|
|
|
icon="page-layout"
|
|
|
|
|
iconSize={theme.fontSizes[9]}
|
2020-03-11 13:59:46 +00:00
|
|
|
/>
|
2022-05-04 09:45:57 +00:00
|
|
|
}
|
|
|
|
|
title="This page seems to be blank"
|
|
|
|
|
/>
|
|
|
|
|
</Centered>
|
|
|
|
|
);
|
2019-11-22 14:02:55 +00:00
|
|
|
|
2022-05-04 09:45:57 +00:00
|
|
|
const pageLoading = (
|
|
|
|
|
<Centered>
|
|
|
|
|
<Spinner />
|
|
|
|
|
</Centered>
|
|
|
|
|
);
|
2019-11-22 14:02:55 +00:00
|
|
|
|
2022-05-04 09:45:57 +00:00
|
|
|
if (isFetchingPage) return pageLoading;
|
|
|
|
|
|
2022-08-19 10:10:36 +00:00
|
|
|
if (!(widgetsStructure.children && widgetsStructure.children.length > 0))
|
|
|
|
|
return pageNotFound;
|
2022-05-04 09:45:57 +00:00
|
|
|
|
|
|
|
|
return (
|
2022-08-09 17:10:10 +00:00
|
|
|
<Section>
|
2022-05-04 09:45:57 +00:00
|
|
|
<AppPage
|
|
|
|
|
appName={currentApplication?.name}
|
2022-08-19 10:10:36 +00:00
|
|
|
canvasWidth={canvasWidth}
|
2022-05-04 09:45:57 +00:00
|
|
|
pageId={match.params.pageId}
|
|
|
|
|
pageName={currentPageName}
|
2022-08-19 10:10:36 +00:00
|
|
|
widgetsStructure={widgetsStructure}
|
2022-05-04 09:45:57 +00:00
|
|
|
/>
|
|
|
|
|
<RequestConfirmationModal />
|
|
|
|
|
</Section>
|
|
|
|
|
);
|
|
|
|
|
}
|
2019-11-22 14:02:55 +00:00
|
|
|
|
2022-05-04 09:45:57 +00:00
|
|
|
export default withRouter(AppViewerPageContainer);
|