melo-sample-websocket-chat-game-server 1.7.6

package/.vscode/launch.json

@@ -0,0 +1,45 @@
+{
+    // 使用 IntelliSense 了解相关属性。 
+    // 悬停以查看现有属性的描述。
+    // 欲了解更多信息，请访问: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "type": "node",
+            "request": "launch",
+            "name": "LaunchMaster",
+            "program": "${workspaceFolder}\\dist\\app.js",
+            "outFiles": [
+                "${workspaceFolder}/**/*.js"
+            ]
+        },
+        {
+            "type": "node",
+            "request": "attach",
+            "name": "Attach to Connector",
+            "address": "127.0.0.1",
+            "port": 10001,
+            "localRoot": "${workspaceFolder}",
+            "remoteRoot": "${workspaceFolder}"
+        },
+        {
+            "type": "node",
+            "request": "attach",
+            "name": "Attach to Chat",
+            "address": "127.0.0.1",
+            "port": 10002,
+            "localRoot": "${workspaceFolder}",
+            "remoteRoot": "${workspaceFolder}"
+        },
+        {
+            "type": "node",
+            "request": "attach",
+            "name": "Attach to Gate",
+            "address": "127.0.0.1",
+            "port": 10003,
+            "localRoot": "${workspaceFolder}",
+            "remoteRoot": "${workspaceFolder}"
+        }
+
+    ]
+}

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 node-melo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/app/servers/chat/handler/chatHandler.ts

@@ -0,0 +1,45 @@
+import { ChatRemote } from '../remote/chatRemote';
+import {Application, BackendSession} from '@bigtyphoon/melo';
+import { FrontendSession } from '@bigtyphoon/melo';
+
+export default function(app: Application) {
+    return new ChatHandler(app);
+}
+
+export class ChatHandler {
+    constructor(private app: Application) {
+    }
+
+    /**
+     * Send messages to users
+     *
+     * @param {Object} msg message from client
+     * @param {Object} session
+     *
+     */
+    async send(msg: {content: string , target: string}, session: BackendSession) {
+        let rid = session.get('rid');
+        let username = session.uid.split('*')[0];
+        let channelService = this.app.get('channelService');
+        let param = {
+            msg: msg.content,
+            from: username,
+            target: msg.target
+        };
+        let channel = channelService.getChannel(rid, false);
+
+        // the target is all users
+        if (msg.target === '*') {
+            channel.pushMessage('onChat', param);
+        }
+        // the target is specific user
+        else {
+            let tuid = msg.target + '*' + rid;
+            let tsid = channel.getMember(tuid)['sid'];
+            channelService.pushMessageByUids('onChat', param, [{
+                uid: tuid,
+                sid: tsid
+            }]);
+        }
+    }
+}

package/app/servers/chat/lifecycle.ts

@@ -0,0 +1,27 @@
+import { ILifeCycle, Application } from '@bigtyphoon/melo';
+
+export default function () {
+    return new Lifecycle();
+}
+
+
+class Lifecycle implements ILifeCycle {
+    beforeStartup(app: Application, cb: () => void): void {
+        console.log(app.getServerId(), '!!!before startup');
+        cb();
+    }
+
+    afterStartup(app: Application, cb: () => void): void {
+        console.log(app.getServerId(), '!!afterStartup');
+        cb();
+    }
+
+    afterStartAll(app: Application): void {
+        console.log(app.getServerId(), '!!after start all');
+    }
+
+    beforeShutdown(app: Application, shutDown: () => void, cancelShutDownTimer: () => void) {
+        console.log(app.getServerId(), '!!beforeShutdown');
+        shutDown();
+    }
+}

package/app/servers/chat/remote/chatRemote.ts

@@ -0,0 +1,105 @@
+import { Application, ChannelService, RemoterClass, FrontendSession } from '@bigtyphoon/melo';
+
+export default function (app: Application) {
+    return new ChatRemote(app);
+}
+
+// UserRpc的命名空间自动合并
+declare global {
+    interface UserRpc {
+        chat: {
+            chatRemote: RemoterClass<FrontendSession, ChatRemote>;
+        };
+    }
+}
+
+// 如果有多个remote文件。需要在各自的remote文件内定义rpc的话。可以这样定义，解决定义被覆盖的问题。
+/**
+ // UserRpc的命名空间自动合并
+ declare global {
+    interface RemoterChat {
+        chatRemote: RemoterClass<FrontendSession, ChatRemote>;
+    }
+
+    interface UserRpc {
+        chat: RemoterChat;
+    }
+}
+
+ */
+export class ChatRemote {
+
+    constructor(private app: Application) {
+        this.app = app;
+        this.channelService = app.get('channelService');
+    }
+
+    private channelService: ChannelService;
+
+    /**
+     * Add user into chat channel.
+     *
+     * @param {String} uid unique id for user
+     * @param {String} sid server id
+     * @param {String} name channel name
+     * @param {boolean} flag channel parameter
+     *
+     */
+    public async add(uid: string, sid: string, name: string, flag: boolean) {
+        let channel = this.channelService.getChannel(name, flag);
+        let username = uid.split('*')[0];
+        let param = {
+            user: username
+        };
+        console.log('send on add', param);
+        channel.pushMessage('onAdd', param);
+
+        if (!!channel) {
+            channel.add(uid, sid);
+        }
+
+        return this.get(name, flag);
+    }
+
+    /**
+     * Get user from chat channel.
+     *
+     * @param {Object} opts parameters for request
+     * @param {String} name channel name
+     * @param {boolean} flag channel parameter
+     * @return {Array} users uids in channel
+     *
+     */
+    private get(name: string, flag: boolean) {
+        let users: string[] = [];
+        let channel = this.channelService.getChannel(name, flag);
+        if (!!channel) {
+            users = channel.getMembers();
+        }
+        for (let i = 0; i < users.length; i++) {
+            users[i] = users[i].split('*')[0];
+        }
+        return users;
+    }
+
+    /**
+     * Kick user out chat channel.
+     *
+     * @param {String} uid unique id for user
+     * @param {String} sid server id
+     * @param {String} name channel name
+     *
+     */
+    public async kick(uid: string, sid: string, name: string) {
+        let channel = this.channelService.getChannel(name, false);
+        // leave channel
+        if (!!channel) {
+            channel.leave(uid, sid);
+        }
+        let username = uid.split('*')[0];
+        let param = {
+            user: username
+        };
+        channel.pushMessage('onLeave', param);
+    }
+}

package/app/servers/connector/handler/entryHandler.ts

@@ -0,0 +1,63 @@
+import {Application} from '@bigtyphoon/melo';
+import {FrontendSession} from '@bigtyphoon/melo';
+
+export default function (app: Application) {
+    return new EntryHandler(app);
+}
+
+export class EntryHandler {
+    constructor(private app: Application) {
+    }
+
+
+    /**
+     * New client entry chat server.
+     *
+     * @param  {Object}   msg     request message
+     * @param  {Object}   session current session object
+     */
+    async enter(msg: { rid: string, username: string }, session: FrontendSession) {
+        let self = this;
+        let rid = msg.rid;
+        let uid = msg.username + '*' + rid;
+        let sessionService = self.app.get('sessionService');
+
+        // duplicate log in
+        if (!!sessionService.getByUid(uid)) {
+            return {
+                code: 500,
+                error: true
+            };
+        }
+
+        await session.abind(uid);
+        session.set('rid', rid);
+        session.push('rid', function (err) {
+            if (err) {
+                console.error('set rid for session service failed! error is : %j', err.stack);
+            }
+        });
+        session.on('closed', this.onUserLeave.bind(this));
+
+        // put user into channel
+        let users = await self.app.rpc.chat.chatRemote.add.route(session)(uid, self.app.get('serverId'), rid, true);
+
+        return {
+            users: users
+        };
+    }
+
+    /**
+     * User log out handler
+     *
+     * @param {Object} app current application
+     * @param {Object} session current session object
+     *
+     */
+    onUserLeave(session: FrontendSession) {
+        if (!session || !session.uid) {
+            return;
+        }
+        this.app.rpc.chat.chatRemote.kick.route(session, true)(session.uid, this.app.get('serverId'), session.get('rid'));
+    }
+}

package/app/servers/connector/lifecycle.ts

@@ -0,0 +1,27 @@
+import { ILifeCycle, Application } from '@bigtyphoon/melo';
+
+export default function () {
+    return new Lifecycle();
+}
+
+
+class Lifecycle implements ILifeCycle {
+    beforeStartup(app: Application, cb: () => void): void {
+        console.log(app.getServerId(), '!!!before startup');
+        cb();
+    }
+
+    afterStartup(app: Application, cb: () => void): void {
+        console.log(app.getServerId(), '!!afterStartup');
+        cb();
+    }
+
+    afterStartAll(app: Application): void {
+        console.log(app.getServerId(), '!!after start all');
+    }
+
+    beforeShutdown(app: Application, shutDown: () => void, cancelShutDownTimer: () => void) {
+        console.log(app.getServerId(), '!!beforeShutdown');
+        shutDown();
+    }
+}

package/app/servers/gate/handler/gateHandler.ts

@@ -0,0 +1,41 @@
+import { dispatch } from '../../../util/dispatcher';
+import { Application , BackendSession} from '@bigtyphoon/melo';
+
+export default function (app: Application) {
+    return new GateHandler(app);
+}
+
+export class GateHandler {
+    constructor(private app: Application) {
+    }
+
+    /**
+     * Gate handler that dispatch user to connectors.
+     *
+     * @param {Object} msg message from client
+     * @param {Object} session
+     *
+     */
+    async queryEntry(msg: {uid: string}, session: BackendSession) {
+        let uid = msg.uid;
+        if (!uid) {
+            return {
+                code: 500
+            };
+        }
+        // get all connectors
+        let connectors = this.app.getServersByType('connector');
+        if (!connectors || connectors.length === 0) {
+            return {
+                code: 500
+            };
+        }
+        // select connector
+        let res = dispatch(uid, connectors);
+        return {
+            code: 200,
+            host: res.host,
+            port: res.clientPort
+        };
+    }
+}

package/app/util/dispatcher.ts

@@ -0,0 +1,7 @@
+import * as crc from 'crc';
+import { ServerInfo } from '@bigtyphoon/melo';
+
+export function dispatch(uid: string , connectors: ServerInfo[]) {
+    let index = Math.abs(crc.crc32(uid)) % connectors.length;
+    return connectors[index];
+}

package/app/util/routeUtil.ts

@@ -0,0 +1,16 @@
+
+import { dispatch} from './dispatcher';
+import { Session, Application } from '@bigtyphoon/melo';
+
+export function chat(session: Session, msg: any, app: Application, cb: (err: Error , serverId ?: string) => void) {
+    let chatServers = app.getServersByType('chat');
+
+    if(!chatServers || chatServers.length === 0) {
+        cb(new Error('can not find chat servers.'));
+        return;
+    }
+
+    let res = dispatch(session.get('rid'), chatServers);
+
+    cb(null, res.id);
+}

package/app.ts

@@ -0,0 +1,70 @@
+import { melo } from '@bigtyphoon/melo';
+import * as  routeUtil from './app/util/routeUtil';
+import { preload } from './preload';
+import { createRobotPlugin } from '@bigtyphoon/melo-robot-plugin';
+
+/**
+ *  替换全局Promise
+ *  自动解析sourcemap
+ *  捕获全局错误
+ */
+preload();
+
+/**
+ * Init app for client.
+ */
+let app = melo.createApp();
+app.set('name', 'chatofpomelo-websocket');
+
+// app configuration
+app.configure('production|development', 'connector', function () {
+    app.set('connectorConfig',
+        {
+            connector: melo.connectors.hybridconnector,
+            heartbeat: 3,
+            useDict: true,
+            useProtobuf: true
+        });
+
+    app.set('serverConfig', {
+        reloadHandlers: true,
+    })
+});
+
+app.configure('production|development', 'gate', function () {
+    app.set('connectorConfig',
+        {
+            connector: melo.connectors.hybridconnector,
+            useProtobuf: true
+        });
+});
+
+// app configure
+app.configure('production|development', function () {
+    // route configures
+    app.route('chat', routeUtil.chat);
+
+    // filter configures
+    app.filter(new melo.filters.timeout());
+
+    // 热更新 handler配置
+    // app.set('serverConfig',{
+    //     reloadHandlers:true,
+    // });
+    // 热更新 remote 配置
+    // app.set('remoteConfig', {
+    //     reloadRemotes: true
+    // });
+});
+
+app.configure('development', function () {
+    // enable the system monitor modules
+    app.enable('systemMonitor');
+});
+
+if (app.isMaster()) {
+    app.use(createRobotPlugin({ scriptFile: __dirname + '/robot/robot.js' }));
+}
+
+// start app
+app.start();

package/ci-test.js

@@ -0,0 +1,44 @@
+const { spawn } = require("child_process");
+
+console.log("!! ci-test directory:", __dirname, " cwd:", process.cwd(), " main file:", require.main.filename)
+
+setTimeout(() => {
+    console.log("start child process timeout")
+    process.exit(-2)
+}, 25000)
+
+let childProcess = spawn("node", ['app.js', 'env=development'], { cwd: __dirname + "/dist" })
+childProcess.stdout.on("data", (data) => {
+    // all servers startup in
+    let str = data.toString()
+    console.log("spawn data:", str)
+    if (str.indexOf("[master-server-1 watchdog.js] all servers startup in") >= 0) {
+        console.log("spawn -- start success")
+        // TODO: 添加 消息测试
+        // 子进程还在.  ci中没什么影响
+        // 解决方法
+        // https://stackoverflow.com/a/42545818/6116888
+        // https://blog.michany.com/2020/01/13/NodeJS-ChildProcess/
+        childProcess.kill("SIGTERM")
+        process.exit(0)
+    }
+})
+
+childProcess.stderr.on("data", (data) => {
+    let str = data.toString()
+    console.log("swpan stderr:", str)
+    if (str.indexOf("Debugger listening") >= 0 ||
+        str.indexOf("Warning: Accessing non-existent") >= 0 ||
+        str.indexOf("For help") >= 0) {
+        return
+    }
+    // 子进程还在.  ci中没什么影响
+    childProcess.kill("SIGTERM")
+    process.exit(-1)
+
+})
+
+childProcess.on("close", (v) => {
+    console.log("spwan process closed!!", v)
+    process.exit(-3)
+})

package/dist/app/servers/chat/handler/chatHandler.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChatHandler = void 0;
+function default_1(app) {
+    return new ChatHandler(app);
+}
+exports.default = default_1;
+class ChatHandler {
+    constructor(app) {
+        this.app = app;
+    }
+    /**
+     * Send messages to users
+     *
+     * @param {Object} msg message from client
+     * @param {Object} session
+     *
+     */
+    async send(msg, session) {
+        let rid = session.get('rid');
+        let username = session.uid.split('*')[0];
+        let channelService = this.app.get('channelService');
+        let param = {
+            msg: msg.content,
+            from: username,
+            target: msg.target
+        };
+        let channel = channelService.getChannel(rid, false);
+        // the target is all users
+        if (msg.target === '*') {
+            channel.pushMessage('onChat', param);
+        }
+        // the target is specific user
+        else {
+            let tuid = msg.target + '*' + rid;
+            let tsid = channel.getMember(tuid)['sid'];
+            channelService.pushMessageByUids('onChat', param, [{
+                    uid: tuid,
+                    sid: tsid
+                }]);
+        }
+    }
+}
+exports.ChatHandler = ChatHandler;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2hhdEhhbmRsZXIuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi8uLi9hcHAvc2VydmVycy9jaGF0L2hhbmRsZXIvY2hhdEhhbmRsZXIudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBSUEsbUJBQXdCLEdBQWdCO0lBQ3BDLE9BQU8sSUFBSSxXQUFXLENBQUMsR0FBRyxDQUFDLENBQUM7QUFDaEMsQ0FBQztBQUZELDRCQUVDO0FBRUQsTUFBYSxXQUFXO0lBQ3BCLFlBQW9CLEdBQWdCO1FBQWhCLFFBQUcsR0FBSCxHQUFHLENBQWE7SUFDcEMsQ0FBQztJQUVEOzs7Ozs7T0FNRztJQUNILEtBQUssQ0FBQyxJQUFJLENBQUMsR0FBdUMsRUFBRSxPQUF1QjtRQUN2RSxJQUFJLEdBQUcsR0FBRyxPQUFPLENBQUMsR0FBRyxDQUFDLEtBQUssQ0FBQyxDQUFDO1FBQzdCLElBQUksUUFBUSxHQUFHLE9BQU8sQ0FBQyxHQUFHLENBQUMsS0FBSyxDQUFDLEdBQUcsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDO1FBQ3pDLElBQUksY0FBYyxHQUFHLElBQUksQ0FBQyxHQUFHLENBQUMsR0FBRyxDQUFDLGdCQUFnQixDQUFDLENBQUM7UUFDcEQsSUFBSSxLQUFLLEdBQUc7WUFDUixHQUFHLEVBQUUsR0FBRyxDQUFDLE9BQU87WUFDaEIsSUFBSSxFQUFFLFFBQVE7WUFDZCxNQUFNLEVBQUUsR0FBRyxDQUFDLE1BQU07U0FDckIsQ0FBQztRQUNGLElBQUksT0FBTyxHQUFHLGNBQWMsQ0FBQyxVQUFVLENBQUMsR0FBRyxFQUFFLEtBQUssQ0FBQyxDQUFDO1FBRXBELDBCQUEwQjtRQUMxQixJQUFJLEdBQUcsQ0FBQyxNQUFNLEtBQUssR0FBRyxFQUFFO1lBQ3BCLE9BQU8sQ0FBQyxXQUFXLENBQUMsUUFBUSxFQUFFLEtBQUssQ0FBQyxDQUFDO1NBQ3hDO1FBQ0QsOEJBQThCO2FBQ3pCO1lBQ0QsSUFBSSxJQUFJLEdBQUcsR0FBRyxDQUFDLE1BQU0sR0FBRyxHQUFHLEdBQUcsR0FBRyxDQUFDO1lBQ2xDLElBQUksSUFBSSxHQUFHLE9BQU8sQ0FBQyxTQUFTLENBQUMsSUFBSSxDQUFDLENBQUMsS0FBSyxDQUFDLENBQUM7WUFDMUMsY0FBYyxDQUFDLGlCQUFpQixDQUFDLFFBQVEsRUFBRSxLQUFLLEVBQUUsQ0FBQztvQkFDL0MsR0FBRyxFQUFFLElBQUk7b0JBQ1QsR0FBRyxFQUFFLElBQUk7aUJBQ1osQ0FBQyxDQUFDLENBQUM7U0FDUDtJQUNMLENBQUM7Q0FDSjtBQXBDRCxrQ0FvQ0MifQ==

package/dist/app/servers/chat/lifecycle.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+function default_1() {
+    return new Lifecycle();
+}
+exports.default = default_1;
+class Lifecycle {
+    beforeStartup(app, cb) {
+        console.log(app.getServerId(), '!!!before startup');
+        cb();
+    }
+    afterStartup(app, cb) {
+        console.log(app.getServerId(), '!!afterStartup');
+        cb();
+    }
+    afterStartAll(app) {
+        console.log(app.getServerId(), '!!after start all');
+    }
+    beforeShutdown(app, shutDown, cancelShutDownTimer) {
+        console.log(app.getServerId(), '!!beforeShutdown');
+        shutDown();
+    }
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibGlmZWN5Y2xlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vLi4vYXBwL3NlcnZlcnMvY2hhdC9saWZlY3ljbGUudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7QUFFQTtJQUNJLE9BQU8sSUFBSSxTQUFTLEVBQUUsQ0FBQztBQUMzQixDQUFDO0FBRkQsNEJBRUM7QUFHRCxNQUFNLFNBQVM7SUFDWCxhQUFhLENBQUMsR0FBZ0IsRUFBRSxFQUFjO1FBQzFDLE9BQU8sQ0FBQyxHQUFHLENBQUMsR0FBRyxDQUFDLFdBQVcsRUFBRSxFQUFFLG1CQUFtQixDQUFDLENBQUM7UUFDcEQsRUFBRSxFQUFFLENBQUM7SUFDVCxDQUFDO0lBRUQsWUFBWSxDQUFDLEdBQWdCLEVBQUUsRUFBYztRQUN6QyxPQUFPLENBQUMsR0FBRyxDQUFDLEdBQUcsQ0FBQyxXQUFXLEVBQUUsRUFBRSxnQkFBZ0IsQ0FBQyxDQUFDO1FBQ2pELEVBQUUsRUFBRSxDQUFDO0lBQ1QsQ0FBQztJQUVELGFBQWEsQ0FBQyxHQUFnQjtRQUMxQixPQUFPLENBQUMsR0FBRyxDQUFDLEdBQUcsQ0FBQyxXQUFXLEVBQUUsRUFBRSxtQkFBbUIsQ0FBQyxDQUFDO0lBQ3hELENBQUM7SUFFRCxjQUFjLENBQUMsR0FBZ0IsRUFBRSxRQUFvQixFQUFFLG1CQUErQjtRQUNsRixPQUFPLENBQUMsR0FBRyxDQUFDLEdBQUcsQ0FBQyxXQUFXLEVBQUUsRUFBRSxrQkFBa0IsQ0FBQyxDQUFDO1FBQ25ELFFBQVEsRUFBRSxDQUFDO0lBQ2YsQ0FBQztDQUNKIn0=