npm - @visulima/health-check - Versions diffs - 1.0.6 → 1.0.8 - Mend

@visulima/health-check 1.0.6 → 1.0.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (8) hide show

package/CHANGELOG.md CHANGED Viewed

@@ -1,3 +1,18 @@
+## @visulima/health-check [1.0.8](https://github.com/visulima/visulima/compare/@visulima/health-check@1.0.7...@visulima/health-check@1.0.8) (2023-07-26)
+### Bug Fixes
+* Refactor code for improved readability and error handling ([2b280d8](https://github.com/visulima/visulima/commit/2b280d836593800f13066ee31828a7f20400eb58))
+* Update eslint-config version to 10.0.6 across multiple packages ([391238a](https://github.com/visulima/visulima/commit/391238ab4d00335e4ad47d7b705960d0af9a5412))
+## @visulima/health-check [1.0.7](https://github.com/visulima/visulima/compare/@visulima/health-check@1.0.6...@visulima/health-check@1.0.7) (2023-06-08)
+### Bug Fixes
+* skipped all ping-check tests on ci ([34c2497](https://github.com/visulima/visulima/commit/34c2497dc0d607d051c8ba138ff9763edd56877d))
 ## @visulima/health-check [1.0.6](https://github.com/visulima/visulima/compare/@visulima/health-check@1.0.5...@visulima/health-check@1.0.6) (2023-06-08)

package/dist/index.d.mts ADDED Viewed

@@ -0,0 +1,70 @@
+import { Options, IPFamily } from 'cacheable-lookup';
+import { extendedPingOptions } from 'pingman';
+import { IncomingMessage, ServerResponse } from 'node:http';
+/**
+ * Shape of health report entry. Each checker must
+ * return an object with similar shape.
+ */
+interface HealthReportEntry {
+    displayName: string;
+    health: {
+        healthy: boolean;
+        message?: string;
+        timestamp: string;
+    };
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    meta?: any;
+}
+type Checker = () => Promise<HealthReportEntry>;
+/**
+ * The shape of entire report
+ */
+type HealthReport = Record<string, HealthReportEntry>;
+/**
+ * Shape of health check contract
+ */
+interface HealthCheck {
+    addChecker: (service: string, checker: Checker) => void;
+    getReport: () => Promise<{ healthy: boolean; report: HealthReport }>;
+    isLive: () => Promise<boolean>;
+    servicesList: string[];
+}
+declare const dnsCheck: (host: string, expectedAddresses?: string[], options?: Options & {
+    family?: IPFamily | "all";
+    hints?: number;
+}) => Checker;
+declare const httpCheck: (host: RequestInfo | URL, options?: {
+    expected?: {
+        body?: string;
+        status?: number;
+    };
+    fetchOptions?: RequestInit;
+}) => Checker;
+declare const nodeEnvironmentCheck: (expectedEnvironment?: string) => Checker;
+declare const pingCheck: (host: string, options?: extendedPingOptions) => Checker;
+declare const _default$1: (healthCheck: HealthCheck, sendHeader?: boolean | undefined) => <Request_1 extends IncomingMessage, Response_1 extends ServerResponse<IncomingMessage>>(_: Request_1, response: Response_1) => Promise<void>;
+declare const _default: <Request_1 extends IncomingMessage, Response_1 extends ServerResponse<IncomingMessage>>(healthCheck: HealthCheck) => (_request: Request_1, response: Response_1) => Promise<void>;
+declare class Healthcheck implements HealthCheck {
+    private healthCheckers;
+    private invokeChecker;
+    addChecker(service: string, checker: Checker): void;
+    getReport(): Promise<{
+        healthy: boolean;
+        report: HealthReport;
+    }>;
+    isLive(): Promise<boolean>;
+    get servicesList(): string[];
+}
+export { Checker, Healthcheck as HealthCheck, dnsCheck, _default$1 as healthCheckHandler, _default as healthReadyHandler, httpCheck, nodeEnvironmentCheck as nodeEnvCheck, pingCheck };

package/dist/index.d.ts CHANGED Viewed

@@ -1,54 +1,37 @@
-import { IncomingMessage, ServerResponse } from 'node:http';
 import { Options, IPFamily } from 'cacheable-lookup';
 import { extendedPingOptions } from 'pingman';
-type Checker = () => Promise<HealthReportEntry>;
+import { IncomingMessage, ServerResponse } from 'node:http';
 /**
  * Shape of health report entry. Each checker must
  * return an object with similar shape.
  */
-type HealthReportEntry = {
+interface HealthReportEntry {
     displayName: string;
     health: {
         healthy: boolean;
         message?: string;
         timestamp: string;
     };
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     meta?: any;
-};
+}
+type Checker = () => Promise<HealthReportEntry>;
 /**
  * The shape of entire report
  */
-type HealthReport = {
-    [service: string]: HealthReportEntry;
-};
+type HealthReport = Record<string, HealthReportEntry>;
 /**
  * Shape of health check contract
  */
 interface HealthCheck {
-    servicesList: string[];
     addChecker: (service: string, checker: Checker) => void;
-    isLive: () => Promise<boolean>;
     getReport: () => Promise<{ healthy: boolean; report: HealthReport }>;
-}
-declare const _default$1: (healthCheck: HealthCheck, sendHeader?: boolean | undefined) => <Request_1 extends IncomingMessage, Response_1 extends ServerResponse<IncomingMessage>>(_: Request_1, response: Response_1) => Promise<void>;
-declare const _default: <Request_1 extends IncomingMessage, Response_1 extends ServerResponse<IncomingMessage>>(healthCheck: HealthCheck) => (_request: Request_1, response: Response_1) => Promise<void>;
-declare class Healthcheck implements HealthCheck {
-    private healthCheckers;
-    get servicesList(): string[];
-    private invokeChecker;
-    addChecker(service: string, checker: Checker): void;
-    getReport(): Promise<{
-        healthy: boolean;
-        report: HealthReport;
-    }>;
-    isLive(): Promise<boolean>;
+    isLive: () => Promise<boolean>;
+    servicesList: string[];
 }
 declare const dnsCheck: (host: string, expectedAddresses?: string[], options?: Options & {
@@ -57,15 +40,31 @@ declare const dnsCheck: (host: string, expectedAddresses?: string[], options?: O
 }) => Checker;
 declare const httpCheck: (host: RequestInfo | URL, options?: {
-    fetchOptions?: RequestInit;
     expected?: {
-        status?: number;
         body?: string;
+        status?: number;
     };
+    fetchOptions?: RequestInit;
 }) => Checker;
 declare const nodeEnvironmentCheck: (expectedEnvironment?: string) => Checker;
 declare const pingCheck: (host: string, options?: extendedPingOptions) => Checker;
+declare const _default$1: (healthCheck: HealthCheck, sendHeader?: boolean | undefined) => <Request_1 extends IncomingMessage, Response_1 extends ServerResponse<IncomingMessage>>(_: Request_1, response: Response_1) => Promise<void>;
+declare const _default: <Request_1 extends IncomingMessage, Response_1 extends ServerResponse<IncomingMessage>>(healthCheck: HealthCheck) => (_request: Request_1, response: Response_1) => Promise<void>;
+declare class Healthcheck implements HealthCheck {
+    private healthCheckers;
+    private invokeChecker;
+    addChecker(service: string, checker: Checker): void;
+    getReport(): Promise<{
+        healthy: boolean;
+        report: HealthReport;
+    }>;
+    isLive(): Promise<boolean>;
+    get servicesList(): string[];
+}
 export { Checker, Healthcheck as HealthCheck, dnsCheck, _default$1 as healthCheckHandler, _default as healthReadyHandler, httpCheck, nodeEnvironmentCheck as nodeEnvCheck, pingCheck };

package/dist/index.js CHANGED Viewed

@@ -1,23 +1,23 @@
 'use strict';
-var httpStatusCodes = require('http-status-codes');
-var k = require('cacheable-lookup');
+var f = require('cacheable-lookup');
 var assert = require('assert');
-var R = require('pingman');
+var O = require('pingman');
+var httpStatusCodes = require('http-status-codes');
 function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
-var k__default = /*#__PURE__*/_interopDefault(k);
-var R__default = /*#__PURE__*/_interopDefault(R);
+var f__default = /*#__PURE__*/_interopDefault(f);
+var O__default = /*#__PURE__*/_interopDefault(O);
-var f=(t,e=!0)=>async(a,r)=>{let{healthy:s,report:o}=await t.getReport(),l={status:s?"ok":"error",message:s?"Health check successful":"Health check failed",appName:process.env.APP_NAME??"unknown",appVersion:process.env.APP_VERSION??"unknown",timestamp:new Date().toISOString(),reports:o};r.statusCode=s?httpStatusCodes.StatusCodes.OK:httpStatusCodes.StatusCodes.SERVICE_UNAVAILABLE,e&&r.setHeader("Content-Type","application/json"),r.end(JSON.stringify(l,null,2));};var u=t=>async(e,a)=>{let{healthy:r}=await t.getReport();a.statusCode=r?httpStatusCodes.StatusCodes.NO_CONTENT:httpStatusCodes.StatusCodes.SERVICE_UNAVAILABLE,a.end();};var c=class{constructor(){this.healthCheckers={};}get servicesList(){return Object.keys(this.healthCheckers)}async invokeChecker(e,a){let r=this.healthCheckers[e],s;try{s=await r(),s.displayName=s.displayName||e;}catch(o){s={displayName:e,health:{healthy:!1,message:o.message,timestamp:new Date().toISOString()},meta:{fatal:!0}};}return a[e]=s,s.health.healthy}addChecker(e,a){this.healthCheckers[e]=a;}async getReport(){let e={};return await Promise.all(Object.keys(this.healthCheckers).map(r=>this.invokeChecker(r,e))),{healthy:!Object.keys(e).find(r=>!e[r].health.healthy),report:e}}async isLive(){let{healthy:e}=await this.getReport();return e}},g=c;var i="DNS check for",C=(t,e,a)=>async()=>{let{hints:r,family:s="all",...o}=a??{},l=new k__default.default(o);try{let n=await l.lookupAsync(t.replace(/^https?:\/\//,""),{hints:r,...s==="all"?{all:!0}:{family:s}});return Array.isArray(e)&&!e.includes(n.address)?{displayName:`${i} ${t}`,health:{healthy:!1,message:`${i} ${t} returned address ${n.address} instead of ${e.join(", ")}.`,timestamp:new Date().toISOString()},meta:{host:t,addresses:n}}:{displayName:`${i} ${t}`,health:{healthy:!0,message:`${i} ${t} were resolved.`,timestamp:new Date().toISOString()},meta:{host:t,addresses:n}}}catch(n){return {displayName:`${i} ${t}`,health:{healthy:!1,message:n.message,timestamp:new Date().toISOString()},meta:{host:t}}}},S=C;var h="HTTP check for",$=(t,e)=>async()=>{try{let a=await fetch(t,e?.fetchOptions??{});if(e?.expected?.status!==void 0&&e.expected.status!==a.status)throw new Error(`${h} ${t} returned status ${a.status} instead of ${e.expected.status}`);if(e?.expected?.body!==void 0){let r=await a.text();try{assert.deepStrictEqual(r,e.expected.body);}catch{throw new Error(`${h} ${t} returned body ${JSON.stringify(r)} instead of ${JSON.stringify(e.expected.body)}`)}}return {displayName:`${h} ${t}`,health:{healthy:!0,message:`${h} ${t} was successful.`,timestamp:new Date().toISOString()},meta:{host:t,method:e?.fetchOptions?.method??"GET",status:a.status}}}catch(a){return {displayName:`${h} ${t}`,health:{healthy:!1,message:a.message,timestamp:new Date().toISOString()},meta:{host:t,method:e?.fetchOptions?.method??"GET"}}}},O=$;var y="Node Environment Check",E=t=>async()=>{let e="production",a;return t!==void 0&&e!==t?a=`NODE_ENV environment variable is set to "${e}" instead of "${t}".`:e,a!==void 0?{displayName:y,health:{healthy:!1,message:a,timestamp:new Date().toISOString()}}:{displayName:y,health:{healthy:!0,timestamp:new Date().toISOString()},meta:{env:e}}},I=E;var p="Ping check for",w=(t,e)=>async()=>{try{let a=await R__default.default(t.replace(/^https?:\/\//,""),e);return a.alive?{displayName:`${p} ${t}`,health:{healthy:!0,message:`${p} ${t} was successful.`,timestamp:new Date().toISOString()},meta:a}:{displayName:`${p} ${t}`,health:{healthy:!1,message:`Ping failed for ${t}.`,timestamp:new Date().toISOString()},meta:a}}catch(a){return {displayName:`${p} ${t}`,health:{healthy:!1,message:a.message,timestamp:new Date().toISOString()}}}},x=w;
+var i="DNS check for",u=(t,e,a)=>async()=>{let{family:r="all",hints:s,...o}=a??{},l=new f__default.default(o);try{let n=await l.lookupAsync(t.replace(/^https?:\/\//,""),{hints:s,...r==="all"?{all:!0}:{family:r}});return Array.isArray(e)&&!e.includes(n.address)?{displayName:`${i} ${t}`,health:{healthy:!1,message:`${i} ${t} returned address ${n.address} instead of ${e.join(", ")}.`,timestamp:new Date().toISOString()},meta:{addresses:n,host:t}}:{displayName:`${i} ${t}`,health:{healthy:!0,message:`${i} ${t} were resolved.`,timestamp:new Date().toISOString()},meta:{addresses:n,host:t}}}catch(n){return {displayName:`${i} ${t}`,health:{healthy:!1,message:n.message,timestamp:new Date().toISOString()},meta:{host:t}}}},g=u;var h="HTTP check for",C=(t,e)=>async()=>{try{let a=await fetch(t,e?.fetchOptions??{});if(e?.expected?.status!==void 0&&e.expected.status!==a.status)throw new Error(`${h} ${t} returned status ${a.status} instead of ${e.expected.status}`);if(e?.expected?.body!==void 0){let r=await a.text();try{assert.deepStrictEqual(r,e.expected.body);}catch{throw new Error(`${h} ${t} returned body ${JSON.stringify(r)} instead of ${JSON.stringify(e.expected.body)}`)}}return {displayName:`${h} ${t}`,health:{healthy:!0,message:`${h} ${t} was successful.`,timestamp:new Date().toISOString()},meta:{host:t,method:e?.fetchOptions?.method??"GET",status:a.status}}}catch(a){return {displayName:`${h} ${t}`,health:{healthy:!1,message:a.message,timestamp:new Date().toISOString()},meta:{host:t,method:e?.fetchOptions?.method??"GET"}}}},S=C;var m="Node Environment Check",N=t=>async()=>{let e="production",a;return t!==void 0&&e!==t?a=`NODE_ENV environment variable is set to "${e}" instead of "${t}".`:e,a!==void 0?{displayName:m,health:{healthy:!1,message:a,timestamp:new Date().toISOString()}}:{displayName:m,health:{healthy:!0,timestamp:new Date().toISOString()},meta:{env:e}}},$=N;var p="Ping check for",R=(t,e)=>async()=>{try{let a=await O__default.default(t.replace(/^https?:\/\//,""),e);return a.alive?{displayName:`${p} ${t}`,health:{healthy:!0,message:`${p} ${t} was successful.`,timestamp:new Date().toISOString()},meta:a}:{displayName:`${p} ${t}`,health:{healthy:!1,message:`Ping failed for ${t}.`,timestamp:new Date().toISOString()},meta:a}}catch(a){return {displayName:`${p} ${t}`,health:{healthy:!1,message:a.message,timestamp:new Date().toISOString()}}}},w=R;var E=(t,e=!0)=>async(a,r)=>{let{healthy:s,report:o}=await t.getReport(),l={appName:process.env.APP_NAME??"unknown",appVersion:process.env.APP_VERSION??"unknown",message:s?"Health check successful":"Health check failed",reports:o,status:s?"ok":"error",timestamp:new Date().toISOString()};r.statusCode=s?httpStatusCodes.StatusCodes.OK:httpStatusCodes.StatusCodes.SERVICE_UNAVAILABLE,e&&r.setHeader("Content-Type","application/json"),r.end(JSON.stringify(l,null,2));};var I=t=>async(e,a)=>{let{healthy:r}=await t.getReport();a.statusCode=r?httpStatusCodes.StatusCodes.NO_CONTENT:httpStatusCodes.StatusCodes.SERVICE_UNAVAILABLE,a.end();};var c=class{constructor(){this.healthCheckers={};}async invokeChecker(e,a){let r=this.healthCheckers[e],s;try{s=await r(),s.displayName=s.displayName||e;}catch(o){s={displayName:e,health:{healthy:!1,message:o.message,timestamp:new Date().toISOString()},meta:{fatal:!0}};}return a[e]=s,s.health.healthy}addChecker(e,a){this.healthCheckers[e]=a;}async getReport(){let e={};return await Promise.all(Object.keys(this.healthCheckers).map(async r=>await this.invokeChecker(r,e))),{healthy:!Object.keys(e).find(r=>!e[r].health.healthy),report:e}}async isLive(){let{healthy:e}=await this.getReport();return e}get servicesList(){return Object.keys(this.healthCheckers)}},x=c;
-exports.HealthCheck = g;
-exports.dnsCheck = S;
-exports.healthCheckHandler = f;
-exports.healthReadyHandler = u;
-exports.httpCheck = O;
-exports.nodeEnvCheck = I;
-exports.pingCheck = x;
+exports.HealthCheck = x;
+exports.dnsCheck = g;
+exports.healthCheckHandler = E;
+exports.healthReadyHandler = I;
+exports.httpCheck = S;
+exports.nodeEnvCheck = $;
+exports.pingCheck = w;
 //# sourceMappingURL=out.js.map
 //# sourceMappingURL=index.js.map

package/dist/index.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"sources":["../src/handler/healthcheck.ts","../src/handler/readyhandler.ts","../src/healthcheck.ts","../src/checks/dns-check.ts","../src/checks/http-check.ts","../src/checks/node-environment-check.ts","../src/checks/ping-check.ts"],"names":["StatusCodes","healthcheck_default","healthCheck","sendHeader","_","response","healthy","report","payload","readyhandler_default","_request","Healthcheck","service","reportSheet","checker","error","CacheableLookup","DISPLAY_NAME","dnsCheck","host","expectedAddresses","options","hints","family","config","cacheable","meta","dns_check_default","deepStrictEqual","httpCheck","textBody","http_check_default","nodeEnvironmentCheck","expectedEnvironment","environment","errorMessage","node_environment_check_default","ping","pingCheck","ping_check_default"],"mappings":"AAAA,OAAS,eAAAA,MAAmB,oBAM5B,IAAOC,EAAQ,CAACC,EAA0BC,EAAkC,KAAS,MAAyEC,EAAYC,IAAsC,CAC5M,GAAM,CAAE,QAAAC,EAAS,OAAAC,CAAO,EAAI,MAAML,EAAY,UAAU,EAElDM,EAAiC,CACnC,OAAQF,EAAU,KAAO,QACzB,QAASA,EAAU,0BAA4B,sBAC/C,QAAS,QAAQ,IAAI,UAAe,UACpC,WAAY,QAAQ,IAAI,aAAkB,UAC1C,UAAW,IAAI,KAAK,EAAE,YAAY,EAClC,QAASC,CACb,EAEAF,EAAS,WAAaC,EAAUN,EAAY,GAAKA,EAAY,oBAEzDG,GACAE,EAAS,UAAU,eAAgB,kBAAkB,EAGzDA,EAAS,IAAI,KAAK,UAAUG,EAAS,KAAM,CAAC,CAAC,CACjD,ECzBA,OAAS,eAAAR,MAAmB,oBAM5B,IAAOS,EAA2EP,GAA6B,MAAOQ,EAAmBL,IAAsC,CAC3K,GAAM,CAAE,QAAAC,CAAQ,EAAI,MAAMJ,EAAY,UAAU,EAEhDG,EAAS,WAAaC,EAAUN,EAAY,WAAaA,EAAY,oBACrEK,EAAS,IAAI,CACjB,ECPA,IAAMM,EAAN,KAAkD,CAAlD,cAII,KAAQ,eAAiD,CAAC,EAK1D,IAAW,cAAyB,CAChC,OAAO,OAAO,KAAK,KAAK,cAAc,CAC1C,CAKA,MAAc,cAAcC,EAAiBC,EAA6C,CACtF,IAAMC,EAAU,KAAK,eAAeF,CAAO,EAEvCL,EAEJ,GAAI,CACAA,EAAS,MAAMO,EAAQ,EAEvBP,EAAO,YAAcA,EAAO,aAAeK,CAC/C,OAASG,EAAP,CACER,EAAS,CACL,YAAaK,EACb,OAAQ,CAAE,QAAS,GAAO,QAAUG,EAAgB,QAAS,UAAW,IAAI,KAAK,EAAE,YAAY,CAAE,EACjG,KAAM,CAAE,MAAO,EAAK,CACxB,CACJ,CAGA,OAAAF,EAAYD,CAAO,EAAIL,EAEhBA,EAAO,OAAO,OACzB,CAEO,WAAWK,EAAiBE,EAAwB,CACvD,KAAK,eAAeF,CAAO,EAAIE,CACnC,CAMA,MAAa,WAAiE,CAC1E,IAAMP,EAAuB,CAAC,EAG9B,aAAM,QAAQ,IAAI,OAAO,KAAK,KAAK,cAAc,EAAE,IAAKK,GAAY,KAAK,cAAcA,EAASL,CAAM,CAAC,CAAC,EAOjG,CAAE,QAAS,CAFO,OAAO,KAAKA,CAAM,EAAE,KAAMK,GAAY,CAAEL,EAAOK,CAAO,EAAwB,OAAO,OAAO,EAEhF,OAAAL,CAAO,CAChD,CAEA,MAAa,QAA2B,CACpC,GAAM,CAAE,QAAAD,CAAQ,EAAI,MAAM,KAAK,UAAU,EAEzC,OAAOA,CACX,CACJ,EAEOL,EAAQU,ECvEf,OAAOK,MAAqB,mBAI5B,IAAMC,EAAe,gBAKfC,EAAW,CACbC,EACAC,EACAC,IAIU,SAAY,CACtB,GAAM,CAAE,MAAAC,EAAO,OAAAC,EAAS,MAAO,GAAGC,CAAO,EAAIH,GAAW,CAAC,EAEnDI,EAAY,IAAIT,EAAgBQ,CAAM,EAE5C,GAAI,CACA,IAAME,EAAO,MAAMD,EAAU,YAAYN,EAAK,QAAQ,eAAgB,EAAE,EAAG,CACvE,MAAAG,EACA,GAAIC,IAAW,MAAQ,CAAE,IAAK,EAAK,EAAI,CAAE,OAAAA,CAAO,CACpD,CAAC,EAED,OAAI,MAAM,QAAQH,CAAiB,GAAK,CAACA,EAAkB,SAASM,EAAK,OAAO,EACrE,CACH,YAAa,GAAGT,KAAgBE,IAChC,OAAQ,CACJ,QAAS,GACT,QAAS,GAAGF,KAAgBE,sBAAyBO,EAAK,sBAAsBN,EAAkB,KAAK,IAAI,KAC3G,UAAW,IAAI,KAAK,EAAE,YAAY,CACtC,EACA,KAAM,CACF,KAAAD,EACA,UAAWO,CACf,CACJ,EAGG,CACH,YAAa,GAAGT,KAAgBE,IAChC,OAAQ,CACJ,QAAS,GACT,QAAS,GAAGF,KAAgBE,mBAC5B,UAAW,IAAI,KAAK,EAAE,YAAY,CACtC,EACA,KAAM,CACF,KAAAA,EACA,UAAWO,CACf,CACJ,CACJ,OAASX,EAAP,CACE,MAAO,CACH,YAAa,GAAGE,KAAgBE,IAChC,OAAQ,CACJ,QAAS,GACT,QAAUJ,EAAgB,QAC1B,UAAW,IAAI,KAAK,EAAE,YAAY,CACtC,EACA,KAAM,CACF,KAAAI,CACJ,CACJ,CACJ,CACJ,EAEOQ,EAAQT,ECtEf,OAAS,mBAAAU,MAAuB,SAIhC,IAAMX,EAAe,iBAKfY,EAAY,CACdV,EACAE,IAIU,SAAY,CACtB,GAAI,CAEA,IAAMhB,EAAW,MAAM,MAAMc,EAAME,GAAS,cAAgB,CAAC,CAAC,EAE9D,GAAIA,GAAS,UAAU,SAAW,QAAaA,EAAQ,SAAS,SAAWhB,EAAS,OAChF,MAAM,IAAI,MAAM,GAAGY,KAAgBE,qBAAwBd,EAAS,qBAAqBgB,EAAQ,SAAS,QAAQ,EAGtH,GAAIA,GAAS,UAAU,OAAS,OAAW,CACvC,IAAMS,EAAW,MAAMzB,EAAS,KAAK,EAErC,GAAI,CACAuB,EAAgBE,EAAUT,EAAQ,SAAS,IAAI,CACnD,MAAE,CACE,MAAM,IAAI,MAAM,GAAGJ,KAAgBE,mBAAsB,KAAK,UAAUW,CAAQ,gBAAgB,KAAK,UAAUT,EAAQ,SAAS,IAAI,GAAG,CAC3I,EAGJ,MAAO,CACH,YAAa,GAAGJ,KAAgBE,IAChC,OAAQ,CACJ,QAAS,GACT,QAAS,GAAGF,KAAgBE,oBAC5B,UAAW,IAAI,KAAK,EAAE,YAAY,CACtC,EACA,KAAM,CACF,KAAAA,EACA,OAAQE,GAAS,cAAc,QAAU,MACzC,OAAQhB,EAAS,MACrB,CACJ,CACJ,OAASU,EAAP,CACE,MAAO,CACH,YAAa,GAAGE,KAAgBE,IAChC,OAAQ,CACJ,QAAS,GACT,QAAUJ,EAAgB,QAC1B,UAAW,IAAI,KAAK,EAAE,YAAY,CACtC,EACA,KAAM,CACF,KAAAI,EACA,OAAQE,GAAS,cAAc,QAAU,KAC7C,CACJ,CACJ,CACJ,EAEOU,EAAQF,EC7Df,IAAMZ,EAAe,yBAMfe,EAAwBC,GAA0C,SAAY,CAEhF,IAAMC,EAAkC,aAEpCC,EASJ,OANID,IAAgB,QAAaD,IAAwB,QAAaC,IAAgBD,EAClFE,EAAe,4CAA4CD,kBAA4BD,MAC/EC,IACRC,EAAe,CAAC,yCAA0C,qDAAqD,EAAE,KAAK,GAAG,GAGzHA,IAAiB,OACV,CACH,YAAalB,EACb,OAAQ,CACJ,QAAS,GACT,QAASkB,EACT,UAAW,IAAI,KAAK,EAAE,YAAY,CACtC,CACJ,EAGG,CACH,YAAalB,EACb,OAAQ,CACJ,QAAS,GACT,UAAW,IAAI,KAAK,EAAE,YAAY,CACtC,EACA,KAAM,CACF,IAAKiB,CACT,CACJ,CACJ,EAEOE,EAAQJ,EC3Cf,OAAOK,MAAU,UAIjB,IAAMpB,EAAe,iBAKfqB,EAAY,CAACnB,EAAcE,IAA2C,SAAY,CACpF,GAAI,CACA,IAAMhB,EAAW,MAAMgC,EAAKlB,EAAK,QAAQ,eAAgB,EAAE,EAAGE,CAAO,EAErE,OAAKhB,EAAS,MAYP,CACH,YAAa,GAAGY,KAAgBE,IAChC,OAAQ,CACJ,QAAS,GACT,QAAS,GAAGF,KAAgBE,oBAC5B,UAAW,IAAI,KAAK,EAAE,YAAY,CACtC,EACA,KAAMd,CACV,EAnBW,CACH,YAAa,GAAGY,KAAgBE,IAChC,OAAQ,CACJ,QAAS,GACT,QAAS,mBAAmBA,KAC5B,UAAW,IAAI,KAAK,EAAE,YAAY,CACtC,EACA,KAAMd,CACV,CAYR,OAASU,EAAP,CACE,MAAO,CACH,YAAa,GAAGE,KAAgBE,IAChC,OAAQ,CACJ,QAAS,GACT,QAAUJ,EAAgB,QAC1B,UAAW,IAAI,KAAK,EAAE,YAAY,CACtC,CACJ,CACJ,CACJ,EAEOwB,EAAQD","sourcesContent":["import { StatusCodes } from \"http-status-codes\";\nimport type { IncomingMessage, ServerResponse } from \"node:http\";\n\nimport type { HealthCheck, HealthReport } from \"../types\";\n\n// eslint-disable-next-line max-len\nexport default (healthCheck: HealthCheck, sendHeader: boolean \| undefined = true) => async <Request extends IncomingMessage, Response extends ServerResponse>(_: Request, response: Response): Promise<void> => {\n const { healthy, report } = await healthCheck.getReport();\n\n const payload: HealthCheckApiPayload = {\n status: healthy ? \"ok\" : \"error\",\n message: healthy ? \"Health check successful\" : \"Health check failed\",\n appName: process.env[\"APP_NAME\"] ?? \"unknown\",\n appVersion: process.env[\"APP_VERSION\"] ?? \"unknown\",\n timestamp: new Date().toISOString(),\n reports: report,\n };\n\n response.statusCode = healthy ? StatusCodes.OK : StatusCodes.SERVICE_UNAVAILABLE;\n\n if (sendHeader) {\n response.setHeader(\"Content-Type\", \"application/json\");\n }\n\n response.end(JSON.stringify(payload, null, 2));\n};\n\nexport type HealthCheckApiPayload = {\n status: \"error\" \| \"ok\";\n message: string;\n appName: string;\n appVersion: string;\n timestamp: string;\n reports: HealthReport;\n};\n","import { StatusCodes } from \"http-status-codes\";\nimport type { IncomingMessage, ServerResponse } from \"node:http\";\n\nimport type { HealthCheck } from \"../types\";\n\n// eslint-disable-next-line max-len\nexport default <Request extends IncomingMessage, Response extends ServerResponse>(healthCheck: HealthCheck) => async (_request: Request, response: Response): Promise<void> => {\n const { healthy } = await healthCheck.getReport();\n\n response.statusCode = healthy ? StatusCodes.NO_CONTENT : StatusCodes.SERVICE_UNAVAILABLE;\n response.end();\n};\n","import type {\n Checker, HealthCheck as HealthcheckInterface, HealthReport, HealthReportEntry,\n} from \"./types.d\";\n\nclass Healthcheck implements HealthcheckInterface {\n /*\n A copy of registered checkers\n /\n private healthCheckers: { [service: string]: Checker } = {};\n\n /\n Returns an array of registered services names\n /\n public get servicesList(): string[] {\n return Object.keys(this.healthCheckers);\n }\n\n /\n Invokes a given checker to collect the report metrics.\n /\n private async invokeChecker(service: string, reportSheet: HealthReport): Promise<boolean> {\n const checker = this.healthCheckers[service] as Checker;\n\n let report: HealthReportEntry;\n\n try {\n report = await checker();\n\n report.displayName = report.displayName \|\| service;\n } catch (error: any) {\n report = {\n displayName: service,\n health: { healthy: false, message: (error as Error).message, timestamp: new Date().toISOString() },\n meta: { fatal: true },\n };\n }\n\n // eslint-disable-next-line no-param-reassign\n reportSheet[service] = report;\n\n return report.health.healthy;\n }\n\n public addChecker(service: string, checker: Checker): void {\n this.healthCheckers[service] = checker;\n }\n\n /\n Returns the health check reports. The health checks are performed when\n * this method is invoked.\n /\n public async getReport(): Promise<{ healthy: boolean; report: HealthReport }> {\n const report: HealthReport = {};\n\n // eslint-disable-next-line compat/compat\n await Promise.all(Object.keys(this.healthCheckers).map((service) => this.invokeChecker(service, report)));\n\n /\n Finding unhealthy service to know if system is healthy or not\n /\n const unhealthyService = Object.keys(report).find((service) => !(report[service] as HealthReportEntry).health.healthy);\n\n return { healthy: !unhealthyService, report };\n }\n\n public async isLive(): Promise<boolean> {\n const { healthy } = await this.getReport();\n\n return healthy;\n }\n}\n\nexport default Healthcheck;\n","import type { IPFamily, Options } from \"cacheable-lookup\";\nimport CacheableLookup from \"cacheable-lookup\";\n\nimport type { Checker } from \"../types\";\n\nconst DISPLAY_NAME = \"DNS check for\";\n\n/\n Register the `dns` checker to ensure that a domain is reachable.\n /\nconst dnsCheck = (\n host: string,\n expectedAddresses?: string[],\n options?: Options & {\n family?: IPFamily \| \"all\";\n hints?: number;\n },\n): Checker => async () => {\n const { hints, family = \"all\", ...config } = options ?? {};\n\n const cacheable = new CacheableLookup(config);\n\n try {\n const meta = await cacheable.lookupAsync(host.replace(/^https?:\\/\\//, \"\"), {\n hints,\n ...(family === \"all\" ? { all: true } : { family }),\n });\n\n if (Array.isArray(expectedAddresses) && !expectedAddresses.includes(meta.address)) {\n return {\n displayName: `${DISPLAY_NAME} ${host}`,\n health: {\n healthy: false,\n message: `${DISPLAY_NAME} ${host} returned address ${meta.address} instead of ${expectedAddresses.join(\", \")}.`,\n timestamp: new Date().toISOString(),\n },\n meta: {\n host,\n addresses: meta,\n },\n };\n }\n\n return {\n displayName: `${DISPLAY_NAME} ${host}`,\n health: {\n healthy: true,\n message: `${DISPLAY_NAME} ${host} were resolved.`,\n timestamp: new Date().toISOString(),\n },\n meta: {\n host,\n addresses: meta,\n },\n };\n } catch (error: any) {\n return {\n displayName: `${DISPLAY_NAME} ${host}`,\n health: {\n healthy: false,\n message: (error as Error).message,\n timestamp: new Date().toISOString(),\n },\n meta: {\n host,\n },\n };\n }\n};\n\nexport default dnsCheck;\n","import { deepStrictEqual } from \"node:assert\";\n\nimport type { Checker } from \"../types\";\n\nconst DISPLAY_NAME = \"HTTP check for\";\n\n/\n Register the `http` checker to ensure http body and status is correct.\n /\nconst httpCheck = (\n host: RequestInfo \| URL,\n options?: {\n fetchOptions?: RequestInit;\n expected?: { status?: number; body?: string };\n },\n): Checker => async () => {\n try {\n // eslint-disable-next-line compat/compat\n const response = await fetch(host, options?.fetchOptions ?? {});\n\n if (options?.expected?.status !== undefined && options.expected.status !== response.status) {\n throw new Error(`${DISPLAY_NAME} ${host} returned status ${response.status} instead of ${options.expected.status}`);\n }\n\n if (options?.expected?.body !== undefined) {\n const textBody = await response.text();\n\n try {\n deepStrictEqual(textBody, options.expected.body);\n } catch {\n throw new Error(`${DISPLAY_NAME} ${host} returned body ${JSON.stringify(textBody)} instead of ${JSON.stringify(options.expected.body)}`);\n }\n }\n\n return {\n displayName: `${DISPLAY_NAME} ${host}`,\n health: {\n healthy: true,\n message: `${DISPLAY_NAME} ${host} was successful.`,\n timestamp: new Date().toISOString(),\n },\n meta: {\n host,\n method: options?.fetchOptions?.method ?? \"GET\",\n status: response.status,\n },\n };\n } catch (error: any) {\n return {\n displayName: `${DISPLAY_NAME} ${host}`,\n health: {\n healthy: false,\n message: (error as Error).message,\n timestamp: new Date().toISOString(),\n },\n meta: {\n host,\n method: options?.fetchOptions?.method ?? \"GET\",\n },\n };\n }\n};\n\nexport default httpCheck;\n","import type { Checker } from \"../types\";\n\nconst DISPLAY_NAME = \"Node Environment Check\";\n\n/\n Register the `env` checker to ensure that `NODE_ENV` environment\n * variable is defined.\n /\nconst nodeEnvironmentCheck = (expectedEnvironment?: string): Checker => async () => {\n // eslint-disable-next-line @typescript-eslint/dot-notation\n const environment: string \| undefined = process.env[\"NODE_ENV\"];\n\n let errorMessage: string \| undefined;\n\n // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition\n if (environment !== undefined && expectedEnvironment !== undefined && environment !== expectedEnvironment) {\n errorMessage = `NODE_ENV environment variable is set to \"${environment}\" instead of \"${expectedEnvironment}\".`;\n } else if (!environment) {\n errorMessage = [\"Missing NODE_ENV environment variable.\", \"It can make some parts of the application misbehave\"].join(\" \");\n }\n\n if (errorMessage !== undefined) {\n return {\n displayName: DISPLAY_NAME,\n health: {\n healthy: false,\n message: errorMessage,\n timestamp: new Date().toISOString(),\n },\n };\n }\n\n return {\n displayName: DISPLAY_NAME,\n health: {\n healthy: true,\n timestamp: new Date().toISOString(),\n },\n meta: {\n env: environment,\n },\n };\n};\n\nexport default nodeEnvironmentCheck;\n","import type { extendedPingOptions } from \"pingman\";\nimport ping from \"pingman\";\n\nimport type { Checker } from \"../types\";\n\nconst DISPLAY_NAME = \"Ping check for\";\n\n/\n Register the `ping` checker to ensure that a domain is reachable.\n */\nconst pingCheck = (host: string, options?: extendedPingOptions): Checker => async () => {\n try {\n const response = await ping(host.replace(/^https?:\\/\\//, \"\"), options);\n\n if (!response.alive) {\n return {\n displayName: `${DISPLAY_NAME} ${host}`,\n health: {\n healthy: false,\n message: `Ping failed for ${host}.`,\n timestamp: new Date().toISOString(),\n },\n meta: response,\n };\n }\n\n return {\n displayName: `${DISPLAY_NAME} ${host}`,\n health: {\n healthy: true,\n message: `${DISPLAY_NAME} ${host} was successful.`,\n timestamp: new Date().toISOString(),\n },\n meta: response,\n };\n } catch (error: any) {\n return {\n displayName: `${DISPLAY_NAME} ${host}`,\n health: {\n healthy: false,\n message: (error as Error).message,\n timestamp: new Date().toISOString(),\n },\n };\n }\n};\n\nexport default pingCheck;\n"]}
1	+ {"version":3,"sources":["../src/checks/dns-check.ts","../src/checks/http-check.ts","../src/checks/node-environment-check.ts","../src/checks/ping-check.ts","../src/handler/healthcheck.ts","../src/handler/readyhandler.ts","../src/healthcheck.ts"],"names":["CacheableLookup","DISPLAY_NAME","dnsCheck","host","expectedAddresses","options","family","hints","config","cacheable","meta","error","dns_check_default","deepStrictEqual","httpCheck","response","textBody","http_check_default","nodeEnvironmentCheck","expectedEnvironment","environment","errorMessage","node_environment_check_default","ping","pingCheck","ping_check_default","StatusCodes","healthcheck_default","healthCheck","sendHeader","_","healthy","report","payload","readyhandler_default","_request","Healthcheck","service","reportSheet","checker"],"mappings":"AACA,OAAOA,MAAqB,mBAI5B,IAAMC,EAAe,gBAKfC,EACF,CACIC,EACAC,EACAC,IAKJ,SAAY,CACR,GAAM,CAAE,OAAAC,EAAS,MAAO,MAAAC,EAAO,GAAGC,CAAO,EAAIH,GAAW,CAAC,EAEnDI,EAAY,IAAIT,EAAgBQ,CAAM,EAE5C,GAAI,CACA,IAAME,EAAO,MAAMD,EAAU,YAAYN,EAAK,QAAQ,eAAgB,EAAE,EAAG,CACvE,MAAAI,EACA,GAAID,IAAW,MAAQ,CAAE,IAAK,EAAK,EAAI,CAAE,OAAAA,CAAO,CACpD,CAAC,EAED,OAAI,MAAM,QAAQF,CAAiB,GAAK,CAACA,EAAkB,SAASM,EAAK,OAAO,EACrE,CACH,YAAa,GAAGT,CAAY,IAAIE,CAAI,GACpC,OAAQ,CACJ,QAAS,GACT,QAAS,GAAGF,CAAY,IAAIE,CAAI,qBAAqBO,EAAK,OAAO,eAAeN,EAAkB,KAAK,IAAI,CAAC,IAC5G,UAAW,IAAI,KAAK,EAAE,YAAY,CACtC,EACA,KAAM,CACF,UAAWM,EACX,KAAAP,CACJ,CACJ,EAGG,CACH,YAAa,GAAGF,CAAY,IAAIE,CAAI,GACpC,OAAQ,CACJ,QAAS,GACT,QAAS,GAAGF,CAAY,IAAIE,CAAI,kBAChC,UAAW,IAAI,KAAK,EAAE,YAAY,CACtC,EACA,KAAM,CACF,UAAWO,EACX,KAAAP,CACJ,CACJ,CACJ,OAASQ,EAAO,CACZ,MAAO,CACH,YAAa,GAAGV,CAAY,IAAIE,CAAI,GACpC,OAAQ,CACJ,QAAS,GACT,QAAUQ,EAAgB,QAC1B,UAAW,IAAI,KAAK,EAAE,YAAY,CACtC,EACA,KAAM,CACF,KAAAR,CACJ,CACJ,CACJ,CACJ,EAEGS,EAAQV,ECxEf,OAAS,mBAAAW,MAAuB,SAIhC,IAAMZ,EAAe,iBAKfa,EACF,CACIX,EACAE,IAKJ,SAAY,CACR,GAAI,CAEA,IAAMU,EAAW,MAAM,MAAMZ,EAAME,GAAS,cAAgB,CAAC,CAAC,EAE9D,GAAIA,GAAS,UAAU,SAAW,QAAaA,EAAQ,SAAS,SAAWU,EAAS,OAChF,MAAM,IAAI,MAAM,GAAGd,CAAY,IAAIE,CAAc,oBAAoBY,EAAS,MAAM,eAAeV,EAAQ,SAAS,MAAM,EAAE,EAGhI,GAAIA,GAAS,UAAU,OAAS,OAAW,CACvC,IAAMW,EAAW,MAAMD,EAAS,KAAK,EAErC,GAAI,CACAF,EAAgBG,EAAUX,EAAQ,SAAS,IAAI,CACnD,MAAQ,CACJ,MAAM,IAAI,MACN,GAAGJ,CAAY,IAAIE,CAAc,kBAAkB,KAAK,UAAUa,CAAQ,CAAC,eAAe,KAAK,UAAUX,EAAQ,SAAS,IAAI,CAAC,EACnI,CACJ,CACJ,CAEA,MAAO,CACH,YAAa,GAAGJ,CAAY,IAAIE,CAAc,GAC9C,OAAQ,CACJ,QAAS,GACT,QAAS,GAAGF,CAAY,IAAIE,CAAc,mBAC1C,UAAW,IAAI,KAAK,EAAE,YAAY,CACtC,EACA,KAAM,CACF,KAAAA,EACA,OAAQE,GAAS,cAAc,QAAU,MACzC,OAAQU,EAAS,MACrB,CACJ,CACJ,OAASJ,EAAO,CACZ,MAAO,CACH,YAAa,GAAGV,CAAY,IAAIE,CAAc,GAC9C,OAAQ,CACJ,QAAS,GACT,QAAUQ,EAAgB,QAC1B,UAAW,IAAI,KAAK,EAAE,YAAY,CACtC,EACA,KAAM,CACF,KAAAR,EACA,OAAQE,GAAS,cAAc,QAAU,KAC7C,CACJ,CACJ,CACJ,EAEGY,EAAQH,ECjEf,IAAMb,EAAe,yBAMfiB,EACDC,GACD,SAAY,CACR,IAAMC,EAAkC,aAEpCC,EAQJ,OANID,IAAgB,QAAaD,IAAwB,QAAaC,IAAgBD,EAClFE,EAAe,4CAA4CD,CAAW,iBAAiBD,CAAmB,KAClGC,IACRC,EAAe,CAAC,yCAA0C,qDAAqD,EAAE,KAAK,GAAG,GAGzHA,IAAiB,OACV,CACH,YAAapB,EACb,OAAQ,CACJ,QAAS,GACT,QAASoB,EACT,UAAW,IAAI,KAAK,EAAE,YAAY,CACtC,CACJ,EAGG,CACH,YAAapB,EACb,OAAQ,CACJ,QAAS,GACT,UAAW,IAAI,KAAK,EAAE,YAAY,CACtC,EACA,KAAM,CACF,IAAKmB,CACT,CACJ,CACJ,EAEGE,EAAQJ,EC3Cf,OAAOK,MAAU,UAIjB,IAAMtB,EAAe,iBAKfuB,EACF,CAACrB,EAAcE,IACf,SAAY,CACR,GAAI,CACA,IAAMU,EAAW,MAAMQ,EAAKpB,EAAK,QAAQ,eAAgB,EAAE,EAAGE,CAAO,EAErE,OAAKU,EAAS,MAYP,CACH,YAAa,GAAGd,CAAY,IAAIE,CAAI,GACpC,OAAQ,CACJ,QAAS,GACT,QAAS,GAAGF,CAAY,IAAIE,CAAI,mBAChC,UAAW,IAAI,KAAK,EAAE,YAAY,CACtC,EACA,KAAMY,CACV,EAnBW,CACH,YAAa,GAAGd,CAAY,IAAIE,CAAI,GACpC,OAAQ,CACJ,QAAS,GACT,QAAS,mBAAmBA,CAAI,IAChC,UAAW,IAAI,KAAK,EAAE,YAAY,CACtC,EACA,KAAMY,CACV,CAYR,OAASJ,EAAO,CACZ,MAAO,CACH,YAAa,GAAGV,CAAY,IAAIE,CAAI,GACpC,OAAQ,CACJ,QAAS,GACT,QAAUQ,EAAgB,QAC1B,UAAW,IAAI,KAAK,EAAE,YAAY,CACtC,CACJ,CACJ,CACJ,EAEGc,EAAQD,ECjDf,OAAS,eAAAE,MAAmB,oBAc5B,IAAOC,EAAQ,CAACC,EAA0BC,EAAkC,KACxE,MAAyEC,EAAYf,IAAsC,CACvH,GAAM,CAAE,QAAAgB,EAAS,OAAAC,CAAO,EAAI,MAAMJ,EAAY,UAAU,EAElDK,EAAiC,CACnC,QAAS,QAAQ,IAAI,UAAe,UACpC,WAAY,QAAQ,IAAI,aAAkB,UAC1C,QAASF,EAAU,0BAA4B,sBAC/C,QAASC,EACT,OAAQD,EAAU,KAAO,QACzB,UAAW,IAAI,KAAK,EAAE,YAAY,CACtC,EAEAhB,EAAS,WAAagB,EAAUL,EAAY,GAAKA,EAAY,oBAEzDG,GACAd,EAAS,UAAU,eAAgB,kBAAkB,EAGzDA,EAAS,IAAI,KAAK,UAAUkB,EAAS,KAAM,CAAC,CAAC,CACjD,EClCJ,OAAS,eAAAP,MAAmB,oBAK5B,IAAOQ,EAA2EN,GAC9E,MAAOO,EAAmBpB,IAAsC,CAC5D,GAAM,CAAE,QAAAgB,CAAQ,EAAI,MAAMH,EAAY,UAAU,EAEhDb,EAAS,WAAagB,EAAUL,EAAY,WAAaA,EAAY,oBACrEX,EAAS,IAAI,CACjB,ECTJ,IAAMqB,EAAN,KAAkD,CAAlD,cAII,KAAQ,eAA0C,CAAC,EAKnD,MAAc,cAAcC,EAAiBC,EAA6C,CAEtF,IAAMC,EAAU,KAAK,eAAeF,CAAO,EAEvCL,EAEJ,GAAI,CACAA,EAAS,MAAMO,EAAQ,EAEvBP,EAAO,YAAcA,EAAO,aAAeK,CAC/C,OAAS1B,EAAO,CACZqB,EAAS,CACL,YAAaK,EACb,OAAQ,CAAE,QAAS,GAAO,QAAU1B,EAAgB,QAAS,UAAW,IAAI,KAAK,EAAE,YAAY,CAAE,EACjG,KAAM,CAAE,MAAO,EAAK,CACxB,CACJ,CAGA,OAAA2B,EAAYD,CAAO,EAAIL,EAEhBA,EAAO,OAAO,OACzB,CAEO,WAAWK,EAAiBE,EAAwB,CAEvD,KAAK,eAAeF,CAAO,EAAIE,CACnC,CAMA,MAAa,WAAiE,CAC1E,IAAMP,EAAuB,CAAC,EAG9B,aAAM,QAAQ,IAAI,OAAO,KAAK,KAAK,cAAc,EAAE,IAAI,MAAOK,GAAY,MAAM,KAAK,cAAcA,EAASL,CAAM,CAAC,CAAC,EAQ7G,CAAE,QAAS,CAFO,OAAO,KAAKA,CAAM,EAAE,KAAMK,GAAY,CAAEL,EAAOK,CAAO,EAAwB,OAAO,OAAO,EAEhF,OAAAL,CAAO,CAChD,CAEA,MAAa,QAA2B,CACpC,GAAM,CAAE,QAAAD,CAAQ,EAAI,MAAM,KAAK,UAAU,EAEzC,OAAOA,CACX,CAKA,IAAW,cAAyB,CAChC,OAAO,OAAO,KAAK,KAAK,cAAc,CAC1C,CACJ,EAEOJ,EAAQS","sourcesContent":["import type { IPFamily, Options } from \"cacheable-lookup\";\nimport CacheableLookup from \"cacheable-lookup\";\n\nimport type { Checker } from \"../types\";\n\nconst DISPLAY_NAME = \"DNS check for\";\n\n/*\n Register the `dns` checker to ensure that a domain is reachable.\n /\nconst dnsCheck =\n (\n host: string,\n expectedAddresses?: string[],\n options?: Options & {\n family?: IPFamily \| \"all\";\n hints?: number;\n },\n ): Checker =>\n async () => {\n const { family = \"all\", hints, ...config } = options ?? {};\n\n const cacheable = new CacheableLookup(config);\n\n try {\n const meta = await cacheable.lookupAsync(host.replace(/^https?:\\/\\//, \"\"), {\n hints,\n ...(family === \"all\" ? { all: true } : { family }),\n });\n\n if (Array.isArray(expectedAddresses) && !expectedAddresses.includes(meta.address)) {\n return {\n displayName: `${DISPLAY_NAME} ${host}`,\n health: {\n healthy: false,\n message: `${DISPLAY_NAME} ${host} returned address ${meta.address} instead of ${expectedAddresses.join(\", \")}.`,\n timestamp: new Date().toISOString(),\n },\n meta: {\n addresses: meta,\n host,\n },\n };\n }\n\n return {\n displayName: `${DISPLAY_NAME} ${host}`,\n health: {\n healthy: true,\n message: `${DISPLAY_NAME} ${host} were resolved.`,\n timestamp: new Date().toISOString(),\n },\n meta: {\n addresses: meta,\n host,\n },\n };\n } catch (error) {\n return {\n displayName: `${DISPLAY_NAME} ${host}`,\n health: {\n healthy: false,\n message: (error as Error).message,\n timestamp: new Date().toISOString(),\n },\n meta: {\n host,\n },\n };\n }\n };\n\nexport default dnsCheck;\n","import { deepStrictEqual } from \"node:assert\";\n\nimport type { Checker } from \"../types\";\n\nconst DISPLAY_NAME = \"HTTP check for\";\n\n/\n Register the `http` checker to ensure http body and status is correct.\n /\nconst httpCheck =\n (\n host: RequestInfo \| URL,\n options?: {\n expected?: { body?: string; status?: number };\n fetchOptions?: RequestInit;\n },\n ): Checker =>\n async () => {\n try {\n // eslint-disable-next-line compat/compat\n const response = await fetch(host, options?.fetchOptions ?? {});\n\n if (options?.expected?.status !== undefined && options.expected.status !== response.status) {\n throw new Error(`${DISPLAY_NAME} ${host as string} returned status ${response.status} instead of ${options.expected.status}`);\n }\n\n if (options?.expected?.body !== undefined) {\n const textBody = await response.text();\n\n try {\n deepStrictEqual(textBody, options.expected.body);\n } catch {\n throw new Error(\n `${DISPLAY_NAME} ${host as string} returned body ${JSON.stringify(textBody)} instead of ${JSON.stringify(options.expected.body)}`,\n );\n }\n }\n\n return {\n displayName: `${DISPLAY_NAME} ${host as string}`,\n health: {\n healthy: true,\n message: `${DISPLAY_NAME} ${host as string} was successful.`,\n timestamp: new Date().toISOString(),\n },\n meta: {\n host,\n method: options?.fetchOptions?.method ?? \"GET\",\n status: response.status,\n },\n };\n } catch (error) {\n return {\n displayName: `${DISPLAY_NAME} ${host as string}`,\n health: {\n healthy: false,\n message: (error as Error).message,\n timestamp: new Date().toISOString(),\n },\n meta: {\n host,\n method: options?.fetchOptions?.method ?? \"GET\",\n },\n };\n }\n };\n\nexport default httpCheck;\n","import type { Checker } from \"../types\";\n\nconst DISPLAY_NAME = \"Node Environment Check\";\n\n/\n Register the `env` checker to ensure that `NODE_ENV` environment\n * variable is defined.\n /\nconst nodeEnvironmentCheck =\n (expectedEnvironment?: string): Checker =>\n async () => {\n const environment: string \| undefined = process.env[\"NODE_ENV\"];\n\n let errorMessage: string \| undefined;\n\n if (environment !== undefined && expectedEnvironment !== undefined && environment !== expectedEnvironment) {\n errorMessage = `NODE_ENV environment variable is set to \"${environment}\" instead of \"${expectedEnvironment}\".`;\n } else if (!environment) {\n errorMessage = [\"Missing NODE_ENV environment variable.\", \"It can make some parts of the application misbehave\"].join(\" \");\n }\n\n if (errorMessage !== undefined) {\n return {\n displayName: DISPLAY_NAME,\n health: {\n healthy: false,\n message: errorMessage,\n timestamp: new Date().toISOString(),\n },\n };\n }\n\n return {\n displayName: DISPLAY_NAME,\n health: {\n healthy: true,\n timestamp: new Date().toISOString(),\n },\n meta: {\n env: environment,\n },\n };\n };\n\nexport default nodeEnvironmentCheck;\n","import type { extendedPingOptions } from \"pingman\";\nimport ping from \"pingman\";\n\nimport type { Checker } from \"../types\";\n\nconst DISPLAY_NAME = \"Ping check for\";\n\n/\n Register the `ping` checker to ensure that a domain is reachable.\n /\nconst pingCheck =\n (host: string, options?: extendedPingOptions): Checker =>\n async () => {\n try {\n const response = await ping(host.replace(/^https?:\\/\\//, \"\"), options);\n\n if (!response.alive) {\n return {\n displayName: `${DISPLAY_NAME} ${host}`,\n health: {\n healthy: false,\n message: `Ping failed for ${host}.`,\n timestamp: new Date().toISOString(),\n },\n meta: response,\n };\n }\n\n return {\n displayName: `${DISPLAY_NAME} ${host}`,\n health: {\n healthy: true,\n message: `${DISPLAY_NAME} ${host} was successful.`,\n timestamp: new Date().toISOString(),\n },\n meta: response,\n };\n } catch (error) {\n return {\n displayName: `${DISPLAY_NAME} ${host}`,\n health: {\n healthy: false,\n message: (error as Error).message,\n timestamp: new Date().toISOString(),\n },\n };\n }\n };\n\nexport default pingCheck;\n","import { StatusCodes } from \"http-status-codes\";\nimport type { IncomingMessage, ServerResponse } from \"node:http\";\n\nimport type { HealthCheck, HealthReport } from \"../types\";\n\nexport interface HealthCheckApiPayload {\n appName: string;\n appVersion: string;\n message: string;\n reports: HealthReport;\n status: \"error\" \| \"ok\";\n timestamp: string;\n}\n\nexport default (healthCheck: HealthCheck, sendHeader: boolean \| undefined = true) =>\n async <Request extends IncomingMessage, Response extends ServerResponse>(_: Request, response: Response): Promise<void> => {\n const { healthy, report } = await healthCheck.getReport();\n\n const payload: HealthCheckApiPayload = {\n appName: process.env[\"APP_NAME\"] ?? \"unknown\",\n appVersion: process.env[\"APP_VERSION\"] ?? \"unknown\",\n message: healthy ? \"Health check successful\" : \"Health check failed\",\n reports: report,\n status: healthy ? \"ok\" : \"error\",\n timestamp: new Date().toISOString(),\n };\n\n response.statusCode = healthy ? StatusCodes.OK : StatusCodes.SERVICE_UNAVAILABLE;\n\n if (sendHeader) {\n response.setHeader(\"Content-Type\", \"application/json\");\n }\n\n response.end(JSON.stringify(payload, null, 2));\n };\n","import { StatusCodes } from \"http-status-codes\";\nimport type { IncomingMessage, ServerResponse } from \"node:http\";\n\nimport type { HealthCheck } from \"../types\";\n\nexport default <Request extends IncomingMessage, Response extends ServerResponse>(healthCheck: HealthCheck) =>\n async (_request: Request, response: Response): Promise<void> => {\n const { healthy } = await healthCheck.getReport();\n\n response.statusCode = healthy ? StatusCodes.NO_CONTENT : StatusCodes.SERVICE_UNAVAILABLE;\n response.end();\n };\n","import type { Checker, HealthReport, HealthReportEntry, HealthCheck as HealthcheckInterface } from \"./types.d\";\n\nclass Healthcheck implements HealthcheckInterface {\n /\n A copy of registered checkers\n /\n private healthCheckers: Record<string, Checker> = {};\n\n /\n Invokes a given checker to collect the report metrics.\n /\n private async invokeChecker(service: string, reportSheet: HealthReport): Promise<boolean> {\n // eslint-disable-next-line security/detect-object-injection\n const checker = this.healthCheckers[service] as Checker;\n\n let report: HealthReportEntry;\n\n try {\n report = await checker();\n\n report.displayName = report.displayName \|\| service;\n } catch (error) {\n report = {\n displayName: service,\n health: { healthy: false, message: (error as Error).message, timestamp: new Date().toISOString() },\n meta: { fatal: true },\n };\n }\n\n // eslint-disable-next-line no-param-reassign,security/detect-object-injection\n reportSheet[service] = report;\n\n return report.health.healthy;\n }\n\n public addChecker(service: string, checker: Checker): void {\n // eslint-disable-next-line security/detect-object-injection\n this.healthCheckers[service] = checker;\n }\n\n /\n Returns the health check reports. The health checks are performed when\n * this method is invoked.\n /\n public async getReport(): Promise<{ healthy: boolean; report: HealthReport }> {\n const report: HealthReport = {};\n\n // eslint-disable-next-line compat/compat\n await Promise.all(Object.keys(this.healthCheckers).map(async (service) => await this.invokeChecker(service, report)));\n\n /\n Finding unhealthy service to know if system is healthy or not\n /\n // eslint-disable-next-line security/detect-object-injection\n const unhealthyService = Object.keys(report).find((service) => !(report[service] as HealthReportEntry).health.healthy);\n\n return { healthy: !unhealthyService, report };\n }\n\n public async isLive(): Promise<boolean> {\n const { healthy } = await this.getReport();\n\n return healthy;\n }\n\n /\n Returns an array of registered services names\n */\n public get servicesList(): string[] {\n return Object.keys(this.healthCheckers);\n }\n}\n\nexport default Healthcheck;\n"]}

package/dist/index.mjs CHANGED Viewed

@@ -1,10 +1,10 @@
-import { StatusCodes } from 'http-status-codes';
-import k from 'cacheable-lookup';
+import f from 'cacheable-lookup';
 import { deepStrictEqual } from 'assert';
-import R from 'pingman';
+import O from 'pingman';
+import { StatusCodes } from 'http-status-codes';
-var f=(t,e=!0)=>async(a,r)=>{let{healthy:s,report:o}=await t.getReport(),l={status:s?"ok":"error",message:s?"Health check successful":"Health check failed",appName:process.env.APP_NAME??"unknown",appVersion:process.env.APP_VERSION??"unknown",timestamp:new Date().toISOString(),reports:o};r.statusCode=s?StatusCodes.OK:StatusCodes.SERVICE_UNAVAILABLE,e&&r.setHeader("Content-Type","application/json"),r.end(JSON.stringify(l,null,2));};var u=t=>async(e,a)=>{let{healthy:r}=await t.getReport();a.statusCode=r?StatusCodes.NO_CONTENT:StatusCodes.SERVICE_UNAVAILABLE,a.end();};var c=class{constructor(){this.healthCheckers={};}get servicesList(){return Object.keys(this.healthCheckers)}async invokeChecker(e,a){let r=this.healthCheckers[e],s;try{s=await r(),s.displayName=s.displayName||e;}catch(o){s={displayName:e,health:{healthy:!1,message:o.message,timestamp:new Date().toISOString()},meta:{fatal:!0}};}return a[e]=s,s.health.healthy}addChecker(e,a){this.healthCheckers[e]=a;}async getReport(){let e={};return await Promise.all(Object.keys(this.healthCheckers).map(r=>this.invokeChecker(r,e))),{healthy:!Object.keys(e).find(r=>!e[r].health.healthy),report:e}}async isLive(){let{healthy:e}=await this.getReport();return e}},g=c;var i="DNS check for",C=(t,e,a)=>async()=>{let{hints:r,family:s="all",...o}=a??{},l=new k(o);try{let n=await l.lookupAsync(t.replace(/^https?:\/\//,""),{hints:r,...s==="all"?{all:!0}:{family:s}});return Array.isArray(e)&&!e.includes(n.address)?{displayName:`${i} ${t}`,health:{healthy:!1,message:`${i} ${t} returned address ${n.address} instead of ${e.join(", ")}.`,timestamp:new Date().toISOString()},meta:{host:t,addresses:n}}:{displayName:`${i} ${t}`,health:{healthy:!0,message:`${i} ${t} were resolved.`,timestamp:new Date().toISOString()},meta:{host:t,addresses:n}}}catch(n){return {displayName:`${i} ${t}`,health:{healthy:!1,message:n.message,timestamp:new Date().toISOString()},meta:{host:t}}}},S=C;var h="HTTP check for",$=(t,e)=>async()=>{try{let a=await fetch(t,e?.fetchOptions??{});if(e?.expected?.status!==void 0&&e.expected.status!==a.status)throw new Error(`${h} ${t} returned status ${a.status} instead of ${e.expected.status}`);if(e?.expected?.body!==void 0){let r=await a.text();try{deepStrictEqual(r,e.expected.body);}catch{throw new Error(`${h} ${t} returned body ${JSON.stringify(r)} instead of ${JSON.stringify(e.expected.body)}`)}}return {displayName:`${h} ${t}`,health:{healthy:!0,message:`${h} ${t} was successful.`,timestamp:new Date().toISOString()},meta:{host:t,method:e?.fetchOptions?.method??"GET",status:a.status}}}catch(a){return {displayName:`${h} ${t}`,health:{healthy:!1,message:a.message,timestamp:new Date().toISOString()},meta:{host:t,method:e?.fetchOptions?.method??"GET"}}}},O=$;var y="Node Environment Check",E=t=>async()=>{let e="production",a;return t!==void 0&&e!==t?a=`NODE_ENV environment variable is set to "${e}" instead of "${t}".`:e,a!==void 0?{displayName:y,health:{healthy:!1,message:a,timestamp:new Date().toISOString()}}:{displayName:y,health:{healthy:!0,timestamp:new Date().toISOString()},meta:{env:e}}},I=E;var p="Ping check for",w=(t,e)=>async()=>{try{let a=await R(t.replace(/^https?:\/\//,""),e);return a.alive?{displayName:`${p} ${t}`,health:{healthy:!0,message:`${p} ${t} was successful.`,timestamp:new Date().toISOString()},meta:a}:{displayName:`${p} ${t}`,health:{healthy:!1,message:`Ping failed for ${t}.`,timestamp:new Date().toISOString()},meta:a}}catch(a){return {displayName:`${p} ${t}`,health:{healthy:!1,message:a.message,timestamp:new Date().toISOString()}}}},x=w;
+var i="DNS check for",u=(t,e,a)=>async()=>{let{family:r="all",hints:s,...o}=a??{},l=new f(o);try{let n=await l.lookupAsync(t.replace(/^https?:\/\//,""),{hints:s,...r==="all"?{all:!0}:{family:r}});return Array.isArray(e)&&!e.includes(n.address)?{displayName:`${i} ${t}`,health:{healthy:!1,message:`${i} ${t} returned address ${n.address} instead of ${e.join(", ")}.`,timestamp:new Date().toISOString()},meta:{addresses:n,host:t}}:{displayName:`${i} ${t}`,health:{healthy:!0,message:`${i} ${t} were resolved.`,timestamp:new Date().toISOString()},meta:{addresses:n,host:t}}}catch(n){return {displayName:`${i} ${t}`,health:{healthy:!1,message:n.message,timestamp:new Date().toISOString()},meta:{host:t}}}},g=u;var h="HTTP check for",C=(t,e)=>async()=>{try{let a=await fetch(t,e?.fetchOptions??{});if(e?.expected?.status!==void 0&&e.expected.status!==a.status)throw new Error(`${h} ${t} returned status ${a.status} instead of ${e.expected.status}`);if(e?.expected?.body!==void 0){let r=await a.text();try{deepStrictEqual(r,e.expected.body);}catch{throw new Error(`${h} ${t} returned body ${JSON.stringify(r)} instead of ${JSON.stringify(e.expected.body)}`)}}return {displayName:`${h} ${t}`,health:{healthy:!0,message:`${h} ${t} was successful.`,timestamp:new Date().toISOString()},meta:{host:t,method:e?.fetchOptions?.method??"GET",status:a.status}}}catch(a){return {displayName:`${h} ${t}`,health:{healthy:!1,message:a.message,timestamp:new Date().toISOString()},meta:{host:t,method:e?.fetchOptions?.method??"GET"}}}},S=C;var m="Node Environment Check",N=t=>async()=>{let e="production",a;return t!==void 0&&e!==t?a=`NODE_ENV environment variable is set to "${e}" instead of "${t}".`:e,a!==void 0?{displayName:m,health:{healthy:!1,message:a,timestamp:new Date().toISOString()}}:{displayName:m,health:{healthy:!0,timestamp:new Date().toISOString()},meta:{env:e}}},$=N;var p="Ping check for",R=(t,e)=>async()=>{try{let a=await O(t.replace(/^https?:\/\//,""),e);return a.alive?{displayName:`${p} ${t}`,health:{healthy:!0,message:`${p} ${t} was successful.`,timestamp:new Date().toISOString()},meta:a}:{displayName:`${p} ${t}`,health:{healthy:!1,message:`Ping failed for ${t}.`,timestamp:new Date().toISOString()},meta:a}}catch(a){return {displayName:`${p} ${t}`,health:{healthy:!1,message:a.message,timestamp:new Date().toISOString()}}}},w=R;var E=(t,e=!0)=>async(a,r)=>{let{healthy:s,report:o}=await t.getReport(),l={appName:process.env.APP_NAME??"unknown",appVersion:process.env.APP_VERSION??"unknown",message:s?"Health check successful":"Health check failed",reports:o,status:s?"ok":"error",timestamp:new Date().toISOString()};r.statusCode=s?StatusCodes.OK:StatusCodes.SERVICE_UNAVAILABLE,e&&r.setHeader("Content-Type","application/json"),r.end(JSON.stringify(l,null,2));};var I=t=>async(e,a)=>{let{healthy:r}=await t.getReport();a.statusCode=r?StatusCodes.NO_CONTENT:StatusCodes.SERVICE_UNAVAILABLE,a.end();};var c=class{constructor(){this.healthCheckers={};}async invokeChecker(e,a){let r=this.healthCheckers[e],s;try{s=await r(),s.displayName=s.displayName||e;}catch(o){s={displayName:e,health:{healthy:!1,message:o.message,timestamp:new Date().toISOString()},meta:{fatal:!0}};}return a[e]=s,s.health.healthy}addChecker(e,a){this.healthCheckers[e]=a;}async getReport(){let e={};return await Promise.all(Object.keys(this.healthCheckers).map(async r=>await this.invokeChecker(r,e))),{healthy:!Object.keys(e).find(r=>!e[r].health.healthy),report:e}}async isLive(){let{healthy:e}=await this.getReport();return e}get servicesList(){return Object.keys(this.healthCheckers)}},x=c;
-export { g as HealthCheck, S as dnsCheck, f as healthCheckHandler, u as healthReadyHandler, O as httpCheck, I as nodeEnvCheck, x as pingCheck };
+export { x as HealthCheck, g as dnsCheck, E as healthCheckHandler, I as healthReadyHandler, S as httpCheck, $ as nodeEnvCheck, w as pingCheck };
 //# sourceMappingURL=out.js.map
 //# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"sources":["../src/handler/healthcheck.ts","../src/handler/readyhandler.ts","../src/healthcheck.ts","../src/checks/dns-check.ts","../src/checks/http-check.ts","../src/checks/node-environment-check.ts","../src/checks/ping-check.ts"],"names":["StatusCodes","healthcheck_default","healthCheck","sendHeader","_","response","healthy","report","payload","readyhandler_default","_request","Healthcheck","service","reportSheet","checker","error","CacheableLookup","DISPLAY_NAME","dnsCheck","host","expectedAddresses","options","hints","family","config","cacheable","meta","dns_check_default","deepStrictEqual","httpCheck","textBody","http_check_default","nodeEnvironmentCheck","expectedEnvironment","environment","errorMessage","node_environment_check_default","ping","pingCheck","ping_check_default"],"mappings":"AAAA,OAAS,eAAAA,MAAmB,oBAM5B,IAAOC,EAAQ,CAACC,EAA0BC,EAAkC,KAAS,MAAyEC,EAAYC,IAAsC,CAC5M,GAAM,CAAE,QAAAC,EAAS,OAAAC,CAAO,EAAI,MAAML,EAAY,UAAU,EAElDM,EAAiC,CACnC,OAAQF,EAAU,KAAO,QACzB,QAASA,EAAU,0BAA4B,sBAC/C,QAAS,QAAQ,IAAI,UAAe,UACpC,WAAY,QAAQ,IAAI,aAAkB,UAC1C,UAAW,IAAI,KAAK,EAAE,YAAY,EAClC,QAASC,CACb,EAEAF,EAAS,WAAaC,EAAUN,EAAY,GAAKA,EAAY,oBAEzDG,GACAE,EAAS,UAAU,eAAgB,kBAAkB,EAGzDA,EAAS,IAAI,KAAK,UAAUG,EAAS,KAAM,CAAC,CAAC,CACjD,ECzBA,OAAS,eAAAR,MAAmB,oBAM5B,IAAOS,EAA2EP,GAA6B,MAAOQ,EAAmBL,IAAsC,CAC3K,GAAM,CAAE,QAAAC,CAAQ,EAAI,MAAMJ,EAAY,UAAU,EAEhDG,EAAS,WAAaC,EAAUN,EAAY,WAAaA,EAAY,oBACrEK,EAAS,IAAI,CACjB,ECPA,IAAMM,EAAN,KAAkD,CAAlD,cAII,KAAQ,eAAiD,CAAC,EAK1D,IAAW,cAAyB,CAChC,OAAO,OAAO,KAAK,KAAK,cAAc,CAC1C,CAKA,MAAc,cAAcC,EAAiBC,EAA6C,CACtF,IAAMC,EAAU,KAAK,eAAeF,CAAO,EAEvCL,EAEJ,GAAI,CACAA,EAAS,MAAMO,EAAQ,EAEvBP,EAAO,YAAcA,EAAO,aAAeK,CAC/C,OAASG,EAAP,CACER,EAAS,CACL,YAAaK,EACb,OAAQ,CAAE,QAAS,GAAO,QAAUG,EAAgB,QAAS,UAAW,IAAI,KAAK,EAAE,YAAY,CAAE,EACjG,KAAM,CAAE,MAAO,EAAK,CACxB,CACJ,CAGA,OAAAF,EAAYD,CAAO,EAAIL,EAEhBA,EAAO,OAAO,OACzB,CAEO,WAAWK,EAAiBE,EAAwB,CACvD,KAAK,eAAeF,CAAO,EAAIE,CACnC,CAMA,MAAa,WAAiE,CAC1E,IAAMP,EAAuB,CAAC,EAG9B,aAAM,QAAQ,IAAI,OAAO,KAAK,KAAK,cAAc,EAAE,IAAKK,GAAY,KAAK,cAAcA,EAASL,CAAM,CAAC,CAAC,EAOjG,CAAE,QAAS,CAFO,OAAO,KAAKA,CAAM,EAAE,KAAMK,GAAY,CAAEL,EAAOK,CAAO,EAAwB,OAAO,OAAO,EAEhF,OAAAL,CAAO,CAChD,CAEA,MAAa,QAA2B,CACpC,GAAM,CAAE,QAAAD,CAAQ,EAAI,MAAM,KAAK,UAAU,EAEzC,OAAOA,CACX,CACJ,EAEOL,EAAQU,ECvEf,OAAOK,MAAqB,mBAI5B,IAAMC,EAAe,gBAKfC,EAAW,CACbC,EACAC,EACAC,IAIU,SAAY,CACtB,GAAM,CAAE,MAAAC,EAAO,OAAAC,EAAS,MAAO,GAAGC,CAAO,EAAIH,GAAW,CAAC,EAEnDI,EAAY,IAAIT,EAAgBQ,CAAM,EAE5C,GAAI,CACA,IAAME,EAAO,MAAMD,EAAU,YAAYN,EAAK,QAAQ,eAAgB,EAAE,EAAG,CACvE,MAAAG,EACA,GAAIC,IAAW,MAAQ,CAAE,IAAK,EAAK,EAAI,CAAE,OAAAA,CAAO,CACpD,CAAC,EAED,OAAI,MAAM,QAAQH,CAAiB,GAAK,CAACA,EAAkB,SAASM,EAAK,OAAO,EACrE,CACH,YAAa,GAAGT,KAAgBE,IAChC,OAAQ,CACJ,QAAS,GACT,QAAS,GAAGF,KAAgBE,sBAAyBO,EAAK,sBAAsBN,EAAkB,KAAK,IAAI,KAC3G,UAAW,IAAI,KAAK,EAAE,YAAY,CACtC,EACA,KAAM,CACF,KAAAD,EACA,UAAWO,CACf,CACJ,EAGG,CACH,YAAa,GAAGT,KAAgBE,IAChC,OAAQ,CACJ,QAAS,GACT,QAAS,GAAGF,KAAgBE,mBAC5B,UAAW,IAAI,KAAK,EAAE,YAAY,CACtC,EACA,KAAM,CACF,KAAAA,EACA,UAAWO,CACf,CACJ,CACJ,OAASX,EAAP,CACE,MAAO,CACH,YAAa,GAAGE,KAAgBE,IAChC,OAAQ,CACJ,QAAS,GACT,QAAUJ,EAAgB,QAC1B,UAAW,IAAI,KAAK,EAAE,YAAY,CACtC,EACA,KAAM,CACF,KAAAI,CACJ,CACJ,CACJ,CACJ,EAEOQ,EAAQT,ECtEf,OAAS,mBAAAU,MAAuB,SAIhC,IAAMX,EAAe,iBAKfY,EAAY,CACdV,EACAE,IAIU,SAAY,CACtB,GAAI,CAEA,IAAMhB,EAAW,MAAM,MAAMc,EAAME,GAAS,cAAgB,CAAC,CAAC,EAE9D,GAAIA,GAAS,UAAU,SAAW,QAAaA,EAAQ,SAAS,SAAWhB,EAAS,OAChF,MAAM,IAAI,MAAM,GAAGY,KAAgBE,qBAAwBd,EAAS,qBAAqBgB,EAAQ,SAAS,QAAQ,EAGtH,GAAIA,GAAS,UAAU,OAAS,OAAW,CACvC,IAAMS,EAAW,MAAMzB,EAAS,KAAK,EAErC,GAAI,CACAuB,EAAgBE,EAAUT,EAAQ,SAAS,IAAI,CACnD,MAAE,CACE,MAAM,IAAI,MAAM,GAAGJ,KAAgBE,mBAAsB,KAAK,UAAUW,CAAQ,gBAAgB,KAAK,UAAUT,EAAQ,SAAS,IAAI,GAAG,CAC3I,EAGJ,MAAO,CACH,YAAa,GAAGJ,KAAgBE,IAChC,OAAQ,CACJ,QAAS,GACT,QAAS,GAAGF,KAAgBE,oBAC5B,UAAW,IAAI,KAAK,EAAE,YAAY,CACtC,EACA,KAAM,CACF,KAAAA,EACA,OAAQE,GAAS,cAAc,QAAU,MACzC,OAAQhB,EAAS,MACrB,CACJ,CACJ,OAASU,EAAP,CACE,MAAO,CACH,YAAa,GAAGE,KAAgBE,IAChC,OAAQ,CACJ,QAAS,GACT,QAAUJ,EAAgB,QAC1B,UAAW,IAAI,KAAK,EAAE,YAAY,CACtC,EACA,KAAM,CACF,KAAAI,EACA,OAAQE,GAAS,cAAc,QAAU,KAC7C,CACJ,CACJ,CACJ,EAEOU,EAAQF,EC7Df,IAAMZ,EAAe,yBAMfe,EAAwBC,GAA0C,SAAY,CAEhF,IAAMC,EAAkC,aAEpCC,EASJ,OANID,IAAgB,QAAaD,IAAwB,QAAaC,IAAgBD,EAClFE,EAAe,4CAA4CD,kBAA4BD,MAC/EC,IACRC,EAAe,CAAC,yCAA0C,qDAAqD,EAAE,KAAK,GAAG,GAGzHA,IAAiB,OACV,CACH,YAAalB,EACb,OAAQ,CACJ,QAAS,GACT,QAASkB,EACT,UAAW,IAAI,KAAK,EAAE,YAAY,CACtC,CACJ,EAGG,CACH,YAAalB,EACb,OAAQ,CACJ,QAAS,GACT,UAAW,IAAI,KAAK,EAAE,YAAY,CACtC,EACA,KAAM,CACF,IAAKiB,CACT,CACJ,CACJ,EAEOE,EAAQJ,EC3Cf,OAAOK,MAAU,UAIjB,IAAMpB,EAAe,iBAKfqB,EAAY,CAACnB,EAAcE,IAA2C,SAAY,CACpF,GAAI,CACA,IAAMhB,EAAW,MAAMgC,EAAKlB,EAAK,QAAQ,eAAgB,EAAE,EAAGE,CAAO,EAErE,OAAKhB,EAAS,MAYP,CACH,YAAa,GAAGY,KAAgBE,IAChC,OAAQ,CACJ,QAAS,GACT,QAAS,GAAGF,KAAgBE,oBAC5B,UAAW,IAAI,KAAK,EAAE,YAAY,CACtC,EACA,KAAMd,CACV,EAnBW,CACH,YAAa,GAAGY,KAAgBE,IAChC,OAAQ,CACJ,QAAS,GACT,QAAS,mBAAmBA,KAC5B,UAAW,IAAI,KAAK,EAAE,YAAY,CACtC,EACA,KAAMd,CACV,CAYR,OAASU,EAAP,CACE,MAAO,CACH,YAAa,GAAGE,KAAgBE,IAChC,OAAQ,CACJ,QAAS,GACT,QAAUJ,EAAgB,QAC1B,UAAW,IAAI,KAAK,EAAE,YAAY,CACtC,CACJ,CACJ,CACJ,EAEOwB,EAAQD","sourcesContent":["import { StatusCodes } from \"http-status-codes\";\nimport type { IncomingMessage, ServerResponse } from \"node:http\";\n\nimport type { HealthCheck, HealthReport } from \"../types\";\n\n// eslint-disable-next-line max-len\nexport default (healthCheck: HealthCheck, sendHeader: boolean \| undefined = true) => async <Request extends IncomingMessage, Response extends ServerResponse>(_: Request, response: Response): Promise<void> => {\n const { healthy, report } = await healthCheck.getReport();\n\n const payload: HealthCheckApiPayload = {\n status: healthy ? \"ok\" : \"error\",\n message: healthy ? \"Health check successful\" : \"Health check failed\",\n appName: process.env[\"APP_NAME\"] ?? \"unknown\",\n appVersion: process.env[\"APP_VERSION\"] ?? \"unknown\",\n timestamp: new Date().toISOString(),\n reports: report,\n };\n\n response.statusCode = healthy ? StatusCodes.OK : StatusCodes.SERVICE_UNAVAILABLE;\n\n if (sendHeader) {\n response.setHeader(\"Content-Type\", \"application/json\");\n }\n\n response.end(JSON.stringify(payload, null, 2));\n};\n\nexport type HealthCheckApiPayload = {\n status: \"error\" \| \"ok\";\n message: string;\n appName: string;\n appVersion: string;\n timestamp: string;\n reports: HealthReport;\n};\n","import { StatusCodes } from \"http-status-codes\";\nimport type { IncomingMessage, ServerResponse } from \"node:http\";\n\nimport type { HealthCheck } from \"../types\";\n\n// eslint-disable-next-line max-len\nexport default <Request extends IncomingMessage, Response extends ServerResponse>(healthCheck: HealthCheck) => async (_request: Request, response: Response): Promise<void> => {\n const { healthy } = await healthCheck.getReport();\n\n response.statusCode = healthy ? StatusCodes.NO_CONTENT : StatusCodes.SERVICE_UNAVAILABLE;\n response.end();\n};\n","import type {\n Checker, HealthCheck as HealthcheckInterface, HealthReport, HealthReportEntry,\n} from \"./types.d\";\n\nclass Healthcheck implements HealthcheckInterface {\n /*\n A copy of registered checkers\n /\n private healthCheckers: { [service: string]: Checker } = {};\n\n /\n Returns an array of registered services names\n /\n public get servicesList(): string[] {\n return Object.keys(this.healthCheckers);\n }\n\n /\n Invokes a given checker to collect the report metrics.\n /\n private async invokeChecker(service: string, reportSheet: HealthReport): Promise<boolean> {\n const checker = this.healthCheckers[service] as Checker;\n\n let report: HealthReportEntry;\n\n try {\n report = await checker();\n\n report.displayName = report.displayName \|\| service;\n } catch (error: any) {\n report = {\n displayName: service,\n health: { healthy: false, message: (error as Error).message, timestamp: new Date().toISOString() },\n meta: { fatal: true },\n };\n }\n\n // eslint-disable-next-line no-param-reassign\n reportSheet[service] = report;\n\n return report.health.healthy;\n }\n\n public addChecker(service: string, checker: Checker): void {\n this.healthCheckers[service] = checker;\n }\n\n /\n Returns the health check reports. The health checks are performed when\n * this method is invoked.\n /\n public async getReport(): Promise<{ healthy: boolean; report: HealthReport }> {\n const report: HealthReport = {};\n\n // eslint-disable-next-line compat/compat\n await Promise.all(Object.keys(this.healthCheckers).map((service) => this.invokeChecker(service, report)));\n\n /\n Finding unhealthy service to know if system is healthy or not\n /\n const unhealthyService = Object.keys(report).find((service) => !(report[service] as HealthReportEntry).health.healthy);\n\n return { healthy: !unhealthyService, report };\n }\n\n public async isLive(): Promise<boolean> {\n const { healthy } = await this.getReport();\n\n return healthy;\n }\n}\n\nexport default Healthcheck;\n","import type { IPFamily, Options } from \"cacheable-lookup\";\nimport CacheableLookup from \"cacheable-lookup\";\n\nimport type { Checker } from \"../types\";\n\nconst DISPLAY_NAME = \"DNS check for\";\n\n/\n Register the `dns` checker to ensure that a domain is reachable.\n /\nconst dnsCheck = (\n host: string,\n expectedAddresses?: string[],\n options?: Options & {\n family?: IPFamily \| \"all\";\n hints?: number;\n },\n): Checker => async () => {\n const { hints, family = \"all\", ...config } = options ?? {};\n\n const cacheable = new CacheableLookup(config);\n\n try {\n const meta = await cacheable.lookupAsync(host.replace(/^https?:\\/\\//, \"\"), {\n hints,\n ...(family === \"all\" ? { all: true } : { family }),\n });\n\n if (Array.isArray(expectedAddresses) && !expectedAddresses.includes(meta.address)) {\n return {\n displayName: `${DISPLAY_NAME} ${host}`,\n health: {\n healthy: false,\n message: `${DISPLAY_NAME} ${host} returned address ${meta.address} instead of ${expectedAddresses.join(\", \")}.`,\n timestamp: new Date().toISOString(),\n },\n meta: {\n host,\n addresses: meta,\n },\n };\n }\n\n return {\n displayName: `${DISPLAY_NAME} ${host}`,\n health: {\n healthy: true,\n message: `${DISPLAY_NAME} ${host} were resolved.`,\n timestamp: new Date().toISOString(),\n },\n meta: {\n host,\n addresses: meta,\n },\n };\n } catch (error: any) {\n return {\n displayName: `${DISPLAY_NAME} ${host}`,\n health: {\n healthy: false,\n message: (error as Error).message,\n timestamp: new Date().toISOString(),\n },\n meta: {\n host,\n },\n };\n }\n};\n\nexport default dnsCheck;\n","import { deepStrictEqual } from \"node:assert\";\n\nimport type { Checker } from \"../types\";\n\nconst DISPLAY_NAME = \"HTTP check for\";\n\n/\n Register the `http` checker to ensure http body and status is correct.\n /\nconst httpCheck = (\n host: RequestInfo \| URL,\n options?: {\n fetchOptions?: RequestInit;\n expected?: { status?: number; body?: string };\n },\n): Checker => async () => {\n try {\n // eslint-disable-next-line compat/compat\n const response = await fetch(host, options?.fetchOptions ?? {});\n\n if (options?.expected?.status !== undefined && options.expected.status !== response.status) {\n throw new Error(`${DISPLAY_NAME} ${host} returned status ${response.status} instead of ${options.expected.status}`);\n }\n\n if (options?.expected?.body !== undefined) {\n const textBody = await response.text();\n\n try {\n deepStrictEqual(textBody, options.expected.body);\n } catch {\n throw new Error(`${DISPLAY_NAME} ${host} returned body ${JSON.stringify(textBody)} instead of ${JSON.stringify(options.expected.body)}`);\n }\n }\n\n return {\n displayName: `${DISPLAY_NAME} ${host}`,\n health: {\n healthy: true,\n message: `${DISPLAY_NAME} ${host} was successful.`,\n timestamp: new Date().toISOString(),\n },\n meta: {\n host,\n method: options?.fetchOptions?.method ?? \"GET\",\n status: response.status,\n },\n };\n } catch (error: any) {\n return {\n displayName: `${DISPLAY_NAME} ${host}`,\n health: {\n healthy: false,\n message: (error as Error).message,\n timestamp: new Date().toISOString(),\n },\n meta: {\n host,\n method: options?.fetchOptions?.method ?? \"GET\",\n },\n };\n }\n};\n\nexport default httpCheck;\n","import type { Checker } from \"../types\";\n\nconst DISPLAY_NAME = \"Node Environment Check\";\n\n/\n Register the `env` checker to ensure that `NODE_ENV` environment\n * variable is defined.\n /\nconst nodeEnvironmentCheck = (expectedEnvironment?: string): Checker => async () => {\n // eslint-disable-next-line @typescript-eslint/dot-notation\n const environment: string \| undefined = process.env[\"NODE_ENV\"];\n\n let errorMessage: string \| undefined;\n\n // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition\n if (environment !== undefined && expectedEnvironment !== undefined && environment !== expectedEnvironment) {\n errorMessage = `NODE_ENV environment variable is set to \"${environment}\" instead of \"${expectedEnvironment}\".`;\n } else if (!environment) {\n errorMessage = [\"Missing NODE_ENV environment variable.\", \"It can make some parts of the application misbehave\"].join(\" \");\n }\n\n if (errorMessage !== undefined) {\n return {\n displayName: DISPLAY_NAME,\n health: {\n healthy: false,\n message: errorMessage,\n timestamp: new Date().toISOString(),\n },\n };\n }\n\n return {\n displayName: DISPLAY_NAME,\n health: {\n healthy: true,\n timestamp: new Date().toISOString(),\n },\n meta: {\n env: environment,\n },\n };\n};\n\nexport default nodeEnvironmentCheck;\n","import type { extendedPingOptions } from \"pingman\";\nimport ping from \"pingman\";\n\nimport type { Checker } from \"../types\";\n\nconst DISPLAY_NAME = \"Ping check for\";\n\n/\n Register the `ping` checker to ensure that a domain is reachable.\n */\nconst pingCheck = (host: string, options?: extendedPingOptions): Checker => async () => {\n try {\n const response = await ping(host.replace(/^https?:\\/\\//, \"\"), options);\n\n if (!response.alive) {\n return {\n displayName: `${DISPLAY_NAME} ${host}`,\n health: {\n healthy: false,\n message: `Ping failed for ${host}.`,\n timestamp: new Date().toISOString(),\n },\n meta: response,\n };\n }\n\n return {\n displayName: `${DISPLAY_NAME} ${host}`,\n health: {\n healthy: true,\n message: `${DISPLAY_NAME} ${host} was successful.`,\n timestamp: new Date().toISOString(),\n },\n meta: response,\n };\n } catch (error: any) {\n return {\n displayName: `${DISPLAY_NAME} ${host}`,\n health: {\n healthy: false,\n message: (error as Error).message,\n timestamp: new Date().toISOString(),\n },\n };\n }\n};\n\nexport default pingCheck;\n"]}
1	+ {"version":3,"sources":["../src/checks/dns-check.ts","../src/checks/http-check.ts","../src/checks/node-environment-check.ts","../src/checks/ping-check.ts","../src/handler/healthcheck.ts","../src/handler/readyhandler.ts","../src/healthcheck.ts"],"names":["CacheableLookup","DISPLAY_NAME","dnsCheck","host","expectedAddresses","options","family","hints","config","cacheable","meta","error","dns_check_default","deepStrictEqual","httpCheck","response","textBody","http_check_default","nodeEnvironmentCheck","expectedEnvironment","environment","errorMessage","node_environment_check_default","ping","pingCheck","ping_check_default","StatusCodes","healthcheck_default","healthCheck","sendHeader","_","healthy","report","payload","readyhandler_default","_request","Healthcheck","service","reportSheet","checker"],"mappings":"AACA,OAAOA,MAAqB,mBAI5B,IAAMC,EAAe,gBAKfC,EACF,CACIC,EACAC,EACAC,IAKJ,SAAY,CACR,GAAM,CAAE,OAAAC,EAAS,MAAO,MAAAC,EAAO,GAAGC,CAAO,EAAIH,GAAW,CAAC,EAEnDI,EAAY,IAAIT,EAAgBQ,CAAM,EAE5C,GAAI,CACA,IAAME,EAAO,MAAMD,EAAU,YAAYN,EAAK,QAAQ,eAAgB,EAAE,EAAG,CACvE,MAAAI,EACA,GAAID,IAAW,MAAQ,CAAE,IAAK,EAAK,EAAI,CAAE,OAAAA,CAAO,CACpD,CAAC,EAED,OAAI,MAAM,QAAQF,CAAiB,GAAK,CAACA,EAAkB,SAASM,EAAK,OAAO,EACrE,CACH,YAAa,GAAGT,CAAY,IAAIE,CAAI,GACpC,OAAQ,CACJ,QAAS,GACT,QAAS,GAAGF,CAAY,IAAIE,CAAI,qBAAqBO,EAAK,OAAO,eAAeN,EAAkB,KAAK,IAAI,CAAC,IAC5G,UAAW,IAAI,KAAK,EAAE,YAAY,CACtC,EACA,KAAM,CACF,UAAWM,EACX,KAAAP,CACJ,CACJ,EAGG,CACH,YAAa,GAAGF,CAAY,IAAIE,CAAI,GACpC,OAAQ,CACJ,QAAS,GACT,QAAS,GAAGF,CAAY,IAAIE,CAAI,kBAChC,UAAW,IAAI,KAAK,EAAE,YAAY,CACtC,EACA,KAAM,CACF,UAAWO,EACX,KAAAP,CACJ,CACJ,CACJ,OAASQ,EAAO,CACZ,MAAO,CACH,YAAa,GAAGV,CAAY,IAAIE,CAAI,GACpC,OAAQ,CACJ,QAAS,GACT,QAAUQ,EAAgB,QAC1B,UAAW,IAAI,KAAK,EAAE,YAAY,CACtC,EACA,KAAM,CACF,KAAAR,CACJ,CACJ,CACJ,CACJ,EAEGS,EAAQV,ECxEf,OAAS,mBAAAW,MAAuB,SAIhC,IAAMZ,EAAe,iBAKfa,EACF,CACIX,EACAE,IAKJ,SAAY,CACR,GAAI,CAEA,IAAMU,EAAW,MAAM,MAAMZ,EAAME,GAAS,cAAgB,CAAC,CAAC,EAE9D,GAAIA,GAAS,UAAU,SAAW,QAAaA,EAAQ,SAAS,SAAWU,EAAS,OAChF,MAAM,IAAI,MAAM,GAAGd,CAAY,IAAIE,CAAc,oBAAoBY,EAAS,MAAM,eAAeV,EAAQ,SAAS,MAAM,EAAE,EAGhI,GAAIA,GAAS,UAAU,OAAS,OAAW,CACvC,IAAMW,EAAW,MAAMD,EAAS,KAAK,EAErC,GAAI,CACAF,EAAgBG,EAAUX,EAAQ,SAAS,IAAI,CACnD,MAAQ,CACJ,MAAM,IAAI,MACN,GAAGJ,CAAY,IAAIE,CAAc,kBAAkB,KAAK,UAAUa,CAAQ,CAAC,eAAe,KAAK,UAAUX,EAAQ,SAAS,IAAI,CAAC,EACnI,CACJ,CACJ,CAEA,MAAO,CACH,YAAa,GAAGJ,CAAY,IAAIE,CAAc,GAC9C,OAAQ,CACJ,QAAS,GACT,QAAS,GAAGF,CAAY,IAAIE,CAAc,mBAC1C,UAAW,IAAI,KAAK,EAAE,YAAY,CACtC,EACA,KAAM,CACF,KAAAA,EACA,OAAQE,GAAS,cAAc,QAAU,MACzC,OAAQU,EAAS,MACrB,CACJ,CACJ,OAASJ,EAAO,CACZ,MAAO,CACH,YAAa,GAAGV,CAAY,IAAIE,CAAc,GAC9C,OAAQ,CACJ,QAAS,GACT,QAAUQ,EAAgB,QAC1B,UAAW,IAAI,KAAK,EAAE,YAAY,CACtC,EACA,KAAM,CACF,KAAAR,EACA,OAAQE,GAAS,cAAc,QAAU,KAC7C,CACJ,CACJ,CACJ,EAEGY,EAAQH,ECjEf,IAAMb,EAAe,yBAMfiB,EACDC,GACD,SAAY,CACR,IAAMC,EAAkC,aAEpCC,EAQJ,OANID,IAAgB,QAAaD,IAAwB,QAAaC,IAAgBD,EAClFE,EAAe,4CAA4CD,CAAW,iBAAiBD,CAAmB,KAClGC,IACRC,EAAe,CAAC,yCAA0C,qDAAqD,EAAE,KAAK,GAAG,GAGzHA,IAAiB,OACV,CACH,YAAapB,EACb,OAAQ,CACJ,QAAS,GACT,QAASoB,EACT,UAAW,IAAI,KAAK,EAAE,YAAY,CACtC,CACJ,EAGG,CACH,YAAapB,EACb,OAAQ,CACJ,QAAS,GACT,UAAW,IAAI,KAAK,EAAE,YAAY,CACtC,EACA,KAAM,CACF,IAAKmB,CACT,CACJ,CACJ,EAEGE,EAAQJ,EC3Cf,OAAOK,MAAU,UAIjB,IAAMtB,EAAe,iBAKfuB,EACF,CAACrB,EAAcE,IACf,SAAY,CACR,GAAI,CACA,IAAMU,EAAW,MAAMQ,EAAKpB,EAAK,QAAQ,eAAgB,EAAE,EAAGE,CAAO,EAErE,OAAKU,EAAS,MAYP,CACH,YAAa,GAAGd,CAAY,IAAIE,CAAI,GACpC,OAAQ,CACJ,QAAS,GACT,QAAS,GAAGF,CAAY,IAAIE,CAAI,mBAChC,UAAW,IAAI,KAAK,EAAE,YAAY,CACtC,EACA,KAAMY,CACV,EAnBW,CACH,YAAa,GAAGd,CAAY,IAAIE,CAAI,GACpC,OAAQ,CACJ,QAAS,GACT,QAAS,mBAAmBA,CAAI,IAChC,UAAW,IAAI,KAAK,EAAE,YAAY,CACtC,EACA,KAAMY,CACV,CAYR,OAASJ,EAAO,CACZ,MAAO,CACH,YAAa,GAAGV,CAAY,IAAIE,CAAI,GACpC,OAAQ,CACJ,QAAS,GACT,QAAUQ,EAAgB,QAC1B,UAAW,IAAI,KAAK,EAAE,YAAY,CACtC,CACJ,CACJ,CACJ,EAEGc,EAAQD,ECjDf,OAAS,eAAAE,MAAmB,oBAc5B,IAAOC,EAAQ,CAACC,EAA0BC,EAAkC,KACxE,MAAyEC,EAAYf,IAAsC,CACvH,GAAM,CAAE,QAAAgB,EAAS,OAAAC,CAAO,EAAI,MAAMJ,EAAY,UAAU,EAElDK,EAAiC,CACnC,QAAS,QAAQ,IAAI,UAAe,UACpC,WAAY,QAAQ,IAAI,aAAkB,UAC1C,QAASF,EAAU,0BAA4B,sBAC/C,QAASC,EACT,OAAQD,EAAU,KAAO,QACzB,UAAW,IAAI,KAAK,EAAE,YAAY,CACtC,EAEAhB,EAAS,WAAagB,EAAUL,EAAY,GAAKA,EAAY,oBAEzDG,GACAd,EAAS,UAAU,eAAgB,kBAAkB,EAGzDA,EAAS,IAAI,KAAK,UAAUkB,EAAS,KAAM,CAAC,CAAC,CACjD,EClCJ,OAAS,eAAAP,MAAmB,oBAK5B,IAAOQ,EAA2EN,GAC9E,MAAOO,EAAmBpB,IAAsC,CAC5D,GAAM,CAAE,QAAAgB,CAAQ,EAAI,MAAMH,EAAY,UAAU,EAEhDb,EAAS,WAAagB,EAAUL,EAAY,WAAaA,EAAY,oBACrEX,EAAS,IAAI,CACjB,ECTJ,IAAMqB,EAAN,KAAkD,CAAlD,cAII,KAAQ,eAA0C,CAAC,EAKnD,MAAc,cAAcC,EAAiBC,EAA6C,CAEtF,IAAMC,EAAU,KAAK,eAAeF,CAAO,EAEvCL,EAEJ,GAAI,CACAA,EAAS,MAAMO,EAAQ,EAEvBP,EAAO,YAAcA,EAAO,aAAeK,CAC/C,OAAS1B,EAAO,CACZqB,EAAS,CACL,YAAaK,EACb,OAAQ,CAAE,QAAS,GAAO,QAAU1B,EAAgB,QAAS,UAAW,IAAI,KAAK,EAAE,YAAY,CAAE,EACjG,KAAM,CAAE,MAAO,EAAK,CACxB,CACJ,CAGA,OAAA2B,EAAYD,CAAO,EAAIL,EAEhBA,EAAO,OAAO,OACzB,CAEO,WAAWK,EAAiBE,EAAwB,CAEvD,KAAK,eAAeF,CAAO,EAAIE,CACnC,CAMA,MAAa,WAAiE,CAC1E,IAAMP,EAAuB,CAAC,EAG9B,aAAM,QAAQ,IAAI,OAAO,KAAK,KAAK,cAAc,EAAE,IAAI,MAAOK,GAAY,MAAM,KAAK,cAAcA,EAASL,CAAM,CAAC,CAAC,EAQ7G,CAAE,QAAS,CAFO,OAAO,KAAKA,CAAM,EAAE,KAAMK,GAAY,CAAEL,EAAOK,CAAO,EAAwB,OAAO,OAAO,EAEhF,OAAAL,CAAO,CAChD,CAEA,MAAa,QAA2B,CACpC,GAAM,CAAE,QAAAD,CAAQ,EAAI,MAAM,KAAK,UAAU,EAEzC,OAAOA,CACX,CAKA,IAAW,cAAyB,CAChC,OAAO,OAAO,KAAK,KAAK,cAAc,CAC1C,CACJ,EAEOJ,EAAQS","sourcesContent":["import type { IPFamily, Options } from \"cacheable-lookup\";\nimport CacheableLookup from \"cacheable-lookup\";\n\nimport type { Checker } from \"../types\";\n\nconst DISPLAY_NAME = \"DNS check for\";\n\n/*\n Register the `dns` checker to ensure that a domain is reachable.\n /\nconst dnsCheck =\n (\n host: string,\n expectedAddresses?: string[],\n options?: Options & {\n family?: IPFamily \| \"all\";\n hints?: number;\n },\n ): Checker =>\n async () => {\n const { family = \"all\", hints, ...config } = options ?? {};\n\n const cacheable = new CacheableLookup(config);\n\n try {\n const meta = await cacheable.lookupAsync(host.replace(/^https?:\\/\\//, \"\"), {\n hints,\n ...(family === \"all\" ? { all: true } : { family }),\n });\n\n if (Array.isArray(expectedAddresses) && !expectedAddresses.includes(meta.address)) {\n return {\n displayName: `${DISPLAY_NAME} ${host}`,\n health: {\n healthy: false,\n message: `${DISPLAY_NAME} ${host} returned address ${meta.address} instead of ${expectedAddresses.join(\", \")}.`,\n timestamp: new Date().toISOString(),\n },\n meta: {\n addresses: meta,\n host,\n },\n };\n }\n\n return {\n displayName: `${DISPLAY_NAME} ${host}`,\n health: {\n healthy: true,\n message: `${DISPLAY_NAME} ${host} were resolved.`,\n timestamp: new Date().toISOString(),\n },\n meta: {\n addresses: meta,\n host,\n },\n };\n } catch (error) {\n return {\n displayName: `${DISPLAY_NAME} ${host}`,\n health: {\n healthy: false,\n message: (error as Error).message,\n timestamp: new Date().toISOString(),\n },\n meta: {\n host,\n },\n };\n }\n };\n\nexport default dnsCheck;\n","import { deepStrictEqual } from \"node:assert\";\n\nimport type { Checker } from \"../types\";\n\nconst DISPLAY_NAME = \"HTTP check for\";\n\n/\n Register the `http` checker to ensure http body and status is correct.\n /\nconst httpCheck =\n (\n host: RequestInfo \| URL,\n options?: {\n expected?: { body?: string; status?: number };\n fetchOptions?: RequestInit;\n },\n ): Checker =>\n async () => {\n try {\n // eslint-disable-next-line compat/compat\n const response = await fetch(host, options?.fetchOptions ?? {});\n\n if (options?.expected?.status !== undefined && options.expected.status !== response.status) {\n throw new Error(`${DISPLAY_NAME} ${host as string} returned status ${response.status} instead of ${options.expected.status}`);\n }\n\n if (options?.expected?.body !== undefined) {\n const textBody = await response.text();\n\n try {\n deepStrictEqual(textBody, options.expected.body);\n } catch {\n throw new Error(\n `${DISPLAY_NAME} ${host as string} returned body ${JSON.stringify(textBody)} instead of ${JSON.stringify(options.expected.body)}`,\n );\n }\n }\n\n return {\n displayName: `${DISPLAY_NAME} ${host as string}`,\n health: {\n healthy: true,\n message: `${DISPLAY_NAME} ${host as string} was successful.`,\n timestamp: new Date().toISOString(),\n },\n meta: {\n host,\n method: options?.fetchOptions?.method ?? \"GET\",\n status: response.status,\n },\n };\n } catch (error) {\n return {\n displayName: `${DISPLAY_NAME} ${host as string}`,\n health: {\n healthy: false,\n message: (error as Error).message,\n timestamp: new Date().toISOString(),\n },\n meta: {\n host,\n method: options?.fetchOptions?.method ?? \"GET\",\n },\n };\n }\n };\n\nexport default httpCheck;\n","import type { Checker } from \"../types\";\n\nconst DISPLAY_NAME = \"Node Environment Check\";\n\n/\n Register the `env` checker to ensure that `NODE_ENV` environment\n * variable is defined.\n /\nconst nodeEnvironmentCheck =\n (expectedEnvironment?: string): Checker =>\n async () => {\n const environment: string \| undefined = process.env[\"NODE_ENV\"];\n\n let errorMessage: string \| undefined;\n\n if (environment !== undefined && expectedEnvironment !== undefined && environment !== expectedEnvironment) {\n errorMessage = `NODE_ENV environment variable is set to \"${environment}\" instead of \"${expectedEnvironment}\".`;\n } else if (!environment) {\n errorMessage = [\"Missing NODE_ENV environment variable.\", \"It can make some parts of the application misbehave\"].join(\" \");\n }\n\n if (errorMessage !== undefined) {\n return {\n displayName: DISPLAY_NAME,\n health: {\n healthy: false,\n message: errorMessage,\n timestamp: new Date().toISOString(),\n },\n };\n }\n\n return {\n displayName: DISPLAY_NAME,\n health: {\n healthy: true,\n timestamp: new Date().toISOString(),\n },\n meta: {\n env: environment,\n },\n };\n };\n\nexport default nodeEnvironmentCheck;\n","import type { extendedPingOptions } from \"pingman\";\nimport ping from \"pingman\";\n\nimport type { Checker } from \"../types\";\n\nconst DISPLAY_NAME = \"Ping check for\";\n\n/\n Register the `ping` checker to ensure that a domain is reachable.\n /\nconst pingCheck =\n (host: string, options?: extendedPingOptions): Checker =>\n async () => {\n try {\n const response = await ping(host.replace(/^https?:\\/\\//, \"\"), options);\n\n if (!response.alive) {\n return {\n displayName: `${DISPLAY_NAME} ${host}`,\n health: {\n healthy: false,\n message: `Ping failed for ${host}.`,\n timestamp: new Date().toISOString(),\n },\n meta: response,\n };\n }\n\n return {\n displayName: `${DISPLAY_NAME} ${host}`,\n health: {\n healthy: true,\n message: `${DISPLAY_NAME} ${host} was successful.`,\n timestamp: new Date().toISOString(),\n },\n meta: response,\n };\n } catch (error) {\n return {\n displayName: `${DISPLAY_NAME} ${host}`,\n health: {\n healthy: false,\n message: (error as Error).message,\n timestamp: new Date().toISOString(),\n },\n };\n }\n };\n\nexport default pingCheck;\n","import { StatusCodes } from \"http-status-codes\";\nimport type { IncomingMessage, ServerResponse } from \"node:http\";\n\nimport type { HealthCheck, HealthReport } from \"../types\";\n\nexport interface HealthCheckApiPayload {\n appName: string;\n appVersion: string;\n message: string;\n reports: HealthReport;\n status: \"error\" \| \"ok\";\n timestamp: string;\n}\n\nexport default (healthCheck: HealthCheck, sendHeader: boolean \| undefined = true) =>\n async <Request extends IncomingMessage, Response extends ServerResponse>(_: Request, response: Response): Promise<void> => {\n const { healthy, report } = await healthCheck.getReport();\n\n const payload: HealthCheckApiPayload = {\n appName: process.env[\"APP_NAME\"] ?? \"unknown\",\n appVersion: process.env[\"APP_VERSION\"] ?? \"unknown\",\n message: healthy ? \"Health check successful\" : \"Health check failed\",\n reports: report,\n status: healthy ? \"ok\" : \"error\",\n timestamp: new Date().toISOString(),\n };\n\n response.statusCode = healthy ? StatusCodes.OK : StatusCodes.SERVICE_UNAVAILABLE;\n\n if (sendHeader) {\n response.setHeader(\"Content-Type\", \"application/json\");\n }\n\n response.end(JSON.stringify(payload, null, 2));\n };\n","import { StatusCodes } from \"http-status-codes\";\nimport type { IncomingMessage, ServerResponse } from \"node:http\";\n\nimport type { HealthCheck } from \"../types\";\n\nexport default <Request extends IncomingMessage, Response extends ServerResponse>(healthCheck: HealthCheck) =>\n async (_request: Request, response: Response): Promise<void> => {\n const { healthy } = await healthCheck.getReport();\n\n response.statusCode = healthy ? StatusCodes.NO_CONTENT : StatusCodes.SERVICE_UNAVAILABLE;\n response.end();\n };\n","import type { Checker, HealthReport, HealthReportEntry, HealthCheck as HealthcheckInterface } from \"./types.d\";\n\nclass Healthcheck implements HealthcheckInterface {\n /\n A copy of registered checkers\n /\n private healthCheckers: Record<string, Checker> = {};\n\n /\n Invokes a given checker to collect the report metrics.\n /\n private async invokeChecker(service: string, reportSheet: HealthReport): Promise<boolean> {\n // eslint-disable-next-line security/detect-object-injection\n const checker = this.healthCheckers[service] as Checker;\n\n let report: HealthReportEntry;\n\n try {\n report = await checker();\n\n report.displayName = report.displayName \|\| service;\n } catch (error) {\n report = {\n displayName: service,\n health: { healthy: false, message: (error as Error).message, timestamp: new Date().toISOString() },\n meta: { fatal: true },\n };\n }\n\n // eslint-disable-next-line no-param-reassign,security/detect-object-injection\n reportSheet[service] = report;\n\n return report.health.healthy;\n }\n\n public addChecker(service: string, checker: Checker): void {\n // eslint-disable-next-line security/detect-object-injection\n this.healthCheckers[service] = checker;\n }\n\n /\n Returns the health check reports. The health checks are performed when\n * this method is invoked.\n /\n public async getReport(): Promise<{ healthy: boolean; report: HealthReport }> {\n const report: HealthReport = {};\n\n // eslint-disable-next-line compat/compat\n await Promise.all(Object.keys(this.healthCheckers).map(async (service) => await this.invokeChecker(service, report)));\n\n /\n Finding unhealthy service to know if system is healthy or not\n /\n // eslint-disable-next-line security/detect-object-injection\n const unhealthyService = Object.keys(report).find((service) => !(report[service] as HealthReportEntry).health.healthy);\n\n return { healthy: !unhealthyService, report };\n }\n\n public async isLive(): Promise<boolean> {\n const { healthy } = await this.getReport();\n\n return healthy;\n }\n\n /\n Returns an array of registered services names\n */\n public get servicesList(): string[] {\n return Object.keys(this.healthCheckers);\n }\n}\n\nexport default Healthcheck;\n"]}

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
     "name": "@visulima/health-check",
-    "version": "1.0.6",
+    "version": "1.0.8",
     "description": "A library built to provide support for defining service health for node services. It allows you to register async health checks for your dependencies and the service itself, provides a health endpoint that exposes their status, and health metrics.",
     "keywords": [
         "anolilab",
@@ -61,8 +61,11 @@
         "clean": "rimraf node_modules dist .eslintcache",
         "coverage": "vitest run --coverage",
         "dev": "pnpm run build --watch",
-        "lint:eslint": "cross-env NO_LOGS=true eslint . --ext js,jsx,ts,tsx --max-warnings=0 --config .eslintrc.cjs --cache --cache-strategy content .",
+        "lint:eslint": "eslint . --ext js,jsx,ts,tsx --max-warnings=0 --config .eslintrc.js --cache --cache-strategy content .",
         "lint:eslint:fix": "pnpm run lint:eslint --fix",
+        "lint:prettier": "prettier --config=.prettierrc.js --check .",
+        "lint:prettier:fix": "prettier --config=.prettierrc.js --write .",
+        "lint:types": "tsc --noEmit",
         "test": "vitest run",
         "test:watch": "vitest"
     },
@@ -72,51 +75,29 @@
         "pingman": "^2.0.0"
     },
     "devDependencies": {
-        "@anolilab/eslint-config": "^5.0.5",
-        "@anolilab/semantic-release-preset": "^2.2.1",
+        "@anolilab/eslint-config": "^10.0.6",
+        "@anolilab/prettier-config": "^5.0.1",
+        "@anolilab/semantic-release-preset": "^6.0.2",
         "@rushstack/eslint-plugin-security": "^0.6.0",
-        "@types/node": "18.16.16",
-        "@types/react": "^18.2.8",
-        "@types/react-dom": "^18.2.4",
-        "@typescript-eslint/eslint-plugin": "^5.59.9",
-        "@typescript-eslint/parser": "^5.59.9",
-        "@vitest/coverage-v8": "^0.32.0",
+        "@types/node": "18.16.18",
+        "@vitest/coverage-v8": "^0.33.0",
         "cross-env": "^7.0.3",
-        "cross-fetch": "^3.1.6",
-        "eslint": "^8.42.0",
-        "eslint-plugin-compat": "^4.1.4",
-        "eslint-plugin-eslint-comments": "^3.2.0",
-        "eslint-plugin-import": "^2.27.5",
-        "eslint-plugin-json": "^3.1.0",
-        "eslint-plugin-jsonc": "^2.8.0",
-        "eslint-plugin-jsx-a11y": "^6.7.1",
-        "eslint-plugin-markdown": "^3.0.0",
-        "eslint-plugin-no-loops": "^0.3.0",
-        "eslint-plugin-no-secrets": "^0.8.9",
-        "eslint-plugin-node": "^11.1.0",
-        "eslint-plugin-optimize-regex": "^1.2.1",
-        "eslint-plugin-promise": "^6.1.1",
-        "eslint-plugin-react": "7.32.2",
-        "eslint-plugin-react-hooks": "4.6.0",
-        "eslint-plugin-simple-import-sort": "^10.0.0",
-        "eslint-plugin-sort-keys-fix": "^1.1.2",
-        "eslint-plugin-testing-library": "^5.11.0",
-        "eslint-plugin-unicorn": "^47.0.0",
-        "eslint-plugin-you-dont-need-lodash-underscore": "^6.12.0",
-        "eslint-plugin-you-dont-need-momentjs": "^1.6.0",
-        "next": "^13.4.4",
+        "cross-fetch": "^4.0.0",
+        "eslint": "^8.45.0",
+        "eslint-plugin-etc": "^2.0.3",
+        "eslint-plugin-mdx": "^2.1.0",
+        "eslint-plugin-vitest": "^0.2.6",
+        "next": "^13.4.6",
         "node-mocks-http": "^1.12.2",
-        "prettier": "^2.8.8",
-        "react": "^18.2.0",
-        "react-dom": "^18.2.0",
+        "prettier": "^3.0.0",
         "rimraf": "^5.0.1",
-        "semantic-release": "^21.0.3",
-        "tsup": "^6.7.0",
-        "typescript": "^5.1.3",
-        "vitest": "^0.32.0"
+        "semantic-release": "^21.0.7",
+        "tsup": "^7.1.0",
+        "typescript": "^5.1.6",
+        "vitest": "^0.33.0"
     },
     "optionalDependencies": {
-        "next": "^13.4.4"
+        "next": "^13.4.5"
     },
     "engines": {
         "node": ">=16.18.0 <=20.*"
@@ -124,5 +105,16 @@
     "publishConfig": {
         "access": "public",
         "provenance": true
+    },
+    "anolilab": {
+        "eslint-config": {
+            "plugin": {
+                "tsdoc": false
+            },
+            "warn_on_unsupported_typescript_version": false,
+            "info_on_disabling_jsx_react_rule": false,
+            "info_on_disabling_prettier_conflict_rule": false,
+            "info_on_disabling_jsonc_sort_keys_rule": false
+        }
     }
 }