@loopback/health 0.8.3

package/LICENSE

@@ -0,0 +1,25 @@
+Copyright (c) IBM Corp. 2019.
+Node module: @loopback/health
+This project is licensed under the MIT License, full text below.
+
+--------
+
+MIT license
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,135 @@
+# @loopback/health
+
+This module contains a component to report health status using
+[@cloudnative/health](https://github.com/CloudNativeJS/cloud-health).
+
+## Installation
+
+```sh
+npm install --save @loopback/health
+```
+
+## Basic use
+
+The component should be loaded in the constructor of your custom Application
+class.
+
+Start by importing the component class:
+
+```ts
+import {HealthComponent} from '@loopback/health';
+```
+
+In the constructor, add the component to your application:
+
+```ts
+this.component(HealthComponent);
+```
+
+By default, three routes are exposed at:
+
+- `/health` - overall health status
+- `/live` - liveness status
+- `/ready` - readiness status
+
+The paths can be customized via Health configuration as follows:
+
+```ts
+this.configure(HealthBindings.COMPONENT).to({
+  healthPath: '/health',
+  livePath: '/live',
+  readyPath: '/ready',
+});
+```
+
+{% include note.html content="*this.configure()* must be called before
+*this.component()* to take effect. This is a
+[known limitation](https://github.com/loopbackio/loopback-next/issues/4289#issuecomment-564617263)
+." %}
+
+http://localhost:3000/health returns health in JSON format, such as:
+
+```json
+{
+  "status": "UP",
+  "checks": [
+    {"name": "readiness", "state": "UP", "data": {"reason": ""}},
+    {"name": "liveness", "state": "UP", "data": {"reason": ""}}
+  ]
+}
+```
+
+It also has to be noted, that by default the OpenAPI spec is disabled and
+therefore the endpoints will not be visible in the API explorer. The spec can be
+enabled by setting `openApiSpec` to `true`.
+
+```ts
+this.configure(HealthBindings.COMPONENT).to({
+  openApiSpec: true,
+});
+```
+
+## Add custom `live` and `ready` checks
+
+The health component allows extra
+[`live` and `ready` checks](https://github.com/CloudNativeJS/cloud-health#readiness-vs-liveness)
+to be added.
+
+_Liveness probes_ are used to know when to restart a container. For example, in
+case of a deadlock due to a multi-threading defect which might not crash the
+container but keep the application unresponsive. A custom liveness probe would
+detect this failure and restart the container.
+
+_Readiness probes_ are used to decide when the container is available for
+accepting traffic. It is important to note, that readiness probes are
+periodically checked and not only at startup.
+
+**Important:** It is recommended to avoid checking dependencies in liveness
+probes. Liveness probes should be inexpensive and have response times with
+minimal variance.
+
+```ts
+import {LiveCheck, ReadyCheck, HealthTags} from '@loopback/health';
+
+const myLiveCheck: LiveCheck = () => {
+  return Promise.resolve();
+};
+app.bind('health.MyLiveCheck').to(myLiveCheck).tag(HealthTags.LIVE_CHECK);
+
+// Define a provider to check the health of a datasource
+class DBHealthCheckProvider implements Provider<ReadyCheck> {
+  constructor(@inject('datasources.db') private ds: DataSource) {}
+
+  value() {
+    return () => this.ds.ping();
+  }
+}
+
+app
+  .bind('health.MyDBCheck')
+  .toProvider(DBHealthCheckProvider)
+  .tag(HealthTags.READY_CHECK);
+
+const myReadyCheck: ReadyCheck = () => {
+  return Promise.resolve();
+};
+app.bind('health.MyReadyCheck').to(myReadyCheck).tag(HealthTags.READY_CHECK);
+```
+
+## Contributions
+
+- [Guidelines](https://github.com/loopbackio/loopback-next/blob/master/docs/CONTRIBUTING.md)
+- [Join the team](https://github.com/loopbackio/loopback-next/issues/110)
+
+## Tests
+
+Run `npm test` from the root folder.
+
+## Contributors
+
+See
+[all contributors](https://github.com/loopbackio/loopback-next/graphs/contributors).
+
+## License
+
+MIT

package/dist/controllers/health.controller.d.ts

@@ -0,0 +1,10 @@
+import { Constructor } from '@loopback/core';
+import { HealthOptions } from '../types';
+/**
+ * A factory function to create a controller class for health endpoints. This
+ * makes it possible to customize decorations such as `@get` with a dynamic
+ * path value not known at compile time.
+ *
+ * @param options - Options for health endpoints
+ */
+export declare function createHealthController(options?: HealthOptions): Constructor<unknown>;

package/dist/controllers/health.controller.js

@@ -0,0 +1,158 @@
+"use strict";
+// Copyright IBM Corp. 2019. All Rights Reserved.
+// Node module: @loopback/health
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createHealthController = void 0;
+const tslib_1 = require("tslib");
+const health_1 = require("@cloudnative/health");
+const core_1 = require("@loopback/core");
+const rest_1 = require("@loopback/rest");
+const keys_1 = require("../keys");
+const types_1 = require("../types");
+function getHealthResponseObject() {
+    /**
+     * OpenAPI definition of health response schema
+     */
+    const HEALTH_RESPONSE_SCHEMA = {
+        type: 'object',
+        properties: {
+            status: { type: 'string' },
+            checks: {
+                type: 'array',
+                items: {
+                    type: 'object',
+                    properties: {
+                        name: { type: 'string' },
+                        state: { type: 'string' },
+                        data: {
+                            type: 'object',
+                            properties: {
+                                reason: { type: 'string' },
+                            },
+                        },
+                    },
+                },
+            },
+        },
+    };
+    /**
+     * OpenAPI definition of health response
+     */
+    const HEALTH_RESPONSE = {
+        description: 'Health Response',
+        content: {
+            'application/json': {
+                schema: HEALTH_RESPONSE_SCHEMA,
+            },
+        },
+    };
+    return HEALTH_RESPONSE;
+}
+/**
+ * OpenAPI spec for health endpoints
+ */
+const HEALTH_SPEC = {
+    // response object needs to be cloned because the oas-validator throws an
+    // error if the same object is referenced twice
+    responses: {
+        '200': getHealthResponseObject(),
+        '500': getHealthResponseObject(),
+        '503': getHealthResponseObject(),
+    },
+};
+/**
+ * OpenAPI spec to hide endpoints
+ */
+const HIDDEN_SPEC = {
+    responses: {},
+    'x-visibility': 'undocumented',
+};
+/**
+ * A factory function to create a controller class for health endpoints. This
+ * makes it possible to customize decorations such as `@get` with a dynamic
+ * path value not known at compile time.
+ *
+ * @param options - Options for health endpoints
+ */
+function createHealthController(options = types_1.DEFAULT_HEALTH_OPTIONS) {
+    const spec = options.openApiSpec ? HEALTH_SPEC : HIDDEN_SPEC;
+    /**
+     * Controller for health endpoints
+     */
+    let HealthController = class HealthController {
+        constructor(healthChecker) {
+            this.healthChecker = healthChecker;
+        }
+        async health(response) {
+            const status = await this.healthChecker.getStatus();
+            return handleStatus(response, status);
+        }
+        async ready(response) {
+            const status = await this.healthChecker.getReadinessStatus();
+            return handleStatus(response, status, 503);
+        }
+        async live(response) {
+            const status = await this.healthChecker.getLivenessStatus();
+            return handleStatus(response, status, 500);
+        }
+    };
+    tslib_1.__decorate([
+        rest_1.get(options.healthPath, spec),
+        tslib_1.__param(0, core_1.inject(rest_1.RestBindings.Http.RESPONSE)),
+        tslib_1.__metadata("design:type", Function),
+        tslib_1.__metadata("design:paramtypes", [Object]),
+        tslib_1.__metadata("design:returntype", Promise)
+    ], HealthController.prototype, "health", null);
+    tslib_1.__decorate([
+        rest_1.get(options.readyPath, spec),
+        tslib_1.__param(0, core_1.inject(rest_1.RestBindings.Http.RESPONSE)),
+        tslib_1.__metadata("design:type", Function),
+        tslib_1.__metadata("design:paramtypes", [Object]),
+        tslib_1.__metadata("design:returntype", Promise)
+    ], HealthController.prototype, "ready", null);
+    tslib_1.__decorate([
+        rest_1.get(options.livePath, spec),
+        tslib_1.__param(0, core_1.inject(rest_1.RestBindings.Http.RESPONSE)),
+        tslib_1.__metadata("design:type", Function),
+        tslib_1.__metadata("design:paramtypes", [Object]),
+        tslib_1.__metadata("design:returntype", Promise)
+    ], HealthController.prototype, "live", null);
+    HealthController = tslib_1.__decorate([
+        core_1.injectable({ scope: core_1.BindingScope.SINGLETON }),
+        tslib_1.__param(0, core_1.inject(keys_1.HealthBindings.HEALTH_CHECKER)),
+        tslib_1.__metadata("design:paramtypes", [health_1.HealthChecker])
+    ], HealthController);
+    return HealthController;
+}
+exports.createHealthController = createHealthController;
+/**
+ * Create response for the given status
+ * @param response - Http response
+ * @param status - Health status
+ * @param failingCode - Status code for `DOWN`
+ */
+function handleStatus(response, status, failingCode = 503) {
+    let statusCode = 200;
+    switch (status.status) {
+        case health_1.State.STARTING:
+            statusCode = 503;
+            break;
+        case health_1.State.UP:
+            statusCode = 200;
+            break;
+        case health_1.State.DOWN:
+            statusCode = failingCode;
+            break;
+        case health_1.State.STOPPING:
+            statusCode = 503;
+            break;
+        case health_1.State.STOPPED:
+            statusCode = 503;
+            break;
+    }
+    response.status(statusCode).send(status);
+    return response;
+}
+//# sourceMappingURL=health.controller.js.map

package/dist/controllers/health.controller.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"health.controller.js","sourceRoot":"","sources":["../../src/controllers/health.controller.ts"],"names":[],"mappings":";AAAA,iDAAiD;AACjD,gCAAgC;AAChC,+CAA+C;AAC/C,gEAAgE;;;;AAEhE,gDAAuE;AACvE,yCAA6E;AAC7E,yCAOwB;AACxB,kCAAuC;AACvC,oCAA+D;AAE/D,SAAS,uBAAuB;IAC9B;;OAEG;IACH,MAAM,sBAAsB,GAAiB;QAC3C,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE;YACV,MAAM,EAAE,EAAC,IAAI,EAAE,QAAQ,EAAC;YACxB,MAAM,EAAE;gBACN,IAAI,EAAE,OAAO;gBACb,KAAK,EAAE;oBACL,IAAI,EAAE,QAAQ;oBACd,UAAU,EAAE;wBACV,IAAI,EAAE,EAAC,IAAI,EAAE,QAAQ,EAAC;wBACtB,KAAK,EAAE,EAAC,IAAI,EAAE,QAAQ,EAAC;wBACvB,IAAI,EAAE;4BACJ,IAAI,EAAE,QAAQ;4BACd,UAAU,EAAE;gCACV,MAAM,EAAE,EAAC,IAAI,EAAE,QAAQ,EAAC;6BACzB;yBACF;qBACF;iBACF;aACF;SACF;KACF,CAAC;IAEF;;OAEG;IACH,MAAM,eAAe,GAAmB;QACtC,WAAW,EAAE,iBAAiB;QAC9B,OAAO,EAAE;YACP,kBAAkB,EAAE;gBAClB,MAAM,EAAE,sBAAsB;aAC/B;SACF;KACF,CAAC;IAEF,OAAO,eAAe,CAAC;AACzB,CAAC;AAED;;GAEG;AACH,MAAM,WAAW,GAAoB;IACnC,yEAAyE;IACzE,+CAA+C;IAC/C,SAAS,EAAE;QACT,KAAK,EAAE,uBAAuB,EAAE;QAChC,KAAK,EAAE,uBAAuB,EAAE;QAChC,KAAK,EAAE,uBAAuB,EAAE;KACjC;CACF,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,GAAoB;IACnC,SAAS,EAAE,EAAE;IACb,cAAc,EAAE,cAAc;CAC/B,CAAC;AAEF;;;;;;GAMG;AACH,SAAgB,sBAAsB,CACpC,UAAyB,8BAAsB;IAE/C,MAAM,IAAI,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC;IAE7D;;OAEG;IAEH,IAAM,gBAAgB,GAAtB,MAAM,gBAAgB;QACpB,YAEU,aAA4B;YAA5B,kBAAa,GAAb,aAAa,CAAe;QACnC,CAAC;QAGJ,KAAK,CAAC,MAAM,CAAqC,QAAkB;YACjE,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE,CAAC;YACpD,OAAO,YAAY,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;QACxC,CAAC;QAGD,KAAK,CAAC,KAAK,CAAqC,QAAkB;YAChE,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,kBAAkB,EAAE,CAAC;YAC7D,OAAO,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,CAAC,CAAC;QAC7C,CAAC;QAGD,KAAK,CAAC,IAAI,CAAqC,QAAkB;YAC/D,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,iBAAiB,EAAE,CAAC;YAC5D,OAAO,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,CAAC,CAAC;QAC7C,CAAC;KACF,CAAA;IAhBC;QADC,UAAG,CAAC,OAAO,CAAC,UAAU,EAAE,IAAI,CAAC;QAChB,mBAAA,aAAM,CAAC,mBAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;;;;kDAG/C;IAGD;QADC,UAAG,CAAC,OAAO,CAAC,SAAS,EAAE,IAAI,CAAC;QAChB,mBAAA,aAAM,CAAC,mBAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;;;;iDAG9C;IAGD;QADC,UAAG,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC;QAChB,mBAAA,aAAM,CAAC,mBAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;;;;gDAG7C;IAtBG,gBAAgB;QADrB,iBAAU,CAAC,EAAC,KAAK,EAAE,mBAAY,CAAC,SAAS,EAAC,CAAC;QAGvC,mBAAA,aAAM,CAAC,qBAAc,CAAC,cAAc,CAAC,CAAA;iDACf,sBAAa;OAHlC,gBAAgB,CAuBrB;IAED,OAAO,gBAAgB,CAAC;AAC1B,CAAC;AAnCD,wDAmCC;AAED;;;;;GAKG;AACH,SAAS,YAAY,CACnB,QAAkB,EAClB,MAAoB,EACpB,cAAyB,GAAG;IAE5B,IAAI,UAAU,GAAG,GAAG,CAAC;IACrB,QAAQ,MAAM,CAAC,MAAM,EAAE;QACrB,KAAK,cAAK,CAAC,QAAQ;YACjB,UAAU,GAAG,GAAG,CAAC;YACjB,MAAM;QACR,KAAK,cAAK,CAAC,EAAE;YACX,UAAU,GAAG,GAAG,CAAC;YACjB,MAAM;QACR,KAAK,cAAK,CAAC,IAAI;YACb,UAAU,GAAG,WAAW,CAAC;YACzB,MAAM;QACR,KAAK,cAAK,CAAC,QAAQ;YACjB,UAAU,GAAG,GAAG,CAAC;YACjB,MAAM;QACR,KAAK,cAAK,CAAC,OAAO;YAChB,UAAU,GAAG,GAAG,CAAC;YACjB,MAAM;KACT;IACD,QAAQ,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACzC,OAAO,QAAQ,CAAC;AAClB,CAAC"}

package/dist/controllers/index.d.ts

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

package/dist/controllers/index.js

@@ -0,0 +1,9 @@
+"use strict";
+// Copyright IBM Corp. 2019. All Rights Reserved.
+// Node module: @loopback/health
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./health.controller"), exports);
+//# sourceMappingURL=index.js.map

package/dist/controllers/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/controllers/index.ts"],"names":[],"mappings":";AAAA,iDAAiD;AACjD,gCAAgC;AAChC,+CAA+C;AAC/C,gEAAgE;;;AAEhE,8DAAoC"}

package/dist/health.component.d.ts

@@ -0,0 +1,9 @@
+import { Application, Component } from '@loopback/core';
+import { HealthConfig } from './types';
+/**
+ * A component providing health status
+ */
+export declare class HealthComponent implements Component {
+    private application;
+    constructor(application: Application, healthConfig?: HealthConfig);
+}

package/dist/health.component.js

@@ -0,0 +1,44 @@
+"use strict";
+// Copyright IBM Corp. 2019. All Rights Reserved.
+// Node module: @loopback/health
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HealthComponent = void 0;
+const tslib_1 = require("tslib");
+const health_1 = require("@cloudnative/health");
+const core_1 = require("@loopback/core");
+const controllers_1 = require("./controllers");
+const keys_1 = require("./keys");
+const observers_1 = require("./observers");
+const types_1 = require("./types");
+/**
+ * A component providing health status
+ */
+let HealthComponent = class HealthComponent {
+    constructor(application, healthConfig = {}) {
+        this.application = application;
+        // Bind the HealthCheck service
+        this.application
+            .bind(keys_1.HealthBindings.HEALTH_CHECKER)
+            .toClass(health_1.HealthChecker)
+            .inScope(core_1.BindingScope.SINGLETON);
+        // Bind the health observer
+        this.application.lifeCycleObserver(observers_1.HealthObserver);
+        const options = {
+            ...types_1.DEFAULT_HEALTH_OPTIONS,
+            ...healthConfig,
+        };
+        if (!options.disabled) {
+            this.application.controller(controllers_1.createHealthController(options));
+        }
+    }
+};
+HealthComponent = tslib_1.__decorate([
+    core_1.injectable({ tags: { [core_1.ContextTags.KEY]: keys_1.HealthBindings.COMPONENT } }),
+    tslib_1.__param(0, core_1.inject(core_1.CoreBindings.APPLICATION_INSTANCE)),
+    tslib_1.__param(1, core_1.config()),
+    tslib_1.__metadata("design:paramtypes", [core_1.Application, Object])
+], HealthComponent);
+exports.HealthComponent = HealthComponent;
+//# sourceMappingURL=health.component.js.map

package/dist/health.component.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"health.component.js","sourceRoot":"","sources":["../src/health.component.ts"],"names":[],"mappings":";AAAA,iDAAiD;AACjD,gCAAgC;AAChC,+CAA+C;AAC/C,gEAAgE;;;;AAEhE,gDAAkD;AAClD,yCASwB;AACxB,+CAAqD;AACrD,iCAAsC;AACtC,2CAA2C;AAC3C,mCAA4E;AAE5E;;GAEG;AAEH,IAAa,eAAe,GAA5B,MAAa,eAAe;IAC1B,YAEU,WAAwB,EAEhC,eAA6B,EAAE;QAFvB,gBAAW,GAAX,WAAW,CAAa;QAIhC,+BAA+B;QAC/B,IAAI,CAAC,WAAW;aACb,IAAI,CAAC,qBAAc,CAAC,cAAc,CAAC;aACnC,OAAO,CAAC,sBAAa,CAAC;aACtB,OAAO,CAAC,mBAAY,CAAC,SAAS,CAAC,CAAC;QAEnC,2BAA2B;QAC3B,IAAI,CAAC,WAAW,CAAC,iBAAiB,CAAC,0BAAc,CAAC,CAAC;QAEnD,MAAM,OAAO,GAAkB;YAC7B,GAAG,8BAAsB;YACzB,GAAG,YAAY;SAChB,CAAC;QACF,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE;YACrB,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,oCAAsB,CAAC,OAAO,CAAC,CAAC,CAAC;SAC9D;IACH,CAAC;CACF,CAAA;AAxBY,eAAe;IAD3B,iBAAU,CAAC,EAAC,IAAI,EAAE,EAAC,CAAC,kBAAW,CAAC,GAAG,CAAC,EAAE,qBAAc,CAAC,SAAS,EAAC,EAAC,CAAC;IAG7D,mBAAA,aAAM,CAAC,mBAAY,CAAC,oBAAoB,CAAC,CAAA;IAEzC,mBAAA,aAAM,EAAE,CAAA;6CADY,kBAAW;GAHvB,eAAe,CAwB3B;AAxBY,0CAAe"}

package/dist/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * A component to report health status using
+ * {@link https://github.com/CloudNativeJS/cloud-health | @cloudnative/health }.
+ *
+ * @packageDocumentation
+ */
+export * from './health.component';
+export * from './keys';
+export * from './types';

package/dist/index.js

@@ -0,0 +1,17 @@
+"use strict";
+// Copyright IBM Corp. 2019,2020. All Rights Reserved.
+// Node module: @loopback/health
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+/**
+ * A component to report health status using
+ * {@link https://github.com/CloudNativeJS/cloud-health | @cloudnative/health }.
+ *
+ * @packageDocumentation
+ */
+tslib_1.__exportStar(require("./health.component"), exports);
+tslib_1.__exportStar(require("./keys"), exports);
+tslib_1.__exportStar(require("./types"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,gCAAgC;AAChC,+CAA+C;AAC/C,gEAAgE;;;AAEhE;;;;;GAKG;AAEH,6DAAmC;AACnC,iDAAuB;AACvB,kDAAwB"}

package/dist/keys.d.ts

@@ -0,0 +1,25 @@
+import { HealthChecker } from '@cloudnative/health';
+import { BindingAddress, BindingKey } from '@loopback/core';
+import { HealthComponent } from './health.component';
+import { HealthConfig } from './types';
+/**
+ * Binding keys used by this component.
+ */
+export declare namespace HealthBindings {
+    const COMPONENT: BindingKey<HealthComponent>;
+    const CONFIG: BindingAddress<HealthConfig>;
+    const HEALTH_CHECKER: BindingKey<HealthChecker>;
+}
+/**
+ * Binding tags for health related services
+ */
+export declare namespace HealthTags {
+    /**
+     * Binding tag for liveness check functions
+     */
+    const LIVE_CHECK = "health.liveCheck";
+    /**
+     * Binding tag for readiness check functions
+     */
+    const READY_CHECK = "health.readyCheck";
+}

package/dist/keys.js

@@ -0,0 +1,32 @@
+"use strict";
+// Copyright IBM Corp. 2019,2020. All Rights Reserved.
+// Node module: @loopback/health
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HealthTags = exports.HealthBindings = void 0;
+const core_1 = require("@loopback/core");
+/**
+ * Binding keys used by this component.
+ */
+var HealthBindings;
+(function (HealthBindings) {
+    HealthBindings.COMPONENT = core_1.BindingKey.create('components.HealthComponent');
+    HealthBindings.CONFIG = core_1.BindingKey.buildKeyForConfig(HealthBindings.COMPONENT.key);
+    HealthBindings.HEALTH_CHECKER = core_1.BindingKey.create('health.HeathChecker');
+})(HealthBindings = exports.HealthBindings || (exports.HealthBindings = {}));
+/**
+ * Binding tags for health related services
+ */
+var HealthTags;
+(function (HealthTags) {
+    /**
+     * Binding tag for liveness check functions
+     */
+    HealthTags.LIVE_CHECK = 'health.liveCheck';
+    /**
+     * Binding tag for readiness check functions
+     */
+    HealthTags.READY_CHECK = 'health.readyCheck';
+})(HealthTags = exports.HealthTags || (exports.HealthTags = {}));
+//# sourceMappingURL=keys.js.map

package/dist/keys.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"keys.js","sourceRoot":"","sources":["../src/keys.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,gCAAgC;AAChC,+CAA+C;AAC/C,gEAAgE;;;AAGhE,yCAA0D;AAI1D;;GAEG;AACH,IAAiB,cAAc,CAW9B;AAXD,WAAiB,cAAc;IAChB,wBAAS,GAAG,iBAAU,CAAC,MAAM,CACxC,4BAA4B,CAC7B,CAAC;IAEW,qBAAM,GACjB,iBAAU,CAAC,iBAAiB,CAAe,eAAA,SAAS,CAAC,GAAG,CAAC,CAAC;IAE/C,6BAAc,GAAG,iBAAU,CAAC,MAAM,CAC7C,qBAAqB,CACtB,CAAC;AACJ,CAAC,EAXgB,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAW9B;AAED;;GAEG;AACH,IAAiB,UAAU,CAS1B;AATD,WAAiB,UAAU;IACzB;;OAEG;IACU,qBAAU,GAAG,kBAAkB,CAAC;IAC7C;;OAEG;IACU,sBAAW,GAAG,mBAAmB,CAAC;AACjD,CAAC,EATgB,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAS1B"}

package/dist/observers/health.observer.d.ts

@@ -0,0 +1,14 @@
+import { HealthChecker } from '@cloudnative/health';
+import { ContextView, LifeCycleObserver } from '@loopback/core';
+import { LiveCheck, ReadyCheck } from '../types';
+export declare class HealthObserver implements LifeCycleObserver {
+    private healthChecker;
+    private liveChecks;
+    private readyChecks;
+    private eventEmitter;
+    private startupCheck;
+    private shutdownCheck;
+    constructor(healthChecker: HealthChecker, liveChecks: ContextView<LiveCheck>, readyChecks: ContextView<ReadyCheck>);
+    start(): Promise<void>;
+    stop(): void;
+}

package/dist/observers/health.observer.js

@@ -0,0 +1,72 @@
+"use strict";
+// Copyright IBM Corp. 2019,2020. All Rights Reserved.
+// Node module: @loopback/health
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HealthObserver = void 0;
+const tslib_1 = require("tslib");
+const health_1 = require("@cloudnative/health");
+const core_1 = require("@loopback/core");
+const events_1 = require("events");
+const keys_1 = require("../keys");
+let HealthObserver = class HealthObserver {
+    constructor(healthChecker, liveChecks, readyChecks) {
+        this.healthChecker = healthChecker;
+        this.liveChecks = liveChecks;
+        this.readyChecks = readyChecks;
+        this.eventEmitter = new events_1.EventEmitter();
+        const startup = once(this.eventEmitter, 'startup');
+        const startupCheck = new health_1.StartupCheck('startup', () => startup);
+        this.startupCheck = this.healthChecker.registerStartupCheck(startupCheck);
+        const shutdown = once(this.eventEmitter, 'shutdown');
+        this.shutdownCheck = new health_1.ShutdownCheck('shutdown', () => shutdown);
+    }
+    async start() {
+        this.healthChecker.registerShutdownCheck(this.shutdownCheck);
+        const liveChecks = await this.liveChecks.values();
+        const liveCheckBindings = this.liveChecks.bindings;
+        let index = 0;
+        for (const lc of liveChecks) {
+            const name = liveCheckBindings[index].key;
+            const check = new health_1.LivenessCheck(name, lc);
+            this.healthChecker.registerLivenessCheck(check);
+            index++;
+        }
+        const readyChecks = await this.readyChecks.values();
+        const readyCheckBindings = this.readyChecks.bindings;
+        index = 0;
+        for (const rc of readyChecks) {
+            const name = readyCheckBindings[index].key;
+            const check = new health_1.ReadinessCheck(name, rc);
+            this.healthChecker.registerReadinessCheck(check);
+            index++;
+        }
+        this.eventEmitter.emit('startup');
+        await this.startupCheck;
+    }
+    stop() {
+        this.eventEmitter.emit('shutdown');
+        // Fix a potential memory leak caused by
+        // https://github.com/CloudNativeJS/cloud-health/blob/2.1.2/src/healthcheck/HealthChecker.ts#L118
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        const onShutdownRequest = this.healthChecker.onShutdownRequest;
+        if (onShutdownRequest != null) {
+            // Remove the listener from the current process
+            process.removeListener('SIGTERM', onShutdownRequest);
+        }
+    }
+};
+HealthObserver = tslib_1.__decorate([
+    tslib_1.__param(0, core_1.inject(keys_1.HealthBindings.HEALTH_CHECKER)),
+    tslib_1.__param(1, core_1.inject.view(core_1.filterByTag(keys_1.HealthTags.LIVE_CHECK))),
+    tslib_1.__param(2, core_1.inject.view(core_1.filterByTag(keys_1.HealthTags.READY_CHECK))),
+    tslib_1.__metadata("design:paramtypes", [health_1.HealthChecker,
+        core_1.ContextView,
+        core_1.ContextView])
+], HealthObserver);
+exports.HealthObserver = HealthObserver;
+function once(emitter, event) {
+    return events_1.once(emitter, event);
+}
+//# sourceMappingURL=health.observer.js.map

package/dist/observers/health.observer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"health.observer.js","sourceRoot":"","sources":["../../src/observers/health.observer.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,gCAAgC;AAChC,+CAA+C;AAC/C,gEAAgE;;;;AAEhE,gDAM6B;AAC7B,yCAKwB;AACxB,mCAAyD;AACzD,kCAAmD;AAGnD,IAAa,cAAc,GAA3B,MAAa,cAAc;IAKzB,YACiD,aAA4B,EAGnE,UAAkC,EAGlC,WAAoC;QANG,kBAAa,GAAb,aAAa,CAAe;QAGnE,eAAU,GAAV,UAAU,CAAwB;QAGlC,gBAAW,GAAX,WAAW,CAAyB;QAXtC,iBAAY,GAAG,IAAI,qBAAY,EAAE,CAAC;QAaxC,MAAM,OAAO,GAAG,IAAI,CAClB,IAAI,CAAC,YAAY,EACjB,SAAS,CACkB,CAAC;QAC9B,MAAM,YAAY,GAAG,IAAI,qBAAY,CAAC,SAAS,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,CAAC;QAChE,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,aAAa,CAAC,oBAAoB,CAAC,YAAY,CAAC,CAAC;QAC1E,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;QACrD,IAAI,CAAC,aAAa,GAAG,IAAI,sBAAa,CAAC,UAAU,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,CAAC;IACrE,CAAC;IAED,KAAK,CAAC,KAAK;QACT,IAAI,CAAC,aAAa,CAAC,qBAAqB,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAC7D,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;QAClD,MAAM,iBAAiB,GAAG,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC;QACnD,IAAI,KAAK,GAAG,CAAC,CAAC;QACd,KAAK,MAAM,EAAE,IAAI,UAAU,EAAE;YAC3B,MAAM,IAAI,GAAG,iBAAiB,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC;YAC1C,MAAM,KAAK,GAAG,IAAI,sBAAa,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YAC1C,IAAI,CAAC,aAAa,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC;YAChD,KAAK,EAAE,CAAC;SACT;QAED,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC;QACpD,MAAM,kBAAkB,GAAG,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC;QACrD,KAAK,GAAG,CAAC,CAAC;QACV,KAAK,MAAM,EAAE,IAAI,WAAW,EAAE;YAC5B,MAAM,IAAI,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC;YAC3C,MAAM,KAAK,GAAG,IAAI,uBAAc,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YAC3C,IAAI,CAAC,aAAa,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAC;YACjD,KAAK,EAAE,CAAC;SACT;QAED,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAClC,MAAM,IAAI,CAAC,YAAY,CAAC;IAC1B,CAAC;IAED,IAAI;QACF,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACnC,wCAAwC;QACxC,iGAAiG;QACjG,8DAA8D;QAC9D,MAAM,iBAAiB,GAAI,IAAI,CAAC,aAAqB,CAAC,iBAAiB,CAAC;QACxE,IAAI,iBAAiB,IAAI,IAAI,EAAE;YAC7B,+CAA+C;YAC/C,OAAO,CAAC,cAAc,CAAC,SAAS,EAAE,iBAAiB,CAAC,CAAC;SACtD;IACH,CAAC;CACF,CAAA;AA7DY,cAAc;IAMtB,mBAAA,aAAM,CAAC,qBAAc,CAAC,cAAc,CAAC,CAAA;IAErC,mBAAA,aAAM,CAAC,IAAI,CAAC,kBAAW,CAAC,iBAAU,CAAC,UAAU,CAAC,CAAC,CAAA;IAG/C,mBAAA,aAAM,CAAC,IAAI,CAAC,kBAAW,CAAC,iBAAU,CAAC,WAAW,CAAC,CAAC,CAAA;6CALa,sBAAa;QAGvD,kBAAW;QAGV,kBAAW;GAZvB,cAAc,CA6D1B;AA7DY,wCAAc;AA+D3B,SAAS,IAAI,CAAC,OAAqB,EAAE,KAAsB;IACzD,OAAO,aAAW,CAAC,OAAO,EAAE,KAAK,CAA6B,CAAC;AACjE,CAAC"}

package/dist/observers/index.d.ts

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

package/dist/observers/index.js

@@ -0,0 +1,9 @@
+"use strict";
+// Copyright IBM Corp. 2019. All Rights Reserved.
+// Node module: @loopback/health
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./health.observer"), exports);
+//# sourceMappingURL=index.js.map

package/dist/observers/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/observers/index.ts"],"names":[],"mappings":";AAAA,iDAAiD;AACjD,gCAAgC;AAChC,+CAA+C;AAC/C,gEAAgE;;;AAEhE,4DAAkC"}

package/dist/types.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Options for health component
+ */
+export declare type HealthOptions = {
+    disabled?: boolean;
+    healthPath: string;
+    readyPath: string;
+    livePath: string;
+    openApiSpec?: boolean;
+};
+/**
+ * Configuration for health component with optional properties
+ */
+export declare type HealthConfig = Partial<HealthOptions>;
+export declare const DEFAULT_HEALTH_OPTIONS: HealthOptions;
+/**
+ * Functions for liveness check
+ */
+export declare type LiveCheck = () => Promise<void>;
+/**
+ * Functions for readiness check
+ */
+export declare type ReadyCheck = () => Promise<void>;

package/dist/types.js

@@ -0,0 +1,14 @@
+"use strict";
+// Copyright IBM Corp. 2019. All Rights Reserved.
+// Node module: @loopback/health
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_HEALTH_OPTIONS = void 0;
+exports.DEFAULT_HEALTH_OPTIONS = {
+    healthPath: '/health',
+    readyPath: '/ready',
+    livePath: '/live',
+    openApiSpec: false,
+};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";AAAA,iDAAiD;AACjD,gCAAgC;AAChC,+CAA+C;AAC/C,gEAAgE;;;AAkBnD,QAAA,sBAAsB,GAAkB;IACnD,UAAU,EAAE,SAAS;IACrB,SAAS,EAAE,QAAQ;IACnB,QAAQ,EAAE,OAAO;IACjB,WAAW,EAAE,KAAK;CACnB,CAAC"}

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@loopback/health",
+  "description": "An extension exposes health check related endpoints with LoopBack 4",
+  "version": "0.8.3",
+  "keywords": [
+    "LoopBack",
+    "Cloud Native",
+    "Health"
+  ],
+  "license": "MIT",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "author": "IBM Corp.",
+  "copyright.owner": "IBM Corp.",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/loopbackio/loopback-next.git",
+    "directory": "extensions/health"
+  },
+  "engines": {
+    "node": "^10.16 || 12 || 14 || 16"
+  },
+  "scripts": {
+    "build": "lb-tsc",
+    "clean": "lb-clean loopback-extension-health*.tgz dist *.tsbuildinfo package",
+    "pretest": "npm run build",
+    "test": "lb-mocha \"dist/__tests__/**/*.js\"",
+    "verify": "npm pack && tar xf loopback-extension-health*.tgz && tree package && npm run clean",
+    "demo": "./src/__examples__/demo.sh"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "README.md",
+    "dist",
+    "src",
+    "!*/__tests__"
+  ],
+  "peerDependencies": {
+    "@loopback/core": "^2.17.0",
+    "@loopback/rest": "^10.0.1"
+  },
+  "dependencies": {
+    "@cloudnative/health": "^2.1.2",
+    "tslib": "^2.3.1"
+  },
+  "devDependencies": {
+    "@loopback/build": "^7.0.1",
+    "@loopback/core": "^2.17.0",
+    "@loopback/eslint-config": "^11.0.1",
+    "@loopback/rest": "^10.0.1",
+    "@loopback/testlab": "^3.4.3",
+    "@types/node": "^10.17.60"
+  },
+  "gitHead": "1df36bb1ee2e513d9e197bd6010c4cfb296d50b8"
+}

package/src/controllers/health.controller.ts

@@ -0,0 +1,157 @@
+// Copyright IBM Corp. 2019. All Rights Reserved.
+// Node module: @loopback/health
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+
+import {HealthChecker, HealthStatus, State} from '@cloudnative/health';
+import {BindingScope, Constructor, inject, injectable} from '@loopback/core';
+import {
+  get,
+  OperationObject,
+  Response,
+  ResponseObject,
+  RestBindings,
+  SchemaObject,
+} from '@loopback/rest';
+import {HealthBindings} from '../keys';
+import {DEFAULT_HEALTH_OPTIONS, HealthOptions} from '../types';
+
+function getHealthResponseObject() {
+  /**
+   * OpenAPI definition of health response schema
+   */
+  const HEALTH_RESPONSE_SCHEMA: SchemaObject = {
+    type: 'object',
+    properties: {
+      status: {type: 'string'},
+      checks: {
+        type: 'array',
+        items: {
+          type: 'object',
+          properties: {
+            name: {type: 'string'},
+            state: {type: 'string'},
+            data: {
+              type: 'object',
+              properties: {
+                reason: {type: 'string'},
+              },
+            },
+          },
+        },
+      },
+    },
+  };
+
+  /**
+   * OpenAPI definition of health response
+   */
+  const HEALTH_RESPONSE: ResponseObject = {
+    description: 'Health Response',
+    content: {
+      'application/json': {
+        schema: HEALTH_RESPONSE_SCHEMA,
+      },
+    },
+  };
+
+  return HEALTH_RESPONSE;
+}
+
+/**
+ * OpenAPI spec for health endpoints
+ */
+const HEALTH_SPEC: OperationObject = {
+  // response object needs to be cloned because the oas-validator throws an
+  // error if the same object is referenced twice
+  responses: {
+    '200': getHealthResponseObject(),
+    '500': getHealthResponseObject(),
+    '503': getHealthResponseObject(),
+  },
+};
+
+/**
+ * OpenAPI spec to hide endpoints
+ */
+const HIDDEN_SPEC: OperationObject = {
+  responses: {},
+  'x-visibility': 'undocumented',
+};
+
+/**
+ * A factory function to create a controller class for health endpoints. This
+ * makes it possible to customize decorations such as `@get` with a dynamic
+ * path value not known at compile time.
+ *
+ * @param options - Options for health endpoints
+ */
+export function createHealthController(
+  options: HealthOptions = DEFAULT_HEALTH_OPTIONS,
+): Constructor<unknown> {
+  const spec = options.openApiSpec ? HEALTH_SPEC : HIDDEN_SPEC;
+
+  /**
+   * Controller for health endpoints
+   */
+  @injectable({scope: BindingScope.SINGLETON})
+  class HealthController {
+    constructor(
+      @inject(HealthBindings.HEALTH_CHECKER)
+      private healthChecker: HealthChecker,
+    ) {}
+
+    @get(options.healthPath, spec)
+    async health(@inject(RestBindings.Http.RESPONSE) response: Response) {
+      const status = await this.healthChecker.getStatus();
+      return handleStatus(response, status);
+    }
+
+    @get(options.readyPath, spec)
+    async ready(@inject(RestBindings.Http.RESPONSE) response: Response) {
+      const status = await this.healthChecker.getReadinessStatus();
+      return handleStatus(response, status, 503);
+    }
+
+    @get(options.livePath, spec)
+    async live(@inject(RestBindings.Http.RESPONSE) response: Response) {
+      const status = await this.healthChecker.getLivenessStatus();
+      return handleStatus(response, status, 500);
+    }
+  }
+
+  return HealthController;
+}
+
+/**
+ * Create response for the given status
+ * @param response - Http response
+ * @param status - Health status
+ * @param failingCode - Status code for `DOWN`
+ */
+function handleStatus(
+  response: Response,
+  status: HealthStatus,
+  failingCode: 500 | 503 = 503,
+) {
+  let statusCode = 200;
+  switch (status.status) {
+    case State.STARTING:
+      statusCode = 503;
+      break;
+    case State.UP:
+      statusCode = 200;
+      break;
+    case State.DOWN:
+      statusCode = failingCode;
+      break;
+    case State.STOPPING:
+      statusCode = 503;
+      break;
+    case State.STOPPED:
+      statusCode = 503;
+      break;
+  }
+  response.status(statusCode).send(status);
+  return response;
+}

package/src/controllers/index.ts

@@ -0,0 +1,6 @@
+// Copyright IBM Corp. 2019. All Rights Reserved.
+// Node module: @loopback/health
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+
+export * from './health.controller';

package/src/health.component.ts

@@ -0,0 +1,50 @@
+// Copyright IBM Corp. 2019. All Rights Reserved.
+// Node module: @loopback/health
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+
+import {HealthChecker} from '@cloudnative/health';
+import {
+  Application,
+  BindingScope,
+  Component,
+  config,
+  ContextTags,
+  CoreBindings,
+  inject,
+  injectable,
+} from '@loopback/core';
+import {createHealthController} from './controllers';
+import {HealthBindings} from './keys';
+import {HealthObserver} from './observers';
+import {DEFAULT_HEALTH_OPTIONS, HealthConfig, HealthOptions} from './types';
+
+/**
+ * A component providing health status
+ */
+@injectable({tags: {[ContextTags.KEY]: HealthBindings.COMPONENT}})
+export class HealthComponent implements Component {
+  constructor(
+    @inject(CoreBindings.APPLICATION_INSTANCE)
+    private application: Application,
+    @config()
+    healthConfig: HealthConfig = {},
+  ) {
+    // Bind the HealthCheck service
+    this.application
+      .bind(HealthBindings.HEALTH_CHECKER)
+      .toClass(HealthChecker)
+      .inScope(BindingScope.SINGLETON);
+
+    // Bind the health observer
+    this.application.lifeCycleObserver(HealthObserver);
+
+    const options: HealthOptions = {
+      ...DEFAULT_HEALTH_OPTIONS,
+      ...healthConfig,
+    };
+    if (!options.disabled) {
+      this.application.controller(createHealthController(options));
+    }
+  }
+}

package/src/index.ts

@@ -0,0 +1,15 @@
+// Copyright IBM Corp. 2019,2020. All Rights Reserved.
+// Node module: @loopback/health
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+
+/**
+ * A component to report health status using
+ * {@link https://github.com/CloudNativeJS/cloud-health | @cloudnative/health }.
+ *
+ * @packageDocumentation
+ */
+
+export * from './health.component';
+export * from './keys';
+export * from './types';

package/src/keys.ts

@@ -0,0 +1,39 @@
+// Copyright IBM Corp. 2019,2020. All Rights Reserved.
+// Node module: @loopback/health
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+
+import {HealthChecker} from '@cloudnative/health';
+import {BindingAddress, BindingKey} from '@loopback/core';
+import {HealthComponent} from './health.component';
+import {HealthConfig} from './types';
+
+/**
+ * Binding keys used by this component.
+ */
+export namespace HealthBindings {
+  export const COMPONENT = BindingKey.create<HealthComponent>(
+    'components.HealthComponent',
+  );
+
+  export const CONFIG: BindingAddress<HealthConfig> =
+    BindingKey.buildKeyForConfig<HealthConfig>(COMPONENT.key);
+
+  export const HEALTH_CHECKER = BindingKey.create<HealthChecker>(
+    'health.HeathChecker',
+  );
+}
+
+/**
+ * Binding tags for health related services
+ */
+export namespace HealthTags {
+  /**
+   * Binding tag for liveness check functions
+   */
+  export const LIVE_CHECK = 'health.liveCheck';
+  /**
+   * Binding tag for readiness check functions
+   */
+  export const READY_CHECK = 'health.readyCheck';
+}

package/src/observers/health.observer.ts

@@ -0,0 +1,88 @@
+// Copyright IBM Corp. 2019,2020. All Rights Reserved.
+// Node module: @loopback/health
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+
+import {
+  HealthChecker,
+  LivenessCheck,
+  ReadinessCheck,
+  ShutdownCheck,
+  StartupCheck,
+} from '@cloudnative/health';
+import {
+  ContextView,
+  filterByTag,
+  inject,
+  LifeCycleObserver,
+} from '@loopback/core';
+import {EventEmitter, once as onceGeneric} from 'events';
+import {HealthBindings, HealthTags} from '../keys';
+import {LiveCheck, ReadyCheck} from '../types';
+
+export class HealthObserver implements LifeCycleObserver {
+  private eventEmitter = new EventEmitter();
+  private startupCheck: Promise<void>;
+  private shutdownCheck: ShutdownCheck;
+
+  constructor(
+    @inject(HealthBindings.HEALTH_CHECKER) private healthChecker: HealthChecker,
+
+    @inject.view(filterByTag(HealthTags.LIVE_CHECK))
+    private liveChecks: ContextView<LiveCheck>,
+
+    @inject.view(filterByTag(HealthTags.READY_CHECK))
+    private readyChecks: ContextView<ReadyCheck>,
+  ) {
+    const startup = once(
+      this.eventEmitter,
+      'startup',
+    ) as unknown as Promise<void>;
+    const startupCheck = new StartupCheck('startup', () => startup);
+    this.startupCheck = this.healthChecker.registerStartupCheck(startupCheck);
+    const shutdown = once(this.eventEmitter, 'shutdown');
+    this.shutdownCheck = new ShutdownCheck('shutdown', () => shutdown);
+  }
+
+  async start() {
+    this.healthChecker.registerShutdownCheck(this.shutdownCheck);
+    const liveChecks = await this.liveChecks.values();
+    const liveCheckBindings = this.liveChecks.bindings;
+    let index = 0;
+    for (const lc of liveChecks) {
+      const name = liveCheckBindings[index].key;
+      const check = new LivenessCheck(name, lc);
+      this.healthChecker.registerLivenessCheck(check);
+      index++;
+    }
+
+    const readyChecks = await this.readyChecks.values();
+    const readyCheckBindings = this.readyChecks.bindings;
+    index = 0;
+    for (const rc of readyChecks) {
+      const name = readyCheckBindings[index].key;
+      const check = new ReadinessCheck(name, rc);
+      this.healthChecker.registerReadinessCheck(check);
+      index++;
+    }
+
+    this.eventEmitter.emit('startup');
+    await this.startupCheck;
+  }
+
+  stop() {
+    this.eventEmitter.emit('shutdown');
+    // Fix a potential memory leak caused by
+    // https://github.com/CloudNativeJS/cloud-health/blob/2.1.2/src/healthcheck/HealthChecker.ts#L118
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const onShutdownRequest = (this.healthChecker as any).onShutdownRequest;
+    if (onShutdownRequest != null) {
+      // Remove the listener from the current process
+      process.removeListener('SIGTERM', onShutdownRequest);
+    }
+  }
+}
+
+function once(emitter: EventEmitter, event: string | symbol): Promise<void> {
+  return onceGeneric(emitter, event) as unknown as Promise<void>;
+}

package/src/observers/index.ts

@@ -0,0 +1,6 @@
+// Copyright IBM Corp. 2019. All Rights Reserved.
+// Node module: @loopback/health
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+
+export * from './health.observer';

package/src/types.ts

@@ -0,0 +1,37 @@
+// Copyright IBM Corp. 2019. All Rights Reserved.
+// Node module: @loopback/health
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+
+/**
+ * Options for health component
+ */
+export type HealthOptions = {
+  disabled?: boolean;
+  healthPath: string;
+  readyPath: string;
+  livePath: string;
+  openApiSpec?: boolean;
+};
+
+/**
+ * Configuration for health component with optional properties
+ */
+export type HealthConfig = Partial<HealthOptions>;
+
+export const DEFAULT_HEALTH_OPTIONS: HealthOptions = {
+  healthPath: '/health',
+  readyPath: '/ready',
+  livePath: '/live',
+  openApiSpec: false,
+};
+
+/**
+ * Functions for liveness check
+ */
+export type LiveCheck = () => Promise<void>;
+
+/**
+ * Functions for readiness check
+ */
+export type ReadyCheck = () => Promise<void>;