startReactApp.tsx

/*
 * SonarQube
 * Copyright (C) 2009-2019 SonarSource SA
 * mailto:info AT sonarsource DOT com
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
/* eslint-disable react/jsx-sort-props */
import * as React from 'react';
import { render } from 'react-dom';
import { Router, Route, IndexRoute, Redirect, RouteProps, RouteConfig } from 'react-router';
import { Provider } from 'react-redux';
import { IntlProvider } from 'react-intl';
import { Location } from 'history';
import getStore from './getStore';
import getHistory from './getHistory';
import MigrationContainer from '../components/MigrationContainer';
import App from '../components/App';
import GlobalContainer from '../components/GlobalContainer';
import aboutRoutes from '../../apps/about/routes';
import accountRoutes from '../../apps/account/routes';
import backgroundTasksRoutes from '../../apps/background-tasks/routes';
import codeRoutes from '../../apps/code/routes';
import codingRulesRoutes from '../../apps/coding-rules/routes';
import componentMeasuresRoutes from '../../apps/component-measures/routes';
import customMeasuresRoutes from '../../apps/custom-measures/routes';
import groupsRoutes from '../../apps/groups/routes';
import Issues from '../../apps/issues/components/AppContainer';
import Explore from '../../apps/explore/Explore';
import ExploreIssues from '../../apps/explore/ExploreIssues';
import ExploreProjects from '../../apps/explore/ExploreProjects';
import IssuesPageSelector from '../../apps/issues/IssuesPageSelector';
import marketplaceRoutes from '../../apps/marketplace/routes';
import customMetricsRoutes from '../../apps/custom-metrics/routes';
import overviewRoutes from '../../apps/overview/routes';
import onboardingRoutes from '../../apps/tutorials/routes';
import organizationsRoutes from '../../apps/organizations/routes';
import permissionTemplatesRoutes from '../../apps/permission-templates/routes';
import portfolioRoutes from '../../apps/portfolio/routes';
import projectActivityRoutes from '../../apps/projectActivity/routes';
import projectBranchesRoutes from '../../apps/projectBranches/routes';
import projectQualityGateRoutes from '../../apps/projectQualityGate/routes';
import projectQualityProfilesRoutes from '../../apps/projectQualityProfiles/routes';
import projectsRoutes from '../../apps/projects/routes';
import projectsManagementRoutes from '../../apps/projectsManagement/routes';
import qualityGatesRoutes from '../../apps/quality-gates/routes';
import qualityProfilesRoutes from '../../apps/quality-profiles/routes';
import sessionsRoutes from '../../apps/sessions/routes';
import settingsRoutes from '../../apps/settings/routes';
import systemRoutes from '../../apps/system/routes';
import usersRoutes from '../../apps/users/routes';
import webAPIRoutes from '../../apps/web-api/routes';
import documentationRoutes from '../../apps/documentation/routes';
import webhooksRoutes from '../../apps/webhooks/routes';
import { maintenanceRoutes, setupRoutes } from '../../apps/maintenance/routes';
import { globalPermissionsRoutes, projectPermissionsRoutes } from '../../apps/permissions/routes';
import { lazyLoad } from '../../components/lazyLoad';
import { isSonarCloud } from '../../helpers/system';

function handleUpdate(this: { state: { location: Location } }) {
  const { action } = this.state.location;

  if (action === 'PUSH') {
    window.scrollTo(0, 0);
  }
}

// this is not an official api
const RouteWithChildRoutes = Route as React.ComponentClass<
  RouteProps & { childRoutes: RouteConfig }
>;

export default function startReactApp(
  lang: string,
  currentUser?: T.CurrentUser,
  appState?: T.AppState
) {
  const el = document.getElementById('content');

  const history = getHistory();
  const store = getStore(currentUser, appState);

  render(
    <Provider store={store}>
      <IntlProvider defaultLocale={lang} locale={lang}>
        <Router history={history} onUpdate={handleUpdate}>
          <Route
            path="/account/issues"
            onEnter={(_, replace) => {
              replace({ pathname: '/issues', query: { myIssues: 'true', resolved: 'false' } });
            }}
          />

          <Route
            path="/codingrules"
            onEnter={(_, replace) => {
              replace('/coding_rules' + window.location.hash);
            }}
          />

          <Route
            path="/dashboard/index/:key"
            onEnter={(nextState, replace) => {
              replace({ pathname: '/dashboard', query: { id: nextState.params.key } });
            }}
          />

          <Route
            path="/issues/search"
            onEnter={(_, replace) => {
              replace('/issues' + window.location.hash);
            }}
          />

          <Redirect from="/admin" to="/admin/settings" />
          <Redirect from="/background_tasks" to="/admin/background_tasks" />
          <Redirect from="/component/index" to="/component" />
          <Redirect from="/component_issues" to="/project/issues" />
          <Redirect from="/dashboard/index" to="/dashboard" />
          <Redirect from="/governance" to="/portfolio" />
          <Redirect from="/groups" to="/admin/groups" />
          <Redirect from="/extension/governance/portfolios" to="/portfolios" />
          <Redirect from="/metrics" to="/admin/custom_metrics" />
          <Redirect from="/permission_templates" to="/admin/permission_templates" />
          <Redirect from="/profiles/index" to="/profiles" />
          <Redirect from="/projects_admin" to="/admin/projects_management" />
          <Redirect from="/quality_gates/index" to="/quality_gates" />
          <Redirect from="/roles/global" to="/admin/permissions" />
          <Redirect from="/settings" to="/admin/settings" />
          <Redirect from="/settings/encryption" to="/admin/settings/encryption" />
          <Redirect from="/settings/index" to="/admin/settings" />
          <Redirect from="/sessions/login" to="/sessions/new" />
          <Redirect from="/system" to="/admin/system" />
          <Redirect from="/system/index" to="/admin/system" />
          <Redirect from="/view" to="/portfolio" />
          <Redirect from="/users" to="/admin/users" />

          <Route
            path="markdown/help"
            component={lazyLoad(() => import('../components/MarkdownHelp'))}
          />

          <Route component={lazyLoad(() => import('../components/SimpleContainer'))}>
            <Route path="maintenance">{maintenanceRoutes}</Route>
            <Route path="setup">{setupRoutes}</Route>
          </Route>

          <Route component={MigrationContainer}>
            <Route component={lazyLoad(() => import('../components/SimpleSessionsContainer'))}>
              <RouteWithChildRoutes path="/sessions" childRoutes={sessionsRoutes} />
            </Route>

            <Route path="/" component={App}>
              <IndexRoute component={lazyLoad(() => import('../components/Landing'))} />
              <RouteWithChildRoutes path="about" childRoutes={aboutRoutes} />

              <Route component={GlobalContainer}>
                <RouteWithChildRoutes path="account" childRoutes={accountRoutes} />
                {!isSonarCloud() && (
                  <RouteWithChildRoutes path="coding_rules" childRoutes={codingRulesRoutes} />
                )}
                <RouteWithChildRoutes path="documentation" childRoutes={documentationRoutes} />
                <Route path="explore" component={Explore}>
                  <Route path="issues" component={ExploreIssues} />
                  <Route path="projects" component={ExploreProjects} />
                </Route>
                <Route
                  path="extension/:pluginKey/:extensionKey"
                  component={lazyLoad(() => import('../components/extensions/GlobalPageExtension'))}
                />
                <Route path="issues" component={IssuesPageSelector} />
                <RouteWithChildRoutes path="onboarding" childRoutes={onboardingRoutes} />
                {isSonarCloud() && (
                  <>
                    <Route
                      path="create-organization"
                      component={lazyLoad(() =>
                        import('../../apps/create/organization/CreateOrganization')
                      )}
                    />
                    <Route
                      path="feedback/downgrade"
                      component={lazyLoad(() =>
                        import('../../apps/feedback/downgrade/DowngradeFeedback')
                      )}
                    />
                  </>
                )}
                <RouteWithChildRoutes path="organizations" childRoutes={organizationsRoutes} />
                <RouteWithChildRoutes path="projects" childRoutes={projectsRoutes} />
                <RouteWithChildRoutes path="quality_gates" childRoutes={qualityGatesRoutes} />
                <Route
                  path="portfolios"
                  component={lazyLoad(() => import('../components/extensions/PortfoliosPage'))}
                />
                <RouteWithChildRoutes path="profiles" childRoutes={qualityProfilesRoutes} />
                <RouteWithChildRoutes path="web_api" childRoutes={webAPIRoutes} />

                <Route component={lazyLoad(() => import('../components/ComponentContainer'))}>
                  <RouteWithChildRoutes path="code" childRoutes={codeRoutes} />
                  <RouteWithChildRoutes
                    path="component_measures"
                    childRoutes={componentMeasuresRoutes}
                  />
                  <RouteWithChildRoutes path="dashboard" childRoutes={overviewRoutes} />
                  <RouteWithChildRoutes path="portfolio" childRoutes={portfolioRoutes} />
                  <RouteWithChildRoutes
                    path="project/activity"
                    childRoutes={projectActivityRoutes}
                  />
                  <Route
                    path="project/extension/:pluginKey/:extensionKey"
                    component={lazyLoad(() =>
                      import('../components/extensions/ProjectPageExtension')
                    )}
                  />
                  <Route path="project/issues" component={Issues} />
                  <Route
                    path="project/security_reports/:type"
                    component={lazyLoad(() => import('../../apps/securityReports/components/App'))}
                  />
                  <RouteWithChildRoutes
                    path="project/quality_gate"
                    childRoutes={projectQualityGateRoutes}
                  />
                  <RouteWithChildRoutes
                    path="project/quality_profiles"
                    childRoutes={projectQualityProfilesRoutes}
                  />
                  <Route component={lazyLoad(() => import('../components/ProjectAdminContainer'))}>
                    {!isSonarCloud() && (
                      <RouteWithChildRoutes
                        path="custom_measures"
                        childRoutes={customMeasuresRoutes}
                      />
                    )}
                    <Route
                      path="project/admin/extension/:pluginKey/:extensionKey"
                      component={lazyLoad(() =>
                        import('../components/extensions/ProjectAdminPageExtension')
                      )}
                    />
                    <RouteWithChildRoutes
                      path="project/background_tasks"
                      childRoutes={backgroundTasksRoutes}
                    />
                    <RouteWithChildRoutes
                      path="project/branches"
                      childRoutes={projectBranchesRoutes}
                    />
                    <RouteWithChildRoutes path="project/settings" childRoutes={settingsRoutes} />
                    <RouteWithChildRoutes
                      path="project_roles"
                      childRoutes={projectPermissionsRoutes}
                    />
                    <RouteWithChildRoutes path="project/webhooks" childRoutes={webhooksRoutes} />
                    <Route
                      path="project/deletion"
                      component={lazyLoad(() => import('../../apps/projectDeletion/App'))}
                    />
                    <Route
                      path="project/links"
                      component={lazyLoad(() => import('../../apps/projectLinks/App'))}
                    />
                    <Route
                      path="project/key"
                      component={lazyLoad(() => import('../../apps/projectKey/Key'))}
                    />
                  </Route>
                </Route>

                <Route
                  component={lazyLoad(() => import('../components/AdminContainer'))}
                  path="admin">
                  <Route
                    path="extension/:pluginKey/:extensionKey"
                    component={lazyLoad(() =>
                      import('../components/extensions/GlobalAdminPageExtension')
                    )}
                  />
                  <RouteWithChildRoutes
                    path="background_tasks"
                    childRoutes={backgroundTasksRoutes}
                  />
                  <RouteWithChildRoutes path="custom_metrics" childRoutes={customMetricsRoutes} />
                  <RouteWithChildRoutes path="groups" childRoutes={groupsRoutes} />
                  <RouteWithChildRoutes
                    path="permission_templates"
                    childRoutes={permissionTemplatesRoutes}
                  />
                  <RouteWithChildRoutes path="roles/global" childRoutes={globalPermissionsRoutes} />
                  <RouteWithChildRoutes path="permissions" childRoutes={globalPermissionsRoutes} />
                  <RouteWithChildRoutes
                    path="projects_management"
                    childRoutes={projectsManagementRoutes}
                  />
                  <RouteWithChildRoutes path="settings" childRoutes={settingsRoutes} />
                  <RouteWithChildRoutes path="system" childRoutes={systemRoutes} />
                  <RouteWithChildRoutes path="marketplace" childRoutes={marketplaceRoutes} />
                  <RouteWithChildRoutes path="users" childRoutes={usersRoutes} />
                  <RouteWithChildRoutes path="webhooks" childRoutes={webhooksRoutes} />
                </Route>
              </Route>
              <Route
                path="not_found"
                component={lazyLoad(() => import('../components/NotFound'))}
              />
              <Route path="*" component={lazyLoad(() => import('../components/NotFound'))} />
            </Route>
          </Route>
        </Router>
      </IntlProvider>
    </Provider>,
    el
  );
}