chore: upgrade dependencies / better health checks

package.json

@@ -19,26 +19,26 @@
     "test:e2e": "jest --config ./test/jest-e2e.json"
   },
   "dependencies": {
-    "@godaddy/terminus": "^4.1.0",
+    "@godaddy/terminus": "^4.6.0",
     "@kiltprotocol/sdk-js": "^0.19.1-8",
-    "@nestjs/common": "^5.4.0",
-    "@nestjs/core": "^5.4.0",
-    "@nestjs/mongoose": "^5.2.2",
-    "@nestjs/terminus": "^5.6.0",
-    "dotenv": "^6.1.0",
+    "@nestjs/common": "^7.6.6",
+    "@nestjs/core": "^7.6.6",
+    "@nestjs/mongoose": "^7.2.2",
+    "@nestjs/platform-express": "^7.6.6",
+    "@nestjs/terminus": "^7.0.1",
+    "dotenv": "^8.2.0",
     "lodash": "^4.17.19",
-    "mongoose": "^5.7.5",
+    "mongoose": "^5.11.13",
     "reflect-metadata": "^0.1.12",
-    "rimraf": "^2.6.2",
-    "rxjs": "^6.2.2",
-    "typescript": "^3.9.5",
-    "typescript-optional": "^1.8.0"
+    "rimraf": "^3.0.2",
+    "rxjs": "^6.6.3",
+    "typescript": "^4.1.3",
+    "typescript-optional": "^2.0.1"
   },
   "devDependencies": {
-    "@nestjs/testing": "^5.1.0",
+    "@nestjs/testing": "^7.6.6",
     "@types/express": "^4.16.0",
     "@types/jest": "^26.0.13",
-    "@types/mongoose": "^5.3.1",
     "@types/node": "^10.7.1",
     "@types/supertest": "^2.0.5",
     "jest": "26.4.2",

src/app.module.ts

@@ -5,9 +5,8 @@ import { CTypesModule } from './ctypes/ctypes.module'
 import { MessagingModule } from './messaging/messaging.module'
 import { ContactsModule } from './contacts/contacts.module'
 import { BlockchainModule } from './blockchain/blockchain.module'
-import { TerminusModule } from '@nestjs/terminus'
-import { TerminusOptionsService } from './health/terminus-options.service'
 import { FaucetModule } from './faucet/faucet.module'
+import { HealthModule } from './health/health.module'
 
 @Module({
   imports: [
@@ -18,9 +17,7 @@ import { FaucetModule } from './faucet/faucet.module'
     ContactsModule,
     BlockchainModule,
     FaucetModule,
-    TerminusModule.forRootAsync({
-      useClass: TerminusOptionsService,
-    }),
+    HealthModule,
   ],
 })
 export class AppModule {}

src/contacts/contacts.controller.ts

@@ -12,7 +12,7 @@ import {
 } from '@nestjs/common'
 import { Contact, ContactsService } from './interfaces/contacts.interfaces'
 import { Did } from '@kiltprotocol/sdk-js'
-import Optional from 'typescript-optional'
+import { Optional } from 'typescript-optional'
 import { AuthGuard } from '../auth/auth.guard'
 import { IDidDocumentSigned } from '@kiltprotocol/sdk-js/build/did/Did'
 

src/contacts/contacts.module.spec.ts

@@ -12,7 +12,7 @@ import {
   Contact,
 } from './interfaces/contacts.interfaces'
 import { MongoDbMContactsService } from './mongodb-contacts.service'
-import Optional from 'typescript-optional'
+import { Optional } from 'typescript-optional'
 import {
   IDidDocumentSigned,
   IDENTIFIER_PREFIX,

src/contacts/interfaces/contacts.interfaces.ts

@@ -1,7 +1,7 @@
 import { PublicIdentity } from '@kiltprotocol/sdk-js'
 import { IDidDocumentSigned } from '@kiltprotocol/sdk-js/build/did/Did'
 import { Document } from 'mongoose'
-import Optional from 'typescript-optional'
+import { Optional } from 'typescript-optional'
 
 export interface Contact {
   metaData: {

src/contacts/mongodb-contacts.service.ts

@@ -1,9 +1,8 @@
 import { PublicIdentity } from '@kiltprotocol/sdk-js'
-import { IDidDocumentSigned } from '@kiltprotocol/sdk-js/build/did/Did'
 import { Injectable } from '@nestjs/common'
 import { InjectModel } from '@nestjs/mongoose'
 import { Model } from 'mongoose'
-import Optional from 'typescript-optional'
+import { Optional } from 'typescript-optional'
 import {
   Contact,
   ContactDB,
@@ -24,7 +23,7 @@ export class MongoDbMContactsService implements ContactsService {
         .findOne({ 'publicIdentity.address': contact.publicIdentity.address })
         .exec()
     )
-    if (registeredContact.isPresent) {
+    if (registeredContact.isPresent()) {
       const registered = registeredContact.get()
       // If the contact was already registered we want to replace the document, as it could exist in outdated format! Signature is still valid.
       await this.contactModel.replaceOne({ _id: registered._id }, {

src/ctypes/ctypes.module.spec.ts

@@ -1,5 +1,5 @@
 import { CType, CTypeService, CTypeDB } from './interfaces/ctype.interfaces'
-import Optional from 'typescript-optional'
+import { Optional } from 'typescript-optional'
 import { Blockchain, CType as SDKCType, CTypeMetadata, Identity} from '@kiltprotocol/sdk-js'
 import { Test } from '@nestjs/testing'
 import { CTypesController } from './ctypes.controller'

src/ctypes/interfaces/ctype.interfaces.ts

@@ -1,6 +1,6 @@
 import { ICType, ICTypeMetadata } from '@kiltprotocol/sdk-js'
 import { Document } from 'mongoose'
-import Optional from 'typescript-optional'
+import { Optional } from 'typescript-optional'
 
 export interface CType {
   metaData: ICTypeMetadata

src/ctypes/mongodb-ctypes.service.ts

@@ -2,7 +2,7 @@ import { ICType } from '@kiltprotocol/sdk-js'
 import { Injectable } from '@nestjs/common'
 import { InjectModel } from '@nestjs/mongoose'
 import { Model } from 'mongoose'
-import Optional from 'typescript-optional'
+import { Optional } from 'typescript-optional'
 import { CType, CTypeDB, CTypeService } from './interfaces/ctype.interfaces'
 
 @Injectable()
@@ -13,7 +13,7 @@ export class MongoDbCTypesService implements CTypeService {
 
   public async register(cType: CType): Promise<boolean> {
     const value = await this.findByHash(cType.cType.hash)
-    if (value.isPresent) {
+    if (value.isPresent()) {
       return false
     }
     const createdCType = new this.cTypeDBModel({

src/health/bc.health.ts

@@ -0,0 +1,40 @@
+import { BlockchainApiConnection } from '@kiltprotocol/sdk-js'
+import { Injectable } from '@nestjs/common'
+import {
+  HealthCheckError,
+  HealthIndicator,
+  HealthIndicatorResult,
+} from '@nestjs/terminus'
+
+@Injectable()
+export class KiltChainConnectionIndicator extends HealthIndicator {
+  public async isConnected(
+    key: string,
+    timeout: number
+  ): Promise<HealthIndicatorResult> {
+    return new Promise<HealthIndicatorResult>(async (resolve, reject) => {
+      setTimeout(
+        reject,
+        timeout,
+        new HealthCheckError(
+          `no response before timeout (${timeout} ms)`,
+          `no response before timeout (${timeout} ms)`
+        )
+      )
+      try {
+        const bc = await BlockchainApiConnection.getCached()
+        const stats = await bc.api.rpc.system.health()
+        resolve(this.getStatus(key, true, stats))
+      } catch (e) {
+        reject(e)
+      }
+    }).catch(e =>
+      Promise.reject(
+        new HealthCheckError(
+          'Error with Kilt chain connection',
+          this.getStatus(key, false, e)
+        )
+      )
+    )
+  }
+}

src/health/health.controller.ts

@@ -0,0 +1,25 @@
+import { Controller, Get } from '@nestjs/common'
+import {
+  HealthCheck,
+  HealthCheckService,
+  MongooseHealthIndicator,
+} from '@nestjs/terminus'
+import { KiltChainConnectionIndicator } from './bc.health'
+
+@Controller('health')
+export class HealthController {
+  constructor(
+    private health: HealthCheckService,
+    private mongoose: MongooseHealthIndicator,
+    private kiltChain: KiltChainConnectionIndicator
+  ) {}
+
+  @Get()
+  @HealthCheck()
+  public check() {
+    return this.health.check([
+      async () => this.mongoose.pingCheck('mongoose'),
+      async () => this.kiltChain.isConnected('chain', 1000),
+    ])
+  }
+}

src/health/health.module.ts

@@ -0,0 +1,11 @@
+import { Module } from '@nestjs/common'
+import { TerminusModule } from '@nestjs/terminus'
+import { KiltChainConnectionIndicator } from './bc.health'
+import { HealthController } from './health.controller'
+
+@Module({
+  imports: [TerminusModule],
+  controllers: [HealthController],
+  providers: [KiltChainConnectionIndicator],
+})
+export class HealthModule {}

src/main.ts

@@ -1,8 +1,9 @@
 import { NestFactory } from '@nestjs/core'
+import { NestExpressApplication } from '@nestjs/platform-express'
 import { AppModule } from './app.module'
 
 async function bootstrap() {
-  const app = await NestFactory.create(AppModule)
+  const app = await NestFactory.create<NestExpressApplication>(AppModule)
   app.set('trust proxy', true)
   app.enableCors()
   await app.listen(3000)

src/messaging/interfaces/messaging.interfaces.ts

@@ -1,7 +1,7 @@
 import { Document } from 'mongoose'
 import { Contact } from '../../contacts/interfaces/contacts.interfaces'
 import { IEncryptedMessage } from '@kiltprotocol/sdk-js'
-import Optional from 'typescript-optional'
+import { Optional } from 'typescript-optional'
 
 export interface MessageDB extends Document, IEncryptedMessage {}
 

src/messaging/messaging.module.spec.ts

@@ -7,7 +7,7 @@ import { MessagingService, MessageDB } from './interfaces/messaging.interfaces'
 import { IEncryptedMessage, Identity } from '@kiltprotocol/sdk-js'
 import * as Controller from './messaging.controller'
 import { MongoDbMessagingService } from './mongodb-messaging.service'
-import Optional from 'typescript-optional'
+import { Optional } from 'typescript-optional'
 import { ForbiddenMessageAccessException } from './exceptions/message-forbidden.exception'
 import { MessageNotFoundException } from './exceptions/message-not-found.exception'
 

src/messaging/mongodb-messaging.service.ts

@@ -3,7 +3,7 @@ import { InjectModel } from '@nestjs/mongoose'
 import { Model } from 'mongoose'
 import { MessageDB, MessagingService } from './interfaces/messaging.interfaces'
 import { IEncryptedMessage } from '@kiltprotocol/sdk-js'
-import Optional from 'typescript-optional'
+import { Optional } from 'typescript-optional'
 
 @Injectable()
 export class MongoDbMessagingService implements MessagingService {

test/app.e2e-spec.ts

@@ -4,6 +4,8 @@ import request from 'supertest'
 import { Identity } from '@kiltprotocol/sdk-js'
 import { MockMongooseModule, mongodbInstance } from './MockMongooseModule'
 import { AppModule } from '../src/app.module'
+import { HealthIndicatorResult } from '@nestjs/terminus'
+import { KiltChainConnectionIndicator } from '../src/health/bc.health'
 
 jest.mock(
   '@kiltprotocol/sdk-js/build/blockchainApiConnection/BlockchainApiConnection'
@@ -14,11 +16,17 @@ jest.mock('../src/mongoose/mongoose.module', () => ({
 
 describe('AppController availability (e2e)', () => {
   let app: INestApplication
+  let chainHealthService = {
+    isConnected: (): HealthIndicatorResult => ({ chain: { status: 'up' } }),
+  }
 
   beforeAll(async () => {
     const moduleFixture = await Test.createTestingModule({
       imports: [AppModule],
-    }).compile()
+    })
+      .overrideProvider(KiltChainConnectionIndicator)
+      .useValue(chainHealthService)
+      .compile()
 
     app = moduleFixture.createNestApplication()
     await app.init()
@@ -66,7 +74,7 @@ describe('AppController availability (e2e)', () => {
   it('health enpoint available (GET)', () => {
     return request(app.getHttpServer())
       .get('/health')
-      .expect(200, { status: 'ok', info: {} })
+      .expect(200)
   })
 
   it('faucet endpoint available (POST)', async () => {

test/faucet.e2e-spec.ts

@@ -16,7 +16,6 @@ jest.mock('@kiltprotocol/sdk-js/build/balance/Balance.chain', () => {
 jest.mock('@kiltprotocol/sdk-js/build/blockchain/Blockchain.utils', () => {
   return {
     __esModules: true,
-
     submitSignedTx: jest.fn(() => Promise.resolve({ isInBlock: true })),
   }
 })