@lokalise/fastify-extras 12.0.0 → 13.1.0

package/dist/index.d.ts

@@ -6,6 +6,8 @@ export { newrelicTransactionManagerPlugin, NewRelicTransactionManager, } from '.
 export type { NewRelicTransactionManagerOptions } from './plugins/newrelicTransactionManagerPlugin';
 export { splitIOFeatureManagerPlugin, SplitIOFeatureManager, } from './plugins/splitIOFeatureManagerPlugin';
 export type { SplitIOOptions } from './plugins/splitIOFeatureManagerPlugin';
+export { healthcheckMetricsPlugin } from './plugins/healthcheckMetricsPlugin';
+export type { PrometheusHealthCheck, HealthcheckResult, HealthcheckMetricsPluginOptions, } from './plugins/healthcheckMetricsPlugin';
 export { metricsPlugin } from './plugins/metricsPlugin';
 export type { ErrorObjectResolver, MetricsPluginOptions } from './plugins/metricsPlugin';
 export { prismaOtelTracingPlugin } from './plugins/opentelemetry/prismaOtelTracingPlugin';

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Amplitude = exports.amplitudePlugin = exports.publicHealthcheckPlugin = exports.prismaOtelTracingPlugin = exports.metricsPlugin = exports.SplitIOFeatureManager = exports.splitIOFeatureManagerPlugin = exports.NewRelicTransactionManager = exports.newrelicTransactionManagerPlugin = exports.REQUEST_ID_STORE_KEY = exports.getRequestIdFastifyAppConfig = exports.requestContextProviderPlugin = exports.reportErrorToBugsnag = exports.bugsnagPlugin = void 0;
+exports.Amplitude = exports.amplitudePlugin = exports.publicHealthcheckPlugin = exports.prismaOtelTracingPlugin = exports.metricsPlugin = exports.healthcheckMetricsPlugin = exports.SplitIOFeatureManager = exports.splitIOFeatureManagerPlugin = exports.NewRelicTransactionManager = exports.newrelicTransactionManagerPlugin = exports.REQUEST_ID_STORE_KEY = exports.getRequestIdFastifyAppConfig = exports.requestContextProviderPlugin = exports.reportErrorToBugsnag = exports.bugsnagPlugin = void 0;
 var bugsnagPlugin_1 = require("./plugins/bugsnagPlugin");
 Object.defineProperty(exports, "bugsnagPlugin", { enumerable: true, get: function () { return bugsnagPlugin_1.bugsnagPlugin; } });
 Object.defineProperty(exports, "reportErrorToBugsnag", { enumerable: true, get: function () { return bugsnagPlugin_1.reportErrorToBugsnag; } });
@@ -14,6 +14,8 @@ Object.defineProperty(exports, "NewRelicTransactionManager", { enumerable: true,
 var splitIOFeatureManagerPlugin_1 = require("./plugins/splitIOFeatureManagerPlugin");
 Object.defineProperty(exports, "splitIOFeatureManagerPlugin", { enumerable: true, get: function () { return splitIOFeatureManagerPlugin_1.splitIOFeatureManagerPlugin; } });
 Object.defineProperty(exports, "SplitIOFeatureManager", { enumerable: true, get: function () { return splitIOFeatureManagerPlugin_1.SplitIOFeatureManager; } });
+var healthcheckMetricsPlugin_1 = require("./plugins/healthcheckMetricsPlugin");
+Object.defineProperty(exports, "healthcheckMetricsPlugin", { enumerable: true, get: function () { return healthcheckMetricsPlugin_1.healthcheckMetricsPlugin; } });
 var metricsPlugin_1 = require("./plugins/metricsPlugin");
 Object.defineProperty(exports, "metricsPlugin", { enumerable: true, get: function () { return metricsPlugin_1.metricsPlugin; } });
 var prismaOtelTracingPlugin_1 = require("./plugins/opentelemetry/prismaOtelTracingPlugin");

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../lib/index.ts"],"names":[],"mappings":";;;AAAA,yDAA6E;AAApE,8GAAA,aAAa,OAAA;AAAE,qHAAA,oBAAoB,OAAA;AAG5C,uFAI+C;AAH7C,4IAAA,4BAA4B,OAAA;AAC5B,4IAAA,4BAA4B,OAAA;AAC5B,oIAAA,oBAAoB,OAAA;AAItB,+FAGmD;AAFjD,oJAAA,gCAAgC,OAAA;AAChC,8IAAA,0BAA0B,OAAA;AAI5B,qFAG8C;AAF5C,0IAAA,2BAA2B,OAAA;AAC3B,oIAAA,qBAAqB,OAAA;AAIvB,yDAAuD;AAA9C,8GAAA,aAAa,OAAA;AAGtB,2FAAyF;AAAhF,kIAAA,uBAAuB,OAAA;AAGhC,6EAA2E;AAAlE,kIAAA,uBAAuB,OAAA;AAGhC,6DAKkC;AAJhC,kHAAA,eAAe,OAAA;AACf,4GAAA,SAAS,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../lib/index.ts"],"names":[],"mappings":";;;AAAA,yDAA6E;AAApE,8GAAA,aAAa,OAAA;AAAE,qHAAA,oBAAoB,OAAA;AAG5C,uFAI+C;AAH7C,4IAAA,4BAA4B,OAAA;AAC5B,4IAAA,4BAA4B,OAAA;AAC5B,oIAAA,oBAAoB,OAAA;AAItB,+FAGmD;AAFjD,oJAAA,gCAAgC,OAAA;AAChC,8IAAA,0BAA0B,OAAA;AAI5B,qFAG8C;AAF5C,0IAAA,2BAA2B,OAAA;AAC3B,oIAAA,qBAAqB,OAAA;AAIvB,+EAA6E;AAApE,oIAAA,wBAAwB,OAAA;AAOjC,yDAAuD;AAA9C,8GAAA,aAAa,OAAA;AAGtB,2FAAyF;AAAhF,kIAAA,uBAAuB,OAAA;AAGhC,6EAA2E;AAAlE,kIAAA,uBAAuB,OAAA;AAGhC,6DAKkC;AAJhC,kHAAA,eAAe,OAAA;AACf,4GAAA,SAAS,OAAA"}

package/dist/plugins/amplitudePlugin.d.ts

@@ -52,7 +52,7 @@ export interface AmplitudeConfig {
  * })
  * ```
  */
-export declare const amplitudePlugin: import("fastify").FastifyPluginCallback<AmplitudeConfig, import("fastify").RawServerDefault, import("fastify").FastifyTypeProviderDefault>;
+export declare const amplitudePlugin: import("fastify").FastifyPluginCallback<AmplitudeConfig, import("fastify").RawServerDefault, import("fastify").FastifyTypeProviderDefault, import("fastify").FastifyBaseLogger>;
 export declare class Amplitude {
     private readonly isEnabled;
     constructor(isEnabled: boolean);

package/dist/plugins/bugsnagPlugin.d.ts

@@ -1,5 +1,6 @@
 import type { Event, NotifiableError } from '@bugsnag/js';
 import type { NodeConfig } from '@bugsnag/node';
+import type { FastifyInstance } from 'fastify';
 export type Severity = Event['severity'];
 export interface ErrorReport {
     error: NotifiableError;
@@ -12,4 +13,6 @@ export interface BugsnagPluginConfig {
     bugsnag: NodeConfig;
     isEnabled: boolean;
 }
-export declare const bugsnagPlugin: import("fastify").FastifyPluginCallback<BugsnagPluginConfig, import("fastify").RawServerDefault, import("fastify").FastifyTypeProviderDefault>;
+declare function plugin(app: FastifyInstance, opts: BugsnagPluginConfig, done: () => void): void;
+export declare const bugsnagPlugin: typeof plugin;
+export {};

package/dist/plugins/healthcheckMetricsPlugin.d.ts

@@ -0,0 +1,16 @@
+import type { Either } from '@lokalise/node-core';
+import type { FastifyInstance } from 'fastify';
+export interface HealthcheckMetricsPluginOptions {
+    healthChecks: readonly PrometheusHealthCheck[];
+}
+export type HealthcheckResult = {
+    checkTimeInMsecs: number;
+    checkPassed: boolean;
+};
+export type PrometheusHealthCheck = {
+    name: string;
+    checker: (app: FastifyInstance) => Promise<Either<Error, HealthcheckResult>>;
+};
+declare function plugin(app: FastifyInstance, opts: HealthcheckMetricsPluginOptions, done: (err?: Error) => void): void;
+export declare const healthcheckMetricsPlugin: typeof plugin;
+export {};

package/dist/plugins/healthcheckMetricsPlugin.js

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.healthcheckMetricsPlugin = void 0;
+const tslib_1 = require("tslib");
+const fastify_plugin_1 = tslib_1.__importDefault(require("fastify-plugin"));
+const VALID_PROMETHEUS_NAME_REGEX = /[a-zA-Z_:][a-zA-Z0-9_:]*/;
+function plugin(app, opts, done) {
+    const invalidNames = [];
+    for (const healthcheck of opts.healthChecks) {
+        if (!VALID_PROMETHEUS_NAME_REGEX.test(healthcheck.name)) {
+            invalidNames.push(healthcheck.name);
+        }
+    }
+    if (invalidNames.length > 0) {
+        return done(new Error(`Invalid healthcheck names: ${JSON.stringify(invalidNames)}`));
+    }
+    try {
+        const promClient = app.metrics.client;
+        if (!promClient) {
+            throw new Error('Prometheus client is not registered');
+        }
+        for (const check of opts.healthChecks) {
+            new promClient.Gauge({
+                name: `${check.name}_availability`,
+                help: `Whether ${check.name} was available at the time`,
+                async collect() {
+                    const checkResult = await check.checker(app);
+                    if (checkResult.result?.checkPassed) {
+                        this.set(1);
+                    }
+                    else {
+                        this.set(0);
+                    }
+                },
+            });
+            new promClient.Gauge({
+                name: `${check.name}_latency_msecs`,
+                help: `How long the healthcheck for ${check.name} took`,
+                async collect() {
+                    const checkResult = await check.checker(app);
+                    if (checkResult.result?.checkPassed) {
+                        this.set(checkResult.result.checkTimeInMsecs);
+                    }
+                    else {
+                        this.set(checkResult.result?.checkTimeInMsecs ?? 0);
+                    }
+                },
+            });
+        }
+    }
+    catch (err) {
+        return done(err);
+    }
+    done();
+}
+exports.healthcheckMetricsPlugin = (0, fastify_plugin_1.default)(plugin, {
+    fastify: '4.x',
+    name: 'healthcheck-metrics-plugin',
+});
+//# sourceMappingURL=healthcheckMetricsPlugin.js.map

package/dist/plugins/healthcheckMetricsPlugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"healthcheckMetricsPlugin.js","sourceRoot":"","sources":["../../lib/plugins/healthcheckMetricsPlugin.ts"],"names":[],"mappings":";;;;AAEA,4EAA+B;AAE/B,MAAM,2BAA2B,GAAG,0BAA0B,CAAA;AAgB9D,SAAS,MAAM,CACb,GAAoB,EACpB,IAAqC,EACrC,IAA2B;IAE3B,MAAM,YAAY,GAAG,EAAE,CAAA;IAEvB,KAAK,MAAM,WAAW,IAAI,IAAI,CAAC,YAAY,EAAE;QAC3C,IAAI,CAAC,2BAA2B,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE;YACvD,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAA;SACpC;KACF;IAED,IAAI,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE;QAC3B,OAAO,IAAI,CAAC,IAAI,KAAK,CAAC,8BAA8B,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC,CAAA;KACrF;IAED,IAAI;QACF,MAAM,UAAU,GAAG,GAAG,CAAC,OAAO,CAAC,MAAM,CAAA;QACrC,IAAI,CAAC,UAAU,EAAE;YACf,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAA;SACvD;QAED,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,YAAY,EAAE;YACrC,IAAI,UAAU,CAAC,KAAK,CAAC;gBACnB,IAAI,EAAE,GAAG,KAAK,CAAC,IAAI,eAAe;gBAClC,IAAI,EAAE,WAAW,KAAK,CAAC,IAAI,4BAA4B;gBACvD,KAAK,CAAC,OAAO;oBACX,MAAM,WAAW,GAAG,MAAM,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;oBAE5C,IAAI,WAAW,CAAC,MAAM,EAAE,WAAW,EAAE;wBACnC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;qBACZ;yBAAM;wBACL,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;qBACZ;gBACH,CAAC;aACF,CAAC,CAAA;YAEF,IAAI,UAAU,CAAC,KAAK,CAAC;gBACnB,IAAI,EAAE,GAAG,KAAK,CAAC,IAAI,gBAAgB;gBACnC,IAAI,EAAE,gCAAgC,KAAK,CAAC,IAAI,OAAO;gBACvD,KAAK,CAAC,OAAO;oBACX,MAAM,WAAW,GAAG,MAAM,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;oBAE5C,IAAI,WAAW,CAAC,MAAM,EAAE,WAAW,EAAE;wBACnC,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAA;qBAC9C;yBAAM;wBACL,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,MAAM,EAAE,gBAAgB,IAAI,CAAC,CAAC,CAAA;qBACpD;gBACH,CAAC;aACF,CAAC,CAAA;SACH;KACF;IAAC,OAAO,GAAY,EAAE;QACrB,OAAO,IAAI,CAAC,GAAY,CAAC,CAAA;KAC1B;IAED,IAAI,EAAE,CAAA;AACR,CAAC;AAEY,QAAA,wBAAwB,GAAG,IAAA,wBAAE,EAAC,MAAM,EAAE;IACjD,OAAO,EAAE,KAAK;IACd,IAAI,EAAE,4BAA4B;CACnC,CAAC,CAAA"}

package/dist/plugins/healthcheckMetricsPlugin.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/plugins/healthcheckMetricsPlugin.spec.js

@@ -0,0 +1,121 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const node_core_1 = require("@lokalise/node-core");
+const fastify_1 = tslib_1.__importDefault(require("fastify"));
+const healthcheckMetricsPlugin_1 = require("./healthcheckMetricsPlugin");
+const metricsPlugin_1 = require("./metricsPlugin");
+let app;
+async function initApp(healthChecks) {
+    const testApp = (0, fastify_1.default)();
+    app = testApp;
+    await app.register(metricsPlugin_1.metricsPlugin, {
+        bindAddress: '0.0.0.0',
+        loggerOptions: false,
+        errorObjectResolver: (err) => err,
+    });
+    await app.register(healthcheckMetricsPlugin_1.healthcheckMetricsPlugin, {
+        healthChecks,
+    });
+    await app.ready();
+    return app;
+}
+describe('healthcheckMetricsPlugin', () => {
+    afterEach(async () => {
+        await app.close();
+    });
+    it('returns positive healthcheck results', async () => {
+        app = await initApp([
+            {
+                name: 'test_healthcheck',
+                // eslint-disable-next-line @typescript-eslint/require-await
+                checker: async () => {
+                    return {
+                        result: {
+                            checkPassed: true,
+                            checkTimeInMsecs: 345,
+                        },
+                    };
+                },
+            },
+        ]);
+        const response = await (0, node_core_1.sendGet)((0, node_core_1.buildClient)('http://127.0.0.1:9080'), '/metrics');
+        console.log(response.result.body);
+        expect(response.result.statusCode).toBe(200);
+        expect(response.result.body).toContain('test_healthcheck_availability 1');
+        expect(response.result.body).toContain('test_healthcheck_latency_msecs 345');
+    });
+    it('returns negative healthcheck results', async () => {
+        app = await initApp([
+            {
+                name: 'test_healthcheck',
+                // eslint-disable-next-line @typescript-eslint/require-await
+                checker: async () => {
+                    return {
+                        result: {
+                            checkPassed: false,
+                            checkTimeInMsecs: 1450,
+                        },
+                    };
+                },
+            },
+        ]);
+        const response = await (0, node_core_1.sendGet)((0, node_core_1.buildClient)('http://127.0.0.1:9080'), '/metrics');
+        console.log(response.result.body);
+        expect(response.result.statusCode).toBe(200);
+        expect(response.result.body).toContain('test_healthcheck_availability 0');
+        expect(response.result.body).toContain('test_healthcheck_latency_msecs 1450');
+    });
+    it('returns mixed healthcheck results', async () => {
+        app = await initApp([
+            {
+                name: 'test_healthcheck_1',
+                // eslint-disable-next-line @typescript-eslint/require-await
+                checker: async () => {
+                    return {
+                        result: {
+                            checkPassed: true,
+                            checkTimeInMsecs: 345,
+                        },
+                    };
+                },
+            },
+            {
+                name: 'test_healthcheck_2',
+                // eslint-disable-next-line @typescript-eslint/require-await
+                checker: async () => {
+                    return {
+                        result: {
+                            checkPassed: false,
+                            checkTimeInMsecs: 1450,
+                        },
+                    };
+                },
+            },
+        ]);
+        const response = await (0, node_core_1.sendGet)((0, node_core_1.buildClient)('http://127.0.0.1:9080'), '/metrics');
+        console.log(response.result.body);
+        expect(response.result.statusCode).toBe(200);
+        expect(response.result.body).toContain('test_healthcheck_1_availability 1');
+        expect(response.result.body).toContain('test_healthcheck_1_latency_msecs 345');
+        expect(response.result.body).toContain('test_healthcheck_2_availability 0');
+        expect(response.result.body).toContain('test_healthcheck_2_latency_msecs 1450');
+    });
+    it('throws on invalid healthcheck name', async () => {
+        await expect(initApp([
+            {
+                name: 'test healthcheck',
+                // eslint-disable-next-line @typescript-eslint/require-await
+                checker: async () => {
+                    return {
+                        result: {
+                            checkPassed: false,
+                            checkTimeInMsecs: 1450,
+                        },
+                    };
+                },
+            },
+        ])).rejects.toThrow(/Invalid metric name/);
+    });
+});
+//# sourceMappingURL=healthcheckMetricsPlugin.spec.js.map

package/dist/plugins/healthcheckMetricsPlugin.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"healthcheckMetricsPlugin.spec.js","sourceRoot":"","sources":["../../lib/plugins/healthcheckMetricsPlugin.spec.ts"],"names":[],"mappings":";;;AAAA,mDAA0D;AAE1D,8DAA6B;AAG7B,yEAAqE;AACrE,mDAA+C;AAE/C,IAAI,GAAoB,CAAA;AAExB,KAAK,UAAU,OAAO,CAAC,YAAqC;IAC1D,MAAM,OAAO,GAAG,IAAA,iBAAO,GAAE,CAAA;IACzB,GAAG,GAAG,OAAO,CAAA;IACb,MAAM,GAAG,CAAC,QAAQ,CAAC,6BAAa,EAAE;QAChC,WAAW,EAAE,SAAS;QACtB,aAAa,EAAE,KAAK;QACpB,mBAAmB,EAAE,CAAC,GAAY,EAAE,EAAE,CAAC,GAAG;KAC3C,CAAC,CAAA;IACF,MAAM,GAAG,CAAC,QAAQ,CAAC,mDAAwB,EAAE;QAC3C,YAAY;KACb,CAAC,CAAA;IAEF,MAAM,GAAG,CAAC,KAAK,EAAE,CAAA;IACjB,OAAO,GAAG,CAAA;AACZ,CAAC;AAED,QAAQ,CAAC,0BAA0B,EAAE,GAAG,EAAE;IACxC,SAAS,CAAC,KAAK,IAAI,EAAE;QACnB,MAAM,GAAG,CAAC,KAAK,EAAE,CAAA;IACnB,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,sCAAsC,EAAE,KAAK,IAAI,EAAE;QACpD,GAAG,GAAG,MAAM,OAAO,CAAC;YAClB;gBACE,IAAI,EAAE,kBAAkB;gBACxB,4DAA4D;gBAC5D,OAAO,EAAE,KAAK,IAAI,EAAE;oBAClB,OAAO;wBACL,MAAM,EAAE;4BACN,WAAW,EAAE,IAAI;4BACjB,gBAAgB,EAAE,GAAG;yBACtB;qBACF,CAAA;gBACH,CAAC;aACF;SACF,CAAC,CAAA;QAEF,MAAM,QAAQ,GAAG,MAAM,IAAA,mBAAO,EAAC,IAAA,uBAAW,EAAC,uBAAuB,CAAC,EAAE,UAAU,CAAC,CAAA;QAEhF,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;QACjC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;QAC5C,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,iCAAiC,CAAC,CAAA;QACzE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,oCAAoC,CAAC,CAAA;IAC9E,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,sCAAsC,EAAE,KAAK,IAAI,EAAE;QACpD,GAAG,GAAG,MAAM,OAAO,CAAC;YAClB;gBACE,IAAI,EAAE,kBAAkB;gBACxB,4DAA4D;gBAC5D,OAAO,EAAE,KAAK,IAAI,EAAE;oBAClB,OAAO;wBACL,MAAM,EAAE;4BACN,WAAW,EAAE,KAAK;4BAClB,gBAAgB,EAAE,IAAI;yBACvB;qBACF,CAAA;gBACH,CAAC;aACF;SACF,CAAC,CAAA;QAEF,MAAM,QAAQ,GAAG,MAAM,IAAA,mBAAO,EAAC,IAAA,uBAAW,EAAC,uBAAuB,CAAC,EAAE,UAAU,CAAC,CAAA;QAEhF,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;QACjC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;QAC5C,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,iCAAiC,CAAC,CAAA;QACzE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,qCAAqC,CAAC,CAAA;IAC/E,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,mCAAmC,EAAE,KAAK,IAAI,EAAE;QACjD,GAAG,GAAG,MAAM,OAAO,CAAC;YAClB;gBACE,IAAI,EAAE,oBAAoB;gBAC1B,4DAA4D;gBAC5D,OAAO,EAAE,KAAK,IAAI,EAAE;oBAClB,OAAO;wBACL,MAAM,EAAE;4BACN,WAAW,EAAE,IAAI;4BACjB,gBAAgB,EAAE,GAAG;yBACtB;qBACF,CAAA;gBACH,CAAC;aACF;YACD;gBACE,IAAI,EAAE,oBAAoB;gBAC1B,4DAA4D;gBAC5D,OAAO,EAAE,KAAK,IAAI,EAAE;oBAClB,OAAO;wBACL,MAAM,EAAE;4BACN,WAAW,EAAE,KAAK;4BAClB,gBAAgB,EAAE,IAAI;yBACvB;qBACF,CAAA;gBACH,CAAC;aACF;SACF,CAAC,CAAA;QAEF,MAAM,QAAQ,GAAG,MAAM,IAAA,mBAAO,EAAC,IAAA,uBAAW,EAAC,uBAAuB,CAAC,EAAE,UAAU,CAAC,CAAA;QAEhF,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;QACjC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;QAC5C,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,mCAAmC,CAAC,CAAA;QAC3E,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,sCAAsC,CAAC,CAAA;QAE9E,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,mCAAmC,CAAC,CAAA;QAC3E,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,uCAAuC,CAAC,CAAA;IACjF,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,oCAAoC,EAAE,KAAK,IAAI,EAAE;QAClD,MAAM,MAAM,CACV,OAAO,CAAC;YACN;gBACE,IAAI,EAAE,kBAAkB;gBACxB,4DAA4D;gBAC5D,OAAO,EAAE,KAAK,IAAI,EAAE;oBAClB,OAAO;wBACL,MAAM,EAAE;4BACN,WAAW,EAAE,KAAK;4BAClB,gBAAgB,EAAE,IAAI;yBACvB;qBACF,CAAA;gBACH,CAAC;aACF;SACF,CAAC,CACH,CAAC,OAAO,CAAC,OAAO,CAAC,qBAAqB,CAAC,CAAA;IAC1C,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}

package/dist/plugins/metricsPlugin.d.ts

@@ -1,3 +1,4 @@
+import type { FastifyInstance } from 'fastify';
 import type { PinoLoggerOptions } from 'fastify/types/logger';
 export type ErrorObjectResolver = (err: unknown, correlationID?: string) => unknown;
 export interface MetricsPluginOptions {
@@ -6,4 +7,6 @@ export interface MetricsPluginOptions {
     bindAddress?: string;
     errorObjectResolver: ErrorObjectResolver;
 }
-export declare const metricsPlugin: import("fastify").FastifyPluginCallback<MetricsPluginOptions, import("fastify").RawServerDefault, import("fastify").FastifyTypeProviderDefault>;
+declare function plugin(app: FastifyInstance, opts: MetricsPluginOptions): Promise<void>;
+export declare const metricsPlugin: typeof plugin;
+export {};

package/dist/plugins/metricsPlugin.js

@@ -47,6 +47,9 @@ function plugin(app, opts) {
         const logObject = opts.errorObjectResolver(err);
         promServer.log.error(logObject);
         throw new Error('Critical error when trying to launch metrics server');
+    })
+        .then(() => {
+        // this is to consume string which plugin does not expect
     });
 }
 exports.metricsPlugin = (0, fastify_plugin_1.default)(plugin, {

package/dist/plugins/metricsPlugin.js.map

@@ -1 +1 @@
-{"version":3,"file":"metricsPlugin.js","sourceRoot":"","sources":["../../lib/plugins/metricsPlugin.ts"],"names":[],"mappings":";;;;AACA,8DAA6B;AAE7B,8EAA4C;AAC5C,4EAA+B;AAE/B,MAAM,YAAY,GAAG,IAAI,CAAA;AAWzB,SAAS,MAAM,CAAC,GAAoB,EAAE,IAA0B;IAC9D,KAAK,GAAG,CAAC,QAAQ,CAAC,yBAAc,EAAE;QAChC,cAAc,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE;QACjC,QAAQ,EAAE,IAAI;QACd,mBAAmB,EAAE,IAAI;QACzB,IAAI,EAAE,SAAS;QACf,YAAY,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE;KAChC,CAAC,CAAA;IAEF,MAAM,UAAU,GAAG,IAAA,iBAAO,EAAC;QACzB,MAAM,EAAE,IAAI,CAAC,aAAa;QAC1B,qBAAqB,EAAE,IAAI,CAAC,+BAA+B,IAAI,IAAI;KACpE,CAAC,CAAA;IAEF,UAAU,CAAC,KAAK,CAAC;QACf,GAAG,EAAE,UAAU;QACf,MAAM,EAAE,KAAK;QACb,QAAQ,EAAE,MAAM;QAChB,MAAM,EAAE;YACN,kCAAkC;YAClC,mBAAmB;YACnB,IAAI,EAAE,IAAI;SACX;QACD,OAAO,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE;YAC1B,MAAM,OAAO,GAAG,MAAM,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAA;YAC3D,OAAO,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QAC/C,CAAC;KACF,CAAC,CAAA;IAEF,GAAG,CAAC,OAAO,CAAC,SAAS,EAAE,KAAK,IAAI,EAAE;QAChC,MAAM,UAAU,CAAC,KAAK,EAAE,CAAA;IAC1B,CAAC,CAAC,CAAA;IAEF,OAAO,UAAU;SACd,MAAM,CAAC;QACN,IAAI,EAAE,YAAY;QAClB,IAAI,EAAE,IAAI,CAAC,WAAW;QACtB,kBAAkB,EAAE,CAAC,OAAO,EAAE,EAAE;YAC9B,OAAO,0CAA0C,OAAO,EAAE,CAAA;QAC5D,CAAC;KACF,CAAC;SACD,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;QACb,MAAM,SAAS,GAAG,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAA;QAC/C,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,CAAA;QAC/B,MAAM,IAAI,KAAK,CAAC,qDAAqD,CAAC,CAAA;IACxE,CAAC,CAAC,CAAA;AACN,CAAC;AAEY,QAAA,aAAa,GAAG,IAAA,wBAAE,EAAC,MAAM,EAAE;IACtC,OAAO,EAAE,KAAK;IACd,IAAI,EAAE,gBAAgB;CACvB,CAAC,CAAA"}
+{"version":3,"file":"metricsPlugin.js","sourceRoot":"","sources":["../../lib/plugins/metricsPlugin.ts"],"names":[],"mappings":";;;;AACA,8DAA6B;AAE7B,8EAA4C;AAC5C,4EAA+B;AAE/B,MAAM,YAAY,GAAG,IAAI,CAAA;AAWzB,SAAS,MAAM,CAAC,GAAoB,EAAE,IAA0B;IAC9D,KAAK,GAAG,CAAC,QAAQ,CAAC,yBAAc,EAAE;QAChC,cAAc,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE;QACjC,QAAQ,EAAE,IAAI;QACd,mBAAmB,EAAE,IAAI;QACzB,IAAI,EAAE,SAAS;QACf,YAAY,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE;KAChC,CAAC,CAAA;IAEF,MAAM,UAAU,GAAG,IAAA,iBAAO,EAAC;QACzB,MAAM,EAAE,IAAI,CAAC,aAAa;QAC1B,qBAAqB,EAAE,IAAI,CAAC,+BAA+B,IAAI,IAAI;KACpE,CAAC,CAAA;IAEF,UAAU,CAAC,KAAK,CAAC;QACf,GAAG,EAAE,UAAU;QACf,MAAM,EAAE,KAAK;QACb,QAAQ,EAAE,MAAM;QAChB,MAAM,EAAE;YACN,kCAAkC;YAClC,mBAAmB;YACnB,IAAI,EAAE,IAAI;SACX;QACD,OAAO,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE;YAC1B,MAAM,OAAO,GAAG,MAAM,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAA;YAC3D,OAAO,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QAC/C,CAAC;KACF,CAAC,CAAA;IAEF,GAAG,CAAC,OAAO,CAAC,SAAS,EAAE,KAAK,IAAI,EAAE;QAChC,MAAM,UAAU,CAAC,KAAK,EAAE,CAAA;IAC1B,CAAC,CAAC,CAAA;IAEF,OAAO,UAAU;SACd,MAAM,CAAC;QACN,IAAI,EAAE,YAAY;QAClB,IAAI,EAAE,IAAI,CAAC,WAAW;QACtB,kBAAkB,EAAE,CAAC,OAAO,EAAE,EAAE;YAC9B,OAAO,0CAA0C,OAAO,EAAE,CAAA;QAC5D,CAAC;KACF,CAAC;SACD,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;QACb,MAAM,SAAS,GAAG,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAA;QAC/C,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,CAAA;QAC/B,MAAM,IAAI,KAAK,CAAC,qDAAqD,CAAC,CAAA;IACxE,CAAC,CAAC;SACD,IAAI,CAAC,GAAG,EAAE;QACT,yDAAyD;IAC3D,CAAC,CAAC,CAAA;AACN,CAAC;AAEY,QAAA,aAAa,GAAG,IAAA,wBAAE,EAAC,MAAM,EAAE;IACtC,OAAO,EAAE,KAAK;IACd,IAAI,EAAE,gBAAgB;CACvB,CAAC,CAAA"}

package/dist/plugins/newrelicTransactionManagerPlugin.d.ts

@@ -1,3 +1,4 @@
+import type { FastifyInstance } from 'fastify';
 declare module 'fastify' {
     interface FastifyInstance {
         newrelicTransactionManager: NewRelicTransactionManager;
@@ -14,4 +15,6 @@ export declare class NewRelicTransactionManager {
     start(jobName: string): void;
     stop(jobId: string): void;
 }
-export declare const newrelicTransactionManagerPlugin: import("fastify").FastifyPluginCallback<NewRelicTransactionManagerOptions, import("fastify").RawServerDefault, import("fastify").FastifyTypeProviderDefault>;
+declare function plugin(fastify: FastifyInstance, opts: NewRelicTransactionManagerOptions, done: () => void): void;
+export declare const newrelicTransactionManagerPlugin: typeof plugin;
+export {};

package/dist/plugins/opentelemetry/prismaOtelTracingPlugin.d.ts

@@ -1,7 +1,10 @@
+import type { FastifyInstance } from 'fastify';
 export interface PrismaOtelTracingPluginConfig {
     isEnabled: boolean;
     useBatchSpans: boolean;
     samplingRatio: number;
     serviceName: string;
 }
-export declare const prismaOtelTracingPlugin: import("fastify").FastifyPluginCallback<PrismaOtelTracingPluginConfig, import("fastify").RawServerDefault, import("fastify").FastifyTypeProviderDefault>;
+declare function plugin(app: FastifyInstance, opts: PrismaOtelTracingPluginConfig, done: () => void): void;
+export declare const prismaOtelTracingPlugin: typeof plugin;
+export {};

package/dist/plugins/publicHealthcheckPlugin.d.ts

@@ -5,4 +5,6 @@ export interface PublicHealthcheckPluginOptions {
     healthChecks: readonly HealthCheck[];
 }
 export type HealthCheck = (app: FastifyInstance) => Promise<Either<Error, true>>;
-export declare const publicHealthcheckPlugin: import("fastify").FastifyPluginCallback<PublicHealthcheckPluginOptions, import("fastify").RawServerDefault, import("fastify").FastifyTypeProviderDefault>;
+declare function plugin(app: FastifyInstance, opts: PublicHealthcheckPluginOptions, done: () => void): void;
+export declare const publicHealthcheckPlugin: typeof plugin;
+export {};

package/dist/plugins/requestContextProviderPlugin.d.ts

@@ -1,4 +1,4 @@
-import type { FastifyServerOptions, FastifyBaseLogger } from 'fastify';
+import type { FastifyInstance, FastifyServerOptions, FastifyBaseLogger } from 'fastify';
 export declare const REQUEST_ID_STORE_KEY = "request_id";
 declare module 'fastify' {
     interface FastifyRequest {
@@ -19,4 +19,6 @@ declare module '@fastify/request-context' {
     }
 }
 export declare function getRequestIdFastifyAppConfig(): Pick<FastifyServerOptions, 'genReqId' | 'requestIdHeader'>;
-export declare const requestContextProviderPlugin: import("fastify").FastifyPluginCallback<import("fastify").FastifyPluginOptions, import("fastify").RawServerDefault, import("fastify").FastifyTypeProviderDefault>;
+declare function plugin(fastify: FastifyInstance, opts: unknown, done: () => void): void;
+export declare const requestContextProviderPlugin: typeof plugin;
+export {};

package/dist/plugins/requestContextProviderPlugin.js.map

@@ -1 +1 @@
-{"version":3,"file":"requestContextProviderPlugin.js","sourceRoot":"","sources":["../../lib/plugins/requestContextProviderPlugin.ts"],"names":[],"mappings":";;;;AAAA,mCAAmC;AAEnC,8DAAyD;AASzD,4EAA+B;AAElB,QAAA,oBAAoB,GAAG,YAAY,CAAA;AAyBhD,SAAgB,4BAA4B;IAI1C,OAAO;QACL,QAAQ,EAAE,GAAG,EAAE,CAAC,IAAA,mBAAU,GAAE;QAC5B,eAAe,EAAE,cAAc;KAChC,CAAA;AACH,CAAC;AARD,oEAQC;AAED,SAAS,MAAM,CAAC,OAAwB,EAAE,IAAa,EAAE,IAAgB;IACvE,OAAO,CAAC,OAAO,CACb,WAAW,EACX,CAAC,GAAmB,EAAE,GAAiB,EAAE,IAA6B,EAAE,EAAE;QACxE,GAAG,CAAC,UAAU,GAAG;YACf,MAAM,EAAE,GAAG,CAAC,GAAG;YACf,KAAK,EAAE,GAAG,CAAC,EAAY;SACxB,CAAA;QAED,0GAA0G;QAC1G,gCAAc,CAAC,GAAG,CAAC,4BAAoB,EAAE,GAAG,CAAC,EAAY,CAAC,CAAA;QAE1D,IAAI,EAAE,CAAA;IACR,CAAC,CACF,CAAA;IAED,OAAO,CAAC,OAAO,CACb,QAAQ,EACR,CAAC,GAAmB,EAAE,GAAiB,EAAE,OAAO,EAAE,IAA6B,EAAE,EAAE;QACjF,KAAK,GAAG,CAAC,MAAM,CAAC,cAAc,EAAE,GAAG,CAAC,EAAE,CAAC,CAAA;QACvC,IAAI,EAAE,CAAA;IACR,CAAC,CACF,CAAA;IAED,IAAI,EAAE,CAAA;AACR,CAAC;AAEY,QAAA,4BAA4B,GAAG,IAAA,wBAAE,EAAC,MAAM,EAAE;IACrD,OAAO,EAAE,KAAK;IACd,IAAI,EAAE,iCAAiC;CACxC,CAAC,CAAA"}
+{"version":3,"file":"requestContextProviderPlugin.js","sourceRoot":"","sources":["../../lib/plugins/requestContextProviderPlugin.ts"],"names":[],"mappings":";;;;AAAA,mCAAmC;AAEnC,8DAAyD;AASzD,4EAA+B;AAElB,QAAA,oBAAoB,GAAG,YAAY,CAAA;AAyBhD,SAAgB,4BAA4B;IAI1C,OAAO;QACL,QAAQ,EAAE,GAAG,EAAE,CAAC,IAAA,mBAAU,GAAE;QAC5B,eAAe,EAAE,cAAc;KAChC,CAAA;AACH,CAAC;AARD,oEAQC;AAED,SAAS,MAAM,CAAC,OAAwB,EAAE,IAAa,EAAE,IAAgB;IACvE,OAAO,CAAC,OAAO,CACb,WAAW,EACX,CAAC,GAAmB,EAAE,GAAiB,EAAE,IAA6B,EAAE,EAAE;QACxE,GAAG,CAAC,UAAU,GAAG;YACf,MAAM,EAAE,GAAG,CAAC,GAAG;YACf,KAAK,EAAE,GAAG,CAAC,EAAE;SACd,CAAA;QAED,0GAA0G;QAC1G,gCAAc,CAAC,GAAG,CAAC,4BAAoB,EAAE,GAAG,CAAC,EAAE,CAAC,CAAA;QAEhD,IAAI,EAAE,CAAA;IACR,CAAC,CACF,CAAA;IAED,OAAO,CAAC,OAAO,CACb,QAAQ,EACR,CAAC,GAAmB,EAAE,GAAiB,EAAE,OAAO,EAAE,IAA6B,EAAE,EAAE;QACjF,KAAK,GAAG,CAAC,MAAM,CAAC,cAAc,EAAE,GAAG,CAAC,EAAE,CAAC,CAAA;QACvC,IAAI,EAAE,CAAA;IACR,CAAC,CACF,CAAA;IAED,IAAI,EAAE,CAAA;AACR,CAAC;AAEY,QAAA,4BAA4B,GAAG,IAAA,wBAAE,EAAC,MAAM,EAAE;IACrD,OAAO,EAAE,KAAK;IACd,IAAI,EAAE,iCAAiC;CACxC,CAAC,CAAA"}

package/dist/plugins/splitIOFeatureManagerPlugin.d.ts

@@ -1,5 +1,6 @@
 import type SplitIO from '@splitsoftware/splitio/types/splitio';
 import type { Attributes, Properties, SplitKey, Treatment, TreatmentWithConfig } from '@splitsoftware/splitio/types/splitio';
+import type { FastifyInstance } from 'fastify';
 declare module 'fastify' {
     interface FastifyInstance {
         splitIOFeatureManager: SplitIOFeatureManager;
@@ -21,4 +22,6 @@ export declare class SplitIOFeatureManager {
     track(key: SplitIO.SplitKey, trafficType: string, eventType: string, value?: number, properties?: Properties): boolean;
     shutdown(): Promise<void>;
 }
-export declare const splitIOFeatureManagerPlugin: import("fastify").FastifyPluginCallback<SplitIOOptions, import("fastify").RawServerDefault, import("fastify").FastifyTypeProviderDefault>;
+declare function plugin(fastify: FastifyInstance, opts: SplitIOOptions, done: () => void): void;
+export declare const splitIOFeatureManagerPlugin: typeof plugin;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lokalise/fastify-extras",
-  "version": "12.0.0",
+  "version": "13.1.0",
   "description": "Opinionated set of fastify plugins, commonly used in Lokalise",
   "author": {
     "name": "Lokalise",
@@ -43,7 +43,7 @@
     "version": "auto-changelog -p && git add CHANGELOG.md"
   },
   "dependencies": {
-    "@bugsnag/js": "^7.20.2",
+    "@bugsnag/js": "^7.21.0",
     "@opentelemetry/api": "^1.4.1",
     "@opentelemetry/exporter-trace-otlp-grpc": "^0.41.0",
     "@opentelemetry/instrumentation": "^0.41.0",
@@ -51,43 +51,43 @@
     "@opentelemetry/sdk-trace-base": "^1.14.0",
     "@opentelemetry/sdk-trace-node": "^1.14.0",
     "@opentelemetry/semantic-conventions": "^1.14.0",
-    "@prisma/instrumentation": "^5.0.0",
+    "@prisma/instrumentation": "^5.2.0",
     "@splitsoftware/splitio": "^10.22.6",
     "@amplitude/analytics-node": "^1.3.1",
     "fastify-metrics": "^10.3.0",
-    "fastify-plugin": "^4.5.0",
-    "tslib": "^2.6.0"
+    "fastify-plugin": "^4.5.1",
+    "tslib": "^2.6.2"
   },
   "peerDependencies": {
     "@fastify/request-context": "^5.0.0",
-    "fastify": "^4.18.0",
-    "newrelic": "^10.1.1",
-    "pino": "^8.14.1"
+    "fastify": "^4.22.2",
+    "newrelic": "^11.0.0",
+    "pino": "^8.15.0"
   },
   "devDependencies": {
     "@fastify/request-context": "^5.0.0",
-    "@lokalise/node-core": "^5.10.0",
+    "@lokalise/node-core": "^6.2.0",
     "@types/jest": "^29.5.3",
     "@types/newrelic": "^9.14.0",
     "@types/node": "^18.16.19",
     "@amplitude/analytics-types": "^2.1.1",
-    "@typescript-eslint/eslint-plugin": "^5.62.0",
-    "@typescript-eslint/parser": "^5.62.0",
+    "@typescript-eslint/eslint-plugin": "^6.6.0",
+    "@typescript-eslint/parser": "^6.6.0",
     "auto-changelog": "^2.4.0",
-    "eslint": "^8.44.0",
-    "eslint-config-prettier": "^8.8.0",
-    "eslint-plugin-import": "^2.27.5",
-    "eslint-plugin-jest": "^27.2.2",
+    "eslint": "^8.48.0",
+    "eslint-config-prettier": "^9.0.0",
+    "eslint-plugin-import": "^2.28.1",
+    "eslint-plugin-jest": "^27.2.3",
     "eslint-plugin-prettier": "^5.0.0",
-    "fastify": "^4.19.2",
-    "jest": "^29.6.1",
-    "newrelic": "10.4.1",
-    "pino": "^8.14.1",
-    "prettier": "^3.0.0",
+    "fastify": "^4.22.2",
+    "jest": "^29.6.4",
+    "newrelic": "11.0.0",
+    "pino": "^8.15.0",
+    "prettier": "^3.0.3",
     "shx": "^0.3.4",
     "ts-jest": "^29.1.1",
     "ts-node": "^10.9.1",
-    "typescript": "^5.1.6"
+    "typescript": "^5.2.2"
   },
   "engines": {
     "node": ">=18"