ee-core 4.1.5 → 5.0.0-beta.2

package/ps/index.js

@@ -1,295 +0,0 @@
-'use strict';
-
-const path = require('path');
-const is = require('../utils/is');
-
-// 当前进程的所有env
-function allEnv() {
-  return process.env;
-}
-
-// 当前环境 - local | prod
-function env() {
-  return process.env.EE_ENV;
-}
-
-// 是否生产环境
-function isProd() {
-  return (process.env.EE_ENV === 'prod');
-}
-
-// 是否为开发环境
-function isDev() {
-  if (process.env.EE_ENV === 'dev' || process.env.EE_ENV === 'local') {
-    return true;
-  }
-
-  return false;
-};
-
-// 是否为渲染进程
-function isRenderer() {
-  return (typeof process === 'undefined' ||
-    !process ||
-    process.type === 'renderer');
-};
-
-// 是否为主进程
-function isMain() {
-  return ( typeof process !== 'undefined' &&
-    process.type === 'browser');
-};
-
-// 是否为node子进程
-function isForkedChild() {
-  return (Number(process.env.ELECTRON_RUN_AS_NODE) === 1);
-};
-
-// 当前进程类型
-function processType() {
-  let type = '';
-  if (isMain()) {
-    type = 'browser';
-  } else if (isRenderer()) {
-    type = 'renderer';
-  } else if (isForkedChild()) {
-    type = 'child';
-  }
-
-  return type;
-};
-
-// app name
-function appName() {
-  return process.env.EE_APP_NAME;
-}
-
-// app version
-function appVersion() {
-  return process.env.EE_APP_VERSION;
-}
-
-// 获取数据存储路径
-function getDataDir() {
-  const base = isDev() ? getBaseDir() : getUserHomeHiddenAppDir();
-  const dataDir = path.join(base, 'data');
-  return dataDir;
-}
-
-// 获取日志存储路径 
-function getLogDir() {
-  const base = isDev() ? getBaseDir() : getUserHomeHiddenAppDir();
-  const dir = path.join(base, 'logs');
-  return dir;
-}
-
-// 获取bundle文件路径
-function getBundleDir(basePath) {
-  const base = basePath || process.cwd();
-  const dir = path.join(base, 'public', 'electron');
-  return dir;
-}
-
-// 获取electron 源码文件路径
-function getElectronCodeDir(basePath) {
-  const base = basePath || process.cwd();
-  const dir = path.join(base, 'electron');
-  return dir;
-}
-
-// 获取frontend 源码文件路径
-function getFrontendCodeDir(basePath) {
-  const base = basePath || process.cwd();
-  const dir = path.join(base, 'frontend');
-  return dir;
-}
-
-// 获取base目录
-function getBaseDir() {
-  return process.env.EE_BASE_DIR;
-}
-
-// 获取electron目录
-function getElectronDir() {
-  return process.env.EE_ELECTRON_DIR;
-}
-
-// 获取public目录
-function getPublicDir() {
-  const dir = path.join(getBaseDir(), "public");
-  return dir;
-}
-
-// 获取 额外资源目录
-function getExtraResourcesDir() {
-  const execDir = getExecDir();
-  const packaged = isPackaged();
-
-  // 资源路径不同
-  let dir = '';
-  if (packaged) {
-    // 打包后  execDir为 应用程序 exe\dmg\dep软件所在目录；打包前该值是项目根目录
-    // windows和MacOs不一样
-    dir = path.join(execDir, "resources", "extraResources");
-    if (is.macOS()) {
-      dir = path.join(execDir, "..", "Resources", "extraResources");
-    }
-  } else {
-    // 打包前
-    dir = path.join(execDir, "build", "extraResources");
-  }
-  return dir;
-}
-
-// 获取root目录  (dev-项目根目录，pro-app user data目录)
-function getRootDir() {
-  const appDir = isDev() ? getBaseDir() : getAppUserDataDir();
-  return appDir;
-}
-
-// 获取 appUserData目录
-function getAppUserDataDir() {
-  return process.env.EE_APP_USER_DATA;
-}
-
-// 获取 exec目录
-function getExecDir() {
-  return process.env.EE_EXEC_DIR;
-}
-
-// 获取操作系统用户目录
-function getUserHomeDir() {
-  return process.env.EE_USER_HOME;
-}
-
-// 获取用户家目录中的隐藏的app目录
-function getUserHomeHiddenAppDir() {
-  const appnameDir = "." + appName();
-  const dir = path.join(getUserHomeDir(), appnameDir);
-  return dir;
-}
-
-// 获取用户家目录中的app目录
-function getUserHomeAppDir() {
-  const appnameDir = appName();
-  const dir = path.join(getUserHomeDir(), appnameDir);
-  return dir;
-}
-
-// 获取内置socket端口
-function getSocketPort() {
-  return parseInt(process.env.EE_SOCKET_PORT) || 0;
-}
-
-// 获取内置http端口
-function getHttpPort() {
-  return parseInt(process.env.EE_HTTP_PORT) || 0;
-}
-
-// 是否打包
-function isPackaged() {
-  return process.env.EE_IS_PACKAGED === 'true';
-}
-
-// 进程退出
-function exit(code = 0) {
-  return process.exit(code);
-}
-
-// 格式化message
-function makeMessage(msg = {}) {
-  let message = Object.assign({
-    channel: '',
-    event: '', 
-    data: {}
-  }, msg);
-
-  return message;
-}
-
-// 退出ChildJob进程
-function exitChildJob(code = 0) {
-  try {
-    let args = JSON.parse(process.argv[2]);
-    if (args.type == 'childJob') {
-      process.exit(code);
-    }
-  } catch (e) {
-    process.exit(code);
-  }
-}
-
-// 任务类型 ChildJob
-function isChildJob() {
-  try {
-    let args = JSON.parse(process.argv[2]);
-    if (args.type == 'childJob') {
-      return true;
-    }
-  } catch (e) {
-    return false;
-  }
-}
-
-// 任务类型 ChildPoolJob
-function isChildPoolJob() {
-  try {
-    let args = JSON.parse(process.argv[2]);
-    if (args.type == 'childPoolJob') {
-      return true;
-    }
-  } catch (e) {
-    return false;
-  }
-}
-
-// Get cmd parameter by name
-function getArgumentByName(name, args) {
-  if (!args) {
-    args = process.argv;
-  }
-  for (let i = 0; i < args.length; i++) {
-    const item = args[i];
-    const prefixKey = `--${name}=`;
-    if (item.indexOf(prefixKey) !== -1) {
-      return item.substring(prefixKey.length);
-    }
-  }
-}
-
-module.exports = {
-  allEnv,
-  env,
-  isProd,
-  isDev,
-  isRenderer,
-  isMain,
-  isForkedChild,
-  processType,
-  appName,
-  appVersion,
-  getDataDir,
-  getLogDir,
-  getBundleDir,
-  getElectronCodeDir,
-  getFrontendCodeDir,
-  getRootDir,
-  getBaseDir,
-  getElectronDir,
-  getPublicDir,
-  getExtraResourcesDir,
-  getAppUserDataDir,
-  getExecDir,
-  getUserHomeDir,
-  getUserHomeAppDir,
-  getUserHomeHiddenAppDir,
-  getSocketPort,
-  getHttpPort,
-  isPackaged,
-  exit,
-  makeMessage,
-  exitChildJob,
-  isChildJob,
-  isChildPoolJob,
-  getArgumentByName
-}

package/socket/httpServer.d.ts

@@ -1,8 +0,0 @@
-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,199 +0,0 @@
-'use strict';
-
-const debug = require('debug')('ee-core:socket:httpServer');
-const assert = require('assert');
-const is = require('is-type-of');
-const Koa = require('koa');
-const cors = require('koa2-cors');
-const koaBody = require('koa-body');
-const https = require('https');
-const fs = require('fs');
-const path = require('path');
-const _ = require('lodash');
-const { coreLogger } = require('../log');
-const { getBaseDir } = require('../ps');
-const { getController } = require('../controller');
-const { getConfig } = require('../config');
-const { getPort } = require('../utils/port');
-
-let channelSeparator = '/';
-
-/**
- * http server
- */
-class HttpServer {
-  constructor () {
-    const { httpServer, mainServer } = getConfig();
-    this.config = httpServer;
-    channelSeparator = mainServer.channelSeparator;
-    this.httpApp = undefined;
-    this.init();
-  }
-
-  async init() {
-    if (this.config.enable == false) {
-      return;
-    }
-
-    const port = await getPort({port: parseInt(this.config.port)});
-    if (!port) {
-      throw new Error('[ee-core] [socket/HttpServer] http port required, and must be a number !');
-    }
-    process.env.EE_HTTP_PORT = port;
-    this.config.port = port;
-
-    this._create();
-  }
-
-  /**
-   * 创建服务
-   */
-  _create () {
-    const config = this.config;
-    // config.default 增加koaConfig配置项
-    const koaConfig = config.koaConfig || {};
-    const { preMiddleware = [], postMiddleware = [], errorHandler = null } = koaConfig;
-    const isHttps = config?.https?.enable ?? false;
-    const sslOptions = {};
-
-    if (isHttps === true) {
-      config.protocol = 'https://';
-      const keyFile = path.join(getBaseDir(), config.https.key);
-      const certFile = path.join(getBaseDir(), config.https.cert);
-      assert(fs.existsSync(keyFile), 'ssl key file is required');
-      assert(fs.existsSync(certFile), 'ssl cert file is required');
-
-      sslOptions.key = fs.readFileSync(keyFile);
-      sslOptions.cert = fs.readFileSync(certFile);
-    }
-    const url = config.protocol + config.host + ':' + config.port;
-    const corsOptions = config.cors;
-
-    const koaApp = new Koa();
-
-    // 设置错误处理器，便于统一错误代码处理
-    this._setupErrorHandler(koaApp, errorHandler);
-
-    // 加载前置中间件
-    this._loadMiddlewares(koaApp, preMiddleware);
-
-    // 核心中间件
-    koaApp
-      .use(cors(corsOptions))
-      .use(koaBody(config.body))
-      .use(this._dispatch);
-
-    // 加载后置中间件
-    this._loadMiddlewares(koaApp, postMiddleware, 'post');
-
-    let msg = '[ee-core] [socket/http] server is: ' + url;
-    const listenOpt = {
-      host: config.host,
-      port: config.port
-    }
-    if (isHttps) {
-      https.createServer(sslOptions, koaApp.callback()).listen(listenOpt, (err) => {
-        msg = err ? err : msg;
-        coreLogger.info(msg);
-      });
-    } else {
-      koaApp.listen(listenOpt, (e) => {
-        msg = e ? e : msg;
-        coreLogger.info(msg);
-      });
-    }
-
-    this.httpApp = koaApp;
-  }
-
-  /**
-   * 路由分发
-   */
-  async _dispatch (ctx, next) {
-    const controller = getController();
-    const { filterRequest } = getConfig().httpServer;
-    let uriPath = ctx.request.path;
-    const method = ctx.request.method;
-    let params = ctx.request.query;
-    params = is.object(params) ? JSON.parse(JSON.stringify(params)) : {};
-    const body = ctx.request.body;
-
-    // 默认
-    ctx.response.status = 200;
-
-    try {
-      // 找函数
-      // 去除开头的 '/'
-      if (uriPath.indexOf('/') == 0) {
-        uriPath = uriPath.substring(1);
-      }
-      // 过滤
-      if (_.includes(filterRequest.uris, uriPath)) {
-        ctx.response.body = filterRequest.returnData;
-        await next();
-        return
-      }
-      if (uriPath.slice(0, 10) != 'controller') {
-        uriPath = 'controller/' + uriPath;
-      }
-      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(channelSeparator);
-        debug('[findFn] channel %o', actions);
-        let obj = { controller };
-        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(controller, args, ctx);
-      ctx.response.body = result;
-    } catch (err) {
-      coreLogger.error('[ee-core/httpServer] throw error:', err);
-    }
-
-    await next();
-  }
-
-  getHttpApp() {
-    return this.httpApp;
-  }
-
-  // 设置错误处理函数
-  _setupErrorHandler(app, errorHandler) {
-    if (is.function(errorHandler)) {
-      app.on('error', errorHandler)
-    }
-  }
-
-  /**
-   * 加载前置、后置中间件
-   * @param {*} app koaApp示例
-   * @param {*} middlewares 中间件数组
-   * @param {*} type 类型，pre/post
-   */
-  _loadMiddlewares(app, middlewares = [], type = 'pre') {
-    if (is.array(middlewares)) {
-      middlewares.forEach((middleware) => {
-        if (is.function(middleware)) {
-          // middleware是一个方法
-          // 返回值是中间件(ctx, next) => {}的异步函数
-          // 便于使用async/await进行同步编程
-          app.use(middleware());
-        } else {
-          coreLogger.warn(`[ee-core/httpServer] Invalid ${type} middleware detected, skipping.`);
-        }
-      })
-    }
-  }
-}
-
-module.exports = {
-  HttpServer
-};

package/socket/index.d.ts

@@ -1,10 +0,0 @@
-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 };

package/socket/index.js

@@ -1,65 +0,0 @@
-'use strict';
-
-const IoServer = require('socket.io');
-const IoClient = require('socket.io-client');
-const Koa = require('koa');
-const { SocketServer } = require('./socketServer');
-const { HttpServer } = require('./httpServer');
-const { IpcServer } = require('./ipcServer');
-
-const Instance = {
-  socketServer: null,
-  httpServer: null,
-  coreLogger: null,
-};
-
-// create SocketServer
-function createSocketServer() {
-  Instance.socketServer = new SocketServer();
-  return Instance.socketServer;
-}
-
-// socketServer
-function getSocketServer() {
-  return Instance.socketServer;
-}
-
-// create Http Server
-function createHttpServer() {
-  Instance.httpServer = new HttpServer();
-  return Instance.httpServer;
-}
-
-// httpServer
-function getHttpServer() {
-  return Instance.httpServer;
-} 
-
-// create IPC Server
-function createIpcServer() {
-  Instance.ipcServer = new IpcServer();
-  return Instance.ipcServer;
-}
-
-// ipcServer
-function getIpcServer() {
-  return Instance.ipcServer;
-}
-
-
-// load socket server
-function loadSocket() {
-  createSocketServer();
-  createHttpServer();
-  createIpcServer();
-} 
-
-module.exports = {
-  Koa,
-  IoServer,
-  IoClient,
-  loadSocket,
-  getSocketServer,
-  getHttpServer,
-  getIpcServer
-};

package/socket/ipcServer.d.ts

@@ -1,9 +0,0 @@
-export declare class IpcServer {
-    directory: string;
-    loop(obj: any, pathname: string): void;
-    register(exportObj: any, propertyChain: any): void;
-    findFn(controller: any, c: any): {
-        controller: any;
-    };
-    init(): void;
-}

package/socket/ipcServer.js

@@ -1,106 +0,0 @@
-'use strict';
-
-const debug = require('debug')('ee-core:socket:ipcServer');
-const is = require('is-type-of');
-const { ipcMain } = require('electron');
-const { coreLogger } = require('../log');
-const { getController } = require('../controller');
-const { EXPORTS } = require('../core/loader/file_loader');
-const { getConfig } = require('../config');
-
-class IpcServer {
-  constructor () {
-    const { mainServer } = getConfig();
-    this.channelSeparator = mainServer.channelSeparator;
-    this.directory = 'controller';
-    this.init();
-  }
-  init() {
-    const controller = getController();
-    this.loop(controller, this.directory);
-  }
-
-  loop(obj, pathname) {
-    const keys = Object.keys(obj);
-    // debug("[loop] keys: %j", keys);
-    for (const key of keys) {
-      if (key === 'constructor') {
-        continue;
-      }
-      let subObj = obj[key];
-      let propertyChain = pathname + '.' + key;
-      if (subObj && subObj[EXPORTS] === true) {
-        this.register(subObj, propertyChain);
-      } else if (typeof subObj === 'object') {
-        // 如果子对象依然是对象，则递归调用继续判断
-        this.loop(subObj, propertyChain);
-      }
-    }
-  }
-
-  register(exportObj, propertyChain) {
-    const controller = getController();
-    const keys = Object.keys(exportObj);
-    for (const key of keys) {
-      // Supports two types of routing separators
-      // channel: controller.file.function | controller/file/function
-      const tmpChannel = `${propertyChain}.${key}`;
-      const channel = tmpChannel.split('.').join(this.channelSeparator);
-      debug('[register] channel %s', channel);
-
-      // send/on model
-      ipcMain.on(channel, async (event, params) => {
-        try {
-          const fn = this.findFn(controller, channel);
-          const result = await fn.call(controller, params, event);
-
-          event.returnValue = result;
-          event.reply(`${channel}`, result);
-        } catch(e) {
-          coreLogger.error('[ee-core] [socket/IpcServer] send/on throw error:', e);
-        }
-      });
-
-      // invoke/handle model
-      ipcMain.handle(channel, async (event, params) => {
-        try {
-          const fn = this.findFn(controller, channel);
-          const result = await fn.call(controller, params, event);
-
-          return result;
-        } catch(e) {
-          coreLogger.error('[ee-core] [socket/IpcServer] invoke/handle throw error:', e);
-        }
-      });
-    }
-  }
-
-  findFn (controller, c) {
-    try {
-      // 找函数
-      const cmd = c;
-      let fn = null;
-      if (is.string(cmd)) {
-        const actions = cmd.split(this.channelSeparator);
-        debug('[findFn] channel %o', actions);
-        let obj = { controller };
-        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');
-      
-      return fn;
-    } catch (err) {
-      coreLogger.error('[ee-core] [socket/IpcServer] throw error:', err);
-    }
-    return null;
-  }
-
-}
-
-module.exports = {
-  IpcServer
-};

package/socket/socketServer.d.ts

@@ -1,10 +0,0 @@
-import { Server } from "socket.io";
-import { DefaultEventsMap } from "socket.io/dist/typed-events";
-export declare class SocketServer {
-    socket: import("socket.io").Socket<DefaultEventsMap, DefaultEventsMap, DefaultEventsMap, any>;
-    io: Server<DefaultEventsMap, DefaultEventsMap, DefaultEventsMap, any>;
-    config: any;
-    init(): Promise<void>;
-    connect(): void;
-}
-