@midwayjs/bull-board 3.0.0 → 3.6.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2013 - Now midwayjs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/adapter.d.ts

@@ -0,0 +1,24 @@
+import { AppControllerRoute, AppViewRoute, BullBoardQueues, ControllerHandlerReturnType, IServerAdapter } from '@bull-board/api/dist/typings/app';
+export declare class MidwayAdapter implements IServerAdapter {
+    private basePath;
+    private bullBoardQueues;
+    private statics;
+    private viewPath;
+    private entryRoute;
+    private apiRoutes;
+    private staticCache;
+    setBasePath(path: string): MidwayAdapter;
+    setStaticPath(staticsRoute: string, staticsPath: string): MidwayAdapter;
+    setViewsPath(viewPath: string): MidwayAdapter;
+    setErrorHandler(handler: (error: Error) => ControllerHandlerReturnType): this;
+    setApiRoutes(routes: AppControllerRoute[]): MidwayAdapter;
+    setEntryRoute(routeDef: AppViewRoute): MidwayAdapter;
+    setQueues(bullBoardQueues: BullBoardQueues): MidwayAdapter;
+    getViewRoutes(): string[];
+    matchApiRoutes(method: string, url: string): AppControllerRoute;
+    getStaticRoutes(): string;
+    renderStatic(filename: any): Promise<any>;
+    renderView(filename: any): Promise<unknown>;
+    runAPI(route: any, query: any): Promise<any>;
+}
+//# sourceMappingURL=adapter.d.ts.map

package/dist/adapter.js

@@ -0,0 +1,108 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MidwayAdapter = void 0;
+const ejs = require("ejs");
+const path_1 = require("path");
+const fs_1 = require("fs");
+const core_1 = require("@midwayjs/core");
+class MidwayAdapter {
+    constructor() {
+        this.basePath = '';
+        this.staticCache = new Map();
+    }
+    setBasePath(path) {
+        this.basePath = path;
+        return this;
+    }
+    setStaticPath(staticsRoute, staticsPath) {
+        this.statics = { route: staticsRoute, path: staticsPath };
+        return this;
+    }
+    setViewsPath(viewPath) {
+        this.viewPath = viewPath;
+        return this;
+    }
+    setErrorHandler(handler) {
+        // this.errorHandler = handler;
+        return this;
+    }
+    setApiRoutes(routes) {
+        this.apiRoutes = routes;
+        this.apiRoutes.forEach(route => {
+            route.regexpPattern = core_1.PathToRegexpUtil.toRegexp(route.route);
+        });
+        return this;
+    }
+    setEntryRoute(routeDef) {
+        this.entryRoute = routeDef;
+        return this;
+    }
+    setQueues(bullBoardQueues) {
+        this.bullBoardQueues = bullBoardQueues;
+        return this;
+    }
+    getViewRoutes() {
+        const { route } = this.entryRoute;
+        return Array.isArray(route) ? route : [route];
+    }
+    matchApiRoutes(method, url) {
+        return this.apiRoutes.find(route => {
+            if (route.method !== method.toLowerCase()) {
+                return false;
+            }
+            const result = core_1.PathToRegexpUtil.match(route.route, {
+                decode: decodeURIComponent,
+            })(url);
+            if (result) {
+                route.params = result.params;
+            }
+            return !!result;
+        });
+    }
+    getStaticRoutes() {
+        return this.statics.route;
+    }
+    async renderStatic(filename) {
+        filename = filename.replace(this.statics.route, '');
+        filename = (0, path_1.join)(this.statics.path, filename);
+        if (this.staticCache.has(filename)) {
+            return this.staticCache.get(filename);
+        }
+        const content = (0, fs_1.readFileSync)(filename, {
+            encoding: 'utf-8',
+        });
+        this.staticCache.set(filename, content);
+        return content;
+    }
+    async renderView(filename) {
+        const basePath = this.basePath.endsWith('/')
+            ? this.basePath
+            : `${this.basePath}/`;
+        if (filename === '/') {
+            filename = 'index.ejs';
+        }
+        filename = (0, path_1.join)(this.viewPath, filename);
+        return new Promise((resolve, reject) => {
+            ejs.renderFile(filename, { basePath, cache: true }, {
+                root: this.viewPath,
+            }, (err, result) => {
+                if (err) {
+                    reject(err);
+                }
+                else {
+                    resolve(result);
+                }
+            });
+        });
+    }
+    async runAPI(route, query) {
+        const response = await route.handler({
+            queues: this.bullBoardQueues,
+            params: route.params,
+            query,
+        });
+        return response.body;
+    }
+}
+exports.MidwayAdapter = MidwayAdapter;
+//# sourceMappingURL=adapter.js.map

package/dist/board.middleware.d.ts

@@ -0,0 +1,15 @@
+import { IMiddleware, IMidwayApplication, IMidwayContext, NextFunction } from '@midwayjs/core';
+import * as bull from '@midwayjs/bull';
+export declare class BoardMiddleware implements IMiddleware<IMidwayContext, NextFunction, unknown> {
+    framework: bull.Framework;
+    bullBoardConfig: {
+        basePath?: string;
+        adapterOptions?: any;
+    };
+    private basePath;
+    private serverAdapter;
+    init(): Promise<void>;
+    resolve(app: IMidwayApplication): (req: any, res: any, next: NextFunction) => Promise<any>;
+    static getName(): string;
+}
+//# sourceMappingURL=board.middleware.d.ts.map

package/dist/board.middleware.js

@@ -0,0 +1,144 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BoardMiddleware = void 0;
+const core_1 = require("@midwayjs/core");
+const path_1 = require("path");
+const bull = require("@midwayjs/bull");
+const api_1 = require("@bull-board/api");
+const bullAdapter_1 = require("@bull-board/api/bullAdapter");
+const adapter_1 = require("./adapter");
+const MIME_MAP = {
+    '.html': 'text/html',
+    '.htm': 'text/html',
+    '.js': 'application/javascript',
+    '.css': 'text/css',
+    '.json': 'application/json',
+    '.png': 'image/png',
+    '.jpg': 'image/jpeg',
+    '.jpeg': 'image/jpeg',
+    '.gif': 'image/gif',
+    '.svg': 'image/svg+xml',
+    '.ico': 'image/x-icon',
+    '.ttf': 'application/x-font-ttf',
+    '.woff': 'application/font-woff',
+    '.woff2': 'application/font-woff2',
+    '.eot': 'application/vnd.ms-fontobject',
+    '.otf': 'application/x-font-opentype',
+};
+let BoardMiddleware = class BoardMiddleware {
+    async init() {
+        const queueList = this.framework.getQueueList();
+        const wrapQueues = queueList.map(queue => new bullAdapter_1.BullAdapter(queue));
+        this.basePath = this.bullBoardConfig.basePath;
+        this.serverAdapter = new adapter_1.MidwayAdapter();
+        (0, api_1.createBullBoard)({
+            queues: wrapQueues,
+            serverAdapter: this.serverAdapter,
+        });
+        this.serverAdapter.setBasePath(this.basePath);
+    }
+    resolve(app) {
+        if (app.getFrameworkType() === core_1.MidwayFrameworkType.WEB_EXPRESS) {
+            return async (req, res, next) => {
+                const pathname = req.path;
+                if (pathname.indexOf(this.basePath) === -1) {
+                    return next();
+                }
+                const routePath = pathname.replace(this.basePath, '') || '/';
+                let content;
+                if (routePath.startsWith(this.serverAdapter.getStaticRoutes())) {
+                    content = await this.serverAdapter.renderStatic(routePath);
+                }
+                else if (this.serverAdapter.getViewRoutes().indexOf(routePath) !== -1) {
+                    content = await this.serverAdapter.renderView(routePath);
+                }
+                else {
+                    const matchRoute = this.serverAdapter.matchApiRoutes(req.method, routePath);
+                    if (matchRoute) {
+                        content = await this.serverAdapter.runAPI(matchRoute, req.query);
+                    }
+                }
+                const ext = (0, path_1.extname)(pathname);
+                if (MIME_MAP[ext]) {
+                    res.type(MIME_MAP[ext]);
+                }
+                else {
+                    if (typeof content === 'object') {
+                        res.type('application/json');
+                    }
+                    else {
+                        res.type('text/html');
+                    }
+                }
+                res.send(content);
+            };
+        }
+        else {
+            return async (ctx, next) => {
+                const pathname = ctx.path;
+                if (pathname.indexOf(this.basePath) === -1) {
+                    return next();
+                }
+                const routePath = pathname.replace(this.basePath, '') || '/';
+                let content;
+                if (routePath.startsWith(this.serverAdapter.getStaticRoutes())) {
+                    content = await this.serverAdapter.renderStatic(routePath);
+                }
+                else if (this.serverAdapter.getViewRoutes().indexOf(routePath) !== -1) {
+                    content = await this.serverAdapter.renderView(routePath);
+                }
+                else {
+                    const matchRoute = this.serverAdapter.matchApiRoutes(ctx.method, routePath);
+                    if (matchRoute) {
+                        content = await this.serverAdapter.runAPI(matchRoute, ctx.query);
+                    }
+                }
+                const ext = (0, path_1.extname)(pathname);
+                if (MIME_MAP[ext]) {
+                    ctx.type = MIME_MAP[ext];
+                }
+                else {
+                    if (typeof content === 'object') {
+                        ctx.type = 'application/json';
+                    }
+                    else {
+                        ctx.type = 'text/html';
+                    }
+                }
+                ctx.body = content;
+            };
+        }
+    }
+    static getName() {
+        return 'bull-board-ui';
+    }
+};
+__decorate([
+    (0, core_1.Inject)(),
+    __metadata("design:type", bull.Framework)
+], BoardMiddleware.prototype, "framework", void 0);
+__decorate([
+    (0, core_1.Config)('bullBoard'),
+    __metadata("design:type", Object)
+], BoardMiddleware.prototype, "bullBoardConfig", void 0);
+__decorate([
+    (0, core_1.Init)(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", Promise)
+], BoardMiddleware.prototype, "init", null);
+BoardMiddleware = __decorate([
+    (0, core_1.Provide)(),
+    (0, core_1.Scope)(core_1.ScopeEnum.Singleton)
+], BoardMiddleware);
+exports.BoardMiddleware = BoardMiddleware;
+//# sourceMappingURL=board.middleware.js.map

package/dist/configuration.d.ts

@@ -1,12 +1,7 @@
-import * as bull from '@midwayjs/bull';
-import { MidwayApplicationManager } from '@midwayjs/core';
+import { MidwayApplicationManager, MidwayConfigService } from '@midwayjs/core';
 export declare class BullBoardConfiguration {
-    framework: bull.Framework;
     applicationManager: MidwayApplicationManager;
-    bullBoardConfig: {
-        basePath?: string;
-        adapterOptions?: any;
-    };
+    configService: MidwayConfigService;
     onReady(): Promise<void>;
 }
 //# sourceMappingURL=configuration.d.ts.map

package/dist/configuration.js

@@ -10,61 +10,40 @@ var __metadata = (this && this.__metadata) || function (k, v) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BullBoardConfiguration = void 0;
-const decorator_1 = require("@midwayjs/decorator");
 const bull = require("@midwayjs/bull");
 const core_1 = require("@midwayjs/core");
-const api_1 = require("@bull-board/api");
-const bullAdapter_1 = require("@bull-board/api/bullAdapter");
-const express_1 = require("@bull-board/express");
-const koa_1 = require("@bull-board/koa");
+const board_middleware_1 = require("./board.middleware");
 let BullBoardConfiguration = class BullBoardConfiguration {
     async onReady() {
-        const queueList = this.framework.getQueueList();
-        const wrapQueues = queueList.map(queue => new bullAdapter_1.BullAdapter(queue));
-        const basePath = this.bullBoardConfig.basePath;
-        const expressApp = this.applicationManager.getApplication('express');
-        if (expressApp) {
-            const serverAdapter = new express_1.ExpressAdapter();
-            (0, api_1.createBullBoard)({
-                queues: wrapQueues,
-                serverAdapter,
+        const apps = this.applicationManager.getApplications([
+            'express',
+            'egg',
+            'koa',
+        ]);
+        if (apps.length) {
+            apps.forEach(app => {
+                app.useMiddleware(board_middleware_1.BoardMiddleware);
             });
-            serverAdapter.setBasePath(basePath);
-            expressApp['originUse'](basePath, serverAdapter.getRouter());
-        }
-        const apps = this.applicationManager.getApplications(['egg', 'koa']);
-        for (const app of apps) {
-            const serverAdapter = new koa_1.KoaAdapter();
-            (0, api_1.createBullBoard)({
-                queues: wrapQueues,
-                serverAdapter,
-            });
-            serverAdapter.setBasePath(basePath);
-            await app.useMiddleware(serverAdapter.registerPlugin());
         }
     }
 };
 __decorate([
-    (0, decorator_1.Inject)(),
-    __metadata("design:type", bull.Framework)
-], BullBoardConfiguration.prototype, "framework", void 0);
-__decorate([
-    (0, decorator_1.Inject)(),
+    (0, core_1.Inject)(),
     __metadata("design:type", core_1.MidwayApplicationManager)
 ], BullBoardConfiguration.prototype, "applicationManager", void 0);
 __decorate([
-    (0, decorator_1.Config)('bullBoard'),
-    __metadata("design:type", Object)
-], BullBoardConfiguration.prototype, "bullBoardConfig", void 0);
+    (0, core_1.Inject)(),
+    __metadata("design:type", core_1.MidwayConfigService)
+], BullBoardConfiguration.prototype, "configService", void 0);
 BullBoardConfiguration = __decorate([
-    (0, decorator_1.Configuration)({
+    (0, core_1.Configuration)({
         namespace: 'bull-board',
         imports: [bull],
         importConfigs: [
             {
                 default: {
                     bullBoard: {
-                        basePath: 'ui',
+                        basePath: '/ui',
                         adapterOptions: {
                             readOnlyMode: false,
                         },

package/dist/index.d.ts

@@ -1,2 +1,3 @@
 export { BullBoardConfiguration as Configuration } from './configuration';
+export * from './board.middleware';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -1,6 +1,21 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Configuration = void 0;
 var configuration_1 = require("./configuration");
 Object.defineProperty(exports, "Configuration", { enumerable: true, get: function () { return configuration_1.BullBoardConfiguration; } });
+__exportStar(require("./board.middleware"), exports);
 //# sourceMappingURL=index.js.map

package/index.d.ts

@@ -1,4 +1,5 @@
 import { QueueAdapterOptions } from '@bull-board/api/dist/typings/app';
+import '@midwayjs/bull';
 export * from './dist/index';
 
 declare module '@midwayjs/core/dist/interface' {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@midwayjs/bull-board",
-  "version": "3.0.0",
+  "version": "3.6.0",
   "description": "midway component for bull",
   "main": "dist/index.js",
   "typings": "index.d.ts",
@@ -24,17 +24,19 @@
   ],
   "license": "MIT",
   "devDependencies": {
-    "@midwayjs/core": "^3.4.13",
-    "@midwayjs/decorator": "^3.4.11",
-    "@midwayjs/mock": "^3.4.13"
+    "@midwayjs/core": "^3.6.0",
+    "@midwayjs/express": "^3.6.0",
+    "@midwayjs/koa": "^3.6.0",
+    "@midwayjs/mock": "^3.6.0"
   },
   "dependencies": {
-    "@bull-board/api": "4.3.1",
-    "@bull-board/express": "4.3.1",
-    "@bull-board/koa": "4.3.1",
-    "@midwayjs/bull": "^3.0.3"
+    "@bull-board/api": "4.4.0",
+    "@bull-board/ui": "4.4.0",
+    "@midwayjs/bull": "^3.6.0",
+    "ejs": "3.1.8"
   },
   "engines": {
     "node": ">=12"
-  }
+  },
+  "gitHead": "22643b0e8519766bb7c68b975930199fc136336e"
 }