scaffold of two more microservices as example, customers and payments

jmw5598 · jmw5598 · commit 6c5cb40f3880 · 2023-02-04T15:14:55.000-05:00
diff --git a/server/apps/customers/src/customers.controller.spec.ts b/server/apps/customers/src/customers.controller.spec.ts
@@ -0,0 +1,22 @@
+import { Test, TestingModule } from '@nestjs/testing';
+import { CustomersController } from './customers.controller';
+import { CustomersService } from './customers.service';
+
+describe('CustomersController', () => {
+  let customersController: CustomersController;
+
+  beforeEach(async () => {
+    const app: TestingModule = await Test.createTestingModule({
+      controllers: [CustomersController],
+      providers: [CustomersService],
+    }).compile();
+
+    customersController = app.get<CustomersController>(CustomersController);
+  });
+
+  describe('root', () => {
+    it('should return "Hello World!"', () => {
+      expect(customersController.getHello()).toBe('Hello World!');
+    });
+  });
+});
diff --git a/server/apps/customers/src/customers.controller.ts b/server/apps/customers/src/customers.controller.ts
@@ -0,0 +1,14 @@
+import { Controller } from '@nestjs/common';
+import { MessagePattern } from '@nestjs/microservices';
+import { findAllCustomersCommand } from '@vsp/common';
+import { CustomersService } from './customers.service';
+
+@Controller()
+export class CustomersController {
+  constructor(private readonly customersService: CustomersService) {}
+
+  @MessagePattern(findAllCustomersCommand)
+  public async findAllPayments(): Promise<any[]> {
+    return [];
+  }
+}
diff --git a/server/apps/customers/src/customers.module.ts b/server/apps/customers/src/customers.module.ts
@@ -0,0 +1,10 @@
+import { Module } from '@nestjs/common';
+import { CustomersController } from './customers.controller';
+import { CustomersService } from './customers.service';
+
+@Module({
+  imports: [],
+  controllers: [CustomersController],
+  providers: [CustomersService],
+})
+export class CustomersModule {}
diff --git a/server/apps/customers/src/customers.service.ts b/server/apps/customers/src/customers.service.ts
@@ -0,0 +1,8 @@
+import { Injectable } from '@nestjs/common';
+
+@Injectable()
+export class CustomersService {
+  getHello(): string {
+    return 'Hello World!';
+  }
+}
diff --git a/server/apps/customers/src/main.ts b/server/apps/customers/src/main.ts
@@ -0,0 +1,23 @@
+import { NestFactory } from '@nestjs/core';
+import { TcpOptions, Transport } from '@nestjs/microservices';
+import { EnvironmentService } from '@vsp/core';
+import { loadEnvironmentVariables } from '@vsp/env';
+import { CustomersModule } from './customers.module';
+
+// Load env file from NODE_ENV
+loadEnvironmentVariables('./environments');
+
+async function bootstrap() {
+  const environmentService: EnvironmentService = new EnvironmentService();
+  const app = await NestFactory.createMicroservice(
+    CustomersModule, {
+      transport: Transport.TCP,
+      options: {
+        host: environmentService.get('CUSTOMERS_SERVICE_HOST') || 'localhost',
+        port: environmentService.get('CUSTOMERS_SERVICE_PORT') || 3001
+      }
+    } as TcpOptions
+  );
+  await app.listen();
+}
+bootstrap();
diff --git a/server/apps/customers/test/app.e2e-spec.ts b/server/apps/customers/test/app.e2e-spec.ts
@@ -0,0 +1,24 @@
+import { Test, TestingModule } from '@nestjs/testing';
+import { INestApplication } from '@nestjs/common';
+import * as request from 'supertest';
+import { CustomersModule } from './../src/customers.module';
+
+describe('CustomersController (e2e)', () => {
+  let app: INestApplication;
+
+  beforeEach(async () => {
+    const moduleFixture: TestingModule = await Test.createTestingModule({
+      imports: [CustomersModule],
+    }).compile();
+
+    app = moduleFixture.createNestApplication();
+    await app.init();
+  });
+
+  it('/ (GET)', () => {
+    return request(app.getHttpServer())
+      .get('/')
+      .expect(200)
+      .expect('Hello World!');
+  });
+});
diff --git a/server/apps/customers/test/jest-e2e.json b/server/apps/customers/test/jest-e2e.json
@@ -0,0 +1,9 @@
+{
+  "moduleFileExtensions": ["js", "json", "ts"],
+  "rootDir": ".",
+  "testEnvironment": "node",
+  "testRegex": ".e2e-spec.ts$",
+  "transform": {
+    "^.+\\.(t|j)s$": "ts-jest"
+  }
+}
diff --git a/server/apps/customers/tsconfig.app.json b/server/apps/customers/tsconfig.app.json
@@ -0,0 +1,9 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "declaration": false,
+    "outDir": "../../dist/apps/customers"
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist", "test", "**/*spec.ts"]
+}
diff --git a/server/apps/gateway/src/controllers/customers.controller.spec.ts b/server/apps/gateway/src/controllers/customers.controller.spec.ts
@@ -0,0 +1,18 @@
+import { Test, TestingModule } from '@nestjs/testing';
+import { CustomersController } from './customers.controller';
+
+describe('CustomersController', () => {
+  let controller: CustomersController;
+
+  beforeEach(async () => {
+    const module: TestingModule = await Test.createTestingModule({
+      controllers: [CustomersController],
+    }).compile();
+
+    controller = module.get<CustomersController>(CustomersController);
+  });
+
+  it('should be defined', () => {
+    expect(controller).toBeDefined();
+  });
+});
diff --git a/server/apps/gateway/src/controllers/customers.controller.ts b/server/apps/gateway/src/controllers/customers.controller.ts
@@ -0,0 +1,25 @@
+import { Controller, Get, Inject, UseGuards } from '@nestjs/common';
+import { ClientProxy, RpcException } from '@nestjs/microservices';
+import { catchError, Observable, throwError } from 'rxjs';
+
+import { CUSTOMERS_SERVICE_TOKEN, findAllCustomersCommand } from '@vsp/common';
+import { LoggerService } from '@vsp/logger';
+import { JwtAuthGuard } from '@vsp/authorization';
+
+@Controller('customers')
+export class CustomersController {
+  @Inject(CUSTOMERS_SERVICE_TOKEN)
+  private readonly _customersServiceClient: ClientProxy;
+  
+  constructor(private readonly _logger: LoggerService) {
+    this._logger.setContext(CustomersController.name);
+  }
+
+  @Get()
+  @UseGuards(JwtAuthGuard)
+  public findAllCustomers(): Observable<any[]> {
+    return this._customersServiceClient
+      .send(findAllCustomersCommand, {})
+      .pipe(catchError(error => throwError(() => new RpcException(error.response))));
+  }
+}
diff --git a/server/apps/gateway/src/controllers/payments.controller.spec.ts b/server/apps/gateway/src/controllers/payments.controller.spec.ts
@@ -0,0 +1,18 @@
+import { Test, TestingModule } from '@nestjs/testing';
+import { PaymentsController } from './payments.controller';
+
+describe('PaymentsController', () => {
+  let controller: PaymentsController;
+
+  beforeEach(async () => {
+    const module: TestingModule = await Test.createTestingModule({
+      controllers: [PaymentsController],
+    }).compile();
+
+    controller = module.get<PaymentsController>(PaymentsController);
+  });
+
+  it('should be defined', () => {
+    expect(controller).toBeDefined();
+  });
+});
diff --git a/server/apps/gateway/src/controllers/payments.controller.ts b/server/apps/gateway/src/controllers/payments.controller.ts
@@ -0,0 +1,25 @@
+import { Controller, Get, Inject, UseGuards } from '@nestjs/common';
+import { ClientProxy, RpcException } from '@nestjs/microservices';
+import { catchError, Observable, throwError } from 'rxjs';
+
+import { PAYMENTS_SERVICE_TOKEN, findAllPaymentsCommand } from '@vsp/common';
+import { LoggerService } from '@vsp/logger';
+import { JwtAuthGuard } from '@vsp/authorization';
+
+@Controller('payments')
+export class PaymentsController {
+  @Inject(PAYMENTS_SERVICE_TOKEN)
+  private readonly _paymentsServiceClient: ClientProxy;
+  
+  constructor(private readonly _logger: LoggerService) {
+    this._logger.setContext(PaymentsController.name);
+  }
+
+  @Get()
+  @UseGuards(JwtAuthGuard)
+  public findAllPayments(): Observable<any[]> {
+    return this._paymentsServiceClient
+      .send(findAllPaymentsCommand, {})
+      .pipe(catchError(error => throwError(() => new RpcException(error.response))));
+  }
+}
diff --git a/server/apps/gateway/src/gateway.module.ts b/server/apps/gateway/src/gateway.module.ts
@@ -7,10 +7,12 @@ import { LoggerModule } from '@vsp/logger';
 
 import { AuthController } from './controllers/auth.controller';
 import { AccountsController } from './controllers/accounts.controller';
-import { identityMicroserviceProvider } from './gateway.providers';
+import { customersMicroserviceProvider, identityMicroserviceProvider, paymentsMicroserviceProvider } from './gateway.providers';
 import { LocalStrategy } from './strategies/local.strategy';
 
 import { JwtStrategy } from './strategies/jwt.strategy';
+import { PaymentsController } from './controllers/payments.controller';
+import { CustomersController } from './controllers/customers.controller';
 
 
 @Module({
@@ -22,10 +24,14 @@ import { JwtStrategy } from './strategies/jwt.strategy';
   ],
   controllers: [
     AuthController,
-    AccountsController
+    AccountsController,
+    PaymentsController,
+    CustomersController
   ],
   providers: [
     identityMicroserviceProvider,
+    customersMicroserviceProvider,
+    paymentsMicroserviceProvider,
     JwtStrategy,
     LocalStrategy,
   ],
diff --git a/server/apps/gateway/src/gateway.providers.ts b/server/apps/gateway/src/gateway.providers.ts
@@ -1,6 +1,6 @@
 import { ClientProxyFactory, TcpClientOptions, Transport } from '@nestjs/microservices';
 
-import { IDENTITY_SERVICE_TOKEN } from '@vsp/common';
+import { CUSTOMERS_SERVICE_TOKEN, IDENTITY_SERVICE_TOKEN, PAYMENTS_SERVICE_TOKEN } from '@vsp/common';
 import { EnvironmentService } from '@vsp/core';
 
 export const identityMicroserviceProvider = {
@@ -16,3 +16,31 @@ export const identityMicroserviceProvider = {
   },
   inject: [EnvironmentService]
 };
+
+export const paymentsMicroserviceProvider = {
+  provide: PAYMENTS_SERVICE_TOKEN,
+  useFactory: (environmentService: EnvironmentService) => {
+    return ClientProxyFactory.create({
+      options: {
+        port: environmentService.get('PAYMENTS_SERVICE_PORT'),
+        host: environmentService.get('PAYMENTS_SERVICE_HOST'),
+      },
+      transport: Transport.TCP,
+    } as TcpClientOptions);
+  },
+  inject: [EnvironmentService]
+};
+
+export const customersMicroserviceProvider = {
+  provide: CUSTOMERS_SERVICE_TOKEN,
+  useFactory: (environmentService: EnvironmentService) => {
+    return ClientProxyFactory.create({
+      options: {
+        port: environmentService.get('CUSTOMERS_SERVICE_PORT'),
+        host: environmentService.get('CUSTOMERS_SERVICE_HOST'),
+      },
+      transport: Transport.TCP,
+    } as TcpClientOptions);
+  },
+  inject: [EnvironmentService]
+};
diff --git a/server/apps/payments/src/main.ts b/server/apps/payments/src/main.ts
@@ -0,0 +1,23 @@
+import { NestFactory } from '@nestjs/core';
+import { TcpOptions, Transport } from '@nestjs/microservices';
+import { EnvironmentService } from '@vsp/core';
+import { loadEnvironmentVariables } from '@vsp/env';
+import { PaymentsModule } from './payments.module';
+
+// Load env file from NODE_ENV
+loadEnvironmentVariables('./environments');
+
+async function bootstrap() {
+  const environmentService: EnvironmentService = new EnvironmentService();
+  const app = await NestFactory.createMicroservice(
+    PaymentsModule, {
+      transport: Transport.TCP,
+      options: {
+        host: environmentService.get('PAYMENTS_SERVICE_HOST') || 'localhost',
+        port: environmentService.get('PAYMENTS_SERVICE_PORT') || 3001
+      }
+    } as TcpOptions
+  );
+  await app.listen();
+}
+bootstrap();
diff --git a/server/apps/payments/src/payments.controller.spec.ts b/server/apps/payments/src/payments.controller.spec.ts
@@ -0,0 +1,22 @@
+import { Test, TestingModule } from '@nestjs/testing';
+import { PaymentsController } from './payments.controller';
+import { PaymentsService } from './payments.service';
+
+describe('PaymentsController', () => {
+  let paymentsController: PaymentsController;
+
+  beforeEach(async () => {
+    const app: TestingModule = await Test.createTestingModule({
+      controllers: [PaymentsController],
+      providers: [PaymentsService],
+    }).compile();
+
+    paymentsController = app.get<PaymentsController>(PaymentsController);
+  });
+
+  describe('root', () => {
+    it('should return "Hello World!"', () => {
+      expect(paymentsController.getHello()).toBe('Hello World!');
+    });
+  });
+});
diff --git a/server/apps/payments/src/payments.controller.ts b/server/apps/payments/src/payments.controller.ts
@@ -0,0 +1,14 @@
+import { Controller, Get } from '@nestjs/common';
+import { MessagePattern } from '@nestjs/microservices';
+import { findAllPaymentsCommand } from '@vsp/common';
+import { PaymentsService } from './payments.service';
+
+@Controller()
+export class PaymentsController {
+  constructor(private readonly paymentsService: PaymentsService) {}
+
+  @MessagePattern(findAllPaymentsCommand)
+  public async findAllPayments(): Promise<any[]> {
+    return [];
+  }
+}
diff --git a/server/apps/payments/src/payments.module.ts b/server/apps/payments/src/payments.module.ts
@@ -0,0 +1,10 @@
+import { Module } from '@nestjs/common';
+import { PaymentsController } from './payments.controller';
+import { PaymentsService } from './payments.service';
+
+@Module({
+  imports: [],
+  controllers: [PaymentsController],
+  providers: [PaymentsService],
+})
+export class PaymentsModule {}
diff --git a/server/apps/payments/src/payments.service.ts b/server/apps/payments/src/payments.service.ts
@@ -0,0 +1,8 @@
+import { Injectable } from '@nestjs/common';
+
+@Injectable()
+export class PaymentsService {
+  getHello(): string {
+    return 'Hello World!';
+  }
+}
diff --git a/server/apps/payments/test/app.e2e-spec.ts b/server/apps/payments/test/app.e2e-spec.ts
@@ -0,0 +1,24 @@
+import { Test, TestingModule } from '@nestjs/testing';
+import { INestApplication } from '@nestjs/common';
+import * as request from 'supertest';
+import { PaymentsModule } from './../src/payments.module';
+
+describe('PaymentsController (e2e)', () => {
+  let app: INestApplication;
+
+  beforeEach(async () => {
+    const moduleFixture: TestingModule = await Test.createTestingModule({
+      imports: [PaymentsModule],
+    }).compile();
+
+    app = moduleFixture.createNestApplication();
+    await app.init();
+  });
+
+  it('/ (GET)', () => {
+    return request(app.getHttpServer())
+      .get('/')
+      .expect(200)
+      .expect('Hello World!');
+  });
+});
diff --git a/server/apps/payments/test/jest-e2e.json b/server/apps/payments/test/jest-e2e.json
diff --git a/server/apps/payments/tsconfig.app.json b/server/apps/payments/tsconfig.app.json
diff --git a/server/environments/dev.env b/server/environments/dev.env
diff --git a/server/environments/sample.env b/server/environments/sample.env
diff --git a/server/libs/common/src/commands/customers.commands.ts b/server/libs/common/src/commands/customers.commands.ts
diff --git a/server/libs/common/src/commands/payments.commands.ts b/server/libs/common/src/commands/payments.commands.ts
diff --git a/server/libs/common/src/constants/injection-tokens.constants.ts b/server/libs/common/src/constants/injection-tokens.constants.ts
diff --git a/server/libs/common/src/index.ts b/server/libs/common/src/index.ts
diff --git a/server/nest-cli.json b/server/nest-cli.json
diff --git a/server/package.json b/server/package.json
