Skip to content

Updated labs tests to not rely on specific flags #26622

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
troyciesco wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Updated labs tests to not rely on specific flags #26622

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 27 additions & 28 deletions ghost/core/test/unit/shared/labs.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,54 +28,47 @@ describe('Labs Service', function () {
}));
});

it('returns an alpha flag when dev experiments in toggled', function () {
configUtils.set('enableDeveloperExperiments', true);
sinon.stub(process.env, 'NODE_ENV').value('production');
const getSpy = sinon.stub(settingsCache, 'get');
getSpy.withArgs('labs').returns({
urlCache: true
});
it('respects the value in config over settings', function () {
if (labs.WRITABLE_KEYS_ALLOWLIST.length === 0) {
this.skip();
}

// NOTE: this test should be rewritten to test the alpha flag independently of the internal ALPHA_FEATURES list
// otherwise we end up in the endless maintenance loop and need to update it every time a feature graduates from alpha
Copy link
Contributor Author

@troyciesco troyciesco Feb 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i think this test wasn't doing anything. enableDeveloperExperiments doesn't seem to change anything about what labs are returned, i think it just controls whether the tab for editing PRIVATE_FEATURES shows up in the UI.

to further check, i create the inverse of this test ("does not return an alpha flag when dev experiments is false") and it failed.

based on how labs works with getAll() returning all beta and private keys, I don't think a test is needed here.

assert.deepEqual(labs.getAll(), expectedLabsObject({
urlCache: true,
members: true
}));
const flag = labs.WRITABLE_KEYS_ALLOWLIST[0];

assert.equal(labs.isSet('members'), true);
assert.equal(labs.isSet('urlCache'), true);
});

it('respects the value in config over settings', function () {
configUtils.set('labs', {
collections: false
[flag]: false
});
const getSpy = sinon.stub(settingsCache, 'get');
getSpy.withArgs('labs').returns({
collections: true,
[flag]: true,
members: true
});

assert.deepEqual(labs.getAll(), expectedLabsObject({
collections: false,
[flag]: false,
members: true
}));

assert.equal(labs.isSet('collections'), false);
assert.equal(labs.isSet(flag), false);
});

it('respects the value in config over GA keys', function () {
if (labs.GA_KEYS.length === 0) {
this.skip();
}

const gaKey = labs.GA_KEYS[0];

configUtils.set('labs', {
announcementBar: false
[gaKey]: false
});

assert.deepEqual(labs.getAll(), expectedLabsObject({
announcementBar: false,
[gaKey]: false,
members: true
}));

assert.equal(labs.isSet('announcementBar'), false);
assert.equal(labs.isSet(gaKey), false);
});

it('members flag is true when members_signup_access setting is "all"', function () {
Expand All @@ -90,19 +83,25 @@ describe('Labs Service', function () {
});

it('returns other allowlisted flags along with members', function () {
if (labs.WRITABLE_KEYS_ALLOWLIST.length === 0) {
this.skip();
}

const flag = labs.WRITABLE_KEYS_ALLOWLIST[0];

const getSpy = sinon.stub(settingsCache, 'get');
getSpy.withArgs('members_signup_access').returns('all');
getSpy.withArgs('labs').returns({
activitypub: false
[flag]: false
});

assert.deepEqual(labs.getAll(), expectedLabsObject({
members: true,
activitypub: false
[flag]: false
}));

assert.equal(labs.isSet('members'), true);
assert.equal(labs.isSet('activitypub'), false);
assert.equal(labs.isSet(flag), false);
});

it('members flag is false when members_signup_access setting is "none"', function () {
Expand Down