mirror of
https://github.com/TryGhost/Ghost.git
synced 2024-12-19 08:31:43 +03:00
f4f48712c5
refs https://github.com/TryGhost/Team/issues/597 - When the library is used on a client without a DB connection (e.g. frontend client running in a browser) the library needs to expose a way to override count queries. - The way these can be used is giving a count based on a HTTP request or some other data provider - Example use with max limit like "staff" would be loading the limit servcie if following way: ``` const limitService = new LimitService(); let limits = { staff: { max: 2, currentCountQuery: () => 5 } }; limitService.loadLimits({limits, errors}); await limitService.checkIsOverLimit('staff') ```
102 lines
3.0 KiB
JavaScript
102 lines
3.0 KiB
JavaScript
const {MaxLimit, FlagLimit} = require('./limit');
|
|
const config = require('./config');
|
|
const _ = require('lodash');
|
|
|
|
class LimitService {
|
|
constructor() {
|
|
this.limits = {};
|
|
}
|
|
|
|
/**
|
|
* Initializes the limits based on configuration
|
|
*
|
|
* @param {Object} options
|
|
* @param {Object} options.limits - hash containing limit configurations keyed by limit name and containing
|
|
* @param {String} options.helpLink - URL pointing to help resources for when limit is reached
|
|
* @param {Object} options.db - knex db connection instance or other data source for the limit checks
|
|
* @param {Object} options.errors - instance of errors compatible with Ghost-Ignition's errors (https://github.com/TryGhost/Ignition#errors)
|
|
*/
|
|
loadLimits({limits, helpLink, db, errors}) {
|
|
if (!errors) {
|
|
throw new Error(`Config Missing: 'errors' is required.`);
|
|
}
|
|
|
|
this.errors = errors;
|
|
|
|
Object.keys(limits).forEach((name) => {
|
|
name = _.camelCase(name);
|
|
|
|
if (config[name]) {
|
|
/** @type LimitConfig */
|
|
let limitConfig = Object.assign({}, config[name], limits[name]);
|
|
|
|
if (_.has(limitConfig, 'max')) {
|
|
this.limits[name] = new MaxLimit({name: name, config: limitConfig, helpLink, db, errors});
|
|
} else {
|
|
this.limits[name] = new FlagLimit({name: name, config: limitConfig, helpLink, errors});
|
|
}
|
|
}
|
|
});
|
|
}
|
|
|
|
isLimited(limitName) {
|
|
return !!this.limits[_.camelCase(limitName)];
|
|
}
|
|
|
|
async checkIsOverLimit(limitName) {
|
|
if (!this.isLimited(limitName)) {
|
|
return;
|
|
}
|
|
|
|
try {
|
|
await this.limits[limitName].errorIfIsOverLimit();
|
|
return false;
|
|
} catch (error) {
|
|
if (error instanceof this.errors.HostLimitError) {
|
|
return true;
|
|
}
|
|
}
|
|
}
|
|
|
|
async checkWouldGoOverLimit(limitName) {
|
|
if (!this.isLimited(limitName)) {
|
|
return;
|
|
}
|
|
|
|
try {
|
|
await this.limits[limitName].errorIfWouldGoOverLimit();
|
|
return false;
|
|
} catch (error) {
|
|
if (error instanceof this.errors.HostLimitError) {
|
|
return true;
|
|
}
|
|
}
|
|
}
|
|
|
|
async errorIfIsOverLimit(limitName) {
|
|
if (!this.isLimited(limitName)) {
|
|
return;
|
|
}
|
|
|
|
await this.limits[limitName].errorIfIsOverLimit();
|
|
}
|
|
|
|
async errorIfWouldGoOverLimit(limitName) {
|
|
if (!this.isLimited(limitName)) {
|
|
return;
|
|
}
|
|
|
|
await this.limits[limitName].errorIfWouldGoOverLimit();
|
|
}
|
|
}
|
|
|
|
module.exports = LimitService;
|
|
|
|
/**
|
|
* @typedef {Object} LimitConfig
|
|
* @prop {Number} [max] - max limit
|
|
* @prop {Boolean} [disabled] - flag disabling/enabling limit
|
|
* @prop {String} error - custom error to be displayed when the limit is reached
|
|
* @prop {Function} [currentCountQuery] - function returning count for the "max" type of limit
|
|
*/
|