@lokalise/fastify-extras 30.0.0 → 30.2.0

package/README.md

@@ -7,6 +7,8 @@ Reusable plugins for Fastify.
 
   - [RequestContext Provider Plugin](#requestcontext-provider-plugin)
   - [Public Healthcheck Plugin](#public-healthcheck-plugin)
+  - [Common Healthcheck Plugin](#common-healthcheck-plugin)
+  - [Common Sync Healthcheck Plugin](#common-sync-healthcheck-plugin)
   - [Split IO Plugin](#split-io-plugin)
   - [BugSnag Plugin](#bugsnag-plugin)
   - [Metrics Plugin](#metrics-plugin)
@@ -72,7 +74,7 @@ Your Fastify app will reply with the status of the app when hitting the `GET /`
 
 ### Common Healthcheck Plugin
 
-Plugin to monitor app status through public and private healthchecks.
+Plugin to monitor app status through public and private healthchecks using asynchronous checks.
 
 Add the plugin to your Fastify instance by registering it with the following options:
 
@@ -89,9 +91,77 @@ Your Fastify app will reply with the status of the app when hitting the `GET /`
 }
 ```
 
+Your Fastify app will reply with the status of the app when hitting the `GET /health` private route with detailed results from healthchecks provided, example:
+```json
+{
+  "heartbeat": "PARTIALLY_HEALTHY",
+  "checks": {
+    "check1": "HEALTHY",
+    "check2": "HEALTHY",
+    "check3": "FAIL"
+  }
+}
+```
 
+### Common Sync Healthcheck Plugin
 
-Your Fastify app will reply with the status of the app when hitting the `GET /health` private route with detailed results from healthchecks provided, example:
+Plugin to monitor app status through public and private healthchecks using synchronous checks. **This plugin is recommended when you have healthchecks that run synchronously or are executed in the background**, as it provides better performance for such use cases.
+
+Add the plugin to your Fastify instance by registering it with the following options:
+
+- `healthChecks`, an array of synchronous healthcheck objects, each containing:
+  - `name`, the identifier for the healthcheck;
+  - `isMandatory`, boolean indicating if this healthcheck is critical for service health;
+  - `checker`, a synchronous function that returns `null` on success or an `Error` on failure;
+- `responsePayload` (optional), the response payload that the healthcheck should return;
+- `logLevel` (optional), the log level for the healthcheck routes ('fatal' | 'error' | 'warn' | 'info' | 'debug' | 'trace' | 'silent'), defaults to 'info';
+- `infoProviders` (optional), an array of info providers to include additional metadata in the `/health` response;
+- `isRootRouteEnabled` (optional), whether to enable the public `/` route, defaults to `true`.
+
+Example usage:
+```typescript
+import { commonSyncHealthcheckPlugin } from '@lokalise/fastify-extras'
+
+app.register(commonSyncHealthcheckPlugin, {
+  healthChecks: [
+    {
+      name: 'database',
+      isMandatory: true,
+      checker: (app) => {
+        // Synchronous check - returns null if healthy, Error if not
+        return isDatabaseConnected() ? null : new Error('Database disconnected')
+      }
+    },
+    {
+      name: 'cache',
+      isMandatory: false,  // Optional dependency
+      checker: (app) => {
+        return isCacheAvailable() ? null : new Error('Cache unavailable')
+      }
+    }
+  ]
+})
+```
+
+The plugin exposes the same routes as the async Common Healthcheck Plugin:
+- `GET /` - Public route returning aggregated health status
+- `GET /health` - Private route with detailed healthcheck results
+
+The key differences from the async version:
+- Uses synchronous healthcheck functions instead of promises
+- Better suited for checks that are already running in the background or are inherently synchronous
+- Supports mandatory vs optional healthchecks (optional failures result in `PARTIALLY_HEALTHY` status)
+
+### Startup Healthcheck Plugin
+
+Plugin to monitor app startup status, doing potentially more expensive checks than what is reasonable through periodic healthchecks.
+
+Add the plugin to your Fastify instance by registering it with the following options:
+
+- `healthChecks`, a list of asynchronous healthchecks to run at the app startup;
+- `resultsLogLevel`, at what log level to report healthcheck results - default is INFO;
+
+This is the structure of the log:
 ```json
 {
   "heartbeat": "PARTIALLY_HEALTHY",
@@ -103,6 +173,14 @@ Your Fastify app will reply with the status of the app when hitting the `GET /he
 }
 ```
 
+In case a non-optional healthcheck fails, an application startup will throw an error. In order to ensure that the error is thrown correctly, make sure to await the app startup:
+
+```ts
+  const app = fastify()
+  await app.register(startupHealthcheckPlugin, opts)
+  await app.ready()
+```
+
 ### Split IO Plugin
 
 Plugin to handle feature flags in Split IO.

package/dist/index.d.ts

@@ -18,9 +18,13 @@ export type { ErrorObjectResolver, MetricsPluginOptions, } from './plugins/metri
 export { publicHealthcheckPlugin } from './plugins/healthcheck/publicHealthcheckPlugin.js';
 export type { PublicHealthcheckPluginOptions, HealthCheck, InfoProvider, } from './plugins/healthcheck/publicHealthcheckPlugin.js';
 export { wrapHealthCheck } from './plugins/healthcheck/healthcheckCommons.js';
-export type { HealthChecker } from './plugins/healthcheck/healthcheckCommons.js';
+export type { HealthChecker, HealthCheckerSync } from './plugins/healthcheck/healthcheckCommons.js';
 export { commonHealthcheckPlugin } from './plugins/healthcheck/commonHealthcheckPlugin.js';
 export type { CommonHealthcheckPluginOptions } from './plugins/healthcheck/commonHealthcheckPlugin.js';
+export { startupHealthcheckPlugin } from './plugins/healthcheck/startupHealthcheckPlugin.js';
+export type { StartupHealthcheckPluginOptions } from './plugins/healthcheck/startupHealthcheckPlugin.js';
+export { commonSyncHealthcheckPlugin } from './plugins/healthcheck/commonSyncHealthcheckPlugin.ts';
+export type { CommonSyncHealthcheckPluginOptions } from './plugins/healthcheck/commonSyncHealthcheckPlugin.ts';
 export { amplitudePlugin, type AmplitudeConfig, type CreateApiTrackingEventFn, } from './plugins/amplitude/amplitudePlugin.js';
 export { Amplitude } from './plugins/amplitude/Amplitude.js';
 export { AmplitudeAdapter, AMPLITUDE_BASE_MESSAGE_SCHEMA, type AmplitudeMessage, type AmplitudeAdapterDependencies, } from './plugins/amplitude/AmplitudeAdapter.js';

package/dist/index.js

@@ -10,6 +10,8 @@ export { metricsPlugin } from './plugins/metricsPlugin.js';
 export { publicHealthcheckPlugin } from './plugins/healthcheck/publicHealthcheckPlugin.js';
 export { wrapHealthCheck } from './plugins/healthcheck/healthcheckCommons.js';
 export { commonHealthcheckPlugin } from './plugins/healthcheck/commonHealthcheckPlugin.js';
+export { startupHealthcheckPlugin } from './plugins/healthcheck/startupHealthcheckPlugin.js';
+export { commonSyncHealthcheckPlugin } from "./plugins/healthcheck/commonSyncHealthcheckPlugin.js";
 export { amplitudePlugin, } from './plugins/amplitude/amplitudePlugin.js';
 export { Amplitude } from './plugins/amplitude/Amplitude.js';
 export { AmplitudeAdapter, AMPLITUDE_BASE_MESSAGE_SCHEMA, } from './plugins/amplitude/AmplitudeAdapter.js';

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../lib/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,aAAa,EACb,oBAAoB,EACpB,oBAAoB,EACpB,cAAc,GACf,MAAM,4BAA4B,CAAA;AAGnC,OAAO,EACL,4BAA4B,EAC5B,4BAA4B,GAC7B,MAAM,2CAA2C,CAAA;AAGlD,OAAO,EACL,gCAAgC,EAChC,0BAA0B,GAC3B,MAAM,+CAA+C,CAAA;AAGtD,OAAO,EACL,2BAA2B,EAC3B,qBAAqB,GACtB,MAAM,0CAA0C,CAAA;AAGjD,OAAO,EACL,wBAAwB,EACxB,4BAA4B,GAC7B,MAAM,mDAAmD,CAAA;AAO1D,OAAO,EAAE,mCAAmC,EAAE,MAAM,6DAA6D,CAAA;AAEjH,OAAO,EAAE,mBAAmB,EAAE,MAAM,kCAAkC,CAAA;AAEtE,OAAO,EACL,yBAAyB,EACzB,kCAAkC,GACnC,MAAM,+CAA+C,CAAA;AAGtD,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAA;AAM1D,OAAO,EAAE,uBAAuB,EAAE,MAAM,kDAAkD,CAAA;AAO1F,OAAO,EAAE,eAAe,EAAE,MAAM,6CAA6C,CAAA;AAG7E,OAAO,EAAE,uBAAuB,EAAE,MAAM,kDAAkD,CAAA;AAG1F,OAAO,EACL,eAAe,GAGhB,MAAM,wCAAwC,CAAA;AAC/C,OAAO,EAAE,SAAS,EAAE,MAAM,kCAAkC,CAAA;AAC5D,OAAO,EACL,gBAAgB,EAChB,6BAA6B,GAG9B,MAAM,yCAAyC,CAAA;AAIhD,OAAO,EAAE,wBAAwB,EAAE,MAAM,uCAAuC,CAAA;AAEhF,OAAO,EACL,wBAAwB,EACxB,yBAAyB,GAC1B,MAAM,uCAAuC,CAAA;AAG9C,OAAO,EAAE,kBAAkB,EAAE,UAAU,EAA4B,MAAM,0BAA0B,CAAA;AAGnG,OAAO,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAA;AAE5E,OAAO,EAAE,+BAA+B,EAAE,MAAM,kCAAkC,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../lib/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,aAAa,EACb,oBAAoB,EACpB,oBAAoB,EACpB,cAAc,GACf,MAAM,4BAA4B,CAAA;AAGnC,OAAO,EACL,4BAA4B,EAC5B,4BAA4B,GAC7B,MAAM,2CAA2C,CAAA;AAGlD,OAAO,EACL,gCAAgC,EAChC,0BAA0B,GAC3B,MAAM,+CAA+C,CAAA;AAGtD,OAAO,EACL,2BAA2B,EAC3B,qBAAqB,GACtB,MAAM,0CAA0C,CAAA;AAGjD,OAAO,EACL,wBAAwB,EACxB,4BAA4B,GAC7B,MAAM,mDAAmD,CAAA;AAO1D,OAAO,EAAE,mCAAmC,EAAE,MAAM,6DAA6D,CAAA;AAEjH,OAAO,EAAE,mBAAmB,EAAE,MAAM,kCAAkC,CAAA;AAEtE,OAAO,EACL,yBAAyB,EACzB,kCAAkC,GACnC,MAAM,+CAA+C,CAAA;AAGtD,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAA;AAM1D,OAAO,EAAE,uBAAuB,EAAE,MAAM,kDAAkD,CAAA;AAO1F,OAAO,EAAE,eAAe,EAAE,MAAM,6CAA6C,CAAA;AAG7E,OAAO,EAAE,uBAAuB,EAAE,MAAM,kDAAkD,CAAA;AAG1F,OAAO,EAAE,wBAAwB,EAAE,MAAM,mDAAmD,CAAA;AAG5F,OAAO,EAAE,2BAA2B,EAAE,MAAM,sDAAsD,CAAA;AAGlG,OAAO,EACL,eAAe,GAGhB,MAAM,wCAAwC,CAAA;AAC/C,OAAO,EAAE,SAAS,EAAE,MAAM,kCAAkC,CAAA;AAC5D,OAAO,EACL,gBAAgB,EAChB,6BAA6B,GAG9B,MAAM,yCAAyC,CAAA;AAIhD,OAAO,EAAE,wBAAwB,EAAE,MAAM,uCAAuC,CAAA;AAEhF,OAAO,EACL,wBAAwB,EACxB,yBAAyB,GAC1B,MAAM,uCAAuC,CAAA;AAG9C,OAAO,EAAE,kBAAkB,EAAE,UAAU,EAA4B,MAAM,0BAA0B,CAAA;AAGnG,OAAO,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAA;AAE5E,OAAO,EAAE,+BAA+B,EAAE,MAAM,kCAAkC,CAAA"}

package/dist/plugins/healthcheck/commonHealthcheckPlugin.d.ts

@@ -1,3 +1,4 @@
+import type { Either } from '@lokalise/node-core';
 import type { FastifyPluginCallback } from 'fastify';
 import type { HealthChecker } from './healthcheckCommons.js';
 export interface CommonHealthcheckPluginOptions {
@@ -7,6 +8,16 @@ export interface CommonHealthcheckPluginOptions {
     infoProviders?: readonly InfoProvider[];
     isRootRouteEnabled?: boolean;
 }
+type HealthcheckResult = {
+    name: string;
+    isMandatory: boolean;
+    result: Either<Error, true>;
+};
+type ResolvedHealthcheckResponse = {
+    isFullyHealthy: boolean;
+    isPartiallyHealthy: boolean;
+    healthChecks: Record<string, string>;
+};
 export type InfoProvider = {
     name: string;
     dataResolver: () => Record<string, unknown>;
@@ -16,4 +27,6 @@ export type HealthCheck = {
     isMandatory: boolean;
     checker: HealthChecker;
 };
+export declare function resolveHealthcheckResults(results: HealthcheckResult[], opts: CommonHealthcheckPluginOptions): ResolvedHealthcheckResponse;
 export declare const commonHealthcheckPlugin: FastifyPluginCallback<CommonHealthcheckPluginOptions>;
+export {};

package/dist/plugins/healthcheck/commonHealthcheckPlugin.js

@@ -1,5 +1,5 @@
 import fp from 'fastify-plugin';
-function resolveHealthcheckResults(results, opts) {
+export function resolveHealthcheckResults(results, opts) {
     const healthChecks = {};
     let isFullyHealthy = true;
     let isPartiallyHealthy = false;

package/dist/plugins/healthcheck/commonHealthcheckPlugin.js.map

@@ -1 +1 @@
-{"version":3,"file":"commonHealthcheckPlugin.js","sourceRoot":"","sources":["../../../lib/plugins/healthcheck/commonHealthcheckPlugin.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,MAAM,gBAAgB,CAAA;AAwC/B,SAAS,yBAAyB,CAChC,OAA4B,EAC5B,IAAoC;IAEpC,MAAM,YAAY,GAA2B,EAAE,CAAA;IAC/C,IAAI,cAAc,GAAG,IAAI,CAAA;IACzB,IAAI,kBAAkB,GAAG,KAAK,CAAA;IAE9B,sCAAsC;IACtC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACxC,MAAM,KAAK,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;QACxB,IAAI,CAAC,KAAK;YAAE,SAAQ;QAEpB,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAA;QAClE,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,IAAI,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,CAAC;YAC5D,cAAc,GAAG,KAAK,CAAA;YACtB,kBAAkB,GAAG,KAAK,CAAA;QAC5B,CAAC;QAED,kFAAkF;QAClF,IAAI,cAAc,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,CAAC;YAC/E,cAAc,GAAG,KAAK,CAAA;YACtB,kBAAkB,GAAG,IAAI,CAAA;QAC3B,CAAC;IACH,CAAC;IAED,OAAO;QACL,cAAc;QACd,kBAAkB;QAClB,YAAY;KACb,CAAA;AACH,CAAC;AAED,SAAS,QAAQ,CACf,GAAuB,EACvB,IAAoC,EACpC,SAAkC;IAElC,MAAM,eAAe,GAAG,IAAI,CAAC,eAAe,IAAI,EAAE,CAAA;IAElD,GAAG,CAAC,KAAK,CAAC;QACR,GAAG,EAAE,SAAS,CAAC,GAAG;QAClB,MAAM,EAAE,KAAK;QACb,QAAQ,EAAE,IAAI,CAAC,QAAQ,IAAI,MAAM;QACjC,MAAM,EAAE;YACN,kCAAkC;YAClC,IAAI,EAAE,IAAI;SACX;QAED,OAAO,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE;YAC1B,IAAI,cAAc,GAAG,IAAI,CAAA;YACzB,IAAI,kBAAkB,GAAG,KAAK,CAAA;YAC9B,IAAI,YAAY,GAA2B,EAAE,CAAA;YAE7C,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC;gBAC7B,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,CAC/B,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,KAAK,EAAE,WAAW,EAAE,EAAE;oBAC1C,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;oBAC7C,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;wBACjB,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,EAAE,GAAG,WAAW,CAAC,IAAI,yBAAyB,CAAC,CAAA;oBAC3E,CAAC;oBACD,OAAO;wBACL,IAAI,EAAE,WAAW,CAAC,IAAI;wBACtB,MAAM;wBACN,WAAW,EAAE,WAAW,CAAC,WAAW;qBACrC,CAAA;gBACH,CAAC,CAAC,CACH,CAAA;gBAED,MAAM,2BAA2B,GAAG,yBAAyB,CAAC,OAAO,EAAE,IAAI,CAAC,CAAA;gBAC5E,YAAY,GAAG,2BAA2B,CAAC,YAAY,CAAA;gBACvD,cAAc,GAAG,2BAA2B,CAAC,cAAc,CAAA;gBAC3D,kBAAkB,GAAG,2BAA2B,CAAC,kBAAkB,CAAA;YACrE,CAAC;YAED,MAAM,SAAS,GAAG,IAAI,CAAC,aAAa,EAAE,GAAG,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;gBAC3D,IAAI,EAAE,YAAY,CAAC,IAAI;gBACvB,KAAK,EAAE,YAAY,CAAC,YAAY,EAAE;aACnC,CAAC,CAAC,CAAA;YAEH,MAAM,SAAS,GAAG,cAAc;gBAC9B,CAAC,CAAC,SAAS;gBACX,CAAC,CAAC,kBAAkB;oBAClB,CAAC,CAAC,mBAAmB;oBACrB,CAAC,CAAC,MAAM,CAAA;YAEZ,MAAM,QAAQ,GAAG;gBACf,GAAG,eAAe;gBAClB,SAAS;gBACT,GAAG,CAAC,SAAS,CAAC,aAAa;oBACzB,CAAC,CAAC,EAAE;oBACJ,CAAC,CAAC,EAAE,MAAM,EAAE,YAAY,EAAE,GAAG,CAAC,SAAS,IAAI,EAAE,SAAS,EAAE,CAAC,EAAE,CAAC;aAC/D,CAAA;YAED,OAAO,KAAK,CAAC,MAAM,CAAC,cAAc,IAAI,kBAAkB,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;QACtF,CAAC;KACF,CAAC,CAAA;AACJ,CAAC;AAED,MAAM,MAAM,GAA0D,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE;IACxF,MAAM,kBAAkB,GAAG,IAAI,CAAC,kBAAkB,IAAI,IAAI,CAAA;IAE1D,IAAI,kBAAkB,EAAE,CAAC;QACvB,QAAQ,CAAC,GAAG,EAAE,IAAI,EAAE;YAClB,GAAG,EAAE,GAAG;YACR,aAAa,EAAE,IAAI;SACpB,CAAC,CAAA;IACJ,CAAC;IAED,QAAQ,CAAC,GAAG,EAAE,IAAI,EAAE;QAClB,GAAG,EAAE,SAAS;QACd,aAAa,EAAE,KAAK;KACrB,CAAC,CAAA;IAEF,IAAI,EAAE,CAAA;AACR,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,uBAAuB,GAAG,EAAE,CAAC,MAAM,EAAE;IAChD,OAAO,EAAE,KAAK;IACd,IAAI,EAAE,2BAA2B;CAClC,CAAC,CAAA"}
+{"version":3,"file":"commonHealthcheckPlugin.js","sourceRoot":"","sources":["../../../lib/plugins/healthcheck/commonHealthcheckPlugin.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,MAAM,gBAAgB,CAAA;AAwC/B,MAAM,UAAU,yBAAyB,CACvC,OAA4B,EAC5B,IAAoC;IAEpC,MAAM,YAAY,GAA2B,EAAE,CAAA;IAC/C,IAAI,cAAc,GAAG,IAAI,CAAA;IACzB,IAAI,kBAAkB,GAAG,KAAK,CAAA;IAE9B,sCAAsC;IACtC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACxC,MAAM,KAAK,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;QACxB,IAAI,CAAC,KAAK;YAAE,SAAQ;QAEpB,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAA;QAClE,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,IAAI,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,CAAC;YAC5D,cAAc,GAAG,KAAK,CAAA;YACtB,kBAAkB,GAAG,KAAK,CAAA;QAC5B,CAAC;QAED,kFAAkF;QAClF,IAAI,cAAc,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,CAAC;YAC/E,cAAc,GAAG,KAAK,CAAA;YACtB,kBAAkB,GAAG,IAAI,CAAA;QAC3B,CAAC;IACH,CAAC;IAED,OAAO;QACL,cAAc;QACd,kBAAkB;QAClB,YAAY;KACb,CAAA;AACH,CAAC;AAED,SAAS,QAAQ,CACf,GAAuB,EACvB,IAAoC,EACpC,SAAkC;IAElC,MAAM,eAAe,GAAG,IAAI,CAAC,eAAe,IAAI,EAAE,CAAA;IAElD,GAAG,CAAC,KAAK,CAAC;QACR,GAAG,EAAE,SAAS,CAAC,GAAG;QAClB,MAAM,EAAE,KAAK;QACb,QAAQ,EAAE,IAAI,CAAC,QAAQ,IAAI,MAAM;QACjC,MAAM,EAAE;YACN,kCAAkC;YAClC,IAAI,EAAE,IAAI;SACX;QAED,OAAO,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE;YAC1B,IAAI,cAAc,GAAG,IAAI,CAAA;YACzB,IAAI,kBAAkB,GAAG,KAAK,CAAA;YAC9B,IAAI,YAAY,GAA2B,EAAE,CAAA;YAE7C,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC;gBAC7B,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,CAC/B,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,KAAK,EAAE,WAAW,EAAE,EAAE;oBAC1C,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;oBAC7C,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;wBACjB,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,EAAE,GAAG,WAAW,CAAC,IAAI,yBAAyB,CAAC,CAAA;oBAC3E,CAAC;oBACD,OAAO;wBACL,IAAI,EAAE,WAAW,CAAC,IAAI;wBACtB,MAAM;wBACN,WAAW,EAAE,WAAW,CAAC,WAAW;qBACrC,CAAA;gBACH,CAAC,CAAC,CACH,CAAA;gBAED,MAAM,2BAA2B,GAAG,yBAAyB,CAAC,OAAO,EAAE,IAAI,CAAC,CAAA;gBAC5E,YAAY,GAAG,2BAA2B,CAAC,YAAY,CAAA;gBACvD,cAAc,GAAG,2BAA2B,CAAC,cAAc,CAAA;gBAC3D,kBAAkB,GAAG,2BAA2B,CAAC,kBAAkB,CAAA;YACrE,CAAC;YAED,MAAM,SAAS,GAAG,IAAI,CAAC,aAAa,EAAE,GAAG,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;gBAC3D,IAAI,EAAE,YAAY,CAAC,IAAI;gBACvB,KAAK,EAAE,YAAY,CAAC,YAAY,EAAE;aACnC,CAAC,CAAC,CAAA;YAEH,MAAM,SAAS,GAAG,cAAc;gBAC9B,CAAC,CAAC,SAAS;gBACX,CAAC,CAAC,kBAAkB;oBAClB,CAAC,CAAC,mBAAmB;oBACrB,CAAC,CAAC,MAAM,CAAA;YAEZ,MAAM,QAAQ,GAAG;gBACf,GAAG,eAAe;gBAClB,SAAS;gBACT,GAAG,CAAC,SAAS,CAAC,aAAa;oBACzB,CAAC,CAAC,EAAE;oBACJ,CAAC,CAAC,EAAE,MAAM,EAAE,YAAY,EAAE,GAAG,CAAC,SAAS,IAAI,EAAE,SAAS,EAAE,CAAC,EAAE,CAAC;aAC/D,CAAA;YAED,OAAO,KAAK,CAAC,MAAM,CAAC,cAAc,IAAI,kBAAkB,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;QACtF,CAAC;KACF,CAAC,CAAA;AACJ,CAAC;AAED,MAAM,MAAM,GAA0D,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE;IACxF,MAAM,kBAAkB,GAAG,IAAI,CAAC,kBAAkB,IAAI,IAAI,CAAA;IAE1D,IAAI,kBAAkB,EAAE,CAAC;QACvB,QAAQ,CAAC,GAAG,EAAE,IAAI,EAAE;YAClB,GAAG,EAAE,GAAG;YACR,aAAa,EAAE,IAAI;SACpB,CAAC,CAAA;IACJ,CAAC;IAED,QAAQ,CAAC,GAAG,EAAE,IAAI,EAAE;QAClB,GAAG,EAAE,SAAS;QACd,aAAa,EAAE,KAAK;KACrB,CAAC,CAAA;IAEF,IAAI,EAAE,CAAA;AACR,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,uBAAuB,GAAG,EAAE,CAAC,MAAM,EAAE;IAChD,OAAO,EAAE,KAAK;IACd,IAAI,EAAE,2BAA2B;CAClC,CAAC,CAAA"}

package/dist/plugins/healthcheck/commonSyncHealthcheckPlugin.d.ts

@@ -0,0 +1,19 @@
+import type { FastifyPluginCallback } from 'fastify';
+import type { HealthCheckerSync } from './healthcheckCommons.js';
+export interface CommonSyncHealthcheckPluginOptions {
+    responsePayload?: Record<string, unknown>;
+    logLevel?: 'fatal' | 'error' | 'warn' | 'info' | 'debug' | 'trace' | 'silent';
+    healthChecks: readonly HealthCheckSync[];
+    infoProviders?: readonly InfoProvider[];
+    isRootRouteEnabled?: boolean;
+}
+export type InfoProvider = {
+    name: string;
+    dataResolver: () => Record<string, unknown>;
+};
+export type HealthCheckSync = {
+    name: string;
+    isMandatory: boolean;
+    checker: HealthCheckerSync;
+};
+export declare const commonSyncHealthcheckPlugin: FastifyPluginCallback<CommonSyncHealthcheckPluginOptions>;

package/dist/plugins/healthcheck/commonSyncHealthcheckPlugin.js

@@ -0,0 +1,97 @@
+import fp from 'fastify-plugin';
+function resolveHealthcheckResults(results, opts) {
+    const healthChecks = {};
+    let isFullyHealthy = true;
+    let isPartiallyHealthy = false;
+    // Return detailed healthcheck results
+    for (let i = 0; i < results.length; i++) {
+        const entry = results[i];
+        if (!entry)
+            continue;
+        healthChecks[entry.name] = entry.healthcheckError ? 'FAIL' : 'HEALTHY';
+        if (entry.healthcheckError && opts.healthChecks[i]?.isMandatory) {
+            isFullyHealthy = false;
+            isPartiallyHealthy = false;
+        }
+        // Check if we are only partially healthy (only optional dependencies are failing)
+        if (isFullyHealthy && entry.healthcheckError && !opts.healthChecks[i]?.isMandatory) {
+            isFullyHealthy = false;
+            isPartiallyHealthy = true;
+        }
+    }
+    return {
+        isFullyHealthy,
+        isPartiallyHealthy,
+        healthChecks,
+    };
+}
+function addRoute(app, opts, routeOpts) {
+    const responsePayload = opts.responsePayload ?? {};
+    app.route({
+        url: routeOpts.url,
+        method: 'GET',
+        logLevel: opts.logLevel ?? 'info',
+        schema: {
+            // hide route from swagger plugins
+            hide: true,
+        },
+        handler: (_, reply) => {
+            let isFullyHealthy = true;
+            let isPartiallyHealthy = false;
+            let healthChecks = {};
+            if (opts.healthChecks.length) {
+                const results = opts.healthChecks.map((healthcheck) => {
+                    const healthcheckError = healthcheck.checker(app);
+                    if (healthcheckError) {
+                        app.log.error(healthcheckError, `${healthcheck.name} healthcheck has failed`);
+                    }
+                    return {
+                        name: healthcheck.name,
+                        healthcheckError,
+                        isMandatory: healthcheck.isMandatory,
+                    };
+                });
+                const resolvedHealthcheckResponse = resolveHealthcheckResults(results, opts);
+                healthChecks = resolvedHealthcheckResponse.healthChecks;
+                isFullyHealthy = resolvedHealthcheckResponse.isFullyHealthy;
+                isPartiallyHealthy = resolvedHealthcheckResponse.isPartiallyHealthy;
+            }
+            const extraInfo = opts.infoProviders?.map((infoProvider) => ({
+                name: infoProvider.name,
+                value: infoProvider.dataResolver(),
+            }));
+            const heartbeat = isFullyHealthy
+                ? 'HEALTHY'
+                : isPartiallyHealthy
+                    ? 'PARTIALLY_HEALTHY'
+                    : 'FAIL';
+            const response = {
+                ...responsePayload,
+                heartbeat,
+                ...(routeOpts.isPublicRoute
+                    ? {}
+                    : { checks: healthChecks, ...(extraInfo && { extraInfo }) }),
+            };
+            return reply.status(isFullyHealthy || isPartiallyHealthy ? 200 : 500).send(response);
+        },
+    });
+}
+const plugin = (app, opts, done) => {
+    const isRootRouteEnabled = opts.isRootRouteEnabled ?? true;
+    if (isRootRouteEnabled) {
+        addRoute(app, opts, {
+            url: '/',
+            isPublicRoute: true,
+        });
+    }
+    addRoute(app, opts, {
+        url: '/health',
+        isPublicRoute: false,
+    });
+    done();
+};
+export const commonSyncHealthcheckPlugin = fp(plugin, {
+    fastify: '5.x',
+    name: 'common-sync-healthcheck-plugin',
+});
+//# sourceMappingURL=commonSyncHealthcheckPlugin.js.map

package/dist/plugins/healthcheck/commonSyncHealthcheckPlugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"commonSyncHealthcheckPlugin.js","sourceRoot":"","sources":["../../../lib/plugins/healthcheck/commonSyncHealthcheckPlugin.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,gBAAgB,CAAA;AAwC/B,SAAS,yBAAyB,CAChC,OAA4B,EAC5B,IAAwC;IAExC,MAAM,YAAY,GAA2B,EAAE,CAAA;IAC/C,IAAI,cAAc,GAAG,IAAI,CAAA;IACzB,IAAI,kBAAkB,GAAG,KAAK,CAAA;IAE9B,sCAAsC;IACtC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACxC,MAAM,KAAK,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;QACxB,IAAI,CAAC,KAAK;YAAE,SAAQ;QAEpB,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAA;QACtE,IAAI,KAAK,CAAC,gBAAgB,IAAI,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,CAAC;YAChE,cAAc,GAAG,KAAK,CAAA;YACtB,kBAAkB,GAAG,KAAK,CAAA;QAC5B,CAAC;QAED,kFAAkF;QAClF,IAAI,cAAc,IAAI,KAAK,CAAC,gBAAgB,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,CAAC;YACnF,cAAc,GAAG,KAAK,CAAA;YACtB,kBAAkB,GAAG,IAAI,CAAA;QAC3B,CAAC;IACH,CAAC;IAED,OAAO;QACL,cAAc;QACd,kBAAkB;QAClB,YAAY;KACb,CAAA;AACH,CAAC;AAED,SAAS,QAAQ,CACf,GAAuB,EACvB,IAAwC,EACxC,SAAkC;IAElC,MAAM,eAAe,GAAG,IAAI,CAAC,eAAe,IAAI,EAAE,CAAA;IAElD,GAAG,CAAC,KAAK,CAAC;QACR,GAAG,EAAE,SAAS,CAAC,GAAG;QAClB,MAAM,EAAE,KAAK;QACb,QAAQ,EAAE,IAAI,CAAC,QAAQ,IAAI,MAAM;QACjC,MAAM,EAAE;YACN,kCAAkC;YAClC,IAAI,EAAE,IAAI;SACX;QAED,OAAO,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE;YACpB,IAAI,cAAc,GAAG,IAAI,CAAA;YACzB,IAAI,kBAAkB,GAAG,KAAK,CAAA;YAC9B,IAAI,YAAY,GAA2B,EAAE,CAAA;YAE7C,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC;gBAC7B,MAAM,OAAO,GAAG,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,WAAW,EAAE,EAAE;oBACpD,MAAM,gBAAgB,GAAG,WAAW,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;oBACjD,IAAI,gBAAgB,EAAE,CAAC;wBACrB,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,gBAAgB,EAAE,GAAG,WAAW,CAAC,IAAI,yBAAyB,CAAC,CAAA;oBAC/E,CAAC;oBACD,OAAO;wBACL,IAAI,EAAE,WAAW,CAAC,IAAI;wBACtB,gBAAgB;wBAChB,WAAW,EAAE,WAAW,CAAC,WAAW;qBACrC,CAAA;gBACH,CAAC,CAAC,CAAA;gBAEF,MAAM,2BAA2B,GAAG,yBAAyB,CAAC,OAAO,EAAE,IAAI,CAAC,CAAA;gBAC5E,YAAY,GAAG,2BAA2B,CAAC,YAAY,CAAA;gBACvD,cAAc,GAAG,2BAA2B,CAAC,cAAc,CAAA;gBAC3D,kBAAkB,GAAG,2BAA2B,CAAC,kBAAkB,CAAA;YACrE,CAAC;YAED,MAAM,SAAS,GAAG,IAAI,CAAC,aAAa,EAAE,GAAG,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;gBAC3D,IAAI,EAAE,YAAY,CAAC,IAAI;gBACvB,KAAK,EAAE,YAAY,CAAC,YAAY,EAAE;aACnC,CAAC,CAAC,CAAA;YAEH,MAAM,SAAS,GAAG,cAAc;gBAC9B,CAAC,CAAC,SAAS;gBACX,CAAC,CAAC,kBAAkB;oBAClB,CAAC,CAAC,mBAAmB;oBACrB,CAAC,CAAC,MAAM,CAAA;YAEZ,MAAM,QAAQ,GAAG;gBACf,GAAG,eAAe;gBAClB,SAAS;gBACT,GAAG,CAAC,SAAS,CAAC,aAAa;oBACzB,CAAC,CAAC,EAAE;oBACJ,CAAC,CAAC,EAAE,MAAM,EAAE,YAAY,EAAE,GAAG,CAAC,SAAS,IAAI,EAAE,SAAS,EAAE,CAAC,EAAE,CAAC;aAC/D,CAAA;YAED,OAAO,KAAK,CAAC,MAAM,CAAC,cAAc,IAAI,kBAAkB,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;QACtF,CAAC;KACF,CAAC,CAAA;AACJ,CAAC;AAED,MAAM,MAAM,GAA8D,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE;IAC5F,MAAM,kBAAkB,GAAG,IAAI,CAAC,kBAAkB,IAAI,IAAI,CAAA;IAE1D,IAAI,kBAAkB,EAAE,CAAC;QACvB,QAAQ,CAAC,GAAG,EAAE,IAAI,EAAE;YAClB,GAAG,EAAE,GAAG;YACR,aAAa,EAAE,IAAI;SACpB,CAAC,CAAA;IACJ,CAAC;IAED,QAAQ,CAAC,GAAG,EAAE,IAAI,EAAE;QAClB,GAAG,EAAE,SAAS;QACd,aAAa,EAAE,KAAK;KACrB,CAAC,CAAA;IAEF,IAAI,EAAE,CAAA;AACR,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,2BAA2B,GAAG,EAAE,CAAC,MAAM,EAAE;IACpD,OAAO,EAAE,KAAK;IACd,IAAI,EAAE,gCAAgC;CACvC,CAAC,CAAA"}

package/dist/plugins/healthcheck/healthcheckCommons.d.ts

@@ -1,6 +1,10 @@
 import type { Either } from '@lokalise/node-core';
 import type { AnyFastifyInstance } from '../pluginsCommon.js';
 export type HealthChecker = (app: AnyFastifyInstance) => Promise<Either<Error, true>>;
+/**
+ * Returns error (if fail) or null (if pass)
+ */
+export type HealthCheckerSync = (app: AnyFastifyInstance) => Error | null;
 /**
  * Return a function which executes healthcheck and throws an error if it fails
  */

package/dist/plugins/healthcheck/healthcheckCommons.js.map

@@ -1 +1 @@
-{"version":3,"file":"healthcheckCommons.js","sourceRoot":"","sources":["../../../lib/plugins/healthcheck/healthcheckCommons.ts"],"names":[],"mappings":"AAKA;;GAEG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,GAAuB,EAAE,WAA0B,EAAE,EAAE;IACrF,OAAO,KAAK,IAAI,EAAE;QAChB,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,GAAG,CAAC,CAAA;QACvC,IAAI,QAAQ,CAAC,KAAK,EAAE,CAAC;YACnB,MAAM,QAAQ,CAAC,KAAK,CAAA;QACtB,CAAC;IACH,CAAC,CAAA;AACH,CAAC,CAAA"}
+{"version":3,"file":"healthcheckCommons.js","sourceRoot":"","sources":["../../../lib/plugins/healthcheck/healthcheckCommons.ts"],"names":[],"mappings":"AAUA;;GAEG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,GAAuB,EAAE,WAA0B,EAAE,EAAE;IACrF,OAAO,KAAK,IAAI,EAAE;QAChB,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,GAAG,CAAC,CAAA;QACvC,IAAI,QAAQ,CAAC,KAAK,EAAE,CAAC;YACnB,MAAM,QAAQ,CAAC,KAAK,CAAA;QACtB,CAAC;IACH,CAAC,CAAA;AACH,CAAC,CAAA"}

package/dist/plugins/healthcheck/publicHealthcheckPlugin.d.ts

@@ -16,4 +16,7 @@ export type HealthCheck = {
     isMandatory: boolean;
     checker: HealthChecker;
 };
+/**
+ * @deprecated use commonSyncHealthcheckPlugin instead
+ */
 export declare const publicHealthcheckPlugin: FastifyPluginCallback<PublicHealthcheckPluginOptions>;

package/dist/plugins/healthcheck/publicHealthcheckPlugin.js

@@ -61,6 +61,9 @@ function plugin(app, opts, done) {
     });
     done();
 }
+/**
+ * @deprecated use commonSyncHealthcheckPlugin instead
+ */
 export const publicHealthcheckPlugin = fp(plugin, {
     fastify: '5.x',
     name: 'public-healthcheck-plugin',

package/dist/plugins/healthcheck/publicHealthcheckPlugin.js.map

@@ -1 +1 @@
-{"version":3,"file":"publicHealthcheckPlugin.js","sourceRoot":"","sources":["../../../lib/plugins/healthcheck/publicHealthcheckPlugin.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,gBAAgB,CAAA;AAuB/B,SAAS,MAAM,CACb,GAAuB,EACvB,IAAoC,EACpC,IAAgB;IAEhB,MAAM,eAAe,GAAG,IAAI,CAAC,eAAe,IAAI,EAAE,CAAA;IAClD,GAAG,CAAC,KAAK,CAAC;QACR,GAAG,EAAE,IAAI,CAAC,GAAG,IAAI,SAAS;QAC1B,MAAM,EAAE,KAAK;QACb,QAAQ,EAAE,IAAI,CAAC,QAAQ,IAAI,MAAM;QACjC,MAAM,EAAE;YACN,kCAAkC;YAClC,IAAI,EAAE,IAAI;SACX;QAED,6EAA6E;QAC7E,OAAO,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE;YAC1B,IAAI,cAAc,GAAG,IAAI,CAAA;YACzB,IAAI,kBAAkB,GAAG,KAAK,CAAA;YAC9B,MAAM,YAAY,GAA4B,EAAE,CAAA;YAEhD,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC;gBAC7B,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,CAC/B,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,WAAW,EAAE,EAAE;oBACpC,OAAO,WAAW,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;wBAC9C,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;4BACjB,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,EAAE,GAAG,WAAW,CAAC,IAAI,yBAAyB,CAAC,CAAA;wBAC3E,CAAC;wBACD,OAAO;4BACL,IAAI,EAAE,WAAW,CAAC,IAAI;4BACtB,MAAM;4BACN,WAAW,EAAE,WAAW,CAAC,WAAW;yBACrC,CAAA;oBACH,CAAC,CAAC,CAAA;gBACJ,CAAC,CAAC,CACH,CAAA;gBAED,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;oBACxC,MAAM,KAAK,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;oBACxB,IAAI,CAAC,KAAK;wBAAE,SAAQ;oBAEpB,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAA;oBAClE,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,IAAI,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,CAAC;wBAC5D,cAAc,GAAG,KAAK,CAAA;wBACtB,kBAAkB,GAAG,KAAK,CAAA;oBAC5B,CAAC;oBAED,kFAAkF;oBAClF,IAAI,cAAc,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,CAAC;wBAC/E,cAAc,GAAG,KAAK,CAAA;wBACtB,kBAAkB,GAAG,IAAI,CAAA;oBAC3B,CAAC;gBACH,CAAC;YACH,CAAC;YAED,MAAM,SAAS,GAAG,IAAI,CAAC,aAAa;gBAClC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,YAAY,EAAE,EAAE;oBACtC,OAAO;wBACL,IAAI,EAAE,YAAY,CAAC,IAAI;wBACvB,KAAK,EAAE,YAAY,CAAC,YAAY,EAAE;qBACnC,CAAA;gBACH,CAAC,CAAC;gBACJ,CAAC,CAAC,SAAS,CAAA;YAEb,OAAO,KAAK,CAAC,MAAM,CAAC,cAAc,IAAI,kBAAkB,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;gBACzE,GAAG,eAAe;gBAClB,MAAM,EAAE,YAAY;gBACpB,GAAG,CAAC,SAAS,IAAI,EAAE,SAAS,EAAE,CAAC;gBAC/B,SAAS,EAAE,cAAc,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,MAAM;aAC1F,CAAC,CAAA;QACJ,CAAC;KACF,CAAC,CAAA;IACF,IAAI,EAAE,CAAA;AACR,CAAC;AAED,MAAM,CAAC,MAAM,uBAAuB,GAA0D,EAAE,CAC9F,MAAM,EACN;IACE,OAAO,EAAE,KAAK;IACd,IAAI,EAAE,2BAA2B;CAClC,CACF,CAAA"}
+{"version":3,"file":"publicHealthcheckPlugin.js","sourceRoot":"","sources":["../../../lib/plugins/healthcheck/publicHealthcheckPlugin.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,gBAAgB,CAAA;AAuB/B,SAAS,MAAM,CACb,GAAuB,EACvB,IAAoC,EACpC,IAAgB;IAEhB,MAAM,eAAe,GAAG,IAAI,CAAC,eAAe,IAAI,EAAE,CAAA;IAClD,GAAG,CAAC,KAAK,CAAC;QACR,GAAG,EAAE,IAAI,CAAC,GAAG,IAAI,SAAS;QAC1B,MAAM,EAAE,KAAK;QACb,QAAQ,EAAE,IAAI,CAAC,QAAQ,IAAI,MAAM;QACjC,MAAM,EAAE;YACN,kCAAkC;YAClC,IAAI,EAAE,IAAI;SACX;QAED,6EAA6E;QAC7E,OAAO,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE;YAC1B,IAAI,cAAc,GAAG,IAAI,CAAA;YACzB,IAAI,kBAAkB,GAAG,KAAK,CAAA;YAC9B,MAAM,YAAY,GAA4B,EAAE,CAAA;YAEhD,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC;gBAC7B,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,CAC/B,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,WAAW,EAAE,EAAE;oBACpC,OAAO,WAAW,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;wBAC9C,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;4BACjB,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,EAAE,GAAG,WAAW,CAAC,IAAI,yBAAyB,CAAC,CAAA;wBAC3E,CAAC;wBACD,OAAO;4BACL,IAAI,EAAE,WAAW,CAAC,IAAI;4BACtB,MAAM;4BACN,WAAW,EAAE,WAAW,CAAC,WAAW;yBACrC,CAAA;oBACH,CAAC,CAAC,CAAA;gBACJ,CAAC,CAAC,CACH,CAAA;gBAED,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;oBACxC,MAAM,KAAK,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;oBACxB,IAAI,CAAC,KAAK;wBAAE,SAAQ;oBAEpB,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAA;oBAClE,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,IAAI,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,CAAC;wBAC5D,cAAc,GAAG,KAAK,CAAA;wBACtB,kBAAkB,GAAG,KAAK,CAAA;oBAC5B,CAAC;oBAED,kFAAkF;oBAClF,IAAI,cAAc,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,CAAC;wBAC/E,cAAc,GAAG,KAAK,CAAA;wBACtB,kBAAkB,GAAG,IAAI,CAAA;oBAC3B,CAAC;gBACH,CAAC;YACH,CAAC;YAED,MAAM,SAAS,GAAG,IAAI,CAAC,aAAa;gBAClC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,YAAY,EAAE,EAAE;oBACtC,OAAO;wBACL,IAAI,EAAE,YAAY,CAAC,IAAI;wBACvB,KAAK,EAAE,YAAY,CAAC,YAAY,EAAE;qBACnC,CAAA;gBACH,CAAC,CAAC;gBACJ,CAAC,CAAC,SAAS,CAAA;YAEb,OAAO,KAAK,CAAC,MAAM,CAAC,cAAc,IAAI,kBAAkB,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;gBACzE,GAAG,eAAe;gBAClB,MAAM,EAAE,YAAY;gBACpB,GAAG,CAAC,SAAS,IAAI,EAAE,SAAS,EAAE,CAAC;gBAC/B,SAAS,EAAE,cAAc,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,MAAM;aAC1F,CAAC,CAAA;QACJ,CAAC;KACF,CAAC,CAAA;IACF,IAAI,EAAE,CAAA;AACR,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAA0D,EAAE,CAC9F,MAAM,EACN;IACE,OAAO,EAAE,KAAK;IACd,IAAI,EAAE,2BAA2B;CAClC,CACF,CAAA"}

package/dist/plugins/healthcheck/startupHealthcheckPlugin.d.ts

@@ -0,0 +1,7 @@
+import type { FastifyPluginCallback } from 'fastify';
+import { type HealthCheck } from './commonHealthcheckPlugin.js';
+export interface StartupHealthcheckPluginOptions {
+    resultsLogLevel?: 'fatal' | 'error' | 'warn' | 'info' | 'debug' | 'trace' | 'silent';
+    healthChecks: readonly HealthCheck[];
+}
+export declare const startupHealthcheckPlugin: FastifyPluginCallback<StartupHealthcheckPluginOptions>;

package/dist/plugins/healthcheck/startupHealthcheckPlugin.js

@@ -0,0 +1,48 @@
+import fp from 'fastify-plugin';
+import { stdSerializers } from 'pino';
+import { resolveHealthcheckResults } from './commonHealthcheckPlugin.js';
+const plugin = (app, opts, done) => {
+    app.addHook('onReady', async () => {
+        let isFullyHealthy = true;
+        let isPartiallyHealthy = false;
+        let healthChecks = {};
+        const failedHealthchecks = [];
+        if (opts.healthChecks.length) {
+            const results = await Promise.all(opts.healthChecks.map(async (healthcheck) => {
+                const result = await healthcheck.checker(app);
+                if (result.error) {
+                    app.log.error({
+                        error: stdSerializers.err(result.error),
+                    }, `${healthcheck.name} healthcheck has failed`);
+                }
+                if (result.error) {
+                    failedHealthchecks.push(healthcheck.name);
+                }
+                return {
+                    name: healthcheck.name,
+                    result,
+                    isMandatory: healthcheck.isMandatory,
+                };
+            }));
+            const resolvedHealthcheckResponse = resolveHealthcheckResults(results, opts);
+            healthChecks = resolvedHealthcheckResponse.healthChecks;
+            isFullyHealthy = resolvedHealthcheckResponse.isFullyHealthy;
+            isPartiallyHealthy = resolvedHealthcheckResponse.isPartiallyHealthy;
+        }
+        const heartbeat = isFullyHealthy ? 'HEALTHY' : isPartiallyHealthy ? 'PARTIALLY_HEALTHY' : 'FAIL';
+        const resultLog = {
+            heartbeat,
+            checks: healthChecks,
+        };
+        app.log[opts.resultsLogLevel ?? 'info'](resultLog, 'Healthcheck finished');
+        if (!isPartiallyHealthy && !isFullyHealthy) {
+            throw new Error(`Healthchecks failed: ${JSON.stringify(failedHealthchecks)}`);
+        }
+    });
+    done();
+};
+export const startupHealthcheckPlugin = fp(plugin, {
+    fastify: '5.x',
+    name: 'startup-healthcheck-plugin',
+});
+//# sourceMappingURL=startupHealthcheckPlugin.js.map

package/dist/plugins/healthcheck/startupHealthcheckPlugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"startupHealthcheckPlugin.js","sourceRoot":"","sources":["../../../lib/plugins/healthcheck/startupHealthcheckPlugin.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,gBAAgB,CAAA;AAC/B,OAAO,EAAE,cAAc,EAAE,MAAM,MAAM,CAAA;AACrC,OAAO,EAAoB,yBAAyB,EAAE,MAAM,8BAA8B,CAAA;AAO1F,MAAM,MAAM,GAA2D,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE;IACzF,GAAG,CAAC,OAAO,CAAC,SAAS,EAAE,KAAK,IAAI,EAAE;QAChC,IAAI,cAAc,GAAG,IAAI,CAAA;QACzB,IAAI,kBAAkB,GAAG,KAAK,CAAA;QAC9B,IAAI,YAAY,GAA2B,EAAE,CAAA;QAC7C,MAAM,kBAAkB,GAAa,EAAE,CAAA;QAEvC,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC;YAC7B,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,CAC/B,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,KAAK,EAAE,WAAW,EAAE,EAAE;gBAC1C,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;gBAC7C,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;oBACjB,GAAG,CAAC,GAAG,CAAC,KAAK,CACX;wBACE,KAAK,EAAE,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC;qBACxC,EACD,GAAG,WAAW,CAAC,IAAI,yBAAyB,CAC7C,CAAA;gBACH,CAAC;gBACD,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;oBACjB,kBAAkB,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAA;gBAC3C,CAAC;gBACD,OAAO;oBACL,IAAI,EAAE,WAAW,CAAC,IAAI;oBACtB,MAAM;oBACN,WAAW,EAAE,WAAW,CAAC,WAAW;iBACrC,CAAA;YACH,CAAC,CAAC,CACH,CAAA;YAED,MAAM,2BAA2B,GAAG,yBAAyB,CAAC,OAAO,EAAE,IAAI,CAAC,CAAA;YAC5E,YAAY,GAAG,2BAA2B,CAAC,YAAY,CAAA;YACvD,cAAc,GAAG,2BAA2B,CAAC,cAAc,CAAA;YAC3D,kBAAkB,GAAG,2BAA2B,CAAC,kBAAkB,CAAA;QACrE,CAAC;QAED,MAAM,SAAS,GAAG,cAAc,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,MAAM,CAAA;QAEhG,MAAM,SAAS,GAAG;YAChB,SAAS;YACT,MAAM,EAAE,YAAY;SACrB,CAAA;QAED,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,eAAe,IAAI,MAAM,CAAC,CAAC,SAAS,EAAE,sBAAsB,CAAC,CAAA;QAE1E,IAAI,CAAC,kBAAkB,IAAI,CAAC,cAAc,EAAE,CAAC;YAC3C,MAAM,IAAI,KAAK,CAAC,wBAAwB,IAAI,CAAC,SAAS,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAA;QAC/E,CAAC;IACH,CAAC,CAAC,CAAA;IACF,IAAI,EAAE,CAAA;AACR,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,wBAAwB,GAAG,EAAE,CAAC,MAAM,EAAE;IACjD,OAAO,EAAE,KAAK;IACd,IAAI,EAAE,4BAA4B;CACnC,CAAC,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@lokalise/fastify-extras",
-    "version": "30.0.0",
+    "version": "30.2.0",
     "description": "Opinionated set of fastify plugins, commonly used in Lokalise",
     "author": {
         "name": "Lokalise",
@@ -65,7 +65,7 @@
         "@lokalise/background-jobs-common": "^14.0.2",
         "@lokalise/biome-config": "^2.0.0",
         "@lokalise/node-core": "^14.4.1",
-        "@lokalise/tsconfig": "^2.0.0",
+        "@lokalise/tsconfig": "^3.0.0",
         "@types/newrelic": "^9.14.8",
         "@types/node": "^22.18.0",
         "@vitest/coverage-v8": "^3.2.4",
@@ -74,7 +74,7 @@
         "fastify": "^5.5.0",
         "fastify-type-provider-zod": "^6.0.0",
         "ioredis": "^5.6.1",
-        "newrelic": "13.2.1",
+        "newrelic": "13.3.2",
         "pino": "^9.9.0",
         "pino-pretty": "^13.1.1",
         "rimraf": "^6.0.1",