Enable zstd bundles on GHES and remove feature flag

src/codeql.test.ts

@@ -69,8 +69,6 @@ async function installIntoToolcache({
     cliVersion !== undefined
       ? { cliVersion, tagName }
       : SAMPLE_DEFAULT_CLI_VERSION,
-
-    createFeatures([]),
     getRunnerLogger(true),
     false,
   );
@@ -130,8 +128,6 @@ test("downloads and caches explicitly requested bundles that aren't in the toolc
         tmpDir,
         util.GitHubVariant.DOTCOM,
         SAMPLE_DEFAULT_CLI_VERSION,
-
-        createFeatures([]),
         getRunnerLogger(true),
         false,
       );
@@ -158,8 +154,6 @@ test("caches semantically versioned bundles using their semantic version number"
       tmpDir,
       util.GitHubVariant.DOTCOM,
       SAMPLE_DEFAULT_CLI_VERSION,
-
-      createFeatures([]),
       getRunnerLogger(true),
       false,
     );
@@ -193,8 +187,6 @@ test("downloads an explicitly requested bundle even if a different version is ca
       tmpDir,
       util.GitHubVariant.DOTCOM,
       SAMPLE_DEFAULT_CLI_VERSION,
-
-      createFeatures([]),
       getRunnerLogger(true),
       false,
     );
@@ -239,8 +231,6 @@ for (const {
         tmpDir,
         util.GitHubVariant.DOTCOM,
         SAMPLE_DEFAULT_CLI_VERSION,
-
-        createFeatures([]),
         getRunnerLogger(true),
         false,
       );
@@ -279,8 +269,6 @@ for (const toolcacheVersion of [
           tmpDir,
           util.GitHubVariant.DOTCOM,
           SAMPLE_DEFAULT_CLI_VERSION,
-
-          createFeatures([]),
           getRunnerLogger(true),
           false,
         );
@@ -313,8 +301,6 @@ test(`uses a cached bundle when no tools input is given on GHES`, async (t) => {
         cliVersion: defaults.cliVersion,
         tagName: defaults.bundleVersion,
       },
-
-      createFeatures([]),
       getRunnerLogger(true),
       false,
     );
@@ -351,8 +337,6 @@ test(`downloads bundle if only an unpinned version is cached on GHES`, async (t)
         cliVersion: defaults.cliVersion,
         tagName: defaults.bundleVersion,
       },
-
-      createFeatures([]),
       getRunnerLogger(true),
       false,
     );
@@ -386,8 +370,6 @@ test('downloads bundle if "latest" tools specified but not cached', async (t) =>
       tmpDir,
       util.GitHubVariant.DOTCOM,
       SAMPLE_DEFAULT_CLI_VERSION,
-
-      createFeatures([]),
       getRunnerLogger(true),
       false,
     );
@@ -424,8 +406,6 @@ test("bundle URL from another repo is cached as 0.0.0-bundleVersion", async (t)
       tmpDir,
       util.GitHubVariant.DOTCOM,
       SAMPLE_DEFAULT_CLI_VERSION,
-
-      createFeatures([]),
       getRunnerLogger(true),
       false,
     );

src/codeql.ts

@@ -343,7 +343,6 @@ export async function setupCodeQL(
   tempDir: string,
   variant: util.GitHubVariant,
   defaultCliVersion: CodeQLDefaultVersionInfo,
-  features: FeatureEnablement,
   logger: Logger,
   checkVersion: boolean,
 ): Promise<{
@@ -366,7 +365,6 @@ export async function setupCodeQL(
       tempDir,
       variant,
       defaultCliVersion,
-      features,
       logger,
     );
 

src/feature-flags.ts

@@ -59,8 +59,6 @@ export enum Feature {
   ExportDiagnosticsEnabled = "export_diagnostics_enabled",
   PythonDefaultIsToNotExtractStdlib = "python_default_is_to_not_extract_stdlib",
   QaTelemetryEnabled = "qa_telemetry_enabled",
-  ZstdBundle = "zstd_bundle",
-  ZstdBundleStreamingExtraction = "zstd_bundle_streaming_extraction",
 }
 
 export const featureConfig: Record<
@@ -156,18 +154,6 @@ export const featureConfig: Record<
     legacyApi: true,
     minimumVersion: undefined,
   },
-  [Feature.ZstdBundle]: {
-    defaultValue: false,
-    envVar: "CODEQL_ACTION_ZSTD_BUNDLE",
-    // We haven't yet installed CodeQL when we check this feature flag, so we need to implement the
-    // version check separately.
-    minimumVersion: undefined,
-  },
-  [Feature.ZstdBundleStreamingExtraction]: {
-    defaultValue: false,
-    envVar: "CODEQL_ACTION_ZSTD_BUNDLE_STREAMING_EXTRACTION",
-    minimumVersion: undefined,
-  },
 };
 
 /**

src/init-action.ts

@@ -319,7 +319,6 @@ async function run() {
       getTemporaryDirectory(),
       gitHubVersion.type,
       codeQLDefaultVersionInfo,
-      features,
       logger,
     );
     codeql = initCodeQLResult.codeql;

src/init.ts

@@ -8,7 +8,7 @@ import { getOptionalInput, isSelfHostedRunner } from "./actions-util";
 import { GitHubApiCombinedDetails, GitHubApiDetails } from "./api-client";
 import { CodeQL, setupCodeQL } from "./codeql";
 import * as configUtils from "./config-utils";
-import { CodeQLDefaultVersionInfo, FeatureEnablement } from "./feature-flags";
+import { CodeQLDefaultVersionInfo } from "./feature-flags";
 import { Language, isScannedLanguage } from "./languages";
 import { Logger } from "./logging";
 import { ToolsSource } from "./setup-codeql";
@@ -24,7 +24,6 @@ export async function initCodeQL(
   tempDir: string,
   variant: util.GitHubVariant,
   defaultCliVersion: CodeQLDefaultVersionInfo,
-  features: FeatureEnablement,
   logger: Logger,
 ): Promise<{
   codeql: CodeQL;
@@ -46,7 +45,6 @@ export async function initCodeQL(
     tempDir,
     variant,
     defaultCliVersion,
-    features,
     logger,
     true,
   );

src/setup-codeql.test.ts

@@ -11,7 +11,6 @@ import {
   LoggedMessage,
   SAMPLE_DEFAULT_CLI_VERSION,
   SAMPLE_DOTCOM_API_DETAILS,
-  createFeatures,
   getRecordingLogger,
   mockBundleDownloadApi,
   setupActionsVars,
@@ -91,7 +90,6 @@ test("getCodeQLSource sets CLI version for a semver tagged bundle", async (t) =>
       SAMPLE_DOTCOM_API_DETAILS,
       GitHubVariant.DOTCOM,
       false,
-      createFeatures([]),
       getRunnerLogger(true),
     );
 
@@ -109,7 +107,6 @@ test("getCodeQLSource correctly returns bundled CLI version when tools == linked
       SAMPLE_DOTCOM_API_DETAILS,
       GitHubVariant.DOTCOM,
       false,
-      createFeatures([]),
       getRunnerLogger(true),
     );
 
@@ -130,7 +127,6 @@ test("getCodeQLSource correctly returns bundled CLI version when tools == latest
       SAMPLE_DOTCOM_API_DETAILS,
       GitHubVariant.DOTCOM,
       false,
-      createFeatures([]),
       logger,
     );
 
@@ -179,7 +175,6 @@ test("setupCodeQLBundle logs the CodeQL CLI version being used when asked to use
       "tmp/codeql_action_test/",
       GitHubVariant.DOTCOM,
       SAMPLE_DEFAULT_CLI_VERSION,
-      createFeatures([]),
       logger,
     );
 
@@ -230,7 +225,6 @@ test("setupCodeQLBundle logs the CodeQL CLI version being used when asked to dow
       "tmp/codeql_action_test/",
       GitHubVariant.DOTCOM,
       SAMPLE_DEFAULT_CLI_VERSION,
-      createFeatures([]),
       logger,
     );
 

src/setup-codeql.ts

@@ -13,8 +13,6 @@ import * as defaults from "./defaults.json";
 import {
   CODEQL_VERSION_ZSTD_BUNDLE,
   CodeQLDefaultVersionInfo,
-  Feature,
-  FeatureEnablement,
 } from "./feature-flags";
 import { formatDuration, Logger } from "./logging";
 import * as tar from "./tar";
@@ -261,7 +259,6 @@ export async function getCodeQLSource(
   apiDetails: api.GitHubApiDetails,
   variant: util.GitHubVariant,
   tarSupportsZstd: boolean,
-  features: FeatureEnablement,
   logger: Logger,
 ): Promise<CodeQLToolsSource> {
   if (
@@ -458,7 +455,7 @@ export async function getCodeQLSource(
       tagName!,
       apiDetails,
       cliVersion !== undefined &&
-        (await useZstdBundle(cliVersion, features, tarSupportsZstd)),
+        (await useZstdBundle(cliVersion, tarSupportsZstd)),
       logger,
     );
   }
@@ -507,7 +504,6 @@ export const downloadCodeQL = async function (
   apiDetails: api.GitHubApiDetails,
   tarVersion: tar.TarVersion | undefined,
   tempDir: string,
-  features: FeatureEnablement,
   logger: Logger,
 ): Promise<{
   codeqlFolder: string;
@@ -542,7 +538,6 @@ export const downloadCodeQL = async function (
     { "User-Agent": "CodeQL Action", ...headers },
     tarVersion,
     tempDir,
-    features,
     logger,
   );
 
@@ -653,7 +648,6 @@ export async function setupCodeQLBundle(
   tempDir: string,
   variant: util.GitHubVariant,
   defaultCliVersion: CodeQLDefaultVersionInfo,
-  features: FeatureEnablement,
   logger: Logger,
 ): Promise<SetupCodeQLResult> {
   const zstdAvailability = await tar.isZstdAvailable(logger);
@@ -675,7 +669,6 @@ export async function setupCodeQLBundle(
         tempDir,
         variant,
         defaultCliVersion,
-        features,
         logger,
         zstdAvailability,
         true,
@@ -700,7 +693,6 @@ export async function setupCodeQLBundle(
     tempDir,
     variant,
     defaultCliVersion,
-    features,
     logger,
     zstdAvailability,
     false,
@@ -717,7 +709,6 @@ async function setupCodeQLBundleWithCompressionMethod(
   tempDir: string,
   variant: util.GitHubVariant,
   defaultCliVersion: CodeQLDefaultVersionInfo,
-  features: FeatureEnablement,
   logger: Logger,
   zstdAvailability: tar.ZstdAvailability,
   useTarIfAvailable: boolean,
@@ -728,7 +719,6 @@ async function setupCodeQLBundleWithCompressionMethod(
     apiDetails,
     variant,
     useTarIfAvailable,
-    features,
     logger,
   );
 
@@ -763,7 +753,6 @@ async function setupCodeQLBundleWithCompressionMethod(
         apiDetails,
         zstdAvailability.version,
         tempDir,
-        features,
         logger,
       );
       toolsVersion = result.toolsVersion;
@@ -786,14 +775,12 @@ async function setupCodeQLBundleWithCompressionMethod(
 
 async function useZstdBundle(
   cliVersion: string,
-  features: FeatureEnablement,
   tarSupportsZstd: boolean,
 ): Promise<boolean> {
   return (
     // In testing, gzip performs better than zstd on Windows.
     process.platform !== "win32" &&
     tarSupportsZstd &&
-    semver.gte(cliVersion, CODEQL_VERSION_ZSTD_BUNDLE) &&
-    !!(await features.getValue(Feature.ZstdBundle))
+    semver.gte(cliVersion, CODEQL_VERSION_ZSTD_BUNDLE)
   );
 }

src/testing-utils.ts

@@ -290,23 +290,30 @@ export function mockBundleDownloadApi({
       : "osx64";
 
   const baseUrl = apiDetails?.url ?? "https://example.com";
-  const relativeUrl = apiDetails
-    ? `/${repo}/releases/download/${tagName}/codeql-bundle${
-        platformSpecific ? `-${platform}` : ""
-      }.tar.gz`
-    : `/download/${tagName}/codeql-bundle.tar.gz`;
 
-  nock(baseUrl)
-    .get(relativeUrl)
-    .replyWithFile(
-      200,
-      path.join(
-        __dirname,
-        `/../src/testdata/codeql-bundle${isPinned ? "-pinned" : ""}.tar.gz`,
-      ),
-    );
+  const bundleUrls = ["tar.gz", "tar.zst"].map((extension) => {
+    const relativeUrl = apiDetails
+      ? `/${repo}/releases/download/${tagName}/codeql-bundle${
+          platformSpecific ? `-${platform}` : ""
+        }.${extension}`
+      : `/download/${tagName}/codeql-bundle.${extension}`;
 
-  return `${baseUrl}${relativeUrl}`;
+    nock(baseUrl)
+      .get(relativeUrl)
+      .replyWithFile(
+        200,
+        path.join(
+          __dirname,
+          `/../src/testdata/codeql-bundle${
+            isPinned ? "-pinned" : ""
+          }.${extension}`,
+        ),
+      );
+    return `${baseUrl}${relativeUrl}`;
+  });
+
+  // Choose an arbitrary URL to return
+  return bundleUrls[0];
 }
 
 export function createTestConfig(overrides: Partial<Config>): Config {

src/tools-download.ts

@@ -6,7 +6,6 @@ import * as toolcache from "@actions/tool-cache";
 import { https } from "follow-redirects";
 import { v4 as uuidV4 } from "uuid";
 
-import { Feature, FeatureEnablement } from "./feature-flags";
 import { formatDuration, Logger } from "./logging";
 import * as tar from "./tar";
 import { cleanUpGlob } from "./util";
@@ -77,7 +76,6 @@ export async function downloadAndExtract(
   headers: OutgoingHttpHeaders,
   tarVersion: tar.TarVersion | undefined,
   tempDir: string,
-  features: FeatureEnablement,
   logger: Logger,
 ): Promise<{
   extractedBundlePath: string;
@@ -89,11 +87,7 @@ export async function downloadAndExtract(
 
   const compressionMethod = tar.inferCompressionMethod(codeqlURL);
 
-  if (
-    compressionMethod === "zstd" &&
-    process.platform === "linux" &&
-    (await features.getValue(Feature.ZstdBundleStreamingExtraction))
-  ) {
+  if (compressionMethod === "zstd" && process.platform === "linux") {
     logger.info(`Streaming the extraction of the CodeQL bundle.`);
 
     const toolsInstallStart = performance.now();

src/upload-lib.ts

@@ -221,7 +221,6 @@ async function combineSarifFilesUsingCLI(
       tempDir,
       gitHubVersion.type,
       codeQLDefaultVersionInfo,
-      features,
       logger,
     );