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
|
/*
* 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 { withTheme } from '@emotion/react';
import styled from '@emotion/styled';
import { Spinner } from '@sonarsource/echoes-react';
import { FlagMessage, themeColor } from 'design-system';
import * as React from 'react';
import { translate } from '../../../helpers/l10n';
import { BranchLike } from '../../../types/branch-like';
import { Hotspot } from '../../../types/security-hotspots';
import {
Component,
ExpandDirection,
FlowLocation,
LinearIssueLocation,
SourceLine,
SourceViewerFile,
} from '../../../types/types';
import SnippetViewer from '../../issues/crossComponentSourceViewer/SnippetViewer';
import HotspotPrimaryLocationBox from './HotspotPrimaryLocationBox';
import HotspotSnippetHeader from './HotspotSnippetHeader';
export interface HotspotSnippetContainerRendererProps {
branchLike?: BranchLike;
component: Component;
highlightedSymbols: string[];
hotspot: Hotspot;
loading: boolean;
locations: { [line: number]: LinearIssueLocation[] };
onExpandBlock: (direction: ExpandDirection) => Promise<void>;
onLocationSelect: (index: number) => void;
onSymbolClick: (symbols: string[]) => void;
secondaryLocations: FlowLocation[];
selectedHotspotLocation?: number;
sourceLines: SourceLine[];
sourceViewerFile: SourceViewerFile;
}
const noop = () => undefined;
const EXPAND_ANIMATION_SPEED = 200;
/* Exported for testing */
export async function animateExpansion(
scrollableRef: React.RefObject<HTMLDivElement>,
expandBlock: (direction: ExpandDirection) => Promise<void>,
direction: ExpandDirection,
) {
const wrapper = scrollableRef.current?.querySelector<HTMLElement>('.it__source-viewer-code');
const table = wrapper?.firstChild as HTMLElement;
if (!wrapper || !table) {
return;
}
// lock the wrapper's height before adding the additional rows
const startHeight = table.getBoundingClientRect().height;
wrapper.style.maxHeight = `${startHeight}px`;
await expandBlock(direction);
const targetHeight = table.getBoundingClientRect().height;
if (direction === 'up') {
/*
* Add a negative margin to keep the original alignment
* Remove the transition to do so instantaneously
*/
table.style.transition = 'none';
table.style.marginTop = `${startHeight - targetHeight}px`;
setTimeout(() => {
/*
* Reset the transition to the default
* transition the margin back to 0 at the same time as the maxheight
*/
table.style.transition = '';
table.style.marginTop = '0px';
wrapper.style.maxHeight = `${targetHeight}px`;
}, 0);
} else {
// False positive:
// eslint-disable-next-line require-atomic-updates
wrapper.style.maxHeight = `${targetHeight}px`;
}
// after the animation is done, clear the applied styles
setTimeout(() => {
table.style.marginTop = '';
wrapper.style.maxHeight = '';
}, EXPAND_ANIMATION_SPEED);
}
export default function HotspotSnippetContainerRenderer(
props: Readonly<HotspotSnippetContainerRendererProps>,
) {
const {
highlightedSymbols,
hotspot,
loading,
locations: primaryLocations,
secondaryLocations,
selectedHotspotLocation,
sourceLines,
sourceViewerFile,
component,
branchLike,
} = props;
const scrollableRef = React.useRef<HTMLDivElement>(null);
const secondaryLocationSelected = selectedHotspotLocation !== undefined;
/* Use memo is important to not rerender and trigger additional scrolls */
const hotspotPrimaryLocationBox = React.useMemo(
() => (
<HotspotPrimaryLocationBox
hotspot={hotspot}
secondaryLocationSelected={secondaryLocationSelected}
/>
),
[hotspot, secondaryLocationSelected],
);
const renderHotspotBoxInLine = (line: SourceLine) =>
line.line === hotspot.line ? hotspotPrimaryLocationBox : undefined;
const highlightedLocation =
selectedHotspotLocation !== undefined
? { index: selectedHotspotLocation, text: hotspot.message }
: undefined;
return (
<Spinner isLoading={loading}>
{sourceLines.length === 0 && (
<FlagMessage variant="info">{translate('hotspots.no_associated_lines')}</FlagMessage>
)}
{sourceLines.length > 0 && (
<>
<HotspotSnippetHeader hotspot={hotspot} component={component} branchLike={branchLike} />
<SourceFileWrapper className="sw-box-border sw-w-full sw-rounded-1" ref={scrollableRef}>
<SnippetViewer
component={sourceViewerFile}
displayLineNumberOptions={false}
displaySCM={false}
expandBlock={(_i, direction) =>
animateExpansion(scrollableRef, props.onExpandBlock, direction)
}
handleSymbolClick={props.onSymbolClick}
highlightedLocationMessage={highlightedLocation}
highlightedSymbols={highlightedSymbols}
index={0}
locations={secondaryLocations}
locationsByLine={primaryLocations}
onLocationSelect={props.onLocationSelect}
renderAdditionalChildInLine={renderHotspotBoxInLine}
renderDuplicationPopup={noop}
snippet={sourceLines}
hideLocationIndex={secondaryLocations.length !== 0}
/>
</SourceFileWrapper>
</>
)}
</Spinner>
);
}
const SourceFileWrapper = withTheme(styled.div`
background-color: ${themeColor('codeLine')};
`);
|
