aboutsummaryrefslogtreecommitdiffstats
path: root/server/sonar-web/src/main/js/components/SourceViewer/helpers/loadIssues.ts
blob: 7627c87f14eb041ac5572c75ff808e72dcdc1ee0 (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
97
98
99
100
101
/*
 * SonarQube
 * Copyright (C) 2009-2024 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 { listIssues, searchIssues } from '../../../api/issues';
import { parseIssueFromResponse } from '../../../helpers/issues';
import { getBranchLikeQuery } from '../../../sonar-aligned/helpers/branch-like';
import { BranchLike } from '../../../types/branch-like';
import { Issue, RawQuery } from '../../../types/types';
import { DEFAULT_ISSUES_QUERY } from '../../shared/utils';

// maximum possible value
const PAGE_SIZE = 500;
// Maximum issues return 20*500 for the API.
const PAGE_MAX = 20;

function buildListQuery(component: string, branchLike: BranchLike | undefined) {
  return {
    component,
    ...DEFAULT_ISSUES_QUERY,
    ...getBranchLikeQuery(branchLike),
  };
}

function buildSearchQuery(component: string, branchLike: BranchLike | undefined) {
  return {
    ...DEFAULT_ISSUES_QUERY,
    additionalFields: '_all',
    components: component,
    s: 'FILE_LINE',
    ...getBranchLikeQuery(branchLike),
  };
}

function loadListPage(query: RawQuery, page: number, pageSize = PAGE_SIZE): Promise<Issue[]> {
  return listIssues({
    ...query,
    p: page,
    ps: pageSize,
  }).then((r) => r.issues.map((issue) => parseIssueFromResponse(issue, r.components)));
}

function loadSearchPage(query: RawQuery, page: number, pageSize = PAGE_SIZE): Promise<Issue[]> {
  return searchIssues({
    ...query,
    p: page,
    ps: pageSize,
  }).then((r) =>
    r.issues.map((issue) => parseIssueFromResponse(issue, r.components, r.users, r.rules)),
  );
}

async function loadPageAndNext(
  query: RawQuery,
  needIssueSync = false,
  page = 1,
  pageSize = PAGE_SIZE,
): Promise<Issue[]> {
  const issues = needIssueSync
    ? await loadListPage(query, page)
    : await loadSearchPage(query, page);

  if (issues.length === 0) {
    return [];
  }

  if (issues.length < pageSize || page >= PAGE_MAX) {
    return issues;
  }

  const nextIssues = await loadPageAndNext(query, needIssueSync, page + 1, pageSize);

  return [...issues, ...nextIssues];
}

export default function loadIssues(
  component: string,
  branchLike: BranchLike | undefined,
  needIssueSync = false,
): Promise<Issue[]> {
  const query = needIssueSync
    ? buildListQuery(component, branchLike)
    : buildSearchQuery(component, branchLike);

  return loadPageAndNext(query, needIssueSync);
}