@pixel-shell/elpis 1.0.0

package/model/index.js

@@ -0,0 +1,86 @@
+const _ = require("lodash");
+const glob = require("glob");
+const path = require("path");
+const { sep } = path;
+// project 继承 model 方法
+const projectExtendModel = (model, project) => {
+  return _.mergeWith({}, model, project, (modelValue, projValue) => {
+    if (Array.isArray(modelValue) && Array.isArray(projValue)) {
+      let result = [];
+      // project有的键值，model也有的话就修改（重载）
+      // project有的键值，model没有的话就新增
+      // model有的键值，project没有的话保留（继承）
+
+      // 处理修改和保留
+      for(let i = 0; i < modelValue.length; i++) {
+        let modelItem = modelValue[i];
+        const projItem = projValue.find((item) => item.key === modelItem.key);
+        result.push(projItem ? projectExtendModel(modelItem, projItem) : modelItem);
+      }
+      // 处理新增
+      for(let i = 0; i < projValue.length; i++) {
+        let projItem = projValue[i];
+        const modelItem = modelValue.find((item) => item.key === projItem.key);
+        if (!modelItem) {
+          result.push(projItem);
+        }
+      }
+
+      return result;
+    }
+  });
+};
+/**
+ * 解析model 配置，并返回阻止且继承后的数据结构
+ *
+ */
+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）
+    const type = file.indexOf(`${sep}project${sep}`) > -1 ? "project" : "model";
+    if (type === "model") {
+      const modelKey = file.match(/\/model\/(.*?)\/model\.js/)?.[1];
+      let modelItem = modelList.find((item) => item.model?.key === modelKey);
+      if (!modelItem) {
+        // 初始化 model 数据结构
+        modelItem = {};
+        modelList.push(modelItem);
+      }
+      modelItem.model = require(path.resolve(file));
+      modelItem.model.key = modelKey; // 挂载 key
+    }
+    if (type === "project") {
+      const modelKey = file.match(/\/model\/(.*?)\/project/)?.[1];
+      const projKey = file.match(/\/project\/(.*?)\.js/)?.[1];
+      const modelItem = modelList.find((item) => item.model?.key === modelKey);
+      if (!modelItem) {
+        // 初始化 model 数据结构
+        modelItem = {};
+        modelList.push(modelItem);
+      }
+      if (!modelItem.project) {
+        // 初始化 project 数据结构
+        modelItem.project = {};
+      }
+      modelItem.project[projKey] = require(path.resolve(file));
+      modelItem.project[projKey].key = projKey; // 挂载 key
+      modelItem.project[projKey].modelKey = modelKey; // 挂载 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,92 @@
+{
+  "name": "@pixel-shell/elpis",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "lint": "eslint --quiet --ext js,vue .",
+    "test": "_ENV='local' mocha 'test/**/*.js'"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://git.code.tencent.com/changdong/Elpis.git"
+  },
+  "author": "小东",
+  "license": "ISC",
+  "dependencies": {
+    "@babel/core": "^7.24.0",
+    "@babel/runtime": "^7.29.7",
+    "@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",
+    "path": "^0.12.7",
+    "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",
+    "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",
+    "happypack": "^5.0.1",
+    "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.6.1",
+    "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",
+    "ghooks": "~1.0.3",
+    "mocha": "^6.1.4",
+    "supertest": "^4.0.2",
+    "validate-commit-msg": "~2.14.0"
+  },
+  "config": {
+    "ghooks": {
+      "commit-msg": "validate-commit-msg",
+      "pre-commit": "pnpm lint"
+    }
+  }
+}

package/test/controller/project.test.js

@@ -0,0 +1,194 @@
+const assert = require("assert");
+const supertest = require("supertest");
+const md5 = require("md5");
+const elpisCore = require("../../elpis-core");
+
+const signKey = "hgy3ghj5gyu03ghjk2ghje3kgu4ghj";
+const st = Date.now();
+
+describe("Project Controller", function () {
+  this.timeout(10000);
+
+  let modelList;
+  const projectList = [];
+
+  let request;
+
+  it("启动服务", async () => {
+    const app = await elpisCore.start();
+    modelList = require("../../model/index.js")(app);
+    modelList.forEach((modelItem) => {
+      const { project } = modelItem;
+      for (const projKey in project) {
+        projectList.push(project[projKey]);
+      }
+    });
+    request = supertest(app.listen());
+  });
+  it("GET /api/project/list without proj_key", async () => {
+    let tmpRes = request.get("/api/project/list");
+    tmpRes = tmpRes.set("s_t", st);
+    tmpRes = tmpRes.set("s_sign", md5(`${signKey}_${st}`));
+    const res = await tmpRes;
+    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)];
+    const { modelKey } = projectList.find((item) => item.key === projKey);
+    let tmpRes = request.get("/api/project/list");
+    tmpRes = tmpRes.set("s_t", st);
+    tmpRes = tmpRes.set("s_sign", md5(`${signKey}_${st}`));
+    tmpRes = tmpRes.query({ proj_key: projKey });
+    const res = await tmpRes;
+    assert(res.body.success === true);
+    const resData = res.body.data;
+    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 without proj_key", async () => {
+    let tmpRes = request.get("/api/project");
+    tmpRes = tmpRes.set("s_t", st);
+    tmpRes = tmpRes.set("s_sign", md5(`${signKey}_${st}`));
+    const res = await tmpRes;
+    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 tmpRes = request.get("/api/project");
+    tmpRes = tmpRes.set("s_t", st);
+    tmpRes = tmpRes.set("s_sign", md5(`${signKey}_${st}`));
+    tmpRes = tmpRes.query({ proj_key: "xxxxxxxxxxxx" });
+    const res = await tmpRes;
+    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;
+
+      let tmpRes = request.get("/api/project");
+      tmpRes = tmpRes.set("s_t", st);
+      tmpRes = tmpRes.set("s_sign", md5(`${signKey}_${st}`));
+      tmpRes = tmpRes.query({ proj_key: projKey });
+      const res = await tmpRes;
+      assert(res.body.success === true);
+      const resData = res.body.data;
+      assert(resData.modelKey);
+      assert(resData.key === projKey);
+      assert(resData.name);
+      assert(resData.desc !== undefined);
+      assert(resData.homePage !== undefined);
+      const { menu } = resData;
+      menu.forEach((menuItem) => {
+        checkMenuItem(menuItem);
+      });
+    }
+
+    function checkMenuItem(menuItem) {
+      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 === "model") {
+        checkModelItem(menuItem);
+      }
+    }
+
+    function checkModelItem(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/model_list", async () => {
+    let tmpRes = request.get("/api/project/model_list");
+    tmpRes = tmpRes.set("s_t", st);
+    tmpRes = tmpRes.set("s_sign", md5(`${signKey}_${st}`));
+    const res = await tmpRes;
+    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);
+      }
+    }
+  });
+});