Fix scaling reserved RAM feature flag naming

github · Jul 18, 2023 · 27d3b2f · 27d3b2f
1 parent da4e0a0
commit 27d3b2f
Show file tree

Hide file tree

Showing 12 changed files with 36 additions and 12 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/util.js b/lib/util.js
diff --git a/lib/util.js.map b/lib/util.js.map
diff --git a/lib/util.test.js b/lib/util.test.js
diff --git a/lib/util.test.js.map b/lib/util.test.js.map
diff --git a/src/feature-flags.test.ts b/src/feature-flags.test.ts
@@ -482,6 +482,15 @@ test("ignores invalid version numbers in default version feature flags", async (
   });
 });
 
+test("feature flags should end with _enabled", async (t) => {
+  for (const feature of Object.values(Feature)) {
+    t.assert(
+      feature.endsWith("_enabled"),
+      `${feature} should end with '_enabled'`
+    );
+  }
+});
+
 function assertAllFeaturesUndefinedInApi(
   t: ExecutionContext<unknown>,
   loggedMessages: LoggedMessage[]

diff --git a/src/feature-flags.ts b/src/feature-flags.ts
@@ -31,6 +31,11 @@ export interface FeatureEnablement {
   getValue(feature: Feature, codeql?: CodeQL): Promise<boolean>;
 }
 
+/**
+ * Feature enablement as returned by the GitHub API endpoint.
+ *
+ * Each value of this enum should end with `_enabled`.
+ */
 export enum Feature {
   CliConfigFileEnabled = "cli_config_file_enabled",
   DisableKotlinAnalysisEnabled = "disable_kotlin_analysis_enabled",
@@ -39,7 +44,7 @@ export enum Feature {
   MlPoweredQueriesEnabled = "ml_powered_queries_enabled",
   NewAnalysisSummaryEnabled = "new_analysis_summary_enabled",
   QaTelemetryEnabled = "qa_telemetry_enabled",
-  ScalingReservedRam = "scaling_reserved_ram",
+  ScalingReservedRamEnabled = "scaling_reserved_ram_enabled",
   UploadFailedSarifEnabled = "upload_failed_sarif_enabled",
 }
 
@@ -77,7 +82,7 @@ export const featureConfig: Record<
     minimumVersion: undefined,
     defaultValue: false,
   },
-  [Feature.ScalingReservedRam]: {
+  [Feature.ScalingReservedRamEnabled]: {
     envVar: "CODEQL_ACTION_SCALING_RESERVED_RAM",
     minimumVersion: undefined,
     defaultValue: false,

diff --git a/src/util.test.ts b/src/util.test.ts
@@ -48,7 +48,7 @@ test("getMemoryFlag() should return the correct --ram flag", async (t) => {
 
   for (const [input, withScaling, expectedFlag] of tests) {
     const features = createFeatures(
-      withScaling ? [Feature.ScalingReservedRam] : []
+      withScaling ? [Feature.ScalingReservedRamEnabled] : []
     );
     const flag = await util.getMemoryFlag(input, features);
     t.deepEqual(flag, expectedFlag);

diff --git a/src/util.ts b/src/util.ts
@@ -164,7 +164,7 @@ async function getSystemReservedMemoryMegaBytes(
   // Windows needs more memory for OS processes.
   const fixedAmount = 1024 * (process.platform === "win32" ? 1.5 : 1);
 
-  if (await features.getValue(Feature.ScalingReservedRam)) {
+  if (await features.getValue(Feature.ScalingReservedRamEnabled)) {
     // Reserve an additional 2% of the total memory, since the amount used by
     // the kernel for page tables scales with the size of physical memory.
     const scaledAmount = 0.02 * totalMemoryMegaBytes;