feat: added authenticated router, moved to using ab-express library

SimonB407 · SimonB407 · commit 3b155c2cc149 · 2020-08-08T20:25:39.000+02:00
diff --git a/example-app/package.json b/example-app/package.json
@@ -18,12 +18,16 @@
     "test:e2e": "jest --config ./test/jest-e2e.json"
   },
   "dependencies": {
-    "admin-bro": "^3.0.0-beta.12",
+    "@admin-bro/express": "^3.0.0-beta.3",
     "@admin-bro/mongoose": "^1.0.0-beta.3",
     "@nestjs/common": "^6.7.2",
     "@nestjs/core": "^6.7.2",
     "@nestjs/mongoose": "^7.0.2",
     "@nestjs/platform-express": "^6.7.2",
+    "admin-bro": "^3.0.0-beta.12",
+    "express": "^4.17.1",
+    "express-formidable": "^1.2.0",
+    "express-session": "^1.17.1",
     "mongoose": "^5.9.27",
     "reflect-metadata": "^0.1.13",
     "rimraf": "^3.0.0",
diff --git a/example-app/src/app.module.ts b/example-app/src/app.module.ts
@@ -27,7 +27,7 @@ import { MongooseSchemasModule } from './mongoose/mongoose.module';
           ],
         },
         auth: {
-          authenticate: async () => new Promise(() => ({ email: 'mordeczka' })),
+          authenticate: async (email, password) => Promise.resolve({ test: 'test' }),
           cookieName: 'test',
           cookiePassword: 'testPass',
         },
diff --git a/example-app/src/index.js b/example-app/src/index.js
@@ -0,0 +1,22 @@
+const bodyParser = require('body-parser')
+const formidable = require('express-formidable')
+
+
+const express = require('express')
+const app = express()
+
+app.use(bodyParser.json());
+
+const router = express.Router()
+router.use(formidable())
+
+app.use('/router', router);
+
+console.log(app._router.stack)
+
+const run = async () => {
+  // const mongooseConnection = await mongoose.connect(process.env.MONGO_URL)
+  app.listen(8080, () => console.log('AdminBro is under localhost:8080/admin'))
+}
+
+run()
diff --git a/example-app/yarn.lock b/example-app/yarn.lock
diff --git a/package.json b/package.json
@@ -23,8 +23,6 @@
     "@commitlint/cli": "^8.3.5",
     "@commitlint/config-conventional": "^8.3.4",
     "@semantic-release/git": "^9.0.0",
-    "@types/express-formidable": "^1.0.4",
-    "@types/express-session": "^1.17.0",
     "@typescript-eslint/eslint-plugin": "^3.7.0",
     "@typescript-eslint/parser": "^3.7.0",
     "admin-bro": ">=3.0.0-beta.7",
@@ -45,9 +43,7 @@
   "dependencies": {
     "@nestjs/common": "^7.4.2",
     "@nestjs/core": "^7.4.2",
-    "express": "^4.17.1",
-    "express-formidable": "^1.2.0",
-    "express-session": "^1.17.1",
+    "@types/express-session": "^1.17.0",
     "reflect-metadata": "^0.1.13",
     "rxjs": "^6.5.3"
   }
diff --git a/src/admin.module.ts b/src/admin.module.ts
@@ -33,9 +33,8 @@ export class AdminModule implements OnModuleInit {
     }
   }
 
-  public async onModuleInit() {
+  public onModuleInit() {
     const admin = new AdminBro(this.adminModuleOptions.adminBroOptions);
-    await admin.initialize();
 
     const { httpAdapter } = this.httpAdapterHost;
     this.loader.register(admin, httpAdapter, { 
diff --git a/src/loaders/express.loader.ts b/src/loaders/express.loader.ts
@@ -1,8 +1,5 @@
-import path from 'path';
-
-import express from 'express';
-import formidable from 'express-formidable';
-import AdminBro, { Router } from 'admin-bro';
+/* eslint-disable no-underscore-dangle */
+import AdminBro from 'admin-bro';
 import { Injectable } from '@nestjs/common';
 import { AbstractHttpAdapter } from '@nestjs/core';
 import { loadPackage } from '@nestjs/common/utils/load-package.util';
@@ -20,144 +17,49 @@ export class ExpressLoader extends AbstractLoader {
   ) {
     const app = httpAdapter.getInstance();
 
-    const router = express.Router();
+    loadPackage('express', '@admin-bro/nestjs');
+    const adminBroExpressjs = loadPackage('@admin-bro/express', '@admin-bro/nestjs', () =>
+      require('@admin-bro/express')
+    );
+    loadPackage('express-formidable', '@admin-bro/nestjs');
+
+    let jsonParser;
+    let urlencodedParser;
+
+    // Nestjs uses bodyParser under the hood which is in conflict with admin-bro setup.
+    // Due to admin-bro-expressjs usage of formidable we have to move body parser in layer tree after admin-bro init.
+    // Notice! This is not documented feature of express, so this may change in the future. We have to keep an eye on it.
+    if (app && app._router && app._router.stack) {
+      const jsonParserIndex = app._router.stack.findIndex(layer => layer.name === 'jsonParser');
+      if (jsonParserIndex >= 0) {
+        jsonParser = app._router.stack.splice(jsonParserIndex, 1);
+      }
 
-    router.use(formidable(options.formidableOptions));
+      const urlencodedParserIndex = app._router.stack.findIndex(layer => layer.name === 'urlencodedParser');
+      if (urlencodedParserIndex >= 0) {
+        urlencodedParser = app._router.stack.splice(urlencodedParserIndex, 1);
+      }
+    }
 
-    const { assets, routes } = Router;
+    let router;
 
     if ('auth' in options) {
-      this.configureSession(router, admin, options);
+      loadPackage('express-session', '@admin-bro/nestjs');
+      router = adminBroExpressjs.buildAuthenticatedRouter(
+        admin, options.auth, undefined, options.sessionOptions, options.formidableOptions
+      );
+    } else {
+      router = adminBroExpressjs.buildRouter(admin, undefined, options.formidableOptions);
     }
 
-    this.registerAssets(router, assets, options);
-    this.registerRoutes(router, admin, routes, options);
-
     app.use(options.adminBroOptions.rootPath, router);
-  }
-
-  private registerAssets(app, assets, options: AdminModuleOptions) {
-    assets.forEach(asset => {
-      app.get(asset.path, (_req, res) => {
-        res.sendFile(path.resolve(asset.src))
-      })
-    })
-  }
 
-  private registerRoutes(app, admin: AdminBro, routes, options: AdminModuleOptions) {
-    routes.forEach((route) => {
-      // we have to change routes defined in AdminBro from {recordId} to :recordId
-      const expressPath = `${route.path.replace(/{/g, ':').replace(/}/g, '') as string}`
-
-      const handler = async (req, res, next) => {
-        try {
-          const controller = new route.Controller({ admin }, req.session && req.session.adminUser)
-          const { params, query } = req
-          const method = req.method.toLowerCase()
-          const payload = {
-            ...(req.fields || {}),
-            ...(req.files || {}),
-          }
-          const html = await controller[route.action]({
-            ...req,
-            params,
-            query,
-            payload,
-            method,
-          }, res)
-          if (route.contentType) {
-            res.set({ 'Content-Type': route.contentType })
-          }
-          if (html) {
-            res.send(html)
-          }
-        } catch (e) {
-          next(e)
-        }
-      }
-  
-      if (route.method === 'GET') {
-        app.get(expressPath, handler)
-      }
-  
-      if (route.method === 'POST') {
-        app.post(expressPath, handler)
-      }
-    })
-  }
-
-  private configureSession(app, admin: AdminBro, options: AdminModuleOptions) {
-    const session = loadPackage('express-session', '@admin-bro/nestjs', () =>
-      require('express-session')
-    );
-
-    app.use(session({
-      ...options.sessionOptions,
-      secret: options.auth?.cookiePassword,
-      name: options.auth?.cookieName || 'adminbro',
-    }));
+    if (jsonParser) {
+      app._router.stack.push(...jsonParser);
+    }
 
-    const { rootPath } = admin.options;
-    let { loginPath, logoutPath } = admin.options;
-    loginPath = loginPath.replace(rootPath, '')
-    logoutPath = logoutPath.replace(rootPath, '')
-  
-    app.get(loginPath, async (_req, res) => {
-      const login = await admin.renderLogin({
-        action: admin.options.loginPath,
-        errorMessage: null,
-      });
-      res.send(login);
-    });
-  
-    app.post(loginPath, async (req, res, next) => {
-      console.log('login post');
-      const { email, password } = req.fields;
-      const adminUser = await options.auth?.authenticate(email, password);
-      if (adminUser) {
-        req.session.adminUser = adminUser;
-        req.session.save((err) => {
-          if (err) {
-            next(err);
-          }
-          if (req.session.redirectTo) {
-            res.redirect(req.session.redirectTo);
-          } else {
-            res.redirect(rootPath);
-          }
-        })
-      } else {
-        const login = await admin.renderLogin({
-          action: admin.options.loginPath,
-          errorMessage: 'invalidCredentials',
-        });
-        res.send(login);
-      }
-    });
-  
-    app.use((req, res, next) => {
-      console.log('redirect?')
-      if (AdminBro.Router.assets.some(asset => req.originalUrl.match(asset.path))) {
-        next();
-      } else if (req.session.adminUser) {
-        next();
-      } else {
-        // If the redirection is caused by API call to some action just redirect to resource
-        const [redirectTo] = req.originalUrl.split('/actions');
-        req.session.redirectTo = redirectTo.includes(`${rootPath}/api`) ? rootPath : redirectTo;
-        req.session.save((err) => {
-          if (err) {
-            next(err);
-          }
-          res.redirect(admin.options.loginPath);
-        })
-      }
-    })
-  
-    app.get(logoutPath, (req, res) => {
-      req.session.destroy(() => {
-        res.redirect(admin.options.loginPath)
-      });
-    });
+    if (urlencodedParser) {
+      app._router.stack.push(...urlencodedParser);
+    }
   }
 }
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -33,9 +33,8 @@ export class AdminModule implements OnModuleInit {`
`33`	`33`	`}`
`34`	`34`	`}`
`35`	`35`
`36`		`- public async onModuleInit() {`
	`36`	`+ public onModuleInit() {`
`37`	`37`	`const admin = new AdminBro(this.adminModuleOptions.adminBroOptions);`
`38`		`- await admin.initialize();`
`39`	`38`
`40`	`39`	`const { httpAdapter } = this.httpAdapterHost;`
`41`	`40`	`this.loader.register(admin, httpAdapter, {`