1a17c59fb0
Avoid usage of "Feature Flag" unless we are talking specifically about the response from github features api. Otherwise, use terms like "Toggleable features". Note both "toggleable" and "togglable" appear to be valid spellings of the word. I chose the first for no good reason.
188 lines
No EOL
11 KiB
JavaScript
Generated
188 lines
No EOL
11 KiB
JavaScript
Generated
"use strict";
|
|
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
};
|
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
const ava_1 = __importDefault(require("ava"));
|
|
const feature_flags_1 = require("./feature-flags");
|
|
const logging_1 = require("./logging");
|
|
const repository_1 = require("./repository");
|
|
const testing_utils_1 = require("./testing-utils");
|
|
const util_1 = require("./util");
|
|
(0, testing_utils_1.setupTests)(ava_1.default);
|
|
ava_1.default.beforeEach(() => {
|
|
(0, util_1.initializeEnvironment)(util_1.Mode.actions, "1.2.3");
|
|
});
|
|
const testApiDetails = {
|
|
auth: "1234",
|
|
url: "https://github.com",
|
|
apiURL: undefined,
|
|
};
|
|
const testRepositoryNwo = (0, repository_1.parseRepositoryNwo)("github/example");
|
|
const ALL_FEATURE_FLAGS_DISABLED_VARIANTS = [
|
|
{
|
|
description: "GHES",
|
|
gitHubVersion: { type: util_1.GitHubVariant.GHES, version: "3.0.0" },
|
|
},
|
|
{ description: "GHAE", gitHubVersion: { type: util_1.GitHubVariant.GHAE } },
|
|
];
|
|
for (const variant of ALL_FEATURE_FLAGS_DISABLED_VARIANTS) {
|
|
(0, ava_1.default)(`All feature flags are disabled if running against ${variant.description}`, async (t) => {
|
|
await (0, util_1.withTmpDir)(async (tmpDir) => {
|
|
const loggedMessages = [];
|
|
const featureFlags = setUpTests(tmpDir, (0, testing_utils_1.getRecordingLogger)(loggedMessages), variant.gitHubVersion);
|
|
for (const flag of Object.values(feature_flags_1.Feature)) {
|
|
t.false(await featureFlags.getValue(flag, includeCodeQlIfRequired(flag)));
|
|
}
|
|
t.assert(loggedMessages.find((v) => v.type === "debug" &&
|
|
v.message ===
|
|
"Not running against github.com. Disabling all feature flags.") !== undefined);
|
|
});
|
|
});
|
|
}
|
|
(0, ava_1.default)("API response missing", async (t) => {
|
|
await (0, util_1.withTmpDir)(async (tmpDir) => {
|
|
const loggedMessages = [];
|
|
const featureFlags = setUpTests(tmpDir, (0, testing_utils_1.getRecordingLogger)(loggedMessages));
|
|
(0, testing_utils_1.mockFeatureFlagApiEndpoint)(403, {});
|
|
for (const flag of Object.values(feature_flags_1.Feature)) {
|
|
t.assert((await featureFlags.getValue(flag, includeCodeQlIfRequired(flag))) ===
|
|
false);
|
|
}
|
|
assertAllFeaturesUndefinedInApi(t, loggedMessages);
|
|
});
|
|
});
|
|
(0, ava_1.default)("Feature flags are disabled if they're not returned in API response", async (t) => {
|
|
await (0, util_1.withTmpDir)(async (tmpDir) => {
|
|
const loggedMessages = [];
|
|
const featureFlags = setUpTests(tmpDir, (0, testing_utils_1.getRecordingLogger)(loggedMessages));
|
|
(0, testing_utils_1.mockFeatureFlagApiEndpoint)(200, {});
|
|
for (const flag of Object.values(feature_flags_1.Feature)) {
|
|
t.assert((await featureFlags.getValue(flag, includeCodeQlIfRequired(flag))) ===
|
|
false);
|
|
}
|
|
assertAllFeaturesUndefinedInApi(t, loggedMessages);
|
|
});
|
|
});
|
|
(0, ava_1.default)("Feature flags exception is propagated if the API request errors", async (t) => {
|
|
await (0, util_1.withTmpDir)(async (tmpDir) => {
|
|
const featureFlags = setUpTests(tmpDir);
|
|
(0, testing_utils_1.mockFeatureFlagApiEndpoint)(500, {});
|
|
await t.throwsAsync(async () => featureFlags.getValue(feature_flags_1.Feature.MlPoweredQueriesEnabled, includeCodeQlIfRequired(feature_flags_1.Feature.MlPoweredQueriesEnabled)), {
|
|
message: "Encountered an error while trying to load feature flags: Error: some error message",
|
|
});
|
|
});
|
|
});
|
|
for (const featureFlag of Object.keys(feature_flags_1.featureConfig)) {
|
|
(0, ava_1.default)(`Only feature flag '${featureFlag}' is enabled if enabled in the API response. Other flags disabled`, async (t) => {
|
|
await (0, util_1.withTmpDir)(async (tmpDir) => {
|
|
const featureFlags = setUpTests(tmpDir);
|
|
// set all feature flags to false except the one we're testing
|
|
const expectedFeatureFlags = {};
|
|
for (const f of Object.keys(feature_flags_1.featureConfig)) {
|
|
expectedFeatureFlags[f] = f === featureFlag;
|
|
}
|
|
(0, testing_utils_1.mockFeatureFlagApiEndpoint)(200, expectedFeatureFlags);
|
|
// retrieve the values of the actual feature flags
|
|
const actualFeatureFlags = {};
|
|
for (const f of Object.keys(feature_flags_1.featureConfig)) {
|
|
actualFeatureFlags[f] = await featureFlags.getValue(f, includeCodeQlIfRequired(f));
|
|
}
|
|
// Alls flags should be false except the one we're testing
|
|
t.deepEqual(actualFeatureFlags, expectedFeatureFlags);
|
|
});
|
|
});
|
|
(0, ava_1.default)(`Only feature flag '${featureFlag}' is enabled if the associated environment variable is true. Others disabled.`, async (t) => {
|
|
await (0, util_1.withTmpDir)(async (tmpDir) => {
|
|
const featureFlags = setUpTests(tmpDir);
|
|
const expectedFeatureFlags = initializeFeatures(false);
|
|
(0, testing_utils_1.mockFeatureFlagApiEndpoint)(200, expectedFeatureFlags);
|
|
// feature flag should be disabled initially
|
|
t.assert(!(await featureFlags.getValue(featureFlag, includeCodeQlIfRequired(featureFlag))));
|
|
// set env var to true and check that the feature flag is now enabled
|
|
process.env[feature_flags_1.featureConfig[featureFlag].envVar] = "true";
|
|
t.assert(await featureFlags.getValue(featureFlag, includeCodeQlIfRequired(featureFlag)));
|
|
});
|
|
});
|
|
(0, ava_1.default)(`Feature flag '${featureFlag}' is disabled if the associated environment variable is false, even if enabled in API`, async (t) => {
|
|
await (0, util_1.withTmpDir)(async (tmpDir) => {
|
|
const featureFlags = setUpTests(tmpDir);
|
|
const expectedFeatureFlags = initializeFeatures(true);
|
|
(0, testing_utils_1.mockFeatureFlagApiEndpoint)(200, expectedFeatureFlags);
|
|
// feature flag should be enabled initially
|
|
t.assert(await featureFlags.getValue(featureFlag, includeCodeQlIfRequired(featureFlag)));
|
|
// set env var to false and check that the feature flag is now disabled
|
|
process.env[feature_flags_1.featureConfig[featureFlag].envVar] = "false";
|
|
t.assert(!(await featureFlags.getValue(featureFlag, includeCodeQlIfRequired(featureFlag))));
|
|
});
|
|
});
|
|
if (feature_flags_1.featureConfig[featureFlag].minimumVersion !== undefined) {
|
|
(0, ava_1.default)(`Getting Feature Flag '${featureFlag} should throw if no codeql is provided`, async (t) => {
|
|
await (0, util_1.withTmpDir)(async (tmpDir) => {
|
|
const featureFlags = setUpTests(tmpDir);
|
|
const expectedFeatureFlags = initializeFeatures(true);
|
|
(0, testing_utils_1.mockFeatureFlagApiEndpoint)(200, expectedFeatureFlags);
|
|
await t.throwsAsync(async () => featureFlags.getValue(featureFlag), {
|
|
message: `Internal error: A minimum version is specified for feature flag ${featureFlag}, but no instance of CodeQL was provided.`,
|
|
});
|
|
});
|
|
});
|
|
}
|
|
if (feature_flags_1.featureConfig[featureFlag].minimumVersion !== undefined) {
|
|
(0, ava_1.default)(`Feature flag '${featureFlag}' is disabled if the minimum CLI version is below ${feature_flags_1.featureConfig[featureFlag].minimumVersion}`, async (t) => {
|
|
await (0, util_1.withTmpDir)(async (tmpDir) => {
|
|
const featureFlags = setUpTests(tmpDir);
|
|
const expectedFeatureFlags = initializeFeatures(true);
|
|
(0, testing_utils_1.mockFeatureFlagApiEndpoint)(200, expectedFeatureFlags);
|
|
// feature flag should be disabled when an old CLI version is set
|
|
let codeql = (0, testing_utils_1.mockCodeQLVersion)("2.0.0");
|
|
t.assert(!(await featureFlags.getValue(featureFlag, codeql)));
|
|
// even setting the env var to true should not enable the feature flag if
|
|
// the minimum CLI version is not met
|
|
process.env[feature_flags_1.featureConfig[featureFlag].envVar] = "true";
|
|
t.assert(!(await featureFlags.getValue(featureFlag, codeql)));
|
|
// feature flag should be enabled when a new CLI version is set
|
|
// and env var is not set
|
|
process.env[feature_flags_1.featureConfig[featureFlag].envVar] = "";
|
|
codeql = (0, testing_utils_1.mockCodeQLVersion)(feature_flags_1.featureConfig[featureFlag].minimumVersion);
|
|
t.assert(await featureFlags.getValue(featureFlag, codeql));
|
|
// set env var to false and check that the feature flag is now disabled
|
|
process.env[feature_flags_1.featureConfig[featureFlag].envVar] = "false";
|
|
t.assert(!(await featureFlags.getValue(featureFlag, codeql)));
|
|
});
|
|
});
|
|
}
|
|
}
|
|
// If we ever run into a situation where we no longer have any feature flags that
|
|
// specify a minimum version, then we will have a bunch of code no longer being
|
|
// tested. This is unlikely, and this test will fail if that happens.
|
|
// If we do end up in that situation, then we should consider adding a synthetic
|
|
// feature flag with a minium version that is only used for tests.
|
|
(0, ava_1.default)("At least one feature has a minimum version specified", (t) => {
|
|
t.assert(Object.values(feature_flags_1.featureConfig).some((f) => f.minimumVersion !== undefined), "At least one feature flag should have a minimum version specified");
|
|
// An even less likely scenario is that we no longer have any feature flags.
|
|
t.assert(Object.values(feature_flags_1.featureConfig).length > 0, "There should be at least one feature flag");
|
|
});
|
|
function assertAllFeaturesUndefinedInApi(t, loggedMessages) {
|
|
for (const featureFlag of Object.keys(feature_flags_1.featureConfig)) {
|
|
t.assert(loggedMessages.find((v) => v.type === "debug" &&
|
|
v.message.includes(featureFlag) &&
|
|
v.message.includes("considering it disabled")) !== undefined);
|
|
}
|
|
}
|
|
function initializeFeatures(initialValue) {
|
|
return Object.keys(feature_flags_1.featureConfig).reduce((features, key) => {
|
|
features[key] = initialValue;
|
|
return features;
|
|
}, {});
|
|
}
|
|
function setUpTests(tmpDir, logger = (0, logging_1.getRunnerLogger)(true), gitHubVersion = { type: util_1.GitHubVariant.DOTCOM }) {
|
|
(0, testing_utils_1.setupActionsVars)(tmpDir, tmpDir);
|
|
return new feature_flags_1.Features(gitHubVersion, testApiDetails, testRepositoryNwo, logger);
|
|
}
|
|
function includeCodeQlIfRequired(featureFlag) {
|
|
return feature_flags_1.featureConfig[featureFlag].minimumVersion !== undefined
|
|
? (0, testing_utils_1.mockCodeQLVersion)("9.9.9")
|
|
: undefined;
|
|
}
|
|
//# sourceMappingURL=feature-flags.test.js.map
|