@ladjs/web 12.0.0 → 13.0.0

package/index.js

@@ -12,6 +12,7 @@ const CacheResponses = require('@ladjs/koa-cache-responses');
 const I18N = require('@ladjs/i18n');
 const Koa = require('koa');
 const Meta = require('koa-meta');
+const Passport = require('@ladjs/passport');
 const RedirectLoop = require('koa-redirect-loop');
 const Redis = require('@ladjs/redis');
 const StateHelper = require('@ladjs/state-helper');
@@ -38,6 +39,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 +50,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 +61,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, client) {
+  constructor(config, Users) {
     this.config = {
       ...sharedConfig('WEB'),
       meta: {},
@@ -165,38 +170,50 @@ class Web {
       ...config
     };
 
-    const cabin = new Cabin({
-      logger: this.config.logger,
-      ...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
+    // only trust proxy if enabled
+    app.proxy = boolean(process.env.TRUST_PROXY);
+
+    // inherit cache variable for cache-pug-templates
+    app.cache = boolean(this.config.views.locals.cache);
+
+    // initialize cabin
+    this.logger = _.isPlainObject(this.config.logger)
+      ? new Cabin(this.config.logger)
+      : this.config.logger instanceof Cabin
+      ? this.config.logger
+      : new Cabin({
+          logger: this.config.logger ? this.config.logger : console
+        });
+    app.context.logger = this.logger;
+
+    // initialize redis
+    this.client =
+      this.config.redis === false
+        ? false
+        : _.isPlainObject(this.config.redis)
+        ? new Redis(this.config.redis, this.logger, this.config.redisMonitor)
+        : this.config.redis;
     app.context.client = this.client;
 
-    // listen for error and log events emitted by app
+    // expose passport
+    this.passport =
+      this.config.passport === false
+        ? false
+        : _.isPlainObject(this.config.passport)
+        ? new Passport(this.config.passport, Users)
+        : this.config.passport;
+    app.context.passport = this.passport;
+
+    // listen for errors emitted by app
     app.on('error', (err, ctx) => {
-      const level = err.status && err.status < 500 ? 'warn' : 'error';
-      if (ctx.logger) ctx.logger[level](err);
-      else cabin[level](err);
+      ctx.logger[err.status && err.status < 500 ? 'warn' : 'error'](err);
     });
-    app.on('log', cabin.log);
 
     // override koa's undocumented error handler
-    app.context.onerror = errorHandler(this.config.cookiesKey, cabin);
-
-    // only trust proxy if enabled
-    app.proxy = boolean(process.env.TRUST_PROXY);
-
-    // inherit cache variable for cache-pug-templates
-    app.cache = boolean(this.config.views.locals.cache);
+    app.context.onerror = errorHandler(this.config.cookiesKey);
 
     // adds request received hrtime and date symbols to request object
     // (which is used by Cabin internally to add `request.timestamp` to logs
@@ -215,7 +232,7 @@ class Web {
     app.use(koaConnect(requestId()));
 
     // add cabin middleware
-    app.use(cabin.middleware);
+    app.use(this.logger.middleware);
 
     // allow before hooks to get setup
     if (_.isFunction(this.config.hookBeforeSetup))
@@ -238,7 +255,14 @@ class Web {
 
         return ratelimit({
           ...this.config.rateLimit,
-          db: this.client
+          db: this.client,
+          logger: this.logger,
+          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);
       });
     }
@@ -255,7 +279,7 @@ class Web {
       // create new @ladjs/i18n instance
       const i18n = this.config.i18n.config
         ? this.config.i18n
-        : new I18N({ ...this.config.i18n, logger: cabin });
+        : new I18N({ ...this.config.i18n, logger: this.logger });
 
       // setup localization (must come before `i18n.redirect`)
       app.use(i18n.middleware);
@@ -310,7 +334,7 @@ class Web {
     // NOTE: this must come after ctx.render is added (via koa-views)
     //
     if (this.config.meta) {
-      const meta = new Meta(this.config.meta, cabin);
+      const meta = new Meta(this.config.meta, this.logger);
       app.use(meta.middleware);
     }
 
@@ -355,7 +379,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
@@ -382,15 +409,15 @@ class Web {
     }
 
     // passport
-    if (this.config.passport) {
-      app.use(this.config.passport.initialize());
-      app.use(this.config.passport.session());
+    if (this.passport) {
+      app.use(this.passport.initialize());
+      app.use(this.passport.session());
     }
 
     // store the user's last ip address in the background
     if (this.config.storeIPAddress) {
       const storeIPAddress = new StoreIPAddress({
-        logger: cabin,
+        logger: this.logger,
         ...this.config.storeIPAddress
       });
       app.use(storeIPAddress.middleware);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ladjs/web",
   "description": "Web server for Lad",
-  "version": "12.0.0",
+  "version": "13.0.0",
   "author": "Nick Baugh <niftylettuce@gmail.com> (http://niftylettuce.com/)",
   "ava": {
     "failFast": true,
@@ -26,8 +26,9 @@
     "@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": "^7.0.3",
     "@ladjs/state-helper": "^1.0.0",
     "@ladjs/store-ip-address": "^0.0.7",
     "boolean": "^3.2.0",
@@ -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,23 @@
     "response-time": "^2.3.2"
   },
   "devDependencies": {
-    "@commitlint/cli": "^16.2.4",
-    "@commitlint/config-conventional": "^16.2.4",
-    "ava": "^4.2.0",
+    "@commitlint/cli": "^17.0.2",
+    "@commitlint/config-conventional": "^17.0.2",
+    "@ladjs/passport": "^5.0.0",
+    "ava": "^4.3.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",
+    "husky": "^8.0.1",
+    "lint-staged": "^13.0.0",
     "nyc": "^15.1.0",
     "pug": "^3.0.2",
     "remark-cli": "^10.0.1",
-    "remark-preset-github": "^4.0.1",
+    "remark-preset-github": "^4.0.2",
     "supertest": "^6.2.3",
-    "xo": "^0.48.0"
+    "xo": "^0.49.0"
   },
   "engines": {
     "node": ">=10.10.0"