fix: bull-board missing export adapter (midwayjs#4351)

Author: czy88840616

packages/bull-board/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@midwayjs/bull-board",
   "version": "3.20.6",
-  "description": "midway component for bull",
+  "description": "midway component for bull-board",
   "main": "dist/index.js",
   "typings": "index.d.ts",
   "scripts": {

packages/bull-board/src/index.ts

@@ -3,3 +3,6 @@ export * from './board.middleware';
 export * from './board.manager';
 export * from './interface';
 export * as BullBoard from '@bull-board/api';
+export { MidwayAdapter } from './adapter';
+export { BullAdapter } from '@bull-board/api/bullAdapter';
+export { BullMQAdapter } from '@bull-board/api/bullMQAdapter';

packages/bull-board/test/index.test.ts

@@ -2,6 +2,8 @@ import { createApp, close, createHttpRequest, createLightApp } from '@midwayjs/m
 import { join } from 'path';
 import * as bullboard from '../src';
 import * as bullmq from '@midwayjs/bullmq';
+import * as bull from '@midwayjs/bull';
+import * as koa from '@midwayjs/koa';
 
 describe(`/test/index.test.ts`, () => {
   it('test ui in koa', async () => {
@@ -78,7 +80,7 @@ describe(`/test/index.test.ts`, () => {
 
   it('test using package bullmq', async () => {
     const app = await createApp(join(__dirname, 'fixtures', 'base-app-bullmq'));
-    
+
     const bullFramework = app.getApplicationContext().get(bullmq.Framework);
     const testQueue = bullFramework.getQueue('test');
     await testQueue?.runJob({name: 'stone-jin'});
@@ -96,4 +98,66 @@ describe(`/test/index.test.ts`, () => {
 
     await close(app);
   });
+
+  it('test dynamic add queue with bullmq', async () => {
+    const app = await createLightApp('', {
+      imports: [koa, bullboard, bullmq],
+      globalConfig: {
+        keys: 123,
+        bullmq: {
+          defaultConnection: {
+            host: '127.0.0.1',
+            port: 6379,
+          }
+        },
+      }
+    });
+
+    const bullFramework = app.getApplicationContext().get(bullmq.Framework);
+    const testQueue = bullFramework.createQueue('test');
+    await testQueue?.addJobToQueue({name: 'stone-jin'});
+
+    const manager = await app.getApplicationContext().getAsync(bullboard.BullBoardManager);
+    manager.addQueue(new bullboard.BullMQAdapter(testQueue) as any);
+
+    const result = await createHttpRequest(app).get('/ui/api/queues?activeQueue=test&page=1&jobsPerPage=10');
+    expect(result.status).toBe(200);
+    expect(result.body.queues.length).toBe(1);
+    expect(result.body.queues[0].type).toBe('bullmq');
+    expect(result.headers['content-type']).toMatch('application/json');
+
+    await close(app);
+  });
+
+  it('test dynamic add queue with bull', async () => {
+    const app = await createLightApp('', {
+      imports: [koa, bullboard, bull],
+      globalConfig: {
+        keys: 123,
+        bull: {
+          defaultQueueOptions: {
+            redis: {
+              port: 6379,
+              host: '127.0.0.1',
+            },
+          }
+        },
+      }
+    });
+
+    const bullFramework = app.getApplicationContext().get(bull.Framework);
+    const testQueue = bullFramework.createQueue('test-bull-board');
+    await testQueue?.addJobToQueue({name: 'stone-jin'});
+
+    const manager = await app.getApplicationContext().getAsync(bullboard.BullBoardManager);
+    manager.addQueue(new bullboard.BullAdapter(testQueue));
+
+    const result = await createHttpRequest(app).get('/ui/api/queues?activeQueue=test&page=1&jobsPerPage=10');
+    expect(result.status).toBe(200);
+    expect(result.body.queues.length).toBe(1);
+    expect(result.body.queues[0].type).toBe('bull');
+    expect(result.headers['content-type']).toMatch('application/json');
+
+    await close(app);
+  });
 });

site/docs/extensions/bull.md

@@ -822,18 +822,20 @@ export class MainConfiguration {
   @Inject()
   bullBoardManager: bullBoard.BullBoardManager;
 
-  async onReady() {
+  async onServerReady() {
     const testQueue = this.bullFramework.createQueue('test', {
       // ...
     });
 
-    this.bullBoardManager.addQueue(testQueue);
+    this.bullBoardManager.addQueue(new bullBoard.BullAdapter(testQueue);
   }
 }
 ```
 
 
 
+
+
 ## 常见问题
 
 ### 1、EVALSHA 错误

site/docs/extensions/bullmq.md

@@ -532,12 +532,14 @@ export class MainConfiguration {
   @Inject()
   bullBoardManager: bullBoard.BullBoardManager;
 
-  async onReady() {
+  async onServerReady() {
     const testQueue = this.bullmqFramework.createQueue('test', {
       // ...
     });
 
-    this.bullBoardManager.addQueue(testQueue);
+    this.bullBoardManager.addQueue(new bullBoard.BullMQAdapter(testQueue) as any);
   }
 }
 ```
+
+由于最新 bull-board 要求最低 Node.js 版本为 v20，所以 Midway v3 无法将 bull-board 升级；在 v5.23.0 版本下的 `bull-board` 存在类型定义问题，采用 `as any`  的方式绕过。

site/i18n/en/docusaurus-plugin-content-docs/current/extensions/bull.md

@@ -819,12 +819,12 @@ export class MainConfiguration {
   @Inject()
   bullBoardManager: bullBoard.BullBoardManager;
 
-  async onReady() {
+  async onServerReady() {
     const testQueue = this.bullFramework.createQueue('test', {
       // ...
     });
 
-    this.bullBoardManager.addQueue(testQueue);
+    this.bullBoardManager.addQueue(new bullBoard.BullAdapter(testQueue));
   }
 }
 ```

site/i18n/en/docusaurus-plugin-content-docs/current/extensions/bullmq.md

@@ -532,12 +532,14 @@ export class MainConfiguration {
   @Inject()
   bullBoardManager: bullBoard.BullBoardManager;
 
-  async onReady() {
+  async onServerReady() {
     const testQueue = this.bullmqFramework.createQueue('test', {
       // ...
     });
 
-    this.bullBoardManager.addQueue(testQueue);
+    this.bullBoardManager.addQueue(new bullBoard.BullMQAdapter(testQueue) as any);
   }
 }
-```
+```
+
+> Note: The latest bull-board requires Node.js v20 or above, so Midway v3 cannot upgrade bull-board; in bull-board v5.23.0 there is a type definition issue, so we use `as any` to bypass it.