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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
|
/*
* 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 { Path, To } from 'react-router-dom';
import { getBranchLikeQuery, isBranch, isMainBranch } from '~sonar-aligned/helpers/branch-like';
import { queryToSearch } from '~sonar-aligned/helpers/urls';
import { BranchParameters } from '~sonar-aligned/types/branch-like';
import { getProfilePath } from '../apps/quality-profiles/utils';
import { DEFAULT_ISSUES_QUERY } from '../components/shared/utils';
import { BranchLike } from '../types/branch-like';
import { ComponentQualifier, isApplication, isPortfolioLike } from '../types/component';
import { MeasurePageView } from '../types/measures';
import { GraphType } from '../types/project-activity';
import { Dict } from '../types/types';
import { HomePage } from '../types/users';
import { isPullRequest } from './branch-like';
import { serializeOptionalBoolean } from './query';
import { getBaseUrl } from './system';
export interface Location {
pathname: string;
query?: Dict<string | undefined | number>;
}
export enum CodeScope {
Overall = 'overall',
New = 'new',
}
type CodeScopeType = CodeScope.Overall | CodeScope.New;
export type Query = Location['query'];
const PROJECT_BASE_URL = '/dashboard';
export function getComponentOverviewUrl(
componentKey: string,
componentQualifier: ComponentQualifier | string,
branchParameters?: BranchParameters,
codeScope?: CodeScopeType,
) {
return isPortfolioLike(componentQualifier)
? getPortfolioUrl(componentKey)
: getProjectQueryUrl(componentKey, branchParameters, codeScope);
}
export function getComponentAdminUrl(
componentKey: string,
componentQualifier: ComponentQualifier | string,
) {
if (isPortfolioLike(componentQualifier)) {
return getPortfolioAdminUrl(componentKey);
} else if (isApplication(componentQualifier)) {
return getApplicationAdminUrl(componentKey);
}
return getProjectUrl(componentKey);
}
export function getProjectUrl(
project: string,
branch?: string,
codeScope?: CodeScopeType,
): Partial<Path> {
return {
pathname: PROJECT_BASE_URL,
search: queryToSearch({ id: project, branch, ...(codeScope && { code_scope: codeScope }) }),
};
}
export function getProjectSecurityHotspots(project: string): To {
return {
pathname: '/security_hotspots',
search: queryToSearch({ id: project }),
};
}
export function getProjectQueryUrl(
project: string,
branchParameters?: BranchParameters,
codeScope?: CodeScopeType,
): To {
return {
pathname: PROJECT_BASE_URL,
search: queryToSearch({
id: project,
...branchParameters,
...(codeScope && { code_scope: codeScope }),
}),
};
}
export function getPortfolioUrl(key: string): To {
return { pathname: '/portfolio', search: queryToSearch({ id: key }) };
}
export function getPortfolioAdminUrl(key: string): To {
return {
pathname: '/project/admin/extension/governance/console',
search: queryToSearch({ id: key, qualifier: ComponentQualifier.Portfolio }),
};
}
export function getApplicationAdminUrl(key: string): To {
return {
pathname: '/project/admin/extension/developer-server/application-console',
search: queryToSearch({ id: key }),
};
}
export function getComponentBackgroundTaskUrl(
componentKey: string,
status?: string,
taskType?: string,
): Path {
return {
pathname: '/project/background_tasks',
search: queryToSearch({ id: componentKey, status, taskType }),
hash: '',
};
}
export function getBranchLikeUrl(project: string, branchLike?: BranchLike): Partial<Path> {
if (isPullRequest(branchLike)) {
return getPullRequestUrl(project, branchLike.key);
} else if (isBranch(branchLike) && !isMainBranch(branchLike)) {
return getBranchUrl(project, branchLike.name);
}
return getProjectUrl(project);
}
export function getBranchUrl(project: string, branch: string): Partial<Path> {
return { pathname: PROJECT_BASE_URL, search: queryToSearch({ branch, id: project }) };
}
export function getPullRequestUrl(project: string, pullRequest: string): Partial<Path> {
return { pathname: PROJECT_BASE_URL, search: queryToSearch({ id: project, pullRequest }) };
}
/**
* Generate URL for a global issues page
*/
export function getIssuesUrl(query: Query): To {
const pathname = '/issues';
return { pathname, search: queryToSearch(query) };
}
/**
* Generate URL for a component's drilldown page
*/
export function getComponentDrilldownUrl(options: {
componentKey: string;
metric: string;
branchLike?: BranchLike;
selectionKey?: string;
treemapView?: boolean;
listView?: boolean;
asc?: boolean;
}): To {
const { componentKey, metric, branchLike, selectionKey, treemapView, listView, asc } = options;
const query: Query = { id: componentKey, metric, ...getBranchLikeQuery(branchLike) };
if (treemapView) {
query.view = 'treemap';
}
if (listView) {
query.view = 'list';
query.asc = serializeOptionalBoolean(asc);
}
if (selectionKey) {
query.selected = selectionKey;
}
return { pathname: '/component_measures', search: queryToSearch(query) };
}
export function getComponentDrilldownUrlWithSelection(
componentKey: string,
selectionKey: string,
metric: string,
branchLike?: BranchLike,
view?: MeasurePageView,
): To {
return getComponentDrilldownUrl({
componentKey,
selectionKey,
metric,
branchLike,
treemapView: view === MeasurePageView.treemap,
listView: view === MeasurePageView.list,
});
}
export function getMeasureTreemapUrl(componentKey: string, metric: string) {
return getComponentDrilldownUrl({ componentKey, metric, treemapView: true });
}
export function getActivityUrl(component: string, branchLike?: BranchLike, graph?: GraphType) {
return {
pathname: '/project/activity',
search: queryToSearch({ id: component, graph, ...getBranchLikeQuery(branchLike) }),
};
}
/**
* Generate URL for a component's measure history
*/
export function getMeasureHistoryUrl(component: string, metric: string, branchLike?: BranchLike) {
return {
pathname: '/project/activity',
search: queryToSearch({
id: component,
graph: 'custom',
custom_metrics: metric,
...getBranchLikeQuery(branchLike),
}),
};
}
/**
* Generate URL for a component's permissions page
*/
export function getComponentPermissionsUrl(componentKey: string): To {
return { pathname: '/project_roles', search: queryToSearch({ id: componentKey }) };
}
/**
* Generate URL for a quality profile
*/
export function getQualityProfileUrl(name: string, language: string): To {
return getProfilePath(name, language);
}
export function getQualityGateUrl(name: string): To {
// This is a workaround for the react router bug: https://github.com/remix-run/react-router/issues/10814
const qualityGateName = name.replace(/%/g, '%25');
return {
pathname: '/quality_gates/show/' + encodeURIComponent(qualityGateName),
};
}
/**
* Generate URL for the project tutorial page
*/
export function getProjectTutorialLocation(
project: string,
selectedTutorial?: string,
): Partial<Path> {
return {
pathname: '/tutorials',
search: queryToSearch({ id: project, selectedTutorial }),
};
}
/**
* Generate URL for the project creation page
*/
export function getCreateProjectModeLocation(mode?: string): Partial<Path> {
return {
search: queryToSearch({ mode }),
};
}
export function getQualityGatesUrl(): To {
return {
pathname: '/quality_gates',
};
}
export function getGlobalSettingsUrl(
category?: string,
query?: Dict<string | undefined | number>,
): Partial<Path> {
return {
pathname: '/admin/settings',
search: queryToSearch({ category, ...query }),
};
}
export function getProjectSettingsUrl(id: string, category?: string): Partial<Path> {
return {
pathname: '/project/settings',
search: queryToSearch({ id, category }),
};
}
/**
* Generate URL for the rules page
*/
export function getRulesUrl(query: Query): Partial<Path> {
return { pathname: '/coding_rules', search: queryToSearch(query) };
}
/**
* Generate URL for the rules page filtering only active deprecated rules
*/
export function getDeprecatedActiveRulesUrl(query: Query = {}): To {
const baseQuery = { activation: 'true', statuses: 'DEPRECATED' };
return getRulesUrl({ ...query, ...baseQuery });
}
export function getRuleUrl(rule: string) {
return getRulesUrl({ open: rule, rule_key: rule });
}
export function getFormattingHelpUrl(): string {
return '/formatting/help';
}
export function getCodeUrl(
project: string,
branchLike?: BranchLike,
selected?: string,
line?: number,
): Partial<Path> {
return {
pathname: '/code',
search: queryToSearch({
id: project,
...getBranchLikeQuery(branchLike),
selected,
line: line?.toFixed(),
}),
};
}
export function getHomePageUrl(homepage: HomePage) {
switch (homepage.type) {
case 'APPLICATION':
return homepage.branch
? getProjectUrl(homepage.component, homepage.branch)
: getProjectUrl(homepage.component);
case 'PROJECT':
return homepage.branch
? getBranchUrl(homepage.component, homepage.branch)
: getProjectUrl(homepage.component);
case 'PORTFOLIO':
return getPortfolioUrl(homepage.component);
case 'PORTFOLIOS':
return '/portfolios';
case 'MY_PROJECTS':
return '/projects';
case 'ISSUES':
case 'MY_ISSUES':
return { pathname: '/issues', query: DEFAULT_ISSUES_QUERY };
}
// should never happen, but just in case...
return '/projects';
}
export function convertGithubApiUrlToLink(url: string) {
return url
.replace(/^https?:\/\/api\.github\.com/, 'https://github.com') // GH.com
.replace(/\/api\/v\d+\/?$/, ''); // GH Enterprise
}
export function stripTrailingSlash(url: string) {
return url.replace(/\/$/, '');
}
export function getHostUrl(): string {
return window.location.origin + getBaseUrl();
}
export function getPathUrlAsString(path: Partial<Path>, internal = true): string {
return `${internal ? getBaseUrl() : getHostUrl()}${path.pathname ?? '/'}${path.search ?? ''}`;
}
export function getReturnUrl(location: { hash?: string; query?: { return_to?: string } }) {
const returnTo = location.query && location.query['return_to'];
if (isRelativeUrl(returnTo)) {
return returnTo + (location.hash ? location.hash : '');
}
return `${getBaseUrl()}/`;
}
export function isRelativeUrl(url?: string): boolean {
const regex = new RegExp(/^\/[^/\\]/);
return Boolean(url && regex.test(url));
}
export function convertToTo(link: string | Location) {
if (linkIsLocation(link)) {
return { pathname: link.pathname, search: queryToSearch(link.query) } as Partial<Path>;
}
return link;
}
function linkIsLocation(link: string | Location): link is Location {
return (link as Location).query !== undefined;
}
|