ee-core 2.12.0 → 4.0.0

package/electron/index.d.ts

@@ -0,0 +1,3 @@
+import { getMainWindow, setCloseAndQuit, getCloseAndQuit } from "./window";
+export declare function loadElectron(): void;
+export { getMainWindow, setCloseAndQuit, getCloseAndQuit };

package/electron/index.js

@@ -1,20 +1,16 @@
-const Window = require('./window');
+'use strict';
 
-const Electron = {
+const { createElectron } = require("./app");
+const { getMainWindow, setCloseAndQuit, getCloseAndQuit } = require("./window");
 
-  /**
-   * 兼容1.x版本api
-   */
-  get mainWindow() {
-    return Window.getMainWindow();
-  },
+// load socket server
+function loadElectron() {
+  createElectron();
+}
 
-  /**
-   * extra
-   */
-  extra: {
-    closeWindow: false,
-  }, 
-};
-
-module.exports = Electron;
+module.exports = {
+  loadElectron,
+  getMainWindow,
+  setCloseAndQuit,
+  getCloseAndQuit
+};

package/electron/window/index.d.ts

@@ -0,0 +1,6 @@
+export declare function getMainWindow(): any;
+export declare function createMainWindow(): any;
+export declare function restoreMainWindow(): void;
+export declare function setCloseAndQuit(flag: any): void;
+export declare function getCloseAndQuit(): boolean;
+export declare function loadServer(): Promise<void>;

package/electron/window/index.js

@@ -1,74 +1,269 @@
+'use strict';
+
+const debug = require('debug')('ee-core:electron:window');
 const is = require('is-type-of');
-const { BrowserWindow, Menu } = require('electron');
-const Conf = require('../../config/cache');
-const Ps = require('../../ps');
-const EEMainWindow = Symbol('Ee#electron#mainWindow');
-
-const Window = {
-
-  /**
-   * 获取 mainWindow
-   */
-  getMainWindow() {
-    if (!this[EEMainWindow]) {
-      this[EEMainWindow] = this.createMainWindow();
-    }
+const path = require('path');
+const axios = require('axios');
+const { BrowserWindow } = require('electron');
+const { getConfig } = require('../../config');
+const { eventBus, WindowReady } = require('../../app/events');
+const { env, isDev, getBaseDir } = require('../../ps');
+const { loadFile } = require('../../loader');
+const { isFileProtocol } = require('../../utils');
+const { getHtmlFilepath } = require('../../html');
+const { fileIsExist, sleep } = require('../../utils/helper');
+const { coreLogger } = require('../../log');
+const { extend } = require('../../utils/extend');
+const { cross } = require('../../cross');
+
+const Instance = {
+  mainWindow: null,
+  closeAndQuit: true,
+};
+
+// getMainWindow
+function getMainWindow() {
+  return Instance.mainWindow;
+}
+
+// Create the main application window
+function createMainWindow() {
+  const { openDevTools, windowsOption } = getConfig();
+  const win = new BrowserWindow(windowsOption);
+  Instance.mainWindow = win;
 
-    return this[EEMainWindow] || null;
-  },
-
-  /**
-   * 创建应用主窗口
-   */
-  createMainWindow() {
-
-    // todo
-    // const protocolName = 'eefile';
-    // protocol.registerFileProtocol(protocolName, (request, callback) => {
-    //   const url = request.url.substring(protocolName.length + 3);
-    //   console.log('[ee-core] [lib/eeApp] registerFileProtocol ----url: ', url);
-    //   callback({ path: path.normalize(decodeURIComponent(url)) })
-    // });
-
-    const config = Conf.all();
-    const win = new BrowserWindow(config.windowsOption);
-    this[EEMainWindow] = win;
-
-    // 菜单显示/隐藏
-    if (config.openAppMenu === 'dev-show' && Ps.isProd()) {
-      Menu.setApplicationMenu(null);
-    } else if (config.openAppMenu === false) {
-      Menu.setApplicationMenu(null);
-    } else {
-      // nothing 
+  // DevTools
+  if (is.object(openDevTools)) {
+    win.webContents.openDevTools(openDevTools);
+  } else if (openDevTools === true) {
+    win.webContents.openDevTools({
+      mode: 'bottom'
+    });
+  }
+  
+  eventBus.emitLifecycle(WindowReady);
+  return win;
+}
+
+// restored window
+function restoreMainWindow() {
+  if (Instance.mainWindow) {
+    if (Instance.mainWindow.isMinimized()) {
+      Instance.mainWindow.restore();
     }
+    Instance.mainWindow.show();
+    Instance.mainWindow.focus();
+  }
+}
 
-    // DevTools
-    if (is.object(config.openDevTools)) {
-      win.webContents.openDevTools(config.openDevTools);
-    } else if (config.openDevTools === true) {
-      win.webContents.openDevTools({
-        mode: 'undocked'
-      });
-    } else {
-      //
+// Set the flag for exiting after close all windows
+function setCloseAndQuit(flag) {
+  Instance.closeAndQuit = flag;
+}
+
+function getCloseAndQuit() {
+  return Instance.closeAndQuit;
+}
+
+// load server 
+// type: remote | single
+async function loadServer() {
+  let type = 'spa';
+  let url = '';
+  const { remote, mainServer } = getConfig();
+  const win = getMainWindow();
+
+  // remote model
+  if (remote.enable == true) {
+    type = 'remote';
+    url = remote.url;
+    loadMainUrl(type, url);
+    return;
+  }
+
+  // 开发环境
+  if (isDev()) {
+    let url;
+    let load = 'url';
+
+    const binFile = path.join(getBaseDir(), "./cmd/bin.js");
+    const binConfig = loadFile(binFile);
+    const { dev } = binConfig;
+    // tips: match with ee-bin
+    const frontendConf = extend(true, {
+      protocol: 'http://',
+      hostname: 'localhost',
+      port: 8080,
+      indexPath: 'index.html',
+    }, dev.frontend);
+    const electronConf = extend(true, {
+      loadingPage: '/public/html/loading.html',
+    }, dev.electron);
+
+    url = frontendConf.protocol + frontendConf.hostname + ':' + frontendConf.port;
+    if (isFileProtocol(frontendConf.protocol)) {
+      url = path.join(getBaseDir(), frontendConf.directory, frontendConf.indexPath);
+      load = 'file';
     }
-    
-    return win;
-  },
-
-  /**
-   * 还原窗口
-   */
-  restoreMainWindow() {
-    if (this[EEMainWindow]) {
-      if (this[EEMainWindow].isMinimized()) {
-        this[EEMainWindow].restore();
+
+    // Check if UI serve is started, load a boot page first
+    if (load == 'url') {
+      // loading page
+      let lp = getHtmlFilepath('boot.html');
+      if (electronConf.hasOwnProperty('loadingPage') && electronConf.loadingPage != '') {
+        lp = path.join(getBaseDir(), electronConf.loadingPage);
+      }
+      _loadingPage(lp);
+
+      // check frontend is ready
+      const retryTimes = frontendConf.force === true ? 3 : 60;
+      let count = 0;
+      let frontendReady = false;
+      while(!frontendReady && count < retryTimes){
+        await sleep(1 * 1000);
+        try {
+          await axios({
+            method: 'get',
+            url,
+            timeout: 1000,
+            proxy: false,
+            headers: { 
+              'Accept': 'text/html, application/json, text/plain, */*',
+            },
+            //responseType: 'text',
+          });
+          frontendReady = true;
+        } catch(err) {
+          // console.warn(err.stack)
+        }
+        count++;
+      }
+      debug('it takes %d seconds to start the frontend', count);
+
+      if (frontendReady == false && frontendConf.force !== true) {
+        const bootFailurePage = getHtmlFilepath('failure.html');
+        win.loadFile(bootFailurePage);
+        coreLogger.error(`[ee-core] Please check the ${url} !`);
+        return;
       }
-      this[EEMainWindow].show();
-      this[EEMainWindow].focus();
     }
+
+    loadMainUrl(type, url, load);
+    return;
   }
-};
 
-module.exports = Window;
+  // 生产环境
+  // cross takeover web
+  if (mainServer.takeover.length > 0) {
+    await crossTakeover()
+    return
+  }
+
+  // 主进程
+  url = path.join(getBaseDir(), mainServer.indexPath);
+  loadMainUrl(type, url, 'file');
+}
+
+/**
+ * 主服务
+ * @params load <string> value: "url" 、 "file"
+ */
+function loadMainUrl(type, url, load = 'url') {
+  const { mainServer } = getConfig();
+  const mainWindow = getMainWindow();
+  coreLogger.info('[ee-core] Env: %s, Type: %s', env(), type);
+  coreLogger.info('[ee-core] App running at: %s', url);
+  if (load ==  'file')  {
+    mainWindow.loadFile(url, mainServer.options)
+    .then()
+    .catch((err)=>{
+      coreLogger.error(`[ee-core] Please check the ${url} !`);
+    });
+  } else {
+    mainWindow.loadURL(url, mainServer.options)
+    .then()
+    .catch((err)=>{
+      coreLogger.error(`[ee-core] Please check the ${url} !`);
+    });
+  }
+}
+
+// loading page 
+function _loadingPage(name) {
+  if (!fileIsExist(name)) {
+    return
+  }
+  const win = getMainWindow();
+  win.loadFile(name);
+}
+
+/**
+ * cross takeover web
+ */
+async function crossTakeover() {
+  const crossConf = getConfig().cross;
+  const mainConf = getConfig().mainServer;
+
+  // loading page
+  if (mainConf.loadingPage.length > 0) {
+    const lp = path.join(getBaseDir, mainConf.loadingPage);
+    _loadingPage(lp);
+  }
+
+  // cross service url
+  const service = mainConf.takeover;
+  if (!crossConf.hasOwnProperty(service)) {
+    throw new Error(`[ee-core] Please Check the value of mainServer.takeover in the config file !`);
+  }
+  // check service
+  if (crossConf[service].enable != true) {
+    throw new Error(`[ee-core] Please Check the value of cross.${service} enable is true !`);
+  }
+
+  const entityName = crossConf[service].name;
+  const url = cross.getUrl(entityName);
+
+  // 循环检查
+  let count = 0;
+  let serviceReady = false;
+  const times = isDev() ? 20 : 100;
+  const sleeptime = isDev() ? 1000 : 200;
+  while(!serviceReady && count < times){
+    await sleep(sleeptime);
+    try {
+      await axios({
+        method: 'get',
+        url,
+        timeout: 100,
+        proxy: false,
+        headers: { 
+          'Accept': 'text/html, application/json, text/plain, */*',
+        },
+      });
+      serviceReady = true;
+    } catch(err) {
+      // console.warn(err.stack)
+    }
+    count++;
+  }
+  debug('it takes %d seconds to start the cross serivce', count * sleeptime);
+
+  if (serviceReady == false) {
+    const bootFailurePage = getHtmlFilepath('cross-failure.html');
+    const mainWindow = getMainWindow();
+    mainWindow.loadFile(bootFailurePage);
+    throw new Error(`[ee-core] Please check cross service [${service}] ${url} !`)
+  }
+
+  coreLogger.info(`[ee-core] cross service [${service}] is started successfully`);
+  loadMainUrl('spa', url);
+} 
+
+module.exports = {
+  getMainWindow,
+  createMainWindow,
+  restoreMainWindow,
+  setCloseAndQuit,
+  getCloseAndQuit,
+  loadServer
+};

package/exception/index.d.ts

@@ -0,0 +1,9 @@
+// Capture exceptions
+export declare function loadException(): void;
+// When an exception is thrown on a process without being caught, trigger the event and silence the exception
+export declare function uncaughtExceptionHandler(): void;
+// When the reject exception in the promise is not caught using catch in the synchronization task, it will trigger the event，
+// Even if catch is used in asynchronous situations, it will trigger the event
+export declare function unhandledRejectionHandler(): void;
+// This event is triggered when an exception is thrown on the process without being caught.
+export declare function uncaughtExceptionMonitorHandler(): void;

package/exception/index.js

@@ -1,20 +1,18 @@
-const Log = require('../log');
-const Ps = require('../ps');
-const Conf = require('../config/cache');
-const Message = require('../message');
+'use strict';
 
-/**
- * 捕获异常
- */
-exports.start = function() {
-  this.uncaughtExceptionHandler();
-  this.unhandledRejectionHandler();
+const { coreLogger } = require('../log');
+const { isForkedChild, isRenderer, isDev, isMain } = require('../ps');
+const { getConfig } = require('../config');
+const { childMessage } = require('../message');
+
+// 捕获异常
+function loadException() {
+  uncaughtExceptionHandler();
+  unhandledRejectionHandler();
 }
 
-/**
- * 当进程上抛出异常而没有被捕获时触发该事件，并且使异常静默。
- */
-exports.uncaughtExceptionHandler = function() {
+// 当进程上抛出异常而没有被捕获时触发该事件，并且使异常静默。
+function uncaughtExceptionHandler() {
   process.on('uncaughtException', function(err) {
     if (!(err instanceof Error)) {
       err = new Error(String(err));
@@ -24,7 +22,7 @@ exports.uncaughtExceptionHandler = function() {
       err.name = 'unhandledExceptionError';
     }
 
-    Log.coreLogger.error(err);
+    coreLogger.error(err);
 
     _devError(err);
 
@@ -32,24 +30,19 @@ exports.uncaughtExceptionHandler = function() {
   });
 }
 
-/**
- * 当进程上抛出异常而没有被捕获时触发该事件。
- */
-exports.uncaughtExceptionMonitorHandler = function() {
-  // process.on('uncaughtExceptionMonitor', function(err, origin) {
-  //   if (!(err instanceof Error)) {
-  //     err = new Error(String(err));
-  //   }
-   
-  //   Log.coreLogger.error('uncaughtExceptionMonitor:',err);
-  // });
+// 当进程上抛出异常而没有被捕获时触发该事件。
+function uncaughtExceptionMonitorHandler() {
+  process.on('uncaughtExceptionMonitor', function(err, origin) {
+    if (!(err instanceof Error)) {
+      err = new Error(String(err));
+    }
+    coreLogger.error('uncaughtExceptionMonitor:',err);
+  });
 }
 
-/**
- * 当promise中reject的异常在同步任务中没有使用catch捕获就会触发该事件，
- * 即便是在异步情况下使用了catch也会触发该事件
- */
-exports.unhandledRejectionHandler = function() {
+// 当promise中reject的异常在同步任务中没有使用catch捕获就会触发该事件，
+// 即便是在异步情况下使用了catch也会触发该事件
+function unhandledRejectionHandler() {
   process.on('unhandledRejection', function(err) {
     if (!(err instanceof Error)) {
       const newError = new Error(String(err));
@@ -64,50 +57,45 @@ exports.unhandledRejectionHandler = function() {
     if (err.name === 'Error') {
       err.name = 'unhandledRejectionError';
     }
-
-    Log.coreLogger.error(err);
-
+    coreLogger.error(err);
     _devError(err);
-
     _exit();
   });
 }
 
-/**
- * 如果是子进程，发送错误到主进程控制台
- */
+// 如果是子进程，发送错误到主进程控制台
 function _devError (err) {
-  if (Ps.isForkedChild() && Ps.isDev()) {
-    Message.childMessage.sendErrorToTerminal(err);
+  if (isForkedChild() && isDev()) {
+    childMessage.sendErrorToTerminal(err);
   }
 }
 
-/**
- * 捕获异常后是否退出
- */
+// 捕获异常后是否退出
 function _exit () {
-  let cfg = Conf.getValue('exception');
-  if (!cfg) {
-    return;
-  }
+  const { mainExit, childExit, rendererExit  } = getConfig().exception;
 
-  if (Ps.isMain() && cfg.mainExit == true) {
+  if (isMain() && mainExit == true) {
     _delayExit();
-  } else if (Ps.isForkedChild() && cfg.childExit == true) {
+  } else if (isForkedChild() && childExit == true) {
     _delayExit();
-  } else if (Ps.isRenderer() && cfg.rendererExit == true) {
+  } else if (isRenderer() && rendererExit == true) {
     _delayExit();
   } else {
     // other
   }
 }
 
-/**
- * 捕获异常后是否退出
- */
+// 捕获异常后是否退出
 function _delayExit() {
   // 等待日志等异步写入完成
   setTimeout(() => {
     process.exit();
   }, 1500)
-}
+}
+
+module.exports = {
+  loadException,
+  uncaughtExceptionHandler,
+  unhandledRejectionHandler,
+  uncaughtExceptionMonitorHandler
+};

package/html/index.d.ts

@@ -0,0 +1 @@
+export declare function getHtmlFilepath(name: string): string;

package/html/index.js

@@ -1,14 +1,11 @@
 const path = require('path');
 
-/**
- * Html
- */
-const Html = {
-  getFilepath(name){
-    const pagePath = path.join(__dirname, name);
-    return pagePath;
-  },
-
+// Html
+function getHtmlFilepath(name){
+  const pagePath = path.join(__dirname, name);
+  return pagePath;
 }
 
-module.exports = Html;
+module.exports = {
+  getHtmlFilepath
+};

package/index.d.ts

@@ -0,0 +1,2 @@
+export { ElectronEgg };
+import { ElectronEgg } from "./app";

package/index.js

@@ -1,55 +1,7 @@
-/**
- * @namespace EeCore
- */
+'use strict';
 
-/**
- * @member {ElectronEgg} EeCore#Index
- * @since 1.0.0
- */
-const ElectronEgg = require('./main');
-
-/**
- * @member {app} EeCore#app
- * @since 1.0.0
- */
-const EE = require('./ee');
-
-/**
- * @member {Controller} EeCore#Controller
- * @since 1.0.0
- */
-const Controller = require('./controller/baseContextClass');
-
-/**
- * @member {Service} EeCore#Service
- * @since 1.0.0
- */
-const Service = require('./services/baseContextClass');
-
-/**
- * @member {Storage}
- * @since 1.0.0
- */
-const Storage = require('./storage');
-
-/**
- * @member {Utils}
- * @since 1.0.0
- */
-const Utils = require('./old-utils');
-
-/**
- * @member {Socket}
- * @since 1.0.0
- */
-const Socket = require('./socket');
+const { ElectronEgg } = require('./app');
 
 module.exports = {
-  ElectronEgg,
-  Application: EE.Application,
-  Controller,
-  Service,
-  Storage,
-  Socket,
-  Utils
-};
+  ElectronEgg
+}

package/jobs/child/app.d.ts

@@ -0,0 +1 @@
+export {};

package/jobs/child/app.js

@@ -1,11 +1,11 @@
 
 const is = require('is-type-of');
-const Exception = require('ee-core/exception');
-const Loader = require('ee-core/loader');
-const Log = require('ee-core/log');
-const UtilsCore = require('ee-core/core/lib/utils');
+const { loadException } = require('ee-core/exception');
+const { requireFile } = require('ee-core/loader');
+const { coreLogger } = require('ee-core/log');
+const { isBytecodeClass } = require('ee-core/core/utils');
 
-Exception.start();
+loadException();
 const commands = ['run'];
 
 class ChildApp {
@@ -20,7 +20,7 @@ class ChildApp {
   _initEvents() {
     process.on('message', this._handleMessage.bind(this));
     process.once('exit', (code) => {
-      Log.coreLogger.info(`[ee-core] [jobs/child] received a exit from main-process, code:${code}, pid:${process.pid}`);
+      coreLogger.info(`[ee-core] [jobs/child] received a exit from main-process, code:${code}, pid:${process.pid}`);
     });
   }
 
@@ -37,7 +37,7 @@ class ChildApp {
         break;
       default:
     }
-    Log.coreLogger.info(`[ee-core] [jobs/child] received a message from main-process, message: ${JSON.stringify(m)}`);
+    coreLogger.info(`[ee-core] [jobs/child] received a message from main-process, message: ${JSON.stringify(m)}`);
   }
 
   /**
@@ -45,8 +45,8 @@ class ChildApp {
    */  
   run(msg = {}) {
     const {jobPath, jobParams, jobFunc, jobFuncParams} = msg;
-    let mod = Loader.loadJsFile(jobPath);
-    if (is.class(mod) || UtilsCore.isBytecodeClass(mod)) {
+    let mod = requireFile(jobPath);
+    if (is.class(mod) || isBytecodeClass(mod)) {
       if (!this.jobMap.has(jobPath)) {
         const instance = new mod(...jobParams);
         instance.handle(...jobParams);
@@ -58,7 +58,7 @@ class ChildApp {
 
     } else if (is.function(mod)) {
       mod(jobParams);
-    } 
+    }
   }
 }