Handle errors when downloading database

Author: koesie10

extensions/ql-vscode/src/local-queries/local-queries.ts

@@ -330,7 +330,7 @@ export class LocalQueries extends DisposableObject {
           this.cliServer,
           progress,
           credentials,
-          this.app.logger,
+          this.app,
           this.databaseManager,
           contextStoragePath,
           language,

extensions/ql-vscode/src/local-queries/skeleton-query-wizard.ts

@@ -1,14 +1,14 @@
 import { join } from "path";
 import { Uri, window as Window, window, workspace } from "vscode";
 import { CodeQLCliServer } from "../codeql-cli/cli";
-import { BaseLogger } from "../common/logging";
+import { showAndLogExceptionWithTelemetry } from "../common/logging";
 import { Credentials } from "../common/authentication";
 import { QueryLanguage } from "../common/query-language";
 import {
   getFirstWorkspaceFolder,
   isFolderAlreadyInWorkspace,
 } from "../common/vscode/workspace-folders";
-import { getErrorMessage } from "../common/helpers-pure";
+import { asError, getErrorMessage } from "../common/helpers-pure";
 import { QlPackGenerator } from "./qlpack-generator";
 import { DatabaseItem, DatabaseManager } from "../databases/local-databases";
 import {
@@ -28,6 +28,8 @@ import {
 import { existsSync } from "fs-extra";
 import { askForLanguage } from "../codeql-cli/query-language";
 import { showInformationMessageWithAction } from "../common/vscode/dialog";
+import { redactableError } from "../common/errors";
+import { App } from "../common/app";
 
 type QueryLanguagesToDatabaseMap = Record<string, string>;
 
@@ -51,7 +53,7 @@ export class SkeletonQueryWizard {
     private readonly cliServer: CodeQLCliServer,
     private readonly progress: ProgressCallback,
     private readonly credentials: Credentials | undefined,
-    private readonly logger: BaseLogger,
+    private readonly app: App,
     private readonly databaseManager: DatabaseManager,
     private readonly databaseStoragePath: string | undefined,
     private language: QueryLanguage | undefined = undefined,
@@ -99,7 +101,7 @@ export class SkeletonQueryWizard {
     try {
       await this.openExampleFile();
     } catch (e: unknown) {
-      void this.logger.log(
+      void this.app.logger.log(
         `Could not open example query file: ${getErrorMessage(e)}`,
       );
     }
@@ -190,7 +192,7 @@ export class SkeletonQueryWizard {
 
       await qlPackGenerator.generate();
     } catch (e: unknown) {
-      void this.logger.log(
+      void this.app.logger.log(
         `Could not create skeleton QL pack: ${getErrorMessage(e)}`,
       );
     }
@@ -222,7 +224,7 @@ export class SkeletonQueryWizard {
       this.fileName = await this.determineNextFileName(this.folderName);
       await qlPackGenerator.createExampleQlFile(this.fileName);
     } catch (e: unknown) {
-      void this.logger.log(
+      void this.app.logger.log(
         `Could not create skeleton QL pack: ${getErrorMessage(e)}`,
       );
     }
@@ -255,7 +257,25 @@ export class SkeletonQueryWizard {
     );
 
     if (action) {
-      void withProgress((progress) => this.downloadDatabase(progress));
+      void withProgress(async (progress) => {
+        try {
+          await this.downloadDatabase(progress);
+        } catch (e: unknown) {
+          if (e instanceof UserCancellationException) {
+            return;
+          }
+
+          void showAndLogExceptionWithTelemetry(
+            this.app.logger,
+            this.app.telemetry,
+            redactableError(
+              asError(e),
+            )`An error occurred while downloading the GitHub repository: ${getErrorMessage(
+              e,
+            )}`,
+          );
+        }
+      });
     }
   }
 

extensions/ql-vscode/test/__mocks__/appMock.ts

@@ -34,7 +34,7 @@ export function createMockApp({
   environment?: EnvironmentContext;
   logger?: NotificationLogger;
   telemetry?: AppTelemetry;
-}): App {
+} = {}): App {
   return {
     mode: AppMode.Test,
     logger,

extensions/ql-vscode/test/vscode-tests/cli-integration/local-queries/skeleton-query-wizard.test.ts

@@ -12,7 +12,6 @@ import {
   workspace,
   WorkspaceFolder,
 } from "vscode";
-import { extLogger } from "../../../../src/common/logging/vscode";
 import { QlPackGenerator } from "../../../../src/local-queries/qlpack-generator";
 import * as workspaceFolders from "../../../../src/common/vscode/workspace-folders";
 import { createFileSync, ensureDirSync, removeSync } from "fs-extra";
@@ -28,9 +27,12 @@ import { createMockDB } from "../../../factories/databases/databases";
 import { asError } from "../../../../src/common/helpers-pure";
 import { Setting } from "../../../../src/config";
 import { QueryLanguage } from "../../../../src/common/query-language";
+import { App } from "../../../../src/common/app";
+import { createMockApp } from "../../../__mocks__/appMock";
 
 describe("SkeletonQueryWizard", () => {
   let mockCli: CodeQLCliServer;
+  let mockApp: App;
   let wizard: SkeletonQueryWizard;
   let mockDatabaseManager: DatabaseManager;
   let dir: tmp.DirResult;
@@ -59,8 +61,6 @@ describe("SkeletonQueryWizard", () => {
   const credentials = testCredentialsWithStub();
   const chosenLanguage = "ruby";
 
-  jest.spyOn(extLogger, "log").mockResolvedValue(undefined);
-
   beforeEach(async () => {
     mockCli = mockedObject<CodeQLCliServer>({
       resolveLanguages: jest
@@ -76,6 +76,7 @@ describe("SkeletonQueryWizard", () => {
         ]),
       getSupportedLanguages: jest.fn(),
     });
+    mockApp = createMockApp();
 
     mockDatabaseManager = mockedObject<DatabaseManager>({
       setCurrentDatabaseItem: jest.fn(),
@@ -126,7 +127,7 @@ describe("SkeletonQueryWizard", () => {
       mockCli,
       jest.fn(),
       credentials,
-      extLogger,
+      mockApp,
       mockDatabaseManager,
       storagePath,
     );
@@ -153,7 +154,7 @@ describe("SkeletonQueryWizard", () => {
         mockCli,
         jest.fn(),
         credentials,
-        extLogger,
+        mockApp,
         mockDatabaseManager,
         storagePath,
         QueryLanguage.Swift,
@@ -308,7 +309,7 @@ describe("SkeletonQueryWizard", () => {
             mockCli,
             jest.fn(),
             credentials,
-            extLogger,
+            mockApp,
             mockDatabaseManagerWithItems,
             storagePath,
           );
@@ -357,7 +358,7 @@ describe("SkeletonQueryWizard", () => {
             mockCli,
             jest.fn(),
             credentials,
-            extLogger,
+            mockApp,
             mockDatabaseManagerWithItems,
             storagePath,
           );