refactor: move project into dedicated folder

lib/health-check/health-check-executor.service.ts

@@ -0,0 +1,55 @@
+import { Injectable } from '@nestjs/common';
+import { HealthIndicatorFunction } from '../health-indicator';
+import { HealthCheckError } from '@godaddy/terminus';
+import { HealthCheckResult } from './health-check-result.interface';
+
+/**
+ * Takes care of the execution of health indicators
+ * @internal
+ */
+@Injectable()
+export class HealthCheckExecutor {
+  /**
+   * Executes the given health indicators.
+   *
+   * @throws {Error} All errors which are not inherited by the `HealthCheckError`-class
+   *
+   * @returns the result of given health indicators
+   * @param healthIndicators The health indicators which should get executed
+   */
+  async execute(
+    healthIndicators: HealthIndicatorFunction[],
+  ): Promise<HealthCheckResult> {
+    const results: any[] = [];
+    const errors: any[] = [];
+    await Promise.all(
+      healthIndicators
+        // Register all promises
+        .map(healthIndicator => healthIndicator())
+        .map((p: Promise<any>) =>
+          p.catch((error: any) => {
+            // Is not an expected error. Throw further!
+            if (!error.causes) throw error;
+            // Is a expected health check error
+            errors.push((error as HealthCheckError).causes);
+          }),
+        )
+        .map((p: Promise<any>) =>
+          p.then((result: any) => result && results.push(result)),
+        ),
+    );
+
+    const info = (results || [])
+      .concat(errors || [])
+      .reduce(
+        (previous: Object, current: Object) => Object.assign(previous, current),
+        {},
+      );
+
+    if (errors.length) {
+      throw new HealthCheckError('Healthcheck failed', info);
+    } else {
+      return info;
+    }
+  }
+}

lib/health-check/health-check-result.interface.ts

@@ -0,0 +1,7 @@
+/**
+ * The result of a health check
+ */
+export interface HealthCheckResult {
+  results: any[];
+  errors: any[];
+}

lib/health.service.ts → lib/health-check/health-check.service.ts

@@ -1,16 +1,16 @@
 import { Injectable, BeforeApplicationShutdown } from '@nestjs/common';
-import { HealthIndicatorFunction } from './interfaces';
-import { HealthIndicatorExecutor } from './health-indicator-executor.service';
+import { HealthIndicatorFunction } from '../health-indicator';
+import { HealthCheckExecutor } from './health-check-executor.service';
 
 @Injectable()
-export class HealthService implements BeforeApplicationShutdown {
+export class HealthCheckService implements BeforeApplicationShutdown {
   private isShuttingDown: boolean = false;
-  constructor(private healthIndicatorExecutor: HealthIndicatorExecutor) {}
+  constructor(private healthCheckExecutor: HealthCheckExecutor) {}
 
   public async check(healthIndicators: HealthIndicatorFunction[]) {
-    const status = await this.healthIndicatorExecutor.execute(healthIndicators);
+    const status = await this.healthCheckExecutor.execute(healthIndicators);
     if (this.isShuttingDown) {
-      // TODO: Omit "status" and then prepend the new status so JSON order does not change 
+      // TODO: Omit "status" and then prepend the new status so JSON order does not change
       return { ...status, status: 'shutting_down' };
     }
     return status;

lib/health-check/index.ts

@@ -0,0 +1,3 @@
+export * from './health-check.service';
+export * from './health-check.decorator';
+export * from './health-check-result.interface';

lib/health-indicators/database/mongoose.health.ts → lib/health-indicator/database/mongoose.health.ts

@@ -13,7 +13,7 @@ import {
   HealthIndicatorResult,
   TimeoutError,
   ConnectionNotFoundError,
-} from '../../';
+} from '../..';
 import { HealthIndicator } from '../health-indicator';
 
 export interface MongoosePingCheckSettings {

lib/health-indicators/database/typeorm.health.ts → lib/health-indicator/database/typeorm.health.ts

@@ -5,7 +5,6 @@ import { HealthCheckError } from '@godaddy/terminus';
 
 import * as NestJSTypeOrm from '@nestjs/typeorm';
 
-import { HealthIndicatorResult } from '../../interfaces/health-indicator.interface';
 import {
   TimeoutError,
   ConnectionNotFoundError,
@@ -16,7 +15,7 @@ import {
   promiseTimeout,
   checkPackages,
 } from '../../utils';
-import { HealthIndicator } from '../health-indicator';
+import { HealthIndicator, HealthIndicatorResult } from '../health-indicator';
 
 export interface TypeOrmPingCheckSettings {
   /**

lib/health-indicators/disk/disk.health.ts → lib/health-indicator/disk/disk.health.ts

@@ -2,8 +2,7 @@ import { Injectable, Inject } from '@nestjs/common';
 import { isNil } from '@nestjs/common/utils/shared.utils';
 import * as checkDiskSpace from 'check-disk-space';
 
-import { HealthIndicatorResult } from '../../interfaces';
-import { HealthIndicator } from '../health-indicator';
+import { HealthIndicator, HealthIndicatorResult } from '../health-indicator';
 import { CHECKDISKSPACE_LIB } from '../../terminus.constants';
 import { StorageExceededError } from '../../errors';
 import { STORAGE_EXCEEDED } from '../../errors/messages.constant';

lib/health-indicators/dns/dns.health.ts → lib/health-indicator/dns/dns.health.ts

@@ -1,14 +1,13 @@
 import { Injectable, HttpService } from '@nestjs/common';
-import { HealthIndicatorResult } from '../../interfaces';
 import { AxiosResponse, AxiosRequestConfig, AxiosError } from 'axios';
-import { HealthIndicator } from '../health-indicator';
+import { HealthIndicator, HealthIndicatorResult } from '../health-indicator';
 import { HealthCheckError } from '@godaddy/terminus';
 
 /**
  * The DNSHealthIndicator contains health indicators
  * which are used for health checks related to HTTP requests
  * and DNS
- * 
+ *
  * @publicApi
  * @module TerminusModule
  */

lib/health-indicator/dns/index.ts

@@ -0,0 +1 @@
+export * from './dns.health';

lib/health-indicators/health-indicator.ts → lib/health-indicator/health-indicator.ts

@@ -1,4 +1,29 @@
-import { HealthIndicatorResult } from '..';
+/**
+ * The result object of a health indicator
+ * @publicApi
+ */
+export type HealthIndicatorResult = {
+  /**
+   * The key of the health indicator which should be uniqe
+   */
+  [key: string]: {
+    /**
+     * The status if the given health indicator was successful or not
+     */
+    status: string;
+    /**
+     * Optional settings of the health indicator result
+     */
+    [optionalKeys: string]: any;
+  };
+};
+
+/**
+ * A health indicator function for a health check
+ *
+ * @publicApi
+ */
+export type HealthIndicatorFunction = () => Promise<HealthIndicatorResult>;
 
 /**
  * Represents an abstract health indicator

lib/health-indicators.provider.ts → lib/health-indicator/health-indicators.provider.ts

@@ -9,7 +9,7 @@ import {
   MicroserviceHealthIndicator,
   HealthIndicator,
   GRPCHealthIndicator,
-} from './health-indicators';
+} from '.';
 
 /**
  * All the health indicators terminus provides as array

lib/health-indicators/index.ts → lib/health-indicator/index.ts

@@ -6,4 +6,4 @@ export * from './microservice/grpc.health';
 export * from './disk';
 export * from './memory';
 
-export * from './health-indicator';
+export * from './health-indicator';

lib/health-indicators/memory/memory.health.ts → lib/health-indicator/memory/memory.health.ts

@@ -1,7 +1,6 @@
 import { Injectable } from '@nestjs/common';
 
-import { HealthIndicatorResult } from '../../interfaces';
-import { HealthIndicator } from '../health-indicator';
+import { HealthIndicator, HealthIndicatorResult } from '../health-indicator';
 import { STORAGE_EXCEEDED } from '../../errors/messages.constant';
 import { StorageExceededError } from '../../errors';
 

lib/health-indicators/microservice/grpc.health.ts → lib/health-indicator/microservice/grpc.health.ts

@@ -8,7 +8,7 @@ import {
   HealthIndicatorResult,
   TimeoutError,
   UnhealthyResponseCodeError,
-} from '../../';
+} from '../..';
 import {
   checkPackages,
   promiseTimeout,

lib/health-indicators/microservice/microservice.health.ts → lib/health-indicator/microservice/microservice.health.ts

@@ -10,13 +10,12 @@ import {
   TcpOptions,
 } from '@nestjs/microservices';
 import { TimeoutError } from '../../errors';
-import { HealthIndicatorResult } from '../../interfaces';
 import {
   checkPackages,
   promiseTimeout,
   TimeoutError as PromiseTimeoutError,
 } from '../../utils';
-import { HealthIndicator } from '../health-indicator';
+import { HealthIndicator, HealthIndicatorResult } from '../health-indicator';
 
 type ClientOptions =
   | RedisOptions

lib/index.ts

@@ -1,4 +1,5 @@
-export * from './interfaces';
-export * from './terminus.module';
-export * from './health-indicators';
+export { TerminusModule } from './terminus.module';
+export * from './health-indicator';
 export * from './errors';
+export { HealthCheck, HealthCheckService } from './health-check';
+export * from './terminus-module-options.interface';