mrva/vscode-codeql
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

Merge pull request #1690 from github/robertbrignull/handle_states_monitoring

Browse Source 
Make the monitoring command slightly simpler and handle being called on any variant analysis
This commit is contained in:
Robert
2022-11-02 09:33:37 +00:00
committed by GitHub
parent 4cc423217d cc955c70f9
commit 36754a8a10
6 changed files with 30 additions and 47 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
extensions/ql-vscode/src/remote-queries/shared/variant-analysis-monitor-result.ts
View File

@@ -1,16 +1,11 @@
import { VariantAnalysis } from './variant-analysis';
export type VariantAnalysisMonitorStatus =
| 'InProgress'
| 'CompletedSuccessfully'
| 'CompletedUnsuccessfully'
| 'Failed'
| 'Cancelled'
| 'TimedOut';
| 'Completed'
| 'Canceled';
export interface VariantAnalysisMonitorResult {
status: VariantAnalysisMonitorStatus;
error?: string;
scannedReposDownloaded?: number[],
variantAnalysis?: VariantAnalysis
}

7
extensions/ql-vscode/src/remote-queries/shared/variant-analysis.ts
View File

@@ -47,6 +47,13 @@ export enum VariantAnalysisStatus {
Canceled = 'canceled',
}
export function isFinalVariantAnalysisStatus(status: VariantAnalysisStatus): boolean {
return [
// All states that indicates the analysis has completed and cannot change status anymore.
VariantAnalysisStatus.Succeeded, VariantAnalysisStatus.Failed, VariantAnalysisStatus.Canceled,
].includes(status);
}
export enum VariantAnalysisFailureReason {
NoReposQueried = 'noReposQueried',
InternalError = 'internalError',

28
extensions/ql-vscode/src/remote-queries/variant-analysis-monitor.ts
View File

@@ -2,13 +2,13 @@ import { ExtensionContext, CancellationToken, commands, EventEmitter } from 'vsc
import { Credentials } from '../authentication';
import * as ghApiClient from './gh-api/gh-api-client';
import { VariantAnalysis, VariantAnalysisStatus } from './shared/variant-analysis';
import { isFinalVariantAnalysisStatus, VariantAnalysis } from './shared/variant-analysis';
import {
VariantAnalysis as VariantAnalysisApiResponse,
VariantAnalysisScannedRepository
} from './gh-api/variant-analysis';
import { VariantAnalysisMonitorResult } from './shared/variant-analysis-monitor-result';
import { processFailureReason, processUpdatedVariantAnalysis } from './variant-analysis-processor';
import { processUpdatedVariantAnalysis } from './variant-analysis-processor';
import { DisposableObject } from '../pure/disposable-object';
export class VariantAnalysisMonitor extends DisposableObject {
@@ -36,38 +36,22 @@ export class VariantAnalysisMonitor extends DisposableObject {
throw Error('Error authenticating with GitHub');
}
let variantAnalysisSummary: VariantAnalysisApiResponse;
let attemptCount = 0;
const scannedReposDownloaded: number[] = [];
this._onVariantAnalysisChange.fire(variantAnalysis);
while (attemptCount <= VariantAnalysisMonitor.maxAttemptCount) {
await this.sleep(VariantAnalysisMonitor.sleepTime);
if (cancellationToken && cancellationToken.isCancellationRequested) {
return { status: 'Cancelled', error: 'Variant Analysis was canceled.' };
return { status: 'Canceled' };
}
variantAnalysisSummary = await ghApiClient.getVariantAnalysis(
const variantAnalysisSummary = await ghApiClient.getVariantAnalysis(
credentials,
variantAnalysis.controllerRepo.id,
variantAnalysis.id
);
if (variantAnalysisSummary.failure_reason) {
variantAnalysis.status = VariantAnalysisStatus.Failed;
variantAnalysis.failureReason = processFailureReason(variantAnalysisSummary.failure_reason);
this._onVariantAnalysisChange.fire(variantAnalysis);
return {
status: 'Failed',
error: `Variant Analysis has failed: ${variantAnalysisSummary.failure_reason}`,
variantAnalysis: variantAnalysis
};
}
variantAnalysis = processUpdatedVariantAnalysis(variantAnalysis, variantAnalysisSummary);
this._onVariantAnalysisChange.fire(variantAnalysis);
@@ -75,14 +59,14 @@ export class VariantAnalysisMonitor extends DisposableObject {
const downloadedRepos = this.downloadVariantAnalysisResults(variantAnalysisSummary, scannedReposDownloaded);
scannedReposDownloaded.push(...downloadedRepos);
if (variantAnalysisSummary.status === 'completed') {
if (isFinalVariantAnalysisStatus(variantAnalysis.status) || variantAnalysis.failureReason) {
break;
}
attemptCount++;
}
return { status: 'CompletedSuccessfully', scannedReposDownloaded: scannedReposDownloaded };
return { status: 'Completed', scannedReposDownloaded, variantAnalysis };
}
private scheduleForDownload(

15
extensions/ql-vscode/src/remote-queries/variant-analysis-processor.ts
View File

@@ -62,7 +62,7 @@ export function processUpdatedVariantAnalysis(
executionStartTime: previousVariantAnalysis.executionStartTime,
createdAt: response.created_at,
updatedAt: response.updated_at,
status: processApiStatus(response.status),
status: processApiStatus(response.status, response.failure_reason),
completedAt: response.completed_at,
actionsWorkflowRunId: response.actions_workflow_run_id,
scannedRepos: scannedRepos,
@@ -158,12 +158,13 @@ function processApiRepoStatus(analysisStatus: ApiVariantAnalysisRepoStatus): Var
}
}
function processApiStatus(status: ApiVariantAnalysisStatus): VariantAnalysisStatus {
switch (status) {
case 'in_progress':
return VariantAnalysisStatus.InProgress;
case 'completed':
return VariantAnalysisStatus.Succeeded;
function processApiStatus(status: ApiVariantAnalysisStatus, failureReason: string | undefined): VariantAnalysisStatus {
if (status === 'in_progress') {
return VariantAnalysisStatus.InProgress;
} else if (failureReason !== undefined) {
return VariantAnalysisStatus.Failed;
} else {
return VariantAnalysisStatus.Succeeded;
}
}

13
extensions/ql-vscode/src/vscode-tests/cli-integration/remote-queries/variant-analysis-monitor.test.ts
View File

@@ -83,14 +83,14 @@ describe('Variant Analysis Monitor', async function() {
const result = await variantAnalysisMonitor.monitorVariantAnalysis(variantAnalysis, cancellationTokenSource.token);
expect(result).to.eql({ status: 'Cancelled', error: 'Variant Analysis was canceled.' });
expect(result).to.eql({ status: 'Canceled' });
});
describe('when the variant analysis fails', async () => {
let mockFailedApiResponse: VariantAnalysisApiResponse;
beforeEach(async function() {
mockFailedApiResponse = createFailedMockApiResponse('in_progress');
mockFailedApiResponse = createFailedMockApiResponse();
mockGetVariantAnalysis = sandbox.stub(ghApiClient, 'getVariantAnalysis').resolves(mockFailedApiResponse);
});
@@ -98,8 +98,7 @@ describe('Variant Analysis Monitor', async function() {
const result = await variantAnalysisMonitor.monitorVariantAnalysis(variantAnalysis, cancellationTokenSource.token);
expect(mockGetVariantAnalysis.calledOnce).to.be.true;
expect(result.status).to.eql('Failed');
expect(result.error).to.eql(`Variant Analysis has failed: ${mockFailedApiResponse.failure_reason}`);
expect(result.status).to.eql('Completed');
expect(result.variantAnalysis?.status).to.equal(VariantAnalysisStatus.Failed);
expect(result.variantAnalysis?.failureReason).to.equal(processFailureReason(mockFailedApiResponse.failure_reason as VariantAnalysisFailureReason));
});
@@ -130,7 +129,7 @@ describe('Variant Analysis Monitor', async function() {
it('should succeed and return a list of scanned repo ids', async () => {
const result = await variantAnalysisMonitor.monitorVariantAnalysis(variantAnalysis, cancellationTokenSource.token);
expect(result.status).to.equal('CompletedSuccessfully');
expect(result.status).to.equal('Completed');
expect(result.scannedReposDownloaded).to.eql(succeededRepos.map(r => r.repository.id));
});
@@ -173,7 +172,7 @@ describe('Variant Analysis Monitor', async function() {
it('should succeed and return an empty list of scanned repo ids', async () => {
const result = await variantAnalysisMonitor.monitorVariantAnalysis(variantAnalysis, cancellationTokenSource.token);
expect(result.status).to.equal('CompletedSuccessfully');
expect(result.status).to.equal('Completed');
expect(result.scannedReposDownloaded).to.eql([]);
});
@@ -194,7 +193,7 @@ describe('Variant Analysis Monitor', async function() {
it('should succeed and return an empty list of scanned repo ids', async () => {
const result = await variantAnalysisMonitor.monitorVariantAnalysis(variantAnalysis, cancellationTokenSource.token);
expect(result.status).to.equal('CompletedSuccessfully');
expect(result.status).to.equal('Completed');
expect(result.scannedReposDownloaded).to.eql([]);
});

5
extensions/ql-vscode/src/vscode-tests/factories/remote-queries/gh-api/variant-analysis-api-response.ts
View File

@@ -39,13 +39,10 @@ export function createMockApiResponse(
}
export function createFailedMockApiResponse(
status: VariantAnalysisStatus = 'in_progress',
scannedRepos: VariantAnalysisScannedRepository[] = createMockScannedRepos(),
skippedRepos: VariantAnalysisSkippedRepositories = createMockSkippedRepos(),
): VariantAnalysisApiResponse {
const variantAnalysis = createMockApiResponse(status, scannedRepos, skippedRepos);
variantAnalysis.status = status;
const variantAnalysis = createMockApiResponse('completed', scannedRepos, skippedRepos);
variantAnalysis.failure_reason = 'internal_error';
return variantAnalysis;
}