Only fire _onVariantAnalysisChange from one place

Author: robertbrignull

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

@@ -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',

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

@@ -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,46 +36,38 @@ 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.' };
       }
 
-      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);
+      variantAnalysis = processUpdatedVariantAnalysis(variantAnalysis, variantAnalysisSummary);
 
-        this._onVariantAnalysisChange.fire(variantAnalysis);
+      this._onVariantAnalysisChange.fire(variantAnalysis);
 
+      if (variantAnalysis.failureReason) {
         return {
           status: 'Failed',
-          error: `Variant Analysis has failed: ${variantAnalysisSummary.failure_reason}`,
+          error: `Variant Analysis has failed: ${variantAnalysis.failureReason}`,
           variantAnalysis: variantAnalysis
         };
       }
 
-      variantAnalysis = processUpdatedVariantAnalysis(variantAnalysis, variantAnalysisSummary);
-
-      this._onVariantAnalysisChange.fire(variantAnalysis);
-
       const downloadedRepos = this.downloadVariantAnalysisResults(variantAnalysisSummary, scannedReposDownloaded);
       scannedReposDownloaded.push(...downloadedRepos);
 
-      if (variantAnalysisSummary.status === 'completed') {
+      if (isFinalVariantAnalysisStatus(variantAnalysis.status)) {
         break;
       }