@gingkoo/base-server 0.0.1-alpha.0 → 0.0.1-alpha.2

package/README.md

@@ -1,2 +1,9 @@
 # base-server
 
+node 基础服务
+
+[文档](http://172.32.68.94:8080/base-server/introduce)
+
+## 打包
+
+记得改下 `/backend/config/index.js  -> isProd = true`

package/app.js

@@ -1,34 +1,28 @@
 const express = require('express');
-const router = require('./common/router');
 const timeout = require('connect-timeout');
 const compression = require('compression');
 const { createServer } = require('http');
-// const { Server } = require('socket.io');
+const { Server } = require('socket.io');
 const cookieParser = require('cookie-parser');
 const xmlparser = require('express-xml-bodyparser');
-// const config = require('@config/index');
-// const { logger } = require('@common/logger/index');
-// const allowCors = require('@common/middleware/cors');
-// const response = require('@common/middleware/response');
-// const { createConnection } = require('@utils/sql-helper/index');
+const { createConnection } = require('@gingkoo/node-tools');
 
-// require('@utils/array');
-
-// var Socket = require('@common/socket');
+const config = require('./backend/config');
+const cors = require('./backend/common/middleware/cors');
+const response = require('./backend/common/middleware/response');
+const router = require('./backend/router');
 
 class App {
-  TIME_OUT = 30 * 1e3; // 超时时间
-
   /**
-   * @param {string} optinos.ip 服务 host
-   * @param {number | string} optinos.port 服务 post
-   * @param {string} optinos.orgid 组织 id
-   *
+   * @param {string} optinos.timeout 超时时间 默认 30s
+   * @param {(app: any, express: any) => void} optinos.beforeRoutes 在前面注册路由
+   * @param {(app: any, express: any) => void} optinos.afterRoutes 在后面注册路由
    */
   constructor(options = {}) {
     this.options = options;
     this.app = express();
     this.httpServer = createServer(this.app);
+    this.TIME_OUT = options.timeout ?? 30 * 1e3; // 超时时间
 
     this.connectDB();
     this.middleware();
@@ -40,17 +34,20 @@ class App {
 
   // 连接数据库
   connectDB() {
-    // createConnection(config.db);
+    if (config.db) {
+      createConnection(config.db);
+    }
   }
 
   // 定时任务
   schedule() {
-    // var schedule = require('@common/schedule');
+    const schedule = require('./backend/common/schedule');
+    schedule.run();
   }
 
   middleware() {
-    // this.app.use(allowCors);
-    // this.app.use(response);
+    this.app.use(cors);
+    this.app.use(response);
     this.app.use((req, res, next) => {
       if (~req.path.indexOf('/sse')) {
         return next();
@@ -69,35 +66,34 @@ class App {
   }
 
   routes() {
-    this.app.use('/static', express.static('static'));
-    // this.app.use('/assets', express.static('dist/assets'));
+    if (this.options.beforeRoutes) {
+      this.options.beforeRoutes(this.app, express);
+    }
     this.app.use('/', router);
+    if (this.options.afterRoutes) {
+      this.options.afterRoutes(this.app, express);
+    }
   }
 
   listenSocket() {
-    // let io = new Server(this.httpServer, {
-    //   transports: ['websocket', 'polling'], // 只使用长轮询
-    //   pingTimeout: 30000,
-    // });
-    // new Socket(io);
+    let io = new Server(this.httpServer, {
+      transports: ['websocket', 'polling'], // 只使用长轮询
+      pingTimeout: 30000,
+      ...config.scoket.config,
+    });
+    var Socket = require('./backend/common/socket');
+    new Socket(io);
   }
 
-  listen(resolve, reject) {
-    let optinos = this.options;
-    global.orgid = optinos.orgid;
-
-    this.httpServer.listen(optinos.port, optinos.ip, () => {
-      console.info(`server running ${optinos.port}`);
-      if (resolve instanceof Function) {
-        resolve('server_started');
-      }
+  listen(cb) {
+    global.orgid = config.orgid;
+    this.httpServer.listen(config.port, config.ip, () => {
+      console.info(`server running http://${config.ip}:${config.port}`);
+      cb?.([false]);
     });
-
     this.httpServer.on('error', (err) => {
       console.error(`server error ${err}`);
-      if (reject instanceof Function) {
-        reject('server error');
-      }
+      cb?.([true, err]);
     });
   }
 }

package/backend/common/entity.js

@@ -0,0 +1,55 @@
+/**
+ * teams 数据库 所有实体表
+ */
+
+const entity = {
+  // -------------- 基础模块 --------------
+  BASE_ATTACHMENTS: 'BASE_ATTACHMENTS', // 文件关联对象表
+  BASE_BG_TASK: 'BASE_BG_TASK', // 后台任务信息表
+  BASE_DICT_MODULE: 'BASE_DICT_MODULE', // 码表模块
+  BASE_DICT: 'BASE_DICT', // 码表模块下的分类
+  BASE_DICT_ITEMS: 'BASE_DICT_ITEMS', // 码表分类下的代码
+  BASE_MODULES: 'BASE_MODULES', // 模块信息表
+  BASE_MODULE_NAV: 'BASE_MODULE_NAV', // 模块菜单信息表
+  BASE_CONFIG: 'BASE_CONFIG', // 一般配置数据表
+  BASE_CONFIG_GROUP: 'BASE_CONFIG_GROUP', // 一般配置分组表
+  BASE_EMAIL_TEMPLATE: 'BASE_EMAIL_TEMPLATE', // 邮件模版
+  BASE_SETUP_NAV: 'BASE_SETUP_NAV', // 系统管理菜单信息
+  BASE_NOTIFI_MESSAGE: 'BASE_NOTIFI_MESSAGE', // 消息通知，消息记录
+  BASE_SEQ_CTL: 'BASE_SEQ_CTL', // 序号生成控制表
+  BASE_API_CONFIG: 'BASE_API_CONFIG', // API配置信息表
+
+  // -------------- 用户模块 --------------
+  IDM_PERMISSIONS: 'IDM_PERMISSIONS', // 权限控制表
+  IDM_GROUPS: 'IDM_GROUPS', // 部门分组表
+  IDM_GROUP_MEMBERS: 'IDM_GROUP_MEMBERS', // 部门分组成员表
+  IDM_ROLES: 'IDM_ROLES', // 用户角色表
+  IDM_ROLE_MEMBERS: 'IDM_ROLE_MEMBERS', // 角色成员表
+  IDM_ORGS: 'IDM_ORGS', // 机构信息表
+  IDM_DEPTS: 'IDM_DEPTS', // 部门表
+  IDM_USERS: 'IDM_USERS', // 用户信息表
+  IDM_USER_SECURITY_PROBLEM: 'IDM_USER_SECURITY_PROBLEM', // 用户密保表
+  IDM_USER_TOKEN: 'IDM_USER_TOKEN', // 用户token表
+  IDM_PERM_PROPS: 'IDM_PERM_PROPS', // 权限属性表
+  IDM_HISTORY_LOG: 'IDM_HISTORY_LOG', // 用户设备登录历史表
+  IDM_USER_OAUTH: 'IDM_USER_OAUTH', // 三方认证用户
+
+  // -------------- 通知模块 --------------
+  NOTICE_LOG: 'NOTICE_LOG', // 通知信息表
+  NOTICE_USER_PERMISSION: 'NOTICE_USER_PERMISSION', // 通知用户权限表
+  NOTICE_MODULE_ITEMS: 'NOTICE_MODULE_ITEMS', // 通知模块内容表
+  NOTICE_MODULES: 'NOTICE_MODULES', // 通知模块表
+
+  // -------------- 企业微信配置 --------------
+  WEWORK_CFG: 'WEWORK_CFG', // 企业微信配置
+  WEWORK_APP_CFG: 'WEWORK_APP_CFG', // 企业微信应用配置
+  WEWORK_MSG_RECV: 'WEWORK_MSG_RECV', // 企业微信接收消息日志
+  WEWORK_MSG_SEND: 'WEWORK_MSG_SEND', // 企业微信发送消息日志
+
+  // -------------- 应用网络配置 --------------
+  APP_NET_CFG: 'APP_NET_CFG', // 应用网络配置
+  APP_NET_ORG: 'APP_NET_ORG', // 应用租户网络
+  APP_NET_STATE: 'APP_NET_STATE', // 应用租户网络状态
+};
+
+module.exports = entity;

package/backend/common/enum.js

@@ -0,0 +1,247 @@
+// fss
+const FILE_TYPE = {
+  IMAGE: 'image',
+  DOC: 'doc',
+};
+const FILE_MODULE = {
+  PROJECT: 'PROJECT',
+  USER: 'USER',
+};
+
+// page
+const PAGE_SECTION = {
+  add: 'BTN_ADD',
+  edit: 'BTN_MOD',
+};
+
+const BRANCH_STATUS = {
+  normal: '00',
+  del: '01',
+  // merged: '02',
+};
+
+// message
+const NOT_STATUS = {
+  normal: '00',
+  notdel: '01',
+};
+
+const NOT_TYPE = {
+  issue_update: 'issue_update', //任务变更
+};
+
+const NOT_IS_READ = {
+  read: 'Y',
+  unread: 'N',
+};
+
+const MSG_TYPE = {
+  issue_update: 'issue_update', // 任务变更
+  issue_comments: 'issue_comment', // 任务评论
+  issue_docx: 'issue_docx', // 任务文件变更
+  issue_image: 'issue_image', // 任务图片变更
+  issue_connect: 'issue_connect', // 任务关联
+};
+
+const MSG_STATUS = {
+  normal: '00', //正常状态
+  fileDel: '02', //任务文件删除，
+  msgDel: '01', //消息删除，但select语句可以查到
+};
+
+const NOT_TITLE = {
+  issue: '工作项变更通知',
+};
+
+const IS_NOTICE = {
+  Y_NOTICE: '00',
+  N_NOTICE: '01',
+};
+
+const ICON_TYPE = {
+  fa: 'fa',
+  antd: 'antd',
+  img: 'image',
+};
+
+const NAV_MODULE_ITEM = {
+  issue_link: '', // 任务相关人员关联到我
+  project_link: '', // 项目负责人关联到我
+  my_issue_update: '', // 我相关的任务变更通知
+  issue_: '', // 任务逾期通知
+  // 邀请加入项目提醒
+  // 团队加入新成员提醒
+  //
+};
+
+const NAV_MODULE_TYPE = {
+  email: 'Email notfications', // 邮件通知
+  weChat: 'Enterprise WeChat notfications', // 企业微信通知
+  web: 'Web Site notfications', // 站内通知
+  // 。。。
+};
+
+const ISSUE_LINK_TYPE_ENUM = {
+  BUG_LINK: 'BUG_LINK', // 缺陷关联
+  EG_LINK: 'EG_LINK', // 用例关联
+  ISSUE_LINK: 'ISSUE_LINK', // 工作项关联
+  PLAN_LINK: 'PLAN_LINK', // 计划关联
+  REQUIRE_LINK: 'REQUIRE_LINK', // 需求关联
+};
+
+const REVIEW_ADVICE_STATUS = {
+  PASS: '通过',
+  NO_PASS: '不通过',
+  N_REVIEW: '未评审',
+  ADVICE: '建议',
+  1: '进行中',
+  Done: '已完成',
+  Doing: '进行中',
+};
+
+const LINK_ISSUE_STATUS = {
+  finish: 'finish', //已完成
+  unfinish: 'unfinish', //未完成
+};
+
+const navTypeMapping = {
+  new_projects: 'new_projects', //新建的项目列表
+  recent_projects: 'recent_projects', //最近访问的项目列表
+  all_projects: 'all_projects', //所有项目列表
+};
+
+const PROJECT_LOG_TYPE = {
+  project: 'project',
+  product: 'product',
+};
+
+// 查询字典树的层级表示
+const DICT_LENVEL_TYPE = {
+  module: 'module', //字典模块
+  dict: 'dict', //字典信息
+};
+
+// 团队成员
+const IDM_LENVEL_TYPE = {
+  DEPT: 'DEPT', //部门
+  GROUP: 'GROUP', //用户组
+};
+const PROJECT_STAGE_RANGE = {
+  ALL_PROJECT: 'ALL_PROJECT', //应用于所有项目
+};
+
+const PROJECT_STAGE_STATUS = {
+  OPEN: 'OPEN', //开启
+  CLOSE: 'CLOSE', //关闭
+};
+
+// 任务阶段状态
+const ISSUE_STAGE_STATUS = {
+  BACKLOG: 'Backlog', //未开始
+  DOING: 'Doing', //进行中
+  DONE: 'Done', //已完成
+};
+
+// 权限操作者类型
+const OPER_TYPE = {
+  ROLE: 'role',
+  USER: 'user',
+  DEPT: 'dept',
+  GROUP: 'group',
+};
+
+const RES_KIND = {
+  API: 'api',
+  PAGE: 'page',
+  FILE: 'file',
+};
+
+const RES_TYPE = {
+  MODULE: 'module', //模块
+  PROJECT_NAV: 'project_nav', //项目管理导航
+  SYSTEM_MODULE: 'system_module', //系统模块
+  SYSTEM_NAV: 'system_nav', //系统导航
+  REQUIREMENT_NAV: 'requirement_nav', //需求导航
+};
+
+// 角色类型
+const ROLE_TYPE = {
+  MANAGER: 'MANAGER',
+  PROJECT: 'PROJECT',
+  REQUIREMENT: 'REQUIREMENT',
+};
+
+const PERMISSION_FEATURE_KIND = {
+  ADD: 'add',
+  EDIT: 'edit',
+  DEL: 'del',
+};
+
+const AUTOMATE_TYPE = {
+  LINK_TASK_AUTOMATE: 'linkTaskAutoMate', //关联任务后触发的自动化规则
+  CREATE_TASK_AUTOMATE: 'createTaskAutomate', //新建任务后触发的自动化规则
+  UPDATE_TASK_AUTOMATE: 'updateTaskAutomate', //修改任务后触发的自动化规则
+  ALL_TASK_AUTOMATE: 'allTaskAutomate', //所有触发的自动化规则
+};
+
+const DEMAND_ROLE = {
+  DEMAND_DEV: 'DEMAND_DEV',
+  DEMAND_BR: 'DEMAND_BR',
+  DEMAND_PM: 'DEMAND_PM',
+};
+
+module.exports = {
+  _issue: {
+    ISSUE_LINK_TYPE_ENUM,
+    AUTOMATE_TYPE,
+  },
+  fss: {
+    FILE_TYPE,
+    FILE_MODULE,
+  },
+  page: {
+    PAGE_SECTION,
+  },
+  project: {
+    BRANCH_STATUS,
+    navTypeMapping,
+    PROJECT_LOG_TYPE,
+    PROJECT_STAGE_RANGE,
+    PROJECT_STAGE_STATUS,
+    ISSUE_STAGE_STATUS,
+  },
+  message: {
+    MSG_STATUS,
+    NOT_IS_READ,
+    MSG_TYPE,
+    NOT_TITLE,
+    NOT_STATUS,
+    NOT_TYPE,
+  },
+  notModule: {
+    IS_NOTICE,
+    ICON_TYPE,
+    NAV_MODULE_ITEM,
+    NAV_MODULE_TYPE,
+  },
+  linkModule: {
+    LINK_ISSUE_STATUS,
+  },
+  reviewModule: {
+    REVIEW_ADVICE_STATUS,
+  },
+  dictLevelType: {
+    DICT_LENVEL_TYPE,
+  },
+  idmLevelType: {
+    IDM_LENVEL_TYPE,
+  },
+  permission: {
+    OPER_TYPE,
+    RES_KIND,
+    ROLE_TYPE,
+    RES_TYPE,
+    PERMISSION_FEATURE_KIND,
+    DEMAND_ROLE,
+  },
+};

package/backend/common/fss/index.js

@@ -0,0 +1,18 @@
+'use strict';
+const express = require('express');
+const { authCheck } = require('../middleware/auth');
+const upload = require('./routers/upload');
+const resources = require('./routers/resources');
+const download = require('./routers/download');
+const attachment = require('./routers/attachment');
+const importExport = require('./routers/import_export');
+
+const router = express.Router();
+
+router.use('/upload', [authCheck], upload); // 上传附件
+router.use('/resources', resources); // 查看资源
+router.use('/download', [authCheck], download); // 下载文件
+router.use('/attachment', [authCheck], attachment); // 查询附件列表
+router.use('/import-export', [authCheck], importExport); // 导入导出
+
+module.exports = router;

package/backend/common/fss/routers/attachment.js

@@ -0,0 +1,45 @@
+'use strict';
+const express = require('express');
+const attachmentService = require('../services');
+
+const { fss } = require('../../enum');
+
+var router = express.Router();
+
+/**
+ * @api {get} /fss/attachment 附件查询
+ * @apiVersion 1.0.0
+ * @apiGroup fss
+ *
+ * @apiQuery {String} id 附件绑定对象id
+ * @apiQuery {String} refId 关联id
+ */
+router.get('/', async function (req, res) {
+  let { id, refId } = req.query;
+
+  if (!id && !refId) {
+    return res.sendOk({ IMAGES: '', FILES: '' });
+  }
+
+  let attachment = await attachmentService.findAttachment({ OBJECT_ID: id, REF_ID: refId });
+
+  let IMAGES = attachment
+    .reduce((mo, v) => {
+      if (v.FILE_KIND === fss.FILE_TYPE.IMAGE) mo.push(`/fss/resources/share/${v.FILE_NAME}`);
+      return mo;
+    }, [])
+    .join(',');
+
+  let FILES = attachment
+    .reduce((mo, v) => {
+      if (v.FILE_KIND === fss.FILE_TYPE.DOC) {
+        mo.push(`/fss/download/share/${v.FILE_NAME}`);
+      }
+      return mo;
+    }, [])
+    .join(',');
+
+  res.sendOk({ IMAGES, FILES });
+});
+
+module.exports = router;

package/backend/common/fss/routers/download.js

@@ -0,0 +1,43 @@
+'use strict';
+const express = require('express');
+
+const { resourcePath } = require('../utils');
+
+var router = express.Router();
+
+// excel导出 fss/download/users/wei.wang1/issues_20220221134006.xlsx
+// 附件下载 /fss/download/share/issues_20220221134006.xlsx
+/**
+ * @api {get} /fss/download/:fileFolder/* 下载文件
+ * @apiVersion 1.0.0
+ * @apiGroup fss
+ *
+ * @apiQuery {string} fileFolder 文件存放文件夹 share | users
+ *
+ */
+router.get('/:fileFolder/*', async function (req, res) {
+  let userid = req.get('X-UserId');
+  let { fileFolder } = req.params;
+
+  let filename = '';
+  if (fileFolder === 'share') {
+    filename = req.path.split('/').slice(-1)[0];
+  } else {
+    filename = req.path.substr();
+  }
+
+  let filePath = resourcePath(userid, fileFolder, filename);
+  if (!filePath) {
+    res.sendErr('rescource not found');
+    return;
+  }
+  filePath = decodeURIComponent(filePath);
+
+  res.download(filePath, (err) => {
+    if (err) {
+      res.sendErr('rescource not found');
+    }
+  });
+});
+
+module.exports = router;

package/backend/common/fss/routers/import_export.js

@@ -0,0 +1,113 @@
+'use strict';
+const express = require('express');
+const path = require('path');
+const multer = require('multer');
+const { v4: uuidv4 } = require('uuid');
+const config = require('../../../config/index');
+const { mkdirPath } = require('../../../utils/path');
+const importExportService = require('../services/import_export');
+
+var router = express.Router();
+
+// 附件存放位置
+const uploadPath = path.join(config.app.home, 'upload');
+
+const multerUpload = multer({
+  storage: multer.diskStorage({
+    destination(req, res, cb) {
+      let dest = mkdirPath(uploadPath);
+      cb(null, dest);
+    },
+    filename(req, file, cb) {
+      let fileName = file.originalname;
+      let fileNameLen = fileName.length;
+      let lastPointIndex = fileName.lastIndexOf('.');
+      let pointIndex = ~lastPointIndex ? lastPointIndex : fileNameLen;
+      let suffixLen = fileNameLen - pointIndex; // 没有后缀为 0
+      let suffixStr = fileName.slice(pointIndex); // 带.
+
+      // 去掉后缀，并限制带上后缀 不超过 56 个字符
+      fileName = fileName.slice(0, Math.min(fileNameLen, 56) - suffixLen);
+
+      function sStr() {
+        return uuidv4()
+          .replaceAll('-', '')
+          .match(/(\w{6})/g)[1];
+      }
+
+      cb(null, `${fileName}__${sStr()}${suffixStr}`);
+    },
+  }),
+});
+
+/**
+ * @api {post} /fss/import-export/excel-import/:moduleId 导入数据
+ * @apiGroup fss
+ *
+ * @apiParams {string} moduleId 模块id
+ * @apiBoby {string} FWD 上传完事之后调哪个 event  (query 也行)
+ * @apiBoby {any} xxx 扩展参数，会原封不动传给 FWD event  (query 也行)
+ */
+router.post('/excel-import/:moduleId', multerUpload.any(), async function (req, res) {
+  let userid = req.get('X-UserId');
+
+  let { moduleId } = req.params;
+
+  let filesInfo = [];
+
+  for (let i in req.files) {
+    let file = req.files[i] || {};
+    let { filename, originalname, encoding, mimetype, destination, fieldname, path, size } = file;
+    let fileInfo = {
+      FILE_NAME: filename,
+      ORIG_NAME: originalname,
+      FILE_ENCODING: encoding,
+      MIME_TYPE: mimetype,
+      UPLOAD_DIR: destination,
+      FIELD_NAME: fieldname,
+      FULL_PATH: path,
+      FILE_SIZE: size,
+      MODULE_ID: moduleId,
+    };
+
+    filesInfo.push(fileInfo);
+  }
+
+  let options = {
+    MODULE_ID: moduleId,
+    ...req.query,
+    ...req.body,
+  };
+
+  let [err, result] = await importExportService.uploadFiles(userid, filesInfo, options);
+  if (err) {
+    return res.sendErr(err?.message || '上传失败');
+  }
+  res.sendOk({ TASK: result.TASK });
+});
+
+/**
+ * @api {post} /fss/import-export/excel-export/:moduleId 导出数据
+ * @apiGroup fss
+ *
+ * @apiParams {string} moduleId 模块id
+ * @apiBoby {string} FWD 上传完事之后调哪个 event  (query 也行)
+ * @apiBoby {any} xxx 扩展参数，会原封不动传给 FWD event (query 也行)
+ */
+router.post('/excel-export/:moduleId', async function (req, res) {
+  let userid = req.get('X-UserId');
+
+  let { moduleId } = req.params;
+  let options = {
+    ...req.query,
+    ...req.body,
+  };
+
+  let [err, result] = await importExportService.downloadFile(userid, moduleId, options);
+  if (err) {
+    return res.sendErr(err?.message || '导出失败');
+  }
+  res.sendOk({ TASK: result.TASK });
+});
+
+module.exports = router;