@juge0218/elpis 1.0.1

package/index.js

@@ -0,0 +1,38 @@
+
+// 引入elpis-core
+const ElpisCore = require("./elpis-core")
+// 引入 前端工程化构建方法
+const FEBuildDev = require("./app/webpack/dev.js")
+const FEBuildProd = require("./app/webpack/prod.js")
+
+module.exports = {
+  /**
+   * 服务端基础
+   */
+  Controller: {
+    Base: require('./app/controller/base.js')
+  },
+  Service: {
+    Base: require('./app/service/base.js')
+  },
+  /**
+   * 编译构建前端工程
+   * @param env 环境变量 local/production
+   */
+  frontendBuild (env) {
+    if (env === 'local') {
+      FEBuildDev()
+    } else if (env === 'production') {
+      FEBuildProd()
+    }
+  },
+  /**
+   * 启动 elpis
+   * @param {object} options 项目配置,透传 elpis-core
+   */
+  serverStart () {
+    const app = ElpisCore.start()
+    return app
+  },
+
+}

package/model/index.js

@@ -0,0 +1,111 @@
+const glob = require('glob')
+const path = require('path')
+const { sep } = path
+const _ = require('lodash')
+
+//project 继承 model 方法
+const projectExtendModel = (model, project) => {
+  return _.mergeWith({}, model, project, (modelValue, projValue) => {
+    //处理数组合并的特殊情况
+    if (_.isArray(modelValue) && _.isArray(projValue)) {
+      let result = []
+
+      // 因为 project 继承 model ，所以需要处理修改和新增的内容
+      // project有的键值，model也有=>修改
+      // project有的键值，model没有=>新增
+      // model有的键值，project没有=>保留（继承）
+
+      // 处理修改
+      for (let i = 0; i < modelValue.length; i++) {
+        const modelItem = modelValue[i]
+        const projItem = projValue.find(item => item.key === modelItem.key)
+        // project有的键值，model也有,则递归调用 projectExtendModel 方法覆盖修改
+        result.push(projItem ? projectExtendModel(modelItem, projItem) : modelItem)
+      }
+      // 处理新增
+      for (let i = 0; i < projValue.length; i++) {
+        const projItem = projValue[i]
+        const modelItem = modelValue.find(item => item.key === projItem.key)
+        if (!modelItem) {
+          result.push(projItem)
+        }
+      }
+
+      return result
+    }
+  })
+}
+/**
+ * 解析 model 配置 ，并返回组织且继承后的数据结构
+ * [{
+    * model:${model}
+    * project:{
+    * proj1Key:${proj1},
+    * proj2Key:${proj2},
+ * }...]
+ */
+module.exports = (app) => {
+  const modelList = []
+
+  // 遍历当前文件夹，构造模型数据结构，加入到 modelList
+  const modelPath = path.resolve(process.cwd(), `.${sep}model`)
+  const fileList = glob.sync(path.resolve(modelPath, `.${sep}**${sep}**.js`))
+
+  fileList.forEach(file => {
+    if (file.indexOf('index.js') > -1) return
+
+    // 区分配置类型 (model / project)
+    // 将路径标准化为统一的正斜杠，避免 Windows 下的反斜杠影响匹配
+    // 说明：部分环境中 glob 已返回正斜杠，此处再次标准化以提高稳健性
+    const unixFile = file.replace(/\\/g, "/");
+
+    // 仅匹配以 /model/<key>/project/<name>.js 结尾，避免 "D:/project" 被误判为项目目录
+    const isProject = /\/model\/[^/]+\/project\/[^/]+\.js$/i.test(unixFile);
+
+    // 仅匹配以 /model/<key>/model.js 结尾
+    const isModel = /\/model\/[^/]+\/model\.js$/i.test(unixFile);
+    const type = isProject ? "project" : isModel ? "model" : "unknown";
+
+    // 非上述两类文件不在解析范围内，忽略
+    if (type === "unknown") return
+
+    if (type === 'project') {
+      // console.log(file, 'project');
+      const modelKey = file.match(/\/model\/(.*?)\/project/)?.[1]
+      const projKey = file.match(/\/project\/(.*?)\.js$/)?.[1]
+      let modelItem = modelList.find(item => item.model?.key === modelKey)
+      if (!modelItem) {//初始化 model 数据结构
+        modelItem = {}
+        modelList.push(modelItem)
+      }
+      if (!modelItem.project) {//初始化 model.project 数据结构
+        modelItem.project = {}
+      }
+      modelItem.project[projKey] = require(path.resolve(file))
+      modelItem.project[projKey].key = projKey//注入 
+      modelItem.project[projKey].modelKey = modelKey
+    }
+
+    if (type === 'model') {
+      // console.log(file, 'model');
+      const modelKey = file.match(/\/model\/(.*?)\/model\.js$/)?.[1]
+      let modelItem = modelList.find(item => item.model?.key === modelKey)
+      if (!modelItem) {
+        modelItem = {}
+        modelList.push(modelItem)
+      }
+      modelItem.model = require(path.resolve(file))
+      modelItem.model.key = modelKey
+    }
+  })
+
+  // 数据进一步整理 ：project=>继承model
+  modelList.forEach(item => {
+    const { model, project } = item
+    for (const key in project) {
+      project[key] = projectExtendModel(model, project[key])
+    }
+  })
+
+  return modelList
+}

package/package.json

@@ -0,0 +1,88 @@
+{
+  "name": "@juge0218/elpis",
+  "version": "1.0.1",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "lint": "eslint --quiet --ext js,vue .",
+    "test": "cross-env _ENV=local mocha 'test/**/*.js'"
+  },
+  "author": "居葛",
+  "license": "ISC",
+  "dependencies": {
+    "@babel/core": "^7.24.0",
+    "@babel/runtime": "^7.24.0",
+    "@element-plus/icons-vue": "^2.3.2",
+    "ajv": "^6.10.2",
+    "axios": "^0.19.2",
+    "echarts": "^5.5.0",
+    "element-plus": "^2.3.7",
+    "generate-password": "^1.7.1",
+    "glob": "^7.1.4",
+    "jsonwebtoken": "^9.0.2",
+    "knex": "^0.19.0",
+    "koa": "2.7.0",
+    "koa-bodyparser": "^4.2.1",
+    "koa-nunjucks-2": "^3.0.2",
+    "koa-router": "^7.4.0",
+    "koa-static": "^5.0.0",
+    "koa-useragent": "2.0.0",
+    "koa2-cors": "^2.0.6",
+    "less": "^3.8.1",
+    "lodash": "^4.17.21",
+    "log4js": "^6.9.1",
+    "md5": "^2.2.1",
+    "moment": "^2.29.4",
+    "mysql": "^2.18.1",
+    "node-schedule": "^2.1.1",
+    "nodemon": "^1.19.2",
+    "pinia": "^2.1.6",
+    "superagent": "^8.1.2",
+    "vue": "^3.3.4",
+    "vue-json-viewer": "^3.0.4",
+    "vue-router": "^4.2.4",
+    "vuex": "^4.1.0",
+    "@babel/plugin-transform-runtime": "^7.1.0",
+    "@babel/preset-env": "^7.4.5",
+    "babel-loader": "^8.0.4",
+    "clean-webpack-plugin": "^0.1.19",
+    "consoler": "^0.2.0",
+    "cross-env": "^7.0.3",
+    "css-loader": "^0.23.1",
+    "css-minimizer-webpack-plugin": "^5.0.1",
+    "directory-named-webpack-plugin": "^4.0.1",
+    "express": "^4.18.2",
+    "file-loader": "^6.2.0",
+    "html-webpack-inject-attributes-plugin": "^1.0.1",
+    "html-webpack-plugin": "^5.5.3",
+    "less-loader": "^11.1.3",
+    "mini-css-extract-plugin": "^2.7.6",
+    "style-loader": "^0.14.1",
+    "terser-webpack-plugin": "^5.3.10",
+    "thread-loader": "^4.0.4",
+    "url-loader": "^4.1.1",
+    "vue-loader": "^17.2.2",
+    "vue-style-loader": "^4.1.2",
+    "webpack": "^5.88.1",
+    "webpack-dev-middleware": "^6.1.1",
+    "webpack-hot-middleware": "^2.25.4",
+    "webpack-merge": "^4.2.1"
+  },
+  "devDependencies": {
+    "assert": "^2.0.0",
+    "babel-eslint": "^10.0.2",
+    "eslint": "^7.32.0",
+    "eslint-plugin-import": "^2.28.1",
+    "eslint-plugin-vue": "^9.17.0",
+    "mocha": "^6.1.4",
+    "ghooks": "~1.0.3",
+    "supertest": "^4.0.2",
+    "validate-commit-msg": "~2.14.0"
+  },
+  "config": {
+    "ghooks": {
+      "pre-commit": "npm run lint",
+      "commit-msg": "validate-commit-msg"
+    }
+  }
+}

package/test/controller/project.test.js

@@ -0,0 +1,208 @@
+const assert = require('assert');
+const supertest = require('supertest');
+const md5 = require('md5');
+const elpisCore = require('../../elpis-core');
+
+const signKey = 'klx05hb3n1c9ujp8uhxbs2ikkiowp212'
+const st = Date.now();
+
+describe('测试 project 相关接口', function () {
+  this.timeout(60000);
+
+  let modelList
+
+  let projectList = []
+
+  let request
+
+  it('启动服务', async () => {
+    const app = await elpisCore.start()
+    modelList = require('../../model/index.js')(app)
+    modelList.forEach(modelItem => {
+      const { project } = modelItem
+      for (const pKey in project) {
+        projectList.push(project[pKey])
+      }
+    })
+    request = supertest(app.listen())
+  })
+
+  it('GET /api/project without proj_key', async () => {
+    let tmpRequest = request.get('/api/project')
+    tmpRequest.set('s_t', st)
+    tmpRequest.set('s_sign', md5(`${signKey}_${st}`))
+    const res = await tmpRequest
+
+    assert(res.body.success === false)
+
+    const resBody = res.body
+    assert(resBody.code === 442)
+    assert(resBody.message.indexOf(`request validate fail: data should have required property 'proj_key'`) > -1)
+  })
+
+  it('GET /api/project fail', async () => {
+    let tmpRequest = request.get('/api/project')
+    tmpRequest.set('s_t', st)
+    tmpRequest.set('s_sign', md5(`${signKey}_${st}`))
+    tmpRequest.query({
+      proj_key: 'xxxxxxxx'
+    })
+    const res = await tmpRequest
+
+    assert(res.body.success === false)
+
+    const resBody = res.body
+    assert(resBody.code === 50000)
+    assert(resBody.message === `获取项目异常`)
+  })
+
+  it('GET /api/project with proj_key', async () => {
+    for (let i = 0; i < projectList.length; i++) {
+      const projItem = projectList[i]
+      const { key: projKey } = projItem
+      console.log(`GET /api/project with proj_key: ${projKey}`);
+      let tmpRequest = request.get('/api/project')
+      tmpRequest.set('s_t', st)
+      tmpRequest.set('s_sign', md5(`${signKey}_${st}`))
+      tmpRequest.query({
+        proj_key: projKey
+      })
+      const res = await tmpRequest
+
+      assert(res.body.success === true)
+
+      const resData = res.body.data
+      assert(resData.key === projKey)
+      assert(resData.modelKey)
+      assert(resData.name)
+      assert(resData.desc !== undefined)
+      assert(resData.homePage !== undefined)
+
+      const { menu } = resData
+      menu.forEach(menuItem => {
+        checkMenuItem(menuItem)
+      })
+    }
+
+    // 检查 menu 菜单
+    function checkMenuItem (menuItem) {
+      console.log(`-------'GET /api/project with proj_key - menuKey: ${menuItem.key}`);
+      assert(menuItem.key)
+      assert(menuItem.name)
+      assert(menuItem.menuType)
+      if (menuItem.menuType === 'group') {
+        assert(menuItem.subMenu !== undefined)
+        menuItem.subMenu.forEach(subMenuItem => {
+          checkMenuItem(subMenuItem)
+        })
+      }
+      if (menuItem.menuType === 'module') {
+        checkModule(menuItem)
+      }
+    }
+    // 检查 module 菜单配置
+    function checkModule (menuItem) {
+      const { moduleType } = menuItem
+      assert(moduleType)
+      if (moduleType === 'sider') {
+        const { siderConfig } = menuItem
+        assert(siderConfig)
+        assert(siderConfig.menu)
+        siderConfig.menu.forEach(siderMenuItem => {
+          checkMenuItem(siderMenuItem)
+        })
+      }
+      if (moduleType === 'iframe') {
+        const { iframeConfig } = menuItem
+        assert(iframeConfig)
+        assert(iframeConfig.path !== undefined)
+      }
+      if (moduleType === 'custom') {
+        const { customConfig } = menuItem
+        assert(customConfig)
+        assert(customConfig.path !== undefined)
+      }
+      if (moduleType === 'schema') {
+        const { schemaConfig } = menuItem
+        assert(schemaConfig)
+        assert(schemaConfig.api !== undefined)
+        assert(schemaConfig.schema)
+      }
+    }
+  })
+
+  it('GET /api/project/list with proj_key', async () => {
+    let tmpRequest = request.get('/api/project/list')
+    tmpRequest.set('s_t', st)
+    tmpRequest.set('s_sign', md5(`${signKey}_${st}`))
+    const res = await tmpRequest
+
+    assert(res.body.success === true)
+
+    const resData = res.body.data
+    assert(resData.length === projectList.length)
+
+    for (let i = 0; i < resData.length; i++) {
+      const item = resData[i]
+      assert(item.modelKey)
+      assert(item.key)
+      assert(item.name)
+      assert(item.desc !== undefined)
+      assert(item.homePage !== undefined)
+    }
+  })
+
+  it('GET /api/project/list with proj_key', async () => {
+
+    const { key: projKey } = projectList[Math.floor(Math.random() * projectList.length)]
+
+    let tmpRequest = request.get('/api/project/list')
+    tmpRequest.set('s_t', st)
+    tmpRequest.set('s_sign', md5(`${signKey}_${st}`))
+    tmpRequest.query({
+      proj_key: projKey
+    })
+    const res = await tmpRequest
+
+    assert(res.body.success === true)
+
+    const resData = res.body.data
+
+    const { modelKey } = projectList.find(item => item.key === projKey)
+
+    assert(projectList.filter(item => item.modelKey === modelKey).length === resData.length)
+
+    for (let i = 0; i < resData.length; i++) {
+      const item = resData[i]
+      assert(item.modelKey)
+      assert(item.key)
+      assert(item.name)
+      assert(item.desc !== undefined)
+      assert(item.homePage !== undefined)
+    }
+  })
+
+  it('GET /api/project/model_list', async () => {
+    let tmpRequest = request.get('/api/project/model_list')
+    tmpRequest.set('s_t', st)
+    tmpRequest.set('s_sign', md5(`${signKey}_${st}`))
+    const res = await tmpRequest
+
+    assert(res.body.success === true)
+
+    const resData = res.body.data
+    assert(resData.length > 0)
+
+    for (let i = 0; i < resData.length; i++) {
+      const item = resData[i]
+      assert(item.model)
+      assert(item.model.key)
+      assert(item.model.name)
+      assert(item.project)
+      for (const projKey in item.project) {
+        assert(item.project[projKey].key)
+        assert(item.project[projKey].name)
+      }
+    }
+  })
+})