ee-core 2.11.1 → 4.0.0-beta.1

package/utils/json.js

@@ -2,7 +2,7 @@ const fs = require('fs');
 const path = require('path');
 const mkdirp = require('mkdirp');
 
-exports.strictParse = function (str) {
+function strictParse(str) {
   const obj = JSON.parse(str);
   if (!obj || typeof obj !== 'object') {
     throw new Error('JSON string is not object');
@@ -10,14 +10,14 @@ exports.strictParse = function (str) {
   return obj;
 };
 
-exports.readSync = function(filepath) {
+function readSync(filepath) {
   if (!fs.existsSync(filepath)) {
     throw new Error(filepath + ' is not found');
   }
   return JSON.parse(fs.readFileSync(filepath));
 };
 
-exports.writeSync = function(filepath, str, options) {
+function writeSync(filepath, str, options) {
   options = options || {};
   if (!('space' in options)) {
     options.space = 2;
@@ -31,7 +31,7 @@ exports.writeSync = function(filepath, str, options) {
   fs.writeFileSync(filepath, str);
 };
 
-exports.read = function(filepath) {
+function read(filepath) {
   return fs.stat(filepath)
     .then(function(stats) {
       if (!stats.isFile()) {
@@ -44,7 +44,7 @@ exports.read = function(filepath) {
     });
 };
 
-exports.write = function(filepath, str, options) {
+function write(filepath, str, options) {
   options = options || {};
   if (!('space' in options)) {
     options.space = 2;
@@ -54,13 +54,13 @@ exports.write = function(filepath, str, options) {
     str = JSON.stringify(str, options.replacer, options.space) + '\n';
   }
 
-  return mkdir(path.dirname(filepath))
+  return _mkdir(path.dirname(filepath))
     .then(function() {
       return fs.writeFile(filepath, str);
     });
 };
 
-function mkdir(dir) {
+function _mkdir(dir) {
   return new Promise(function(resolve, reject) {
     mkdirp(dir, function(err) {
       if (err) {
@@ -70,3 +70,11 @@ function mkdir(dir) {
     });
   });
 }
+
+module.exports = {
+  strictParse,
+  readSync,
+  writeSync,
+  read,
+  write
+}

package/utils/pargv.js

@@ -20,7 +20,7 @@ function isConstructorOrProto(obj, key) {
 	return (key === 'constructor' && typeof obj[key] === 'function') || key === '__proto__';
 }
 
-module.exports = function (args, opts) {
+function parseArgv(args, opts) {
 	if (!opts) { opts = {}; }
 
 	var flags = {
@@ -261,3 +261,7 @@ module.exports = function (args, opts) {
 
 	return argv;
 };
+
+module.exports = {
+  parseArgv
+}

package/utils/{get-port → port}/index.js

@@ -77,7 +77,7 @@ const portCheckSequence = function * (ports) {
 	yield 0; // Fall back to 0 if anything else failed
 };
 
-module.exports = async options => {
+async function getPort(options) {
 	let ports;
 
 	if (options) {
@@ -121,28 +121,6 @@ module.exports = async options => {
 	throw new Error('No available ports found');
 };
 
-module.exports.makeRange = (from, to) => {
-	if (!Number.isInteger(from) || !Number.isInteger(to)) {
-		throw new TypeError('`from` and `to` must be integer numbers');
-	}
-
-	if (from < 1024 || from > 65535) {
-		throw new RangeError('`from` must be between 1024 and 65535');
-	}
-
-	if (to < 1024 || to > 65536) {
-		throw new RangeError('`to` must be between 1024 and 65536');
-	}
-
-	if (to < from) {
-		throw new RangeError('`to` must be greater than or equal to `from`');
-	}
-
-	const generator = function * (from, to) {
-		for (let port = from; port <= to; port++) {
-			yield port;
-		}
-	};
-
-	return generator(from, to);
-};
+module.exports = {
+	getPort
+}

package/utils/wrap.js

@@ -1,7 +1,7 @@
 const assert = require('assert');
 const is = require('is-type-of');
 
-exports.getProperties = (filepath, { caseStyle }) => {
+function getProperties(filepath, { caseStyle }) {
   // if caseStyle is function, return the result of function
   if (is.function(caseStyle)) {
     const result = caseStyle(filepath);
@@ -9,10 +9,10 @@ exports.getProperties = (filepath, { caseStyle }) => {
     return result;
   }
   // use default camelize
-  return this.defaultCamelize(filepath, caseStyle);
+  return defaultCamelize(filepath, caseStyle);
 }
 
-exports.defaultCamelize = (filepath, caseStyle) => {
+function defaultCamelize(filepath, caseStyle) {
   const properties = filepath.substring(0, filepath.lastIndexOf('.')).split('/');
   return properties.map(property => {
     if (!/^[a-z][a-z0-9_-]*$/i.test(property)) {
@@ -33,4 +33,9 @@ exports.defaultCamelize = (filepath, caseStyle) => {
     }
     return first + property.substring(1);
   });
+}
+
+module.exports = {
+  getProperties,
+  defaultCamelize,
 }

package/addon/index.js

@@ -1,35 +0,0 @@
-const EE = require('../ee');
-
-const Addon = {
-
-  /**
-   * 获取 all addon instances
-   */  
-  all() {
-    const { CoreApp } = EE;
-    if (!CoreApp) {
-      throw new Error('An unknown error or Addons cannot be used by the jobs!');
-    }
-
-    const instances = CoreApp.addon || null;
-    if (!instances) {
-      throw new Error('Addons not exists or do not call directly at the top!');
-    };
-    return instances;
-  },
-
-  /**
-   * 获取 addon instance
-   */  
-  get(name) {
-    const instances = this.all();
-    const instance = instances[name] || null;
-    if (!instance) {
-      throw new Error(`Addon class '${name}' not exists or do not call directly at the top!`);
-    };
-    return instance;
-  },
- 
-};
-
-module.exports = Addon;

package/addon/window/index.js

@@ -1,99 +0,0 @@
-const { BrowserWindow } = require('electron');
-const extend = require('../../utils/extend');
-
-/**
- * 窗口插件
- * @class
- */
-class WinAddon {
-
-  constructor(app) {
-    this.app = app;
-    this.windowContentsIdMap = {};
-  }
-
-  /**
-   * create window
-   *
-   * @function 
-   * @since 1.0.0
-   */
-  create(name, opt) {
-
-    // todo 判断name是否唯一
-    // if (this.windowContentsIdMap.hasOwnProperty(name)) {
-    //   throw new Error(`[addon] [window] Name: ${name} already exists!`);
-    // }
- 
-    const options = extend(true, {}, {
-      x: 10,
-      y: 10,
-      width: 980, 
-      height: 650,
-      webPreferences: {
-        contextIsolation: false,
-        nodeIntegration: true,
-      },
-    }, opt);
-    const win = new BrowserWindow(options)
-    
-    const winContentsId = win.webContents.id;
-    win.webContents.on('did-finish-load', () => {
-      this.registerWCid(name, winContentsId);
-    })
- 
-    win.webContents.on('destroyed', () => {
-      this.removeWCid(name);
-    })
-
-    win.webContents.on('render-process-gone', (event, details) => {
-      this.removeWCid(name);
-    })
-
-    return win;
-  }
-
-  /**
-   * 获取窗口Contents id
-   *
-   * @function 
-   * @since 1.0.0
-   */
-  getWCid(name) {
-    const id = this.windowContentsIdMap[name] || null;
-    return id;
-  }
-
-  /**
-   * 获取主窗口Contents id
-   *
-   * @function 
-   * @since 1.0.0
-   */
-  getMWCid() {
-    const id = this.windowContentsIdMap['main'] || null;
-    return id;
-  }
-
-  /**
-   * 注册窗口Contents id
-   *
-   * @function 
-   * @since 1.0.0
-   */
-  registerWCid(name, id) {
-    this.windowContentsIdMap[name] = id;
-  }
-
-  /**
-   * 销毁窗口Contents id
-   *
-   * @function 
-   * @since 1.0.0
-   */
-   removeWCid(name) {
-    delete this.windowContentsIdMap[name];
-  }  
-}
-
-module.exports = WinAddon;

package/bin/tools.js

@@ -1,8 +0,0 @@
-#!/usr/bin/env node
-
-const chalk = require('chalk');
-
-let tip = chalk.bgYellow('Warning') + ' please use ' + chalk.blue('ee-bin') + ', See: ';
-tip += chalk.underline('https://www.kaka996.com/pages/e1816f/');
-
-console.log(tip);

package/config/cache.js

@@ -1,42 +0,0 @@
-const EE = require('../ee');
-
-const conf = {
-
-  /**
-   * 获取 内存中的config
-   */
-  _getConfig(withError = true) {
-    const { CoreApp } = EE;
-    if (!CoreApp && withError) {
-      throw new Error(`[ee-core] [config] Frame initialization is not complete !`);
-    }
-    if (!CoreApp) {
-      return null;
-    }
-
-    return CoreApp.config;
-  },
-
-  /**
-   * all
-   */
-  all(withError = true) {
-    return this._getConfig(withError);
-  },
-
-  /**
-   * getValue
-   */
-  getValue(key) {
-    const v = this._objectGet(this._getConfig(), key);
-    return v;
-  }, 
-  
-  _objectGet(object, path, defaultValue) {
-    const pathParts = Array.isArray(path) ? path : path.split('.');
-    const value = pathParts.reduce((obj, key) => obj && key in obj ? obj[key] : undefined, object);
-    return value === undefined ? defaultValue : value;
-  }
-};
-
-module.exports = conf;

package/config/config.default.js

@@ -1,331 +0,0 @@
-const path = require('path');
-
-/**
- * The configuration of ee application, can be access by `app.config`
- * @class Config
- * @since 1.0.0
- */
-
-module.exports = appInfo => {
-
-  const config = {
-
-    /**
-     * The environment of ee
-     * @member {String} Config#env
-     * @see {appInfo#env}
-     * @since 1.0.0
-     */
-    env: appInfo.env,
-
-    /**
-     * The name of the application
-     * @member {String} Config#name
-     * @see {appInfo#name}
-     * @since 1.0.0
-     */
-    name: appInfo.name,
-
-    /**
-     * The current directory of the application
-     * @member {String} Config#baseDir
-     * @see {appInfo#baseDir}
-     * @since 1.0.0
-     */
-    baseDir: appInfo.baseDir,
-
-    /**
-     * The current HOME directory
-     * @member {String} Config#HOME
-     * @see {appInfo#HOME}
-     * @since 1.0.0
-     */
-    HOME: appInfo.home,
-
-    /**
-     * The directory of server running. You can find `application_config.json` under it that is dumpped from `app.config`.
-     * @member {String} Config#rundir
-     * @default
-     * @since 1.0.0
-     */
-    rundir: path.join(appInfo.baseDir, 'run'),
-
-    /**
-     * dump config
-     *
-     * It will ignore special keys when dumpConfig
-     *
-     * @member Config#dump
-     * @property {Set} ignore - keys to ignore
-     */
-    dump: {
-      ignore: new Set([
-        'pass', 'pwd', 'passd', 'passwd', 'password', 'keys', 'masterKey', 'accessKey',
-        // ignore any key contains "secret" keyword
-        /secret/i,
-      ]),
-    },
-
-    /**
-     * application home directory
-     * @member {String} Config#homeDir
-     * @default
-     * @since 1.0.0
-     */
-    homeDir: appInfo.home,
-
-    /**
-     * application data & logs directory by env
-     * @member {String} Config#root
-     * @default
-     * @since 1.0.0
-     */
-    root: appInfo.root,
-
-    /**
-     * application data directory
-     * @member {String} Config#appUserDataDir
-     * @default
-     * @since 1.0.0
-     */
-    appUserDataDir: appInfo.appUserDataDir,
-
-    /**
-     * system user home dir 
-     * @member {String} Config#userHome
-     */
-    userHome: appInfo.userHome,
-
-    /**
-      * application version
-      * @member {String} Config#appVersion
-      */
-    appVersion: appInfo.appVersion,
-
-    /**
-      * application package status
-      * @member {boolean} Config#isPackaged
-      */      
-    isPackaged: appInfo.isPackaged,
-
-    /**
-      * application exec file dir
-      * @member {String} Config#execDir
-      */  
-    execDir: appInfo.execDir
-  };
-
-  /**
-   * logger options
-   * @member Config#logger
-   * @property {String} dir - directory of log files
-   * @property {String} encoding - log file encoding, defaults to utf8
-   * @property {String} level - default log level, could be: DEBUG, INFO, WARN, ERROR or NONE, defaults to INFO in production
-   * @property {String} consoleLevel - log level of stdout, defaults to INFO in local serverEnv, defaults to WARN in unittest, defaults to NONE elsewise
-   * @property {Boolean} disableConsoleAfterReady - disable logger console after app ready. defaults to `false` on local and unittest env, others is `true`.
-   * @property {Boolean} outputJSON - log as JSON or not, defaults to false
-   * @property {Boolean} buffer - if enabled, flush logs to disk at a certain frequency to improve performance, defaults to true
-   * @property {String} errorLogName - file name of errorLogger
-   * @property {String} coreLogName - file name of coreLogger
-   * @property {String} agentLogName - file name of agent worker log
-   * @property {Object} coreLogger - custom config of coreLogger
-   * @property {Boolean} allowDebugAtProd - allow debug log at prod, defaults to false
-   * @property {Boolean} enablePerformanceTimer - using performance.now() timer instead of Date.now() for more more precise milliseconds, defaults to false. e.g.: logger will set 1.456ms instead of 1ms.
-   */
-  config.logger = {
-    type: 'application',
-    dir: path.join(appInfo.root, 'logs'),
-    encoding: 'utf8',
-    env: appInfo.env,
-    level: 'INFO',
-    consoleLevel: 'INFO',
-    disableConsoleAfterReady: appInfo.env !== 'local' && appInfo.env !== 'unittest',
-    outputJSON: false,
-    buffer: true,
-    appLogName: `ee.log`,
-    coreLogName: 'ee-core.log',
-    agentLogName: 'ee-agent.log',
-    errorLogName: `ee-error.log`,
-    coreLogger: {},
-    allowDebugAtProd: false,
-    enablePerformanceTimer: false,
-    rotator: 'none',
-  };
-
-  /**
-   * customLogger options
-   * @member Config#customLogger
-   * 
-   */  
-  config.customLogger = {}
-
-  /**
-   * The option for httpclient
-   * @member Config#httpclient
-   * @property {Boolean} enableDNSCache - Enable DNS lookup from local cache or not, default is false.
-   * @property {Boolean} dnsCacheLookupInterval - minimum interval of DNS query on the same hostname (default 10s).
-   *
-   * @property {Number} request.timeout - httpclient request default timeout, default is 5000 ms.
-   *
-   * @property {Boolean} httpAgent.keepAlive - Enable http agent keepalive or not, default is true
-   * @property {Number} httpAgent.freeSocketTimeout - http agent socket keepalive max free time, default is 4000 ms.
-   * @property {Number} httpAgent.maxSockets - http agent max socket number of one host, default is `Number.MAX_SAFE_INTEGER` @ses https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/MAX_SAFE_INTEGER
-   * @property {Number} httpAgent.maxFreeSockets - http agent max free socket number of one host, default is 256.
-   *
-   * @property {Boolean} httpsAgent.keepAlive - Enable https agent keepalive or not, default is true
-   * @property {Number} httpsAgent.freeSocketTimeout - httpss agent socket keepalive max free time, default is 4000 ms.
-   * @property {Number} httpsAgent.maxSockets - https agent max socket number of one host, default is `Number.MAX_SAFE_INTEGER` @ses https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/MAX_SAFE_INTEGER
-   * @property {Number} httpsAgent.maxFreeSockets - https agent max free socket number of one host, default is 256.
-   */
-  config.httpclient = {
-    enableDNSCache: false,
-    dnsCacheLookupInterval: 10000,
-    dnsCacheMaxLength: 1000,
-    request: {
-      timeout: 5000,
-    },
-    httpAgent: {
-      keepAlive: true,
-      freeSocketTimeout: 4000,
-      maxSockets: Number.MAX_SAFE_INTEGER,
-      maxFreeSockets: 256,
-    },
-    httpsAgent: {
-      keepAlive: true,
-      freeSocketTimeout: 4000,
-      maxSockets: Number.MAX_SAFE_INTEGER,
-      maxFreeSockets: 256,
-    },
-  };
-
-  /**
-   * 应用模式配置
-   */
-  config.developmentMode = {
-    default: 'vue',
-    mode: {
-      vue: {
-        protocol: 'http://',
-        hostname: 'localhost',
-        port: 8080
-      },
-      react: {
-        protocol: 'http://',
-        hostname: 'localhost',
-        port: 3000
-      },
-      html: {
-        protocol: 'http://',
-        hostname: 'localhost',
-        indexPage: 'index.html'
-      },
-    }
-  };
-
-  /* 内置socket服务 */
-  config.socketServer = {
-    enable: false, // 是否启用
-    port: 7070, // 默认端口（如果端口被使用，则随机获取一个）
-    path: "/socket.io/", // 路径名称
-    connectTimeout: 45000, // 客户端连接超时时间
-    pingTimeout: 30000, // 心跳检测超时时间
-    pingInterval: 25000, // 心跳检测间隔
-    maxHttpBufferSize: 1e8, // 每条消息的数据大小 1M
-    transports: ["polling", "websocket"], // http轮询和websocket
-    cors: {
-      origin: true, // http协议时，要设置跨域 类型 Boolean String RegExp Array Function
-    }
-  };
-  
-  /* 内置http服务 */
-  config.httpServer = {
-    enable: false, // 是否启用
-    https: {
-      enable: false,
-      key: '',
-      cert: ''
-    },
-    protocol: 'http://',
-    host: 'localhost',
-    port: 7071, // 默认端口（如果端口被使用，则随机获取一个）
-    cors: {
-      origin: "*"
-    },
-    body: {
-      multipart: true, // 文件类型
-    },
-    filterRequest: {
-      uris:  [],
-      returnData: ''
-    }
-  };  
-
-  /* 主进程加载的地址 */
-  config.mainServer = {
-    protocol: 'file://', // http:// | https:// | file://
-    indexPath: '/public/dist/index.html',
-    host: 'localhost',
-    port: 7072, // 默认端口（如果端口被使用，则随机获取一个）
-    open: false, // 是否开放0.0.0.0，默认关闭
-    options: {},
-    ssl: {
-      key: '',
-      cert: ''
-    }
-  }; 
-
-  /**
-   * 应用程序顶部菜单
-   * boolean | string
-   * true, false, 'dev-show'(dev环境显示，prod环境隐藏)
-   */
-  config.openAppMenu = true; 
-
-  /**
-   * 硬件加速
-   */
-  config.hardGpu = {
-    enable: true
-  };
-
-  /**
-   * TODO storage
-   */
-  config.storage = {
-    dir: path.join(appInfo.root, 'data'),
-  };
-
-  /**
-   * addons
-   */
-  config.addons = {
-    window: {
-      enable: true,
-    }
-  }; 
-
-  /**
-   * 异常捕获
-   */
-  config.exception = {
-    mainExit: false,
-    childExit: true,
-    rendererExit: true,
-  };
-
-  /**
-   * Cross-language service
-   * 跨语言服务
-   * 例如：执行go的二进制程序
-   */
-  config.cross = {};   
-  
-  /**
-   * jobs
-   */
-  config.jobs = {
-    messageLog: true
-  };  
-  
-  return config;
-};

package/controller/baseContextClass.js

@@ -1,25 +0,0 @@
-'use strict';
-
-/**
- * BaseContextClass is a base class that can be extended,
- * it's instantiated in context level,
- */
-class BaseContextClass {
-
-  /**
-   * @class
-   * @param {Context} ctx - context instance
-   * @since 1.1.0
-   */
-  constructor(ctx) {
-
-    // todo 兼容旧版本，后续废弃ctx
-    if (typeof ctx === 'object') {
-      this.app = ctx;
-      this.config = ctx.config;
-      this.service = ctx.service;
-    }
-  }
-}
-
-module.exports = BaseContextClass;