PromucFlow_constructor/app/client/src/pages/AppViewer/index.tsx
Hetu Nandu 04a6314602
perf: Optimise App loading apis (#24365)
## Description
Start downloading app data earlier to improve load times. 


#### PR fixes following issue(s)
Fixes #24618

#### Type of change

- Bug fix (non-breaking change which fixes an issue)

## Testing
>
#### How Has This Been Tested?

- [ ] Cypress

#### Test Plan
- [x] Loading apps in view/edit mode from home page and having them work
perfectly
- [x] Opening apps in view/edit mode directly via links and having them
work perfectly
- [x] Having apps with on page load actions
- [x] Test with complex widgets and see if they work properly

>
>
#### Issues raised during DP testing

https://github.com/appsmithorg/appsmith/pull/24365#issuecomment-1624013687
>
>
>
## Checklist:
#### Dev activity
- [ ] 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
- [ ] 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:
- [ ] [Speedbreak
features](https://github.com/appsmithorg/TestSmith/wiki/Test-plan-implementation#speedbreaker-features-to-consider-for-every-change)
have been covered
- [ ] Test plan covers all impacted features and [areas of
interest](https://github.com/appsmithorg/TestSmith/wiki/Guidelines-for-test-plans/_edit#areas-of-interest)
- [ ] Test plan has been peer reviewed by project stakeholders and other
QA members
- [ ] Manually tested functionality on DP
- [ ] We had an implementation alignment call with stakeholders post QA
Round 2
- [ ] Cypress test cases have been added and approved by SDET/manual QA
- [ ] Added `Test Plan Approved` label after Cypress tests were reviewed
- [ ] Added `Test Plan Approved` label after JUnit tests were reviewed

---------

Co-authored-by: akash-codemonk <67054171+akash-codemonk@users.noreply.github.com>
2023-07-10 11:21:40 +05:30

201 lines
6.8 KiB
TypeScript

import React, { useEffect } from "react";
import styled, { ThemeProvider } from "styled-components";
import { useDispatch } from "react-redux";
import type { RouteComponentProps } from "react-router";
import { withRouter } from "react-router";
import type { AppState } from "@appsmith/reducers";
import type {
AppViewerRouteParams,
BuilderRouteParams,
} from "constants/routes";
import { GIT_BRANCH_QUERY_KEY } from "constants/routes";
import {
getIsInitialized,
getAppViewHeaderHeight,
} from "selectors/appViewSelectors";
import EditorContextProvider from "components/editorComponents/EditorContextProvider";
import AppViewerPageContainer from "./AppViewerPageContainer";
import * as Sentry from "@sentry/react";
import {
getCurrentPageDescription,
getViewModePageList,
} from "selectors/editorSelectors";
import { getThemeDetails, ThemeMode } from "selectors/themeSelectors";
import { getSearchQuery } from "utils/helpers";
import { getSelectedAppTheme } from "selectors/appThemingSelectors";
import { useSelector } from "react-redux";
import BrandingBadge from "./BrandingBadge";
import { setAppViewHeaderHeight } from "actions/appViewActions";
import { showPostCompletionMessage } from "selectors/onboardingSelectors";
import { CANVAS_SELECTOR } from "constants/WidgetConstants";
import { fetchPublishedPage } from "actions/pageActions";
import usePrevious from "utils/hooks/usePrevious";
import { getIsBranchUpdated } from "../utils";
import { APP_MODE } from "entities/App";
import { initAppViewer } from "actions/initActions";
import { WidgetGlobaStyles } from "globalStyles/WidgetGlobalStyles";
import { getAppsmithConfigs } from "@appsmith/configs";
import useWidgetFocus from "utils/hooks/useWidgetFocus/useWidgetFocus";
import HtmlTitle from "./AppViewerHtmlTitle";
import type { ApplicationPayload } from "@appsmith/constants/ReduxActionConstants";
import { getCurrentApplication } from "@appsmith/selectors/applicationSelectors";
import { editorInitializer } from "../../utils/editor/EditorUtils";
import { widgetInitialisationSuccess } from "../../actions/widgetActions";
const AppViewerBody = styled.section<{
hasPages: boolean;
headerHeight: number;
showGuidedTourMessage: boolean;
}>`
display: flex;
flex-direction: row;
align-items: stretch;
justify-content: flex-start;
height: calc(100vh - ${({ headerHeight }) => headerHeight}px);
--view-mode-header-height: ${({ headerHeight }) => headerHeight}px;
`;
const AppViewerBodyContainer = styled.div<{
width?: string;
backgroundColor: string;
}>`
flex: 1;
overflow: auto;
margin: 0 auto;
background: ${({ backgroundColor }) => backgroundColor};
`;
export type AppViewerProps = RouteComponentProps<BuilderRouteParams>;
type Props = AppViewerProps & RouteComponentProps<AppViewerRouteParams>;
const DEFAULT_FONT_NAME = "System Default";
function AppViewer(props: Props) {
const dispatch = useDispatch();
const { pathname, search } = props.location;
const { applicationId, pageId } = props.match.params;
const isInitialized = useSelector(getIsInitialized);
const pages = useSelector(getViewModePageList);
const selectedTheme = useSelector(getSelectedAppTheme);
const lightTheme = useSelector((state: AppState) =>
getThemeDetails(state, ThemeMode.LIGHT),
);
const showGuidedTourMessage = useSelector(showPostCompletionMessage);
const headerHeight = useSelector(getAppViewHeaderHeight);
const branch = getSearchQuery(search, GIT_BRANCH_QUERY_KEY);
const prevValues = usePrevious({ branch, location: props.location, pageId });
const { hideWatermark } = getAppsmithConfigs();
const pageDescription = useSelector(getCurrentPageDescription);
const currentApplicationDetails: ApplicationPayload | undefined = useSelector(
getCurrentApplication,
);
const focusRef = useWidgetFocus();
useEffect(() => {
editorInitializer().then(() => {
dispatch(widgetInitialisationSuccess());
});
});
/**
* initialize the app if branch, pageId or application is changed
*/
useEffect(() => {
const prevBranch = prevValues?.branch;
const prevLocation = prevValues?.location;
const prevPageId = prevValues?.pageId;
let isBranchUpdated = false;
if (prevBranch && prevLocation) {
isBranchUpdated = getIsBranchUpdated(props.location, prevLocation);
}
const isPageIdUpdated = pageId !== prevPageId;
if (prevBranch && isBranchUpdated && (applicationId || pageId)) {
dispatch(
initAppViewer({
applicationId,
branch,
pageId,
mode: APP_MODE.PUBLISHED,
}),
);
} else {
/**
* First time load is handled by init sagas
* If we don't check for `prevPageId`: fetch page is retriggered
* when redirected to the default page
*/
if (prevPageId && pageId && isPageIdUpdated) {
dispatch(fetchPublishedPage(pageId, true));
}
}
}, [branch, pageId, applicationId, pathname]);
useEffect(() => {
const header = document.querySelector(".js-appviewer-header");
dispatch(setAppViewHeaderHeight(header?.clientHeight || 0));
}, [pages.length, isInitialized]);
/**
* returns the font to be used for the canvas
*/
const appFontFamily =
selectedTheme.properties.fontFamily.appFont === DEFAULT_FONT_NAME
? "inherit"
: selectedTheme.properties.fontFamily.appFont;
/**
* loads font for canvas based on theme
*/
useEffect(() => {
document.body.style.fontFamily = `${appFontFamily}, sans-serif`;
return function reset() {
document.body.style.fontFamily = "inherit";
};
}, [selectedTheme.properties.fontFamily.appFont]);
return (
<ThemeProvider theme={lightTheme}>
<EditorContextProvider renderMode="PAGE">
<WidgetGlobaStyles
fontFamily={selectedTheme.properties.fontFamily.appFont}
primaryColor={selectedTheme.properties.colors.primaryColor}
/>
<HtmlTitle
description={pageDescription}
name={currentApplicationDetails?.name}
/>
<AppViewerBodyContainer
backgroundColor={selectedTheme.properties.colors.backgroundColor}
>
<AppViewerBody
className={CANVAS_SELECTOR}
hasPages={pages.length > 1}
headerHeight={headerHeight}
ref={focusRef}
showGuidedTourMessage={showGuidedTourMessage}
>
{isInitialized && <AppViewerPageContainer />}
</AppViewerBody>
{!hideWatermark && (
<a
className="fixed hidden right-8 bottom-4 z-3 hover:no-underline md:flex"
href="https://appsmith.com"
rel="noreferrer"
target="_blank"
>
<BrandingBadge />
</a>
)}
</AppViewerBodyContainer>
</EditorContextProvider>
</ThemeProvider>
);
}
export default withRouter(Sentry.withProfiler(AppViewer));