ee-core 1.1.5 → 1.1.8

package/config/config.default.js

@@ -27,14 +27,6 @@ module.exports = appInfo => {
      */
     name: appInfo.name,
 
-    /**
-     * package.json
-     * @member {Object} Config#pkg
-     * @see {appInfo#pkg}
-     * @since 1.0.0
-     */
-    pkg: appInfo.pkg,
-
     /**
      * The current directory of the application
      * @member {String} Config#baseDir
@@ -97,7 +89,31 @@ module.exports = appInfo => {
      * @default
      * @since 1.0.0
      */
-    appUserDataDir: appInfo.appUserDataDir
+    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
   };
 
   /**
@@ -175,19 +191,11 @@ module.exports = appInfo => {
     },
   };
 
-  /* egg服务 (待定) */
-  config.egg = {
-    enable: false, // 是否启用
-    title: 'ee', // 进程的title属性标识（默认你的应用名称-英文）
-    port: 7068,
-    hostname: '127.0.0.1',
-    workers: 1 // 工作进程数据
-  };
-
-  /* web渲染服务 */
-  config.webServer = {
-    port: 7068
-  };
+  /* 内置socket服务 */
+  config.socketServer = {
+    port: 7070, // 默认端口
+    isDynamic: false // 如果值为false，框架默认使用port端口（如果默认端口被使用，则随机获取一个）；如果为true，默认端口无效，框架随机生成
+  };  
 
   return config;
 };

package/core/lib/ee.js

@@ -88,15 +88,11 @@ class EeCore extends KoaApplication {
      */
     const Loader = this[EE_LOADER];
     assert(Loader, 'Symbol.for(\'ee#loader\') is required');
-    this.loader = new Loader({
-      baseDir: options.baseDir,
-      homeDir: options.homeDir,
+    let loaderOptions = Object.assign({
       logger: this.console,
-      app: this,
-      env: options.env,
-      appUserData: options.appUserData,
-      isPackaged: options.isPackaged
-    });
+      app:this
+    }, options);
+    this.loader = new Loader(loaderOptions);
   }
 
   /**

package/core/lib/loader/ee_loader.js

@@ -147,11 +147,7 @@ class EeLoader {
    */
   getAppInfo() {
     const env = this.serverEnv;
-    const scope = this.serverScope;
-    const home = this.getHomedir();
-    const baseDir = this.options.baseDir;
-    const appUserDataDir = this.options.appUserData;
-
+    
     /**
      * Meta information of the application
      * @class AppInfo
@@ -167,7 +163,7 @@ class EeLoader {
        * The current directory, where the application code is.
        * @member {String} AppInfo#baseDir
        */
-      baseDir,
+      baseDir: this.options.baseDir,
 
       /**
        * The environment of the application, **it's not NODE_ENV**
@@ -186,24 +182,18 @@ class EeLoader {
        * @member {String} AppInfo#env
        * @see https://Eejs.org/zh-cn/basics/env.html
        */
-      env,
+      env: env,
 
       /**
        * @member {String} AppInfo#scope
        */
-      scope,
+      scope: this.serverScope,
 
       /**
        * The use directory, same as `process.env.HOME`
        * @member {String} AppInfo#HOME
        */
-      home: home,
-
-      /**
-       * parsed from `package.json`
-       * @member {Object} AppInfo#pkg
-       */
-      pkg: this.pkg,
+      home: this.getHomedir(),
 
       /**
        * The directory whether is baseDir or HOME depend on env.
@@ -213,9 +203,37 @@ class EeLoader {
        * keep root directory in baseDir when local and unittest
        * @member {String} AppInfo#root
        */
-      root: env === 'local' || env === 'unittest' ? home : appUserDataDir,
+      root: env === 'local' || env === 'unittest' ? this.getHomedir() : this.options.appUserData,
 
-      appUserDataDir: appUserDataDir
+      /**
+       * electron application data dir
+       * @member {String} AppInfo#appUserDataDir
+       */
+      appUserDataDir: this.options.appUserData,
+
+      /**
+       * system user home dir 
+       * @member {String} AppInfo#userHome
+       */
+      userHome: this.options.userHome,
+
+      /**
+       * application version
+       * @member {String} AppInfo#appVersion
+       */
+      appVersion: this.options.appVersion,
+
+      /**
+       * application package status
+       * @member {boolean} AppInfo#isPackaged
+       */      
+      isPackaged: this.options.isPackaged,
+
+      /**
+       * application exec file dir
+       * @member {String} AppInfo#execDir
+       */  
+      execDir: this.options.execDir
     };
   }
 
@@ -409,15 +427,9 @@ class EeLoader {
   }
 
   getPkg() {
-    //let filePath = '';
-    // let variablePath = 'build'; // 打包前路径
-    // if (this.options.isPackaged) {
-    //   variablePath = '..'; // 打包后路径
-    // }
-    // filePath = path.join(app.getAppPath(), variablePath, "package.json");
-
-    const content = utility.readJSONSync(path.join(this.options.homeDir, 'package.json'));
-    return content;
+    const filePath = path.join(this.options.homeDir, 'package.json');
+    const json = utility.readJSONSync(filePath);
+    return json;
   }  
 }
 

package/lib/application.js

@@ -11,8 +11,6 @@ class Appliaction extends EeApp {
     const { env } = process;
 
     // 路径不能使用绝对，打包前后有问题
-    
-
     let options = {
       env: 'prod',
       serverScope: '',
@@ -24,9 +22,10 @@ class Appliaction extends EeApp {
       userHome: app.getPath('home'),
       appData: app.getPath('appData'),
       appUserData: app.getPath('userData'),
-      logsDir: app.getPath('logs'),
+      //logsDir: app.getPath('logs'),
       appVersion: app.getVersion(),
-      isPackaged: app.isPackaged
+      isPackaged: app.isPackaged,
+      execDir: app.getAppPath()
     }
 
     // argv
@@ -37,8 +36,12 @@ class Appliaction extends EeApp {
       }
     }
 
-    // normalize env
+    // exec directory (exe dmg dep) for prod
+    if (options.env == 'prod' && app.isPackaged) {
+      options.execDir = path.dirname(app.getPath('exe'));
+    }
 
+    // normalize env
     env.NODE_ENV = 'production';
     env.EE_HOME = options.homeDir;
     env.EE_SERVER_ENV = options.env;
@@ -47,7 +50,7 @@ class Appliaction extends EeApp {
     env.EE_APP_DATA = options.appData;
     env.EE_APP_USER_DATA = options.appUserData;
     env.EE_WEB_PORT = null;
-    env.EE_IPC_PORT = null;
+    env.EE_SOCKET_PORT = null;
     env.EGG_SERVER_ENV = options.env;
     debug('options:%j', options)
 

package/lib/baseApp.js

@@ -111,38 +111,26 @@ class BaseApp extends EeAppCore {
   /**
    * 调用 egg api
    */
-  async curlEgg (method, uri, params, timeout = 15000) {
-    let result = null;
-    try {
-      const port = this.config.egg.port;
-      const url = "http://127.0.0.1:" + port + uri;
-      // console.log('[ee:baseApp] [curlEgg] url:', url);
-      const response = await this.curl(url, {
-        method: method,
-        contentType: 'application/json',
-        data: params,
-        dataType: 'json',
-        timeout: timeout,
-      });
-      result = response.data;
-    } catch (err) {
-      this.logger.error('[ee:baseApp] [curlEgg] throw error:', err);
-    }
-
-    return result; 
-  }
-
-  /**
-   * @class socket模块
-   * @since 1.0.0
-   */
-  get socket () {
-    const obj = {
-      ipc: {},
-      server: {}
-    }
-    return obj;
-  }
+  // async curlEgg (method, uri, params, timeout = 15000) {
+  //   let result = null;
+  //   try {
+  //     const port = this.config.egg.port;
+  //     const url = "http://127.0.0.1:" + port + uri;
+  //     // console.log('[ee:baseApp] [curlEgg] url:', url);
+  //     const response = await this.curl(url, {
+  //       method: method,
+  //       contentType: 'application/json',
+  //       data: params,
+  //       dataType: 'json',
+  //       timeout: timeout,
+  //     });
+  //     result = response.data;
+  //   } catch (err) {
+  //     this.logger.error('[ee:baseApp] [curlEgg] throw error:', err);
+  //   }
+
+  //   return result; 
+  // }
 
   /**
    * core app have been loaded

package/lib/constant.js

@@ -23,8 +23,7 @@ module.exports = {
   },
   socketIo: {
     channel: {
-      eggIoEe: 'c1',
-      eggIoFrotend: 'c2'
+      partySoftware: 'c1',
     }
   }
 };

package/lib/eeApp.js

@@ -20,16 +20,17 @@ class EeApp extends BaseApp {
    * 生成端口
    */
   async createPorts () {
-    const ipcPort = await getPort();
-    const webPort = this.config.env === 'prod' ? await getPort() : this.config.webServer.port;
-    this.config.webServer.port = webPort;
-    process.env.EE_IPC_PORT = ipcPort;
+    const socketPort = await getPort({port: this.config.socketServer.port});
+    //const webPort = this.config.env === 'prod' ? await getPort() : this.config.webServer.port;
+    const webPort = await getPort();
+    
+    process.env.EE_SOCKET_PORT = socketPort;
     process.env.EE_WEB_PORT = webPort;
-    this.coreLogger.info('[ee-core:EeApp] [createPorts] ipc port:', ipcPort);
+    this.coreLogger.info('[ee-core:EeApp] [createPorts] socket port:', socketPort);
     this.coreLogger.info('[ee-core:EeApp] [createPorts] web port:', webPort);
     
     // 更新db配置
-    this.getCoreDB().setItem('ipc_port', ipcPort);
+    this.config.socketServer.port = socketPort;
     this.getCoreDB().setItem('config', this.config);
   }
 
@@ -78,6 +79,9 @@ class EeApp extends BaseApp {
    * 创建应用主窗口
    */
   async createWindow () {
+
+    await this.electronAppReady();
+
     const winOptions = this.config.windowsOption;
     this.electron.mainWindow = new BrowserWindow(winOptions);
 
@@ -86,15 +90,13 @@ class EeApp extends BaseApp {
       Menu.setApplicationMenu(null);
     }
 
-    this.loadRemoreWeb();
-
     this.loadingView(winOptions);
 
     await this.windowReady();
   
     await this.loderPreload();
 
-    this.loadLocalWeb();
+    this.selectAppType();
 
     // DevTools
     if (!app.isPackaged && this.config.openDevTools) {
@@ -102,38 +104,6 @@ class EeApp extends BaseApp {
     }
   }
 
-  /**
-   * 加载远程网址
-   */
-  loadRemoreWeb () {
-    const remoteConfig = this.config.remoteUrl;
-    if (remoteConfig.enable) {
-      this.loadMainUrl('remote_web', remoteConfig.url);
-    }
-  }
-
-  /**
-   * 加载本地前端资源
-   */
-  loadLocalWeb () {
-    // 如果加载了远程，则不能加载本地的
-    const remoteConfig = this.config.remoteUrl;
-    if (remoteConfig.enable) {
-      return;
-    }
-
-    const self = this;
-    const staticDir = path.join(this.config.homeDir, 'public', 'dist');
-
-    const koaApp = new Koa();	
-    koaApp.use(koaServe(staticDir))
-    const port = process.env.EE_WEB_PORT;
-    koaApp.listen(port, () => {
-      const url = 'http://127.0.0.1:' + port;
-      self.loadMainUrl('local_web', url);
-    });
-  }
-
   /**
    * 加载已经实现的功能
    */
@@ -142,43 +112,10 @@ class EeApp extends BaseApp {
     return await preferences(this);
   }
 
-  /**
-   * 创建egg服务
-   */  
-  // async startEggServer () {
-  //   // egg服务是否开启
-  //   if (this.config.egg.enable == false) {
-  //     return;
-  //   }
-  //   let eggConfig = this.config.egg;
-  //   const protocol = 'http://';
-  //   let startRes = null;
-  //   let url = protocol + eggConfig.hostname + ':' + eggConfig.port;
-
-  //   startRes = await this.startEgg(eggConfig).then((res) => res, (err) => err);
-  //   this.coreLogger.info('[ee-core:EeApp] [startEggServer] startRes:', startRes)
-  //   if (startRes === 'success') {
-  //     // 如果加载远程网址，则不能重复load
-  //     const remoteConfig = this.config.remoteUrl;
-  //     if (remoteConfig.enable) {
-  //       return;
-  //     }
-  //     this.loadMainUrl('egg', url);
-  //   } else {
-  //     // 失败后重启
-  //     app.relaunch();
-  //   }
-  // }
-
   /**
    * 加载loading页面
    */
   loadingView (winOptions) {
-    const remoteConfig = this.config.remoteUrl;
-    if (remoteConfig.enable) {
-      return;
-    }
-
     if (!this.config.loadingPage) {
       return;
     }
@@ -204,55 +141,75 @@ class EeApp extends BaseApp {
   }
 
   /**
-   * 加载主页面
+   * 应用类型 （远程、html、单页应用）
    */
-  loadMainUrl (type, url) {
+  selectAppType () {
+    let type = '';
+    let url = '';
 
-    // 环境模式 (远程模式，不加载dev)
+    // 远程模式
     const remoteConfig = this.config.remoteUrl;
-    if (this.config.env !== 'prod' && remoteConfig.enable == false) {
-      const protocol = 'http://';
-      const developmentModeConfig = this.config.developmentMode;
-      const selectMode = developmentModeConfig.default;
-      const modeInfo = developmentModeConfig.mode[selectMode];
-      url = protocol + modeInfo.hostname + ':' + modeInfo.port;
-      
-      this.coreLogger.info('[ee-core:EeApp] frontend server :', url)
+    if (remoteConfig.enable == true) {
+      type = 'remote_web';
+      url = remoteConfig.url;
+      this.loadMainUrl(type, url);
+      return;
     }
 
-    this.logger.info('main page is env: %s, type: %s, url: %s', this.config.env, type, url);
-    this.electron.mainWindow.loadURL(url);
+    const protocol = 'http://';
+    const developmentModeConfig = this.config.developmentMode;
+    const selectMode = developmentModeConfig.default;
+    const modeInfo = developmentModeConfig.mode[selectMode];
+    let staticDir = null;
+
+    // html模式
+    if (selectMode == 'html') {
+      if (this.config.env !== 'prod') {
+        staticDir = path.join(this.config.homeDir, 'frontend', 'dist');
+      }
+      this.loadLocalWeb('html', staticDir, modeInfo);
+      return;
+    }
+
+    // 单页应用
+    url = protocol + modeInfo.hostname + ':' + modeInfo.port;
+    if (this.config.env !== 'prod') {
+      this.loadMainUrl('spa', url);
+    } else {
+      this.loadLocalWeb('spa');
+    }
   }
 
   /**
-   * egg
+   * 加载本地前端资源
    */
-  // startEgg (argv) {
-    
-  //   let homeDir = this.homeDir;
-  //   argv.baseDir = homeDir;
-  //   argv.framework = path.join(homeDir, 'node_modules', 'egg');
-
-  //   const appName = this.config.name;
-  //   argv.title = argv.title || `egg-server-${appName}`;
+  loadLocalWeb (mode, staticDir, hostInfo) {
+    const self = this;
+    if (!staticDir) {
+      staticDir = path.join(this.config.homeDir, 'public', 'dist')
+    }
 
+    const koaApp = new Koa();	
+    koaApp.use(koaServe(staticDir))
+    const port = process.env.EE_WEB_PORT;
+    let url = 'http://127.0.0.1:' + port;
+    if (mode == 'html') {
+      url += '/' + hostInfo.indexPage;
+    }
 
-  //   // normalize env
-  //   // 目前没有用到，不用修改；想要修改的话，区分打包前后的路径？
-  //   // env.HOME = HOME; // 这个home不能修改，因为自动升级功能会用到（win没有问题，mac有权限问题）
-  //   //env.NODE_ENV = 'production';
+    koaApp.listen(port, () => {
+      self.loadMainUrl(mode, url);
+    });
+  }
 
-  //   // 更新缓存配置  
-  //   this.getCoreDB().setItem('config', this.config);
+  /**
+   * 主页面
+   */
+  loadMainUrl (type, url) {
+    this.logger.info('main page is env: %s, type: %s, url: %s', this.config.env, type, url);
+    this.electron.mainWindow.loadURL(url);
+  }  
 
-  //   const ignoreKeys = [ '_', '$0', 'env', 'daemon', 'stdout', 'stderr', 'timeout', 'ignore-stderr', 'node' ];
-  //   const clusterOptions = this.stringify(argv, ignoreKeys);
-  //   const options = JSON.parse(clusterOptions);
-  //   this.coreLogger.info('[ee-core:EeApp] [startEgg] options', options);
-  //   if (is.function(this.startEggCluster)) {
-  //     return this.startEggCluster(options);
-  //   }
-  // }
 
   /**
    * 限制一个窗口
@@ -269,7 +226,17 @@ class EeApp extends BaseApp {
    */  
   async appQuit () {
     await this.beforeClose();
+    
+    // 窗口销毁
     this.electron.mainWindow.destroy();
+
+    //console.log('Exit now!');
+    // 托盘销毁
+    // if (this.electron.tray) {
+    //   console.log('ssssssssssss');
+    //   this.electron.tray.destroy();
+    // }
+
     app.quit();
   }
 
@@ -308,6 +275,20 @@ class EeApp extends BaseApp {
     process.on('uncaughtException', function(err) {
       self.logger.error(err);
     });
+    
+    // process.on('SIGINT', function () {
+    //   console.log('Exit now!');
+    //   self.appQuit();
+    //   process.exit();
+    // });
+  }
+
+  /**
+   * electron app已经准备好，主窗口还未创建
+   */
+  async electronAppReady () {
+    // do some things
+
   }
 
   /**

package/lib/socket/socketClient.js

@@ -8,7 +8,7 @@ const EggConsoleLogger = require('egg-logger').EggConsoleLogger;
 class SocketClient {
   constructor (port) {
     this.consoleLogger = new EggConsoleLogger();
-    port = port ? port : this.getIpcPort();
+    port = port ? parseInt(port) : this.getSocketcPort();
 
     assert(typeof port === 'number', 'port required, and must be a number');
     this.consoleLogger.info('[ee-core:socket:client] start client');
@@ -29,7 +29,7 @@ class SocketClient {
   call (method = '', ...params) {
     return new Promise((resolve, reject) => {
       // 获取通信频道
-      const channel = constant.socketIo.channel.eggIoEe;
+      const channel = constant.socketIo.channel.partySoftware;
       this.client.emit(channel, { cmd: method, params: params }, (response) => {
         resolve(response);
       });
@@ -41,10 +41,10 @@ class SocketClient {
     return coreDB;
   }
 
-  getIpcPort () {
+  getSocketcPort () {
     const cdb = this.getCoreDB();
-    const port = cdb.getItem('ipc_port');
-    return port;
+    const port = cdb.getItem('config').socketServer.port;
+    return parseInt(port);
   }
 }
 

package/lib/socket/socketServer.js

@@ -11,7 +11,7 @@ const is = require('is-type-of');
  */
 class SocketServer {
   constructor (app) {
-    let port = process.env.EE_IPC_PORT ? parseInt(process.env.EE_IPC_PORT) : parseInt(this.getIpcPort());
+    let port = process.env.EE_SOCKET_PORT ? parseInt(process.env.EE_SOCKET_PORT) : parseInt(this.getSocketcPort());
 
     assert(typeof port === 'number', 'port required, and must be a number');
 
@@ -23,11 +23,12 @@ class SocketServer {
   }
 
   connec () {
+    const self = this;
     this.consoleLogger.info('[ee-core:socket:server] connection .....');
     this.io.on('connection', (socket) => {
-      const channel = constant.socketIo.channel.eggIoEe;
+      const channel = constant.socketIo.channel.partySoftware;
       socket.on(channel, async (message, callback) => {
-        this.consoleLogger.info('[ee-core:socket:server] socket id:' + socket.id + ' message cmd: ' + message.cmd);
+        self.consoleLogger.info('[ee-core:socket:server] socket id:' + socket.id + ' message cmd: ' + message.cmd);
 
         try {
           // 找函数
@@ -36,7 +37,7 @@ class SocketServer {
           let fn = null;
           if (is.string(cmd)) {
             const actions = cmd.split('.');
-            let obj = this.app;
+            let obj = self.app;
             actions.forEach(key => {
               obj = obj[key];
               if (!obj) throw new Error(`class or function '${key}' not exists`);
@@ -45,12 +46,11 @@ class SocketServer {
           }
           if (!fn) throw new Error('function not exists');
 
-          const result = await fn.call(this.app, args);
+          const result = await fn.call(self.app, args);
           callback(result);
         } catch (err) {
-          this.app.logger.error('[ee:socket] throw error:', err);
+          self.app.logger.error('[ee:socket] throw error:', err);
         }
- 
       });
     });
   }
@@ -60,9 +60,9 @@ class SocketServer {
     return coreDB;
   }
 
-  getIpcPort () {
+  getSocketcPort () {
     const cdb = this.getCoreDB();
-    const port = cdb.getItem('ipc_port');
+    const port = cdb.getItem('config').socketServer.port;
     return port;
   }
 }

package/lib/socket/start.js

@@ -11,7 +11,7 @@ const ipcServer = require('./ipcServer');
   // 启动 socket server
   new socketServer(app);
 
-  // 启动 ipc server
+  // 启动 electron ipc server
   new ipcServer(app);
 
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ee-core",
-  "version": "1.1.5",
+  "version": "1.1.8",
   "description": "ee core",
   "main": "index.js",
   "scripts": {
@@ -13,6 +13,7 @@
   },
   "dependencies": {
     "agentkeepalive": "^4.2.0",
+    "co": "^4.6.0",
     "egg-errors": "^2.3.0",
     "egg-logger": "^2.7.1",
     "electron-is": "^3.0.0",

package/tools/replaceDist.js

@@ -47,6 +47,11 @@ const fsPro = require('fs-extra');
     
     // 复制到ee资源目录
     const eeResourceDir = path.join(homeDir, 'public', 'dist');
+
+    // 清空历史资源
+    fs.rmdirSync(eeResourceDir, {recursive: true});
+    console.log('[ee-core] [replace_dist] 清空历史资源:', eeResourceDir);
+
     fsPro.copySync(sourceDir, eeResourceDir);
     console.log('[ee-core] [replace_dist] 复制资源到:', eeResourceDir);
 

package/utils/index.js

@@ -6,6 +6,7 @@ const constant = require('../lib/constant');
 const convert = require('koa-convert');
 const is = require('is-type-of');
 const co = require('co');
+const utility = require('utility');
 
 exports.mkdir = function(dirpath, dirname) {
   // 判断是否是第一次调用
@@ -52,8 +53,7 @@ exports.chmodPath = function(path, mode) {
 exports.getPackage = function() {
   const cdb = this.getCoreDB();
   const config = cdb.getItem('config');
-  const filePath = path.join(config.homeDir, 'package.json');
-  const json = require(filePath);
+  const json = utility.readJSONSync(path.join(config.homeDir, 'package.json'));
   
   return json;
 };
@@ -118,16 +118,16 @@ exports.getLogDir = function() {
 /**
  * 获取 socketio port
  */
-exports.getIpcPort = function() {
+exports.getSocketPort = function() {
   const cdb = this.getCoreDB();
-  const port = cdb.getItem('ipc_port');
-  return port;
+  const port = cdb.getItem('config').socketServer.port;
+  return parseInt(port);
 }
 
 /**
- * 获取 ipc channel
+ * 获取 socket channel
  */
-exports.getIpcChannel = function() {
+exports.getSocketChannel = function() {
   return constant.socketIo.channel;
 }