feat: breaking rewrite to support better structure

Author: titanism

index.js

@@ -5,6 +5,7 @@ const util = require('util');
 
 const Cabin = require('cabin');
 const I18N = require('@ladjs/i18n');
+const Passport = require('@ladjs/passport');
 const Koa = require('koa');
 const Redis = require('@ladjs/redis');
 const StoreIPAddress = require('@ladjs/store-ip-address');
@@ -32,39 +33,52 @@ const { boolean } = require('boolean');
 const RATE_LIMIT_EXCEEDED = `Rate limit exceeded, retry in %s.`;
 
 class API {
-  constructor(config, client) {
+  // eslint-disable-next-line complexity
+  constructor(config, Users) {
     this.config = {
       ...sharedConfig('API'),
       rateLimitIgnoredGlobs: [],
       ...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
+    // 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(false, cabin);
+    app.context.onerror = errorHandler(false, this.logger);
 
     // only trust proxy if enabled
     app.proxy = boolean(process.env.TRUST_PROXY);
@@ -89,7 +103,7 @@ class API {
     app.use(koaConnect(requestId()));
 
     // use the cabin middleware (adds request-based logging and helpers)
-    app.use(cabin.middleware);
+    app.use(this.logger.middleware);
 
     // allow before hooks to get setup
     if (_.isFunction(this.config.hookBeforeSetup))
@@ -99,7 +113,7 @@ class API {
     if (this.config.auth) app.use(auth(this.config.auth));
 
     // rate limiting
-    if (this.config.rateLimit) {
+    if (this.client && this.config.rateLimit) {
       app.use((ctx, next) => {
         // check against ignored/whitelisted paths
         if (
@@ -113,7 +127,7 @@ class API {
         return ratelimit({
           ...this.config.rateLimit,
           db: this.client,
-          logger: cabin,
+          logger: this.logger,
           errorMessage(exp) {
             const fn =
               typeof ctx.request.t === 'function' ? ctx.request.t : util.format;
@@ -131,7 +145,7 @@ class API {
     if (this.config.i18n) {
       const i18n = this.config.i18n.config
         ? this.config.i18n
-        : new I18N({ ...this.config.i18n, logger: cabin });
+        : new I18N({ ...this.config.i18n, logger: this.logger });
       app.use(i18n.middleware);
     }
 
@@ -151,12 +165,12 @@ class API {
     app.use(json());
 
     // passport
-    if (this.config.passport) app.use(this.config.passport.initialize());
+    if (this.passport) app.use(this.passport.initialize());
 
     // 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.json

@@ -24,7 +24,7 @@
     "@ladjs/i18n": "^7.2.6",
     "@ladjs/koa-simple-ratelimit": "^3.0.0",
     "@ladjs/redis": "^1.0.7",
-    "@ladjs/shared-config": "^7.0.0",
+    "@ladjs/shared-config": "^7.0.3",
     "@ladjs/store-ip-address": "^0.0.7",
     "boolean": "^3.2.0",
     "cabin": "^9.1.2",
@@ -49,20 +49,21 @@
     "response-time": "^2.3.2"
   },
   "devDependencies": {
-    "@commitlint/cli": "^17.0.1",
-    "@commitlint/config-conventional": "^17.0.0",
-    "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.16.0",
     "eslint-config-xo-lass": "^1.0.6",
     "fixpack": "^4.0.0",
     "husky": "^8.0.1",
-    "lint-staged": "12.4.3",
-    "mongoose": "^6.3.4",
+    "lint-staged": "13.0.0",
+    "mongoose": "^6.3.5",
     "nyc": "^15.1.0",
     "remark-cli": "^10.0.1",
-    "remark-preset-github": "^4.0.1",
+    "remark-preset-github": "^4.0.2",
     "supertest": "^6.2.3",
     "xo": "^0.49.0"
   },

test/test.js

@@ -1,6 +1,8 @@
-const test = require('ava');
-const request = require('supertest');
+const Passport = require('@ladjs/passport');
 const Router = require('@koa/router');
+const request = require('supertest');
+const test = require('ava');
+
 const API = require('..');
 
 test('allows custom routes', async (t) => {
@@ -18,3 +20,28 @@ test('allows custom routes', async (t) => {
   t.is(response.status, 200);
   t.is(response.body.ok, 'ok');
 });
+
+test('with redis instance', (t) => {
+  const api = new API();
+  t.is(typeof api.client, 'object');
+  t.is(typeof api.app.context.client, 'object');
+});
+
+test('without redis instance', (t) => {
+  const api = new API({ redis: false });
+  t.is(api.client, false);
+  t.is(api.app.context.client, false);
+});
+
+test('with passport instance', (t) => {
+  const passport = new Passport({});
+  const api = new API({ passport });
+  t.is(typeof api.passport, 'object');
+  t.is(typeof api.app.context.passport, 'object');
+});
+
+test('without passport instance', (t) => {
+  const api = new API();
+  t.is(api.passport, false);
+  t.is(api.app.context.passport, false);
+});