Merge pull request #4244 from github/henrymercer/graduate-per-language-bundles

Use per-language CodeQL bundles by default

Author: henrymercer

.github/workflows/__export-file-baseline-information.yml

@@ -11,16 +11,17 @@ installDotNet: true
 env:
   CODEQL_ACTION_SKIP_FILE_COVERAGE_ON_PRS: false
   CODEQL_ACTION_SUBLANGUAGE_FILE_COVERAGE: true
-  # To balance speed and coverage, we analyze only a single language (JavaScript), but use the
-  # combined bundle so we can test that baseline information is reported for each language in the
-  # multi-language source directory.
-  CODEQL_ACTION_PER_LANGUAGE_BUNDLES: false
 steps:
   - uses: ./../action/init
     id: init
     with:
       languages: javascript
       tools: ${{ steps.prepare-test.outputs.tools-url }}
+      # To balance speed and coverage, analyze only JavaScript but use the combined bundle so
+      # baseline information is reported for every language in the multi-language repository. A
+      # custom configuration prevents per-language bundles from being used.
+      config: |
+        paths-ignore: []
   - name: Build code
     run: ./build.sh
   - uses: ./../action/analyze

.github/workflows/__per-language-bundle-validation.yml

@@ -1,49 +1,51 @@
 name: Per-language bundles
 description: Validates extraction and analysis using each per-language CodeQL bundle.
-# TODO: Use a released bundle once releases include per-language bundles.
 matrix:
   include:
     - language: actions
       os: ubuntu-latest
-      version: nightly-latest
+      version: linked
       # Actions also needs the JavaScript extractor.
       expected-extractors: actions javascript
     - language: cpp
       os: ubuntu-latest
-      version: nightly-latest
+      version: linked
       build-mode: manual
       build-command: gcc -o main main.c
     - language: csharp
       os: ubuntu-latest
-      version: nightly-latest
+      version: linked
       build-mode: none
     - language: go
       os: ubuntu-latest
-      version: nightly-latest
+      version: linked
       build-mode: autobuild
     - language: java
       os: ubuntu-latest
-      version: nightly-latest
+      version: linked
       build-mode: none
     - language: javascript
       os: ubuntu-latest
-      version: nightly-latest
+      version: linked
     - language: python
       os: ubuntu-latest
-      version: nightly-latest
+      version: linked
     - language: ruby
       os: ubuntu-latest
-      version: nightly-latest
+      version: linked
     - language: rust
       os: ubuntu-latest
-      version: nightly-latest
+      version: linked
     - language: swift
       os: macos-latest-xlarge
-      version: nightly-latest
+      version: linked
       build-mode: autobuild
-env:
-  CODEQL_ACTION_PER_LANGUAGE_BUNDLES: true
+installNode: true
 steps:
+  - name: Remove CodeQL from toolcache
+    run: |
+      cd ./../action
+      npx tsx ./pr-checks/toolcache.ts clear
   - uses: ./../action/init
     id: init
     with:
@@ -84,9 +86,8 @@ steps:
       CODEQL_PATH: ${{ steps.init.outputs.codeql-path }}
     run: |
       # A bundle that is missing most of its extractors must never be left in the toolcache,
-      # where a later job analyzing a different language could pick it up. The runner image
-      # ships with its own CodeQL in the toolcache, so check where this bundle was extracted to
-      # rather than whether the toolcache contains CodeQL at all.
+      # where a later job analyzing a different language could pick it up. Per-language bundles
+      # must instead be extracted under the runner's temporary directory.
       echo "CodeQL is at $CODEQL_PATH"
       if [[ "$CODEQL_PATH" == "$RUNNER_TOOL_CACHE"/* ]]; then
         echo "::error::The per-language bundle was added to the toolcache at $CODEQL_PATH."

lib/entry-points.js

@@ -143,11 +143,6 @@ export enum Feature {
   OverlayAnalysisStatusCheck = "overlay_analysis_status_check",
   /** Controls whether overlay build failures on the default branch are stored in the Actions cache. */
   OverlayAnalysisStatusSave = "overlay_analysis_status_save",
-  /**
-   * Controls whether we may download a bundle containing only the single language being analysed,
-   * rather than the combined bundle that contains every language.
-   */
-  PerLanguageBundles = "per_language_bundles_v2",
   QaTelemetryEnabled = "qa_telemetry_enabled",
   /** Routes (some) API requests through the registry proxy. */
   ProxyApiRequests = "proxy_api_requests",
@@ -393,11 +388,6 @@ export const featureConfig = {
     envVar: "CODEQL_ACTION_OVERLAY_ANALYSIS_SKIP_RESOURCE_CHECKS",
     minimumVersion: undefined,
   },
-  [Feature.PerLanguageBundles]: {
-    defaultValue: false,
-    envVar: "CODEQL_ACTION_PER_LANGUAGE_BUNDLES",
-    minimumVersion: undefined,
-  },
   [Feature.QaTelemetryEnabled]: {
     defaultValue: false,
     envVar: "CODEQL_ACTION_QA_TELEMETRY",

pr-checks/checks/export-file-baseline-information.yml

@@ -1,7 +1,6 @@
 import test from "ava";
 
 import { ActionsEnvVars } from "./environment";
-import { Feature } from "./feature-flags";
 import { BuiltInLanguage } from "./languages";
 import {
   getOtherLanguagePacksReason,
@@ -12,7 +11,6 @@ import {
 } from "./per-language-bundles";
 import { BundlePlatform } from "./platform";
 import {
-  createFeatures,
   getRecordingLogger,
   getTestEnv,
   initAllState,
@@ -40,7 +38,6 @@ async function checkEligibility(
       env: getTestEnv({
         [ActionsEnvVars.RUNNER_ENVIRONMENT]: "github-hosted",
       }),
-      features: createFeatures([Feature.PerLanguageBundles]),
       ...stateOverrides,
     }),
     { ...ELIGIBLE_OPTIONS, ...overrides },
@@ -145,27 +142,6 @@ test("getPerLanguageBundleLanguage requires a supported release version", async
   t.is(await checkEligibility({ cliVersion: "2.27.1" }), BuiltInLanguage.java);
 });
 
-test("getPerLanguageBundleLanguage requires the feature flag", async (t) => {
-  t.is(await checkEligibility({}, { features: createFeatures([]) }), undefined);
-});
-
-test("getPerLanguageBundleLanguage explains a disabled feature before checking eligibility", async (t) => {
-  const messages: LoggedMessage[] = [];
-  const language = await getPerLanguageBundleLanguage(
-    initAllState({
-      features: createFeatures([]),
-      logger: getRecordingLogger(messages, { logToConsole: false }),
-    }),
-    { ...ELIGIBLE_OPTIONS, rawLanguages: undefined, cliVersion: undefined },
-  );
-
-  t.is(language, undefined);
-  t.deepEqual(
-    messages.map((message) => message.message),
-    ["Not using a per-language CodeQL bundle since the feature is disabled."],
-  );
-});
-
 test("getPerLanguageBundleLanguage skips only the release version check for the latest nightly", async (t) => {
   const nightly = { isLatestNightly: true, cliVersion: undefined };
   t.is(await checkEligibility(nightly), BuiltInLanguage.java);
@@ -181,10 +157,6 @@ test("getPerLanguageBundleLanguage skips only the release version check for the
   ]) {
     t.is(await checkEligibility({ ...nightly, ...overrides }), undefined);
   }
-  t.is(
-    await checkEligibility(nightly, { features: createFeatures([]) }),
-    undefined,
-  );
   t.is(
     await checkEligibility(nightly, {
       env: getTestEnv({ [ActionsEnvVars.RUNNER_ENVIRONMENT]: "self-hosted" }),