feat: add winston logger and setup for e2e test suite

Author: gobeam

.env.example

@@ -1,6 +1,7 @@
 SERVER_PORT=7777
-DB_PASSWORD=truthy
-DB_USERNAME=truthy123
-DB_DATABASE_NAME=truthy
+DB_HOST=
+DB_PASSWORD=
+DB_USERNAME=
+DB_DATABASE_NAME=
 DB_PORT=5432
 REDIS_PORT=6399

.github/workflows/test.yml

@@ -15,6 +15,13 @@ jobs:
           POSTGRES_PASSWORD: truthypwd
         ports:
           - 5432:5432
+      redis:
+        image: redis
+        options: >-
+          --health-cmd "redis-cli ping"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
 
     steps:
       - uses: actions/checkout@v2

README.md

@@ -1,5 +1,5 @@
 <div align="center">
-<img src="./images/logo.svg" alt="Truthy Logo">
+<img src="./public/images/logo.svg" alt="Truthy Logo">
 </div><br>
 <h1 align="center">
   Truthy CMS (NestJS Headless API)

config/default.yml

@@ -6,7 +6,9 @@ db:
   host: 'localhost'
   type: 'postgres'
   port: 5432
-  database: 'truthy'
+  username: 'postgres'
+  password: 'root'
+  synchronize: false
 
 jwt:
   # expiresIn: 10
@@ -55,3 +57,11 @@ throttle:
 
 twofa:
   authenticationAppNAme: 'truthy'
+
+winston:
+  groupName: 'truthy'
+  streamName: 'truthy-stream'
+  awsAccessKeyId: ''
+  awsSecretAccessKey: ''
+  awsRegion: ''
+  

package.json

@@ -20,15 +20,15 @@
     "test:watch": "jest --config ./test/unit/jest-unit.json --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/e2e/jest-e2e.json --runInBand",
+    "test:e2e": "jest --config ./test/e2e/jest-e2e.json",
     "test:unit": "jest --config ./test/unit/jest-unit.json --runInBand",
     "typeorm": "ts-node -r tsconfig-paths/register ./node_modules/typeorm/cli.js --config src/config/ormconfig.ts",
     "orm-create": "npm run typeorm migration:create -- -n",
     "migrate": "npm run typeorm migration:run",
     "migration:rollback": "npm run typeorm migration:revert",
     "seed": "ts-node ./node_modules/typeorm-seeding/dist/cli.js seed -n ./src/config/ormconfig.ts",
-    "precommit": "lint-staged && npm run lint && npm run test:unit",
-    "prepush": "npm run test:unit",
+    "precommit": "lint-staged && npm run lint && npm run test:unit && npm run test:e2e",
+    "prepush": "npm run test:unit && npm run test:e2e",
     "prepare": "husky install"
   },
   "dependencies": {
@@ -45,6 +45,7 @@
     "@nestjs/throttler": "^2.0.0",
     "@nestjs/typeorm": "^8.0.3",
     "@types/cookie-parser": "^1.4.2",
+    "aws-sdk": "^2.1092.0",
     "bcrypt": "^5.0.0",
     "bull": "^4.2.1",
     "class-transformer": "^0.5.1",
@@ -53,6 +54,7 @@
     "cookie-parser": "^1.4.6",
     "coveralls": "^3.1.1",
     "ioredis": "^4.28.3",
+    "nest-winston": "^1.6.2",
     "nestjs-i18n": "^8.2.2",
     "nestjs-throttler-storage-redis": "^0.1.18",
     "nodemailer": "^6.7.2",
@@ -69,7 +71,9 @@
     "typeorm": "^0.2.41",
     "typeorm-seeding": "^1.6.1",
     "ua-parser-js": "^1.0.2",
-    "uuid": "^8.3.2"
+    "uuid": "^8.3.2",
+    "winston": "^3.6.0",
+    "winston-cloudwatch": "^3.1.1"
   },
   "devDependencies": {
     "@commitlint/cli": "^16.0.2",

images/logo.svg public/images/logo.svgimages/logo.svg renamed to public/images/logo.svg

@@ -3,9 +3,16 @@ import { Controller, Get } from '@nestjs/common';
 @Controller()
 export class AppController {
   @Get('/health')
-  getHello() {
+  health() {
     return {
       status: 200
     };
   }
+
+  @Get('')
+  index() {
+    return {
+      message: 'hello world'
+    };
+  }
 }

images/profile/.gitignore public/images/profile/.gitignoreimages/profile/.gitignore renamed to public/images/profile/.gitignore

@@ -13,6 +13,7 @@ import {
   I18nModule,
   QueryResolver
 } from 'nestjs-i18n';
+import { WinstonModule } from 'nest-winston';
 
 import { AuthModule } from 'src/auth/auth.module';
 import { RolesModule } from 'src/role/roles.module';
@@ -28,11 +29,13 @@ import { TwofaModule } from 'src/twofa/twofa.module';
 import { CustomThrottlerGuard } from 'src/common/guard/custom-throttle.guard';
 import { DashboardModule } from 'src/dashboard/dashboard.module';
 import { AppController } from 'src/app.controller';
+import winstonConfig from 'src/config/winston';
 
 const appConfig = config.get('app');
 
 @Module({
   imports: [
+    WinstonModule.forRoot(winstonConfig),
     ThrottlerModule.forRootAsync({
       useFactory: () => throttleConfig
     }),
@@ -58,7 +61,7 @@ const appConfig = config.get('app');
       ]
     }),
     ServeStaticModule.forRoot({
-      rootPath: join(__dirname, '..', 'images'),
+      rootPath: join(__dirname, '..', 'public'),
       exclude: ['/api*']
     }),
     AuthModule,

src/app.controller.ts

@@ -137,7 +137,10 @@ export class AuthController {
   @UseGuards(JwtTwoFactorGuard)
   @Put('/auth/profile')
   @UseInterceptors(
-    FileInterceptor('avatar', multerOptionsHelper('images/profile', 1000000))
+    FileInterceptor(
+      'avatar',
+      multerOptionsHelper('public/images/profile', 1000000)
+    )
   )
   updateProfile(
     @GetUser()