aboutsummaryrefslogtreecommitdiffstats
path: root/server/sonar-web/src/main/js/app/components/embed-docs-modal/SuggestionsProvider.tsx
blob: 21cf0bd5bed91e42ef886af10c0e27b4e178e99a (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
/*
 * 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 * as PropTypes from 'prop-types';
// eslint-disable-next-line import/no-extraneous-dependencies
import suggestionsJson from 'Docs/EmbedDocsSuggestions.json';
import { SuggestionsContext } from './SuggestionsContext';
import { isSonarCloud } from '../../../helpers/system';

export interface SuggestionLink {
  link: string;
  scope?: 'sonarcloud';
  text: string;
}

interface SuggestionsJson {
  [key: string]: SuggestionLink[];
}

interface Props {
  children: ({ suggestions }: { suggestions: SuggestionLink[] }) => React.ReactNode;
}

interface State {
  suggestions: SuggestionLink[];
}

export default class SuggestionsProvider extends React.Component<Props, State> {
  keys: string[] = [];

  static childContextTypes = {
    suggestions: PropTypes.object
  };

  state: State = { suggestions: [] };

  getChildContext = (): { suggestions: SuggestionsContext } => {
    return {
      suggestions: {
        addSuggestions: this.addSuggestions,
        removeSuggestions: this.removeSuggestions
      }
    };
  };

  fetchSuggestions = () => {
    const jsonList = suggestionsJson as SuggestionsJson;
    let suggestions: SuggestionLink[] = [];
    this.keys.forEach(key => {
      if (jsonList[key]) {
        suggestions = [...jsonList[key], ...suggestions];
      }
    });
    this.setState({ suggestions });
  };

  addSuggestions = (newKey: string) => {
    this.keys = [...this.keys, newKey];
    this.fetchSuggestions();
  };

  removeSuggestions = (oldKey: string) => {
    this.keys = this.keys.filter(key => key !== oldKey);
    this.fetchSuggestions();
  };

  render() {
    const suggestions = isSonarCloud()
      ? this.state.suggestions
      : this.state.suggestions.filter(suggestion => suggestion.scope !== 'sonarcloud');

    return this.props.children({ suggestions });
  }
}