Merge pull request #2536 from yoff/python/ff-std-lib-extraction

Python: Handle new default for standard library extraction
github · Oct 11, 2024 · 0c3e006 · 0c3e006
2 parents 38469af + 201e02e
commit 0c3e006
Show file tree

Hide file tree

Showing 9 changed files with 46 additions and 3 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/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/lib/tools-features.js b/lib/tools-features.js
diff --git a/lib/tools-features.js.map b/lib/tools-features.js.map
diff --git a/src/feature-flags.ts b/src/feature-flags.ts
@@ -47,6 +47,7 @@ export interface FeatureEnablement {
 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",
@@ -97,6 +98,12 @@ 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",

diff --git a/src/init-action.ts b/src/init-action.ts
@@ -611,6 +611,24 @@ async function run() {
       );
     }
 
+    if (
+      await codeql.supportsFeature(
+        ToolsFeature.PythonDefaultIsToNotExtractStdlib,
+      )
+    ) {
+      // We are in the case where the default has switched to not extracting the stdlib.
+      if (
+        !(await features.getValue(
+          Feature.CodeqlActionPythonDefaultIsToNotExtractStdlib,
+          codeql,
+        ))
+      ) {
+        // We are in a situation where the feature flag is not rolled out,
+        // so we need to suppress the new default behavior.
+        core.exportVariable("CODEQL_EXTRACTOR_PYTHON_EXTRACT_STDLIB", "true");
+      }
+    }
+
     const sourceRoot = path.resolve(
       getRequiredEnvParam("GITHUB_WORKSPACE"),
       getOptionalInput("source-root") || "",

diff --git a/src/tools-features.ts b/src/tools-features.ts
@@ -10,6 +10,7 @@ export enum ToolsFeature {
   TraceCommandUseBuildMode = "traceCommandUseBuildMode",
   SarifMergeRunsFromEqualCategory = "sarifMergeRunsFromEqualCategory",
   ForceOverwrite = "forceOverwrite",
+  PythonDefaultIsToNotExtractStdlib = "pythonDefaultIsToNotExtractStdlib",
 }
 
 /**