Merge pull request #2230 from github/robertbrignull/activate_extension

Use undefined instead of Record<string, never> type when unable to activate extension

Author: robertbrignull

extensions/ql-vscode/src/extension.ts

@@ -289,7 +289,7 @@ const MIN_VERSION = "1.67.0";
  */
 export async function activate(
   ctx: ExtensionContext,
-): Promise<CodeQLExtensionInterface | Record<string, never>> {
+): Promise<CodeQLExtensionInterface | undefined> {
   void extLogger.log(`Starting ${extensionId} extension`);
   if (extension === undefined) {
     throw new Error(`Can't find extension ${extensionId}`);
@@ -379,9 +379,11 @@ export async function activate(
     },
   );
 
-  variantAnalysisViewSerializer.onExtensionLoaded(
-    codeQlExtension.variantAnalysisManager,
-  );
+  if (codeQlExtension !== undefined) {
+    variantAnalysisViewSerializer.onExtensionLoaded(
+      codeQlExtension.variantAnalysisManager,
+    );
+  }
 
   return codeQlExtension;
 }
@@ -571,7 +573,7 @@ async function installOrUpdateThenTryActivate(
   distributionManager: DistributionManager,
   distributionConfigListener: DistributionConfigListener,
   config: DistributionUpdateConfig,
-): Promise<CodeQLExtensionInterface | Record<string, never>> {
+): Promise<CodeQLExtensionInterface | undefined> {
   await installOrUpdateDistribution(ctx, app, distributionManager, config);
 
   try {
@@ -585,20 +587,19 @@ async function installOrUpdateThenTryActivate(
   // Display the warnings even if the extension has already activated.
   const distributionResult =
     await getDistributionDisplayingDistributionWarnings(distributionManager);
-  let extensionInterface: CodeQLExtensionInterface | Record<string, never> = {};
   if (
     !beganMainExtensionActivation &&
     distributionResult.kind !== FindDistributionResultKind.NoDistribution
   ) {
-    extensionInterface = await activateWithInstalledDistribution(
+    return await activateWithInstalledDistribution(
       ctx,
       app,
       distributionManager,
       distributionConfigListener,
     );
-  } else if (
-    distributionResult.kind === FindDistributionResultKind.NoDistribution
-  ) {
+  }
+
+  if (distributionResult.kind === FindDistributionResultKind.NoDistribution) {
     registerErrorStubs([checkForUpdatesCommand], (command) => async () => {
       const installActionName = "Install CodeQL CLI";
       const chosenAction = await showAndLogErrorMessage(
@@ -622,7 +623,7 @@ async function installOrUpdateThenTryActivate(
       }
     });
   }
-  return extensionInterface;
+  return undefined;
 }
 
 const PACK_GLOBS = [

extensions/ql-vscode/test/vscode-tests/activated-extension/databases/db-panel.test.ts

@@ -1,6 +1,5 @@
-import { commands, extensions, window } from "vscode";
+import { commands, window } from "vscode";
 
-import { CodeQLExtensionInterface } from "../../../../src/extension";
 import { readJson } from "fs-extra";
 import * as path from "path";
 import {
@@ -15,19 +14,15 @@ import { DbListKind } from "../../../../src/databases/db-item";
 import { createDbTreeViewItemSystemDefinedList } from "../../../../src/databases/ui/db-tree-view-item";
 import { createRemoteSystemDefinedListDbItem } from "../../../factories/db-item-factories";
 import { DbConfigStore } from "../../../../src/databases/config/db-config-store";
+import { getActivatedExtension } from "../../global.helper";
 
 jest.setTimeout(60_000);
 
 describe("Db panel UI commands", () => {
-  let extension: CodeQLExtensionInterface | Record<string, never>;
   let storagePath: string;
 
   beforeEach(async () => {
-    extension = await extensions
-      .getExtension<CodeQLExtensionInterface | Record<string, never>>(
-        "GitHub.vscode-codeql",
-      )!
-      .activate();
+    const extension = await getActivatedExtension();
 
     storagePath =
       extension.ctx.storageUri?.fsPath || extension.ctx.globalStorageUri.fsPath;

extensions/ql-vscode/test/vscode-tests/activated-extension/variant-analysis/variant-analysis-manager.test.ts

@@ -1,14 +1,12 @@
 import {
   commands,
   env,
-  extensions,
   TextDocument,
   TextEditor,
   Uri,
   window,
   workspace,
 } from "vscode";
-import { CodeQLExtensionInterface } from "../../../../src/extension";
 import { extLogger } from "../../../../src/common";
 import * as ghApiClient from "../../../../src/variant-analysis/gh-api/gh-api-client";
 import * as ghActionsApiClient from "../../../../src/variant-analysis/gh-api/gh-actions-api-client";
@@ -20,7 +18,7 @@ import { Response } from "node-fetch";
 
 import { VariantAnalysisManager } from "../../../../src/variant-analysis/variant-analysis-manager";
 import { CodeQLCliServer } from "../../../../src/cli";
-import { storagePath } from "../../global.helper";
+import { getActivatedExtension, storagePath } from "../../global.helper";
 import { VariantAnalysisResultsManager } from "../../../../src/variant-analysis/variant-analysis-results-manager";
 import { createMockVariantAnalysis } from "../../../factories/variant-analysis/shared/variant-analysis";
 import * as VariantAnalysisModule from "../../../../src/variant-analysis/shared/variant-analysis";
@@ -67,11 +65,7 @@ describe("Variant Analysis Manager", () => {
       scannedRepos,
     });
 
-    const extension = await extensions
-      .getExtension<CodeQLExtensionInterface | Record<string, never>>(
-        "GitHub.vscode-codeql",
-      )!
-      .activate();
+    const extension = await getActivatedExtension();
     const cli = mockedObject<CodeQLCliServer>({});
     app = new ExtensionApp(extension.ctx);
     const dbManager = new DbManager(app, new DbConfigStore(app));

extensions/ql-vscode/test/vscode-tests/activated-extension/variant-analysis/variant-analysis-monitor.test.ts

@@ -1,5 +1,4 @@
-import { commands, extensions } from "vscode";
-import { CodeQLExtensionInterface } from "../../../../src/extension";
+import { commands } from "vscode";
 
 import * as ghApiClient from "../../../../src/variant-analysis/gh-api/gh-api-client";
 import { VariantAnalysisMonitor } from "../../../../src/variant-analysis/variant-analysis-monitor";
@@ -25,11 +24,11 @@ import {
 import { createMockVariantAnalysis } from "../../../factories/variant-analysis/shared/variant-analysis";
 import { VariantAnalysisManager } from "../../../../src/variant-analysis/variant-analysis-manager";
 import { testCredentialsWithStub } from "../../../factories/authentication";
+import { getActivatedExtension } from "../../global.helper";
 
 jest.setTimeout(60_000);
 
 describe("Variant Analysis Monitor", () => {
-  let extension: CodeQLExtensionInterface | Record<string, never>;
   let mockGetVariantAnalysis: jest.SpiedFunction<
     typeof ghApiClient.getVariantAnalysis
   >;
@@ -48,11 +47,7 @@ describe("Variant Analysis Monitor", () => {
 
     shouldCancelMonitor = jest.fn();
 
-    extension = await extensions
-      .getExtension<CodeQLExtensionInterface | Record<string, never>>(
-        "GitHub.vscode-codeql",
-      )!
-      .activate();
+    const extension = await getActivatedExtension();
     variantAnalysisMonitor = new VariantAnalysisMonitor(shouldCancelMonitor);
     variantAnalysisMonitor.onVariantAnalysisChange(onVariantAnalysisChangeSpy);
 

extensions/ql-vscode/test/vscode-tests/cli-integration/databaseFetcher.test.ts

@@ -1,14 +1,19 @@
 import { join } from "path";
-import { extensions, CancellationToken, Uri, window } from "vscode";
+import { CancellationToken, Uri, window } from "vscode";
 
-import { CodeQLExtensionInterface } from "../../../src/extension";
 import { CodeQLCliServer } from "../../../src/cli";
 import { DatabaseManager } from "../../../src/local-databases";
 import {
   importArchiveDatabase,
   promptImportInternetDatabase,
 } from "../../../src/databaseFetcher";
-import { cleanDatabases, dbLoc, DB_URL, storagePath } from "../global.helper";
+import {
+  cleanDatabases,
+  dbLoc,
+  DB_URL,
+  getActivatedExtension,
+  storagePath,
+} from "../global.helper";
 import { createMockCommandManager } from "../../__mocks__/commandsMock";
 
 jest.setTimeout(60_000);
@@ -30,18 +35,8 @@ describe("DatabaseFetcher", () => {
     jest.spyOn(window, "showErrorMessage").mockResolvedValue(undefined);
     jest.spyOn(window, "showInformationMessage").mockResolvedValue(undefined);
 
-    const extension = await extensions
-      .getExtension<CodeQLExtensionInterface | Record<string, never>>(
-        "GitHub.vscode-codeql",
-      )!
-      .activate();
-    if ("databaseManager" in extension) {
-      databaseManager = extension.databaseManager;
-    } else {
-      throw new Error(
-        "Extension not initialized. Make sure cli is downloaded and installed properly.",
-      );
-    }
+    const extension = await getActivatedExtension();
+    databaseManager = extension.databaseManager;
 
     await cleanDatabases(databaseManager);
   });

extensions/ql-vscode/test/vscode-tests/cli-integration/helpers.test.ts

@@ -1,9 +1,8 @@
 import { join } from "path";
-import { extensions } from "vscode";
 
 import { CodeQLCliServer } from "../../../src/cli";
-import { CodeQLExtensionInterface } from "../../../src/extension";
 import { tryGetQueryMetadata } from "../../../src/helpers";
+import { getActivatedExtension } from "../global.helper";
 
 // up to 3 minutes per test
 jest.setTimeout(3 * 60 * 1000);
@@ -14,18 +13,8 @@ describe("helpers (with CLI)", () => {
   let cli: CodeQLCliServer;
 
   beforeEach(async () => {
-    const extension = await extensions
-      .getExtension<CodeQLExtensionInterface | Record<string, never>>(
-        "GitHub.vscode-codeql",
-      )!
-      .activate();
-    if ("cliServer" in extension) {
-      cli = extension.cliServer;
-    } else {
-      throw new Error(
-        "Extension not initialized. Make sure cli is downloaded and installed properly.",
-      );
-    }
+    const extension = await getActivatedExtension();
+    cli = extension.cliServer;
   });
 
   it("should get query metadata when available", async () => {

extensions/ql-vscode/test/vscode-tests/cli-integration/legacy-query.test.ts

@@ -7,12 +7,11 @@ import * as messages from "../../../src/pure/legacy-messages";
 import * as qsClient from "../../../src/legacy-query-server/queryserver-client";
 import * as cli from "../../../src/cli";
 import { CellValue } from "../../../src/pure/bqrs-cli-types";
-import { extensions } from "vscode";
-import { CodeQLExtensionInterface } from "../../../src/extension";
 import { describeWithCodeQL } from "../cli";
 import { QueryServerClient } from "../../../src/legacy-query-server/queryserver-client";
 import { extLogger, ProgressReporter } from "../../../src/common";
 import { createMockApp } from "../../__mocks__/appMock";
+import { getActivatedExtension } from "../global.helper";
 
 const baseDir = join(__dirname, "../../../test/data");
 
@@ -112,41 +111,30 @@ describeWithCodeQL()("using the legacy query server", () => {
   let cliServer: cli.CodeQLCliServer;
 
   beforeAll(async () => {
-    const extension = await extensions
-      .getExtension<CodeQLExtensionInterface | Record<string, never>>(
-        "GitHub.vscode-codeql",
-      )!
-      .activate();
-    if ("cliServer" in extension) {
-      cliServer = extension.cliServer;
-      cliServer.quiet = true;
-
-      qs = new QueryServerClient(
-        createMockApp({}),
-        {
-          codeQlPath:
-            (await extension.distributionManager.getCodeQlPathWithoutVersionCheck()) ||
-            "",
-          debug: false,
-          cacheSize: 0,
-          numThreads: 1,
-          saveCache: false,
-          timeoutSecs: 0,
-        },
-        cliServer,
-        {
-          contextStoragePath: tmpDir.name,
-          logger: extLogger,
-        },
-        (task) =>
-          task(nullProgressReporter, new CancellationTokenSource().token),
-      );
-      await qs.startQueryServer();
-    } else {
-      throw new Error(
-        "Extension not initialized. Make sure cli is downloaded and installed properly.",
-      );
-    }
+    const extension = await getActivatedExtension();
+    cliServer = extension.cliServer;
+    cliServer.quiet = true;
+
+    qs = new QueryServerClient(
+      createMockApp({}),
+      {
+        codeQlPath:
+          (await extension.distributionManager.getCodeQlPathWithoutVersionCheck()) ||
+          "",
+        debug: false,
+        cacheSize: 0,
+        numThreads: 1,
+        saveCache: false,
+        timeoutSecs: 0,
+      },
+      cliServer,
+      {
+        contextStoragePath: tmpDir.name,
+        logger: extLogger,
+      },
+      (task) => task(nullProgressReporter, new CancellationTokenSource().token),
+    );
+    await qs.startQueryServer();
   });
 
   for (const queryTestCase of queryTestCases) {