(
38 | 'No vulnerabilities found:
- Navigate to the Contrast - Assess menu
- Select the necessary filters and click Run Button.
- View the results in the Vulnerability Report tab.
After retrieving vulnerabilities, return to this screen or else click on refresh icon to see the latest vulnerability report.
'
39 | );
40 |
41 | const [allfileVul, setAllFileVul] = useState(
42 | []
43 | );
44 | const [getSelectedVul, setSelectedVul] = useState<{
45 | fetching: null | AssessVulnerability;
46 | }>({
47 | fetching: null,
48 | });
49 |
50 | useEffect(() => {
51 | if (
52 | vulnerabilitiesList !== undefined &&
53 | vulnerabilitiesList !== null &&
54 | vulnerabilitiesList.responseData !== null &&
55 | vulnerabilitiesList.responseData !== undefined
56 | ) {
57 | const node =
58 | vulnerabilitiesList.responseData as AssessProjectVulnerability;
59 | setAllFileVul([node]);
60 | if (getSelectedVul.fetching !== null) {
61 | if (isVulnerabilityInList(node, getSelectedVul.fetching) === false) {
62 | setSelectedVul({ fetching: null });
63 | }
64 | }
65 | } else {
66 | setAllFileVul([]);
67 | setSelectedVul({ fetching: null });
68 | }
69 | }, [vulnerabilitiesList]);
70 |
71 | useEffect(() => {
72 | if (vulnerabilitiesList === null || vulnerabilitiesList?.code === 400) {
73 | webviewPostMessage({
74 | command: WEBVIEW_COMMANDS.ASSESS_GET_INITIAL_ALL_FILES_VULNERABILITY,
75 | payload: null,
76 | screen: WEBVIEW_SCREENS.ASSESS,
77 | });
78 | }
79 | }, [vulnerabilitiesList]);
80 |
81 | useEffect(() => {
82 | if (i18nData !== null && i18nData !== null) {
83 | const { vulnerabilityReport } =
84 | i18nData as unknown as ContrastAssessLocale;
85 | updateI18nFields(vulnerabilityReport?.htmlElements?.translate as string);
86 | }
87 | }, [i18nData]);
88 |
89 | const setStyle = (width: 'full' | 'half') => {
90 | return { width: width === 'full' ? '100%' : '50%' };
91 | };
92 |
93 | const handleVulnerabilitySelect = (e: AssessVulnerability) => {
94 | AssessEventsHttpRequestUpdate(e);
95 | setSelectedVul({ fetching: e });
96 | };
97 |
98 | return (
99 | <>
100 |
101 |
102 | {allfileVul.length === 0 || allfileVul === null ? (
103 |
107 | ) : (
108 |
{
111 | if (e?.isUnmapped === false) {
112 | webviewPostMessage({
113 | command: WEBVIEW_COMMANDS.ASSESS_OPEN_VULNERABILITY_FILE,
114 | payload: e,
115 | screen: WEBVIEW_SCREENS.ASSESS,
116 | });
117 | }
118 |
119 | if (e?.level === 0) {
120 | handleVulnerabilitySelect(e);
121 | }
122 | }}
123 | />
124 | )}
125 |
126 | {getSelectedVul.fetching !== null &&
127 | allfileVul.length > 0 &&
128 | allfileVul[0]?.child?.length > 0 ? (
129 |
130 |
131 |
132 | ) : null}
133 |
71 |
72 |
73 | | Plugin Name |
74 | ${displayName} |
75 |
76 |
77 |
78 | | Plugin Release Version |
79 | ${version} |
80 |
81 |
82 |
83 | | IDE Version |
84 | ${IDEVersion} |
85 |
86 |
87 | | OS Version |
88 | ${osWithVersion} |
89 |
90 |
91 |
92 | | Platform |
93 | ${platform} |
94 |
95 |
96 |
98 |
101 |
102 | ${aboutPage.content}
103 |
104 | `;
105 | }
106 | }
107 | return null;
108 | }
109 |
110 | private async template(): Promise {
111 | let stylePath: Uri | undefined;
112 |
113 | if (webviewPanel) {
114 | const pathResolver = new PathResolver(webviewPanel.webview);
115 | stylePath = pathResolver.resolve(['src', 'styles', 'about.css']);
116 | }
117 |
118 | return `
119 |
120 |
121 |
122 |
123 |
124 | ${stylePath ? `` : ''}
125 |
126 |
127 | ${await this.tabular()}
128 |
129 |
130 | `;
131 | }
132 |
133 | private async render(): Promise {
134 | if (webviewPanel) {
135 | webviewPanel.webview.html = await this.template();
136 | }
137 | }
138 |
139 | public dispose() {
140 | if (webviewPanel) {
141 | webviewPanel.dispose();
142 | }
143 | }
144 | }
145 |
146 | const aboutWebviewPanelInstance = new AboutWebviewPanel();
147 | export const registerAboutWebviewPanel = commands.registerCommand(
148 | CONSTRAST_ABOUT,
149 | async () => {
150 | await aboutWebviewPanelInstance.init();
151 | }
152 | );
153 |
154 | export { aboutWebviewPanelInstance };
155 |
--------------------------------------------------------------------------------
/src/test/unitTest/vscode-extension/getVulnerabilityByTraceId.test.ts:
--------------------------------------------------------------------------------
1 | import { getDataOnlyFromCacheAssess } from '../../../vscode-extension/cache/cacheManager';
2 | import { localeI18ln } from '../../../l10n';
3 | import {
4 | resolveFailure,
5 | resolveSuccess,
6 | } from '../../../vscode-extension/utils/errorHandling';
7 | import { getVulnerabilityByTraceId } from '../../../vscode-extension/api/services/apiService';
8 | import path from 'path';
9 | import { Uri } from 'vscode';
10 |
11 | jest.mock('../../../vscode-extension/cache/cacheManager', () => ({
12 | getDataOnlyFromCacheAssess: jest.fn(),
13 | }));
14 |
15 | jest.mock('../../../l10n', () => ({
16 | localeI18ln: {
17 | getTranslation: jest.fn(),
18 | },
19 | }));
20 |
21 | jest.mock('../../../vscode-extension/utils/errorHandling', () => ({
22 | resolveFailure: jest.fn(),
23 | resolveSuccess: jest.fn(),
24 | }));
25 |
26 | /* eslint-disable @typescript-eslint/no-explicit-any */
27 | jest.mock('vscode', () => {
28 | const UIKind = { Desktop: 1, Web: 2 };
29 | return {
30 | UIKind,
31 | env: {
32 | language: 'en',
33 | appName: 'VSCode',
34 | uiKind: UIKind.Desktop,
35 | },
36 | workspace: {
37 | workspaceFolders: [{ uri: { fsPath: '/path/to/mock/workspace' } }],
38 | onDidChangeConfiguration: jest.fn(),
39 | },
40 | window: {
41 | createTreeView: jest.fn().mockReturnValue({
42 | onDidChangeVisibility: jest.fn(),
43 | }),
44 | activeTextEditor: null,
45 | },
46 |
47 | TreeItem: class {
48 | [x: string]: { dark: Uri; light: Uri };
49 | constructor(
50 | label: { dark: Uri; light: Uri },
51 | command: any = null,
52 | icon: any = null
53 | ) {
54 | this.label = label;
55 | if (command !== null) {
56 | this.command = {
57 | title: label,
58 | command: command,
59 | } as any;
60 | }
61 | if (icon !== null) {
62 | const projectRoot = path.resolve(__dirname, '..');
63 | const iconPath = Uri.file(path.join(projectRoot, 'assets', icon));
64 | this.iconPath = {
65 | dark: iconPath,
66 | light: iconPath,
67 | };
68 | }
69 | }
70 | },
71 | Uri: {
72 | file: jest.fn().mockReturnValue('mockUri'),
73 | },
74 | commands: {
75 | registerCommand: jest.fn(),
76 | },
77 | languages: {
78 | registerHoverProvider: jest.fn(),
79 | },
80 | };
81 | });
82 |
83 | jest.mock(
84 | '../../../vscode-extension/commands/ui-commands/webviewHandler',
85 | () => ({
86 | ContrastPanelInstance: {
87 | postMessage: jest.fn(),
88 | },
89 | })
90 | );
91 |
92 | const mockVulnerabilityData = {
93 | responseData: {
94 | child: [
95 | {
96 | label: 'file1.js',
97 | child: [
98 | {
99 | traceId: 'trace123',
100 | vulnerabilityDetails: 'vulnerability 1 details',
101 | },
102 | {
103 | traceId: 'trace456',
104 | vulnerabilityDetails: 'vulnerability 2 details',
105 | },
106 | ],
107 | },
108 | {
109 | label: 'file2.js',
110 | child: [
111 | {
112 | traceId: 'trace789',
113 | vulnerabilityDetails: 'vulnerability 3 details',
114 | },
115 | ],
116 | },
117 | ],
118 | },
119 | };
120 |
121 | describe('getVulnerabilityByTraceId', () => {
122 | const traceId = 'trace123';
123 |
124 | beforeEach(() => {
125 | jest.clearAllMocks();
126 | });
127 |
128 | it('should return the vulnerability details when traceId is found', async () => {
129 | (getDataOnlyFromCacheAssess as jest.Mock).mockResolvedValue(
130 | mockVulnerabilityData
131 | );
132 | (localeI18ln.getTranslation as jest.Mock).mockReturnValue(
133 | 'Vulnerability fetched successfully'
134 | );
135 | (resolveSuccess as jest.Mock).mockReturnValue({
136 | message: 'Success',
137 | statusCode: 200,
138 | data: mockVulnerabilityData.responseData.child[0].child[0],
139 | });
140 |
141 | const result = await getVulnerabilityByTraceId(traceId);
142 |
143 | expect(getDataOnlyFromCacheAssess).toHaveBeenCalled();
144 | expect(resolveSuccess).toHaveBeenCalledWith(
145 | 'Vulnerability fetched successfully',
146 | 200,
147 | mockVulnerabilityData.responseData.child[0].child[0]
148 | );
149 | expect(result).toEqual({
150 | message: 'Success',
151 | statusCode: 200,
152 | data: mockVulnerabilityData.responseData.child[0].child[0],
153 | });
154 | });
155 |
156 | it('should return undefined if the traceId is not found', async () => {
157 | (getDataOnlyFromCacheAssess as jest.Mock).mockResolvedValue(
158 | mockVulnerabilityData
159 | );
160 | (localeI18ln.getTranslation as jest.Mock).mockReturnValue(
161 | 'TraceId not found'
162 | );
163 | (resolveFailure as jest.Mock).mockReturnValue({
164 | message: 'TraceId not found',
165 | statusCode: 400,
166 | });
167 |
168 | const result = await getVulnerabilityByTraceId('trace999');
169 |
170 | expect(getDataOnlyFromCacheAssess).toHaveBeenCalled();
171 | expect(result).toBeUndefined();
172 | expect(resolveFailure).not.toHaveBeenCalled();
173 | });
174 | });
175 |
--------------------------------------------------------------------------------
/src/webview/screens/Assess/tabs/LibraryReport/tabs/LibraryPath.tsx:
--------------------------------------------------------------------------------
1 | import React, { useEffect, useState } from 'react';
2 | import {
3 | ContrastAssessLocale,
4 | PassLocalLang,
5 | ReducerTypes,
6 | } from '../../../../../../common/types';
7 | import {
8 | LibParsedVulnerability,
9 | LibraryNode,
10 | } from '../../../../../../vscode-extension/api/model/api.interface';
11 | import { useSelector } from 'react-redux';
12 | import {
13 | getLibraryNodeByUuid,
14 | scaPathUpdate,
15 | } from '../../../../../utils/helper';
16 | import FolderIcon from '@mui/icons-material/Folder';
17 | import { webviewPostMessage } from '../../../../../utils/postMessage';
18 | import {
19 | WEBVIEW_COMMANDS,
20 | WEBVIEW_SCREENS,
21 | } from '../../../../../../vscode-extension/utils/constants/commands';
22 |
23 | export function LibraryPath({
24 | vulnerability,
25 | translate,
26 | }: {
27 | translate: PassLocalLang;
28 | vulnerability: unknown;
29 | }) {
30 | const [libraryPaths, setLibraryPaths] = useState<
31 | { path: string; link: string }[]
32 | >([]);
33 | const [isPathAvailable, setIsPathAvailable] = useState(false);
34 | const [selectedLibraryNode, setSelectedLibraryNode] =
35 | useState(null);
36 |
37 | const scaAllFilesData = useSelector(
38 | (state: ReducerTypes) => state.assessFilter.scaAllFiles
39 | );
40 | const scaAutoRefresh = useSelector(
41 | (state: ReducerTypes) => state.assessFilter.scaAutoRefresh
42 | );
43 |
44 | const [properties, setProperties] = useState<{
45 | noDataFoundLable: string;
46 | noDataFoundContent: string;
47 | }>({
48 | noDataFoundLable: 'No Path found',
49 | noDataFoundContent:
50 | 'Note: Please check the corresponding manifest files for the selected library.',
51 | });
52 |
53 | useEffect(() => {
54 | if (translate !== null && translate !== undefined) {
55 | const locale = translate as unknown as ContrastAssessLocale;
56 | const pathData = locale?.librariesReport?.tabs?.path;
57 | setProperties({
58 | noDataFoundLable: pathData?.noDataFoundLable ?? 'No Path found',
59 | noDataFoundContent:
60 | pathData?.noDataFoundContent ??
61 | 'Note: Please check the corresponding manifest files for the selected library.',
62 | });
63 | }
64 | }, [translate]);
65 |
66 | useEffect(() => {
67 | if (vulnerability !== null && vulnerability !== undefined) {
68 | const node = vulnerability as unknown as LibraryNode;
69 | if (node.level === 1) {
70 | setSelectedLibraryNode(node);
71 | setIsPathAvailable(node?.path !== null && node?.path.length > 0);
72 | setLibraryPaths(node?.path);
73 | }
74 | } else {
75 | setIsPathAvailable(false);
76 | }
77 | }, [vulnerability]);
78 |
79 | useEffect(() => {
80 | if (
81 | scaAllFilesData !== undefined &&
82 | scaAllFilesData !== null &&
83 | scaAllFilesData.responseData !== undefined &&
84 | scaAllFilesData.responseData !== null
85 | ) {
86 | const parsedVulnerability =
87 | scaAllFilesData.responseData as LibParsedVulnerability;
88 |
89 | if (
90 | !isPathAvailable &&
91 | selectedLibraryNode !== null &&
92 | selectedLibraryNode !== undefined
93 | ) {
94 | const resolvedNode = getLibraryNodeByUuid(
95 | parsedVulnerability,
96 | selectedLibraryNode?.overview?.hash,
97 | selectedLibraryNode?.isUnmapped
98 | );
99 |
100 | if (resolvedNode !== undefined && resolvedNode !== null) {
101 | const resolvedPaths = resolvedNode?.path ?? [];
102 | setLibraryPaths(resolvedPaths);
103 | }
104 | }
105 | }
106 | }, [scaAllFilesData, isPathAvailable, selectedLibraryNode]);
107 |
108 | useEffect(() => {
109 | if (
110 | !isPathAvailable &&
111 | vulnerability !== null &&
112 | vulnerability !== undefined &&
113 | scaAutoRefresh !== null
114 | ) {
115 | const node = vulnerability as unknown as LibraryNode;
116 | scaPathUpdate(node);
117 | }
118 | }, [isPathAvailable, scaAutoRefresh]);
119 |
120 | return (
121 |
122 | {libraryPaths.length > 0 ? (
123 |
144 | ) : (
145 |
146 |
147 | {properties.noDataFoundLable}
148 |
149 |
150 | {properties.noDataFoundContent}
151 |
152 |
153 | )}
154 |