Parsoid: Rate limit stashing requests

config.example.wikimedia.yaml

@@ -21,6 +21,7 @@ default_project: &default_project
         parsoid:
           host: https://parsoid-beta.wmflabs.org
           grace_ttl: 1000000
+          stash_ratelimit: 5
         action:
           apiUriTemplate: "{{'https://{domain}/w/api.php'}}"
           baseUriTemplate: "{{'https://{domain}/api/rest_v1'}}"

sys/parsoid.js

@@ -103,10 +103,7 @@ function compileReRenderBlacklist(blacklist) {
 
 class ParsoidService {
     constructor(options) {
-        this.options = options = options || {};
-        this.parsoidHost = options.parsoidHost;
-
-        this._blacklist = compileReRenderBlacklist(options.rerenderBlacklist);
+        this._initOpts(options);
 
         // Set up operations
         this.operations = {
@@ -125,6 +122,46 @@ class ParsoidService {
         };
     }
 
+    _initOpts(opts = {}) {
+        this.options = opts;
+        this.parsoidHost = opts.parsoidHost;
+        this.options.stash_ratelimit = opts.stash_ratelimit || 5;
+        this.options.grace_ttl = opts.grace_ttl || 86400;
+        this._blacklist = compileReRenderBlacklist(opts.rerenderBlacklist);
+        if (!opts.parsoidHost) {
+            throw new Error('Parsoid module: the option parsoidHost must be provided!');
+        }
+    }
+
+    _checkStashRate(hyper, req) {
+        if (!hyper.ratelimiter) {
+            return;
+        }
+        if (hyper._rootReq.headers['x-request-class'] !== 'external') {
+            return;
+        }
+        if (!((req.query && req.query.stash) || (req.body && req.body.stash))) {
+            return;
+        }
+        const key = `${hyper.config.service_name}.parsoid_stash|` +
+            `${hyper._rootReq.headers['x-client-ip']}`;
+        if (hyper.ratelimiter.isAboveLimit(key, this.options.stash_ratelimit)) {
+            hyper.logger.log('warn/parsoid/stashlimit', {
+                key,
+                rate_limit_per_second: this.options.stash_ratelimit,
+                message: 'Stashing rate limit exceeded'
+            });
+            throw new HTTPError({
+                status: 429,
+                body: {
+                    type: 'request_rate_exceeded',
+                    title: 'Stashing rate limit exceeded',
+                    rate_limit_per_second: this.options.stash_ratelimit
+                }
+            });
+        }
+    }
+
     /**
      * Get the URI of a bucket for the latest Parsoid content.
      * @param {string} domain the domain name.
@@ -453,6 +490,9 @@ class ParsoidService {
             });
         }
 
+        // check the rate limit for stashing requests
+        this._checkStashRate(hyper, req);
+
         let contentReq =
             this._getContentWithFallback(hyper, rp.domain, rp.title, rp.revision, rp.tid);
 
@@ -690,6 +730,8 @@ class ParsoidService {
                 if (!rp.revision) {
                     rp.revision = '0';
                 }
+                // check the rate limit for stashing requests
+                this._checkStashRate(hyper, req);
             }
 
             let transform;

v1/content.yaml

@@ -174,7 +174,8 @@ paths:
           in: query
           description: >
             Whether to temporary stash data-parsoid in order to support transforming the
-            modified content later.
+            modified content later. If this parameter is set, requests are rate-limited on
+            a per-client basis (max 5 requests per second per client)
           type: boolean
           required: false
         - name: Accept-Language
@@ -426,7 +427,8 @@ paths:
           in: query
           description: >
             Whether to temporary stash data-parsoid in order to support transforming the
-            modified content later.
+            modified content later. If this parameter is set, requests are rate-limited on
+            a per-client basis (max 5 requests per second per client)
           type: boolean
           required: false
         - name: Accept-Language
@@ -541,7 +543,8 @@ paths:
           in: query
           description: >
             Whether to temporary stash data-parsoid in order to support transforming the
-            modified content later.
+            modified content later. If this parameter is set, requests are rate-limited on
+            a per-client basis (max 5 requests per second per client)
           type: boolean
           required: false
         - name: Accept-Language

v1/transform.yaml

@@ -190,7 +190,7 @@ paths:
         also need to supply the title.
 
         - Stability: [stable](https://www.mediawiki.org/wiki/API_versioning#Stable)
-        - Rate limit: 25 req/s
+        - Rate limit: 25 req/s (5 req/s when `stash: true`)
       consumes:
         - multipart/form-data
       produces: