@bull-board/nestjs 8.0.2 → 8.1.0

package/README.md

@@ -144,10 +144,32 @@ export class FeatureModule {}
 
 The `forFeature` method registers the given queues to the bull-board instance.
 The following options are available.
-- `name` the queue name to register
+- `name` the queue name to resolve from the Nest DI container.
+- `queue` a queue instance to register directly, instead of resolving it by `name`.
 - `adapter` either `BullAdapter` or `BullMQAdapter` depending on which package you use.
 - `options` queue adapter options as found in the bull-board package, such as `readOnlyMode`, `description` etc.
 
+Provide either `name` or `queue`.
+
+### Registering queue instances directly
+
+`@nestjs/bullmq` generates the DI token for a queue from its `name` only, ignoring the
+`prefix`. Two queues that share a name but use different prefixes therefore collapse onto a
+single DI token, and a `name`-based lookup cannot tell them apart. Pass the queue instances
+directly via `queue` to register them as distinct board entries:
+
+```typescript
+@Module({
+  imports: [
+    BullBoardModule.forFeature(
+      { queue: emailsTenantA, adapter: BullMQAdapter, options: { prefix: 'tenant-a:' } },
+      { queue: emailsTenantB, adapter: BullMQAdapter, options: { prefix: 'tenant-b:' } },
+    ),
+  ],
+})
+export class FeatureModule {}
+```
+
 ##  Using the bull-board instance in your controllers and/or services.
 The created bull-board instance is available via the `@InjectBullBoard()` decorator.
 For example in a controller:

package/dist/bull-board.feature-module.js

@@ -24,8 +24,9 @@ let BullBoardFeatureModule = class BullBoardFeatureModule {
         this.board = board;
     }
     onModuleInit() {
+        var _a;
         for (const queueOption of this.queues) {
-            const queue = this.moduleRef.get((0, bull_shared_1.getQueueToken)(queueOption.name), { strict: false });
+            const queue = (_a = queueOption.queue) !== null && _a !== void 0 ? _a : this.moduleRef.get((0, bull_shared_1.getQueueToken)(queueOption.name), { strict: false });
             const queueAdapter = new queueOption.adapter(queue, queueOption.options);
             this.board.addQueue(queueAdapter);
         }

package/dist/bull-board.types.d.ts

@@ -16,13 +16,29 @@ export type BullBoardModuleAsyncOptions = {
     imports?: ModuleMetadata['imports'];
     inject?: Array<InjectionToken | OptionalFactoryDependency>;
 };
-export type BullBoardQueueOptions = {
-    name: string;
+type BullBoardQueueCommonOptions = {
     adapter: {
         new (queue: any, options?: Partial<QueueAdapterOptions>): BaseAdapter;
     };
     options?: Partial<QueueAdapterOptions>;
 };
+export type BullBoardQueueOptions = BullBoardQueueCommonOptions & ({
+    /**
+     * The queue name to resolve from the Nest DI container (via `getQueueToken`).
+     */
+    name: string;
+    queue?: undefined;
+} | {
+    /**
+     * A queue instance to register directly, bypassing the DI container lookup.
+     *
+     * Use this when the name-based lookup cannot disambiguate the queue — e.g. two
+     * queues sharing the same name but using different prefixes, which `@nestjs/bullmq`
+     * collapses onto a single DI token.
+     */
+    queue: unknown;
+    name?: string;
+});
 export type BullBoardServerAdapter = IServerAdapter & {
     setBasePath(path: string): any;
 };
@@ -32,3 +48,4 @@ export type BullBoardFastifyAdapter = BullBoardServerAdapter & {
 export type BullBoardExpressAdapter = BullBoardServerAdapter & {
     getRouter(): any;
 };
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bull-board/nestjs",
-  "version": "8.0.2",
+  "version": "8.1.0",
   "description": "A NestJS module for Bull-Board dashboard.",
   "keywords": [
     "bull",
@@ -28,9 +28,9 @@
     "test": "jest"
   },
   "devDependencies": {
-    "@bull-board/api": "^8.0.2",
-    "@bull-board/express": "^8.0.2",
-    "@bull-board/fastify": "^8.0.2",
+    "@bull-board/api": "^8.1.0",
+    "@bull-board/express": "^8.1.0",
+    "@bull-board/fastify": "^8.1.0",
     "@bull-board/test-utils": "workspace:*",
     "@nestjs/bull-shared": "^11.0.4",
     "@nestjs/bullmq": "^11.0.4",
@@ -49,7 +49,7 @@
     "typescript": "^5.9.3"
   },
   "peerDependencies": {
-    "@bull-board/api": "^8.0.2",
+    "@bull-board/api": "^8.1.0",
     "@nestjs/bull-shared": "^10.0.0 || ^11.0.0",
     "@nestjs/common": "^9.0.0 || ^10.0.0 || ^11.0.0",
     "@nestjs/core": "^9.0.0 || ^10.0.0 || ^11.0.0",

package/src/bull-board.feature-module.ts

@@ -15,7 +15,9 @@ export class BullBoardFeatureModule implements OnModuleInit {
 
   onModuleInit(): any {
     for (const queueOption of this.queues) {
-      const queue = this.moduleRef.get<Queue>(getQueueToken(queueOption.name), { strict: false });
+      const queue =
+        queueOption.queue ??
+        this.moduleRef.get<Queue>(getQueueToken(queueOption.name), { strict: false });
       const queueAdapter = new queueOption.adapter(queue, queueOption.options);
       this.board.addQueue(queueAdapter);
     }

package/src/bull-board.types.ts

@@ -22,12 +22,33 @@ export type BullBoardModuleAsyncOptions = {
   inject?: Array<InjectionToken | OptionalFactoryDependency>;
 };
 
-export type BullBoardQueueOptions = {
-  name: string;
+type BullBoardQueueCommonOptions = {
   adapter: { new (queue: any, options?: Partial<QueueAdapterOptions>): BaseAdapter };
   options?: Partial<QueueAdapterOptions>;
 };
 
+export type BullBoardQueueOptions = BullBoardQueueCommonOptions &
+  (
+    | {
+        /**
+         * The queue name to resolve from the Nest DI container (via `getQueueToken`).
+         */
+        name: string;
+        queue?: undefined;
+      }
+    | {
+        /**
+         * A queue instance to register directly, bypassing the DI container lookup.
+         *
+         * Use this when the name-based lookup cannot disambiguate the queue — e.g. two
+         * queues sharing the same name but using different prefixes, which `@nestjs/bullmq`
+         * collapses onto a single DI token.
+         */
+        queue: unknown;
+        name?: string;
+      }
+  );
+
 //create our own types with the needed functions, so we don't need to include express/fastify libraries here.
 export type BullBoardServerAdapter = IServerAdapter & { setBasePath(path: string): any };
 export type BullBoardFastifyAdapter = BullBoardServerAdapter & { registerPlugin(): any };

package/tests/same-name-prefix.spec.ts

@@ -0,0 +1,87 @@
+import 'reflect-metadata';
+import { BullMQAdapter } from '@bull-board/api/bullMQAdapter';
+import { ExpressAdapter as BullBoardExpressAdapter } from '@bull-board/express';
+import { uiFixtureBasePath } from '@bull-board/test-utils';
+import { BullModule } from '@nestjs/bullmq';
+import { INestApplication, Module } from '@nestjs/common';
+import { NestFactory } from '@nestjs/core';
+import { ExpressAdapter } from '@nestjs/platform-express';
+import { Queue } from 'bullmq';
+import request from 'supertest';
+import { BullBoardModule } from '../src';
+
+const connection = {
+  host: process.env.REDIS_HOST || 'localhost',
+  port: +(process.env.REDIS_PORT || 6379),
+};
+
+describe('forFeature with queue instances (same name, different prefix)', () => {
+  const queues: Queue[] = [];
+  let app: INestApplication | undefined;
+
+  afterEach(async () => {
+    if (app) {
+      await app.close();
+      app = undefined;
+    }
+    await Promise.all(queues.map((queue) => queue.close()));
+    queues.length = 0;
+  });
+
+  it('registers both queues as distinct board entries', async () => {
+    const emailsA = new Queue('emails', { connection, prefix: 'tenant-a' });
+    const emailsB = new Queue('emails', { connection, prefix: 'tenant-b' });
+    queues.push(emailsA, emailsB);
+
+    @Module({
+      imports: [
+        BullBoardModule.forRoot({
+          route: '/queues',
+          adapter: BullBoardExpressAdapter,
+          boardOptions: { uiBasePath: uiFixtureBasePath },
+        }),
+        BullBoardModule.forFeature(
+          { queue: emailsA, adapter: BullMQAdapter, options: { prefix: 'tenant-a:' } },
+          { queue: emailsB, adapter: BullMQAdapter, options: { prefix: 'tenant-b:' } }
+        ),
+      ],
+    })
+    class AppModule {}
+
+    app = await NestFactory.create(AppModule, new ExpressAdapter(), { logger: false });
+    await app.init();
+
+    const res = await request(app.getHttpServer()).get('/queues/api/queues').expect(200);
+    const names = (JSON.parse(res.text).queues as Array<{ name: string }>)
+      .map((queue) => queue.name)
+      .sort();
+
+    expect(names).toEqual(['tenant-a:emails', 'tenant-b:emails']);
+  });
+
+  it('still resolves a queue from the DI container when only a name is given', async () => {
+    @Module({
+      imports: [
+        BullModule.forRoot({ connection }),
+        BullModule.registerQueue({ name: 'reports' }),
+        BullBoardModule.forRoot({
+          route: '/queues',
+          adapter: BullBoardExpressAdapter,
+          boardOptions: { uiBasePath: uiFixtureBasePath },
+        }),
+        BullBoardModule.forFeature({ name: 'reports', adapter: BullMQAdapter }),
+      ],
+    })
+    class AppModule {}
+
+    app = await NestFactory.create(AppModule, new ExpressAdapter(), { logger: false });
+    await app.init();
+
+    const res = await request(app.getHttpServer()).get('/queues/api/queues').expect(200);
+    const names = (JSON.parse(res.text).queues as Array<{ name: string }>).map(
+      (queue) => queue.name
+    );
+
+    expect(names).toEqual(['reports']);
+  });
+});