Merge pull request #2550 from github/henrymercer/fix-ff-name

Fix name of Python stdlib extraction feature flag
github · Oct 17, 2024 · af56b04 · af56b04
2 parents c470063 + 5d314b7
commit af56b04
Show file tree

Hide file tree

Showing 9 changed files with 53 additions and 24 deletions.
diff --git a/lib/feature-flags.js b/lib/feature-flags.js
diff --git a/lib/feature-flags.js.map b/lib/feature-flags.js.map
diff --git a/lib/feature-flags.test.js b/lib/feature-flags.test.js
diff --git a/lib/feature-flags.test.js.map b/lib/feature-flags.test.js.map
diff --git a/lib/init-action.js b/lib/init-action.js
diff --git a/lib/init-action.js.map b/lib/init-action.js.map
diff --git a/src/feature-flags.test.ts b/src/feature-flags.test.ts
@@ -495,6 +495,17 @@ test("non-legacy feature flags should not end with _enabled", async (t) => {
   }
 });
 
+test("non-legacy feature flags should not start with codeql_action_", async (t) => {
+  for (const [feature, config] of Object.entries(featureConfig)) {
+    if (!config.legacyApi) {
+      t.false(
+        feature.startsWith("codeql_action_"),
+        `non-legacy feature ${feature} should not start with 'codeql_action_'`,
+      );
+    }
+  }
+});
+
 function assertAllFeaturesUndefinedInApi(
   t: ExecutionContext<unknown>,
   loggedMessages: LoggedMessage[],

diff --git a/src/feature-flags.ts b/src/feature-flags.ts
@@ -42,17 +42,20 @@ export interface FeatureEnablement {
 /**
  * Feature enablement as returned by the GitHub API endpoint.
  *
+ * Do not include the `codeql_action_` prefix as this is stripped by the API
+ * endpoint.
+ *
  * Legacy features should end with `_enabled`.
  */
 export enum Feature {
   ArtifactV4Upgrade = "artifact_v4_upgrade",
   CleanupTrapCaches = "cleanup_trap_caches",
-  CodeqlActionPythonDefaultIsToNotExtractStdlib = "codeql_action_python_default_is_to_not_extract_stdlib",
   CppDependencyInstallation = "cpp_dependency_installation_enabled",
   DisableCsharpBuildless = "disable_csharp_buildless",
   DisableJavaBuildlessEnabled = "disable_java_buildless_enabled",
   DisableKotlinAnalysisEnabled = "disable_kotlin_analysis_enabled",
   ExportDiagnosticsEnabled = "export_diagnostics_enabled",
+  PythonDefaultIsToNotExtractStdlib = "python_default_is_to_not_extract_stdlib",
   QaTelemetryEnabled = "qa_telemetry_enabled",
   ZstdBundle = "zstd_bundle",
   ZstdBundleStreamingExtraction = "zstd_bundle_streaming_extraction",
@@ -99,12 +102,6 @@ export const featureConfig: Record<
     envVar: "CODEQL_ACTION_CLEANUP_TRAP_CACHES",
     minimumVersion: undefined,
   },
-  [Feature.CodeqlActionPythonDefaultIsToNotExtractStdlib]: {
-    defaultValue: false,
-    envVar: "CODEQL_ACTION_DISABLE_PYTHON_STANDARD_LIBRARY_EXTRACTION",
-    minimumVersion: undefined,
-    toolsFeature: ToolsFeature.PythonDefaultIsToNotExtractStdlib,
-  },
   [Feature.CppDependencyInstallation]: {
     defaultValue: false,
     envVar: "CODEQL_EXTRACTOR_CPP_AUTOINSTALL_DEPENDENCIES",
@@ -134,6 +131,12 @@ export const featureConfig: Record<
     legacyApi: true,
     minimumVersion: undefined,
   },
+  [Feature.PythonDefaultIsToNotExtractStdlib]: {
+    defaultValue: false,
+    envVar: "CODEQL_ACTION_DISABLE_PYTHON_STANDARD_LIBRARY_EXTRACTION",
+    minimumVersion: undefined,
+    toolsFeature: ToolsFeature.PythonDefaultIsToNotExtractStdlib,
+  },
   [Feature.QaTelemetryEnabled]: {
     defaultValue: false,
     envVar: "CODEQL_ACTION_QA_TELEMETRY",

diff --git a/src/init-action.ts b/src/init-action.ts
@@ -594,15 +594,18 @@ async function run() {
         ToolsFeature.PythonDefaultIsToNotExtractStdlib,
       )
     ) {
-      // We are in the case where the default has switched to not extracting the stdlib.
-      if (
+      if (process.env["CODEQL_EXTRACTOR_PYTHON_EXTRACT_STDLIB"]) {
+        logger.debug(
+          "CODEQL_EXTRACTOR_PYTHON_EXTRACT_STDLIB is already set, so the Action will not override it.",
+        );
+      } else if (
         !(await features.getValue(
-          Feature.CodeqlActionPythonDefaultIsToNotExtractStdlib,
+          Feature.PythonDefaultIsToNotExtractStdlib,
           codeql,
         ))
       ) {
         // We are in a situation where the feature flag is not rolled out,
-        // so we need to suppress the new default behavior.
+        // so we need to suppress the new default CLI behavior.
         core.exportVariable("CODEQL_EXTRACTOR_PYTHON_EXTRACT_STDLIB", "true");
       }
     }