ee-core 1.5.1 → 1.5.2-beta.2

package/lib/httpclient.js

@@ -1,136 +1,136 @@
-'use strict';
-
-const Agent = require('agentkeepalive');
-const HttpsAgent = require('agentkeepalive').HttpsAgent;
-const urllib = require('urllib');
-const ms = require('humanize-ms');
-const { FrameworkBaseError } = require('egg-errors');
-
-class HttpClientError extends FrameworkBaseError {
-  get module() {
-    return 'httpclient';
-  }
-}
-
-class HttpClient extends urllib.HttpClient2 {
-  constructor(app) {
-    normalizeConfig(app);
-    const config = app.config.httpclient;
-    super({
-      app,
-      defaultArgs: config.request,
-      agent: new Agent(config.httpAgent),
-      httpsAgent: new HttpsAgent(config.httpsAgent),
-    });
-    this.app = app;
-  }
-
-  request(url, args, callback) {
-    if (typeof args === 'function') {
-      callback = args;
-      args = null;
-    }
-
-    args = args || {};
-
-    // the callback style
-    if (callback) {
-      //this.app.deprecate('[httpclient] We now support async for this function, so callback isn\'t recommended.');
-      super.request(url, args)
-        .then(result => process.nextTick(() => callback(null, result.data, result.res)))
-        .catch(err => process.nextTick(() => callback(err)));
-      return;
-    }
-
-    // the Promise style
-    return super.request(url, args)
-      .catch(err => {
-        if (err.code === 'ENETUNREACH') {
-          throw HttpClientError.create(err.message, err.code);
-        }
-        throw err;
-      });
-  }
-
-  curl(url, args, callback) {
-    return this.request(url, args, callback);
-  }
-
-  requestThunk(url, args) {
-    //this.app.deprecate('[httpclient] Please use `request()` instead of `requestThunk()`');
-    return callback => {
-      this.request(url, args, (err, data, res) => {
-        if (err) {
-          return callback(err);
-        }
-        callback(null, {
-          data,
-          status: res.status,
-          headers: res.headers,
-          res,
-        });
-      });
-    };
-  }
-}
-
-function normalizeConfig(app) {
-  const config = app.config.httpclient;
-
-  // compatibility
-  if (typeof config.keepAlive === 'boolean') {
-    config.httpAgent.keepAlive = config.keepAlive;
-    config.httpsAgent.keepAlive = config.keepAlive;
-  }
-  if (config.timeout) {
-    config.timeout = ms(config.timeout);
-    config.httpAgent.timeout = config.timeout;
-    config.httpsAgent.timeout = config.timeout;
-  }
-  // compatibility httpclient.freeSocketKeepAliveTimeout => httpclient.freeSocketTimeout
-  if (config.freeSocketKeepAliveTimeout && !config.freeSocketTimeout) {
-    config.freeSocketTimeout = config.freeSocketKeepAliveTimeout;
-    delete config.freeSocketKeepAliveTimeout;
-  }
-  if (config.freeSocketTimeout) {
-    config.freeSocketTimeout = ms(config.freeSocketTimeout);
-    config.httpAgent.freeSocketTimeout = config.freeSocketTimeout;
-    config.httpsAgent.freeSocketTimeout = config.freeSocketTimeout;
-  } else {
-    // compatibility agent.freeSocketKeepAliveTimeout
-    if (config.httpAgent.freeSocketKeepAliveTimeout && !config.httpAgent.freeSocketTimeout) {
-      config.httpAgent.freeSocketTimeout = config.httpAgent.freeSocketKeepAliveTimeout;
-      delete config.httpAgent.freeSocketKeepAliveTimeout;
-    }
-    if (config.httpsAgent.freeSocketKeepAliveTimeout && !config.httpsAgent.freeSocketTimeout) {
-      config.httpsAgent.freeSocketTimeout = config.httpsAgent.freeSocketKeepAliveTimeout;
-      delete config.httpsAgent.freeSocketKeepAliveTimeout;
-    }
-  }
-
-  if (typeof config.maxSockets === 'number') {
-    config.httpAgent.maxSockets = config.maxSockets;
-    config.httpsAgent.maxSockets = config.maxSockets;
-  }
-  if (typeof config.maxFreeSockets === 'number') {
-    config.httpAgent.maxFreeSockets = config.maxFreeSockets;
-    config.httpsAgent.maxFreeSockets = config.maxFreeSockets;
-  }
-
-  if (config.httpAgent.timeout < 30000) {
-    app.coreLogger.warn('[ee:httpclient] config.httpclient.httpAgent.timeout(%s) can\'t below 30000, auto reset to 30000',
-      config.httpAgent.timeout);
-    config.httpAgent.timeout = 30000;
-  }
-  if (config.httpsAgent.timeout < 30000) {
-    app.coreLogger.warn('[ee:httpclient] config.httpclient.httpsAgent.timeout(%s) can\'t below 30000, auto reset to 30000',
-      config.httpsAgent.timeout);
-    config.httpsAgent.timeout = 30000;
-  }
-
-  if (typeof config.request.timeout === 'string') {
-    config.request.timeout = ms(config.request.timeout);
-  }
-}
-
-module.exports = HttpClient;
+'use strict';
+
+const Agent = require('agentkeepalive');
+const HttpsAgent = require('agentkeepalive').HttpsAgent;
+const urllib = require('urllib');
+const ms = require('humanize-ms');
+const { FrameworkBaseError } = require('egg-errors');
+
+class HttpClientError extends FrameworkBaseError {
+  get module() {
+    return 'httpclient';
+  }
+}
+
+class HttpClient extends urllib.HttpClient2 {
+  constructor(app) {
+    normalizeConfig(app);
+    const config = app.config.httpclient;
+    super({
+      app,
+      defaultArgs: config.request,
+      agent: new Agent(config.httpAgent),
+      httpsAgent: new HttpsAgent(config.httpsAgent),
+    });
+    this.app = app;
+  }
+
+  request(url, args, callback) {
+    if (typeof args === 'function') {
+      callback = args;
+      args = null;
+    }
+
+    args = args || {};
+
+    // the callback style
+    if (callback) {
+      //this.app.deprecate('[httpclient] We now support async for this function, so callback isn\'t recommended.');
+      super.request(url, args)
+        .then(result => process.nextTick(() => callback(null, result.data, result.res)))
+        .catch(err => process.nextTick(() => callback(err)));
+      return;
+    }
+
+    // the Promise style
+    return super.request(url, args)
+      .catch(err => {
+        if (err.code === 'ENETUNREACH') {
+          throw HttpClientError.create(err.message, err.code);
+        }
+        throw err;
+      });
+  }
+
+  curl(url, args, callback) {
+    return this.request(url, args, callback);
+  }
+
+  requestThunk(url, args) {
+    //this.app.deprecate('[httpclient] Please use `request()` instead of `requestThunk()`');
+    return callback => {
+      this.request(url, args, (err, data, res) => {
+        if (err) {
+          return callback(err);
+        }
+        callback(null, {
+          data,
+          status: res.status,
+          headers: res.headers,
+          res,
+        });
+      });
+    };
+  }
+}
+
+function normalizeConfig(app) {
+  const config = app.config.httpclient;
+
+  // compatibility
+  if (typeof config.keepAlive === 'boolean') {
+    config.httpAgent.keepAlive = config.keepAlive;
+    config.httpsAgent.keepAlive = config.keepAlive;
+  }
+  if (config.timeout) {
+    config.timeout = ms(config.timeout);
+    config.httpAgent.timeout = config.timeout;
+    config.httpsAgent.timeout = config.timeout;
+  }
+  // compatibility httpclient.freeSocketKeepAliveTimeout => httpclient.freeSocketTimeout
+  if (config.freeSocketKeepAliveTimeout && !config.freeSocketTimeout) {
+    config.freeSocketTimeout = config.freeSocketKeepAliveTimeout;
+    delete config.freeSocketKeepAliveTimeout;
+  }
+  if (config.freeSocketTimeout) {
+    config.freeSocketTimeout = ms(config.freeSocketTimeout);
+    config.httpAgent.freeSocketTimeout = config.freeSocketTimeout;
+    config.httpsAgent.freeSocketTimeout = config.freeSocketTimeout;
+  } else {
+    // compatibility agent.freeSocketKeepAliveTimeout
+    if (config.httpAgent.freeSocketKeepAliveTimeout && !config.httpAgent.freeSocketTimeout) {
+      config.httpAgent.freeSocketTimeout = config.httpAgent.freeSocketKeepAliveTimeout;
+      delete config.httpAgent.freeSocketKeepAliveTimeout;
+    }
+    if (config.httpsAgent.freeSocketKeepAliveTimeout && !config.httpsAgent.freeSocketTimeout) {
+      config.httpsAgent.freeSocketTimeout = config.httpsAgent.freeSocketKeepAliveTimeout;
+      delete config.httpsAgent.freeSocketKeepAliveTimeout;
+    }
+  }
+
+  if (typeof config.maxSockets === 'number') {
+    config.httpAgent.maxSockets = config.maxSockets;
+    config.httpsAgent.maxSockets = config.maxSockets;
+  }
+  if (typeof config.maxFreeSockets === 'number') {
+    config.httpAgent.maxFreeSockets = config.maxFreeSockets;
+    config.httpsAgent.maxFreeSockets = config.maxFreeSockets;
+  }
+
+  if (config.httpAgent.timeout < 30000) {
+    app.coreLogger.warn('[ee:httpclient] config.httpclient.httpAgent.timeout(%s) can\'t below 30000, auto reset to 30000',
+      config.httpAgent.timeout);
+    config.httpAgent.timeout = 30000;
+  }
+  if (config.httpsAgent.timeout < 30000) {
+    app.coreLogger.warn('[ee:httpclient] config.httpclient.httpsAgent.timeout(%s) can\'t below 30000, auto reset to 30000',
+      config.httpsAgent.timeout);
+    config.httpsAgent.timeout = 30000;
+  }
+
+  if (typeof config.request.timeout === 'string') {
+    config.request.timeout = ms(config.request.timeout);
+  }
+}
+
+module.exports = HttpClient;

package/lib/logger.js

@@ -1,47 +1,47 @@
-'use strict';
-
-const debug = require('debug')('ee-core:logger');
-const Loggers = require('egg-logger').EggLoggers;
-const assert = require('assert');
-
-class Logger {
-  constructor (config) {
-    debug('Loaded logger');
-    assert(Object.keys(config).length != 0, `logger config is null`);
-    this.eggLogger = this.init(config);
-  }
-
-  /**
-   * 单例
-   */
-  static getInstance (config = {}) {
-    if (typeof this.instance === 'object') {
-      return this.instance.eggLogger;
-    }
-
-    this.instance = new Logger(config);
-
-    // 返回egg-logger实例
-    return this.instance.eggLogger;
-  }
-
-  /**
-   * 初始化模块
-   */
-  init(config) {
-    const loggerConfig = config.logger;
-    loggerConfig.type = 'application'; // application、agent
-
-    if (config.env === 'prod' && loggerConfig.level === 'DEBUG' && !loggerConfig.allowDebugAtProd) {
-      loggerConfig.level = 'INFO';
-    }
-
-    const loggers = new Loggers(config);
-
-    loggers.coreLogger.info('[ee-core:logger] init all loggers with options: %j', loggerConfig);
-
-    return loggers;
-  };
-}
-
+'use strict';
+
+const debug = require('debug')('ee-core:logger');
+const Loggers = require('egg-logger').EggLoggers;
+const assert = require('assert');
+
+class Logger {
+  constructor (config) {
+    debug('Loaded logger');
+    assert(Object.keys(config).length != 0, `logger config is null`);
+    this.eggLogger = this.init(config);
+  }
+
+  /**
+   * 单例
+   */
+  static getInstance (config = {}) {
+    if (typeof this.instance === 'object') {
+      return this.instance.eggLogger;
+    }
+
+    this.instance = new Logger(config);
+
+    // 返回egg-logger实例
+    return this.instance.eggLogger;
+  }
+
+  /**
+   * 初始化模块
+   */
+  init(config) {
+    const loggerConfig = config.logger;
+    loggerConfig.type = 'application'; // application、agent
+
+    if (config.env === 'prod' && loggerConfig.level === 'DEBUG' && !loggerConfig.allowDebugAtProd) {
+      loggerConfig.level = 'INFO';
+    }
+
+    const loggers = new Loggers(config);
+
+    loggers.coreLogger.info('[ee-core:logger] init all loggers with options: %j', loggerConfig);
+
+    return loggers;
+  };
+}
+
 module.exports = Logger;

package/lib/socket/httpServer.js

@@ -1,143 +1,143 @@
-'use strict';
-
-const assert = require('assert');
-const is = require('is-type-of');
-const Koa = require('koa');
-const cors = require('koa2-cors');
-const koaBody = require('koa-body');
-const https = require('https');
-const fs = require('fs');
-const path = require('path');
-const _ = require('lodash');
-
-/**
- * http server
- */
-class HttpServer {
-  constructor (app) {
-    this.app = app;
-    this.options = this.app.config.httpServer;
-
-    if (!this.options.enable) {
-      return;
-    }
-
-    let port = process.env.EE_HTTP_PORT ? parseInt(process.env.EE_HTTP_PORT) : parseInt(this.getHttpPort());
-    assert(typeof port === 'number', 'http port required, and must be a number');
-
-    this.create();
-  }
-
-  /**
-   * 创建服务
-   */
-  create () {
-    const self = this;
-    const httpServer = this.options;
-    const isHttps = httpServer?.https?.enable ?? false;
-    let sslOptions = {};
-
-    if (isHttps === true) {
-      httpServer.protocol = 'https://';
-      const keyFile = path.join(this.app.config.homeDir, httpServer.https.key);
-      const certFile = path.join(this.app.config.homeDir, httpServer.https.cert);
-      assert(fs.existsSync(keyFile), 'ssl key file is required');
-      assert(fs.existsSync(certFile), 'ssl cert file is required');
-
-      sslOptions.key = fs.readFileSync(keyFile);
-      sslOptions.cert = fs.readFileSync(certFile);
-    }
-    const url = httpServer.protocol + httpServer.host + ':' + httpServer.port;
-    const corsOptions = httpServer.cors;
-
-    const koaApp = new Koa();
-    koaApp
-      .use(cors(corsOptions))
-      .use(koaBody(httpServer.body))
-      .use(async (ctx, next) => {
-        ctx.eeApp = self.app;
-        await next();
-      })
-      .use(this.dispatch);
-
-    let msg = '[ee-core:http:server] server is: ' + url;
-    if (isHttps) {
-      https.createServer(sslOptions, koaApp.callback()).listen(httpServer.port, (err) => {
-        msg = err ? err : msg;
-        self.app.coreLogger.info(msg);
-      });
-    } else {
-      koaApp.listen(httpServer.port, (e) => {
-        msg = e ? e : msg;
-        self.app.coreLogger.info(msg);
-      });
-    }  
-  }
-
-  /**
-   * 路由分发
-   */
-  async dispatch (ctx, next) {
-    const config = ctx.eeApp.config.httpServer;
-    let uriPath = ctx.request.path;
-    const method = ctx.request.method;
-    let params = ctx.request.query;
-    params = is.object(params) ? JSON.parse(JSON.stringify(params)) : {};
-    const body = ctx.request.body;
-
-    // 默认
-    ctx.response.status = 200;
-
-    // 添加到全局属性
-    ctx.eeApp.request = ctx.request;
-    ctx.eeApp.response = ctx.response;
-
-    try {
-      // 找函数
-      // 去除开头的 '/'
-      if (uriPath.indexOf('/') == 0) {
-        uriPath = uriPath.substring(1);
-      }
-      // 过滤
-      if (_.includes(config.filterRequest.uris, uriPath)) {
-        ctx.response.body = config.filterRequest.returnData;
-        await next();
-        return
-      }
-      if (uriPath.slice(0, 10) != 'controller') {
-        uriPath = 'controller/' + uriPath;
-      }
-      const cmd = uriPath.split('/').join('.');
-      const args = (method == 'POST') ? body : params;
-      let fn = null;
-      if (is.string(cmd)) {
-        const actions = cmd.split('.');
-        let obj = ctx.eeApp;
-        actions.forEach(key => {
-          obj = obj[key];
-          if (!obj) throw new Error(`class or function '${key}' not exists`);
-        });
-        fn = obj;
-      }
-      if (!fn) throw new Error('function not exists');
-
-      const result = await fn.call(ctx.eeApp, args);
-      ctx.response.body = result;
-    } catch (err) {
-      ctx.eeApp.console.error('[ee-core:http:server] throw error:', err);
-    }
-
-    await next();
-  }
-
-  /**
-   * 获取http端口
-   */  
-  getHttpPort () {
-    const cdb = this.getCoreDB();
-    const port = cdb.getItem('config').httpServer.port;
-    return parseInt(port);
-  } 
-}
-
+'use strict';
+
+const assert = require('assert');
+const is = require('is-type-of');
+const Koa = require('koa');
+const cors = require('koa2-cors');
+const koaBody = require('koa-body');
+const https = require('https');
+const fs = require('fs');
+const path = require('path');
+const _ = require('lodash');
+
+/**
+ * http server
+ */
+class HttpServer {
+  constructor (app) {
+    this.app = app;
+    this.options = this.app.config.httpServer;
+
+    if (!this.options.enable) {
+      return;
+    }
+
+    let port = process.env.EE_HTTP_PORT ? parseInt(process.env.EE_HTTP_PORT) : parseInt(this.getHttpPort());
+    assert(typeof port === 'number', 'http port required, and must be a number');
+
+    this.create();
+  }
+
+  /**
+   * 创建服务
+   */
+  create () {
+    const self = this;
+    const httpServer = this.options;
+    const isHttps = httpServer?.https?.enable ?? false;
+    let sslOptions = {};
+
+    if (isHttps === true) {
+      httpServer.protocol = 'https://';
+      const keyFile = path.join(this.app.config.homeDir, httpServer.https.key);
+      const certFile = path.join(this.app.config.homeDir, httpServer.https.cert);
+      assert(fs.existsSync(keyFile), 'ssl key file is required');
+      assert(fs.existsSync(certFile), 'ssl cert file is required');
+
+      sslOptions.key = fs.readFileSync(keyFile);
+      sslOptions.cert = fs.readFileSync(certFile);
+    }
+    const url = httpServer.protocol + httpServer.host + ':' + httpServer.port;
+    const corsOptions = httpServer.cors;
+
+    const koaApp = new Koa();
+    koaApp
+      .use(cors(corsOptions))
+      .use(koaBody(httpServer.body))
+      .use(async (ctx, next) => {
+        ctx.eeApp = self.app;
+        await next();
+      })
+      .use(this.dispatch);
+
+    let msg = '[ee-core:http:server] server is: ' + url;
+    if (isHttps) {
+      https.createServer(sslOptions, koaApp.callback()).listen(httpServer.port, (err) => {
+        msg = err ? err : msg;
+        self.app.coreLogger.info(msg);
+      });
+    } else {
+      koaApp.listen(httpServer.port, (e) => {
+        msg = e ? e : msg;
+        self.app.coreLogger.info(msg);
+      });
+    }  
+  }
+
+  /**
+   * 路由分发
+   */
+  async dispatch (ctx, next) {
+    const config = ctx.eeApp.config.httpServer;
+    let uriPath = ctx.request.path;
+    const method = ctx.request.method;
+    let params = ctx.request.query;
+    params = is.object(params) ? JSON.parse(JSON.stringify(params)) : {};
+    const body = ctx.request.body;
+
+    // 默认
+    ctx.response.status = 200;
+
+    // 添加到全局属性
+    ctx.eeApp.request = ctx.request;
+    ctx.eeApp.response = ctx.response;
+
+    try {
+      // 找函数
+      // 去除开头的 '/'
+      if (uriPath.indexOf('/') == 0) {
+        uriPath = uriPath.substring(1);
+      }
+      // 过滤
+      if (_.includes(config.filterRequest.uris, uriPath)) {
+        ctx.response.body = config.filterRequest.returnData;
+        await next();
+        return
+      }
+      if (uriPath.slice(0, 10) != 'controller') {
+        uriPath = 'controller/' + uriPath;
+      }
+      const cmd = uriPath.split('/').join('.');
+      const args = (method == 'POST') ? body : params;
+      let fn = null;
+      if (is.string(cmd)) {
+        const actions = cmd.split('.');
+        let obj = ctx.eeApp;
+        actions.forEach(key => {
+          obj = obj[key];
+          if (!obj) throw new Error(`class or function '${key}' not exists`);
+        });
+        fn = obj;
+      }
+      if (!fn) throw new Error('function not exists');
+
+      const result = await fn.call(ctx.eeApp, args);
+      ctx.response.body = result;
+    } catch (err) {
+      ctx.eeApp.console.error('[ee-core:http:server] throw error:', err);
+    }
+
+    await next();
+  }
+
+  /**
+   * 获取http端口
+   */  
+  getHttpPort () {
+    const cdb = this.getCoreDB();
+    const port = cdb.getItem('config').httpServer.port;
+    return parseInt(port);
+  } 
+}
+
 module.exports = HttpServer;