@ladjs/web 11.1.1 → 12.0.1

package/index.js

@@ -38,6 +38,7 @@ const koaConnect = require('koa-connect');
 const methodOverride = require('koa-methodoverride');
 const ms = require('ms');
 const multimatch = require('multimatch');
+const ratelimit = require('@ladjs/koa-simple-ratelimit');
 const redisStore = require('koa-redis');
 const removeTrailingSlashes = require('koa-no-trailing-slash');
 const requestId = require('express-request-id');
@@ -48,7 +49,6 @@ const session = require('koa-generic-session');
 const sharedConfig = require('@ladjs/shared-config');
 const views = require('koa-views');
 const { boolean } = require('boolean');
-const { ratelimit } = require('koa-simple-ratelimit');
 
 const defaultSrc = isSANB(process.env.WEB_HOST)
   ? [
@@ -60,13 +60,17 @@ const defaultSrc = isSANB(process.env.WEB_HOST)
       `${process.env.WEB_HOST}:*`
     ]
   : null;
+
 const reportUri = isSANB(process.env.WEB_URL)
   ? `${process.env.WEB_URL}/report`
   : null;
 
+const INVALID_TOKEN_MESSAGE = 'Invalid CSRF token.';
+const RATE_LIMIT_EXCEEDED = `Rate limit exceeded, retry in %s.`;
+
 class Web {
   // eslint-disable-next-line complexity
-  constructor(config) {
+  constructor(config, client) {
     this.config = {
       ...sharedConfig('WEB'),
       meta: {},
@@ -170,9 +174,17 @@ class Web {
       ...this.config.cabin
     });
 
+    // initialize redis
+    this.client = client
+      ? client
+      : new Redis(this.config.redis, cabin, this.config.redisMonitor);
+
     // initialize the app
     const app = new Koa();
 
+    // allow middleware to access redis client
+    app.context.client = this.client;
+
     // listen for error and log events emitted by app
     app.on('error', (err, ctx) => {
       const level = err.status && err.status < 500 ? 'warn' : 'error';
@@ -181,16 +193,6 @@ class Web {
     });
     app.on('log', cabin.log);
 
-    // initialize redis
-    const client = new Redis(
-      this.config.redis,
-      cabin,
-      this.config.redisMonitor
-    );
-
-    // allow middleware to access redis client
-    app.context.client = client;
-
     // override koa's undocumented error handler
     app.context.onerror = errorHandler(this.config.cookiesKey, cabin);
 
@@ -240,7 +242,14 @@ class Web {
 
         return ratelimit({
           ...this.config.rateLimit,
-          db: 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);
       });
     }
@@ -324,7 +333,7 @@ class Web {
     app.keys = this.config.sessionKeys;
     app.use(
       session({
-        store: redisStore({ client }),
+        store: redisStore({ client: this.client }),
         key: this.config.cookiesKey,
         cookie: this.config.cookies,
         genSid: this.config.genSid,
@@ -357,7 +366,10 @@ class Web {
     if (this.config.csrf && process.env.NODE_ENV !== 'test') {
       const csrf = new CSRF({
         ...this.config.csrf,
-        invalidTokenMessage: (ctx) => ctx.request.t('Invalid CSRF token')
+        invalidTokenMessage: (ctx) =>
+          typeof ctx.request.t === 'function'
+            ? ctx.request.t(INVALID_TOKEN_MESSAGE)
+            : INVALID_TOKEN_MESSAGE
       });
       app.use(async (ctx, next) => {
         // check against ignored/whitelisted redirect middleware paths
@@ -413,15 +425,13 @@ class Web {
     }
 
     // start server on either http or http2
-    const server =
+    this.server =
       this.config.protocol === 'https'
         ? http2.createSecureServer(this.config.ssl, app.callback())
         : http.createServer(app.callback());
 
-    // expose app, server, client
+    // expose the app
     this.app = app;
-    this.server = server;
-    this.client = client;
 
     // bind listen/close to this
     this.listen = this.listen.bind(this);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ladjs/web",
   "description": "Web server for Lad",
-  "version": "11.1.1",
+  "version": "12.0.1",
   "author": "Nick Baugh <niftylettuce@gmail.com> (http://niftylettuce.com/)",
   "ava": {
     "failFast": true,
@@ -20,20 +20,21 @@
     "Nick Baugh <niftylettuce@gmail.com> (http://niftylettuce.com/)"
   ],
   "dependencies": {
-    "@hapi/boom": "^9.1.4",
+    "@hapi/boom": "^10.0.0",
     "@koa/router": "^10.1.1",
-    "@ladjs/i18n": "^7.2.4",
+    "@ladjs/i18n": "^7.2.6",
     "@ladjs/koa-better-static": "^2.0.1",
     "@ladjs/koa-cache-responses": "^0.0.3",
     "@ladjs/koa-isajax": "^2.0.0",
+    "@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/state-helper": "^1.0.0",
     "@ladjs/store-ip-address": "^0.0.7",
-    "boolean": "^3.1.4",
-    "cabin": "^9.1.1",
+    "boolean": "^3.2.0",
+    "cabin": "^9.1.2",
     "crypto-random-string": "3",
-    "express-request-id": "^1.4.1",
+    "express-request-id": "1.4.1",
     "is-string-and-not-blank": "^0.0.2",
     "kcors": "^2.2.2",
     "koa": "^2.13.4",
@@ -58,7 +59,6 @@
     "koa-no-trailing-slash": "^2.1.0",
     "koa-redirect-loop": "^1.0.2",
     "koa-redis": "^4.0.1",
-    "koa-simple-ratelimit": "^5.1.1",
     "koa-views": "^8.0.0",
     "lodash": "^4.17.21",
     "ms": "^2.1.3",
@@ -67,22 +67,22 @@
     "response-time": "^2.3.2"
   },
   "devDependencies": {
-    "@commitlint/cli": "^16.0.2",
-    "@commitlint/config-conventional": "^16.0.0",
-    "ava": "^4.0.1",
+    "@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.6.0",
+    "eslint": "^8.16.0",
     "eslint-config-xo-lass": "^1.0.6",
     "fixpack": "^4.0.0",
-    "husky": "^7.0.4",
-    "lint-staged": "^12.1.7",
+    "husky": "^8.0.1",
+    "lint-staged": "^12.4.2",
     "nyc": "^15.1.0",
     "pug": "^3.0.2",
     "remark-cli": "^10.0.1",
     "remark-preset-github": "^4.0.1",
-    "supertest": "^6.2.1",
-    "xo": "^0.47.0"
+    "supertest": "^6.2.3",
+    "xo": "^0.49.0"
   },
   "engines": {
     "node": ">=10.10.0"