ee-core 2.12.0 → 4.0.0

package/loader/index.js

@@ -1,162 +1,92 @@
 const is = require('is-type-of');
 const fs = require('fs');
 const path = require('path');
-const UtilsCore = require('../core/lib/utils');
-const Ps = require('../ps');
-
-module.exports = {
+const CoreUtils = require('../core/utils');
+const { getElectronDir } = require('../ps');
+
+// 加载单个文件(如果是函数，将被执行)
+function loadFile(filepath, ...inject) {
+  const isAbsolute = path.isAbsolute(filepath);
+  if (!isAbsolute) {
+    filepath = path.join(getElectronDir(), filepath);
+  }
 
-  /**
-   * 加载单个文件(如果是函数，将被执行)
-   *
-   * @param {String} filepath - fullpath
-   * @param {Array} inject - pass rest arguments into the function when invoke
-   * @return {Object} exports
-   * @since 1.0.0
-   */
-  loadOneFile (filepath, ...inject) {
-    const isAbsolute = path.isAbsolute(filepath);
-    if (!isAbsolute) {
-      filepath = path.join(Ps.getBaseDir(), filepath);
-    }
+  filepath = filepath && resolveModule(filepath);
+  if (!fs.existsSync(filepath)) {
+    let errorMsg = `[ee-core] [loader/index] loadFile ${filepath} does not exist`;
+    throw new Error(errorMsg);
+  }
 
-    filepath = filepath && this.resolveModule(filepath);
-    if (!fs.existsSync(filepath)) {
-      let errorMsg = `[ee-core] [loader/index] loadOneFile ${filepath} does not exist`;
-      throw new Error(errorMsg);
-    }
+  let ret = CoreUtils.loadFile(filepath);
+  if (is.function(ret) && !is.class(ret) && !CoreUtils.isBytecodeClass(ret)) {
+    ret = ret(...inject);
+  }
+  return ret;
+}
 
-    let ret = UtilsCore.loadFile(filepath);
-    if (is.function(ret) && !is.class(ret) && !UtilsCore.isBytecodeClass(ret)) {
-      ret = ret(...inject);
-    }
-    return ret;
-  },
-
-  /**
-   * 加载js文件
-   *
-   * @param {String} filepath - fullpath
-   * @return {Any} exports
-   * @since 1.0.0
-   */
-  loadJsFile (filepath) {
-    if (!fs.existsSync(filepath)) {
-      let errMsg = `[ee-core] [loader] loadJobFile ${filepath} does not exist`;
-      throw new Error(errMsg);
-    }
+// requireFile
+function requireFile(filepath) {
+  return CoreUtils.loadFile(filepath);
+}
 
-    const ret = UtilsCore.loadFile(filepath);
-    return ret;
-  },  
-
-  /**
-   * 加载并运行js文件
-   *
-   * @param {String} filepath - fullpath
-   * @param {Array} inject - pass rest arguments into the function when invoke
-   * @return {Any}
-   * @since 1.0.0
-   */
-  execJsFile (filepath, ...inject) {
-    if (!fs.existsSync(filepath)) {
-      let errMsg = `[ee-core] [loader] loadJobFile ${filepath} does not exist`;
-      throw new Error(errMsg);
-    }
+// 加载并运行文件
+function execFile(filepath, ...inject) {
+  let ret = CoreUtils.loadFile(filepath);
+  if (is.class(ret) || CoreUtils.isBytecodeClass(ret)) {
+    ret = new ret(inject);
+  } else if (is.function(ret)) {
+    ret = ret(inject);
+  }
 
-    let ret = UtilsCore.loadFile(filepath);
-    if (is.class(ret) || UtilsCore.isBytecodeClass(ret)) {
-      ret = new ret(inject);
-    } else if (is.function(ret)) {
-      ret = ret(inject);
-    }
+  return ret;
+}
 
-    return ret;
-  }, 
-
-  /**
-   * 模块的绝对路径
-   * @param {String} filepath - fullpath
-   */
-  resolveModule(filepath) {
-    let fullpath;
-    try {
-      fullpath = require.resolve(filepath);
-    } catch (e) {
-
-      // 特殊后缀处理
-      if (filepath && (filepath.endsWith('.defalut') || filepath.endsWith('.prod'))) {
-        fullpath = filepath + '.jsc';
-      } else if (filepath && filepath.endsWith('.js')) {
-        fullpath = filepath + 'c';
-      }
-
-      if (!fs.existsSync(filepath) && !fs.existsSync(fullpath)) {
-        let files = { filepath, fullpath }
-        console.warn(`[ee-core] [loader] resolveModule unknow filepath: ${files}`)
-        return undefined;
-      }
+// 模块的绝对路径
+function resolveModule(filepath) {
+  let fullpath;
+  try {
+    fullpath = require.resolve(filepath);
+  } catch (e) {
+
+    // 特殊后缀处理
+    if (filepath && (filepath.endsWith('.defalut') || filepath.endsWith('.prod'))) {
+      fullpath = filepath + '.jsc';
+    } else if (filepath && filepath.endsWith('.js')) {
+      fullpath = filepath + 'c';
     }
 
-    return fullpath;
-  },
-
-  /**
-   * 加载模块(子进程中使用)
-   *
-   * @param {String} filepath - fullpath
-   * @return {Object} exports
-   * @since 1.0.0
-   */
-  requireModule (filepath, type = '') {
-    let fullpath;
-    const isAbsolute = path.isAbsolute(filepath);
-    if (!isAbsolute) {
-      filepath = path.join(Ps.getBaseDir(), type, filepath);
+    if (!fs.existsSync(filepath) && !fs.existsSync(fullpath)) {
+      let files = { filepath, fullpath }
+      console.warn(`[ee-core] [loader] resolveModule unknow filepath: ${files}`)
+      return undefined;
     }
+  }
 
-    fullpath = this.resolveModule(filepath);
-    if (!fs.existsSync(fullpath)) {
-      let errorMsg = `[ee-core] [loader] requireModule filepath: ${filepath} does not exist`;
-      throw new Error(errorMsg);
-    }
-    const ret = UtilsCore.loadFile(fullpath);
-
-    return ret;
-  },   
-
-  /**
-   * 加载jobs模块(子进程中使用)
-   *
-   * @param {String} filepath - fullpath
-   * @return {Object} exports
-   * @since 1.0.0
-   */
-  requireJobsModule (filepath) {
-    const ret = this.requireModule(filepath, 'jobs');
-
-    return ret;
-  },
-  
-  /**
-   * 获取electron目录下文件的绝对路径
-   * @param {String} filepath - fullpath
-   */
-  getFullpath(filepath) {
-    let fullpath;
-    const isAbsolute = path.isAbsolute(filepath);
-    if (!isAbsolute) {
-      filepath = path.join(Ps.getBaseDir(), filepath);
-    }
+  return fullpath;
+}
 
-    fullpath = this.resolveModule(filepath);
-    if (!fs.existsSync(fullpath)) {
-      throw new Error(`[ee-core] [loader] getFullpath filepath ${fullpath} not exists`);
-    }
+// 获取electron目录下文件的绝对路径
+function getFullpath(filepath) {
+  let fullpath;
+  const isAbsolute = path.isAbsolute(filepath);
+  if (!isAbsolute) {
+    filepath = path.join(getElectronDir(), filepath);
+  }
 
-    return fullpath;
+  fullpath = resolveModule(filepath);
+  if (!fs.existsSync(fullpath)) {
+    throw new Error(`[ee-core] [loader] getFullpath filepath ${filepath} not exists`);
   }
-  
+
+  return fullpath;
+}
+
+module.exports = {
+  loadFile,
+  execFile,
+  requireFile,
+  resolveModule,
+  getFullpath,
 }
 
 

package/log/index.d.ts

@@ -0,0 +1,5 @@
+import { EggLoggers, Logger } from "egg-logger";
+export declare function createLog(config: any): EggLoggers;
+export declare function loadLog(): EggLoggers;
+export declare const logger: Logger;
+export declare const coreLogger: Logger;

package/log/index.js

@@ -1,69 +1,86 @@
-const dayjs = require('dayjs');
-const Logger = require('./logger');
-const EELoggers = Symbol('EeApplication#EELoggers');
-let LogDate = 0;
+'use strict';
 
-const Log = {
-  /**
-   * 创建日志实例
-   */
-  create(config) {
-    this._delCache();
-    const eeLog = Logger.create(config);
+const dayjs = require('dayjs');
+const { create } = require('./logger');
 
-    return eeLog;
-  },
+const Instance = {
+  eelog: null,
+  logger: {},
+  coreLogger: {},
+};
+let logDate = 0;
+const logProperties = ['error', 'warn', 'info', 'debug'];
 
-  /**
-   * delete cache
-   */
-  _delCache() {
-    let now = parseInt(dayjs().format('YYYYMMDD'));
-    if (LogDate != now) {
-      LogDate = now;
-      this[EELoggers] = null;
-    }
-  },
+// define logger/coreLogger properties
+defineLoggerProperty();
+defineCoreLoggerProperty();
 
-  /**
-   * logger
-   */
-  get logger() {
-    this._delCache();
-    if (!this[EELoggers]) {
-      this[EELoggers] = Logger.create();
-    }
+// Create a log instance
+function createLog(config) {
+  _delCache();
+  const eeLog = create(config);
 
-    return this[EELoggers]['logger'] || null;
-  },
+  return eeLog;
+}
 
-  /**
-   * coreLogger
-   */
-  get coreLogger () {
-    this._delCache();
-    if (!this[EELoggers]) {
-      this[EELoggers] = Logger.create();
-    }
+function loadLog() {
+  Instance.eelog = createLog();
+  return Instance.eelog;
+}
 
-    return this[EELoggers]['coreLogger'] || null;
-  },
+function defineLoggerProperty() {
+  for (const property of logProperties) {
+    Object.defineProperty(Instance.logger, property, {
+      get() {
+        //console.log('emit logger property: ', property);
+        let log = getLogger();
+        let val = log[property].bind(log);
+        return val;
+      },
+    });
+  }
+}
 
-  get error() {
-    return this.logger.error.bind(this.logger);
-  },
+function defineCoreLoggerProperty() {
+  for (const property of logProperties) {
+    Object.defineProperty(Instance.coreLogger, property, {
+      get() {
+        let log = getCoreLogger();
+        let val = log[property].bind(log);
+        return val;
+      },
+    });
+  }
+}
 
-  get warn() {
-    return this.logger.warn.bind(this.logger);
-  },
+function _delCache() {
+  const now = parseInt(dayjs().format('YYYYMMDD'));
+  if (logDate != now) {
+    logDate = now;
+    Instance.eelog = null;
+  }
+}
 
-  get info() {
-    return this.logger.info.bind(this.logger);
-  },
+function getLogger() {
+  _delCache();
+  if (!Instance.eelog) {
+    loadLog();
+  }
+  
+  return Instance.eelog["logger"];
+}
 
-  get debug() {
-    return this.logger.debug.bind(this.logger);
-  },
-};
+function getCoreLogger() {
+  _delCache();
+  if (!Instance.eelog) {
+    loadLog();
+  }
+  return Instance.eelog["coreLogger"];
+}
 
-module.exports = Log;
+module.exports = {
+  createLog,
+  loadLog,
+  logger: Instance.logger,
+  coreLogger: Instance.coreLogger
+};

package/log/logger.d.ts

@@ -0,0 +1,2 @@
+import { EggLoggers } from "egg-logger";
+export declare function create(config?: {}): EggLoggers;

package/log/logger.js

@@ -1,10 +1,12 @@
+'use strict';
+
+const debug = require('debug')('ee-core:log:logger');
 const Loggers = require('egg-logger').EggLoggers;
-const assert = require('assert');
 const dayjs = require('dayjs');
 const path = require('path');
-const Ps = require('../ps');
-const ConfigCache = require('../config/cache');
-const extend = require('../utils/extend');
+const { extend } = require('../utils/extend');
+const { getConfig } = require('../config');
+const { getLogDir, env, isDev } = require('../ps');
 
 let LogDate = 0;
 const TmpFileName = {
@@ -13,88 +15,81 @@ const TmpFileName = {
   errorLogName: '',
 }
 
-module.exports = {
+// 创建
+function create(config = {}) {
+  let opt = {};
+  
+  if (Object.keys(config).length == 0) {
+    const defaultConfig = {
+      logger: {
+        type: 'application',
+        dir: getLogDir(),
+        env: env(),
+        consoleLevel: 'INFO',
+        disableConsoleAfterReady: !isDev(),
+        coreLogger: {},
+        allowDebugAtProd: false,
+        agentLogName: 'ee-agent.log',
+        rotator: 'day',
+      },
+      customLogger: {}
+    };
+    const sysConfig = getConfig();
+    opt = extend(true, defaultConfig, {
+      logger: sysConfig.logger,
+      customLogger: sysConfig.customLogger || {}
+    });
+  } else {
+    opt.logger = config.logger;
+    opt.customLogger = config.customLogger;
+  }
 
-  /**
-   * 创建
-   */
-  create(config = {}) {
-    let opt = {};
-    
-    if (Object.keys(config).length == 0) {
-      const defaultConfig = {
-        logger: {
-          type: 'application',
-          dir: Ps.getLogDir(),
-          encoding: 'utf8',
-          env: Ps.env(),
-          level: 'INFO',
-          consoleLevel: 'INFO',
-          disableConsoleAfterReady: !Ps.isDev(),
-          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: 'day',
-        },
-        customLogger: {}
-      }
+  if (Object.keys(opt).length == 0) {
+    throw new Error("logger config is null");
+  }
 
-      const sysConfig = ConfigCache.all();
-      opt = extend(true, defaultConfig, {
-        logger: sysConfig.logger,
-        customLogger: sysConfig.customLogger || {}
-      });
-    } else {
-      opt.logger = config.logger;
-      opt.customLogger = config.customLogger;
-    }
-    // console.log('log---------', opt);
+  let rotateType = opt.logger.rotator;
+  if (rotateType == 'day') {
+    opt = _rotateByDay(opt);
+  }
 
-    assert(Object.keys(opt).length != 0, `logger config is null`);
+  debug('[create] opt:%j', opt);
+  const loggers = new Loggers(opt);
 
-    let rotateType = opt.logger.rotator;
-    if (rotateType == 'day') {
-      this._rotateByDay(opt);
-    }
+  return loggers;
+}
+
+/**
+ * 按天分割
+ */
+function _rotateByDay(logOpt) {
+  const now = parseInt(dayjs().format('YYYYMMDD'));
+  if (LogDate != now) {
+    LogDate = now;
 
-    const loggers = new Loggers(opt);
+    // 保存一个临时文件名，防止文件名按日期累加
+    if (TmpFileName.appLogName.length == 0) {
+      TmpFileName.appLogName = logOpt.logger.appLogName;
+    }
+    if (TmpFileName.coreLogName.length == 0) {
+      TmpFileName.coreLogName = logOpt.logger.coreLogName;
+    }
+    if (TmpFileName.errorLogName.length == 0) {
+      TmpFileName.errorLogName = logOpt.logger.errorLogName;
+    }
 
-    return loggers;
-  },
+    const {appLogName, coreLogName, errorLogName} = TmpFileName;
+    const appLogExtname = path.extname(appLogName);
+    const coreLogExtname = path.extname(coreLogName);
+    const errorLogExtname = path.extname(errorLogName);
+    logOpt.logger.appLogName = path.basename(appLogName, appLogExtname) + '-' + now + appLogExtname;
+    logOpt.logger.coreLogName = path.basename(coreLogName, coreLogExtname) + '-' + now + coreLogExtname;
+    logOpt.logger.errorLogName = path.basename(errorLogName, errorLogExtname) + '-' + now + errorLogExtname;
+  }
 
-  /**
-   * 按天分割
-   */
-  _rotateByDay(logOpt) {
-    let now = parseInt(dayjs().format('YYYYMMDD'));
-    if (LogDate != now) {
-      LogDate = now;
+  return logOpt;
+}
 
-      // 保存一个临时文件名，防止文件名按日期累加
-      if (TmpFileName.appLogName.length == 0) {
-        TmpFileName.appLogName = logOpt.logger.appLogName;
-      }
-      if (TmpFileName.coreLogName.length == 0) {
-        TmpFileName.coreLogName = logOpt.logger.coreLogName;
-      }
-      if (TmpFileName.errorLogName.length == 0) {
-        TmpFileName.errorLogName = logOpt.logger.errorLogName;
-      }
-      let appLogName = TmpFileName.appLogName;
-      let coreLogName = TmpFileName.coreLogName;
-      let errorLogName = TmpFileName.errorLogName;
-      let appLogExtname = path.extname(appLogName);
-      let coreLogExtname = path.extname(coreLogName);
-      let errorLogExtname = path.extname(errorLogName);
-      logOpt.logger.appLogName = path.basename(appLogName, appLogExtname) + '-' + now + appLogExtname;
-      logOpt.logger.coreLogName = path.basename(coreLogName, coreLogExtname) + '-' + now + coreLogExtname;
-      logOpt.logger.errorLogName = path.basename(errorLogName, errorLogExtname) + '-' + now + errorLogExtname;
-    }
-  },  
+module.exports = {
+  create
 };

package/message/childMessage.d.ts

@@ -0,0 +1,10 @@
+export declare class ChildMessage {
+    // 向主进程发消息 for ChildJob 实例
+    sendToMain(eventName: string, params?: {}): boolean;
+    // 向主进程发消息 for task 实例
+    send(eventName: string, params: {}, receiver?: string): boolean;
+    // 进程退出
+    exit(code?: number): never;
+    // 发送错误到控制台
+    sendErrorToTerminal(err: any): void;
+}

package/message/childMessage.js

@@ -1,25 +1,20 @@
-const Channel = require('../const/channel');
+'use strict';
+
+const { Receiver, Processes } = require('../const/channel');
 
 class ChildMessage {
-  constructor() {
-    // ...
-  }
 
-  /**
-   * 向主进程发消息 for ChildJob 实例
-   */
+  // Send a message to the main process for ChildJob instance
   sendToMain(eventName, params = {}) {
-    let receiver = Channel.receiver.childJob;
+    const receiver = Receiver.childJob;
     return this.send(eventName, params, receiver);
   }
 
-  /**
-   * 向主进程发消息 for task 实例
-   */
+  // Send a message to the main process for a task instance
   send(eventName, params = {}, receiver) {
-    let eventReceiver = receiver || Channel.receiver.forkProcess;
-    let message = {
-      channel: Channel.process.sendToMain,
+    const eventReceiver = receiver || Receiver.forkProcess;
+    const message = {
+      channel: Processes.sendToMain,
       eventReceiver,
       event: eventName,
       data: params,
@@ -28,26 +23,21 @@ class ChildMessage {
     return process.send(message);
   }
 
-  /**
-   * 进程退出
-   */
   exit(code = 0) {
     return process.exit(code);
   }
 
-  /**
-   * 发送错误到控制台
-   */
   sendErrorToTerminal(err) {
     let errTips = (err && typeof err == 'object') ? err.toString() : '';
-    let message = {
-      channel: Channel.process.showException,
+    errTips += ' Error !!! Please See file ee-core.log or ee-error-xxx.log for details !'
+    const message = {
+      channel: Processes.showException,
       data: errTips
     }
     process.send(message);
   }
 }
 
-
-
-module.exports = ChildMessage;
+module.exports = { 
+  ChildMessage
+};

package/message/index.d.ts

@@ -0,0 +1,3 @@
+import { ChildMessage } from "./childMessage";
+export declare const childMessage: ChildMessage;
+export { ChildMessage };

package/message/index.js

@@ -1,19 +1,10 @@
-const ChildMessage = require('./childMessage');
-const EEChildMessage = Symbol('EeCore#Module#ChildMessage');
+'use strict';
 
-const message = {
+const { ChildMessage } = require('./childMessage');
 
-  /**
-   * childMessage
-   */
-  get childMessage() {
-    if (!this[EEChildMessage]) {
-      this[EEChildMessage] = new ChildMessage();
-    }
+const childMessage = new ChildMessage();
 
-    return this[EEChildMessage] || null;
-  },
-
-};
-
-module.exports = message;
+module.exports = {
+  ChildMessage,
+  childMessage
+};