ee-core 2.0.0-beta.3 → 2.0.0-beta.6

package/{module/utils → oldUtils}/index.js

@@ -1,14 +1,27 @@
+/**
+ * 该模块不在增加新功能，请使用 /module/utils/index 模块
+ */
+
 const path = require('path');
+const UtilsJson = require('../utils/json');
+const UtilsPs = require('../ps');
+const UtilsHelper = require('../utils/helper');
+const Copy = require('../utils/copyto');
 const Storage = require('../storage');
 const Constants = require('../const');
-const Ps = require('./ps');
-const UtilsJson = require('./json');
+
+/**
+ * other module
+ */
+Copy(UtilsPs)
+.and(UtilsHelper)
+.to(exports);
 
 /**
  * 获取项目根目录package.json
  */
 exports.getPackage = function() {
-  const json = UtilsJson.readSync(path.join(Ps.getHomeDir(), 'package.json'));
+  const json = UtilsJson.readSync(path.join(this.getHomeDir(), 'package.json'));
   
   return json;
 };
@@ -76,11 +89,18 @@ exports.getSocketServerConfig = function() {
   return cfg;
 }
 
+/**
+ * 获取 socketio port
+ */
+exports.getSocketPort = function() {
+  const cdb = this.getCoreDB();
+  const port = cdb.getItem('config').socketServer.port;
+  return parseInt(port);
+}
+
 /**
  * 获取 socket channel
  */
 exports.getSocketChannel = function() {
   return Constants.socketIo.channel;
 }
-
-

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ee-core",
-  "version": "2.0.0-beta.3",
+  "version": "2.0.0-beta.6",
   "description": "ee core",
   "main": "index.js",
   "scripts": {
@@ -36,6 +36,7 @@
     "lodash": "^4.17.21",
     "mkdirp": "^2.1.3",
     "path-to-regexp": "^6.2.0",
+    "serialize-javascript": "^6.0.1",
     "socket.io": "^4.4.1",
     "socket.io-client": "^4.4.1",
     "urllib": "^2.38.0"

package/{module/utils/ps.js → ps/index.js}

@@ -20,6 +20,13 @@ exports.env = function() {
  */
 exports.getEnv = this.env
 
+/**
+ * 是否生产环境
+ */
+exports.isProd = function() {
+  return (process.env.EE_SERVER_ENV === 'prod');
+}
+
 /**
  * 是否为开发环境
  */
@@ -182,21 +189,21 @@ exports.getUserHomeDir = function () {
  * 获取主进程端口
  */
 exports.getMainPort = function () {
-  return process.env.EE_MAIN_PORT;
+  return parseInt(process.env.EE_MAIN_PORT) || 0;
 }
 
 /**
  * 获取内置socket端口
  */
 exports.getSocketPort = function () {
-  return process.env.EE_SOCKET_PORT;
+  return parseInt(process.env.EE_SOCKET_PORT) || 0;
 }
 
 /**
  * 获取内置http端口
  */
 exports.getHttpPort = function () {
-  return process.env.EE_HTTP_PORT;
+  return parseInt(process.env.EE_HTTP_PORT) || 0;
 }
 
 /**
@@ -218,4 +225,24 @@ exports.isEncrypted = function () {
  */
 exports.isHotReload = function () {
   return process.env.HOT_RELOAD === 'true';
+}
+
+/**
+ * 进程退出
+ */
+exports.exit = function(code = 0) {
+  return process.exit(code);
+}
+
+/**
+ * 格式化message
+ */
+exports.makeMessage = function(msg = {}) {
+  let message = Object.assign({
+    channel: '',
+    event: '', 
+    data: {}
+  }, msg);
+
+  return message;
 }

package/service/index.js

@@ -0,0 +1,34 @@
+'use strict';
+
+/**
+ * BaseContextClass is a base class that can be extended,
+ * it's instantiated in context level,
+ * {@link Helper}, {@link Service} is extending it.
+ */
+class BaseContextClass {
+
+  /**
+   * @class
+   * @param {Context} ctx - context instance
+   * @since 1.0.0
+   */
+  constructor(ctx) {
+    /**
+     * @member {Application} BaseContextClass#app
+     * @since 1.0.0
+     */
+    this.app = ctx;
+    /**
+     * @member {Config} BaseContextClass#config
+     * @since 1.0.0
+     */
+    this.config = ctx.config;
+    /**
+     * @member {Service} BaseContextClass#service
+     * @since 1.0.0
+     */
+    this.service = ctx.service;
+  }
+}
+
+module.exports = BaseContextClass;

package/{module/socket → socket}/httpServer.js

@@ -10,6 +10,7 @@ const fs = require('fs');
 const path = require('path');
 const _ = require('lodash');
 const Log = require('../log');
+const Ps = require('../ps');
 
 /**
  * http server
@@ -19,12 +20,14 @@ class HttpServer {
     this.app = app;
     this.options = this.app.config.httpServer;
 
-    if (!this.options.enable) {
+    if (this.options.enable == false) {
       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');
+    let port = Ps.getHttpPort();
+    if (!port) {
+      throw new Error('[ee-core] [socket/HttpServer] http port required, and must be a number !');
+    }
 
     this.create();
   }
@@ -33,15 +36,15 @@ class HttpServer {
    * 创建服务
    */
   create () {
-    const self = this;
+    const app = this.app;
     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);
+      const keyFile = path.join(app.config.homeDir, httpServer.https.key);
+      const certFile = path.join(app.config.homeDir, httpServer.https.cert);
       assert(fs.existsSync(keyFile), 'ssl key file is required');
       assert(fs.existsSync(certFile), 'ssl cert file is required');
 
@@ -56,12 +59,12 @@ class HttpServer {
       .use(cors(corsOptions))
       .use(koaBody(httpServer.body))
       .use(async (ctx, next) => {
-        ctx.eeApp = self.app;
+        ctx.eeApp = app;
         await next();
       })
       .use(this.dispatch);
 
-    let msg = '[ee-core] [module/socket/httpServer] server is: ' + url;
+    let msg = '[ee-core] [socket/http] server is: ' + url;
     if (isHttps) {
       https.createServer(sslOptions, koaApp.callback()).listen(httpServer.port, (err) => {
         msg = err ? err : msg;
@@ -125,20 +128,11 @@ class HttpServer {
       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);
+      Log.coreLogger.error('[ee-core/httpServer] throw error:', err);
     }
 
     await next();
   }
-
-  /**
-   * 获取http端口
-   */  
-  getHttpPort () {
-    const cdb = this.getCoreDB();
-    const port = cdb.getItem('config').httpServer.port;
-    return parseInt(port);
-  } 
 }
 
 module.exports = HttpServer;

package/socket/index.js

@@ -0,0 +1,82 @@
+'use strict';
+
+const IoServer = require('socket.io');
+const IoClient = require('socket.io-client');
+const Koa = require('koa');
+const EESocketServer = Symbol('Ee#SocketServer');
+const EEIpcServer = Symbol('Ee#IpcServer');
+const EEHttpServer = Symbol('Ee#HttpServer');
+
+const EeSocket = {
+
+  /**
+   * 提供基础库 - 避免用户重复安装
+   */
+  Koa,
+  IoServer,
+  IoClient,
+
+  /**
+   * 启动所有服务
+   */ 
+  startAll(app) {
+    this._createSocketServer(app);
+    this._createHttpServer(app);
+    this._createIpcServer(app);
+  },
+
+  /**
+   * 创建SocketServer
+   */ 
+  _createSocketServer(app) {
+    const SocketServer = require('./socketServer');
+    this[EESocketServer] = new SocketServer(app);
+
+    return this[EESocketServer];
+  },
+
+  /**
+   * 获取 Socket Server
+   */
+  getSocketServer() {
+    return this[EESocketServer] || null;
+  },  
+
+  /**
+   * 创建 Http Server
+   */ 
+  _createHttpServer(app) {
+    const HttpServer = require('./httpServer');
+    this[EEHttpServer] = new HttpServer(app);
+
+    return this[EEHttpServer];
+  },
+
+  /**
+   * 获取 Http Server
+   */
+  getHttpServer() {
+    return this[EEHttpServer] || null;
+  }, 
+
+  /**
+   * 创建 IPC Server
+   */ 
+  _createIpcServer(app) {
+    const IpcServer = require('./ipcServer');
+    this[EEIpcServer] = new IpcServer(app);
+
+    return this[EEIpcServer];
+  },
+
+  /**
+   * 获取 IPC Server
+   */
+  getIpcServer() {
+    return this[EEIpcServer] || null;
+  },   
+
+}
+
+
+module.exports = EeSocket;

package/{module/socket → socket}/io.js

@@ -1,9 +1,13 @@
 'use strict';
 
+/**
+ * 该文件将废弃
+ */
+
 const IoServer = require('socket.io');
 const IoClient = require('socket.io-client');
 //const socketServer = require('./socketServer');
-const socketClient = require('./socketClient');
+// const socketClient = require('./socketClient');
 const Koa = require('koa');
 
 const EeSocket = {
@@ -11,7 +15,7 @@ const EeSocket = {
     //return socketServer.getInstance();
   },
   getClient: () => {
-    return socketClient.getInstance();
+    //return socketClient.getInstance();
   }
 }
 

package/{module/socket → socket}/ipcServer.js

@@ -4,7 +4,7 @@ const { ipcMain } = require('electron');
 const path = require('path');
 const fs = require('fs');
 const globby = require('globby');
-const Utils = require('../../core/lib/utils');
+const Utils = require('../core/lib/utils');
 const Wrap = require('../utils/wrap');
 const Log = require('../log');
 
@@ -15,8 +15,6 @@ class IpcServer {
   }
 
   register () {
-    console.log('[ee-core] [module/socket/IpcServer] register channels');
-
     const self = this;
     // 遍历方法
     const files = Utils.filePatterns();
@@ -75,7 +73,7 @@ class IpcServer {
             
             return fn;
           } catch (err) {
-            Log.coreLogger.error('[ee-core] [module/socket/IpcServer] throw error:', err);
+            Log.coreLogger.error('[ee-core] [socket/IpcServer] throw error:', err);
           }
           return null;
         }

package/socket/socketServer.js

@@ -0,0 +1,66 @@
+'use strict';
+
+const { Server } = require('socket.io');
+const is = require('is-type-of');
+const Log = require('../log');
+const Conf = require('../config');
+const Ps = require('../ps');
+const Channel = require('../const/channel');
+
+/**
+ * socket server
+ */
+class SocketServer {
+  constructor (app) {
+    this.app = app;
+    const options = Conf.getValue('socketServer');
+
+    if (options.enable == false) {
+      return;
+    }
+
+    let port = Ps.getSocketPort();
+    if (!port) {
+      throw new Error('[ee-core] [socket/socketServer] socekt port required, and must be a number !');
+    }
+
+    Log.coreLogger.info('[ee-core] [socket/socketServer] port is:', port);
+
+    this.io = new Server(port, options);
+    this.connec();
+  }
+
+  connec () {
+    const app = this.app;
+    this.io.on('connection', (socket) => {
+      const channel = Channel.socketIo.partySoftware;
+      socket.on(channel, async (message, callback) => {
+        Log.coreLogger.info('[ee-core] [socket/socketServer] socket id:' + socket.id + ' message cmd: ' + message.cmd);
+
+        try {
+          // 找函数
+          const cmd = message.cmd;
+          const args = message.params;
+          let fn = null;
+          if (is.string(cmd)) {
+            const actions = cmd.split('.');
+            let obj = app;
+            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(app, args);
+          callback(result);
+        } catch (err) {
+          Log.coreLogger.error('[ee-core] [socket/socketServer] throw error:', err);
+        }
+      });
+    });
+  }
+}
+
+module.exports = SocketServer;

package/{module/storage → storage}/jsondbStorage.js

@@ -6,7 +6,7 @@ const FileSync = require('./jsondb/adapters/FileSync');
 const _ = require('lodash');
 const Constants = require('../const');
 const Helper = require('../utils/helper');
-const Ps = require('../utils/ps');
+const Ps = require('../ps');
 
 class JsondbStorage {
   constructor (name, opt = {}) {
@@ -90,6 +90,43 @@ class JsondbStorage {
       .get(keyId)
       .value();
   
+    return data;
+  }
+
+  /**
+   * 设置config对象key属性的值
+   */
+  setConfigItem (key, value) {
+    assert(_.isString(key), `key must be a string`);
+    assert(key.length != 0, `key cannot be empty`);
+    assert(!this.storageKey.hasOwnProperty(key), `${key} is not allowed`);
+
+    let cacheKey = this.storageKey.cacheConfig;
+    if (!this.db.has(cacheKey).value()) {
+      this.db.set(cacheKey, {}).write();
+    }
+
+    let keyId = cacheKey + "." + key; 
+    this.db
+      .set(keyId, value)
+      .write();
+  
+    return true;
+  }
+  
+  /**
+   * 获取config对象key属性的值
+   */
+  getConfigItem (key) {
+    assert(_.isString(key), `key must be a string`);
+    assert(key.length != 0, `key cannot be empty`);
+
+    let cacheKey = this.storageKey.cacheConfig;
+    let keyId = cacheKey + "." + key; 
+    const data = this.db
+      .get(keyId)
+      .value();
+  
     return data;
   }   
 }

package/{module/storage → storage}/sqliteStorage.js

@@ -5,7 +5,7 @@ const fs = require('fs');
 const path = require('path');
 const Database = require('better-sqlite3');
 const Helper = require('../utils/helper');
-const Ps = require('../utils/ps');
+const Ps = require('../ps');
 
 class SqliteStorage {
   constructor (name, opt = {}) {

package/tools/encrypt.js

@@ -7,7 +7,7 @@ const is = require('is-type-of');
 const bytenode = require('bytenode');
 const crypto = require('crypto');
 const JavaScriptObfuscator = require('javascript-obfuscator');
-const UtilsJson = require('../module/utils/json');
+const UtilsJson = require('../utils/json');
 
 class Encrypt {
   constructor() {

package/{module/utils → utils}/helper.js

@@ -1,5 +1,4 @@
 const fs = require('fs');
-const path = require('path');
 const mkdirp = require('mkdirp');
 const convert = require('koa-convert');
 const is = require('is-type-of');

package/utils/index.js

@@ -1,27 +1,14 @@
-/**
- * 该模块不在增加新功能，请使用 /module/utils/index 模块
- */
-
 const path = require('path');
-const UtilsJson = require('../module/utils/json');
-const UtilsPs = require('../module/utils/ps');
-const UtilsHelper = require('../module/utils/helper');
-const Copy = require('../module/utils/copyto');
-const Storage = require('../module/storage');
-const Constants = require('../module/const');
-
-/**
- * other module
- */
-Copy(UtilsPs)
-.and(UtilsHelper)
-.to(exports);
+const Storage = require('../storage');
+const Constants = require('../const');
+const Ps = require('../ps');
+const UtilsJson = require('./json');
 
 /**
  * 获取项目根目录package.json
  */
 exports.getPackage = function() {
-  const json = UtilsJson.readSync(path.join(this.getHomeDir(), 'package.json'));
+  const json = UtilsJson.readSync(path.join(Ps.getHomeDir(), 'package.json'));
   
   return json;
 };
@@ -89,18 +76,11 @@ exports.getSocketServerConfig = function() {
   return cfg;
 }
 
-/**
- * 获取 socketio port
- */
-exports.getSocketPort = function() {
-  const cdb = this.getCoreDB();
-  const port = cdb.getItem('config').socketServer.port;
-  return parseInt(port);
-}
-
 /**
  * 获取 socket channel
  */
 exports.getSocketChannel = function() {
   return Constants.socketIo.channel;
 }
+
+

package/module/exception/index.js

@@ -1,16 +0,0 @@
-const Log = require('../log');
-
-/**
- * 捕获异常
- */
-exports.start = function() {
-  process.on('uncaughtException', this.uncaughtExceptionHandler);
-}
-
-exports.uncaughtExceptionHandler = function(err) {
-  if (!(err instanceof Error)) {
-    err = new Error(String(err));
-  }
- 
-  Log.coreLogger.error(err);
-}

package/module/jobs/child/app.js

@@ -1,43 +0,0 @@
-
-const Exception = require('ee-core/module/exception');
-Exception.start();
-const Loader = require('ee-core/module/loader');
-const Log = require('ee-core/module/log');
-
-class ChildApp {
-  constructor() {
-    this._initEvents();
-  }
-
-  /**
-   * 初始化事件监听
-   */
-  _initEvents() {
-    Log.info('[ee-core] [child-process] init Events');
-
-    process.on('disconnect', () => {
-      Log.coreLogger.info(`[ee-core] [module/message/childMessage] child process disconnected:${process.pid} !`);
-    });
-    process.on('exit', () => {
-      Log.coreLogger.info(`[ee-core] [module/message/childMessage] child process exited:${process.pid} !`);
-    });
-    process.on('message', this._handleMessage.bind(this));
-  }
-
-  /**
-   * 监听消息
-   */
-  _handleMessage(message) {
-    Log.coreLogger.info(`[ee-core] [module/message/childMessage] Received a message ${message} from the mainProcess`);
-
-    this.run(message);
-  }
-
-  run(msg = {}) {
-    Log.coreLogger.info('[ee-core] [child-process] run');
-
-    Loader.loadJobFile(msg.jobPath, msg.params);
-  }
-}
-
-new ChildApp();