Added healthcheck

Update the dependencies for security reason (PR)
Change the redirection to the api document

Author: leganz

CHANGELOG.md

@@ -4,6 +4,16 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.3.1] - 2020-08-07
+### Fixed
+- Updated the dependencies (PR1)
+
+### Added
+- Healthcheck (/health)
+
+### Changed
+- Removed the old simple healthcheck.
+
 ## [0.3.0] - 2020-08-05
 ### Changed
 - Instead of reading the filesystem the checks will run against a sqlite database

package-lock.json

@@ -22,14 +22,15 @@
     "test:e2e": "jest --config ./test/jest-e2e.json"
   },
   "dependencies": {
-    "@nestjs/common": "^7.4.1",
+    "@nestjs/common": "^7.4.2",
     "@nestjs/config": "^0.5.0",
-    "@nestjs/core": "^7.4.1",
-    "@nestjs/platform-express": "^7.4.1",
+    "@nestjs/core": "^7.4.2",
+    "@nestjs/platform-express": "^7.4.2",
     "@nestjs/swagger": "^4.5.12",
+    "@nestjs/terminus": "^7.0.1",
     "@nestjs/typeorm": "^7.1.0",
     "axios": "^0.19.2",
-    "class-transformer": "^0.2.3",
+    "class-transformer": "0.3.1",
     "class-validator": "^0.12.2",
     "form-data": "^3.0.0",
     "jest-junit": "^10.0.0",
@@ -39,7 +40,7 @@
     "puppeteer": "^3.3.0",
     "reflect-metadata": "^0.1.13",
     "rimraf": "^3.0.2",
-    "rxjs": "^6.6.0",
+    "rxjs": "^6.6.2",
     "signed": "^1.0.3",
     "sqlite3": "^5.0.0",
     "swagger-ui-express": "^4.1.4",
@@ -49,7 +50,7 @@
   "devDependencies": {
     "@nestjs/cli": "^7.4.1",
     "@nestjs/schematics": "^7.0.0",
-    "@nestjs/testing": "^7.4.1",
+    "@nestjs/testing": "^7.4.2",
     "@types/express": "^4.17.7",
     "@types/jest": "25.2.3",
     "@types/node": "^13.13.15",

package.json

@@ -9,9 +9,9 @@ export class AppController {
   constructor(private readonly appService: AppService) {}
 
   @Get('/')
-  @ApiResponse({ status: 303, description: 'Will redirect to the healthcheck (/api/status).' })
+  @ApiResponse({ status: 303, description: 'Will redirect to documentation.' })
   @ApiTags("System")
   postAuthRequest(@Res() response: express.Response) {
-    return response.redirect(303, `/api/status`);
+    return response.redirect(303, `/api`);
   }
 }

src/app.controller.ts

@@ -1,7 +1,6 @@
 import { Module, MiddlewareConsumer, RequestMethod } from '@nestjs/common';
 import { AppController } from './app.controller';
 import { AppService } from './app.service';
-import { SystemModule } from './system/system.module';
 import { BrowserModule } from './browser/browser.module';
 
 import { TypeOrmModule } from '@nestjs/typeorm';
@@ -10,19 +9,21 @@ import configuration from './configuration/configuration';
 
 import { ConfigModule } from '@nestjs/config';
 import { ConfigurationModule } from './configuration/configuration.module';
+import { TerminusModule } from '@nestjs/terminus';
+import { HealthController } from './health/health.controller';
 
 @Module({
   imports: [ConfigModule.forRoot({
       isGlobal: true,
       load: [configuration],
       envFilePath: ['.env']
-  }), SystemModule, BrowserModule, ConfigurationModule, TypeOrmModule.forRoot({
+  }), BrowserModule, ConfigurationModule,TerminusModule, TypeOrmModule.forRoot({
     type: 'sqlite',
     database: __dirname + '/../database/database.sqlite',
     entities: [__dirname + '/**/*.entity{.ts,.js}'],
     synchronize: true,
   })],
-  controllers: [AppController],
+  controllers: [AppController, HealthController],
   providers: [AppService],
 })
 export class AppModule {

src/app.module.ts

@@ -16,5 +16,8 @@ export default () => ({
         browseDestroy: process.env.PERMISSION_BROWSE_DELETE || 'browse-delete',
         browseRead: process.env.PERMISSION_BROWSE_READ || 'browse-read'
     },
-    browser: process.env.BROWSER_PATH || null
+    browser: process.env.BROWSER_PATH || null,
+    healthcheck: {
+        dnsUrl: process.env.HEALTHCHECK_DNS_CHECK_URL || 'https://google.com',
+    }
   });

src/configuration/configuration.ts

@@ -0,0 +1,18 @@
+import { Test, TestingModule } from '@nestjs/testing';
+import { HealthController } from './health.controller';
+
+describe('Health Controller', () => {
+  let controller: HealthController;
+
+  beforeEach(async () => {
+    const module: TestingModule = await Test.createTestingModule({
+      controllers: [HealthController],
+    }).compile();
+
+    controller = module.get<HealthController>(HealthController);
+  });
+
+  it('should be defined', () => {
+    expect(controller).toBeDefined();
+  });
+});

src/health/health.controller.spec.ts

@@ -0,0 +1,30 @@
+import { Controller, Get } from '@nestjs/common';
+import { HealthCheckService, DNSHealthIndicator, HealthCheck, TypeOrmHealthIndicator } from '@nestjs/terminus';
+import { ConfigService } from '@nestjs/config';
+import { ApiOperation, ApiTags } from '@nestjs/swagger';
+
+@Controller('health')
+export class HealthController {
+
+    constructor(
+        private health: HealthCheckService,
+        private dns: DNSHealthIndicator,
+        private db: TypeOrmHealthIndicator,
+        private configService: ConfigService
+    ) {}
+
+    @Get()
+    @HealthCheck()
+    @ApiOperation({description: 'Check the health of the service'})
+    @ApiTags('Healthcheck')
+    check() {
+
+        let dnsCheckUrl = this.configService.get<string>('healthcheck.dnsUrl')
+
+        return this.health.check([
+            async () => this.dns.pingCheck('dnscheck', dnsCheckUrl),
+            async () => this.db.pingCheck('database', { timeout: 300 }),
+        ]);
+    }
+
+}