Ghost/test/unit/server/services/labs.test.js
Kevin Ansfield a6982d5606
Added ability for themes to define custom settings (#13661)
closes https://github.com/TryGhost/Team/issues/1164

Themes can now define custom settings via their `package.json` file, and use them in templates via `@custom.{setting}`. Values for custom settings can be changed by site owners through a redesigned "Design settings" area in the admin interface.

Full announcement, documentation, and examples will be made available soon.

Co-authored-by:
- Sanne de Vries (@sanne-san)
- Thibaut Patel (@tpatel)
2021-10-22 15:02:16 +01:00

114 lines
3.8 KiB
JavaScript

const should = require('should');
const sinon = require('sinon');
const configUtils = require('../../../utils/configUtils');
const labs = require('../../../../core/shared/labs');
const settingsCache = require('../../../../core/shared/settings-cache');
function expectedLabsObject(obj) {
const withGA = Object.assign({}, obj);
labs.GA_KEYS.forEach((key) => {
withGA[key] = true;
});
return withGA;
}
describe('Labs Service', function () {
afterEach(function () {
sinon.restore();
configUtils.restore();
});
it('can getAll, even if empty with enabled members', function () {
labs.getAll().should.eql(expectedLabsObject({
members: true
}));
});
it('returns an alpha flag when dev experiments in toggled', function () {
configUtils.set('enableDeveloperExperiments', true);
sinon.stub(process.env, 'NODE_ENV').value('production');
sinon.stub(settingsCache, 'get');
settingsCache.get.withArgs('labs').returns({
oauthLogin: true
});
// 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
labs.getAll().should.eql(expectedLabsObject({
oauthLogin: true,
members: true
}));
labs.isSet('members').should.be.true;
labs.isSet('oauthLogin').should.be.true;
});
it('returns a falsy alpha flag when dev experiments in NOT toggled', function () {
configUtils.set('enableDeveloperExperiments', false);
sinon.stub(process.env, 'NODE_ENV').value('production');
sinon.stub(settingsCache, 'get');
settingsCache.get.withArgs('labs').returns({
oauthLogin: true
});
// 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
labs.getAll().should.eql(expectedLabsObject({
members: true
}));
labs.isSet('members').should.be.true;
labs.isSet('oauthLogin').should.be.false;
});
it('members flag is true when members_signup_access setting is "all"', function () {
sinon.stub(settingsCache, 'get');
settingsCache.get.withArgs('members_signup_access').returns('all');
labs.getAll().should.eql(expectedLabsObject({
members: true
}));
labs.isSet('members').should.be.true;
});
it('returns other allowlisted flags along with members', function () {
sinon.stub(settingsCache, 'get');
settingsCache.get.withArgs('members_signup_access').returns('all');
settingsCache.get.withArgs('labs').returns({
activitypub: false
});
labs.getAll().should.eql(expectedLabsObject({
members: true,
activitypub: false
}));
labs.isSet('members').should.be.true;
labs.isSet('activitypub').should.be.false;
});
it('members flag is false when members_signup_access setting is "none"', function () {
sinon.stub(settingsCache, 'get');
settingsCache.get.withArgs('members_signup_access').returns('none');
labs.getAll().should.eql(expectedLabsObject({
members: false
}));
labs.isSet('members').should.be.false;
});
it('isSet returns false for undefined', function () {
labs.isSet('bar').should.be.false;
});
it('isSet always returns false for deprecated', function () {
labs.isSet('subscribers').should.be.false;
labs.isSet('publicAPI').should.be.false;
});
});