@tryghost/limit-service 0.6.4 → 1.0.2

package/README.md

@@ -24,7 +24,7 @@ const LimitService = require('@tryghost/limit-service');
 const limitService = new LimitService();
 
 // setup limit configuration
-// currently supported limit keys are: staff, members, customThemes, customIntegrations
+// currently supported limit keys are: staff, members, customThemes, customIntegrations, uploads
 // all limit configs support custom "error" configuration that is a template string
 const limits = {
     // staff and member are "max" type of limits accepting "max" configuration
@@ -59,6 +59,12 @@ const limits = {
     //     maxPeriodic: 42,
     //     error: 'Your plan supports up to {{max}} emails. Please upgrade to reenable sending emails.'
     // }
+    uploads: {
+        // max key is in bytes
+        max: 5000000,
+        // formatting of the {{ max }} vairable is in MB, e.g: 5MB
+        error: 'Your plan supports uploads of max size up to {{max}}. Please upgrade to reenable uploading.'
+    }
 };
 
 // This information is needed for the limit service to work with "max periodic" limits
@@ -116,6 +122,11 @@ if (limitService.isLimited('members')) {
     await limitService.errorIfIsOverLimit('members', {max: 10000});
 }
 
+if (limitService.isLimited('uploads')) {
+    // for the uploads limit we HAVE TO pass in the "currentCount" parameter and use bytes as a base unit
+    await limitService.errorIfIsOverLimit('uploads', {currentCount: frame.file.size});
+}
+
 // check if any of the limits are acceding
 if (limitService.checkIfAnyOverLimit()) {
     console.log('One of the limits has acceded!');
@@ -130,7 +141,7 @@ At the moment there are four different types of limits that limit service allows
 4. `allowList` - checks if provided value is defined in configured "allowlist". Example usecase: "disable theme activation if it is not an official theme". To configure this limit define ` allowlist: ['VALUE_1', 'VALUE_2', 'VALUE_N']` property in the "limits" parameter. 
 
 ### Supported limits
-There's a limited amount of limits that are supported by limit service. The are defined by "key" property name in the "config" module. List of currently supported limit names: `members`, `staff`, `customIntegrations`, `emails`, `customThemes`. 
+There's a limited amount of limits that are supported by limit service. The are defined by "key" property name in the "config" module. List of currently supported limit names: `members`, `staff`, `customIntegrations`, `emails`, `customThemes`, `uploads`. 
 
 All limits can act as `flag` or `allowList` types. Only certain (`members`, `staff`, and`customIntegrations`) can have a `max` limit. Only `emails` currently supports the `maxPeriodic` type of limit.
 

package/lib/config.js

@@ -45,5 +45,14 @@ module.exports = {
             return result.count;
         }
     },
-    customThemes: {}
+    customThemes: {},
+    uploads: {
+        // NOTE: this function should not ever be used as for uploads we compare the size
+        //       of the uploaded file with the configured limit. Noop is here to keep the
+        //       MaxLimit constructor happy
+        currentCountQuery: () => {},
+        // NOTE: the uploads limit is based on file sizes provided in Bytes
+        //       a custom formatter is here for more user-friendly formatting when forming an error
+        formatter: count => `${count / 1000000}MB`
+    }
 };

package/lib/limit-service.js

@@ -21,7 +21,7 @@ class LimitService {
      * @param {Object} [options.subscription] - hash containing subscription configuration with interval and startDate properties
      * @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)
+     * @param {Object} options.errors - instance of errors compatible with GhostError errors (@tryghost/errors)
      */
     loadLimits({limits = {}, subscription, helpLink, db, errors}) {
         if (!errors) {
@@ -101,6 +101,12 @@ class LimitService {
         }
     }
 
+    /**
+     *
+     * @param {String} limitName - name of the configured limit
+     * @param {Object} metadata - limit parameters
+     * @returns
+     */
     async errorIfIsOverLimit(limitName, metadata = {}) {
         if (!this.isLimited(limitName)) {
             return;
@@ -109,6 +115,12 @@ class LimitService {
         await this.limits[limitName].errorIfIsOverLimit(metadata);
     }
 
+    /**
+     *
+     * @param {String} limitName - name of the configured limit
+     * @param {Object} metadata - limit parameters
+     * @returns
+     */
     async errorIfWouldGoOverLimit(limitName, metadata = {}) {
         if (!this.isLimited(limitName)) {
             return;
@@ -118,9 +130,9 @@ class LimitService {
     }
 
     /**
-     * Checks if any of the configured limits acced
+     * Checks if any of the configured limits acceded
      *
-     * @returns {boolean}
+     * @returns {Promise<boolean>}
      */
     async checkIfAnyOverLimit() {
         for (const limit in this.limits) {

package/lib/limit.js

@@ -5,6 +5,15 @@ const {lastPeriodStart, SUPPORTED_INTERVALS} = require('./date-utils');
 _.templateSettings.interpolate = /{{([\s\S]+?)}}/g;
 
 class Limit {
+    /**
+     *
+     * @param {Object} options
+     * @param {String} options.name - name of the limit
+     * @param {String} options.error - error message to use when limit is reached
+     * @param {String} options.helpLink - URL to the resource explaining how the limit works
+     * @param {Object} [options.db] - instance of knex db connection that currentCountQuery can use to run state check through
+     * @param {Object} options.errors - instance of errors compatible with GhostError errors (@tryghost/errors)
+     */
     constructor({name, error, helpLink, db, errors}) {
         this.name = name;
         this.error = error;
@@ -36,9 +45,11 @@ class MaxLimit extends Limit {
      * @param {Object} options.config - limit configuration
      * @param {Number} options.config.max - maximum limit the limit would check against
      * @param {Function} options.config.currentCountQuery - query checking the state that would be compared against the limit
-     * @param {String} options.helpLink - URL to the resource explaining how the limit works
-     * @param {Object} options.db - instance of knex db connection that currentCountQuery can use to run state check through
-     * @param {Object} options.errors - instance of errors compatible with Ghost-Ignition's errors (https://github.com/TryGhost/Ignition#errors)
+     * @param {Function} [options.config.formatter] - function to format the limit counts before they are passed to the error message
+     * @param {String} [options.config.error] - error message to use when limit is reached
+     * @param {String} [options.helpLink] - URL to the resource explaining how the limit works
+     * @param {Object} [options.db] - instance of knex db connection that currentCountQuery can use to run state check through
+     * @param {Object} options.errors - instance of errors compatible with GhostError errors (@tryghost/errors)
      */
     constructor({name, config, helpLink, db, errors}) {
         super({name, error: config.error || '', helpLink, db, errors});
@@ -53,20 +64,27 @@ class MaxLimit extends Limit {
 
         this.currentCountQueryFn = config.currentCountQuery;
         this.max = config.max;
+        this.formatter = config.formatter;
         this.fallbackMessage = `This action would exceed the ${_.lowerCase(this.name)} limit on your current plan.`;
     }
 
+    /**
+     *
+     * @param {Number} count - current count that acceded the limit
+     * @returns {Object} instance of HostLimitError
+     */
     generateError(count) {
         let errorObj = super.generateError();
 
         errorObj.message = this.fallbackMessage;
 
         if (this.error) {
+            const formatter = this.formatter || Intl.NumberFormat().format;
             try {
                 errorObj.message = _.template(this.error)(
                     {
-                        max: Intl.NumberFormat().format(this.max),
-                        count: Intl.NumberFormat().format(count),
+                        max: formatter(this.max),
+                        count: formatter(count),
                         name: this.name
                     });
             } catch (e) {
@@ -85,13 +103,14 @@ class MaxLimit extends Limit {
     }
 
     /**
-     * Throws a HostLimitError if the configured or passed max limit is ecceded by currentCountQuery
+     * Throws a HostLimitError if the configured or passed max limit is acceded by currentCountQuery
      *
      * @param {Object} options
      * @param {Number} [options.max] - overrides configured default max value to perform checks against
+     * @param {Number} [options.addedCount] - number of items to add to the currentCount during the check
      */
     async errorIfWouldGoOverLimit({max, addedCount = 1} = {}) {
-        let currentCount = await this.currentCountQuery(this.db);
+        let currentCount = await this.currentCountQuery();
 
         if ((currentCount + addedCount) > (max || this.max)) {
             throw this.generateError(currentCount);
@@ -99,13 +118,14 @@ class MaxLimit extends Limit {
     }
 
     /**
-     * Throws a HostLimitError if the configured or passed max limit is ecceded by currentCountQuery
+     * Throws a HostLimitError if the configured or passed max limit is acceded by currentCountQuery
      *
      * @param {Object} options
      * @param {Number} [options.max] - overrides configured default max value to perform checks against
+     * @param {Number} [options.currentCount] - overrides currentCountQuery to perform checks against
      */
-    async errorIfIsOverLimit({max} = {}) {
-        let currentCount = await this.currentCountQuery(this.db);
+    async errorIfIsOverLimit({max, currentCount} = {}) {
+        currentCount = currentCount || await this.currentCountQuery();
 
         if (currentCount > (max || this.max)) {
             throw this.generateError(currentCount);
@@ -120,12 +140,13 @@ class MaxPeriodicLimit extends Limit {
      * @param {String} options.name - name of the limit
      * @param {Object} options.config - limit configuration
      * @param {Number} options.config.maxPeriodic - maximum limit the limit would check against
+     * @param {String} options.config.error - error message to use when limit is reached
      * @param {Function} options.config.currentCountQuery - query checking the state that would be compared against the limit
      * @param {('month')} options.config.interval - an interval to take into account when checking the limit. Currently only supports 'month' value
      * @param {String} options.config.startDate - start date in ISO 8601 format (https://en.wikipedia.org/wiki/ISO_8601), used to calculate period intervals
      * @param {String} options.helpLink - URL to the resource explaining how the limit works
-     * @param {Object} options.db - instance of knex db connection that currentCountQuery can use to run state check through
-     * @param {Object} options.errors - instance of errors compatible with Ghost-Ignition's errors (https://github.com/TryGhost/Ignition#errors)
+     * @param {Object} [options.db] - instance of knex db connection that currentCountQuery can use to run state check through
+     * @param {Object} options.errors - instance of errors compatible with GhostError errors (@tryghost/errors)
      */
     constructor({name, config, helpLink, db, errors}) {
         super({name, error: config.error || '', helpLink, db, errors});
@@ -188,13 +209,14 @@ class MaxPeriodicLimit extends Limit {
     }
 
     /**
-     * Throws a HostLimitError if the configured or passed max limit is ecceded by currentCountQuery
+     * Throws a HostLimitError if the configured or passed max limit is acceded by currentCountQuery
      *
      * @param {Object} options
      * @param {Number} [options.max] - overrides configured default maxPeriodic value to perform checks against
+     * @param {Number} [options.addedCount] - number of items to add to the currentCount during the check
      */
     async errorIfWouldGoOverLimit({max, addedCount = 1} = {}) {
-        let currentCount = await this.currentCountQuery(this.db);
+        let currentCount = await this.currentCountQuery();
 
         if ((currentCount + addedCount) > (max || this.maxPeriodic)) {
             throw this.generateError(currentCount);
@@ -202,13 +224,13 @@ class MaxPeriodicLimit extends Limit {
     }
 
     /**
-     * Throws a HostLimitError if the configured or passed max limit is ecceded by currentCountQuery
+     * Throws a HostLimitError if the configured or passed max limit is acceded by currentCountQuery
      *
      * @param {Object} options
      * @param {Number} [options.max] - overrides configured default maxPeriodic value to perform checks against
      */
     async errorIfIsOverLimit({max} = {}) {
-        let currentCount = await this.currentCountQuery(this.db);
+        let currentCount = await this.currentCountQuery();
 
         if (currentCount > (max || this.maxPeriodic)) {
             throw this.generateError(currentCount);
@@ -223,9 +245,10 @@ class FlagLimit extends Limit {
      * @param {String} options.name - name of the limit
      * @param {Object} options.config - limit configuration
      * @param {Number} options.config.disabled - disabled/enabled flag for the limit
+     * @param {String} options.config.error - error message to use when limit is reached
      * @param {String} options.helpLink - URL to the resource explaining how the limit works
-     * @param {Object} options.db - instance of knex db connection that currentCountQuery can use to run state check through
-     * @param {Object} options.errors - instance of errors compatible with Ghost-Ignition's errors (https://github.com/TryGhost/Ignition#errors)
+     * @param {Object} [options.db] - instance of knex db connection that currentCountQuery can use to run state check through
+     * @param {Object} options.errors - instance of errors compatible with GhostError errors (@tryghost/errors)
      */
     constructor({name, config, helpLink, db, errors}) {
         super({name, error: config.error || '', helpLink, db, errors});
@@ -265,6 +288,16 @@ class FlagLimit extends Limit {
 }
 
 class AllowlistLimit extends Limit {
+    /**
+     *
+     * @param {Object} options
+     * @param {String} options.name - name of the limit
+     * @param {Object} options.config - limit configuration
+     * @param {[String]} options.config.allowlist - allowlist values that would be compared against
+     * @param {String} options.config.error - error message to use when limit is reached
+     * @param {String} options.helpLink - URL to the resource explaining how the limit works
+     * @param {Object} options.errors - instance of errors compatible with GhostError errors (@tryghost/errors)
+     */
     constructor({name, config, helpLink, errors}) {
         super({name, error: config.error || '', helpLink, errors});
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tryghost/limit-service",
-  "version": "0.6.4",
+  "version": "1.0.2",
   "repository": "https://github.com/TryGhost/Utils/tree/main/packages/limit-service",
   "author": "Ghost Foundation",
   "license": "MIT",
@@ -8,7 +8,7 @@
   "exports": "./lib/limit-service.js",
   "scripts": {
     "dev": "echo \"Implement me!\"",
-    "test": "NODE_ENV=testing c8 mocha './test/**/*.test.js'",
+    "test": "NODE_ENV=testing c8 --reporter text --reporter cobertura mocha './test/**/*.test.js'",
     "lint": "eslint . --ext .js --cache",
     "posttest": "yarn lint"
   },
@@ -20,15 +20,15 @@
     "access": "public"
   },
   "devDependencies": {
-    "c8": "7.9.0",
-    "mocha": "9.1.2",
+    "c8": "7.10.0",
+    "mocha": "9.1.3",
     "should": "13.2.3",
     "sinon": "11.1.2"
   },
   "dependencies": {
-    "@tryghost/errors": "^0.2.16",
+    "@tryghost/errors": "^1.0.1",
     "lodash": "^4.17.21",
     "luxon": "^1.26.0"
   },
-  "gitHead": "a88c5e82f900a7df2d03c2e07d14ec9b5c59dde1"
+  "gitHead": "cef9c2f09117b0966380653a9c2be7aa409a9f86"
 }