fix: fixed timeout issue and redis disconnection causing rate limit to block requests

Author: titanism

index.js

@@ -19,14 +19,17 @@ const etag = require('koa-etag');
 const json = require('koa-json');
 const koa404Handler = require('koa-404-handler');
 const koaConnect = require('koa-connect');
+const ms = require('ms');
 const multimatch = require('multimatch');
+const ratelimit = require('@ladjs/koa-simple-ratelimit');
 const removeTrailingSlashes = require('koa-no-trailing-slash');
 const requestId = require('express-request-id');
 const requestReceived = require('request-received');
 const responseTime = require('response-time');
 const sharedConfig = require('@ladjs/shared-config');
 const { boolean } = require('boolean');
-const { ratelimit } = require('koa-simple-ratelimit');
+
+const RATE_LIMIT_EXCEEDED = `Rate limit exceeded, retry in %s.`;
 
 class API {
   constructor(config, client) {
@@ -109,7 +112,14 @@ class API {
 
         return ratelimit({
           ...this.config.rateLimit,
-          db: this.client
+          db: this.client,
+          logger: cabin,
+          errorMessage(exp) {
+            const fn =
+              typeof ctx.request.t === 'function' ? ctx.request.t : util.format;
+            // NOTE: ms does not support i18n localization
+            return fn(RATE_LIMIT_EXCEEDED, ms(exp, { long: true }));
+          }
         })(ctx, next);
       });
     }

package.json

@@ -22,8 +22,9 @@
   "dependencies": {
     "@koa/router": "^10.1.1",
     "@ladjs/i18n": "^7.2.6",
+    "@ladjs/koa-simple-ratelimit": "^3.0.0",
     "@ladjs/redis": "^1.0.7",
-    "@ladjs/shared-config": "^6.0.0",
+    "@ladjs/shared-config": "^6.0.2",
     "@ladjs/store-ip-address": "^0.0.7",
     "boolean": "^3.2.0",
     "cabin": "^9.1.2",
@@ -41,29 +42,29 @@
     "koa-etag": "^4.0.0",
     "koa-json": "^2.0.2",
     "koa-no-trailing-slash": "^2.1.0",
-    "koa-simple-ratelimit": "^5.1.1",
     "lodash": "^4.17.21",
+    "ms": "^2.1.3",
     "multimatch": "5",
     "request-received": "^0.0.3",
     "response-time": "^2.3.2"
   },
   "devDependencies": {
-    "@commitlint/cli": "^16.2.4",
-    "@commitlint/config-conventional": "^16.2.4",
+    "@commitlint/cli": "^17.0.1",
+    "@commitlint/config-conventional": "^17.0.0",
     "ava": "^4.2.0",
     "codecov": "^3.8.3",
     "cross-env": "^7.0.3",
-    "eslint": "^8.14.0",
+    "eslint": "^8.16.0",
     "eslint-config-xo-lass": "^1.0.6",
     "fixpack": "^4.0.0",
-    "husky": "^7.0.4",
-    "lint-staged": "12.4.1",
-    "mongoose": "^6.3.2",
+    "husky": "^8.0.1",
+    "lint-staged": "12.4.2",
+    "mongoose": "^6.3.4",
     "nyc": "^15.1.0",
     "remark-cli": "^10.0.1",
     "remark-preset-github": "^4.0.1",
     "supertest": "^6.2.3",
-    "xo": "^0.48.0"
+    "xo": "^0.49.0"
   },
   "engines": {
     "node": ">=10.10.0"