aboutsummaryrefslogtreecommitdiffstats
path: root/server/sonar-web/src/main/js/components/lazyLoad.tsx
blob: 7043b40f4407771a7dbf4a63b19d10aa1b4173f0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
/*
 * SonarQube
 * Copyright (C) 2009-2018 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.
 */
import * as React from 'react';
import { translate } from '../helpers/l10n';
import { get, save } from '../helpers/storage';

type ReactComponent<P> = React.ComponentClass<P> | React.StatelessComponent<P>;

interface Loader<P> {
  (): Promise<{ default: ReactComponent<P> }>;
}

export const LAST_FAILED_CHUNK_STORAGE_KEY = 'sonarqube.last_failed_chunk';

export function lazyLoad<P>(loader: Loader<P>) {
  interface ImportError {
    request?: string;
  }

  interface State {
    Component?: ReactComponent<P>;
    error?: ImportError;
  }

  // use `React.Component`, not `React.PureComponent` to always re-render
  // and let the child component decide if it needs to change
  return class LazyLoader extends React.Component<any, State> {
    mounted = false;
    state: State = {};

    componentDidMount() {
      this.mounted = true;
      loader().then(i => this.receiveComponent(i.default), this.failToReceiveComponent);
    }

    componentWillUnmount() {
      this.mounted = false;
    }

    receiveComponent = (Component: ReactComponent<P>) => {
      if (this.mounted) {
        this.setState({ Component, error: undefined });
      }
    };

    failToReceiveComponent = (error?: ImportError) => {
      const lastFailedChunk = get(LAST_FAILED_CHUNK_STORAGE_KEY);
      if (error && error.request === lastFailedChunk) {
        // BOOM!
        // this is the second time we try to load the same file
        // usually that means the file does not exist on the server
        // so we should not try to reload the page to not fall into infinite reloading
        // just show the error message
        if (this.mounted) {
          this.setState({ Component: undefined, error });
        }
      } else {
        if (error && error.request) {
          save(LAST_FAILED_CHUNK_STORAGE_KEY, error.request);
        }
        window.location.reload();
      }
    };

    render() {
      const { Component, error } = this.state;

      if (error && error.request) {
        return <div className="alert alert-danger">{translate('default_error_message')}</div>;
      }

      if (!Component) {
        return null;
      }

      return <Component {...this.props} />;
    }
  };
}