Skip to content

Commit bac3963

Browse files
committed
Update messages for variant analysis warnings
This uses the correct title and message for all warnings currently supported.
1 parent 96d99a7 commit bac3963

2 files changed

Lines changed: 22 additions & 18 deletions

File tree

extensions/ql-vscode/src/view/variant-analysis/VariantAnalysisOutcomePanels.tsx

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@ export const VariantAnalysisOutcomePanels = ({
4848
}: VariantAnalysisOutcomePanelProps) => {
4949
const [filterSortState, setFilterSortState] = useState<RepositoriesFilterSortState>(defaultFilterSortState);
5050

51+
const scannedReposCount = variantAnalysis.scannedRepos?.length ?? 0;
5152
const noCodeqlDbRepos = variantAnalysis.skippedRepos?.noCodeqlDbRepos;
5253
const notFoundRepos = variantAnalysis.skippedRepos?.notFoundRepos;
5354
const overLimitRepositoryCount = variantAnalysis.skippedRepos?.overLimitRepos?.repositoryCount ?? 0;
@@ -58,22 +59,22 @@ export const VariantAnalysisOutcomePanels = ({
5859
{variantAnalysis.status === VariantAnalysisStatus.Canceled && (
5960
<Alert
6061
type="warning"
61-
title="Query manually stopped"
62-
message="This query was manually stopped before the analysis completed. Results may be partial."
62+
title="Variant analysis canceled"
63+
message="Variant analysis canceled before all queries were complete. Some repositories were not analyzed."
6364
/>
6465
)}
6566
{overLimitRepositoryCount > 0 && (
6667
<Alert
6768
type="warning"
68-
title="Repository limit exceeded"
69-
message={`The number of requested repositories exceeds the maximum number of repositories supported by multi-repository variant analysis. ${overLimitRepositoryCount} ${overLimitRepositoryCount === 1 ? 'repository was' : 'repositories were'} skipped.`}
69+
title="Repository list too large"
70+
message={`Repository list contains more than ${formatDecimal(scannedReposCount)} entries. Only the first ${formatDecimal(scannedReposCount)} repositories were processed.`}
7071
/>
7172
)}
7273
{accessMismatchRepositoryCount > 0 && (
7374
<Alert
7475
type="warning"
75-
title="Access mismatch"
76-
message={`${accessMismatchRepositoryCount} ${accessMismatchRepositoryCount === 1 ? 'repository is' : 'repositories are'} private, while the controller repository is public. ${accessMismatchRepositoryCount === 1 ? 'This repository was' : 'These repositories were'} skipped.`}
76+
title="Problem with controller repository"
77+
message={`Publicly visible controller repository can't be used to analyze private repositories. ${formatDecimal(accessMismatchRepositoryCount)} ${accessMismatchRepositoryCount === 1 ? 'private repository was' : 'private repositories were'} not analyzed.`}
7778
/>
7879
)}
7980
</WarningsContainer>
@@ -126,17 +127,17 @@ export const VariantAnalysisOutcomePanels = ({
126127
{notFoundRepos?.repositoryCount &&
127128
<VSCodePanelView>
128129
<VariantAnalysisSkippedRepositoriesTab
129-
alertTitle='No access'
130-
alertMessage='The following repositories could not be scanned because you do not have read access.'
130+
alertTitle="No access"
131+
alertMessage="The following repositories can't be analyzed because they don’t exist or you don’t have access."
131132
skippedRepositoryGroup={notFoundRepos}
132133
filterSortState={filterSortState}
133134
/>
134135
</VSCodePanelView>}
135136
{noCodeqlDbRepos?.repositoryCount &&
136137
<VSCodePanelView>
137138
<VariantAnalysisSkippedRepositoriesTab
138-
alertTitle='No database'
139-
alertMessage='The following repositories could not be scanned because they do not have an available CodeQL database.'
139+
alertTitle="No CodeQL database"
140+
alertMessage="The following repositories can't be analyzed because they don't currently have a CodeQL database available for the selected language."
140141
skippedRepositoryGroup={noCodeqlDbRepos}
141142
filterSortState={filterSortState}
142143
/>

extensions/ql-vscode/src/view/variant-analysis/__tests__/VariantAnalysisOutcomePanels.spec.tsx

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,10 @@ import {
88
import { VariantAnalysisOutcomePanelProps, VariantAnalysisOutcomePanels } from '../VariantAnalysisOutcomePanels';
99
import { createMockVariantAnalysis } from '../../../vscode-tests/factories/remote-queries/shared/variant-analysis';
1010
import { createMockRepositoryWithMetadata } from '../../../vscode-tests/factories/remote-queries/shared/repository';
11-
import { createMockScannedRepo } from '../../../vscode-tests/factories/remote-queries/shared/scanned-repositories';
11+
import {
12+
createMockScannedRepo,
13+
createMockScannedRepos
14+
} from '../../../vscode-tests/factories/remote-queries/shared/scanned-repositories';
1215

1316
describe(VariantAnalysisOutcomePanels.name, () => {
1417
const defaultVariantAnalysis = {
@@ -141,7 +144,7 @@ describe(VariantAnalysisOutcomePanels.name, () => {
141144
status: VariantAnalysisStatus.Canceled,
142145
});
143146

144-
expect(screen.getByText('Warning: Query manually stopped')).toBeInTheDocument();
147+
expect(screen.getByText('Warning: Variant analysis canceled')).toBeInTheDocument();
145148
});
146149

147150
it('renders warning with access mismatch repos', () => {
@@ -152,7 +155,7 @@ describe(VariantAnalysisOutcomePanels.name, () => {
152155
},
153156
});
154157

155-
expect(screen.getByText('Warning: Access mismatch')).toBeInTheDocument();
158+
expect(screen.getByText('Warning: Problem with controller repository')).toBeInTheDocument();
156159
});
157160

158161
it('renders warning with over limit repos', () => {
@@ -162,7 +165,7 @@ describe(VariantAnalysisOutcomePanels.name, () => {
162165
},
163166
});
164167

165-
expect(screen.getByText('Warning: Repository limit exceeded')).toBeInTheDocument();
168+
expect(screen.getByText('Warning: Repository list too large')).toBeInTheDocument();
166169
});
167170

168171
it('renders singulars in warnings', () => {
@@ -179,12 +182,12 @@ describe(VariantAnalysisOutcomePanels.name, () => {
179182
},
180183
});
181184

182-
expect(screen.getByText('The number of requested repositories exceeds the maximum number of repositories supported by multi-repository variant analysis. 1 repository was skipped.')).toBeInTheDocument();
183-
expect(screen.getByText('1 repository is private, while the controller repository is public. This repository was skipped.')).toBeInTheDocument();
185+
expect(screen.getByText('Publicly visible controller repository can\'t be used to analyze private repositories. 1 private repository was not analyzed.')).toBeInTheDocument();
184186
});
185187

186188
it('renders plurals in warnings', () => {
187189
render({
190+
scannedRepos: createMockScannedRepos(),
188191
skippedRepos: {
189192
overLimitRepos: {
190193
repositoryCount: 2,
@@ -197,7 +200,7 @@ describe(VariantAnalysisOutcomePanels.name, () => {
197200
},
198201
});
199202

200-
expect(screen.getByText('The number of requested repositories exceeds the maximum number of repositories supported by multi-repository variant analysis. 2 repositories were skipped.')).toBeInTheDocument();
201-
expect(screen.getByText('2 repositories are private, while the controller repository is public. These repositories were skipped.')).toBeInTheDocument();
203+
expect(screen.getByText('Repository list contains more than 3 entries. Only the first 3 repositories were processed.')).toBeInTheDocument();
204+
expect(screen.getByText('Publicly visible controller repository can\'t be used to analyze private repositories. 2 private repositories were not analyzed.')).toBeInTheDocument();
202205
});
203206
});

0 commit comments

Comments
 (0)