Skip to content

Commit 27d3b2f

Browse files
committed
Fix scaling reserved RAM feature flag naming
1 parent da4e0a0 commit 27d3b2f

12 files changed

+36
-12
lines changed

lib/feature-flags.js

+7-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

lib/feature-flags.js.map

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

lib/feature-flags.test.js

+5
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

lib/feature-flags.test.js.map

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

lib/util.js

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

lib/util.js.map

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

lib/util.test.js

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

lib/util.test.js.map

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/feature-flags.test.ts

+9
Original file line numberDiff line numberDiff line change
@@ -482,6 +482,15 @@ test("ignores invalid version numbers in default version feature flags", async (
482482
});
483483
});
484484

485+
test("feature flags should end with _enabled", async (t) => {
486+
for (const feature of Object.values(Feature)) {
487+
t.assert(
488+
feature.endsWith("_enabled"),
489+
`${feature} should end with '_enabled'`
490+
);
491+
}
492+
});
493+
485494
function assertAllFeaturesUndefinedInApi(
486495
t: ExecutionContext<unknown>,
487496
loggedMessages: LoggedMessage[]

src/feature-flags.ts

+7-2
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,11 @@ export interface FeatureEnablement {
3131
getValue(feature: Feature, codeql?: CodeQL): Promise<boolean>;
3232
}
3333

34+
/**
35+
* Feature enablement as returned by the GitHub API endpoint.
36+
*
37+
* Each value of this enum should end with `_enabled`.
38+
*/
3439
export enum Feature {
3540
CliConfigFileEnabled = "cli_config_file_enabled",
3641
DisableKotlinAnalysisEnabled = "disable_kotlin_analysis_enabled",
@@ -39,7 +44,7 @@ export enum Feature {
3944
MlPoweredQueriesEnabled = "ml_powered_queries_enabled",
4045
NewAnalysisSummaryEnabled = "new_analysis_summary_enabled",
4146
QaTelemetryEnabled = "qa_telemetry_enabled",
42-
ScalingReservedRam = "scaling_reserved_ram",
47+
ScalingReservedRamEnabled = "scaling_reserved_ram_enabled",
4348
UploadFailedSarifEnabled = "upload_failed_sarif_enabled",
4449
}
4550

@@ -77,7 +82,7 @@ export const featureConfig: Record<
7782
minimumVersion: undefined,
7883
defaultValue: false,
7984
},
80-
[Feature.ScalingReservedRam]: {
85+
[Feature.ScalingReservedRamEnabled]: {
8186
envVar: "CODEQL_ACTION_SCALING_RESERVED_RAM",
8287
minimumVersion: undefined,
8388
defaultValue: false,

src/util.test.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ test("getMemoryFlag() should return the correct --ram flag", async (t) => {
4848

4949
for (const [input, withScaling, expectedFlag] of tests) {
5050
const features = createFeatures(
51-
withScaling ? [Feature.ScalingReservedRam] : []
51+
withScaling ? [Feature.ScalingReservedRamEnabled] : []
5252
);
5353
const flag = await util.getMemoryFlag(input, features);
5454
t.deepEqual(flag, expectedFlag);

src/util.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ async function getSystemReservedMemoryMegaBytes(
164164
// Windows needs more memory for OS processes.
165165
const fixedAmount = 1024 * (process.platform === "win32" ? 1.5 : 1);
166166

167-
if (await features.getValue(Feature.ScalingReservedRam)) {
167+
if (await features.getValue(Feature.ScalingReservedRamEnabled)) {
168168
// Reserve an additional 2% of the total memory, since the amount used by
169169
// the kernel for page tables scales with the size of physical memory.
170170
const scaledAmount = 0.02 * totalMemoryMegaBytes;

0 commit comments

Comments
 (0)