test(core) add e2e for injection of inquirer in transient injectables

Author: Aetherall

integration/scopes/e2e/inject-inquirer.spec.ts

@@ -0,0 +1,69 @@
+import { INestApplication, Logger } from '@nestjs/common';
+import { Test } from '@nestjs/testing';
+import { expect } from 'chai';
+import * as request from 'supertest';
+import * as sinon from 'sinon';
+import { HelloModule } from '../src/inject-inquirer/hello.module';
+
+describe('Inject Inquirer', () => {
+  let logger;
+
+  let server;
+  let app: INestApplication;
+
+  before(async () => {
+    logger = { log: sinon.spy() };
+
+    const module = await Test.createTestingModule({
+      imports: [HelloModule],
+    })
+      .overrideProvider(Logger)
+      .useValue(logger)
+      .compile();
+
+    app = module.createNestApplication();
+    server = app.getHttpServer();
+    await app.init();
+  });
+
+  beforeEach(() => {
+    logger.log.reset();
+  });
+
+  it(`should allow the injection of the inquirer in a Transient Scope`, async () => {
+    await request(server).get('/hello/transient');
+
+    expect(
+      logger.log.calledWith({
+        message: 'Hello transient!',
+        feature: 'transient',
+      }),
+    ).to.be.true;
+  });
+
+  it(`should allow the injection of the inquirer in a Request Scope`, async () => {
+    await request(server).get('/hello/request');
+
+    expect(
+      logger.log.calledWith({
+        message: 'Hello request!',
+        requestId: sinon.match.string,
+        feature: 'request',
+      }),
+    ).to.be.true;
+
+    const requestId = logger.log.getCall(0).args[0].requestId;
+
+    expect(
+      logger.log.calledWith({
+        message: 'Goodbye request!',
+        requestId,
+        feature: 'request',
+      }),
+    );
+  });
+
+  after(async () => {
+    await app.close();
+  });
+});

integration/scopes/src/inject-inquirer/hello-request/hello-request.service.ts

@@ -0,0 +1,17 @@
+import { Injectable } from '@nestjs/common';
+import { RequestLogger } from './request-logger.service';
+
+@Injectable()
+export class HelloRequestService {
+  static logger = { feature: 'request' };
+
+  constructor(private readonly logger: RequestLogger) {}
+
+  greeting() {
+    this.logger.log('Hello request!');
+  }
+
+  farewell() {
+    this.logger.log('Goodbye request!');
+  }
+}

integration/scopes/src/inject-inquirer/hello-request/request-logger.service.ts

@@ -0,0 +1,26 @@
+import { Inject, Logger, Injectable, Scope } from '@nestjs/common';
+import { REQUEST, INQUIRER } from '@nestjs/core';
+
+@Injectable({ scope: Scope.TRANSIENT })
+export class RequestLogger {
+  config: object;
+
+  constructor(
+    @Inject(INQUIRER) { constructor },
+    @Inject(REQUEST) private readonly request,
+    private readonly logger: Logger,
+  ) {
+    this.config = (constructor && constructor.logger) || {};
+  }
+
+  get requestId() {
+    if (!this.request.id) {
+      this.request.id = `${Date.now()}.${Math.floor(Math.random() * 1000000)}`;
+    }
+    return this.request.id;
+  }
+
+  log(message: string) {
+    this.logger.log({ message, requestId: this.requestId, ...this.config });
+  }
+}

integration/scopes/src/inject-inquirer/hello-transient/hello-transient.service.ts

@@ -0,0 +1,13 @@
+import { Injectable } from '@nestjs/common';
+import { TransientLogger } from './transient-logger.service';
+
+@Injectable()
+export class HelloTransientService {
+  static logger = { feature: 'transient' };
+
+  constructor(private readonly logger: TransientLogger) {}
+
+  greeting() {
+    this.logger.log('Hello transient!');
+  }
+}

integration/scopes/src/inject-inquirer/hello-transient/transient-logger.service.ts

@@ -0,0 +1,18 @@
+import { Inject, Logger, Injectable, Scope } from '@nestjs/common';
+import { INQUIRER } from '@nestjs/core';
+
+@Injectable({ scope: Scope.TRANSIENT })
+export class TransientLogger {
+  config: object;
+
+  constructor(
+    @Inject(INQUIRER) { constructor },
+    private readonly logger: Logger,
+  ) {
+    this.config = (constructor && constructor.logger) || {};
+  }
+
+  log(message: string) {
+    this.logger.log({ message, ...this.config });
+  }
+}

integration/scopes/src/inject-inquirer/hello.controller.ts

@@ -0,0 +1,22 @@
+import { Controller, Get } from '@nestjs/common';
+import { HelloRequestService } from './hello-request/hello-request.service';
+import { HelloTransientService } from './hello-transient/hello-transient.service';
+
+@Controller('hello')
+export class HelloController {
+  constructor(
+    private readonly helloTransientService: HelloTransientService,
+    private readonly helloRequestService: HelloRequestService,
+  ) {}
+
+  @Get('transient')
+  greetingTransient() {
+    this.helloTransientService.greeting();
+  }
+
+  @Get('request')
+  greetingRequest() {
+    this.helloRequestService.greeting();
+    this.helloRequestService.farewell();
+  }
+}

integration/scopes/src/inject-inquirer/hello.module.ts

@@ -0,0 +1,18 @@
+import { Module, Logger } from '@nestjs/common';
+import { HelloController } from './hello.controller';
+import { HelloRequestService } from './hello-request/hello-request.service';
+import { HelloTransientService } from './hello-transient/hello-transient.service';
+import { RequestLogger } from './hello-request/request-logger.service';
+import { TransientLogger } from './hello-transient/transient-logger.service';
+
+@Module({
+  controllers: [HelloController],
+  providers: [
+    HelloRequestService,
+    HelloTransientService,
+    RequestLogger,
+    TransientLogger,
+    Logger,
+  ],
+})
+export class HelloModule {}