init

examples/cocos-room-cluster/README.md

@@ -0,0 +1,6 @@
+TSRPC 分布式游戏房间服务 Demo
+===
+
+## 特性
+1. 可开房间、随机匹配，房间逻辑可以自定义
+2. 支持分布式部署和水平扩展

examples/cocos-room-cluster/backend/.gitignore

@@ -0,0 +1,3 @@
+node_modules
+dist
+.DS_STORE

examples/cocos-room-cluster/backend/.mocharc.js

@@ -0,0 +1,11 @@
+module.exports = {
+    require: [
+        'ts-node/register',
+    ],
+    timeout: 999999,
+    exit: true,
+    spec: [
+        './test/**/*.test.ts'
+    ],
+    'preserve-symlinks': true
+}

examples/cocos-room-cluster/backend/.vscode/launch.json

@@ -0,0 +1,30 @@
+{
+    "configurations": [
+        {
+            "type": "node",
+            "request": "launch",
+            "name": "mocha current file",
+            "program": "${workspaceFolder}/node_modules/mocha/bin/_mocha",
+            "args": [
+                "${file}"
+            ],
+            "internalConsoleOptions": "openOnSessionStart",
+            "cwd": "${workspaceFolder}"
+        },
+        {
+            "type": "node",
+            "request": "launch",
+            "name": "ts-node current file",
+            "protocol": "inspector",
+            "args": [
+                "${relativeFile}"
+            ],
+            "cwd": "${workspaceRoot}",
+            "runtimeArgs": [
+                "-r",
+                "ts-node/register"
+            ],
+            "internalConsoleOptions": "openOnSessionStart"
+        }
+    ]
+}

examples/cocos-room-cluster/backend/.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "typescript.tsdk": "node_modules\\typescript\\lib"
+}

examples/cocos-room-cluster/backend/Dockerfile

@@ -0,0 +1,30 @@
+FROM node
+
+# 使用淘宝 NPM 镜像（国内机器构建推荐启用）
+# RUN npm config set registry https://registry.npm.taobao.org/
+
+# npm install
+ADD package*.json /src/
+WORKDIR /src
+RUN npm i
+
+# build
+ADD . /src
+RUN npm run build
+
+# clean
+RUN npm prune --production
+
+# move
+RUN rm -rf /app \
+    && mv dist /app \
+    && mv node_modules /app/ \
+    && rm -rf /src
+
+# ENV
+ENV NODE_ENV production
+
+EXPOSE 3000
+
+WORKDIR /app
+CMD node index.js

examples/cocos-room-cluster/backend/README.md

@@ -0,0 +1,31 @@
+# TSRPC Server
+
+## Usage
+### Local dev server
+
+Dev server would restart automatically when code changed.
+
+```
+npm run dev
+```
+
+### Build
+```
+npm run build
+```
+
+### Generate API document
+
+Generate API document in swagger/openapi and markdown format.
+
+```shell
+npm run doc
+```
+
+### Run unit Test
+Execute `npm run dev` first, then execute:
+```
+npm run test
+```
+
+---

examples/cocos-room-cluster/backend/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "backend-.",
+  "version": "0.1.0",
+  "main": "index.js",
+  "private": true,
+  "scripts": {
+    "dev": "tsrpc-cli dev",
+    "build": "tsrpc-cli build",
+    "doc": "tsrpc-cli doc",
+    "test": "mocha test/**/*.test.ts",
+    "proto": "tsrpc-cli proto",
+    "sync": "tsrpc-cli sync",
+    "api": "tsrpc-cli api"
+  },
+  "devDependencies": {
+    "@types/mocha": "^8.2.3",
+    "@types/node": "^15.14.9",
+    "mocha": "^9.1.3",
+    "onchange": "^7.1.0",
+    "ts-node": "^10.4.0",
+    "tsrpc-cli": "^2.3.1",
+    "typescript": "^4.5.4"
+  },
+  "dependencies": {
+    "tsrpc": "^3.1.4"
+  }
+}

examples/cocos-room-cluster/backend/src/api/ApiSend.ts

@@ -0,0 +1,26 @@
+import { ApiCall } from "tsrpc";
+import { server } from "..";
+import { ReqSend, ResSend } from "../shared/protocols/PtlSend";
+
+// This is a demo code file
+// Feel free to delete it
+
+export async function ApiSend(call: ApiCall<ReqSend, ResSend>) {
+    // Error
+    if (call.req.content.length === 0) {
+        call.error('Content is empty')
+        return;
+    }
+
+    // Success
+    let time = new Date();
+    call.succ({
+        time: time
+    });
+
+    // Broadcast
+    server.broadcastMsg('Chat', {
+        content: call.req.content,
+        time: time
+    })
+}

examples/cocos-room-cluster/backend/src/index.ts

@@ -0,0 +1,25 @@
+import * as path from "path";
+import { WsServer } from "tsrpc";
+import { serviceProto } from './shared/protocols/serviceProto';
+
+// Create the Server
+export const server = new WsServer(serviceProto, {
+    port: 3000,
+    // Remove this to use binary mode (remove from the client too)
+    json: true
+});
+
+// Initialize before server start
+async function init() {
+    await server.autoImplementApi(path.resolve(__dirname, 'api'));
+
+    // TODO
+    // Prepare something... (e.g. connect the db)
+};
+
+// Entry function
+async function main() {
+    await init();
+    await server.start();
+}
+main();

examples/cocos-room-cluster/backend/src/shared/protocols/MsgChat.ts

@@ -0,0 +1,7 @@
+// This is a demo code file
+// Feel free to delete it
+
+export interface MsgChat {
+    content: string,
+    time: Date
+}

examples/cocos-room-cluster/backend/src/shared/protocols/PtlSend.ts

@@ -0,0 +1,10 @@
+// This is a demo code file
+// Feel free to delete it
+
+export interface ReqSend {
+    content: string
+}
+
+export interface ResSend {
+    time: Date
+}

examples/cocos-room-cluster/backend/src/shared/protocols/base.ts

@@ -0,0 +1,15 @@
+export interface BaseRequest {
+    
+}
+
+export interface BaseResponse {
+    
+}
+
+export interface BaseConf {
+    
+}
+
+export interface BaseMessage {
+
+}

examples/cocos-room-cluster/backend/src/shared/protocols/serviceProto.ts

@@ -0,0 +1,78 @@
+import { ServiceProto } from 'tsrpc-proto';
+import { MsgChat } from './MsgChat';
+import { ReqSend, ResSend } from './PtlSend';
+
+// This is a demo service proto file (auto generated)
+// Feel free to delete it
+
+export interface ServiceType {
+    api: {
+        "Send": {
+            req: ReqSend,
+            res: ResSend
+        }
+    },
+    msg: {
+        "Chat": MsgChat
+    }
+}
+
+export const serviceProto: ServiceProto<ServiceType> = {
+    "services": [
+        {
+            "id": 0,
+            "name": "Chat",
+            "type": "msg"
+        },
+        {
+            "id": 1,
+            "name": "Send",
+            "type": "api"
+        }
+    ],
+    "types": {
+        "MsgChat/MsgChat": {
+            "type": "Interface",
+            "properties": [
+                {
+                    "id": 0,
+                    "name": "content",
+                    "type": {
+                        "type": "String"
+                    }
+                },
+                {
+                    "id": 1,
+                    "name": "time",
+                    "type": {
+                        "type": "Date"
+                    }
+                }
+            ]
+        },
+        "PtlSend/ReqSend": {
+            "type": "Interface",
+            "properties": [
+                {
+                    "id": 0,
+                    "name": "content",
+                    "type": {
+                        "type": "String"
+                    }
+                }
+            ]
+        },
+        "PtlSend/ResSend": {
+            "type": "Interface",
+            "properties": [
+                {
+                    "id": 0,
+                    "name": "time",
+                    "type": {
+                        "type": "Date"
+                    }
+                }
+            ]
+        }
+    }
+};

examples/cocos-room-cluster/backend/test/api/ApiSend.test.ts

@@ -0,0 +1,40 @@
+import assert from 'assert';
+import { TsrpcError, WsClient } from 'tsrpc';
+import { serviceProto } from '../../src/shared/protocols/serviceProto';
+
+// 1. EXECUTE `npm run dev` TO START A LOCAL DEV SERVER
+// 2. EXECUTE `npm test` TO START UNIT TEST
+
+describe('ApiSend', function () {
+    let client = new WsClient(serviceProto, {
+        server: 'ws://127.0.0.1:3000',
+        json: true,
+        logger: console
+    });
+
+    before(async function () {
+        let res = await client.connect();
+        assert.strictEqual(res.isSucc, true, 'Failed to connect to server, have you executed `npm run dev` already?');
+    })
+
+    it('Success', async function () {
+        let ret = await client.callApi('Send', {
+            content: 'Test'
+        });
+        assert.ok(ret.isSucc)
+    });
+
+    it('Check content is empty', async function () {
+        let ret = await client.callApi('Send', {
+            content: ''
+        });
+        assert.deepStrictEqual(ret, {
+            isSucc: false,
+            err: new TsrpcError('Content is empty')
+        });
+    })
+
+    after(async function () {
+        await client.disconnect();
+    })
+})

examples/cocos-room-cluster/backend/test/tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "compilerOptions": {
+    "lib": [
+      "es2018"
+    ],
+    "module": "commonjs",
+    "target": "es2018",
+    "outDir": "dist",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "moduleResolution": "node"
+  }
+}

examples/cocos-room-cluster/backend/tsconfig.json

@@ -0,0 +1,18 @@
+{
+  "compilerOptions": {
+    "lib": [
+      "es2018"
+    ],
+    "module": "commonjs",
+    "target": "es2018",
+    "outDir": "dist",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "moduleResolution": "node"
+  },
+  "include": [
+    "src"
+  ]
+}

examples/cocos-room-cluster/backend/tsrpc.config.ts

@@ -0,0 +1,39 @@
+import { CodeTemplate, TsrpcConfig } from 'tsrpc-cli';
+
+const tsrpcConf: TsrpcConfig = {
+    // Generate ServiceProto
+    proto: [
+        {
+            ptlDir: 'src/shared/protocols', // Protocol dir
+            output: 'src/shared/protocols/serviceProto.ts', // Path for generated ServiceProto
+            apiDir: 'src/api',   // API dir
+            docDir: 'docs',     // API documents dir
+            ptlTemplate: CodeTemplate.getExtendedPtl(),
+            // msgTemplate: CodeTemplate.getExtendedMsg(),
+        }
+    ],
+    // Sync shared code
+    sync: [
+        // {
+        //     from: 'src/shared',
+        //     to: '../frontend/src/shared',
+        //     type: 'symlink'     // Change this to 'copy' if your environment not support symlink
+        // }
+    ],
+    // Dev server
+    dev: {
+        autoProto: true,        // Auto regenerate proto
+        autoSync: true,         // Auto sync when file changed
+        autoApi: true,          // Auto create API when ServiceProto updated
+        watch: 'src',           // Restart dev server when these files changed
+        entry: 'src/index.ts',  // Dev server command: node -r ts-node/register {entry}
+    },
+    // Build config
+    build: {
+        autoProto: true,        // Auto generate proto before build
+        autoSync: true,         // Auto sync before build
+        autoApi: true,          // Auto generate API before build
+        outDir: 'dist',         // Clean this dir before build
+    }
+}
+export default tsrpcConf;