@domain.js/main 0.1.16 → 0.2.0

package/.eslintrc.js

@@ -8,6 +8,7 @@ module.exports = {
     node: true,
     commonjs: true,
     es6: true,
+    jest: true,
   },
   globals: {
     // Your global variables (setting to false means it's not allowed to be reassigned)

package/dist/http/defines.d.ts

@@ -4,6 +4,7 @@ export interface Cnf {
     host?: string;
     bodyMaxBytes?: number;
     apisRoute?: string;
+    socket?: boolean;
     [propName: string]: any;
 }
 interface Sign {
@@ -28,6 +29,9 @@ export interface Profile {
     uuid?: string;
     token?: string;
     sign?: Sign;
+    isSocket?: boolean;
+    /** socket 的时候汇报自己的位置 */
+    position?: string;
 }
 export interface HttpCodes {
     [propName: string]: number;
@@ -35,9 +39,7 @@ export interface HttpCodes {
 export interface Domain {
     [propName: string]: (profile: Profile, params: any) => any | Domain;
 }
-export interface GetSchemaByPath {
-    (methodPath: string): [any, any];
-}
+export declare type GetSchemaByPath = (methodPath: string) => [any, any];
 export interface Err {
     message: string;
     code?: number | string;

package/dist/http/index.d.ts

@@ -1,8 +1,8 @@
 import * as restify from "restify";
+import { Cnf, Domain, GetSchemaByPath, HttpCodes, Profile } from "./defines";
 import { Router } from "./router";
-import { Cnf, Domain, Profile, HttpCodes, GetSchemaByPath } from "./defines";
 interface Deps {
-    routers(r: ReturnType<typeof Router>): void;
+    routers: (r: ReturnType<typeof Router>) => void;
     domain: Domain;
     httpCodes: HttpCodes;
     getSchemaByPath: GetSchemaByPath;

package/dist/http/index.js

@@ -21,7 +21,9 @@ var __importStar = (this && this.__importStar) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Main = void 0;
 const restify = __importStar(require("restify"));
+const socket_io_1 = require("socket.io");
 const router_1 = require("./router");
+const socket_1 = require("./socket");
 const utils_1 = require("./utils");
 function Main(cnf, deps) {
     const utils = (0, utils_1.Utils)(cnf);
@@ -42,6 +44,11 @@ function Main(cnf, deps) {
         apisRoute: cnf.apisRoute,
     });
     routers(router);
+    // 根据需求起送socket服务
+    if (cnf.socket) {
+        const io = new socket_io_1.Server(server);
+        (0, socket_1.BridgeSocket)(io, domain);
+    }
     // Http server start
     return () => {
         server.listen(cnf.port || 8088, cnf.host || "127.0.0.1", () => {

package/dist/http/router.d.ts

@@ -1,13 +1,13 @@
 import * as restify from "restify";
+import { Domain, GetSchemaByPath, HttpCodes, Profile } from "./defines";
 import { Utils } from "./utils";
-import { HttpCodes, Domain, Profile, GetSchemaByPath } from "./defines";
 interface Deps {
     domain: Domain;
     getSchemaByPath: GetSchemaByPath;
     utils: ReturnType<typeof Utils>;
     server: restify.Server;
     httpCodes: HttpCodes;
-    makeProfileHook?(obj: Profile, req: restify.Request): any;
+    makeProfileHook?: (obj: Profile, req: restify.Request) => any;
     apisRoute?: string;
     swagger?: [any, any];
 }

package/dist/http/router.js

@@ -71,6 +71,7 @@ function Router(deps) {
             next();
         });
     }
+    // eslint-disable-next-line max-params
     function register(verb, route, methodPath, code = 200, isList = false, handler, resHandler) {
         /**
          * 暂存起来，提供给apis接口来用
@@ -93,7 +94,7 @@ function Router(deps) {
             try {
                 let results = await method(profile, params);
                 res.header("X-ConsumedTime", Date.now() - profile.startedAt.valueOf());
-                if (results == null)
+                if (results === null || results === undefined)
                     results = "Ok";
                 if (resHandler) {
                     resHandler(results, res);

package/dist/http/socket.d.ts

@@ -0,0 +1,3 @@
+import { Server } from "socket.io";
+import { Domain } from "./defines";
+export declare function BridgeSocket(io: Server, domain: Domain): void;

package/dist/http/socket.js

@@ -0,0 +1,134 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BridgeSocket = void 0;
+const proxyIps = new Set(["127.0.0.1"]);
+class MyError extends Error {
+    constructor(code, message, data) {
+        super(message);
+        this.code = code;
+        this.data = data;
+    }
+}
+const utils = {
+    /** 真实的连接请求端ip */
+    remoteIp(client) {
+        return client.handshake.address;
+    },
+    /**
+     * 获取客户端真实ip地址
+     */
+    clientIp(client) {
+        const { headers } = client.handshake;
+        const clientIp = headers["x-forwarded-for"] || headers["x-real-ip"] || utils.remoteIp(client);
+        if (Array.isArray(clientIp))
+            return clientIp[0];
+        return clientIp.split(",")[0];
+    },
+    /**
+     * 获取可信任的真实ip
+     */
+    realIp(client) {
+        const remoteIp = utils.remoteIp(client);
+        if (!proxyIps.has(remoteIp))
+            return remoteIp;
+        const realIp = client.handshake.headers["x-real-ip"] || remoteIp;
+        if (Array.isArray(realIp))
+            return realIp[0];
+        return realIp.split(",")[0];
+    },
+};
+const makeProfile = (client, token, params, extra) => {
+    const obj = {
+        token,
+        clientIp: utils.clientIp(client),
+        remoteIp: utils.remoteIp(client),
+        realIp: utils.realIp(client),
+        isSocket: true,
+        startedAt: new Date(),
+        userAgent: client.handshake.headers["user-agent"] || "Not captured",
+        requestId: client.id,
+        /** 客户端发布号 */
+        revision: params.revision,
+        /** 用户uuid 可以长期跨app */
+        uuid: params.uuid,
+        /** 额外信息，自由扩展 */
+        extra,
+    };
+    return obj;
+};
+function BridgeSocket(io, domain) {
+    const subscribe = domain["message.subscribe"];
+    const unsubscribe = domain["message.unsubscribe"];
+    if (!subscribe)
+        throw Error("要启用 socket 服务，必须要要有 message.subscribe 方法，用来处理 socket 订阅");
+    if (!unsubscribe)
+        throw Error("要启用 socket 服务，必须要要有 message.unsubscribe 方法，用来处理 socket 退订");
+    io.on("connection", (client) => {
+        console.log("[%s] connection: client.id: %s", new Date(), client.id);
+        client.on("init", async (token, params, extra) => {
+            console.log("[%s] socket.init: client.id: %s", new Date(), client.id);
+            if (!token) {
+                client.emit("initError", "Token lost");
+                return;
+            }
+            try {
+                Object.assign(client, { profile: makeProfile(client, token, params, extra) });
+                if (!client.profile)
+                    throw new MyError("noAuth", "请先登录");
+                const session = await domain["auth.session"](client.profile, {});
+                // 创建消息监听函数
+                if (!client.listener)
+                    client.listener = client.emit.bind(client);
+                // 向领域注册改用户的监听函数
+                domain["message.subscribe"](client.profile, client.listener);
+                client.emit("inited", session);
+            }
+            catch (e) {
+                if (e instanceof MyError) {
+                    client.emit("internalError", e.message, e.code || "unknown");
+                    return;
+                }
+                console.error(e);
+            }
+        });
+        client.use(async ([name, params, responseId], next) => {
+            if (name === "init")
+                return next();
+            const method = domain[name];
+            try {
+                if (!method)
+                    throw new MyError("notFound", "不存在该领域方法");
+                if (!client.profile)
+                    throw new MyError("noAuth", "请先执行 init");
+                const res = await method(client.profile, params);
+                if (responseId) {
+                    client.emit("response", responseId, res);
+                }
+            }
+            catch (e) {
+                if (e instanceof Error) {
+                    if (responseId) {
+                        client.emit("responseError", responseId, e.code, e.message, e.data);
+                    }
+                    else {
+                        client.emit(`${name}Error`, e.code, e.message, e.data);
+                    }
+                }
+                else {
+                    console.error(e);
+                }
+            }
+            return next();
+        });
+        // 掉线
+        client.on("disconnect", () => {
+            if (!client.profile)
+                return;
+            if (!client.listener)
+                return;
+            // 这里要取消对领域消息的监听
+            unsubscribe(client.profile, client.listener);
+        });
+    });
+}
+exports.BridgeSocket = BridgeSocket;

package/dist/http/utils.d.ts

@@ -15,7 +15,7 @@ export declare function Utils(cnf: Cnf): {
     /**
      * 构造profile参数
      */
-    makeProfile(req: restify.Request, method: string, customFn?: Function | undefined): Readonly<Profile>;
+    makeProfile<T extends {} = {}>(req: restify.Request, method: string, customFn?: ((obj: Profile, req: restify.Request) => T) | undefined): Profile & T;
     /**
      * 构造领域方法所需的 params 参数
      */

package/dist/http/utils.js

@@ -18,14 +18,17 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __setModuleDefault(result, mod);
     return result;
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Utils = void 0;
-const os = __importStar(require("os"));
-const fs = __importStar(require("fs"));
 const crypto = __importStar(require("crypto"));
-const _ = __importStar(require("lodash"));
-const xlsx = __importStar(require("xlsx"));
 const csv_stringify_1 = require("csv-stringify");
+const fs = __importStar(require("fs"));
+const lodash_1 = __importDefault(require("lodash"));
+const os = __importStar(require("os"));
+const xlsx = __importStar(require("xlsx"));
 const str2arr = ["_includes", "dimensions", "metrics", "_attrs"];
 const enc = encodeURI;
 const TMPDIR = os.tmpdir();
@@ -103,7 +106,7 @@ function Utils(cnf) {
          */
         makeParams(req) {
             let params = { ...req.params, ...req.query };
-            if (_.isObject(req.body) && !Array.isArray(req.body)) {
+            if (lodash_1.default.isObject(req.body) && !Array.isArray(req.body)) {
                 params = { ...req.body, ...params };
             }
             else if (req.body) {
@@ -111,10 +114,10 @@ function Utils(cnf) {
             }
             // 逗号分隔的属性，自动转换为 array
             for (const k of str2arr) {
-                if (params[k] && _.isString(params[k]))
+                if (params[k] && lodash_1.default.isString(params[k]))
                     params[k] = params[k].split(",");
             }
-            if (_.size(req.files))
+            if (lodash_1.default.size(req.files))
                 params.__files = req.files;
             return params;
         },
@@ -124,9 +127,9 @@ function Utils(cnf) {
          */
         async outputCSV(rows, params, res, isXLSX = false) {
             const { _names, _cols, _filename } = params;
-            if (!_.isString(_cols))
+            if (!lodash_1.default.isString(_cols))
                 return false;
-            if (_names && !_.isString(_names))
+            if (_names && !lodash_1.default.isString(_names))
                 return false;
             const keys = _cols.split(",");
             const titles = (_names || _cols).split(",");
@@ -156,7 +159,7 @@ function Utils(cnf) {
                 await new Promise((resolve) => {
                     const stream = (0, csv_stringify_1.stringify)(rows, {
                         header: true,
-                        columns: _.zipObject(keys, titles),
+                        columns: lodash_1.default.zipObject(keys, titles),
                     });
                     stream.pipe(res);
                     stream.on("end", resolve);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@domain.js/main",
-  "version": "0.1.16",
+  "version": "0.2.0",
   "description": "DDD framework",
   "main": "dist/index.js",
   "bin": {
@@ -13,7 +13,7 @@
     "prepare": "husky install",
     "lint-staged": "lint-staged",
     "lint-staged:js": "eslint --ext .js,.ts",
-    "loadDeps": "ts-node src/cli/index.ts loadDeps ./ ts"
+    "loadDeps": "ts-node src/cli/index.ts loadDeps ./src/deps ts"
   },
   "author": "Redstone Zhao",
   "license": "MIT",
@@ -78,6 +78,7 @@
     "restify": "^8.6.0",
     "restify-errors": "^8.0.2",
     "sequelize": "6.16.1",
+    "socket.io": "^4.4.1",
     "type-fest": "^2.8.0",
     "uuid": "^8.3.2",
     "xlsx": "^0.17.4"