ee-core 2.12.0 → 4.0.0

package/jobs/child/index.d.ts

@@ -0,0 +1,13 @@
+import EventEmitter = require("events");
+import { JobProcess } from "./jobProcess";
+export declare class ChildJob extends EventEmitter<[never]> {
+    constructor();
+    jobs: {};
+    config: any;
+    _initEvents(): void;
+    exec(filepath: string, params?: {}, opt?: {}): JobProcess;
+    createProcess(opt?: {}): JobProcess;
+    getPids(): string[];
+    execPromise(filepath: string, params?: {}, opt?: {}): Promise<JobProcess>;
+}
+

package/jobs/child/index.js

@@ -1,8 +1,9 @@
 const EventEmitter = require('events');
-const ForkProcess = require('./forkProcess');
-const Loader = require('../../loader');
-const Channel = require('../../const/channel');
-const Conf = require('../../config/cache');
+const { JobProcess } = require('./jobProcess');
+const { getFullpath } = require('../../loader');
+const { Events } = require('../../const/channel');
+const { getConfig } = require('../../config');
+const { extend } = require('../../utils/extend');
 
 class ChildJob extends EventEmitter {
 
@@ -11,7 +12,7 @@ class ChildJob extends EventEmitter {
     this.jobs = {};
     this.config = {};
 
-    const cfg = Conf.getValue('jobs');
+    const cfg = getConfig().jobs;
     if (cfg) {
       this.config = cfg;
     }
@@ -23,10 +24,10 @@ class ChildJob extends EventEmitter {
    * 初始化监听
    */  
   _initEvents() {
-    this.on(Channel.events.childProcessExit, (data) => {
+    this.on(Events.childProcessExit, (data) => {
       delete this.jobs[data.pid];
     });
-    this.on(Channel.events.childProcessError, (data) => {
+    this.on(Events.childProcessError, (data) => {
       delete this.jobs[data.pid];
     });
   }
@@ -35,7 +36,7 @@ class ChildJob extends EventEmitter {
    * 执行一个job文件
    */  
   exec(filepath, params = {}, opt = {}) {
-    const jobPath = Loader.getFullpath(filepath);
+    const jobPath = getFullpath(filepath);
     const proc = this.createProcess(opt);
     const cmd = 'run';
     proc.dispatch(cmd, jobPath, params);
@@ -47,12 +48,12 @@ class ChildJob extends EventEmitter {
    * 创建子进程
    */  
   createProcess(opt = {}) {
-    let options = Object.assign({
+    const options = extend(true, {
       processArgs: {
         type: 'childJob'
       }
     }, opt);
-    const proc = new ForkProcess(this, options);
+    const proc = new JobProcess(this, options);
     if (!proc) {
       let errorMessage = `[ee-core] [jobs/child] Failed to obtain the child process !`
       throw new Error(errorMessage);
@@ -79,4 +80,6 @@ class ChildJob extends EventEmitter {
 
 }
 
-module.exports = ChildJob;
+module.exports = {
+  ChildJob
+};

package/jobs/child/jobProcess.d.ts

@@ -0,0 +1,16 @@
+import { EventEmitter } from "events";
+import { ChildProcess } from "child_process";
+declare export class JobProcess {
+    constructor(host: any, opt?: {});
+    emitter: EventEmitter<[never]>;
+    host: any;
+    args: string[];
+    sleeping: boolean;
+    child: ChildProcess;
+    pid: number;
+    _init(): void;
+    _eventEmit(m: any): void;
+    dispatch(cmd: string, jobPath?: string, ...params: any[]): void;
+    callFunc(jobPath?: string, funcName?: string, ...params: any[]): void;
+    kill(timeout?: number): void;
+}

package/jobs/child/{forkProcess.js → jobProcess.js}

@@ -1,29 +1,29 @@
 const path = require('path');
 const EventEmitter = require('events');
-const { fork } = require('child_process');
 const serialize = require('serialize-javascript');
-const Log = require('../../log');
-const Ps = require('../../ps');
-const Channel = require('../../const/channel');
-const Helper = require('../../utils/helper');
-const Loader = require('../../loader');
-const extend = require('../../utils/extend');
-
-class ForkProcess {
+const { fork } = require('child_process');
+const { coreLogger } = require('../../log');
+const { getBaseDir, isPackaged, allEnv } = require('../../ps');
+const { Processes, Events, Receiver } = require('../../const/channel');
+const { getRandomString } = require('../../utils/helper');
+const { getFullpath } = require('../../loader');
+const { extend } = require('../../utils/extend');
+
+class JobProcess {
   constructor(host, opt = {}) {
     
-    let cwd = Ps.getHomeDir();
-    let appPath = path.join(__dirname, 'app.js');
-    if (Ps.isPackaged()) {
+    let cwd = getBaseDir();
+    const appPath = path.join(__dirname, 'app.js');
+    if (isPackaged()) {
       // todo fork的cwd目录为什么要在app.asar外 ？
-      cwd = path.join(Ps.getHomeDir(), '..');
+      cwd = path.join(getBaseDir(), '..');
     }
 
-    let options = extend(true,{
+    const options = extend(true, {
       processArgs: {},
       processOptions: { 
         cwd: cwd,
-        env: Ps.allEnv(), 
+        env: allEnv(), 
         stdio: 'ignore' // pipe
       }
     }, opt);
@@ -41,22 +41,19 @@ class ForkProcess {
     this._init();
   }
 
-  /**
-   * 初始化事件监听
-   */
   _init() {
     const { messageLog } = this.host.config;
     this.child.on('message', (m) => {
       if (messageLog == true) {
-        Log.coreLogger.info(`[ee-core] [jobs/child] received a message from child-process, message: ${serialize(m)}`);
+        coreLogger.info(`[ee-core] [jobs/child] received a message from child-process, message: ${serialize(m)}`);
       }
       
-      if (m.channel == Channel.process.showException) {
-        Log.coreLogger.error(`${m.data}`);
+      if (m.channel == Processes.showException) {
+        coreLogger.error(`${m.data}`);
       }
 
       // 收到子进程消息，转发到 event 
-      if (m.channel == Channel.process.sendToMain) {
+      if (m.channel == Processes.sendToMain) {
         this._eventEmit(m);
       }
     });
@@ -65,28 +62,25 @@ class ForkProcess {
       let data = {
         pid: this.pid
       }
-      this.host.emit(Channel.events.childProcessExit, data);
-      Log.coreLogger.info(`[ee-core] [jobs/child] received a exit from child-process, code:${code}, signal:${signal}, pid:${this.pid}`);
+      this.host.emit(Events.childProcessExit, data);
+      coreLogger.info(`[ee-core] [jobs/child] received a exit from child-process, code:${code}, signal:${signal}, pid:${this.pid}`);
     });
 
     this.child.on('error', (err) => {
       let data = {
         pid: this.pid
       }
-      this.host.emit(Channel.events.childProcessError, data);
-      Log.coreLogger.error(`[ee-core] [jobs/child] received a error from child-process, error: ${err}, pid:${this.pid}`);
+      this.host.emit(Events.childProcessError, data);
+      coreLogger.error(`[ee-core] [jobs/child] received a error from child-process, error: ${err}, pid:${this.pid}`);
     });
   }
 
-  /**
-   * event emit
-   */
   _eventEmit(m) {
     switch (m.eventReceiver) {
-      case Channel.receiver.forkProcess:
+      case Receiver.forkProcess:
         this.emitter.emit(m.event, m.data);
         break;
-      case Channel.receiver.childJob:
+      case Receiver.childJob:
         this.host.emit(m.event, m.data);
         break;    
       default:
@@ -96,12 +90,9 @@ class ForkProcess {
     }
   }
   
-  /**
-   * 分发任务
-   */
   dispatch(cmd, jobPath = '', ...params) {
     // 消息对象
-    const mid = Helper.getRandomString();
+    const mid = getRandomString();
     let msg = {
       mid,
       cmd,
@@ -114,14 +105,11 @@ class ForkProcess {
     this.child.send(msg);
   }
 
-  /**
-   * 调用job的方法
-   */
   callFunc(jobPath = '', funcName = '', ...params) {
-    jobPath = Loader.getFullpath(jobPath);
+    jobPath = getFullpath(jobPath);
 
     // 消息对象
-    const mid = Helper.getRandomString();
+    const mid = getRandomString();
     let msg = {
       mid,
       cmd:'run',
@@ -132,9 +120,6 @@ class ForkProcess {
     this.child.send(msg);
   }
 
-  /**
-   * kill
-   */
   kill(timeout = 1000) {
     this.child.kill('SIGINT');
     setTimeout(() => {
@@ -142,24 +127,8 @@ class ForkProcess {
       this.child.kill('SIGKILL');
     }, timeout)
   }
-
-  /**
-   * sleep (仅Unix平台)
-   */
-  sleep() {
-    if (this.sleeping) return;
-    process.kill(this.pid, 'SIGSTOP');
-    this.sleeping = true;
-  }
-  
-  /**
-   * wakeup (仅Unix平台)
-   */
-  wakeup() {
-    if (!this.sleeping) return;
-    process.kill(this.pid, 'SIGCONT');
-    this.sleeping = false;
-  }
 }
 
-module.exports = ForkProcess;
+module.exports = {
+  JobProcess
+};

package/jobs/child-pool/index.d.ts

@@ -0,0 +1,26 @@
+import EventEmitter = require("events");
+import LoadBalancer = require("../load-balancer");
+export declare class ChildPoolJob extends EventEmitter<[never]> {
+    constructor(opt?: {});
+    config: any;
+    boundMap: Map<any, any>;
+    children: {};
+    min: number;
+    max: number;
+    strategy: string;
+    weights: any[];
+    LB: LoadBalancer;
+    _initEvents(): void;
+    _removeChild(pid: any): void;
+    create(number?: number): Promise<string[]>;
+    _childCreated(childProcess: any): void;
+    run(filepath: any, params?: {}): any;
+    runPromise(filepath: any, params?: {}): Promise<any>;
+    getBoundChild(boundId: any): any;
+    getChildByPid(pid: any): any;
+    getChild(): any;
+    getPids(): string[];
+    // kill all
+    // type: sequence | parallel
+    killAll(type?: string): void;
+}

package/jobs/child-pool/index.js

@@ -1,10 +1,10 @@
 const EventEmitter = require('events');
 const LoadBalancer = require('../load-balancer');
-const Loader = require('../../loader');
-const ForkProcess = require('../child/forkProcess');
-const Channel = require('../../const/channel');
-const Helper = require('../../utils/helper');
-const Conf = require('../../config/cache');
+const { getFullpath } = require('../../loader');
+const { JobProcess } = require('../child/jobProcess');
+const { Events } = require('../../const/channel');
+const { validValue } = require('../../utils/helper');
+const { getConfig } = require('../../config');
 
 class ChildPoolJob extends EventEmitter {
 
@@ -21,7 +21,7 @@ class ChildPoolJob extends EventEmitter {
     this.max = 6;
     this.strategy = 'polling';
     this.weights = new Array(this.max).fill().map((v, i) => {
-      let w = Helper.validValue(options.weights[i]) ? options.weights[i] : 1
+      let w = validValue(options.weights[i]) ? options.weights[i] : 1
       return w;
     });
 
@@ -31,7 +31,7 @@ class ChildPoolJob extends EventEmitter {
     }
     this.LB = new LoadBalancer(lbOpt);
 
-    const cfg = Conf.getValue('jobs');
+    const cfg = getConfig().jobs;
     if (cfg) {
       this.config = cfg;
     }
@@ -39,21 +39,15 @@ class ChildPoolJob extends EventEmitter {
     this._initEvents();
   }
 
-  /**
-   * 初始化监听
-   */  
   _initEvents() {
-    this.on(Channel.events.childProcessExit, (data) => {
+    this.on(Events.childProcessExit, (data) => {
       this._removeChild(data.pid);
     });
-    this.on(Channel.events.childProcessError, (data) => {
+    this.on(Events.childProcessError, (data) => {
       this._removeChild(data.pid);
     });
   }
-
-  /**
-   * 移除对象
-   */  
+ 
   _removeChild(pid) {
     const length = Object.keys(this.children).length;
     const lbOpt = {
@@ -63,10 +57,7 @@ class ChildPoolJob extends EventEmitter {
     this.LB.del(lbOpt);
     delete this.children[pid];
   }
-
-  /**
-   * 创建一个池子
-   */  
+ 
   async create(number = 3) {
     if (number < 0 || number > this.max) {
       throw new Error(`[ee-core] [jobs/child-pool] The number is invalid !`);
@@ -87,7 +78,7 @@ class ChildPoolJob extends EventEmitter {
       }
     }, {});
     for (let i = 1; i <= number; i++) {
-      let task = new ForkProcess(this, options);
+      let task = new JobProcess(this, options);
       this._childCreated(task);
     }
   
@@ -96,9 +87,7 @@ class ChildPoolJob extends EventEmitter {
     return pids;
   }
 
-  /**
-   * 子进程创建后处理
-   */  
+  //  Post creation processing of child processes
   _childCreated(childProcess) {
     let pid = childProcess.pid;
     this.children[pid] = childProcess;
@@ -111,27 +100,21 @@ class ChildPoolJob extends EventEmitter {
     this.LB.add(lbTask);
   }
 
-  /**
-   * 执行一个job文件
-   */  
+  // Execute a job file 
   run(filepath, params = {}) {
-    const jobPath = Loader.getFullpath(filepath);
+    const jobPath = getFullpath(filepath);
     const childProcess = this.getChild();
     childProcess.dispatch('run', jobPath, params);
 
     return childProcess;
   }
 
-  /**
-   * 异步执行一个job文件
-   */
+  // Asynchronous execution of a job file
   async runPromise(filepath, params = {}) {
     return this.run(filepath, params);
   }  
 
-  /**
-   * 获取绑定的进程对象
-   */  
+  // Get the bound process object 
   getBoundChild(boundId) {
     let proc;
     const boundPid = this.boundMap.get(boundId);
@@ -147,17 +130,13 @@ class ChildPoolJob extends EventEmitter {
     return proc;
   }
 
-  /**
-   * 通过pid获取一个子进程对象
-   */  
+  // Retrieve a sub process object through PID 
   getChildByPid(pid) {
     let proc = this.children[pid] || null;
     return proc;
   }
 
-  /**
-   * 获取一个子进程对象
-   */  
+  // Get a sub process object 
   getChild() {
     let proc;
     const currentPids = Object.keys(this.children);
@@ -180,18 +159,14 @@ class ChildPoolJob extends EventEmitter {
     return proc;
   }
 
-  /**
-   * 获取当前pids
-   */  
+  // Get current pigs 
   getPids() {
     let pids = Object.keys(this.children);
     return pids;
   }   
 
-  /**
-   * kill all 
-   * @param type {String} - 'sequence' | 'parallel'
-   */
+  // kill all
+  // type: sequence | parallel
   killAll(type = 'parallel') {
     let i = 1;
     Object.keys(this.children).forEach(key => {
@@ -210,4 +185,6 @@ class ChildPoolJob extends EventEmitter {
   }
 }
 
-module.exports = ChildPoolJob;
+module.exports = {
+  ChildPoolJob
+};

package/jobs/index.d.ts

@@ -0,0 +1,3 @@
+import { ChildJob } from "./child";
+import { ChildPoolJob } from "./child-pool";
+export { ChildJob, ChildPoolJob };

package/jobs/index.js

@@ -1,9 +1,7 @@
-const ChildJob = require('./child');
-const RendererJob = require('./renderer');
-const ChildPoolJob = require('./child-pool');
+const { ChildJob } = require('./child');
+const { ChildPoolJob } = require('./child-pool');
 
 module.exports = {
   ChildJob,
-  RendererJob,
   ChildPoolJob
 };

package/jobs/load-balancer/algorithm/index.d.ts

@@ -0,0 +1,4 @@
+declare const _exports: {
+    [x: string]: (tasks: any, weightIndex: any, weightTotal: any, context: any) => any;
+};
+export = _exports;

package/jobs/load-balancer/algorithm/minimumConnection.d.ts

@@ -0,0 +1,2 @@
+declare function _exports(tasks: any, conMap?: {}): any;
+export = _exports;

package/jobs/load-balancer/algorithm/polling.d.ts

@@ -0,0 +1,2 @@
+declare function _exports(tasks: any, currentIndex: any, context: any): any;
+export = _exports;

package/jobs/load-balancer/algorithm/random.d.ts

@@ -0,0 +1,2 @@
+declare function _exports(tasks: any): any;
+export = _exports;

package/jobs/load-balancer/algorithm/specify.d.ts

@@ -0,0 +1,2 @@
+declare function _exports(tasks: any, id: any): any;
+export = _exports;

package/jobs/load-balancer/algorithm/weights.d.ts

@@ -0,0 +1,2 @@
+declare function _exports(tasks: any, weightTotal: any, context: any): any;
+export = _exports;

package/jobs/load-balancer/algorithm/weightsMinimumConnection.d.ts

@@ -0,0 +1,2 @@
+declare function _exports(tasks: any, weightTotal: any, connectionsMap: any, context: any): any;
+export = _exports;

package/jobs/load-balancer/algorithm/weightsPolling.d.ts

@@ -0,0 +1,2 @@
+declare function _exports(tasks: any, weightIndex: any, weightTotal: any, context: any): any;
+export = _exports;

package/jobs/load-balancer/algorithm/weightsRandom.d.ts

@@ -0,0 +1,2 @@
+declare function _exports(tasks: any, weightTotal: any): any;
+export = _exports;

package/jobs/load-balancer/consts.d.ts

@@ -0,0 +1,8 @@
+export declare let polling: string;
+export declare let weights: string;
+export declare let random: string;
+export declare let specify: string;
+export declare let weightsPolling: string;
+export declare let weightsRandom: string;
+export declare let minimumConnection: string;
+export declare let weightsMinimumConnection: string;

package/jobs/load-balancer/index.d.ts

@@ -0,0 +1,96 @@
+export = LoadBalancer;
+/**
+ * 负载均衡器
+ * @intro 参考electron-re项目，并做了一些改动
+ * @since 1.0.0
+ */
+declare class LoadBalancer {
+    static Algorithm: {
+        polling: string;
+        weights: string;
+        random: string;
+        specify: string;
+        weightsPolling: string;
+        weightsRandom: string;
+        minimumConnection: string;
+        weightsMinimumConnection: string;
+    };
+    /**
+      * @param  {Object} options
+      * @param  {Array } options.targets [ targets for load balancing calculation: [{id: 1, weight: 1}, {id: 2, weight: 2}] ]
+      * @param  {String} options.algorithm
+      */
+    constructor(options: {
+        targets: any[];
+        algorithm: string;
+    });
+    targets: any[];
+    algorithm: string;
+    params: {
+        currentIndex: number;
+        weightIndex: number;
+        weightTotal: number;
+        connectionsMap: {};
+        cpuOccupancyMap: {};
+        memoryOccupancyMap: {};
+    };
+    scheduler: Scheduler;
+    memoParams: {
+        [x: string]: (id: any) => any[];
+    };
+    /**
+     * 算法参数
+     */
+    memorizedParams(): {
+        [x: string]: (id: any) => any[];
+    };
+    /**
+     * 刷新参数
+     */
+    refreshParams(pidMap: any): void;
+    /**
+     * 选举出一个进程
+     */
+    pickOne(...params: any[]): any;
+    /**
+     * 选举出多个进程
+     */
+    pickMulti(count?: number, ...params: any[]): any[];
+    /**
+     * 计算权重
+     */
+    calculateWeightIndex(): void;
+    /**
+     * 计算索引
+     */
+    calculateIndex(): void;
+    /**
+     * 清除data
+     */
+    clean(id: any): void;
+    /**
+     * 添加一个进程信息
+     */
+    add(task: any): void;
+    /**
+     * 删除一个进程信息
+     */
+    del(target: any): void;
+    /**
+     * 擦除
+     */
+    wipe(): void;
+    /**
+     * 更新计算参数
+     */
+    updateParams(object: any): void;
+    /**
+     * 设置targets
+     */
+    setTargets(targets: any): void;
+    /**
+     * 设置算法
+     */
+    setAlgorithm: (algorithm: any) => void;
+}
+import Scheduler = require("./scheduler");

package/jobs/load-balancer/scheduler.d.ts

@@ -0,0 +1,16 @@
+export = Scheduler;
+/**
+ * 算法调度器
+ */
+declare class Scheduler {
+    constructor(algorithm: any);
+    algorithm: any;
+    /**
+     * 计算
+     */
+    calculate(tasks: any, params: any): any;
+    /**
+     * 设置算法
+     */
+    setAlgorithm: (algorithm: any) => void;
+}

package/loader/index.d.ts

@@ -0,0 +1,9 @@
+// 加载单个文件(如果是函数，将被执行)
+export declare function loadFile(filepath: string, ...inject: any[]): any;
+// 加载并运行文件
+export declare function execFile(filepath: string, ...inject: any[]): Any;
+export declare function requireFile(filepath: string): any;
+// 模块的绝对路径
+export declare function resolveModule(filepath: string): string;
+// 获取electron目录下文件的绝对路径
+export function getFullpath(filepath: string): string;