@lokalise/fastify-bullboard-plugin 1.0.0 → 1.1.0

package/dist/basicAuth.d.ts

@@ -0,0 +1,11 @@
+export type AuthConfig = {
+    isEnabled: boolean;
+    username: string;
+    password: string;
+};
+type BasicAuthOptions = {
+    config: AuthConfig;
+    enableList: Set<string>;
+};
+export declare const basicAuth: import("fastify").FastifyPluginCallback<BasicAuthOptions, import("fastify").RawServerDefault, import("fastify").FastifyTypeProviderDefault, import("fastify").FastifyBaseLogger>;
+export {};

package/dist/basicAuth.js

@@ -0,0 +1,40 @@
+import fastifyAuth from '@fastify/auth';
+import fastifyBasicAuth from '@fastify/basic-auth';
+import { AuthFailedError } from '@lokalise/node-core';
+import fp from 'fastify-plugin';
+function validate(config) {
+    return (username, password, _req, _reply, done) => {
+        if (username === config.username && password === config.password) {
+            done();
+        }
+        else {
+            done(new AuthFailedError());
+        }
+    };
+}
+function enableListAuthHandler(enableList) {
+    return (req, _res, done) => {
+        if (req.routeOptions.url && !enableList.has(req.routeOptions.url)) {
+            return done();
+        }
+        return done(new AuthFailedError());
+    };
+}
+async function plugin(fastify, pluginOptions) {
+    if (!pluginOptions.config.isEnabled) {
+        return;
+    }
+    await fastify.register(fastifyAuth);
+    await fastify.register(fastifyBasicAuth, {
+        validate: validate(pluginOptions.config),
+        authenticate: true,
+    });
+    fastify.after(() => {
+        fastify.addHook('onRequest', fastify.auth([enableListAuthHandler(pluginOptions.enableList), fastify.basicAuth]));
+    });
+}
+export const basicAuth = fp(plugin, {
+    fastify: '>=4.0.0',
+    name: 'basic-auth',
+});
+//# sourceMappingURL=basicAuth.js.map

package/dist/basicAuth.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"basicAuth.js","sourceRoot":"","sources":["../src/basicAuth.ts"],"names":[],"mappings":"AACA,OAAO,WAAW,MAAM,eAAe,CAAA;AACvC,OAAO,gBAAgB,MAAM,qBAAqB,CAAA;AAClD,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAA;AAErD,OAAO,EAAE,MAAM,gBAAgB,CAAA;AAa/B,SAAS,QAAQ,CAAC,MAAkB;IAClC,OAAO,CACL,QAAgB,EAChB,QAAgB,EAChB,IAAoB,EACpB,MAAoB,EACpB,IAA2B,EAC3B,EAAE;QACF,IAAI,QAAQ,KAAK,MAAM,CAAC,QAAQ,IAAI,QAAQ,KAAK,MAAM,CAAC,QAAQ,EAAE,CAAC;YACjE,IAAI,EAAE,CAAA;QACR,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,IAAI,eAAe,EAAE,CAAC,CAAA;QAC7B,CAAC;IACH,CAAC,CAAA;AACH,CAAC;AAED,SAAS,qBAAqB,CAAC,UAAuB;IACpD,OAAO,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE;QACzB,IAAI,GAAG,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,EAAE,CAAC;YAClE,OAAO,IAAI,EAAE,CAAA;QACf,CAAC;QAED,OAAO,IAAI,CAAC,IAAI,eAAe,EAAE,CAAC,CAAA;IACpC,CAAC,CAAA;AACH,CAAC;AAED,KAAK,UAAU,MAAM,CAAC,OAAwB,EAAE,aAA+B;IAC7E,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC;QACpC,OAAM;IACR,CAAC;IAED,MAAM,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAA;IACnC,MAAM,OAAO,CAAC,QAAQ,CAAC,gBAAgB,EAAE;QACvC,QAAQ,EAAE,QAAQ,CAAC,aAAa,CAAC,MAAM,CAAC;QACxC,YAAY,EAAE,IAAI;KACnB,CAAC,CAAA;IAEF,OAAO,CAAC,KAAK,CAAC,GAAG,EAAE;QACjB,OAAO,CAAC,OAAO,CACb,WAAW,EACX,OAAO,CAAC,IAAI,CAAC,CAAC,qBAAqB,CAAC,aAAa,CAAC,UAAU,CAAC,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC,CACnF,CAAA;IACH,CAAC,CAAC,CAAA;AACJ,CAAC;AAED,MAAM,CAAC,MAAM,SAAS,GAAG,EAAE,CAAmB,MAAM,EAAE;IACpD,OAAO,EAAE,SAAS;IAClB,IAAI,EAAE,YAAY;CACnB,CAAC,CAAA"}

package/dist/bullBoard.d.ts

@@ -0,0 +1,21 @@
+import { type RedisConfig } from '@lokalise/node-core';
+import type { Queue, QueueOptions, RedisConnection } from 'bullmq';
+import type { Redis } from 'ioredis';
+export type BullBoardOptions = {
+    queueConstructor: QueueProConstructor | QueueConstructor;
+    basePath: string;
+    refreshIntervalInSeconds?: number;
+} & ({
+    redisInstances: Redis[];
+    redisConfigs?: never;
+} | {
+    redisInstances?: never;
+    redisConfigs: RedisConfig[];
+});
+export interface QueueProConstructor {
+    new (name: string, opts?: Record<string, unknown>): Queue;
+}
+export interface QueueConstructor {
+    new (name: string, opts?: QueueOptions, Connection?: typeof RedisConnection): Queue;
+}
+export declare const bullBoard: import("fastify").FastifyPluginCallback<BullBoardOptions, import("fastify").RawServerDefault, import("fastify").FastifyTypeProviderDefault, import("fastify").FastifyBaseLogger>;

package/dist/bullBoard.js

@@ -0,0 +1,72 @@
+import { constants as httpConstants } from 'node:http2';
+import { createBullBoard } from '@bull-board/api';
+// @ts-ignore
+import { BullMQAdapter } from '@bull-board/api/bullMQAdapter.js';
+import { FastifyAdapter } from '@bull-board/fastify';
+import fastifySchedule from '@fastify/schedule';
+import { backgroundJobProcessorGetActiveQueueIds, createSanitizedRedisClient, QUEUE_GROUP_DELIMITER, } from '@lokalise/background-jobs-common';
+import { resolveGlobalErrorLogObject } from '@lokalise/node-core';
+import fp from 'fastify-plugin';
+import { AsyncTask, SimpleIntervalJob } from 'toad-scheduler';
+function containStatusCode(error) {
+    return Object.hasOwn(error, 'statusCode');
+}
+const bullBoardErrorHandler = (error) => {
+    const status = containStatusCode(error)
+        ? error.statusCode
+        : httpConstants.HTTP_STATUS_INTERNAL_SERVER_ERROR;
+    return {
+        status: status,
+        body: { message: error.message, details: error.stack },
+    };
+};
+async function getCurrentQueues(redisInstances, queueConstructor) {
+    const queueIds = await Promise.all(redisInstances.map((redis) => backgroundJobProcessorGetActiveQueueIds(redis)));
+    return queueIds
+        .flatMap((ids, index) => 
+    // biome-ignore lint/style/noNonNullAssertion: Should exist
+    ids.map((id) => new queueConstructor(id, { connection: redisInstances[index] })))
+        .map((queue) => new BullMQAdapter(queue, { delimiter: QUEUE_GROUP_DELIMITER }));
+}
+async function scheduleUpdates(fastify, bullBoard, resolvedRedisInstances, pluginOptions) {
+    const { refreshIntervalInSeconds, queueConstructor } = pluginOptions;
+    if (!refreshIntervalInSeconds || refreshIntervalInSeconds <= 0)
+        return;
+    const refreshTask = new AsyncTask('Bull-board - update queues', async () => {
+        fastify.log.debug({ refreshIntervalInSeconds }, 'Bull-dashboard -> updating queues');
+        bullBoard.replaceQueues(await getCurrentQueues(resolvedRedisInstances, queueConstructor));
+    }, (e) => fastify.log.error(resolveGlobalErrorLogObject(e)));
+    await fastify.register(fastifySchedule);
+    fastify.scheduler.addSimpleIntervalJob(new SimpleIntervalJob({ seconds: refreshIntervalInSeconds }, refreshTask, {
+        id: 'bull-board-queues-update',
+        preventOverrun: true,
+    }));
+}
+const resolveRedisInstances = (options) => {
+    if (options.redisInstances)
+        return options.redisInstances;
+    if (options.redisConfigs)
+        return options.redisConfigs.map(createSanitizedRedisClient);
+    throw new Error('Either `redisInstances` or `redisConfigs` must be provided in BullBoardOptions');
+};
+const plugin = async (fastify, pluginOptions) => {
+    const { basePath, queueConstructor } = pluginOptions;
+    const resolvedRedisInstances = resolveRedisInstances(pluginOptions);
+    const serverAdapter = new FastifyAdapter();
+    const bullBoard = createBullBoard({
+        queues: await getCurrentQueues(resolvedRedisInstances, queueConstructor),
+        serverAdapter,
+    });
+    // biome-ignore lint/suspicious/noExplicitAny: bull-board is not exporting this type
+    serverAdapter.setErrorHandler(bullBoardErrorHandler);
+    serverAdapter.setBasePath(basePath);
+    await fastify.register(serverAdapter.registerPlugin(), {
+        prefix: basePath,
+    });
+    await scheduleUpdates(fastify, bullBoard, resolvedRedisInstances, pluginOptions);
+};
+export const bullBoard = fp(plugin, {
+    fastify: '>=4.0.0',
+    name: 'bull-board',
+});
+//# sourceMappingURL=bullBoard.js.map

package/dist/bullBoard.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bullBoard.js","sourceRoot":"","sources":["../src/bullBoard.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,IAAI,aAAa,EAAE,MAAM,YAAY,CAAA;AACvD,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AACjD,aAAa;AACb,OAAO,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAA;AAChE,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AACpD,OAAO,eAAe,MAAM,mBAAmB,CAAA;AAC/C,OAAO,EACL,uCAAuC,EACvC,0BAA0B,EAC1B,qBAAqB,GACtB,MAAM,kCAAkC,CAAA;AACzC,OAAO,EAAoB,2BAA2B,EAAE,MAAM,qBAAqB,CAAA;AAGnF,OAAO,EAAE,MAAM,gBAAgB,CAAA;AAE/B,OAAO,EAAE,SAAS,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAA;AAiB7D,SAAS,iBAAiB,CAAC,KAAY;IACrC,OAAO,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,YAAY,CAAC,CAAA;AAC3C,CAAC;AAED,MAAM,qBAAqB,GAAG,CAAC,KAAY,EAAE,EAAE;IAC7C,MAAM,MAAM,GAAG,iBAAiB,CAAC,KAAK,CAAC;QACrC,CAAC,CAAC,KAAK,CAAC,UAAU;QAClB,CAAC,CAAC,aAAa,CAAC,iCAAiC,CAAA;IACnD,OAAO;QACL,MAAM,EAAE,MAAM;QACd,IAAI,EAAE,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,CAAC,KAAK,EAAE;KACvD,CAAA;AACH,CAAC,CAAA;AAUD,KAAK,UAAU,gBAAgB,CAC7B,cAAuB,EACvB,gBAAwD;IAExD,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,GAAG,CAChC,cAAc,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,uCAAuC,CAAC,KAAK,CAAC,CAAC,CAC9E,CAAA;IAED,OAAO,QAAQ;SACZ,OAAO,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE;IACtB,2DAA2D;IAC3D,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,IAAI,gBAAgB,CAAC,EAAE,EAAE,EAAE,UAAU,EAAE,cAAc,CAAC,KAAK,CAAE,EAAE,CAAC,CAAC,CAClF;SACA,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,aAAa,CAAC,KAAK,EAAE,EAAE,SAAS,EAAE,qBAAqB,EAAE,CAAC,CAAC,CAAA;AACnF,CAAC;AAED,KAAK,UAAU,eAAe,CAC5B,OAAwB,EACxB,SAA6C,EAC7C,sBAA+B,EAC/B,aAA+B;IAE/B,MAAM,EAAE,wBAAwB,EAAE,gBAAgB,EAAE,GAAG,aAAa,CAAA;IAEpE,IAAI,CAAC,wBAAwB,IAAI,wBAAwB,IAAI,CAAC;QAAE,OAAM;IAEtE,MAAM,WAAW,GAAG,IAAI,SAAS,CAC/B,4BAA4B,EAC5B,KAAK,IAAI,EAAE;QACT,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,wBAAwB,EAAE,EAAE,mCAAmC,CAAC,CAAA;QACpF,SAAS,CAAC,aAAa,CAAC,MAAM,gBAAgB,CAAC,sBAAsB,EAAE,gBAAgB,CAAC,CAAC,CAAA;IAC3F,CAAC,EACD,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,2BAA2B,CAAC,CAAC,CAAC,CAAC,CACzD,CAAA;IAED,MAAM,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAA;IACvC,OAAO,CAAC,SAAS,CAAC,oBAAoB,CACpC,IAAI,iBAAiB,CAAC,EAAE,OAAO,EAAE,wBAAwB,EAAE,EAAE,WAAW,EAAE;QACxE,EAAE,EAAE,0BAA0B;QAC9B,cAAc,EAAE,IAAI;KACrB,CAAC,CACH,CAAA;AACH,CAAC;AAED,MAAM,qBAAqB,GAAG,CAAC,OAAyB,EAAW,EAAE;IACnE,IAAI,OAAO,CAAC,cAAc;QAAE,OAAO,OAAO,CAAC,cAAc,CAAA;IACzD,IAAI,OAAO,CAAC,YAAY;QAAE,OAAO,OAAO,CAAC,YAAY,CAAC,GAAG,CAAC,0BAA0B,CAAC,CAAA;IAErF,MAAM,IAAI,KAAK,CAAC,gFAAgF,CAAC,CAAA;AACnG,CAAC,CAAA;AAED,MAAM,MAAM,GAAG,KAAK,EAAE,OAAwB,EAAE,aAA+B,EAAE,EAAE;IACjF,MAAM,EAAE,QAAQ,EAAE,gBAAgB,EAAE,GAAG,aAAa,CAAA;IACpD,MAAM,sBAAsB,GAAG,qBAAqB,CAAC,aAAa,CAAC,CAAA;IAEnE,MAAM,aAAa,GAAG,IAAI,cAAc,EAAE,CAAA;IAC1C,MAAM,SAAS,GAAG,eAAe,CAAC;QAChC,MAAM,EAAE,MAAM,gBAAgB,CAAC,sBAAsB,EAAE,gBAAgB,CAAC;QACxE,aAAa;KACd,CAAC,CAAA;IACF,oFAAoF;IACpF,aAAa,CAAC,eAAe,CAAC,qBAA4B,CAAC,CAAA;IAC3D,aAAa,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAA;IAEnC,MAAM,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAC,cAAc,EAAE,EAAE;QACrD,MAAM,EAAE,QAAQ;KACjB,CAAC,CAAA;IAEF,MAAM,eAAe,CAAC,OAAO,EAAE,SAAS,EAAE,sBAAsB,EAAE,aAAa,CAAC,CAAA;AAClF,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,SAAS,GAAG,EAAE,CAAmB,MAAM,EAAE;IACpD,OAAO,EAAE,SAAS;IAClB,IAAI,EAAE,YAAY;CACnB,CAAC,CAAA"}

package/dist/errorReporterPlugin.d.ts

@@ -0,0 +1,5 @@
+import type { ErrorReporter } from '@lokalise/node-core';
+export type ErrorReporterOptions = {
+    errorReporter: ErrorReporter;
+};
+export declare const errorReporterPlugin: import("fastify").FastifyPluginCallback<ErrorReporterOptions, import("fastify").RawServerDefault, import("fastify").FastifyTypeProviderDefault, import("fastify").FastifyBaseLogger>;

package/dist/errorReporterPlugin.js

@@ -0,0 +1,51 @@
+import { constants as httpConstants } from 'node:http2';
+import { isError, isInternalError, isObject, isPublicNonRecoverableError, } from '@lokalise/node-core';
+import fp from 'fastify-plugin';
+import { pino } from 'pino';
+function resolveLogObject(error) {
+    if (isInternalError(error)) {
+        return {
+            message: error.message,
+            code: error.errorCode,
+            details: error.details ? JSON.stringify(error.details) : undefined,
+            error: pino.stdSerializers.err({
+                name: error.name,
+                message: error.message,
+                stack: error.stack,
+            }),
+        };
+    }
+    if (isError(error)) {
+        return {
+            message: error.message,
+            error: pino.stdSerializers.err({
+                name: error.name,
+                message: error.message,
+                stack: error.stack,
+            }),
+        };
+    }
+    return {
+        message: isObject(error) ? error.message : JSON.stringify(error),
+        error,
+    };
+}
+function plugin(fastify, pluginOptions, next) {
+    fastify.addHook('onError', (request, _reply, error, done) => {
+        let statusCode = error.statusCode ?? httpConstants.HTTP_STATUS_INTERNAL_SERVER_ERROR;
+        if (isPublicNonRecoverableError(error)) {
+            statusCode = error.httpStatusCode;
+        }
+        if (statusCode >= httpConstants.HTTP_STATUS_INTERNAL_SERVER_ERROR) {
+            request.log.error(resolveLogObject(error));
+            pluginOptions.errorReporter.report({ error });
+        }
+        done();
+    });
+    next();
+}
+export const errorReporterPlugin = fp(plugin, {
+    fastify: '>=4.0.0',
+    name: 'error-reporter',
+});
+//# sourceMappingURL=errorReporterPlugin.js.map

package/dist/errorReporterPlugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errorReporterPlugin.js","sourceRoot":"","sources":["../src/errorReporterPlugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,IAAI,aAAa,EAAE,MAAM,YAAY,CAAA;AAGvD,OAAO,EACL,OAAO,EACP,eAAe,EACf,QAAQ,EACR,2BAA2B,GAC5B,MAAM,qBAAqB,CAAA;AAE5B,OAAO,EAAE,MAAM,gBAAgB,CAAA;AAC/B,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAA;AAM3B,SAAS,gBAAgB,CAAC,KAAc;IACtC,IAAI,eAAe,CAAC,KAAK,CAAC,EAAE,CAAC;QAC3B,OAAO;YACL,OAAO,EAAE,KAAK,CAAC,OAAO;YACtB,IAAI,EAAE,KAAK,CAAC,SAAS;YACrB,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS;YAClE,KAAK,EAAE,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC;gBAC7B,IAAI,EAAE,KAAK,CAAC,IAAI;gBAChB,OAAO,EAAE,KAAK,CAAC,OAAO;gBACtB,KAAK,EAAE,KAAK,CAAC,KAAK;aACnB,CAAC;SACH,CAAA;IACH,CAAC;IACD,IAAI,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACnB,OAAO;YACL,OAAO,EAAE,KAAK,CAAC,OAAO;YACtB,KAAK,EAAE,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC;gBAC7B,IAAI,EAAE,KAAK,CAAC,IAAI;gBAChB,OAAO,EAAE,KAAK,CAAC,OAAO;gBACtB,KAAK,EAAE,KAAK,CAAC,KAAK;aACnB,CAAC;SACH,CAAA;IACH,CAAC;IAED,OAAO;QACL,OAAO,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC;QAChE,KAAK;KACN,CAAA;AACH,CAAC;AAED,SAAS,MAAM,CACb,OAAwB,EACxB,aAAmC,EACnC,IAA2B;IAE3B,OAAO,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;QAC1D,IAAI,UAAU,GAAG,KAAK,CAAC,UAAU,IAAI,aAAa,CAAC,iCAAiC,CAAA;QACpF,IAAI,2BAA2B,CAAC,KAAK,CAAC,EAAE,CAAC;YACvC,UAAU,GAAG,KAAK,CAAC,cAAc,CAAA;QACnC,CAAC;QAED,IAAI,UAAU,IAAI,aAAa,CAAC,iCAAiC,EAAE,CAAC;YAClE,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,CAAA;YAC1C,aAAa,CAAC,aAAa,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC,CAAA;QAC/C,CAAC;QAED,IAAI,EAAE,CAAA;IACR,CAAC,CAAC,CAAA;IAEF,IAAI,EAAE,CAAA;AACR,CAAC;AAED,MAAM,CAAC,MAAM,mBAAmB,GAAG,EAAE,CAAuB,MAAM,EAAE;IAClE,OAAO,EAAE,SAAS;IAClB,IAAI,EAAE,gBAAgB;CACvB,CAAC,CAAA"}

package/{src/index.ts → dist/index.d.ts}

@@ -1,3 +1,3 @@
-export { type AuthConfig, basicAuth } from './basicAuth.js'
-export { type BullBoardOptions, bullBoard, type QueueProConstructor } from './bullBoard.js'
-export { type ErrorReporterOptions, errorReporterPlugin } from './errorReporterPlugin.js'
+export { type AuthConfig, basicAuth } from './basicAuth.js';
+export { type BullBoardOptions, bullBoard, type QueueProConstructor } from './bullBoard.js';
+export { type ErrorReporterOptions, errorReporterPlugin } from './errorReporterPlugin.js';

package/dist/index.js

@@ -0,0 +1,4 @@
+export { basicAuth } from './basicAuth.js';
+export { bullBoard } from './bullBoard.js';
+export { errorReporterPlugin } from './errorReporterPlugin.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAmB,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC3D,OAAO,EAAyB,SAAS,EAA4B,MAAM,gBAAgB,CAAA;AAC3F,OAAO,EAA6B,mBAAmB,EAAE,MAAM,0BAA0B,CAAA"}

package/package.json

@@ -1,7 +1,12 @@
 {
     "name": "@lokalise/fastify-bullboard-plugin",
-    "version": "1.0.0",
+    "version": "1.1.0",
     "type": "module",
+    "files": [
+        "dist",
+        "README.md",
+        "LICENSE.md"
+    ],
     "engines": {
         "node": ">=20.13.0"
     },

package/src/basicAuth.spec.ts

@@ -1,79 +0,0 @@
-import fastify, { type FastifyInstance } from 'fastify'
-import { beforeAll, describe, expect } from 'vitest'
-
-import { basicAuth } from './basicAuth.js'
-
-const skippedEndpoint = '/skipAuth'
-const enabledEndpoint = '/'
-
-async function initApp(authEnabled: boolean) {
-  const app = fastify()
-  await app.register(basicAuth, {
-    config: { isEnabled: authEnabled, username: 'test', password: 'test' },
-    enableList: new Set([enabledEndpoint]),
-  })
-
-  app.route({
-    method: 'GET',
-    url: '/',
-    handler: (_req, reply) => {
-      return reply.status(200).send({ hello: 'world' })
-    },
-  })
-
-  app.route({
-    method: 'GET',
-    url: skippedEndpoint,
-    handler: (_req, reply) => {
-      return reply.status(200).send({ hello: 'my friend' })
-    },
-  })
-
-  await app.ready()
-  return app
-}
-
-describe('basicAuth', () => {
-  let app: FastifyInstance
-
-  afterAll(async () => {
-    await app.close()
-  })
-
-  const performRequest = async (path: string) => app.inject().get(path).end()
-
-  describe('auth enabled', () => {
-    beforeAll(async () => {
-      app = await initApp(true)
-    })
-
-    it('returns 401 on not skipped endpoints', async () => {
-      const response = await performRequest('/')
-      expect(response.statusCode).toBe(401)
-    })
-
-    it('works on skipped endpoints', async () => {
-      const response = await performRequest(skippedEndpoint)
-      expect(response.statusCode).toBe(200)
-      expect(response.json()).toEqual({ hello: 'my friend' })
-    })
-  })
-
-  describe('auth disabled', () => {
-    beforeAll(async () => {
-      app = await initApp(false)
-    })
-
-    it('works on not skipped endpoints', async () => {
-      const response = await performRequest('/')
-      expect(response.statusCode).toBe(200)
-      expect(response.json()).toEqual({ hello: 'world' })
-    })
-
-    it('works on skipped endpoints', async () => {
-      const response = await performRequest(skippedEndpoint)
-      expect(response.statusCode).toBe(200)
-      expect(response.json()).toEqual({ hello: 'my friend' })
-    })
-  })
-})

package/src/basicAuth.ts

@@ -1,67 +0,0 @@
-import type { FastifyAuthFunction } from '@fastify/auth'
-import fastifyAuth from '@fastify/auth'
-import fastifyBasicAuth from '@fastify/basic-auth'
-import { AuthFailedError } from '@lokalise/node-core'
-import type { FastifyInstance, FastifyReply, FastifyRequest } from 'fastify'
-import fp from 'fastify-plugin'
-
-export type AuthConfig = {
-  isEnabled: boolean
-  username: string
-  password: string
-}
-
-type BasicAuthOptions = {
-  config: AuthConfig
-  enableList: Set<string>
-}
-
-function validate(config: AuthConfig) {
-  return (
-    username: string,
-    password: string,
-    _req: FastifyRequest,
-    _reply: FastifyReply,
-    done: (err?: Error) => void,
-  ) => {
-    if (username === config.username && password === config.password) {
-      done()
-    } else {
-      done(new AuthFailedError())
-    }
-  }
-}
-
-function enableListAuthHandler(enableList: Set<string>): FastifyAuthFunction {
-  return (req, _res, done) => {
-    if (req.routeOptions.url && !enableList.has(req.routeOptions.url)) {
-      return done()
-    }
-
-    return done(new AuthFailedError())
-  }
-}
-
-async function plugin(fastify: FastifyInstance, pluginOptions: BasicAuthOptions): Promise<void> {
-  if (!pluginOptions.config.isEnabled) {
-    return
-  }
-
-  await fastify.register(fastifyAuth)
-  await fastify.register(fastifyBasicAuth, {
-    validate: validate(pluginOptions.config),
-    authenticate: true,
-  })
-
-  fastify.after(() => {
-    fastify.addHook(
-      'onRequest',
-      fastify.auth([enableListAuthHandler(pluginOptions.enableList), fastify.basicAuth]),
-    )
-  })
-}
-
-export const basicAuth = fp<BasicAuthOptions>(plugin, {
-  fastify: '>=4.0.0',
-  name: 'basic-auth',
-})

package/src/bullBoard.spec.ts

@@ -1,67 +0,0 @@
-import { Queue } from 'bullmq'
-import fastify, { type FastifyInstance } from 'fastify'
-import { beforeAll, expect } from 'vitest'
-import { type BullBoardOptions, bullBoard, type QueueProConstructor } from './bullBoard.js'
-
-const QueuePro: QueueProConstructor = Queue as QueueProConstructor
-
-async function initApp(options: BullBoardOptions) {
-  const app = fastify()
-
-  await app.register(bullBoard, options)
-
-  await app.ready()
-  return app
-}
-
-describe('bull board', () => {
-  let app: FastifyInstance
-
-  afterAll(async () => {
-    await app.close()
-  })
-
-  describe('refresh disabled', () => {
-    beforeAll(async () => {
-      app = await initApp({
-        queueConstructor: QueuePro,
-        redisInstances: [],
-        basePath: '/test-disabled',
-      })
-    })
-
-    it('works', async () => {
-      const response = await app.inject().get('/test-disabled').end()
-
-      expect(response.statusCode).toBe(200)
-      expect(response.body.toLowerCase()).includes('<!doctype html>')
-      expect(response.body.toLowerCase()).includes('<title>bull dashboard</title>')
-
-      expect(app.scheduler).toBeUndefined()
-    })
-  })
-
-  describe('refresh enabled', () => {
-    beforeAll(async () => {
-      app = await initApp({
-        queueConstructor: Queue,
-        redisInstances: [],
-        basePath: '/test-enabled',
-        refreshIntervalInSeconds: 1,
-      })
-    })
-
-    it('works', async () => {
-      const response = await app.inject().get('/test-enabled').end()
-
-      expect(response.statusCode).toBe(200)
-      expect(response.body.toLowerCase()).includes('<!doctype html>')
-      expect(response.body.toLowerCase()).includes('<title>bull dashboard</title>')
-
-      expect(app.scheduler).toBeDefined()
-      const jobs = app.scheduler.getAllJobs()
-      expect(jobs).toHaveLength(1)
-      expect(jobs[0]!.id).toBe('bull-board-queues-update')
-    })
-  })
-})

package/src/bullBoard.ts

@@ -1,112 +0,0 @@
-import { constants as httpConstants } from 'node:http2'
-import { createBullBoard } from '@bull-board/api'
-// @ts-ignore
-import { BullMQAdapter } from '@bull-board/api/bullMQAdapter.js'
-import { FastifyAdapter } from '@bull-board/fastify'
-import fastifySchedule from '@fastify/schedule'
-import {
-  backgroundJobProcessorGetActiveQueueIds,
-  QUEUE_GROUP_DELIMITER,
-} from '@lokalise/background-jobs-common'
-import { resolveGlobalErrorLogObject } from '@lokalise/node-core'
-import type { Queue, QueueOptions, RedisConnection } from 'bullmq'
-import type { FastifyInstance } from 'fastify'
-import fp from 'fastify-plugin'
-import type { Redis } from 'ioredis'
-import { AsyncTask, SimpleIntervalJob } from 'toad-scheduler'
-
-export type BullBoardOptions = {
-  queueConstructor: QueueProConstructor | QueueConstructor
-  redisInstances: Redis[]
-  basePath: string
-  refreshIntervalInSeconds?: number
-}
-
-function containStatusCode(error: Error): error is Error & { statusCode: number } {
-  return Object.hasOwn(error, 'statusCode')
-}
-
-const bullBoardErrorHandler = (error: Error) => {
-  const status = containStatusCode(error)
-    ? error.statusCode
-    : httpConstants.HTTP_STATUS_INTERNAL_SERVER_ERROR
-  return {
-    status: status,
-    body: { message: error.message, details: error.stack },
-  }
-}
-
-export interface QueueProConstructor {
-  new (name: string, opts?: Record<string, unknown>): Queue
-}
-
-export interface QueueConstructor {
-  new (name: string, opts?: QueueOptions, Connection?: typeof RedisConnection): Queue
-}
-
-async function getCurrentQueues(
-  redisInstances: Redis[],
-  queueConstructor: QueueProConstructor | QueueConstructor,
-): Promise<BullMQAdapter[]> {
-  const queueIds = await Promise.all(
-    redisInstances.map((redis) => backgroundJobProcessorGetActiveQueueIds(redis)),
-  )
-
-  return queueIds
-    .flatMap((ids, index) =>
-      // biome-ignore lint/style/noNonNullAssertion: Should exist
-      ids.map((id) => new queueConstructor(id, { connection: redisInstances[index]! })),
-    )
-    .map((queue) => new BullMQAdapter(queue, { delimiter: QUEUE_GROUP_DELIMITER }))
-}
-
-async function scheduleUpdates(
-  fastify: FastifyInstance,
-  bullBoard: ReturnType<typeof createBullBoard>,
-  pluginOptions: BullBoardOptions,
-) {
-  const { refreshIntervalInSeconds, redisInstances, queueConstructor } = pluginOptions
-
-  if (!refreshIntervalInSeconds || refreshIntervalInSeconds <= 0) return
-
-  const refreshTask = new AsyncTask(
-    'Bull-board - update queues',
-    async () => {
-      fastify.log.debug({ refreshIntervalInSeconds }, 'Bull-dashboard -> updating queues')
-      bullBoard.replaceQueues(await getCurrentQueues(redisInstances, queueConstructor))
-    },
-    (e) => fastify.log.error(resolveGlobalErrorLogObject(e)),
-  )
-
-  await fastify.register(fastifySchedule)
-  fastify.scheduler.addSimpleIntervalJob(
-    new SimpleIntervalJob({ seconds: refreshIntervalInSeconds }, refreshTask, {
-      id: 'bull-board-queues-update',
-      preventOverrun: true,
-    }),
-  )
-}
-
-const plugin = async (fastify: FastifyInstance, pluginOptions: BullBoardOptions) => {
-  const { basePath, redisInstances, queueConstructor } = pluginOptions
-
-  const serverAdapter = new FastifyAdapter()
-  const bullBoard = createBullBoard({
-    queues: await getCurrentQueues(redisInstances, queueConstructor),
-    serverAdapter,
-  })
-  // biome-ignore lint/suspicious/noExplicitAny: bull-board is not exporting this type
-  serverAdapter.setErrorHandler(bullBoardErrorHandler as any)
-  serverAdapter.setBasePath(basePath)
-
-  await fastify.register(serverAdapter.registerPlugin(), {
-    prefix: basePath,
-  })
-
-  await scheduleUpdates(fastify, bullBoard, pluginOptions)
-}
-
-export const bullBoard = fp<BullBoardOptions>(plugin, {
-  fastify: '>=4.0.0',
-  name: 'bull-board',
-})

package/src/errorReporterPlugin.spec.ts

@@ -1,127 +0,0 @@
-import { type ErrorReporter, InternalError, PublicNonRecoverableError } from '@lokalise/node-core'
-import fastify, { type FastifyInstance, type RouteHandlerMethod } from 'fastify'
-import { pino } from 'pino'
-import { afterAll, describe, expect, it, type MockInstance, vi } from 'vitest'
-
-import { FakeErrorReporter } from '../test/FakeErrorReporter.js'
-import { errorReporterPlugin } from './errorReporterPlugin.js'
-
-async function initApp(routeHandler: RouteHandlerMethod, errorReporter: ErrorReporter) {
-  const app = fastify({
-    logger: true,
-  })
-  await app.register(errorReporterPlugin, { errorReporter })
-
-  app.route({
-    method: 'GET',
-    url: '/',
-    handler: routeHandler,
-  })
-
-  await app.ready()
-  return app
-}
-
-describe('errorHandlerPlugin', () => {
-  let app: FastifyInstance
-
-  afterAll(async () => {
-    await app.close()
-  })
-
-  const performRequest = async () => app.inject().get('/').end()
-
-  it('generic errors are reported', async () => {
-    const fakeErrorReporter = new FakeErrorReporter()
-    const error = new Error('Generic error')
-    let logSpy: MockInstance | undefined
-    app = await initApp((req) => {
-      logSpy = vi.spyOn(req.log, 'error')
-      throw error
-    }, fakeErrorReporter)
-
-    await performRequest()
-
-    expect(fakeErrorReporter.calls).length(1)
-    expect(fakeErrorReporter.calls[0]).toEqual({ error })
-    expect(logSpy).toHaveBeenCalledWith({
-      message: error.message,
-      error: pino.stdSerializers.err({
-        name: error.name,
-        message: error.message,
-        stack: error.stack,
-      }),
-    })
-  })
-
-  it('internal errors are reported', async () => {
-    const fakeErrorReporter = new FakeErrorReporter()
-    const error = new InternalError({
-      message: 'Internal error',
-      errorCode: 'INTERNAL_ERROR',
-    })
-    let logSpy: MockInstance | undefined
-    app = await initApp((req) => {
-      logSpy = vi.spyOn(req.log, 'error')
-      throw error
-    }, fakeErrorReporter)
-
-    await performRequest()
-
-    expect(fakeErrorReporter.calls).length(1)
-    expect(fakeErrorReporter.calls[0]).toEqual({ error })
-    expect(logSpy).toHaveBeenCalledWith({
-      message: error.message,
-      code: error.errorCode,
-      details: error.details ? JSON.stringify(error.details) : undefined,
-      error: pino.stdSerializers.err({
-        name: error.name,
-        message: error.message,
-        stack: error.stack,
-      }),
-    })
-  })
-
-  it('5xx errors are reported', async () => {
-    const fakeErrorReporter = new FakeErrorReporter()
-    const error = new PublicNonRecoverableError({
-      httpStatusCode: 500,
-      message: 'Internal error',
-      errorCode: 'INTERNAL_ERROR',
-    })
-    let logSpy: MockInstance | undefined
-    app = await initApp((req) => {
-      logSpy = vi.spyOn(req.log, 'error')
-      throw error
-    }, fakeErrorReporter)
-
-    await performRequest()
-
-    expect(fakeErrorReporter.calls).length(1)
-    expect(fakeErrorReporter.calls[0]).toEqual({ error })
-    expect(logSpy).toHaveBeenCalledWith({
-      message: error.message,
-      error: pino.stdSerializers.err({
-        name: error.name,
-        message: error.message,
-        stack: error.stack,
-      }),
-    })
-  })
-
-  it('4xx erros are ignored', async () => {
-    const fakeErrorReporter = new FakeErrorReporter()
-    const error = new PublicNonRecoverableError({
-      httpStatusCode: 400,
-      message: 'test',
-      errorCode: 'TEST',
-    })
-    app = await initApp(() => {
-      throw error
-    }, fakeErrorReporter)
-
-    await performRequest()
-
-    expect(fakeErrorReporter.calls).length(0)
-  })
-})

package/src/errorReporterPlugin.ts

@@ -1,73 +0,0 @@
-import { constants as httpConstants } from 'node:http2'
-
-import type { ErrorReporter } from '@lokalise/node-core'
-import {
-  isError,
-  isInternalError,
-  isObject,
-  isPublicNonRecoverableError,
-} from '@lokalise/node-core'
-import type { FastifyInstance } from 'fastify'
-import fp from 'fastify-plugin'
-import { pino } from 'pino'
-
-export type ErrorReporterOptions = {
-  errorReporter: ErrorReporter
-}
-
-function resolveLogObject(error: unknown): Record<string, unknown> {
-  if (isInternalError(error)) {
-    return {
-      message: error.message,
-      code: error.errorCode,
-      details: error.details ? JSON.stringify(error.details) : undefined,
-      error: pino.stdSerializers.err({
-        name: error.name,
-        message: error.message,
-        stack: error.stack,
-      }),
-    }
-  }
-  if (isError(error)) {
-    return {
-      message: error.message,
-      error: pino.stdSerializers.err({
-        name: error.name,
-        message: error.message,
-        stack: error.stack,
-      }),
-    }
-  }
-
-  return {
-    message: isObject(error) ? error.message : JSON.stringify(error),
-    error,
-  }
-}
-
-function plugin(
-  fastify: FastifyInstance,
-  pluginOptions: ErrorReporterOptions,
-  next: (err?: Error) => void,
-) {
-  fastify.addHook('onError', (request, _reply, error, done) => {
-    let statusCode = error.statusCode ?? httpConstants.HTTP_STATUS_INTERNAL_SERVER_ERROR
-    if (isPublicNonRecoverableError(error)) {
-      statusCode = error.httpStatusCode
-    }
-
-    if (statusCode >= httpConstants.HTTP_STATUS_INTERNAL_SERVER_ERROR) {
-      request.log.error(resolveLogObject(error))
-      pluginOptions.errorReporter.report({ error })
-    }
-
-    done()
-  })
-
-  next()
-}
-
-export const errorReporterPlugin = fp<ErrorReporterOptions>(plugin, {
-  fastify: '>=4.0.0',
-  name: 'error-reporter',
-})

package/test/FakeErrorReporter.ts

@@ -1,18 +0,0 @@
-import type { ErrorReport } from '@lokalise/fastify-extras'
-import type { ErrorReporter } from '@lokalise/node-core'
-
-export class FakeErrorReporter implements ErrorReporter {
-  private _calls: ErrorReport[] = []
-
-  report(errorReport: ErrorReport): void {
-    this._calls.push(errorReport)
-  }
-
-  clean(): void {
-    this._calls = []
-  }
-
-  get calls(): ErrorReport[] {
-    return this._calls
-  }
-}

package/tsconfig.build.json

@@ -1,5 +0,0 @@
-{
-    "extends": ["./tsconfig.json", "@lokalise/tsconfig/build-public-lib"],
-    "include": ["src/**/*"],
-    "exclude": ["src/**/*.spec.ts", "src/**/*.test.ts"]
-}

package/tsconfig.json

@@ -1,7 +0,0 @@
-{
-    "extends": "@lokalise/tsconfig/tsc",
-    "include": ["src/**/*", "vitest.config.ts"],
-    "compilerOptions": {
-        "types": ["vitest/globals"]
-    }
-}

package/vitest.config.ts

@@ -1,22 +0,0 @@
-import { defineConfig } from 'vitest/config'
-
-// biome-ignore lint/style/noDefaultExport: vite expects default export
-export default defineConfig({
-  test: {
-    globals: true,
-    watch: false,
-    restoreMocks: true,
-    pool: 'threads',
-    coverage: {
-      provider: 'v8',
-      include: ['src/**/*.ts'],
-      exclude: ['src/index.ts'],
-      thresholds: {
-        lines: 84,
-        functions: 80,
-        branches: 86,
-        statements: 84,
-      },
-    },
-  },
-})