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

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/components/nestComponent.ts

@@ -0,0 +1,103 @@
+import { NestFactory } from "@nestjs/core";
+import { Application, IComponent, manualReloadCrons, manualReloadHandlers, manualReloadRemoters } from "@bigtyphoon/melo";
+
+
+
+/**
+ *
+ */
+export class NestComponent implements IComponent {
+    name = "NestComponent";
+    app: Application;
+
+    constructor(app: Application) {
+        this.app = app;
+        this.app.set(this.name, this);
+    }
+
+    /**
+     * 组件开始
+     */
+    start(cb) {
+        cb();
+    }
+
+    beforeStart(cb) {
+        this.bootstrap().then(async result => {
+            this.app.set('nestjs', result);
+            cb();
+        })
+    }
+
+
+    /**
+     * 组件结束
+     * @param cb
+     */
+    afterStart(cb) {
+        process.nextTick(cb);
+
+    }
+
+    // 热更新. 只是示例 需要根据自己的逻辑处理自己的逻辑
+    public async hotUpdate() {
+        if (this.app.getServerType() == 'master') {
+            return;
+        }
+        // 这里放热更新代码
+
+
+        // 清除自己逻辑相关的缓存
+
+
+        // 生成新的nestapp
+        await new Promise((resolve) => {
+            this.beforeStart(() => {
+                resolve(null)
+            })
+        })
+
+        // 热更新框架
+        console.log(this.app.getServerId(), 'logic hot update  handler')
+        manualReloadHandlers(this.app)
+        console.log(this.app.getServerId(), 'logic hot update  remoter')
+        manualReloadRemoters(this.app)
+        // manualReloadProxies(this.app)
+        console.log(this.app.getServerId(), 'logic hot update  crons')
+        manualReloadCrons(this.app)
+        console.log(this.app.getServerId(), 'logic hot update  finished')
+    }
+
+    private async bootstrap() {
+        const servertype = this.app.getServerType();
+        let moduleLocal: any = null;
+        console.log("bootstrap servertype")
+        switch (servertype) {
+            case 'connector': {
+                moduleLocal = require('../servers/connector.module').ConnectorServerModule;
+                console.log('nestApp init: connector');
+                break;
+            }
+            case 'chat': {
+                moduleLocal = require('../servers/chat.module').ChatServerModule;
+                console.log('nestApp init: chat');
+                break;
+            }
+            case 'gate': {
+                moduleLocal = require('../servers/gate.module').GateServerModule;
+                console.log('nestApp init: gate');
+                break;
+            }
+            default:
+                console.warn(' unknow  melo server type . no nestModule::', servertype);
+                return null
+        }
+        console.log('servertype:', servertype, 'before create nestApp');
+        const nestApp = await NestFactory.createApplicationContext(moduleLocal);
+        console.log('servertype:', servertype, 'create nest end');
+        await nestApp.init();
+        console.log('servertype:', servertype, 'init nest end');
+        // 没有listen ,因为只是用nestjs的依赖注入
+        return nestApp;
+    }
+}

package/app/components/testcomponent.ts

@@ -0,0 +1,22 @@
+import { Application, IComponent } from "@bigtyphoon/melo";
+
+
+export class TestComponent implements IComponent {
+    name = "TestComponent";
+    app: Application;
+
+    constructor(app: Application) {
+        this.app = app;
+        this.app.set(this.name, this)
+    }
+
+    start(cb: () => void) {
+        console.log("TestComponent  start", this.app.getServerId())
+        cb()
+    }
+
+    stop(force: boolean, cb: () => void) {
+        console.log("TestComponent stop", force, this.app.getServerId())
+        cb()
+    }
+}

package/app/logic/mutemodule/mute.dao.ts

@@ -0,0 +1,21 @@
+import { Inject, Injectable } from "@nestjs/common";
+
+
+@Injectable()
+export class MuteDao {
+    constructor(
+        @Inject("mydatabase")
+        private readonly dbConnection: any
+    ) {
+
+    }
+
+    public async checkUidMuted(uid: string) {
+        console.log("check user has been muted:", uid);
+        this.dbConnection.hget()
+        if (uid == "abc") {
+            return true
+        }
+        return false
+    }
+}

package/app/logic/mutemodule/mute.module.ts

@@ -0,0 +1,14 @@
+import { Module } from "@nestjs/common";
+import { meloAppProvider } from "../../util/nestutil";
+import { databaseProvider } from "../provider/db.provider";
+import { MuteDao } from "./mute.dao";
+import { MuteService } from "./mute.service";
+
+
+@Module({
+    imports: [],
+    providers: [meloAppProvider, databaseProvider, MuteDao, MuteService,],
+    // 因为外部要用 需要需要导出
+    exports: [MuteService],
+})
+export class MuteModule { }

package/app/logic/mutemodule/mute.service.ts

@@ -0,0 +1,16 @@
+import { Injectable } from "@nestjs/common";
+import { MuteDao } from "./mute.dao";
+
+
+@Injectable()
+export class MuteService {
+    constructor(
+        private readonly muteDao: MuteDao,
+    ) {
+
+    }
+
+    public async checkUidMuted(uid: string) {
+        return this.muteDao.checkUidMuted(uid)
+    }
+}

package/app/logic/provider/db.provider.ts

@@ -0,0 +1,15 @@
+
+// more examples
+// https://docs.nestjs.com/fundamentals/custom-providers
+
+
+export const databaseProvider = {
+    provide: "mydatabase",
+    useFactory: async () => {
+        // create redis,mongodb,mysql etc.
+        return {
+            hget: () => { console.log("mydatabase hget") },
+            hset: () => { console.log("mydatabase hset") },
+        }
+    }
+}

package/app/servers/chat/cron/cronTest.ts

@@ -0,0 +1,20 @@
+import { Injectable } from "@nestjs/common";
+import { Application } from "@bigtyphoon/melo";
+import { getNestClass } from "../../../util/nestutil";
+import { ChatServerModule } from "../../chat.module";
+
+let cronInstance: CronTest
+
+export default function (app) {
+    return getNestClass(app, CronTest, ChatServerModule)
+}
+
+@Injectable()
+export class CronTest {
+    constructor(app: Application) {
+    }
+
+    public async onlineCron() {
+        console.log("online cron", Date.now())
+    }
+}

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

@@ -0,0 +1,55 @@
+import { Application, BackendSession } from '@bigtyphoon/melo';
+import { Injectable } from '@nestjs/common';
+import { getNestClass } from '../../../util/nestutil';
+import { MuteService } from '../../../logic/mutemodule/mute.service';
+
+
+export default function (app: Application) {
+    return getNestClass(app, ChatHandler)
+}
+
+@Injectable()
+export class ChatHandler {
+    constructor(
+        private app: Application,
+        private readonly muteService: MuteService,
+    ) {
+    }
+
+    /**
+     * 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];
+        if (this.muteService.checkUidMuted(username)) {
+            console.log("user has been muted", username, " chage msg");
+            msg.content = "##@ user has been muted## - " + msg.content
+        }
+        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/remote/anotherName.ts

@@ -0,0 +1,32 @@
+import { Application, ChannelService, FrontendSession, RemoterClass } from '@bigtyphoon/melo';
+import { Injectable } from '@nestjs/common';
+import { getNestClass } from '../../../util/nestutil';
+
+export default function (app: Application) {
+    return getNestClass(app, AnotherName);
+}
+
+// UserRpc的命名空间自动合并
+declare global {
+    interface MergeChatRemoter {
+        anotherName: RemoterClass<null, AnotherName>;
+    }
+
+    interface UserRpc {
+        chat: MergeChatRemoter
+    }
+}
+
+@Injectable()
+export class AnotherName {
+
+    constructor(private app: Application) {
+        this.app = app;
+    }
+
+
+    public async zzzMethod(uid: string, sid: string, name: string) {
+        console.log("~~~~  zzzMethod ", uid, sid, name);
+        return null;
+    }
+}

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

@@ -0,0 +1,96 @@
+import { Injectable } from '@nestjs/common';
+import { Application, ChannelService, FrontendSession, RemoterClass } from '@bigtyphoon/melo';
+import { getNestClass } from '../../../util/nestutil';
+
+export default function (app: Application) {
+    return getNestClass(app, ChatRemote);
+}
+
+
+// UserRpc的命名空间自动合并
+declare global {
+    interface MergeChatRemoter {
+        chatRemote: RemoterClass<FrontendSession, ChatRemote>;
+    }
+
+    interface UserRpc {
+        chat: MergeChatRemoter
+    }
+}
+
+@Injectable()
+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
+        };
+        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/chat/remote/notifyRemote.ts

@@ -0,0 +1,32 @@
+import { Injectable } from '@nestjs/common';
+import { Application, ChannelService, FrontendSession, RemoterClass } from '@bigtyphoon/melo';
+import { getNestClass } from '../../../util/nestutil';
+
+export default function (app: Application) {
+    return getNestClass(app, NotifyRemoter);
+}
+
+// UserRpc的命名空间自动合并
+declare global {
+    interface MergeChatRemoter {
+        notifyRemote: RemoterClass<FrontendSession, NotifyRemoter>;
+    }
+
+    interface UserRpc {
+        chat: MergeChatRemoter
+    }
+}
+
+@Injectable()
+export class NotifyRemoter {
+
+    constructor(private app: Application) {
+        this.app = app;
+    }
+
+
+    public async notifyMethod(uid: string, sid: string, name: string) {
+        console.log("notifyMethod@@!!!~~", uid, sid, name)
+        return null
+    }
+}

package/app/servers/chat.module.ts

@@ -0,0 +1,23 @@
+import { Module } from '@nestjs/common';
+import { MuteModule } from '../logic/mutemodule/mute.module';
+import { meloAppProvider } from '../util/nestutil';
+import { CronTest } from './chat/cron/cronTest';
+import { ChatHandler } from './chat/handler/chatHandler';
+import { AnotherName } from './chat/remote/anotherName';
+import { ChatRemote } from './chat/remote/chatRemote';
+import { NotifyRemoter } from './chat/remote/notifyRemote';
+
+
+// 数据库 provider
+// https://docs.nestjs.com/fundamentals/custom-providers#export-custom-provider
+
+
+
+@Module({
+    imports: [MuteModule],
+    controllers: [],
+    providers: [meloAppProvider, ChatHandler, AnotherName, ChatRemote, NotifyRemoter, CronTest],
+    // 因为外部要用 需要需要导出
+    exports: [ChatHandler, AnotherName, ChatRemote, NotifyRemoter, CronTest],
+})
+export class ChatServerModule { }

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

@@ -0,0 +1,69 @@
+import { Injectable } from '@nestjs/common';
+import { Application } from '@bigtyphoon/melo';
+import { FrontendSession } from '@bigtyphoon/melo';
+import { getNestClass } from '../../../util/nestutil';
+
+export default function (app: Application) {
+    return getNestClass(app, EntryHandler);
+}
+
+@Injectable()
+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);
+
+        // test remoter
+        self.app.rpc.chat.notifyRemote.notifyMethod.to("chat-server-1")('11', '22', '33')
+        self.app.rpc.chat.anotherName.zzzMethod.to(null)('aa', 'bb', 'cc')
+        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.module.ts

@@ -0,0 +1,11 @@
+import { Module } from '@nestjs/common';
+import { meloAppProvider } from '../util/nestutil';
+import { EntryHandler } from './connector/handler/entryHandler';
+
+@Module({
+    imports: [],
+    controllers: [],
+    providers: [meloAppProvider, EntryHandler],
+    exports: [EntryHandler],
+})
+export class ConnectorServerModule { }

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

@@ -0,0 +1,54 @@
+import { dispatch } from '../../../util/dispatcher';
+import {Application, BackendSession, FrontendSession} from '@bigtyphoon/melo';
+import { Injectable } from '@nestjs/common';
+import { getNestClass } from '../../../util/nestutil';
+
+export default function (app: Application) {
+    return getNestClass(app, GateHandler);
+}
+
+@Injectable()
+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
+        };
+    }
+    
+    /**
+     * protobuftest include obj and map
+     * @param msg
+     * @param session
+     */
+    async protobufTest(msg: { username: string, obj:{[key: string]: {a: string, b: number, c: boolean}},map:Map<string, {d: string, e: number, f: boolean}> }, session: FrontendSession){
+        console.log(msg);
+        return msg;
+    }
+}

package/app/servers/gate.module.ts

@@ -0,0 +1,11 @@
+import { Module } from '@nestjs/common';
+import { meloAppProvider } from '../util/nestutil';
+import { GateHandler } from './gate/handler/gateHandler';
+
+@Module({
+    imports: [],
+    controllers: [],
+    providers: [meloAppProvider, GateHandler],
+    exports: [GateHandler],
+})
+export class GateServerModule { }

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/nestutil.ts

@@ -0,0 +1,25 @@
+import { INestApplicationContext } from "@nestjs/common";
+import { Application, melo } from "@bigtyphoon/melo";
+
+export function getNestClass(app: Application, classz: any, module?: any) {
+    let root: INestApplicationContext = app.get('nestjs');
+    if (module) {
+        root = root.select(module);
+    }
+    if (!root) {
+        return null;
+    }
+    try {
+        let cls = root.get(classz);
+        return cls;
+    } catch (e) {
+        // 给RPC用来读取 方法名用的
+        return classz.prototype;
+    }
+}
+
+// melo 需要先初始化
+export const meloAppProvider = {
+    provide: Application,
+    useValue: melo.app,
+}

package/app/util/routeUtil.ts

@@ -0,0 +1,15 @@
+
+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);
+}