fix: slash route fix, better express reorder, option to not init admin

Author: SimonB407

example-app/package.json

@@ -15,7 +15,7 @@
     "test:watch": "jest --watch",
     "test:cov": "jest --coverage",
     "test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand",
-    "test:e2e": "jest --config ./test/jest-e2e.json"
+    "test:e2e": "NODE_ENV=test jest --config ./test/jest-e2e.json"
   },
   "dependencies": {
     "@admin-bro/express": "^3.0.1",

example-app/src/app.module.ts

@@ -1,5 +1,7 @@
 import { Module } from '@nestjs/common';
 import { MongooseModule, getModelToken } from '@nestjs/mongoose';
+import AdminBro from 'admin-bro';
+import AdminBroMongoose from '@admin-bro/mongoose';
 import { Model } from 'mongoose';
 
 import { AdminModule } from '../../src'; // lib
@@ -10,6 +12,8 @@ import { ExpressCustomLoader } from './express-custom.loader';
 import { Admin } from './mongoose/admin-model';
 import { MongooseSchemasModule } from './mongoose/mongoose.module';
 
+AdminBro.registerAdapter(AdminBroMongoose);
+
 @Module({
   imports: [
     MongooseModule.forRoot('mongodb://localhost:27017/nest'),

example-app/src/main.ts

@@ -1,12 +1,9 @@
-import AdminBro from 'admin-bro';
-import AdminBroMongoose from '@admin-bro/mongoose';
+
 import { NestFactory } from '@nestjs/core';
 import { ValidationPipe } from '@nestjs/common';
 
 import { AppModule } from './app.module';
 
-AdminBro.registerAdapter(AdminBroMongoose);
-
 const bootstrap = async () => {
   const app = await NestFactory.create(AppModule);
   app.useGlobalPipes(new ValidationPipe({

example-app/test/app.e2e-spec.ts

@@ -1,5 +1,5 @@
 import { Test, TestingModule } from '@nestjs/testing';
-import * as request from 'supertest';
+import request from 'supertest';
 
 import { AppModule } from './../src/app.module';
 
@@ -19,4 +19,10 @@ describe('AppController (e2e)', () => {
     .get('/')
     .expect(200)
     .expect('Hello World!'));
+
+  it('/ (POST)', () => request(app.getHttpServer())
+    .post('/')
+    .send({ hello: 'hello' })
+    .expect(201)
+    .expect('hello'));
 });

src/admin.module.ts

@@ -122,6 +122,10 @@ export class AdminModule implements OnModuleInit {
    * Applies given options to AdminBro and initializes it
    */
   public onModuleInit() {
+    if ('shouldBeInitialized' in this.adminModuleOptions && !this.adminModuleOptions.shouldBeInitialized) {
+      return;
+    }
+
     const admin = new AdminBro(this.adminModuleOptions.adminBroOptions);
 
     const { httpAdapter } = this.httpAdapterHost;

src/interfaces/admin-module-options.interface.ts

@@ -1,9 +1,6 @@
-import { Type } from '@nestjs/common';
 import { AdminBroOptions, CurrentAdmin } from 'admin-bro';
 import { SessionOptions } from 'express-session';
 
-import { AbstractLoader } from '../loaders/abstract.loader';
-
 import { ExpressFormidableOptions } from './express-formidable-options.interface';
 
 /**
@@ -38,4 +35,9 @@ export type AdminModuleOptions = {
    * something more reliable (i.e. database).
    */
   sessionOptions?: SessionOptions,
+  /**
+   * Flag indicating if admin-bro should be initialized. Helpful in cases like turning off admin for tests.
+   * Default is true.
+   */
+  shouldBeInitialized?: boolean,
 }

src/loaders/express.loader.ts

@@ -34,11 +34,17 @@ export class ExpressLoader extends AbstractLoader {
       router = adminBroExpressjs.buildRouter(admin, undefined, options.formidableOptions);
     }
 
-    app.use(options.adminBroOptions.rootPath, router);
-    this.reorderRoutes(app, options);
+    // This named function is there on purpose. 
+    // It names layer in main router with the name of the function, which helps localize
+    // admin layer in reorderRoutes() step.
+    // eslint-disable-next-line prefer-arrow/prefer-arrow-functions
+    app.use(options.adminBroOptions.rootPath, function admin(req, res, next) {
+      return router(req, res, next);
+    });
+    this.reorderRoutes(app);
   }
 
-  private reorderRoutes(app, options) {
+  private reorderRoutes(app) {
     let jsonParser;
     let urlencodedParser;
     let admin;
@@ -61,9 +67,9 @@ export class ExpressLoader extends AbstractLoader {
         urlencodedParser = app._router.stack.splice(urlencodedParserIndex, 1);
       }
 
-      const adminIndex = app._router.stack.findIndex((layer: { regexp: RegExp }) =>
-        layer.regexp.toString().includes(options.adminBroOptions.rootPath),
-      )
+      const adminIndex = app._router.stack.findIndex(
+        (layer: { name: string }) => layer.name === 'admin'
+      );
       if (adminIndex >= 0) {
         admin = app._router.stack.splice(adminIndex, 1)
       }