Fix linting errors

github · Jan 23, 2023 · 8ca90f9 · 8ca90f9
1 parent cc99631
commit 8ca90f9
Show file tree

Hide file tree

Showing 6 changed files with 121 additions and 75 deletions.
diff --git a/src/codeql.ts b/src/codeql.ts
@@ -301,17 +301,23 @@ export async function setupCodeQL(
   defaultCliVersion: CodeQLDefaultVersionInfo,
   logger: Logger,
   checkVersion: boolean
-): Promise<{ codeql: CodeQL; toolsDownloadDurationMs?: number; toolsSource: ToolsSource; toolsVersion: string }> {
+): Promise<{
+  codeql: CodeQL;
+  toolsDownloadDurationMs?: number;
+  toolsSource: ToolsSource;
+  toolsVersion: string;
+}> {
   try {
-    const { codeqlFolder, toolsDownloadDurationMs, toolsSource, toolsVersion } = await setupCodeql.setupCodeQLBundle(
-      toolsInput,
-      apiDetails,
-      tempDir,
-      variant,
-      bypassToolcache,
-      defaultCliVersion,
-      logger
-    );
+    const { codeqlFolder, toolsDownloadDurationMs, toolsSource, toolsVersion } =
+      await setupCodeql.setupCodeQLBundle(
+        toolsInput,
+        apiDetails,
+        tempDir,
+        variant,
+        bypassToolcache,
+        defaultCliVersion,
+        logger
+      );
     let codeqlCmd = path.join(codeqlFolder, "codeql", "codeql");
     if (process.platform === "win32") {
       codeqlCmd += ".exe";
@@ -320,7 +326,12 @@ export async function setupCodeQL(
     }
 
     cachedCodeQL = await getCodeQLForCmd(codeqlCmd, checkVersion);
-    return { codeql: cachedCodeQL, toolsDownloadDurationMs, toolsSource, toolsVersion };
+    return {
+      codeql: cachedCodeQL,
+      toolsDownloadDurationMs,
+      toolsSource,
+      toolsVersion,
+    };
   } catch (e) {
     logger.error(e instanceof Error ? e : new Error(String(e)));
     throw new Error("Unable to download and extract CodeQL CLI");

diff --git a/src/feature-flags.test.ts b/src/feature-flags.test.ts
@@ -378,13 +378,11 @@ for (const variant of [GitHubVariant.GHAE, GitHubVariant.GHES]) {
       const features = setUpFeatureFlagTests(tmpDir);
 
       const defaultCliVersion = await features.getDefaultCliVersion(variant);
-      t.deepEqual(
-        defaultCliVersion.codeQLDefaultVersionInfo,
-        {
-          cliVersion: defaults.cliVersion,
-          tagName: defaults.bundleVersion,
-          variant,
-        });
+      t.deepEqual(defaultCliVersion.codeQLDefaultVersionInfo, {
+        cliVersion: defaults.cliVersion,
+        tagName: defaults.bundleVersion,
+        variant,
+      });
 
       t.is(defaultCliVersion.toolsFeatureFlagsValid, undefined);
     });
@@ -403,13 +401,13 @@ test("selects CLI v2.12.1 on Dotcom when feature flags enable v2.12.0 and v2.12.
     expectedFeatureEnablement["default_codeql_version_2_12_5_enabled"] = false;
     mockFeatureFlagApiEndpoint(200, expectedFeatureEnablement);
 
-    const defaultCliVersion = await featureEnablement.getDefaultCliVersion(GitHubVariant.DOTCOM);
-    t.deepEqual(
-      defaultCliVersion.codeQLDefaultVersionInfo,
-      {
-        cliVersion: "2.12.1",
-        variant: GitHubVariant.DOTCOM,
-      });
+    const defaultCliVersion = await featureEnablement.getDefaultCliVersion(
+      GitHubVariant.DOTCOM
+    );
+    t.deepEqual(defaultCliVersion.codeQLDefaultVersionInfo, {
+      cliVersion: "2.12.1",
+      variant: GitHubVariant.DOTCOM,
+    });
 
     t.is(defaultCliVersion.toolsFeatureFlagsValid, true);
   });
@@ -421,13 +419,13 @@ test(`selects CLI v2.11.6 on Dotcom when no default version feature flags are en
     const expectedFeatureEnablement = initializeFeatures(true);
     mockFeatureFlagApiEndpoint(200, expectedFeatureEnablement);
 
-    const defaultCliVersion = await featureEnablement.getDefaultCliVersion(GitHubVariant.DOTCOM);
-    t.deepEqual(
-      defaultCliVersion.codeQLDefaultVersionInfo,
-      {
-        cliVersion: "2.11.6",
-        variant: GitHubVariant.DOTCOM,
-      });
+    const defaultCliVersion = await featureEnablement.getDefaultCliVersion(
+      GitHubVariant.DOTCOM
+    );
+    t.deepEqual(defaultCliVersion.codeQLDefaultVersionInfo, {
+      cliVersion: "2.11.6",
+      variant: GitHubVariant.DOTCOM,
+    });
 
     t.is(defaultCliVersion.toolsFeatureFlagsValid, false);
   });
@@ -447,13 +445,13 @@ test("ignores invalid version numbers in default version feature flags", async (
       true;
     mockFeatureFlagApiEndpoint(200, expectedFeatureEnablement);
 
-    const defaultCliVersion = await featureEnablement.getDefaultCliVersion(GitHubVariant.DOTCOM);
-    t.deepEqual(
-      defaultCliVersion.codeQLDefaultVersionInfo,
-      {
-        cliVersion: "2.12.1",
-        variant: GitHubVariant.DOTCOM,
-      });
+    const defaultCliVersion = await featureEnablement.getDefaultCliVersion(
+      GitHubVariant.DOTCOM
+    );
+    t.deepEqual(defaultCliVersion.codeQLDefaultVersionInfo, {
+      cliVersion: "2.12.1",
+      variant: GitHubVariant.DOTCOM,
+    });
 
     t.is(defaultCliVersion.toolsFeatureFlagsValid, true);
 

diff --git a/src/feature-flags.ts b/src/feature-flags.ts
@@ -27,9 +27,10 @@ export type CodeQLDefaultVersionInfo =
 
 export interface FeatureEnablement {
   /** Gets the default version of the CodeQL tools. */
-  getDefaultCliVersion(
-    variant: util.GitHubVariant
-  ): Promise<{ codeQLDefaultVersionInfo: CodeQLDefaultVersionInfo; toolsFeatureFlagsValid?: boolean }>;
+  getDefaultCliVersion(variant: util.GitHubVariant): Promise<{
+    codeQLDefaultVersionInfo: CodeQLDefaultVersionInfo;
+    toolsFeatureFlagsValid?: boolean;
+  }>;
   getValue(feature: Feature, codeql?: CodeQL): Promise<boolean>;
 }
 
@@ -113,9 +114,10 @@ export class Features implements FeatureEnablement {
     );
   }
 
-  async getDefaultCliVersion(
-    variant: util.GitHubVariant
-  ): Promise<{ codeQLDefaultVersionInfo: CodeQLDefaultVersionInfo; toolsFeatureFlagsValid?: boolean }> {
+  async getDefaultCliVersion(variant: util.GitHubVariant): Promise<{
+    codeQLDefaultVersionInfo: CodeQLDefaultVersionInfo;
+    toolsFeatureFlagsValid?: boolean;
+  }> {
     return await this.gitHubFeatureFlags.getDefaultCliVersion(variant);
   }
 
@@ -204,17 +206,18 @@ class GitHubFeatureFlags implements FeatureEnablement {
     return version;
   }
 
-  async getDefaultCliVersion(
-    variant: util.GitHubVariant
-  ): Promise<{ codeQLDefaultVersionInfo: CodeQLDefaultVersionInfo; toolsFeatureFlagsValid?: boolean }> {
+  async getDefaultCliVersion(variant: util.GitHubVariant): Promise<{
+    codeQLDefaultVersionInfo: CodeQLDefaultVersionInfo;
+    toolsFeatureFlagsValid?: boolean;
+  }> {
     if (variant === util.GitHubVariant.DOTCOM) {
       const defaultDotComCliVersion = await this.getDefaultDotcomCliVersion();
       return {
         codeQLDefaultVersionInfo: {
           cliVersion: defaultDotComCliVersion.version,
           variant,
         },
-        toolsFeatureFlagsValid: defaultDotComCliVersion.toolsFeatureFlagsValid
+        toolsFeatureFlagsValid: defaultDotComCliVersion.toolsFeatureFlagsValid,
       };
     }
     return {
@@ -226,7 +229,10 @@ class GitHubFeatureFlags implements FeatureEnablement {
     };
   }
 
-  async getDefaultDotcomCliVersion(): Promise<{ version: string; toolsFeatureFlagsValid: boolean }> {
+  async getDefaultDotcomCliVersion(): Promise<{
+    version: string;
+    toolsFeatureFlagsValid: boolean;
+  }> {
     const response = await this.getAllFeatures();
 
     const enabledFeatureFlagCliVersions = Object.entries(response)
@@ -241,7 +247,10 @@ class GitHubFeatureFlags implements FeatureEnablement {
         "Feature flags do not specify a default CLI version. Falling back to CLI version " +
           `${MINIMUM_ENABLED_CODEQL_VERSION}.`
       );
-      return { version: MINIMUM_ENABLED_CODEQL_VERSION, toolsFeatureFlagsValid: false };
+      return {
+        version: MINIMUM_ENABLED_CODEQL_VERSION,
+        toolsFeatureFlagsValid: false,
+      };
     }
 
     const maxCliVersion = enabledFeatureFlagCliVersions.reduce(

diff --git a/src/init-action.ts b/src/init-action.ts
@@ -23,7 +23,7 @@ import {
   injectWindowsTracer,
   installPythonDeps,
   runInit,
-  ToolsSource
+  ToolsSource,
 } from "./init";
 import { Language } from "./languages";
 import { getActionsLogger, Logger } from "./logging";
@@ -139,12 +139,12 @@ async function sendInitStatusReport(
     tools_resolved_version: toolsVersion || "",
     workflow_languages: workflowLanguages || "",
     // TODO(angelapwen): I think the following will crash if config.trapCaches is undefined because we might
-    // be sending a failure report before we initialize config. 
+    // be sending a failure report before we initialize config.
     trap_cache_languages: Object.keys(config.trapCaches).join(",") || "",
-    trap_cache_download_size_bytes: Math.round(
-      await getTotalCacheSize(config.trapCaches, logger)
-    ) || -1, // Placeholder value if cache size is not determined yet.
-    trap_cache_download_duration_ms: Math.round(config.trapCacheDownloadTime) || -1, // Placeholder value if cache size is not determined yet.,
+    trap_cache_download_size_bytes:
+      Math.round(await getTotalCacheSize(config.trapCaches, logger)) || -1, // Placeholder value if cache size is not determined yet.
+    trap_cache_download_duration_ms:
+      Math.round(config.trapCacheDownloadTime) || -1, // Placeholder value if cache size is not determined yet.,
     tools_source: toolsSource || ToolsSource.Unknown,
   };
 
@@ -155,8 +155,12 @@ async function sendInitStatusReport(
   // Otherwise, we should append the extra two download-related telemetry fields.
   const downloadStatusReport: InitDownloadStatusReport = {
     ...statusReport,
-    tools_download_duration_ms: toolsDownloadDurationMs ? toolsDownloadDurationMs : -1, // Placeholder value in case field is undefined.
-    tools_feature_flags_valid: toolsFeatureFlagsValid ? toolsFeatureFlagsValid : false, // Report invalid in case field is undefined.
+    tools_download_duration_ms: toolsDownloadDurationMs
+      ? toolsDownloadDurationMs
+      : -1, // Placeholder value in case field is undefined.
+    tools_feature_flags_valid: toolsFeatureFlagsValid
+      ? toolsFeatureFlagsValid
+      : false, // Report invalid in case field is undefined.
   };
 
   await sendStatusReport(downloadStatusReport);
@@ -363,7 +367,16 @@ async function run() {
     );
     return;
   }
-  await sendInitStatusReport("success", startedAt, config, toolsDownloadDurationMs, toolsFeatureFlagsValid, toolsSource, toolsVersion, logger);
+  await sendInitStatusReport(
+    "success",
+    startedAt,
+    config,
+    toolsDownloadDurationMs,
+    toolsFeatureFlagsValid,
+    toolsSource,
+    toolsVersion,
+    logger
+  );
 }
 
 async function getTrapCachingEnabled(

diff --git a/src/init.ts b/src/init.ts
@@ -19,7 +19,7 @@ export enum ToolsSource {
   Unknown = "UNKNOWN",
   Local = "LOCAL",
   Toolcache = "TOOLCACHE",
-  Download = "DOWNLOAD"
+  Download = "DOWNLOAD",
 }
 
 export async function initCodeQL(
@@ -30,18 +30,24 @@ export async function initCodeQL(
   bypassToolcache: boolean,
   defaultCliVersion: CodeQLDefaultVersionInfo,
   logger: Logger
-): Promise<{ codeql: CodeQL; toolsDownloadDurationMs?: number; toolsSource: ToolsSource; toolsVersion: string }> {
+): Promise<{
+  codeql: CodeQL;
+  toolsDownloadDurationMs?: number;
+  toolsSource: ToolsSource;
+  toolsVersion: string;
+}> {
   logger.startGroup("Setup CodeQL tools");
-  const { codeql, toolsDownloadDurationMs, toolsSource, toolsVersion } = await setupCodeQL(
-    toolsInput,
-    apiDetails,
-    tempDir,
-    variant,
-    bypassToolcache,
-    defaultCliVersion,
-    logger,
-    true
-  );
+  const { codeql, toolsDownloadDurationMs, toolsSource, toolsVersion } =
+    await setupCodeQL(
+      toolsInput,
+      apiDetails,
+      tempDir,
+      variant,
+      bypassToolcache,
+      defaultCliVersion,
+      logger,
+      true
+    );
   await codeql.printVersion();
   logger.endGroup();
   return { codeql, toolsDownloadDurationMs, toolsSource, toolsVersion };

diff --git a/src/setup-codeql.ts b/src/setup-codeql.ts
@@ -516,7 +516,11 @@ export async function downloadCodeQL(
   variant: util.GitHubVariant,
   tempDir: string,
   logger: Logger
-): Promise<{ toolsVersion: string; codeqlFolder: string; toolsDownloadDurationMs: number }> {
+): Promise<{
+  toolsVersion: string;
+  codeqlFolder: string;
+  toolsDownloadDurationMs: number;
+}> {
   const parsedCodeQLURL = new URL(codeqlURL);
   const searchParams = new URLSearchParams(parsedCodeQLURL.search);
   const headers: OutgoingHttpHeaders = {
@@ -587,7 +591,7 @@ export async function downloadCodeQL(
       "CodeQL",
       toolcacheVersion
     ),
-    toolsDownloadDurationMs
+    toolsDownloadDurationMs,
   };
 }
 
@@ -623,7 +627,12 @@ export async function setupCodeQLBundle(
   bypassToolcache: boolean,
   defaultCliVersion: CodeQLDefaultVersionInfo,
   logger: Logger
-): Promise<{ codeqlFolder: string; toolsDownloadDurationMs?: number; toolsSource: ToolsSource; toolsVersion: string }> {
+): Promise<{
+  codeqlFolder: string;
+  toolsDownloadDurationMs?: number;
+  toolsSource: ToolsSource;
+  toolsVersion: string;
+}> {
   const source = await getCodeQLSource(
     toolsInput,
     bypassToolcache,