ee-core 4.0.0-beta.1 → 4.0.0

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

@@ -9,10 +9,10 @@ const { getRandomString } = require('../../utils/helper');
 const { getFullpath } = require('../../loader');
 const { extend } = require('../../utils/extend');
 
-class ForkProcess {
+class JobProcess {
   constructor(host, opt = {}) {
     
-    const cwd = getBaseDir();
+    let cwd = getBaseDir();
     const appPath = path.join(__dirname, 'app.js');
     if (isPackaged()) {
       // todo fork的cwd目录为什么要在app.asar外 ？
@@ -41,9 +41,6 @@ class ForkProcess {
     this._init();
   }
 
-  /**
-   * 初始化事件监听
-   */
   _init() {
     const { messageLog } = this.host.config;
     this.child.on('message', (m) => {
@@ -78,9 +75,6 @@ class ForkProcess {
     });
   }
 
-  /**
-   * event emit
-   */
   _eventEmit(m) {
     switch (m.eventReceiver) {
       case Receiver.forkProcess:
@@ -96,9 +90,6 @@ class ForkProcess {
     }
   }
   
-  /**
-   * 分发任务
-   */
   dispatch(cmd, jobPath = '', ...params) {
     // 消息对象
     const mid = getRandomString();
@@ -114,9 +105,6 @@ class ForkProcess {
     this.child.send(msg);
   }
 
-  /**
-   * 调用job的方法
-   */
   callFunc(jobPath = '', funcName = '', ...params) {
     jobPath = getFullpath(jobPath);
 
@@ -132,9 +120,6 @@ class ForkProcess {
     this.child.send(msg);
   }
 
-  /**
-   * kill
-   */
   kill(timeout = 1000) {
     this.child.kill('SIGINT');
     setTimeout(() => {
@@ -145,5 +130,5 @@ class ForkProcess {
 }
 
 module.exports = {
-  ForkProcess
+  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,7 +1,7 @@
 const EventEmitter = require('events');
 const LoadBalancer = require('../load-balancer');
 const { getFullpath } = require('../../loader');
-const { ForkProcess } = require('../child/forkProcess');
+const { JobProcess } = require('../child/jobProcess');
 const { Events } = require('../../const/channel');
 const { validValue } = require('../../utils/helper');
 const { getConfig } = require('../../config');
@@ -39,9 +39,6 @@ class ChildPoolJob extends EventEmitter {
     this._initEvents();
   }
 
-  /**
-   * 初始化监听
-   */  
   _initEvents() {
     this.on(Events.childProcessExit, (data) => {
       this._removeChild(data.pid);
@@ -50,10 +47,7 @@ class ChildPoolJob extends EventEmitter {
       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,9 +100,7 @@ class ChildPoolJob extends EventEmitter {
     this.LB.add(lbTask);
   }
 
-  /**
-   * 执行一个job文件
-   */  
+  // Execute a job file 
   run(filepath, params = {}) {
     const jobPath = getFullpath(filepath);
     const childProcess = this.getChild();
@@ -122,16 +109,12 @@ class ChildPoolJob extends EventEmitter {
     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 => {

package/jobs/index.d.ts

@@ -0,0 +1,3 @@
+import { ChildJob } from "./child";
+import { ChildPoolJob } from "./child-pool";
+export { ChildJob, 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;

package/loader/index.js

@@ -4,13 +4,7 @@ const path = require('path');
 const CoreUtils = require('../core/utils');
 const { getElectronDir } = require('../ps');
 
-/**
- * 加载单个文件(如果是函数，将被执行)
- *
- * @param {String} filepath - fullpath
- * @param {Array} inject - pass rest arguments into the function when invoke
- * @return {Object} exports
- */
+// 加载单个文件(如果是函数，将被执行)
 function loadFile(filepath, ...inject) {
   const isAbsolute = path.isAbsolute(filepath);
   if (!isAbsolute) {
@@ -35,13 +29,7 @@ function requireFile(filepath) {
   return CoreUtils.loadFile(filepath);
 }
 
-/**
- * 加载并运行文件
- *
- * @param {String} filepath - fullpath
- * @param {Array} inject - pass rest arguments into the function when invoke
- * @return {Any}
- */
+// 加载并运行文件
 function execFile(filepath, ...inject) {
   let ret = CoreUtils.loadFile(filepath);
   if (is.class(ret) || CoreUtils.isBytecodeClass(ret)) {
@@ -53,10 +41,7 @@ function execFile(filepath, ...inject) {
   return ret;
 }
 
-/**
- * 模块的绝对路径
- * @param {String} filepath - fullpath
- */
+// 模块的绝对路径
 function resolveModule(filepath) {
   let fullpath;
   try {
@@ -80,10 +65,7 @@ function resolveModule(filepath) {
   return fullpath;
 }
 
-/**
- * 获取electron目录下文件的绝对路径
- * @param {String} filepath - fullpath
- */
+// 获取electron目录下文件的绝对路径
 function getFullpath(filepath) {
   let fullpath;
   const isAbsolute = path.isAbsolute(filepath);

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/logger.d.ts

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

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

@@ -4,17 +4,13 @@ const { Receiver, Processes } = require('../const/channel');
 
 class ChildMessage {
 
-  /**
-   * 向主进程发消息 for ChildJob 实例
-   */
+  // Send a message to the main process for ChildJob instance
   sendToMain(eventName, params = {}) {
     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) {
     const eventReceiver = receiver || Receiver.forkProcess;
     const message = {
@@ -27,16 +23,10 @@ class ChildMessage {
     return process.send(message);
   }
 
-  /**
-   * 进程退出
-   */
   exit(code = 0) {
     return process.exit(code);
   }
 
-  /**
-   * 发送错误到控制台
-   */
   sendErrorToTerminal(err) {
     let errTips = (err && typeof err == 'object') ? err.toString() : '';
     errTips += ' Error !!! Please See file ee-core.log or ee-error-xxx.log for details !'

package/message/index.d.ts

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ee-core",
-  "version": "4.0.0-beta.1",
+  "version": "4.0.0",
   "description": "ee core",
   "main": "index.js",
   "scripts": {
@@ -34,5 +34,11 @@
     "socket.io": "^4.6.1",
     "socket.io-client": "^4.6.1",
     "urllib": "^2.38.0"
+  },
+  "devDependencies": {
+    "@types/better-sqlite3": "^7.6.12",
+    "@types/electron": "^1.4.38",
+    "@types/node": "^20.16.0",
+    "typescript": "^5.7.2"
   }
 }

package/ps/index.d.ts

@@ -0,0 +1,37 @@
+export declare function allEnv(): NodeJS.ProcessEnv;
+export declare function env(): string;
+export declare function isProd(): boolean;
+export declare function isDev(): boolean;
+export declare function isRenderer(): boolean;
+export declare function isMain(): boolean;
+export declare function isForkedChild(): boolean;
+export declare function processType(): string;
+export declare function appName(): string;
+export declare function appVersion(): string;
+export declare function getDataDir(): string;
+export declare function getLogDir(): string;
+export declare function getBundleDir(basePath: string): string;
+export declare function getRootDir(): string;
+export declare function getBaseDir(): string;
+export declare function getElectronDir(): string;
+export declare function getPublicDir(): string;
+export declare function getExtraResourcesDir(): string;
+export declare function getAppUserDataDir(): string;
+export declare function getExecDir(): string;
+export declare function getUserHomeDir(): string;
+export declare function getUserHomeAppDir(): string;
+export declare function getUserHomeHiddenAppDir(): string;
+export declare function getSocketPort(): number;
+export declare function getHttpPort(): number;
+export declare function isPackaged(): boolean;
+export declare function isHotReload(): boolean;
+export declare function exit(code?: number): never;
+export declare function makeMessage(msg?: {}): {
+    channel: string;
+    event: string;
+    data: {};
+};
+export declare function exitChildJob(code?: number): void;
+export declare function isChildJob(): boolean;
+export declare function isChildPoolJob(): boolean;
+export declare function getArgumentByName(name: string): string;

package/ps/index.js

@@ -18,9 +18,7 @@ function isProd() {
   return (process.env.EE_ENV === 'prod');
 }
 
-/**
- * 是否为开发环境
- */
+// 是否为开发环境
 function isDev() {
   if (process.env.EE_ENV === 'dev' || process.env.EE_ENV === 'local') {
     return true;
@@ -174,18 +172,11 @@ function getHttpPort() {
   return parseInt(process.env.EE_HTTP_PORT) || 0;
 }
 
-/**
- * 是否打包
- */
+// 是否打包
 function isPackaged() {
   return process.env.EE_IS_PACKAGED === 'true';
 }
 
-// 是否热重启
-function isHotReload() {
-  return process.env.HOT_RELOAD === 'true';
-}
-
 // 进程退出
 function exit(code = 0) {
   return process.exit(code);
@@ -276,7 +267,6 @@ module.exports = {
   getSocketPort,
   getHttpPort,
   isPackaged,
-  isHotReload,
   exit,
   makeMessage,
   exitChildJob,

package/socket/httpServer.d.ts

@@ -0,0 +1,8 @@
+export declare class HttpServer {
+    config: any;
+    httpApp: any;
+    init(): Promise<void>;
+    _create(): void;
+    _dispatch(ctx: any, next: any): Promise<void>;
+    getHttpApp(): any;
+}

package/socket/httpServer.js

@@ -1,5 +1,6 @@
 'use strict';
 
+const debug = require('debug')('ee-core:socket:httpServer');
 const assert = require('assert');
 const is = require('is-type-of');
 const Koa = require('koa');
@@ -15,12 +16,16 @@ const { getController } = require('../controller');
 const { getConfig } = require('../config');
 const { getPort } = require('../utils/port');
 
+let channelSeparator = '/';
+
 /**
  * http server
  */
 class HttpServer {
   constructor () {
-    this.config = getConfig().httpServer;
+    const { httpServer, mainServer } = getConfig();
+    this.config = httpServer;
+    channelSeparator = mainServer.channelSeparator;
     this.httpApp = undefined;
     this.init();
   }
@@ -117,11 +122,13 @@ class HttpServer {
       if (uriPath.slice(0, 10) != 'controller') {
         uriPath = 'controller/' + uriPath;
       }
-      const cmd = uriPath.split('/').join('.');
+      const cmd = uriPath.split('/').join(channelSeparator);
+      debug('[request] uri %s', cmd);
       const args = (method == 'POST') ? body: params;
       let fn = null;
       if (is.string(cmd)) {
-        const actions = cmd.split('.');
+        const actions = cmd.split(channelSeparator);
+        debug('[findFn] channel %o', actions);
         let obj = { controller };
         actions.forEach(key => {
           obj = obj[key];

package/socket/index.d.ts

@@ -0,0 +1,10 @@
+import IoServer = require("socket.io");
+import IoClient = require("socket.io-client");
+import { HttpServer } from './httpServer';
+import { IpcServer } from './ipcServer';
+import { SocketServer } from './socketServer';
+export declare function loadSocket(): void;
+export declare function getSocketServer(): SocketServer;
+export declare function getHttpServer(): HttpServer;
+export declare function getIpcServer(): IpcServer;
+export { IoServer, IoClient };