Introduce a rollback mechanism for Java buildless

github · henrymercer · Feb 14, 2024 · Feb 12, 2024 · Feb 12, 2024 · Feb 12, 2024
commit 4e5f9c0873d817a805a88288066dc2e918b10a89
@@ -15,12 +15,16 @@ import {
 } from "./codeql";
 import * as configUtils from "./config-utils";
 import { BuildMode } from "./config-utils";
+import { Feature } from "./feature-flags";
 import { Language } from "./languages";
 import { getRunnerLogger } from "./logging";
 import { parseRepositoryNwo } from "./repository";
 import {
   setupTests,
   mockLanguagesInRepo as mockLanguagesInRepo,
+  createFeatures,
+  getRecordingLogger,
+  LoggedMessage,
 } from "./testing-utils";
 import {
   GitHubVariant,
@@ -63,6 +67,7 @@ function createTestInitConfigInputs(
         apiURL: undefined,
         registriesAuthTokens: undefined,
       },
+      features: createFeatures([]),
       logger: getRunnerLogger(true),
     },
     overrides,
@@ -1080,3 +1085,45 @@ const mockRepositoryNwo = parseRepositoryNwo("owner/repo");
     t.deepEqual(mockRequest.called, args.expectedApiCall);
   });
 });
+
+test("Build mode not overridden when disable Java buildless feature flag disabled", async (t) => {
+  const messages: LoggedMessage[] = [];
+  const buildMode = await configUtils.parseBuildModeInput(
+    "none",
+    [Language.java],
+    createFeatures([]),
+    getRecordingLogger(messages),
+  );
+  t.is(buildMode, BuildMode.None);
+  t.deepEqual(messages, []);
+});
+
+test("Build mode not overridden for other languages", async (t) => {
+  const messages: LoggedMessage[] = [];
+  const buildMode = await configUtils.parseBuildModeInput(
+    "none",
+    [Language.python],
+    createFeatures([Feature.DisableJavaBuildlessEnabled]),
+    getRecordingLogger(messages),
+  );
+  t.is(buildMode, BuildMode.None);
+  t.deepEqual(messages, []);
+});
+
+test("Build mode overridden when analyzing Java and disable Java buildless feature flag enabled", async (t) => {
+  const messages: LoggedMessage[] = [];
+  const buildMode = await configUtils.parseBuildModeInput(
+    "none",
+    [Language.java],
+    createFeatures([Feature.DisableJavaBuildlessEnabled]),
+    getRecordingLogger(messages),
+  );
+  t.is(buildMode, BuildMode.Autobuild);
+  t.deepEqual(messages, [
+    {
+      message:
+        "Scanning Java code without a build is temporarily unavailable. Falling back to 'autobuild' build mode.",
+      type: "warning",
+    },
+  ]);
+});
@@ -7,6 +7,7 @@ import * as semver from "semver";
 
 import * as api from "./api-client";
 import { CodeQL, CODEQL_VERSION_LANGUAGE_ALIASING } from "./codeql";
+import { Feature, FeatureEnablement } from "./feature-flags";
 import { Language, parseLanguage } from "./languages";
 import { Logger } from "./logging";
 import { RepositoryNwo } from "./repository";
@@ -420,6 +421,7 @@ export interface InitConfigInputs {
   workspacePath: string;
   githubVersion: GitHubVersion;
   apiDetails: api.GitHubApiCombinedDetails;
+  features: FeatureEnablement;
   logger: Logger;
 }
 
@@ -449,6 +451,7 @@ export async function getDefaultConfig({
   tempDir,
   codeql,
   githubVersion,
+  features,
   logger,
 }: GetDefaultConfigInputs): Promise<Config> {
   const languages = await getLanguages(
@@ -457,6 +460,14 @@ export async function getDefaultConfig({
     repository,
     logger,
   );
+
+  const buildMode = await parseBuildModeInput(
+    buildModeInput,
+    languages,
+    features,
+    logger,
+  );
+
   const augmentationProperties = calculateAugmentation(
     packsInput,
     queriesInput,
@@ -472,7 +483,7 @@ export async function getDefaultConfig({
 
   return {
     languages,
-    buildMode: validateBuildModeInput(buildModeInput),
+    buildMode,
     originalUserInput: {},
     tempDir,
     codeQLCmd: codeql.getPath(),
@@ -526,6 +537,7 @@ async function loadConfig({
   workspacePath,
   githubVersion,
   apiDetails,
+  features,
   logger,
 }: LoadConfigInputs): Promise<Config> {
   let parsedYAML: UserConfig;
@@ -545,6 +557,13 @@ async function loadConfig({
     logger,
   );
 
+  const buildMode = await parseBuildModeInput(
+    buildModeInput,
+    languages,
+    features,
+    logger,
+  );
+
   const augmentationProperties = calculateAugmentation(
     packsInput,
     queriesInput,
@@ -560,7 +579,7 @@ async function loadConfig({
 
   return {
     languages,
-    buildMode: validateBuildModeInput(buildModeInput),
+    buildMode,
     originalUserInput: parsedYAML,
     tempDir,
     codeQLCmd: codeql.getPath(),
@@ -1073,19 +1092,33 @@ export async function wrapEnvironment(
   }
 }
 
-function validateBuildModeInput(
-  buildModeInput: string | undefined,
-): BuildMode | undefined {
-  if (buildModeInput === undefined) {
+// Exported for testing
+export async function parseBuildModeInput(
+  input: string | undefined,
+  languages: Language[],
+  features: FeatureEnablement,
+  logger: Logger,
+): Promise<BuildMode | undefined> {
+  if (input === undefined) {
     return undefined;
   }
 
-  if (!Object.values(BuildMode).includes(buildModeInput as BuildMode)) {
+  if (!Object.values(BuildMode).includes(input as BuildMode)) {
     throw new ConfigurationError(
-      `Invalid build mode: '${buildModeInput}'. Supported build modes are: ${Object.values(
+      `Invalid build mode: '${input}'. Supported build modes are: ${Object.values(
         BuildMode,
       ).join(", ")}.`,
     );
   }
-  return buildModeInput as BuildMode;
+
+  if (
+    languages.includes(Language.java) &&
+    (await features.getValue(Feature.DisableJavaBuildlessEnabled))
+  ) {
+    logger.warning(
+      "Scanning Java code without a build is temporarily unavailable. Falling back to 'autobuild' build mode.",
+    );
+    return BuildMode.Autobuild;
+  }
+  return input as BuildMode;
 }
@@ -285,6 +285,7 @@ async function run() {
       workspacePath: getRequiredEnvParam("GITHUB_WORKSPACE"),
       githubVersion: gitHubVersion,
       apiDetails,
+      features,
       logger,
     });