Merge branch 'main' into henrymercer/user-errors-for-upload-sarif

lib/analyze-action.js

@@ -163,7 +163,7 @@ async function run() {
         const repositoryNwo = (0, repository_1.parseRepositoryNwo)(util.getRequiredEnvParam("GITHUB_REPOSITORY"));
         const gitHubVersion = await (0, api_client_1.getGitHubVersion)();
         const features = new feature_flags_1.Features(gitHubVersion, repositoryNwo, actionsUtil.getTemporaryDirectory(), logger);
-        const memory = util.getMemoryFlag(actionsUtil.getOptionalInput("ram") || process.env["CODEQL_RAM"], await features.getValue(feature_flags_1.Feature.ScalingReservedRamEnabled));
+        const memory = util.getMemoryFlag(actionsUtil.getOptionalInput("ram") || process.env["CODEQL_RAM"]);
         await runAutobuildIfLegacyGoWorkflow(config, logger);
         dbCreationTimings = await (0, analyze_1.runFinalize)(outputDir, threads, memory, config, logger, features);
         if (actionsUtil.getRequiredInput("skip-queries") !== "true") {

lib/api-compatibility.json

@@ -1 +1 @@
-{ "maximumVersion": "3.10", "minimumVersion": "3.6" }
+{ "maximumVersion": "3.11", "minimumVersion": "3.6" }

lib/codeql.js

@@ -23,7 +23,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getGeneratedCodeScanningConfigPath = exports.getTrapCachingExtractorConfigArgsForLang = exports.getTrapCachingExtractorConfigArgs = exports.getExtraOptions = exports.getCodeQLForCmd = exports.getCodeQLForTesting = exports.getCachedCodeQL = exports.setCodeQL = exports.getCodeQL = exports.setupCodeQL = exports.CODEQL_VERSION_RESOLVE_ENVIRONMENT = exports.CODEQL_VERSION_DIAGNOSTICS_EXPORT_FIXED = exports.CODEQL_VERSION_BETTER_NO_CODE_ERROR_MESSAGE = exports.CODEQL_VERSION_INIT_WITH_QLCONFIG = exports.CODEQL_VERSION_EXPORT_CODE_SCANNING_CONFIG = exports.CODEQL_VERSION_SECURITY_EXPERIMENTAL_SUITE = exports.CODEQL_VERSION_BETTER_RESOLVE_LANGUAGES = exports.CODEQL_VERSION_GHES_PACK_DOWNLOAD = exports.CommandInvocationError = void 0;
+exports.getGeneratedCodeScanningConfigPath = exports.getTrapCachingExtractorConfigArgsForLang = exports.getTrapCachingExtractorConfigArgs = exports.getExtraOptions = exports.getCodeQLForCmd = exports.getCodeQLForTesting = exports.getCachedCodeQL = exports.setCodeQL = exports.getCodeQL = exports.setupCodeQL = exports.CODEQL_VERSION_LANGUAGE_BASELINE_CONFIG = exports.CODEQL_VERSION_RESOLVE_ENVIRONMENT = exports.CODEQL_VERSION_DIAGNOSTICS_EXPORT_FIXED = exports.CODEQL_VERSION_BETTER_NO_CODE_ERROR_MESSAGE = exports.CODEQL_VERSION_INIT_WITH_QLCONFIG = exports.CODEQL_VERSION_EXPORT_CODE_SCANNING_CONFIG = exports.CODEQL_VERSION_SECURITY_EXPERIMENTAL_SUITE = exports.CODEQL_VERSION_BETTER_RESOLVE_LANGUAGES = exports.CODEQL_VERSION_GHES_PACK_DOWNLOAD = exports.CommandInvocationError = void 0;
 const fs = __importStar(require("fs"));
 const path = __importStar(require("path"));
 const core = __importStar(require("@actions/core"));
@@ -108,6 +108,10 @@ exports.CODEQL_VERSION_DIAGNOSTICS_EXPORT_FIXED = "2.13.1";
  * Versions 2.13.4+ of the CodeQL CLI support the `resolve build-environment` command.
  */
 exports.CODEQL_VERSION_RESOLVE_ENVIRONMENT = "2.13.4";
+/**
+ * Versions 2.14.2+ of the CodeQL CLI support language-specific baseline configuration.
+ */
+exports.CODEQL_VERSION_LANGUAGE_BASELINE_CONFIG = "2.14.2";
 /**
  * Set up CodeQL CLI access.
  *
@@ -278,7 +282,7 @@ async function getCodeQLForCmd(cmd, checkVersion) {
                 (await util.codeQlVersionAbove(this, exports.CODEQL_VERSION_INIT_WITH_QLCONFIG))) {
                 extraArgs.push(`--qlconfig-file=${qlconfigFile}`);
             }
-            if (await features.getValue(feature_flags_1.Feature.LanguageBaselineConfigEnabled, this)) {
+            if (await util.codeQlVersionAbove(this, exports.CODEQL_VERSION_LANGUAGE_BASELINE_CONFIG)) {
                 extraArgs.push("--calculate-language-specific-baseline");
             }
             await runTool(cmd, [

lib/environment.js

@@ -31,6 +31,11 @@ var EnvVar;
     /** UUID representing the current job run. */
     EnvVar["JOB_RUN_UUID"] = "JOB_RUN_UUID";
     EnvVar["ODASA_TRACER_CONFIGURATION"] = "ODASA_TRACER_CONFIGURATION";
+    /**
+     * What percentage of the total amount of RAM over 8 GB that the Action should reserve for the
+     * system.
+     */
+    EnvVar["SCALING_RESERVED_RAM_PERCENTAGE"] = "CODEQL_ACTION_SCALING_RESERVED_RAM_PERCENTAGE";
     /** Whether to suppress the warning if the current CLI will soon be unsupported. */
     EnvVar["SUPPRESS_DEPRECATED_SOON_WARNING"] = "CODEQL_ACTION_SUPPRESS_DEPRECATED_SOON_WARNING";
     /** Whether to disable uploading SARIF results or status reports to the GitHub API */

lib/environment.js.map

@@ -1 +1 @@
-{"version":3,"file":"environment.js","sourceRoot":"","sources":["../src/environment.ts"],"names":[],"mappings":";;;AAAA,IAAY,MA0DX;AA1DD,WAAY,MAAM;IAChB,2DAA2D;IAC3D,+FAAqF,CAAA;IAErF,gEAAgE;IAChE,qEAA2D,CAAA;IAE3D;;;OAGG;IACH,yFAA+E,CAAA;IAE/E;;;OAGG;IACH,yEAA+D,CAAA;IAE/D,gFAAgF;IAChF,6DAAmD,CAAA;IAEnD;;;OAGG;IACH,uEAA6D,CAAA;IAE7D,gEAAgE;IAChE,mEAAyD,CAAA;IAEzD,kFAAkF;IAClF,mFAAyE,CAAA;IAEzE,6CAA6C;IAC7C,uCAA6B,CAAA;IAE7B,mEAAyD,CAAA;IAEzD,mFAAmF;IACnF,6FAAmF,CAAA;IAEnF,qFAAqF;IACrF,+CAAqC,CAAA;IAErC,mEAAyD,CAAA;IAEzD,kEAAkE;IAClE,2CAAiC,CAAA;IAEjC;;;;;;OAMG;IACH,4DAAkD,CAAA;AACpD,CAAC,EA1DW,MAAM,sBAAN,MAAM,QA0DjB"}
+{"version":3,"file":"environment.js","sourceRoot":"","sources":["../src/environment.ts"],"names":[],"mappings":";;;AAAA,IAAY,MAgEX;AAhED,WAAY,MAAM;IAChB,2DAA2D;IAC3D,+FAAqF,CAAA;IAErF,gEAAgE;IAChE,qEAA2D,CAAA;IAE3D;;;OAGG;IACH,yFAA+E,CAAA;IAE/E;;;OAGG;IACH,yEAA+D,CAAA;IAE/D,gFAAgF;IAChF,6DAAmD,CAAA;IAEnD;;;OAGG;IACH,uEAA6D,CAAA;IAE7D,gEAAgE;IAChE,mEAAyD,CAAA;IAEzD,kFAAkF;IAClF,mFAAyE,CAAA;IAEzE,6CAA6C;IAC7C,uCAA6B,CAAA;IAE7B,mEAAyD,CAAA;IAEzD;;;OAGG;IACH,2FAAiF,CAAA;IAEjF,mFAAmF;IACnF,6FAAmF,CAAA;IAEnF,qFAAqF;IACrF,+CAAqC,CAAA;IAErC,mEAAyD,CAAA;IAEzD,kEAAkE;IAClE,2CAAiC,CAAA;IAEjC;;;;;;OAMG;IACH,4DAAkD,CAAA;AACpD,CAAC,EAhEW,MAAM,sBAAN,MAAM,QAgEjB"}

lib/feature-flags.js

@@ -23,7 +23,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.logCodeScanningConfigInCli = exports.useCodeScanningConfigInCli = exports.Features = exports.FEATURE_FLAGS_FILE_NAME = exports.featureConfig = exports.Feature = exports.CODEQL_VERSION_LANGUAGE_BASELINE_CONFIG = exports.CODEQL_VERSION_INTRA_LAYER_PARALLELISM = exports.CODEQL_VERSION_ANALYSIS_SUMMARY_V2 = exports.CODEQL_VERSION_BUNDLE_SEMANTICALLY_VERSIONED = void 0;
+exports.logCodeScanningConfigInCli = exports.useCodeScanningConfigInCli = exports.Features = exports.FEATURE_FLAGS_FILE_NAME = exports.featureConfig = exports.Feature = exports.CODEQL_VERSION_INTRA_LAYER_PARALLELISM = exports.CODEQL_VERSION_ANALYSIS_SUMMARY_V2 = exports.CODEQL_VERSION_BUNDLE_SEMANTICALLY_VERSIONED = void 0;
 const fs = __importStar(require("fs"));
 const path = __importStar(require("path"));
 const semver = __importStar(require("semver"));
@@ -44,10 +44,6 @@ exports.CODEQL_VERSION_ANALYSIS_SUMMARY_V2 = "2.14.0";
  * Versions 2.14.0+ of the CodeQL CLI support intra-layer parallelism (aka fine-grained parallelism) options.
  */
 exports.CODEQL_VERSION_INTRA_LAYER_PARALLELISM = "2.14.0";
-/**
- * Versions 2.14.2+ of the CodeQL CLI support language-specific baseline configuration.
- */
-exports.CODEQL_VERSION_LANGUAGE_BASELINE_CONFIG = "2.14.2";
 /**
  * Feature enablement as returned by the GitHub API endpoint.
  *
@@ -62,10 +58,8 @@ var Feature;
     Feature["DisablePythonDependencyInstallationEnabled"] = "disable_python_dependency_installation_enabled";
     Feature["EvaluatorIntraLayerParallelismEnabled"] = "evaluator_intra_layer_parallelism_enabled";
     Feature["ExportDiagnosticsEnabled"] = "export_diagnostics_enabled";
-    Feature["LanguageBaselineConfigEnabled"] = "language_baseline_config_enabled";
     Feature["MlPoweredQueriesEnabled"] = "ml_powered_queries_enabled";
     Feature["QaTelemetryEnabled"] = "qa_telemetry_enabled";
-    Feature["ScalingReservedRamEnabled"] = "scaling_reserved_ram_enabled";
     Feature["UploadFailedSarifEnabled"] = "upload_failed_sarif_enabled";
 })(Feature || (exports.Feature = Feature = {}));
 exports.featureConfig = {
@@ -99,11 +93,6 @@ exports.featureConfig = {
         minimumVersion: "2.12.4",
         defaultValue: true,
     },
-    [Feature.LanguageBaselineConfigEnabled]: {
-        envVar: "CODEQL_ACTION_LANGUAGE_BASELINE_CONFIG",
-        minimumVersion: exports.CODEQL_VERSION_LANGUAGE_BASELINE_CONFIG,
-        defaultValue: false,
-    },
     [Feature.MlPoweredQueriesEnabled]: {
         envVar: "CODEQL_ML_POWERED_QUERIES",
         minimumVersion: undefined,
@@ -114,11 +103,6 @@ exports.featureConfig = {
         minimumVersion: undefined,
         defaultValue: false,
     },
-    [Feature.ScalingReservedRamEnabled]: {
-        envVar: "CODEQL_ACTION_SCALING_RESERVED_RAM",
-        minimumVersion: undefined,
-        defaultValue: false,
-    },
     [Feature.UploadFailedSarifEnabled]: {
         envVar: "CODEQL_ACTION_UPLOAD_FAILED_SARIF",
         minimumVersion: "2.11.3",

lib/init-action.js

@@ -173,7 +173,7 @@ async function run() {
         // options at https://codeql.github.com/docs/codeql-cli/manual/database-trace-command/
         // for details.
         core.exportVariable("CODEQL_RAM", process.env["CODEQL_RAM"] ||
-            (0, util_1.getMemoryFlagValue)((0, actions_util_1.getOptionalInput)("ram"), await features.getValue(feature_flags_1.Feature.ScalingReservedRamEnabled)).toString());
+            (0, util_1.getMemoryFlagValue)((0, actions_util_1.getOptionalInput)("ram")).toString());
         core.exportVariable("CODEQL_THREADS", (0, util_1.getThreadsFlagValue)((0, actions_util_1.getOptionalInput)("threads"), logger).toString());
         // Disable Kotlin extractor if feature flag set
         if (await features.getValue(feature_flags_1.Feature.DisableKotlinAnalysisEnabled)) {

lib/util.js

@@ -55,6 +55,10 @@ exports.DEFAULT_DEBUG_ARTIFACT_NAME = "debug-artifacts";
  * Default name of the database in the debugging artifact.
  */
 exports.DEFAULT_DEBUG_DATABASE_NAME = "db";
+/**
+ * The default fraction of the total RAM above 8 GB that should be reserved for the system.
+ */
+const DEFAULT_RESERVED_RAM_SCALING_FACTOR = 0.05;
 /**
  * Get the extra options for the codeql commands.
  */
@@ -106,18 +110,20 @@ exports.withTmpDir = withTmpDir;
  * from committing too much of the available memory to CodeQL.
  * @returns number
  */
-function getSystemReservedMemoryMegaBytes(totalMemoryMegaBytes, platform, isScalingReservedRamEnabled) {
+function getSystemReservedMemoryMegaBytes(totalMemoryMegaBytes, platform) {
     // Windows needs more memory for OS processes.
     const fixedAmount = 1024 * (platform === "win32" ? 1.5 : 1);
-    if (isScalingReservedRamEnabled) {
-        // Reserve an additional 5% of the amount of memory above 8 GB, since the amount used by the
-        // kernel for page tables scales with the size of physical memory.
-        const scaledAmount = 0.05 * Math.max(totalMemoryMegaBytes - 8 * 1024, 0);
-        return fixedAmount + scaledAmount;
-    }
-    else {
-        return fixedAmount;
+    // Reserve an additional percentage of the amount of memory above 8 GB, since the amount used by
+    // the kernel for page tables scales with the size of physical memory.
+    const scaledAmount = getReservedRamScaleFactor() * Math.max(totalMemoryMegaBytes - 8 * 1024, 0);
+    return fixedAmount + scaledAmount;
+}
+function getReservedRamScaleFactor() {
+    const envVar = Number.parseInt(process.env[environment_1.EnvVar.SCALING_RESERVED_RAM_PERCENTAGE] || "", 10);
+    if (envVar < 0 || envVar > 100 || Number.isNaN(envVar)) {
+        return DEFAULT_RESERVED_RAM_SCALING_FACTOR;
     }
+    return envVar / 100;
 }
 /**
  * Get the value of the codeql `--ram` flag as configured by the `ram` input.
@@ -126,7 +132,7 @@ function getSystemReservedMemoryMegaBytes(totalMemoryMegaBytes, platform, isScal
  *
  * @returns {number} the amount of RAM to use, in megabytes
  */
-function getMemoryFlagValueForPlatform(userInput, totalMemoryBytes, platform, isScalingReservedRamEnabled) {
+function getMemoryFlagValueForPlatform(userInput, totalMemoryBytes, platform) {
     let memoryToUseMegaBytes;
     if (userInput) {
         memoryToUseMegaBytes = Number(userInput);
@@ -136,7 +142,7 @@ function getMemoryFlagValueForPlatform(userInput, totalMemoryBytes, platform, is
     }
     else {
         const totalMemoryMegaBytes = totalMemoryBytes / (1024 * 1024);
-        const reservedMemoryMegaBytes = getSystemReservedMemoryMegaBytes(totalMemoryMegaBytes, platform, isScalingReservedRamEnabled);
+        const reservedMemoryMegaBytes = getSystemReservedMemoryMegaBytes(totalMemoryMegaBytes, platform);
         memoryToUseMegaBytes = totalMemoryMegaBytes - reservedMemoryMegaBytes;
     }
     return Math.floor(memoryToUseMegaBytes);
@@ -149,8 +155,8 @@ exports.getMemoryFlagValueForPlatform = getMemoryFlagValueForPlatform;
  *
  * @returns {number} the amount of RAM to use, in megabytes
  */
-function getMemoryFlagValue(userInput, isScalingReservedRamEnabled) {
-    return getMemoryFlagValueForPlatform(userInput, os.totalmem(), process.platform, isScalingReservedRamEnabled);
+function getMemoryFlagValue(userInput) {
+    return getMemoryFlagValueForPlatform(userInput, os.totalmem(), process.platform);
 }
 exports.getMemoryFlagValue = getMemoryFlagValue;
 /**
@@ -160,8 +166,8 @@ exports.getMemoryFlagValue = getMemoryFlagValue;
  *
  * @returns string
  */
-function getMemoryFlag(userInput, isScalingReservedRamEnabled) {
-    const megabytes = getMemoryFlagValue(userInput, isScalingReservedRamEnabled);
+function getMemoryFlag(userInput) {
+    const megabytes = getMemoryFlagValue(userInput);
     return `--ram=${megabytes}`;
 }
 exports.getMemoryFlag = getMemoryFlag;

lib/util.test.js

@@ -30,6 +30,7 @@ const fs = __importStar(require("fs"));
 const os = __importStar(require("os"));
 const path_1 = __importDefault(require("path"));
 const ava_1 = __importDefault(require("ava"));
+const environment_1 = require("./environment");
 const logging_1 = require("./logging");
 const testing_utils_1 = require("./testing-utils");
 const util = __importStar(require("./util"));
@@ -45,56 +46,58 @@ const GET_MEMORY_FLAG_TESTS = [
         totalMemoryMb: 8 * 1024,
         platform: "linux",
         expectedMemoryValue: 7 * 1024,
-        expectedMemoryValueWithScaling: 7 * 1024,
     },
     {
         input: undefined,
         totalMemoryMb: 8 * 1024,
         platform: "win32",
         expectedMemoryValue: 6.5 * 1024,
-        expectedMemoryValueWithScaling: 6.5 * 1024,
     },
     {
         input: "",
         totalMemoryMb: 8 * 1024,
         platform: "linux",
         expectedMemoryValue: 7 * 1024,
-        expectedMemoryValueWithScaling: 7 * 1024,
     },
     {
         input: "512",
         totalMemoryMb: 8 * 1024,
         platform: "linux",
         expectedMemoryValue: 512,
-        expectedMemoryValueWithScaling: 512,
     },
     {
         input: undefined,
         totalMemoryMb: 64 * 1024,
         platform: "linux",
-        expectedMemoryValue: 63 * 1024,
-        expectedMemoryValueWithScaling: 61644, // Math.floor(1024 * (64 - 1 - 0.05 * (64 - 8)))
+        expectedMemoryValue: 61644, // Math.floor(1024 * (64 - 1 - 0.05 * (64 - 8)))
     },
     {
         input: undefined,
         totalMemoryMb: 64 * 1024,
         platform: "win32",
-        expectedMemoryValue: 62.5 * 1024,
-        expectedMemoryValueWithScaling: 61132, // Math.floor(1024 * (64 - 1.5 - 0.05 * (64 - 8)))
+        expectedMemoryValue: 61132, // Math.floor(1024 * (64 - 1.5 - 0.05 * (64 - 8)))
+    },
+    {
+        input: undefined,
+        totalMemoryMb: 64 * 1024,
+        platform: "linux",
+        expectedMemoryValue: 58777,
+        reservedPercentageValue: "10",
     },
 ];
-for (const { input, totalMemoryMb, platform, expectedMemoryValue, expectedMemoryValueWithScaling, } of GET_MEMORY_FLAG_TESTS) {
-    (0, ava_1.default)(`Memory flag value is ${expectedMemoryValue} without scaling and ${expectedMemoryValueWithScaling} with scaling ` +
-        `for ${input ?? "no user input"} on ${platform} with ${totalMemoryMb} MB total system RAM`, async (t) => {
-        for (const withScaling of [true, false]) {
-            const flag = util.getMemoryFlagValueForPlatform(input, totalMemoryMb * 1024 * 1024, platform, withScaling);
-            t.deepEqual(flag, withScaling ? expectedMemoryValueWithScaling : expectedMemoryValue);
-        }
+for (const { input, totalMemoryMb, platform, expectedMemoryValue, reservedPercentageValue, } of GET_MEMORY_FLAG_TESTS) {
+    (0, ava_1.default)(`Memory flag value is ${expectedMemoryValue} for ${input ?? "no user input"} on ${platform} with ${totalMemoryMb} MB total system RAM${reservedPercentageValue
+        ? ` and reserved percentage env var set to ${reservedPercentageValue}`
+        : ""}`, async (t) => {
+        process.env[environment_1.EnvVar.SCALING_RESERVED_RAM_PERCENTAGE] =
+            reservedPercentageValue || undefined;
+        const flag = util.getMemoryFlagValueForPlatform(input, totalMemoryMb * 1024 * 1024, platform);
+        t.deepEqual(flag, expectedMemoryValue);
     });
 }
 (0, ava_1.default)("getMemoryFlag() throws if the ram input is < 0 or NaN", async (t) => {
     for (const input of ["-1", "hello!"]) {
-        t.throws(() => util.getMemoryFlag(input, false));
+        t.throws(() => util.getMemoryFlag(input));
     }
 });
 (0, ava_1.default)("getAddSnippetsFlag() should return the correct flag", (t) => {