From 497acede927e672356ba30133719b6c3b832c146 Mon Sep 17 00:00:00 2001 From: Charis Kyriakou Date: Wed, 9 Mar 2022 15:06:38 +0000 Subject: [PATCH 1/3] Rename analysis alert results --- .../analyses-results-manager.ts | 4 +-- .../src/remote-queries/sample-data.ts | 32 +++++++++---------- .../remote-queries/shared/analysis-result.ts | 2 +- .../src/remote-queries/view/RemoteQueries.tsx | 8 ++--- 4 files changed, 23 insertions(+), 23 deletions(-) diff --git a/extensions/ql-vscode/src/remote-queries/analyses-results-manager.ts b/extensions/ql-vscode/src/remote-queries/analyses-results-manager.ts index d28e4ed27b3..74c415c00bd 100644 --- a/extensions/ql-vscode/src/remote-queries/analyses-results-manager.ts +++ b/extensions/ql-vscode/src/remote-queries/analyses-results-manager.ts @@ -101,7 +101,7 @@ export class AnalysesResultsManager { const analysisResults: AnalysisResults = { nwo: analysis.nwo, status: 'InProgress', - results: [] + alertResults: [] }; const queryId = analysis.downloadLink.queryId; const resultsForQuery = this.internalGetAnalysesResults(queryId); @@ -123,7 +123,7 @@ export class AnalysesResultsManager { const queryResults = await this.readResults(artifactPath); newAnaysisResults = { ...analysisResults, - results: queryResults, + alertResults: queryResults, status: 'Completed' }; } else { diff --git a/extensions/ql-vscode/src/remote-queries/sample-data.ts b/extensions/ql-vscode/src/remote-queries/sample-data.ts index 21b8c267ff1..58069ff47bd 100644 --- a/extensions/ql-vscode/src/remote-queries/sample-data.ts +++ b/extensions/ql-vscode/src/remote-queries/sample-data.ts @@ -99,7 +99,7 @@ export const sampleRemoteQueryResult: RemoteQueryResult = { }; -const createAnalysisResults = (n: number) => Array(n).fill( +const createAnalysisAlertResults = (n: number) => Array(n).fill( { message: 'This shell command depends on an uncontrolled [absolute path](1).', shortDescription: 'Shell command built from environment values', @@ -317,18 +317,18 @@ export const sampleAnalysesResultsStage1: AnalysisResults[] = [ { nwo: 'big-corp/repo1', status: 'InProgress', - results: [] + alertResults: [] }, { nwo: 'big-corp/repo2', status: 'InProgress', - results: [] + alertResults: [] }, { nwo: 'big-corp/repo3', status: 'InProgress', - results: [] + alertResults: [] }, // No entries for repo4 ]; @@ -337,22 +337,22 @@ export const sampleAnalysesResultsStage2: AnalysisResults[] = [ { nwo: 'big-corp/repo1', status: 'Completed', - results: createAnalysisResults(85) + alertResults: createAnalysisAlertResults(85) }, { nwo: 'big-corp/repo2', status: 'Completed', - results: createAnalysisResults(20) + alertResults: createAnalysisAlertResults(20) }, { nwo: 'big-corp/repo3', status: 'InProgress', - results: [] + alertResults: [] }, { nwo: 'big-corp/repo4', status: 'InProgress', - results: [] + alertResults: [] }, ]; @@ -360,22 +360,22 @@ export const sampleAnalysesResultsStage3: AnalysisResults[] = [ { nwo: 'big-corp/repo1', status: 'Completed', - results: createAnalysisResults(85) + alertResults: createAnalysisAlertResults(85) }, { nwo: 'big-corp/repo2', status: 'Completed', - results: createAnalysisResults(20) + alertResults: createAnalysisAlertResults(20) }, { nwo: 'big-corp/repo3', status: 'Completed', - results: createAnalysisResults(8) + alertResults: createAnalysisAlertResults(8) }, { nwo: 'big-corp/repo4', status: 'Completed', - results: createAnalysisResults(3) + alertResults: createAnalysisAlertResults(3) }, ]; @@ -383,21 +383,21 @@ export const sampleAnalysesResultsWithFailure: AnalysisResults[] = [ { nwo: 'big-corp/repo1', status: 'Completed', - results: createAnalysisResults(85) + alertResults: createAnalysisAlertResults(85) }, { nwo: 'big-corp/repo2', status: 'Completed', - results: createAnalysisResults(20) + alertResults: createAnalysisAlertResults(20) }, { nwo: 'big-corp/repo3', status: 'Failed', - results: [] + alertResults: [] }, { nwo: 'big-corp/repo4', status: 'Completed', - results: createAnalysisResults(3) + alertResults: createAnalysisAlertResults(3) }, ]; diff --git a/extensions/ql-vscode/src/remote-queries/shared/analysis-result.ts b/extensions/ql-vscode/src/remote-queries/shared/analysis-result.ts index 8a81ad3e1f5..30f54d2a16b 100644 --- a/extensions/ql-vscode/src/remote-queries/shared/analysis-result.ts +++ b/extensions/ql-vscode/src/remote-queries/shared/analysis-result.ts @@ -3,7 +3,7 @@ export type AnalysisResultStatus = 'InProgress' | 'Completed' | 'Failed'; export interface AnalysisResults { nwo: string; status: AnalysisResultStatus; - results: AnalysisAlert[]; + alertResults: AnalysisAlert[]; } export interface AnalysisAlert { diff --git a/extensions/ql-vscode/src/remote-queries/view/RemoteQueries.tsx b/extensions/ql-vscode/src/remote-queries/view/RemoteQueries.tsx index 44e7a3793cb..e66bc1a8d94 100644 --- a/extensions/ql-vscode/src/remote-queries/view/RemoteQueries.tsx +++ b/extensions/ql-vscode/src/remote-queries/view/RemoteQueries.tsx @@ -73,7 +73,7 @@ const openQueryTextVirtualFile = (queryResult: RemoteQueryResult) => { }; const sumAnalysesResults = (analysesResults: AnalysisResults[]) => - analysesResults.reduce((acc, curr) => acc + curr.results.length, 0); + analysesResults.reduce((acc, curr) => acc + curr.alertResults.length, 0); const QueryInfo = (queryResult: RemoteQueryResult) => ( <> @@ -264,13 +264,13 @@ const AnalysesResultsDescription = ({ totalAnalysesResults, totalResults }: { to const RepoAnalysisResults = (analysisResults: AnalysisResults) => { const title = <> {analysisResults.nwo} - + ; return (
    - {analysisResults.results.map((r, i) => + {analysisResults.alertResults.map((r, i) =>
  • @@ -297,7 +297,7 @@ const AnalysesResults = ({ analysesResults, totalResults }: { analysesResults: A totalAnalysesResults={totalAnalysesResults} totalResults={totalResults} />
      - {analysesResults.filter(a => a.results.length > 0).map(r => + {analysesResults.filter(a => a.alertResults.length > 0).map(r =>
      • )} From 29ceacaa14b10c35c8a101f3b234e1642692b68c Mon Sep 17 00:00:00 2001 From: Charis Kyriakou Date: Wed, 9 Mar 2022 15:26:01 +0000 Subject: [PATCH 2/3] Fix tests --- .../no-workspace/remote-query-history.test.ts | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/extensions/ql-vscode/src/vscode-tests/no-workspace/remote-query-history.test.ts b/extensions/ql-vscode/src/vscode-tests/no-workspace/remote-query-history.test.ts index b8839ee38f9..7eeef9ea3a2 100644 --- a/extensions/ql-vscode/src/vscode-tests/no-workspace/remote-query-history.test.ts +++ b/extensions/ql-vscode/src/vscode-tests/no-workspace/remote-query-history.test.ts @@ -211,14 +211,14 @@ describe('Remote queries and query history manager', function() { expect(publisher.getCall(0).args[0][0]).to.include({ nwo: 'github/vscode-codeql', status: 'InProgress', - // results: ... avoid checking the results object since it is complex + // alertResults: ... avoid checking the alertResults object since it is complex }); // second time, it has the path to the sarif file. expect(publisher.getCall(1).args[0][0]).to.include({ nwo: 'github/vscode-codeql', status: 'Completed', - // results: ... avoid checking the results object since it is complex + // alertResults: ... avoid checking the alertResults object since it is complex }); expect(publisher).to.have.been.calledTwice; @@ -226,7 +226,7 @@ describe('Remote queries and query history manager', function() { expect(arm.getAnalysesResults(rawQueryHistory[0].queryId)[0]).to.include({ nwo: 'github/vscode-codeql', status: 'Completed', - // results: ... avoid checking the results object since it is complex + // alertResults: ... avoid checking the alertResults object since it is complex }); publisher.resetHistory(); @@ -242,7 +242,7 @@ describe('Remote queries and query history manager', function() { await arm.downloadAnalysesResults(analysisSummaries, undefined, publisher); const trimmed = publisher.getCalls().map(call => call.args[0]).map(args => { - args.forEach((analysisResult: any) => delete analysisResult.results); + args.forEach((analysisResult: any) => delete analysisResult.alertResults); return args; }); From f6d95e984312b4c1bd2f48d9b0cc019ba09590a7 Mon Sep 17 00:00:00 2001 From: Charis Kyriakou Date: Wed, 9 Mar 2022 17:01:06 +0000 Subject: [PATCH 3/3] Rename alertResults to interpretedResults --- .../analyses-results-manager.ts | 4 +-- .../src/remote-queries/sample-data.ts | 32 +++++++++---------- .../remote-queries/shared/analysis-result.ts | 2 +- .../src/remote-queries/view/RemoteQueries.tsx | 8 ++--- .../no-workspace/remote-query-history.test.ts | 8 ++--- 5 files changed, 27 insertions(+), 27 deletions(-) diff --git a/extensions/ql-vscode/src/remote-queries/analyses-results-manager.ts b/extensions/ql-vscode/src/remote-queries/analyses-results-manager.ts index 74c415c00bd..5f82826158c 100644 --- a/extensions/ql-vscode/src/remote-queries/analyses-results-manager.ts +++ b/extensions/ql-vscode/src/remote-queries/analyses-results-manager.ts @@ -101,7 +101,7 @@ export class AnalysesResultsManager { const analysisResults: AnalysisResults = { nwo: analysis.nwo, status: 'InProgress', - alertResults: [] + interpretedResults: [] }; const queryId = analysis.downloadLink.queryId; const resultsForQuery = this.internalGetAnalysesResults(queryId); @@ -123,7 +123,7 @@ export class AnalysesResultsManager { const queryResults = await this.readResults(artifactPath); newAnaysisResults = { ...analysisResults, - alertResults: queryResults, + interpretedResults: queryResults, status: 'Completed' }; } else { diff --git a/extensions/ql-vscode/src/remote-queries/sample-data.ts b/extensions/ql-vscode/src/remote-queries/sample-data.ts index 58069ff47bd..f0f85b8219c 100644 --- a/extensions/ql-vscode/src/remote-queries/sample-data.ts +++ b/extensions/ql-vscode/src/remote-queries/sample-data.ts @@ -99,7 +99,7 @@ export const sampleRemoteQueryResult: RemoteQueryResult = { }; -const createAnalysisAlertResults = (n: number) => Array(n).fill( +const createAnalysisInterpretedResults = (n: number) => Array(n).fill( { message: 'This shell command depends on an uncontrolled [absolute path](1).', shortDescription: 'Shell command built from environment values', @@ -317,18 +317,18 @@ export const sampleAnalysesResultsStage1: AnalysisResults[] = [ { nwo: 'big-corp/repo1', status: 'InProgress', - alertResults: [] + interpretedResults: [] }, { nwo: 'big-corp/repo2', status: 'InProgress', - alertResults: [] + interpretedResults: [] }, { nwo: 'big-corp/repo3', status: 'InProgress', - alertResults: [] + interpretedResults: [] }, // No entries for repo4 ]; @@ -337,22 +337,22 @@ export const sampleAnalysesResultsStage2: AnalysisResults[] = [ { nwo: 'big-corp/repo1', status: 'Completed', - alertResults: createAnalysisAlertResults(85) + interpretedResults: createAnalysisInterpretedResults(85) }, { nwo: 'big-corp/repo2', status: 'Completed', - alertResults: createAnalysisAlertResults(20) + interpretedResults: createAnalysisInterpretedResults(20) }, { nwo: 'big-corp/repo3', status: 'InProgress', - alertResults: [] + interpretedResults: [] }, { nwo: 'big-corp/repo4', status: 'InProgress', - alertResults: [] + interpretedResults: [] }, ]; @@ -360,22 +360,22 @@ export const sampleAnalysesResultsStage3: AnalysisResults[] = [ { nwo: 'big-corp/repo1', status: 'Completed', - alertResults: createAnalysisAlertResults(85) + interpretedResults: createAnalysisInterpretedResults(85) }, { nwo: 'big-corp/repo2', status: 'Completed', - alertResults: createAnalysisAlertResults(20) + interpretedResults: createAnalysisInterpretedResults(20) }, { nwo: 'big-corp/repo3', status: 'Completed', - alertResults: createAnalysisAlertResults(8) + interpretedResults: createAnalysisInterpretedResults(8) }, { nwo: 'big-corp/repo4', status: 'Completed', - alertResults: createAnalysisAlertResults(3) + interpretedResults: createAnalysisInterpretedResults(3) }, ]; @@ -383,21 +383,21 @@ export const sampleAnalysesResultsWithFailure: AnalysisResults[] = [ { nwo: 'big-corp/repo1', status: 'Completed', - alertResults: createAnalysisAlertResults(85) + interpretedResults: createAnalysisInterpretedResults(85) }, { nwo: 'big-corp/repo2', status: 'Completed', - alertResults: createAnalysisAlertResults(20) + interpretedResults: createAnalysisInterpretedResults(20) }, { nwo: 'big-corp/repo3', status: 'Failed', - alertResults: [] + interpretedResults: [] }, { nwo: 'big-corp/repo4', status: 'Completed', - alertResults: createAnalysisAlertResults(3) + interpretedResults: createAnalysisInterpretedResults(3) }, ]; diff --git a/extensions/ql-vscode/src/remote-queries/shared/analysis-result.ts b/extensions/ql-vscode/src/remote-queries/shared/analysis-result.ts index 30f54d2a16b..ebcf63ae668 100644 --- a/extensions/ql-vscode/src/remote-queries/shared/analysis-result.ts +++ b/extensions/ql-vscode/src/remote-queries/shared/analysis-result.ts @@ -3,7 +3,7 @@ export type AnalysisResultStatus = 'InProgress' | 'Completed' | 'Failed'; export interface AnalysisResults { nwo: string; status: AnalysisResultStatus; - alertResults: AnalysisAlert[]; + interpretedResults: AnalysisAlert[]; } export interface AnalysisAlert { diff --git a/extensions/ql-vscode/src/remote-queries/view/RemoteQueries.tsx b/extensions/ql-vscode/src/remote-queries/view/RemoteQueries.tsx index e66bc1a8d94..c1f49d83054 100644 --- a/extensions/ql-vscode/src/remote-queries/view/RemoteQueries.tsx +++ b/extensions/ql-vscode/src/remote-queries/view/RemoteQueries.tsx @@ -73,7 +73,7 @@ const openQueryTextVirtualFile = (queryResult: RemoteQueryResult) => { }; const sumAnalysesResults = (analysesResults: AnalysisResults[]) => - analysesResults.reduce((acc, curr) => acc + curr.alertResults.length, 0); + analysesResults.reduce((acc, curr) => acc + curr.interpretedResults.length, 0); const QueryInfo = (queryResult: RemoteQueryResult) => ( <> @@ -264,13 +264,13 @@ const AnalysesResultsDescription = ({ totalAnalysesResults, totalResults }: { to const RepoAnalysisResults = (analysisResults: AnalysisResults) => { const title = <> {analysisResults.nwo} - + ; return (
        - {analysisResults.alertResults.map((r, i) => + {analysisResults.interpretedResults.map((r, i) =>
      • @@ -297,7 +297,7 @@ const AnalysesResults = ({ analysesResults, totalResults }: { analysesResults: A totalAnalysesResults={totalAnalysesResults} totalResults={totalResults} />
          - {analysesResults.filter(a => a.alertResults.length > 0).map(r => + {analysesResults.filter(a => a.interpretedResults.length > 0).map(r =>
          • )} diff --git a/extensions/ql-vscode/src/vscode-tests/no-workspace/remote-query-history.test.ts b/extensions/ql-vscode/src/vscode-tests/no-workspace/remote-query-history.test.ts index 7eeef9ea3a2..3f0d12ea8e4 100644 --- a/extensions/ql-vscode/src/vscode-tests/no-workspace/remote-query-history.test.ts +++ b/extensions/ql-vscode/src/vscode-tests/no-workspace/remote-query-history.test.ts @@ -211,14 +211,14 @@ describe('Remote queries and query history manager', function() { expect(publisher.getCall(0).args[0][0]).to.include({ nwo: 'github/vscode-codeql', status: 'InProgress', - // alertResults: ... avoid checking the alertResults object since it is complex + // interpretedResults: ... avoid checking the interpretedResults object since it is complex }); // second time, it has the path to the sarif file. expect(publisher.getCall(1).args[0][0]).to.include({ nwo: 'github/vscode-codeql', status: 'Completed', - // alertResults: ... avoid checking the alertResults object since it is complex + // interpretedResults: ... avoid checking the interpretedResults object since it is complex }); expect(publisher).to.have.been.calledTwice; @@ -226,7 +226,7 @@ describe('Remote queries and query history manager', function() { expect(arm.getAnalysesResults(rawQueryHistory[0].queryId)[0]).to.include({ nwo: 'github/vscode-codeql', status: 'Completed', - // alertResults: ... avoid checking the alertResults object since it is complex + // interpretedResults: ... avoid checking the interpretedResults object since it is complex }); publisher.resetHistory(); @@ -242,7 +242,7 @@ describe('Remote queries and query history manager', function() { await arm.downloadAnalysesResults(analysisSummaries, undefined, publisher); const trimmed = publisher.getCalls().map(call => call.args[0]).map(args => { - args.forEach((analysisResult: any) => delete analysisResult.alertResults); + args.forEach((analysisResult: any) => delete analysisResult.interpretedResults); return args; });