PromucFlow_constructor/app/client/src/ce/AppRouter.tsx
Nilansh Bansal b3f1805e36
feat: Flagsmith Integration (#24472)
## Description
> This PR integrates Flagsmith feature flagging into the Appsmith
codebase
> It also sets some default traits such as instance_id, tenant_id and
email/hashed email to the new and existing users

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


#### Type of change
- New feature (non-breaking change which adds functionality)
- Breaking change (fix or feature that would cause existing
functionality to not work as expected)

## Testing
>
#### How Has This Been Tested?
> Please describe the tests that you ran to verify your changes. Also
list any relevant details for your test configuration.
> Delete anything that is not relevant
- [ ] Manual
- [ ] Jest
- [ ] Cypress
>
>
#### 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
- [x] I have performed a self-review of my own code
- [x] 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
- [x] I have added tests that prove my fix is effective or that my
feature works
- [x] 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/Guidelines-for-test-plans#speedbreakers-)
have been covered
- [ ] Test plan covers all impacted features and [areas of
interest](https://github.com/appsmithorg/TestSmith/wiki/Guidelines-for-test-plans#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: Hetu Nandu <hetunandu@gmail.com>
2023-06-27 16:15:33 +05:30

196 lines
6.5 KiB
TypeScript

import React, { Suspense, useEffect } from "react";
import history from "utils/history";
import AppHeader from "pages/common/AppHeader";
import { Redirect, Route, Router, Switch } from "react-router-dom";
import {
ADMIN_SETTINGS_CATEGORY_PATH,
ADMIN_SETTINGS_PATH,
APPLICATIONS_URL,
AUTH_LOGIN_URL,
BASE_LOGIN_URL,
BASE_SIGNUP_URL,
BASE_URL,
BUILDER_CUSTOM_PATH,
BUILDER_PATCH_PATH,
BUILDER_PATH,
BUILDER_PATH_DEPRECATED,
PROFILE,
SETUP,
SIGNUP_SUCCESS_URL,
SIGN_UP_URL,
TEMPLATES_PATH,
USERS_URL,
USER_AUTH_URL,
VIEWER_CUSTOM_PATH,
VIEWER_PATCH_PATH,
VIEWER_PATH,
VIEWER_PATH_DEPRECATED,
WORKSPACE_URL,
} from "constants/routes";
import WorkspaceLoader from "pages/workspace/loader";
import ApplicationListLoader from "pages/Applications/loader";
import EditorLoader from "pages/Editor/loader";
import AppViewerLoader from "pages/AppViewer/loader";
import LandingScreen from "../LandingScreen";
import UserAuth from "pages/UserAuth";
import Users from "pages/users";
import ErrorPage from "pages/common/ErrorPage";
import PageNotFound from "pages/common/ErrorPages/PageNotFound";
import PageLoadingBar from "pages/common/PageLoadingBar";
import ErrorPageHeader from "pages/common/ErrorPageHeader";
import type { AppState } from "@appsmith/reducers";
import { connect, useSelector } from "react-redux";
import * as Sentry from "@sentry/react";
import { getSafeCrash, getSafeCrashCode } from "selectors/errorSelectors";
import UserProfile from "pages/UserProfile";
import { getCurrentUser } from "actions/authActions";
import { getCurrentUserLoading } from "selectors/usersSelectors";
import Setup from "pages/setup";
import Settings from "@appsmith/pages/AdminSettings";
import SignupSuccess from "pages/setup/SignupSuccess";
import type { ERROR_CODES } from "@appsmith/constants/ApiConstants";
import TemplatesListLoader from "pages/Templates/loader";
import { fetchFeatureFlagsInit } from "actions/userActions";
import { getCurrentTenant } from "@appsmith/actions/tenantActions";
import { getDefaultAdminSettingsPath } from "@appsmith/utils/adminSettingsHelpers";
import { getCurrentUser as getCurrentUserSelector } from "selectors/usersSelectors";
import {
getTenantPermissions,
isTenantLoading,
} from "@appsmith/selectors/tenantSelectors";
import useBrandingTheme from "utils/hooks/useBrandingTheme";
import RouteChangeListener from "RouteChangeListener";
export const SentryRoute = Sentry.withSentryRouting(Route);
export const loadingIndicator = <PageLoadingBar />;
export function Routes() {
const user = useSelector(getCurrentUserSelector);
const tenantPermissions = useSelector(getTenantPermissions);
return (
<Switch>
<SentryRoute component={LandingScreen} exact path={BASE_URL} />
<Redirect exact from={BASE_LOGIN_URL} to={AUTH_LOGIN_URL} />
<Redirect exact from={BASE_SIGNUP_URL} to={SIGN_UP_URL} />
<SentryRoute component={WorkspaceLoader} path={WORKSPACE_URL} />
<SentryRoute component={Users} exact path={USERS_URL} />
<SentryRoute component={UserAuth} path={USER_AUTH_URL} />
<SentryRoute
component={ApplicationListLoader}
exact
path={APPLICATIONS_URL}
/>
<SentryRoute component={SignupSuccess} exact path={SIGNUP_SUCCESS_URL} />
<SentryRoute component={UserProfile} path={PROFILE} />
<SentryRoute component={Setup} exact path={SETUP} />
<SentryRoute component={TemplatesListLoader} path={TEMPLATES_PATH} />
<Redirect
exact
from={ADMIN_SETTINGS_PATH}
to={
!user
? ADMIN_SETTINGS_PATH
: getDefaultAdminSettingsPath({
isSuperUser: user?.isSuperUser || false,
tenantPermissions,
})
}
/>
<SentryRoute
component={Settings}
exact
path={ADMIN_SETTINGS_CATEGORY_PATH}
/>
<SentryRoute component={EditorLoader} path={BUILDER_PATH_DEPRECATED} />
<SentryRoute component={AppViewerLoader} path={VIEWER_PATH_DEPRECATED} />
{/*
* Note: When making changes to the order of these paths
* Be sure to check if it is sync with the order of checks in getUpdatedRoute helper method
* Context: https://github.com/appsmithorg/appsmith/pull/19833
*/}
<SentryRoute component={EditorLoader} path={BUILDER_PATH} />
<SentryRoute component={EditorLoader} path={BUILDER_CUSTOM_PATH} />
<SentryRoute component={AppViewerLoader} path={VIEWER_PATH} />
<SentryRoute component={AppViewerLoader} path={VIEWER_CUSTOM_PATH} />
{/*
* End Note: When making changes to the order of the paths above
*/}
<Redirect from={BUILDER_PATCH_PATH} to={BUILDER_PATH} />
<Redirect from={VIEWER_PATCH_PATH} to={VIEWER_PATH} />
<SentryRoute component={PageNotFound} />
</Switch>
);
}
function AppRouter(props: {
safeCrash: boolean;
getCurrentUser: () => void;
getFeatureFlags: () => void;
getCurrentTenant: () => void;
safeCrashCode?: ERROR_CODES;
}) {
const { getCurrentTenant, getCurrentUser, getFeatureFlags } = props;
const tenantIsLoading = useSelector(isTenantLoading);
const currentUserIsLoading = useSelector(getCurrentUserLoading);
useEffect(() => {
getCurrentUser();
getFeatureFlags();
getCurrentTenant();
}, []);
useBrandingTheme();
// hide the top loader once the tenant is loaded
useEffect(() => {
if (tenantIsLoading === false && currentUserIsLoading === false) {
const loader = document.getElementById("loader") as HTMLDivElement;
if (loader) {
loader.style.width = "100vw";
setTimeout(() => {
loader.style.opacity = "0";
});
}
}
}, [tenantIsLoading, currentUserIsLoading]);
if (tenantIsLoading || currentUserIsLoading) return null;
return (
<Router history={history}>
<Suspense fallback={loadingIndicator}>
<RouteChangeListener />
{props.safeCrash && props.safeCrashCode ? (
<>
<ErrorPageHeader />
<ErrorPage code={props.safeCrashCode} />
</>
) : (
<>
<AppHeader />
<Routes />
</>
)}
</Suspense>
</Router>
);
}
const mapStateToProps = (state: AppState) => ({
safeCrash: getSafeCrash(state),
safeCrashCode: getSafeCrashCode(state),
});
const mapDispatchToProps = (dispatch: any) => ({
getCurrentUser: () => dispatch(getCurrentUser()),
getFeatureFlags: () => dispatch(fetchFeatureFlagsInit()),
getCurrentTenant: () => dispatch(getCurrentTenant(false)),
});
export default connect(mapStateToProps, mapDispatchToProps)(AppRouter);