@midwayjs/info 3.0.0-beta.9 → 3.0.0

package/README.md

@@ -1,11 +1,12 @@
-# midwayjs info
+# Midway Information Component
 
-Document: [https://midwayjs.org/midway](https://midwayjs.org/midway)
+Show your project info in router or other way, like phpInfo.
+
+![info](https://img.alicdn.com/imgextra/i3/O1CN01TCkSvr28x8T7gtnCl_!!6000000007998-2-tps-797-1106.png)
 
-![info](./docs/info.png)
 ## Usage
 
-in Configuration.ts file
+import info component in `configuration.ts` file
 
 ```ts
 import * as info from '@midwayjs/info';
@@ -24,29 +25,7 @@ export class ContainerConfiguration {
 
 ```
 
-in your code file
-
-```ts
-// model/user.ts
-import { Provider, Controller, Get } from '@midwayjs/decorator';
-import { InfoService, InfoValueType } from '@midwayjs/info';
-
-@Provider()
-@Controller('/')
-export class Photo {
-
-  @Inject()
-  infoService: InfoService;
-
-  @Get('/info')
-  getMidwayInfo() {
-    // return json
-    return this.infoService.info();
-    // return html
-    return this.infoService.info(InfoValueType.HTML);
-  }
-}
-```
+Your can curl `/_info` to show it.
 
 ## License
 

package/dist/config.default.d.ts

@@ -0,0 +1,3 @@
+import { InfoConfigOptions } from './interface';
+export declare const info: InfoConfigOptions;
+//# sourceMappingURL=config.default.d.ts.map

package/dist/config.default.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.info = void 0;
+const interface_1 = require("./interface");
+exports.info = {
+    title: 'Midway Info',
+    infoPath: '/_info',
+    hiddenKey: interface_1.DefaultHiddenKey,
+};
+//# sourceMappingURL=config.default.js.map

package/dist/configuration.d.ts

@@ -1,3 +1,6 @@
+import { MidwayApplicationManager } from '@midwayjs/core';
 export declare class InfoConfiguration {
+    applicationManager: MidwayApplicationManager;
+    onReady(): Promise<void>;
 }
 //# sourceMappingURL=configuration.d.ts.map

package/dist/configuration.js

@@ -5,19 +5,34 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
     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.InfoConfiguration = void 0;
 const decorator_1 = require("@midwayjs/decorator");
+const info_middleware_1 = require("./middleware/info.middleware");
+const core_1 = require("@midwayjs/core");
+const DefaultConfig = require("./config.default");
 let InfoConfiguration = class InfoConfiguration {
+    async onReady() {
+        this.applicationManager
+            .getApplications(['koa', 'faas', 'express', 'egg'])
+            .forEach(app => {
+            app.useMiddleware(info_middleware_1.InfoMiddleware);
+        });
+    }
 };
+__decorate([
+    (0, decorator_1.Inject)(),
+    __metadata("design:type", core_1.MidwayApplicationManager)
+], InfoConfiguration.prototype, "applicationManager", void 0);
 InfoConfiguration = __decorate([
     (0, decorator_1.Configuration)({
         namespace: 'info',
         importConfigs: [
             {
-                default: {
-                    info: {},
-                },
+                default: DefaultConfig,
             },
         ],
     })

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 export { InfoConfiguration as Configuration } from './configuration';
 export * from './infoService';
+export * from './middleware/info.middleware';
 export * from './interface';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -14,5 +14,6 @@ exports.Configuration = void 0;
 var configuration_1 = require("./configuration");
 Object.defineProperty(exports, "Configuration", { enumerable: true, get: function () { return configuration_1.InfoConfiguration; } });
 __exportStar(require("./infoService"), exports);
+__exportStar(require("./middleware/info.middleware"), exports);
 __exportStar(require("./interface"), exports);
 //# sourceMappingURL=index.js.map

package/dist/infoService.d.ts

@@ -1,9 +1,14 @@
-import { MidwayInformationService, IMidwayContainer } from '@midwayjs/core';
+import { MidwayInformationService, IMidwayContainer, MidwayConfigService, MidwayEnvironmentService } from '@midwayjs/core';
 import { InfoValueType, TypeInfo } from './interface';
 export declare class InfoService {
     midwayInformationService: MidwayInformationService;
-    app: any;
+    configService: MidwayConfigService;
+    environment: MidwayEnvironmentService;
+    titleConfig: any;
+    defaultHiddenKey: string[];
+    secretMatchList: Array<any>;
     container: IMidwayContainer;
+    init(): Promise<void>;
     info(infoValueType?: InfoValueType): string | TypeInfo[];
     projectInfo(): TypeInfo;
     systemInfo(): TypeInfo;
@@ -21,5 +26,7 @@ export declare class InfoService {
         type: string;
         info: {};
     };
+    protected filterSecretContent(key: any, value: any): any;
+    protected safeJson(value: any): string;
 }
 //# sourceMappingURL=infoService.d.ts.map

package/dist/infoService.js

@@ -12,11 +12,16 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.InfoService = void 0;
 const decorator_1 = require("@midwayjs/decorator");
 const core_1 = require("@midwayjs/core");
-const interface_1 = require("./interface");
 const utils_1 = require("./utils");
 const os_1 = require("os");
 const path_1 = require("path");
+const pm = require("picomatch");
 let InfoService = class InfoService {
+    async init() {
+        this.secretMatchList = Array.from(new Set(this.defaultHiddenKey)).map(pattern => {
+            return pm(pattern);
+        });
+    }
     info(infoValueType) {
         const info = [];
         info.push(this.projectInfo());
@@ -29,8 +34,8 @@ let InfoService = class InfoService {
         info.push(this.envInfo());
         info.push(this.dependenciesInfo());
         info.push(this.networkInfo());
-        if (infoValueType === interface_1.InfoValueType.HTML) {
-            return (0, utils_1.renderToHtml)(info);
+        if (infoValueType === 'html') {
+            return (0, utils_1.renderToHtml)(info, this.titleConfig);
         }
         return info;
     }
@@ -42,7 +47,7 @@ let InfoService = class InfoService {
                 AppDir: this.midwayInformationService.getAppDir(),
                 BaseDir: this.midwayInformationService.getBaseDir(),
                 Root: this.midwayInformationService.getRoot(),
-                Env: this.app.getEnv(),
+                Env: this.environment.getCurrentEnvironment(),
             },
         };
     }
@@ -110,9 +115,13 @@ let InfoService = class InfoService {
         };
     }
     envInfo() {
+        const env = {};
+        Object.keys(process.env).forEach(envName => {
+            env[envName] = this.filterSecretContent(envName, process.env[envName]);
+        });
         return {
             type: 'Environment Variable',
-            info: process.env,
+            info: env,
         };
     }
     timeInfo() {
@@ -189,28 +198,91 @@ let InfoService = class InfoService {
     }
     midwayConfig() {
         const info = {};
-        const config = this.app.getConfig() || {};
+        const config = this.configService.getConfiguration() || {};
         Object.keys(config).forEach(key => {
-            info[key] = (0, utils_1.safeJson)(config[key]);
+            info[key] = this.safeJson(this.filterSecretContent(key, config[key]));
         });
         return {
             type: 'Midway Config',
             info,
         };
     }
+    filterSecretContent(key, value) {
+        if (typeof value === 'string') {
+            const find = this.secretMatchList.some(isMatch => {
+                return isMatch(key.toLowerCase());
+            });
+            if (find) {
+                return (0, utils_1.safeContent)(value);
+            }
+        }
+        else if (Array.isArray(value)) {
+            return value.map(item => {
+                return this.filterSecretContent(key, item);
+            });
+        }
+        return value;
+    }
+    safeJson(value) {
+        switch (typeof value) {
+            case 'string':
+                return `"${value}"`;
+            case 'number':
+                return `${value}`;
+            case 'boolean':
+                return String(value);
+            case 'object':
+                if (!value) {
+                    return 'null';
+                }
+                if (Array.isArray(value)) {
+                    return `[${value.map(item => this.safeJson(item)).join(',')}]`;
+                }
+                if (value instanceof RegExp) {
+                    return `"${value.toString()}"`;
+                }
+                // eslint-disable-next-line no-case-declarations
+                const props = [];
+                for (const key in value) {
+                    props.push(`"${key}":${this.safeJson(this.filterSecretContent(key, value[key]))}`);
+                }
+                return `{${props.join(',')}}`;
+            case 'function':
+                return `function ${value.name}(${value.length} args)`;
+        }
+        return '';
+    }
 };
 __decorate([
     (0, decorator_1.Inject)(),
     __metadata("design:type", core_1.MidwayInformationService)
 ], InfoService.prototype, "midwayInformationService", void 0);
 __decorate([
-    (0, decorator_1.App)(),
+    (0, decorator_1.Inject)(),
+    __metadata("design:type", core_1.MidwayConfigService)
+], InfoService.prototype, "configService", void 0);
+__decorate([
+    (0, decorator_1.Inject)(),
+    __metadata("design:type", core_1.MidwayEnvironmentService)
+], InfoService.prototype, "environment", void 0);
+__decorate([
+    (0, decorator_1.Config)('info.title'),
     __metadata("design:type", Object)
-], InfoService.prototype, "app", void 0);
+], InfoService.prototype, "titleConfig", void 0);
+__decorate([
+    (0, decorator_1.Config)('info.hiddenKey'),
+    __metadata("design:type", Array)
+], InfoService.prototype, "defaultHiddenKey", void 0);
 __decorate([
     (0, decorator_1.ApplicationContext)(),
     __metadata("design:type", Object)
 ], InfoService.prototype, "container", void 0);
+__decorate([
+    (0, decorator_1.Init)(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", Promise)
+], InfoService.prototype, "init", null);
 InfoService = __decorate([
     (0, decorator_1.Provide)(),
     (0, decorator_1.Scope)(decorator_1.ScopeEnum.Singleton)

package/dist/interface.d.ts

@@ -1,11 +1,14 @@
-export declare enum InfoValueType {
-    HTML = "html",
-    JSON = "json"
-}
+export declare type InfoValueType = 'html' | 'json';
+export declare const DefaultHiddenKey: string[];
 export interface TypeInfo {
     type: string;
     info: {
         [key: string]: string | number;
     };
 }
+export interface InfoConfigOptions {
+    title: string;
+    infoPath: string;
+    hiddenKey: Array<string>;
+}
 //# sourceMappingURL=interface.d.ts.map

package/dist/interface.js

@@ -1,9 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.InfoValueType = void 0;
-var InfoValueType;
-(function (InfoValueType) {
-    InfoValueType["HTML"] = "html";
-    InfoValueType["JSON"] = "json";
-})(InfoValueType = exports.InfoValueType || (exports.InfoValueType = {}));
+exports.DefaultHiddenKey = void 0;
+exports.DefaultHiddenKey = ['keys', '*key', '*token', '*secret*', 'pass*'];
 //# sourceMappingURL=interface.js.map

package/dist/middleware/info.middleware.d.ts

@@ -0,0 +1,8 @@
+import { InfoService } from '../infoService';
+export declare class InfoMiddleware {
+    protected infoPath: any;
+    protected infoService: InfoService;
+    resolve(app: any): ((req: any, res: any, next: any) => Promise<void>) | ((ctx: any, next: any) => Promise<any>);
+    static getName(): string;
+}
+//# sourceMappingURL=info.middleware.d.ts.map

package/dist/middleware/info.middleware.js

@@ -0,0 +1,55 @@
+"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.InfoMiddleware = void 0;
+const decorator_1 = require("@midwayjs/decorator");
+const infoService_1 = require("../infoService");
+let InfoMiddleware = class InfoMiddleware {
+    resolve(app) {
+        if (app.getFrameworkType() === decorator_1.MidwayFrameworkType.WEB_EXPRESS) {
+            return async (req, res, next) => {
+                if (req.path === this.infoPath) {
+                    // return html
+                    res.type('html');
+                    res.send(this.infoService.info('html'));
+                }
+                else {
+                    next();
+                }
+            };
+        }
+        else {
+            return async (ctx, next) => {
+                if (ctx.path === this.infoPath) {
+                    // return html
+                    return this.infoService.info('html');
+                }
+                return await next();
+            };
+        }
+    }
+    static getName() {
+        return 'info';
+    }
+};
+__decorate([
+    (0, decorator_1.Config)('info.infoPath'),
+    __metadata("design:type", Object)
+], InfoMiddleware.prototype, "infoPath", void 0);
+__decorate([
+    (0, decorator_1.Inject)(),
+    __metadata("design:type", infoService_1.InfoService)
+], InfoMiddleware.prototype, "infoService", void 0);
+InfoMiddleware = __decorate([
+    (0, decorator_1.Middleware)()
+], InfoMiddleware);
+exports.InfoMiddleware = InfoMiddleware;
+//# sourceMappingURL=info.middleware.js.map

package/dist/utils.d.ts

@@ -1,6 +1,6 @@
 import { TypeInfo } from './interface';
 export declare function safeRequire(mod: string, defaultValue?: any): any;
 export declare function bitToMB(bit: number): string;
-export declare function renderToHtml(infoList: TypeInfo[]): string;
-export declare function safeJson(value: any): string;
+export declare function renderToHtml(infoList: TypeInfo[], title: any): string;
+export declare function safeContent(value?: string): string;
 //# sourceMappingURL=utils.d.ts.map

package/dist/utils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.safeJson = exports.renderToHtml = exports.bitToMB = exports.safeRequire = void 0;
+exports.safeContent = exports.renderToHtml = exports.bitToMB = exports.safeRequire = void 0;
 function safeRequire(mod, defaultValue) {
     try {
         return require(mod);
@@ -14,8 +14,8 @@ function bitToMB(bit) {
     return Number((bit || 0) / 1024 / 1024).toFixed(2) + ' MB';
 }
 exports.bitToMB = bitToMB;
-function renderToHtml(infoList) {
-    let html = '<div style="padding: 24px; font-size: 36px;background: #9999cb;font-weight: bold;">Midway Info</div>';
+function renderToHtml(infoList, title) {
+    let html = `<div style="padding: 24px; font-size: 36px;background: #9999cb;font-weight: bold;">${title}</div>`;
     html += infoList
         .map(info => {
         const infoList = Object.keys(info.info || {});
@@ -34,34 +34,22 @@ function renderToHtml(infoList) {
   </style><div style="margin: 24px auto;max-width: 720px;min-width: 440px;">${html}</div>`;
 }
 exports.renderToHtml = renderToHtml;
-function safeJson(value) {
-    switch (typeof value) {
-        case 'string':
-            return `"${value}"`;
-        case 'number':
-            return `${value}`;
-        case 'boolean':
-            return String(value);
-        case 'object':
-            if (!value) {
-                return 'null';
-            }
-            if (Array.isArray(value)) {
-                return `[${value.map(item => safeJson(item)).join(',')}]`;
-            }
-            if (value instanceof RegExp) {
-                return `"${value.toString()}"`;
-            }
-            // eslint-disable-next-line no-case-declarations
-            const props = [];
-            for (const key in value) {
-                props.push(`"${key}":${safeJson(value[key])}`);
-            }
-            return `{${props.join(',')}}`;
-        case 'function':
-            return `function ${value.name}(${value.length} args)`;
+function safeContent(value = '') {
+    if (value.length < 3) {
+        return '*'.repeat(value.length);
+    }
+    else if (value.length < 6) {
+        return value[0] + '*'.repeat(value.length - 1);
+    }
+    else if (value.length < 10) {
+        return value[0] + '*'.repeat(value.length - 2) + value[value.length - 1];
+    }
+    else if (value.length < 15) {
+        return value.slice(0, 2) + '*'.repeat(value.length - 4) + value.slice(-2);
+    }
+    else {
+        return value.slice(0, 3) + '*'.repeat(value.length - 6) + value.slice(-3);
     }
-    return '';
 }
-exports.safeJson = safeJson;
+exports.safeContent = safeContent;
 //# sourceMappingURL=utils.js.map

package/package.json

@@ -1,19 +1,24 @@
 {
   "name": "@midwayjs/info",
   "description": "midway info",
-  "version": "3.0.0-beta.9",
+  "version": "3.0.0",
   "main": "dist/index",
   "typings": "dist/index.d.ts",
   "files": [
     "dist/**/*.js",
     "dist/**/*.d.ts"
   ],
+  "dependencies": {
+    "picomatch": "2.3.1"
+  },
   "devDependencies": {
-    "@midwayjs/core": "^3.0.0-beta.9",
-    "@midwayjs/decorator": "^3.0.0-beta.9",
-    "@midwayjs/mock": "^3.0.0-beta.9",
-    "@midwayjs/serverless-fc-starter": "^3.0.0-beta.9",
-    "@midwayjs/serverless-scf-starter": "^3.0.0-beta.9"
+    "@midwayjs/core": "^3.0.0",
+    "@midwayjs/decorator": "^3.0.0",
+    "@midwayjs/express": "^3.0.0",
+    "@midwayjs/koa": "^3.0.0",
+    "@midwayjs/mock": "^3.0.0",
+    "@midwayjs/serverless-fc-starter": "^3.0.0",
+    "@midwayjs/serverless-scf-starter": "^3.0.0"
   },
   "keywords": [
     "midway"
@@ -22,8 +27,8 @@
   "license": "MIT",
   "scripts": {
     "build": "tsc",
-    "test": "node --require=ts-node/register ../../node_modules/.bin/jest",
-    "cov": "node --require=ts-node/register ../../node_modules/.bin/jest --coverage --forceExit",
+    "test": "node --require=ts-node/register ../../node_modules/.bin/jest --runInBand",
+    "cov": "node --require=ts-node/register ../../node_modules/.bin/jest --runInBand --coverage --forceExit",
     "ci": "npm run test",
     "lint": "mwts check"
   },
@@ -34,5 +39,5 @@
     "type": "git",
     "url": "https://github.com/midwayjs/midway.git"
   },
-  "gitHead": "d23e4a4fee58097b98461625c428a37d55535cec"
+  "gitHead": "55c26029bccf7bbb739fa1597e8f418dafa2caa0"
 }

package/CHANGELOG.md

@@ -1,75 +0,0 @@
-# Change Log
-
-All notable changes to this project will be documented in this file.
-See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
-
-# [3.0.0-beta.9](https://github.com/midwayjs/midway/compare/v3.0.0-beta.8...v3.0.0-beta.9) (2021-12-09)
-
-**Note:** Version bump only for package @midwayjs/info
-
-
-
-
-
-# [3.0.0-beta.8](https://github.com/midwayjs/midway/compare/v3.0.0-beta.7...v3.0.0-beta.8) (2021-12-08)
-
-**Note:** Version bump only for package @midwayjs/info
-
-
-
-
-
-# [3.0.0-beta.7](https://github.com/midwayjs/midway/compare/v3.0.0-beta.6...v3.0.0-beta.7) (2021-12-03)
-
-**Note:** Version bump only for package @midwayjs/info
-
-
-
-
-
-# [3.0.0-beta.6](https://github.com/midwayjs/midway/compare/v3.0.0-beta.5...v3.0.0-beta.6) (2021-11-26)
-
-**Note:** Version bump only for package @midwayjs/info
-
-
-
-
-
-# [3.0.0-beta.5](https://github.com/midwayjs/midway/compare/v3.0.0-beta.4...v3.0.0-beta.5) (2021-11-25)
-
-**Note:** Version bump only for package @midwayjs/info
-
-
-
-
-
-# [3.0.0-beta.4](https://github.com/midwayjs/midway/compare/v3.0.0-beta.3...v3.0.0-beta.4) (2021-11-24)
-
-**Note:** Version bump only for package @midwayjs/info
-
-
-
-
-
-# [3.0.0-beta.3](https://github.com/midwayjs/midway/compare/v3.0.0-beta.2...v3.0.0-beta.3) (2021-11-18)
-
-
-### Features
-
-* add component and framework config definition ([#1367](https://github.com/midwayjs/midway/issues/1367)) ([b2fe615](https://github.com/midwayjs/midway/commit/b2fe6157f99659471ff1333eca0b86bb889f61a3))
-
-
-
-
-
-# [3.0.0-beta.2](https://github.com/midwayjs/midway/compare/v3.0.0-beta.1...v3.0.0-beta.2) (2021-11-16)
-
-**Note:** Version bump only for package @midwayjs/info
-
-
-
-
-
-# [3.0.0-beta.1](https://github.com/midwayjs/midway/compare/v2.12.4...v3.0.0-beta.1) (2021-11-14)
-
-**Note:** Version bump only for package @midwayjs/info