mirror of
https://github.com/TryGhost/Ghost.git
synced 2024-12-24 19:33:02 +03:00
7069cc1221
refs: https://github.com/TryGhost/Team/issues/759 - wired up a matchHelper feature flag & used the labsEnabledHelper tool to gate the helper - added a first version of the match helper, which is intended to replace the has helper - this is an experimental helper and may or may not make it to GA - match is a simple comparison helper, right now it does a very basic equals or not equals comparison - much more functionality is needed to reach parity with has
59 lines
2.0 KiB
JavaScript
59 lines
2.0 KiB
JavaScript
const _ = require('lodash');
|
|
const Promise = require('bluebird');
|
|
const SafeString = require('../../frontend/services/theme-engine/engine').SafeString;
|
|
const errors = require('@tryghost/errors');
|
|
const i18n = require('../../shared/i18n');
|
|
const logging = require('../../shared/logging');
|
|
const settingsCache = require('../services/settings/cache');
|
|
|
|
// NOTE: this allowlist is meant to be used to filter out any unexpected
|
|
// input for the "labs" setting value
|
|
const WRITABLE_KEYS_ALLOWLIST = [
|
|
'activitypub',
|
|
'matchHelper'
|
|
];
|
|
|
|
module.exports.WRITABLE_KEYS_ALLOWLIST = WRITABLE_KEYS_ALLOWLIST;
|
|
|
|
module.exports.getAll = () => {
|
|
const labs = _.cloneDeep(settingsCache.get('labs')) || {};
|
|
|
|
labs.members = settingsCache.get('members_signup_access') !== 'none';
|
|
|
|
return labs;
|
|
};
|
|
|
|
module.exports.isSet = function isSet(flag) {
|
|
const labsConfig = module.exports.getAll();
|
|
|
|
return !!(labsConfig && labsConfig[flag] && labsConfig[flag] === true);
|
|
};
|
|
|
|
module.exports.enabledHelper = function enabledHelper(options, callback) {
|
|
const errDetails = {};
|
|
let errString;
|
|
|
|
if (module.exports.isSet(options.flagKey) === true) {
|
|
// helper is active, use the callback
|
|
return callback();
|
|
}
|
|
|
|
// Else, the helper is not active and we need to handle this as an error
|
|
errDetails.message = i18n.t(options.errMessagePath || 'warnings.helpers.helperNotAvailable', {helperName: options.helperName}),
|
|
errDetails.context = i18n.t(options.errContextPath || 'warnings.helpers.flagMustBeEnabled', {
|
|
helperName: options.helperName,
|
|
flagName: options.flagName
|
|
});
|
|
errDetails.help = i18n.t(options.errHelpPath || 'warnings.helpers.seeLink', {url: options.helpUrl});
|
|
|
|
logging.error(new errors.DisabledFeatureError(errDetails));
|
|
|
|
errString = new SafeString(`<script>console.error("${_.values(errDetails).join(' ')}");</script>`);
|
|
|
|
if (options.async) {
|
|
return Promise.resolve(errString);
|
|
}
|
|
|
|
return errString;
|
|
};
|