## [3.4.0-beta.1] - 2022-06-08

### Added
- Support using the same name with API and message

Author: k8w

.mocharc.js

@@ -15,9 +15,14 @@ module.exports = {
         './test/cases/inner.test.ts',
         './test/cases/inputJSON.test.ts',
         './test/cases/inputBuffer.test.ts',
+        './test/cases/https.test.ts',
+        './test/cases/httpsJSON.test.ts',
+        './test/cases/wss.test.ts',
+        './test/cases/wssJSON.test.ts',
+
     ],
     // parallel: false,
 
     // 'expose-gc': true,
-    // fgrep: 'ObjectId'
+    // fgrep: 'Same-name'
 }

CHANGELOG.md

@@ -1,9 +1,10 @@
 # CHANGELOG
 
-## [3.4.0-beta.0] - 2022-06-08
+## [3.4.0-beta.1] - 2022-06-08
 ### Added
 - `https` options for `HttpServer`
 - `wss` options for `WsServer`
+- Support using the same name with API and message
 
 ## [3.3.3] - 2022-06-07
 ### Fixed

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "tsrpc",
-  "version": "3.4.0-beta.0",
+  "version": "3.4.0-beta.1",
   "description": "A TypeScript RPC Framework, with runtime type checking and built-in serialization, support both HTTP and WebSocket.",
   "main": "index.js",
   "exports": {
@@ -38,8 +38,8 @@
   "author": "k8w",
   "license": "MIT",
   "devDependencies": {
-    "@microsoft/api-documenter": "^7.17.16",
-    "@microsoft/api-extractor": "^7.24.2",
+    "@microsoft/api-documenter": "^7.17.17",
+    "@microsoft/api-extractor": "^7.25.0",
     "@types/chai": "^4.3.1",
     "@types/mocha": "^8.2.3",
     "@types/node": "^15.14.9",
@@ -48,16 +48,16 @@
     "mocha": "^9.2.2",
     "mongodb": "^4.7.0",
     "nyc": "^15.1.0",
-    "rollup": "^2.75.5",
-    "rollup-plugin-typescript2": "^0.31.2",
-    "ts-node": "^10.8.0",
-    "typescript": "^4.7.2"
+    "rollup": "^2.75.6",
+    "rollup-plugin-typescript2": "^0.32.1",
+    "ts-node": "^10.8.1",
+    "typescript": "^4.7.3"
   },
   "dependencies": {
     "@types/ws": "^7.4.7",
     "chalk": "^4.1.2",
     "tsbuffer": "^2.2.3",
-    "tsrpc-base-client": "^2.0.6",
+    "tsrpc-base-client": "^2.0.8-dev.1",
     "tsrpc-proto": "^1.4.2",
     "uuid": "^8.3.2",
     "ws": "^7.5.8"

package.json

@@ -1,7 +1,7 @@
 import chalk from "chalk";
 import * as path from "path";
 import { TSBuffer } from 'tsbuffer';
-import { ApiService, Counter, Flow, getCustomObjectIdTypes, MsgHandlerManager, MsgService, ParsedServerInput, ServiceMap, ServiceMapUtil, TransportDataUtil } from 'tsrpc-base-client';
+import { Counter, Flow, getCustomObjectIdTypes, MsgHandlerManager, MsgService, ParsedServerInput, ServiceMap, ServiceMapUtil, TransportDataUtil } from 'tsrpc-base-client';
 import { ApiReturn, ApiServiceDef, BaseServiceType, Logger, LogLevel, ServerInputData, ServiceProto, setLogLevel, TsrpcError, TsrpcErrorType } from 'tsrpc-proto';
 import { getClassObjectId } from "../../models/getClassObjectId";
 import { ApiCallInner } from "../inner/ApiCallInner";
@@ -59,7 +59,16 @@ export abstract class BaseServer<ServiceType extends BaseServiceType = BaseServi
          * Before processing the received data, usually be used to encryption / decryption.
          * Return `null | undefined` would ignore the buffer.
          */
-        preRecvDataFlow: new Flow<{ conn: BaseConnection<ServiceType>, data: string | Uint8Array | object, serviceName?: string }>(),
+        preRecvDataFlow: new Flow<{
+            conn: BaseConnection<ServiceType>,
+            data: string | Uint8Array | object,
+            /**
+             * @deprecated use `serviceId` instead
+             */
+            serviceName?: string,
+            /** Parsed service id */
+            serviceId?: number
+        }>(),
         /**
          * Before send out data to network, usually be used to encryption / decryption.
          * Return `null | undefined` would not send the buffer.
@@ -221,7 +230,7 @@ export abstract class BaseServer<ServiceType extends BaseServiceType = BaseServi
     /**
      * Process the buffer, after the `preRecvBufferFlow`.
      */
-    async _onRecvData(conn: BaseConnection<ServiceType>, data: string | Uint8Array | object, serviceName?: string) {
+    async _onRecvData(conn: BaseConnection<ServiceType>, data: string | Uint8Array | object, serviceId?: number) {
         // 非 OPENED 状态 停止接受新的请求
         if (!(conn instanceof InnerConnection) && this.status !== ServerStatus.Opened) {
             return;
@@ -246,13 +255,28 @@ export abstract class BaseServer<ServiceType extends BaseServiceType = BaseServi
             return;
         }
 
-        let pre = await this.flows.preRecvDataFlow.exec({ conn: conn, data: data, serviceName: serviceName }, conn.logger);
+        // Pre flow
+        const preServiceName = serviceId ? this.serviceMap.id2Service[serviceId].name : undefined;
+        let pre = await this.flows.preRecvDataFlow.exec({
+            conn: conn,
+            data: data,
+            serviceId: serviceId,
+            serviceName: preServiceName
+        }, conn.logger);
         if (!pre) {
             conn.logger.debug('[preRecvDataFlow] Canceled');
             return;
         }
         data = pre.data;
-        serviceName = pre.serviceName;
+
+        // Pre flow res
+        if (pre.serviceId !== serviceId) {
+            serviceId = pre.serviceId
+        }
+        // @deprecated 兼容
+        else if (pre.serviceName && pre.serviceName !== preServiceName) {
+            serviceId = this.serviceMap.apiName2Service[pre.serviceName]?.id;
+        }
 
         // @deprecated preRecvBuffer
         if (data instanceof Uint8Array) {
@@ -265,7 +289,7 @@ export abstract class BaseServer<ServiceType extends BaseServiceType = BaseServi
         }
 
         // Parse Call
-        let opInput = this._parseServerInput(this.tsbuffer, this.serviceMap, data, serviceName);
+        let opInput = this._parseServerInput(this.tsbuffer, this.serviceMap, data, serviceId);
         if (!opInput.isSucc) {
             this.onInputDataError(opInput.errMsg, conn, data);
             return;
@@ -668,7 +692,8 @@ export abstract class BaseServer<ServiceType extends BaseServiceType = BaseServi
         if (apiName.startsWith('/')) {
             apiName = apiName.slice(1);
         }
-        if (!this.serviceMap.apiName2Service[apiName]) {
+        const service = this.serviceMap.apiName2Service[apiName];
+        if (!service) {
             return {
                 isSucc: false,
                 err: new TsrpcError(`Invalid service name: ${apiName}`, {
@@ -690,7 +715,7 @@ export abstract class BaseServer<ServiceType extends BaseServiceType = BaseServi
                 }
             });
 
-            this._onRecvData(conn, req, apiName);
+            this._onRecvData(conn, req, service.id);
         })
     }
 
@@ -716,7 +741,7 @@ export abstract class BaseServer<ServiceType extends BaseServiceType = BaseServi
         })
     }
 
-    protected _parseServerInput(tsbuffer: TSBuffer, serviceMap: ServiceMap, data: string | Uint8Array | object, serviceName?: string): { isSucc: true, result: ParsedServerInput } | { isSucc: false, errMsg: string } {
+    protected _parseServerInput(tsbuffer: TSBuffer, serviceMap: ServiceMap, data: string | Uint8Array | object, serviceId?: number): { isSucc: true, result: ParsedServerInput } | { isSucc: false, errMsg: string } {
         if (data instanceof Uint8Array) {
             let opServerInputData = TransportDataUtil.tsbuffer.decode(data, 'ServerInputData');
 
@@ -773,31 +798,32 @@ export abstract class BaseServer<ServiceType extends BaseServiceType = BaseServi
             let body: any;
             let sn: number | undefined;
 
-            // Parse serviceName / body / sn
-            let service: ApiService | MsgService | undefined;
-            const oriServiceName = serviceName;
-            if (serviceName == undefined) {
+            // Parse serviceId / body / sn
+            if (serviceId == undefined) {
+                // 未指定 serviceId，必然是长连接，传入格式应该是数组 [serviceName, body, sn?]
                 if (!Array.isArray(json)) {
                     return { isSucc: false, errMsg: `Invalid request format: unresolved service name.` };
                 }
-                serviceName = json[0] as string;
+
                 body = json[1];
                 sn = json[2];
+
+                // Parse serviceId
+                const serviceName = json[0] as string;
+                const isMsg = sn === undefined;
+                serviceId = (isMsg ? serviceMap.msgName2Service : serviceMap.apiName2Service)[serviceName]?.id;
+                if (serviceId === undefined) {
+                    return { isSucc: false, errMsg: `Invalid ${isMsg ? 'msg' : 'api'} path: ${serviceName}` };
+                }
             }
             else {
                 body = json;
             }
 
             // Get Service
-            service = serviceMap.apiName2Service[serviceName] ?? serviceMap.msgName2Service[serviceName];
+            let service = serviceMap.id2Service[serviceId];
             if (!service) {
-                let errMsg = `Invalid service name: ${chalk.cyan.underline(serviceName)}`;
-
-                // 可能是 JSON 模式下，jsonHostPath 未设置妥当的原因，此时给予友好提示
-                if (oriServiceName) {
-                    // TODO
-                }
-
+                let errMsg = `Invalid service id: ${chalk.cyan.underline(serviceId)}`;
                 return { isSucc: false, errMsg: errMsg };
             }
 

src/server/base/BaseServer.ts

@@ -89,12 +89,28 @@ export class HttpServer<ServiceType extends BaseServiceType = any> extends BaseS
                         let url = conn.httpReq.url!;
 
                         let urlEndPos = url.indexOf('?');
+                        let isMsg: boolean = false;
                         if (urlEndPos > -1) {
-                            url = url.slice(0, urlEndPos);
+                            isMsg = url.slice(urlEndPos + 1).split('&').some(v => v === 'type=msg');
+                            url = url.slice(0, urlEndPos);                            
                         }
 
+                        // Parse serviceId
                         let serviceName = url.slice(this.options.jsonHostPath.length);
-                        this._onRecvData(conn, buf.toString(), serviceName);
+                        let serviceId: number | undefined;
+                        if (isMsg) {
+                            serviceId = this.serviceMap.msgName2Service[serviceName]?.id;
+                        }
+                        else {
+                            serviceId = this.serviceMap.apiName2Service[serviceName]?.id
+                        }
+
+                        const data = buf.toString();
+                        if (serviceId === undefined) {
+                            this.onInputDataError(`Invalid ${isMsg ? 'msg' : 'api'} path: ${serviceName}`, conn, data)
+                            return;
+                        }
+                        this._onRecvData(conn, data, serviceId);
                     }
                     else {
                         this._onRecvData(conn, buf);

src/server/http/HttpServer.ts

@@ -196,7 +196,7 @@ describe('HTTP Server & Client basic', function () {
             logger: serverLogger,
             // debugBuf: true
         });
-
+        await server.autoImplementApi(path.resolve(__dirname, '../api'))
         await server.start();
 
         let client = new HttpClient(getProto(), {
@@ -223,6 +223,38 @@ describe('HTTP Server & Client basic', function () {
         })
     })
 
+    it('Same-name msg and api', async function () {
+        let server = new HttpServer(getProto(), {
+            port: 3001,
+            logger: serverLogger,
+            debugBuf: true
+        });
+
+        await server.autoImplementApi(path.resolve(__dirname, '../api'))
+        await server.start();
+
+        let client = new HttpClient(getProto(), {
+            server: 'http://127.0.0.1:3001',
+            logger: clientLogger,
+            debugBuf: true
+        });
+
+        let ret = await client.callApi('Test', { name: 'xxx' });
+        assert.ok(ret.isSucc);
+
+        return new Promise(rs => {
+            server.listenMsg('Test', async v => {
+                assert.deepStrictEqual(v.msg, { content: 'abc' });
+                await server.stop();
+                rs();
+            });
+
+            client.sendMsg('Test', {
+                content: 'abc'
+            });
+        })
+    });
+
     it('abort', async function () {
         let server = new HttpServer(getProto(), {
             logger: serverLogger

test/cases/http.test.ts

@@ -90,7 +90,7 @@ async function testApi(server: HttpServer<ServiceType>, client: HttpClient<Servi
     }
 }
 
-describe('HTTP Server & Client basic', function () {
+describe('HTTP JSON Server & Client basic', function () {
     it('implement API manually', async function () {
         let server = new HttpServer(getProto(), {
             json: true,
@@ -232,6 +232,40 @@ describe('HTTP Server & Client basic', function () {
         })
     })
 
+    it('Same-name msg and api', async function () {
+        let server = new HttpServer(getProto(), {
+            port: 3001,
+            json: true,
+            logger: serverLogger,
+            // debugBuf: true
+        });
+
+        await server.autoImplementApi(path.resolve(__dirname, '../api'))
+        await server.start();
+
+        let client = new HttpClient(getProto(), {
+            server: 'http://127.0.0.1:3001',
+            json: true,
+            logger: clientLogger,
+            // debugBuf: true
+        });
+
+        let ret = await client.callApi('Test', { name: 'xxx' });
+        assert.ok(ret.isSucc);
+
+        return new Promise(rs => {
+            server.listenMsg('Test', async v => {
+                assert.deepStrictEqual(v.msg, { content: 'abc' });
+                await server.stop();
+                rs();
+            });
+
+            client.sendMsg('Test', {
+                content: 'abc'
+            });
+        })
+    });
+
     it('abort', async function () {
         let server = new HttpServer(getProto(), {
             json: true,
@@ -531,7 +565,7 @@ describe('HTTP Server & Client basic', function () {
     })
 })
 
-describe('HTTP Flows', function () {
+describe('HTTP JSON Flows', function () {
     it('Server conn flow', async function () {
         let server = new HttpServer(getProto(), {
             json: true,

test/cases/httpJSON.test.ts

@@ -194,6 +194,39 @@ describe('WS Server & Client basic', function () {
         })
     });
 
+    it('Same-name msg and api', async function () {
+        let server = new WsServer(getProto(), {
+            port: 3000,
+            logger: serverLogger,
+            // debugBuf: true
+        });
+
+        await server.autoImplementApi(path.resolve(__dirname, '../api'))
+        await server.start();
+
+        let client = new WsClient(getProto(), {
+            server: 'ws://127.0.0.1:3000',
+            logger: clientLogger,
+            // debugBuf: true
+        });
+        await client.connect();
+
+        let ret = await client.callApi('Test', { name: 'xxx' });
+        assert.ok(ret.isSucc);
+
+        return new Promise(rs => {
+            server.listenMsg('Test', async v => {
+                assert.deepStrictEqual(v.msg, { content: 'abc' });
+                await server.stop();
+                rs();
+            });
+
+            client.sendMsg('Test', {
+                content: 'abc'
+            });
+        })
+    });
+
     it('server send msg', async function () {
         let server = new WsServer(getProto(), {
             port: 3001,

test/cases/ws.test.ts

@@ -88,7 +88,7 @@ async function testApi(server: WsServer<ServiceType>, client: WsClient<ServiceTy
     }
 }
 
-describe('WS Server & Client basic', function () {
+describe('WS JSON Server & Client basic', function () {
     it('cannot callApi before connect', async function () {
         let client = new WsClient(getProto(), {
             json: true,
@@ -246,6 +246,41 @@ describe('WS Server & Client basic', function () {
         })
     });
 
+    it('Same-name msg and api', async function () {
+        let server = new WsServer(getProto(), {
+            port: 3000,
+            logger: serverLogger,
+            json: true,
+            // debugBuf: true
+        });
+
+        await server.autoImplementApi(path.resolve(__dirname, '../api'))
+        await server.start();
+
+        let client = new WsClient(getProto(), {
+            server: 'ws://127.0.0.1:3000',
+            logger: clientLogger,
+            json: true,
+            // debugBuf: true
+        });
+        await client.connect();
+
+        let ret = await client.callApi('Test', { name: 'xxx' });
+        assert.ok(ret.isSucc);
+
+        return new Promise(rs => {
+            server.listenMsg('Test', async v => {
+                assert.deepStrictEqual(v.msg, { content: 'abc' });
+                await server.stop();
+                rs();
+            });
+
+            client.sendMsg('Test', {
+                content: 'abc'
+            });
+        })
+    });
+
     it('server send msg', async function () {
         let server = new WsServer(getProto(), {
             json: true,
@@ -855,7 +890,7 @@ describe('WS Server & Client basic', function () {
     })
 })
 
-describe('WS Flows', function () {
+describe('WS JSON Flows', function () {
     it('Server conn flow', async function () {
         let server = new WsServer(getProto(), {
             json: true,

test/cases/wsJSON.test.ts

@@ -0,0 +1,3 @@
+export interface MsgTest {
+    content: string
+}

test/proto/MsgTest.ts

@@ -1,6 +1,7 @@
 import { ServiceProto } from 'tsrpc-proto';
 import { ReqTest, ResTest } from './a/b/c/PtlTest';
 import { MsgChat } from './MsgChat';
+import { MsgTest } from './MsgTest';
 import { ReqObjId, ResObjId } from './PtlObjId';
 import { ReqTest as ReqTest_1, ResTest as ResTest_1 } from './PtlTest';
 
@@ -20,12 +21,13 @@ export interface ServiceType {
         }
     },
     msg: {
-        "Chat": MsgChat
+        "Chat": MsgChat,
+        "Test": MsgTest
     }
 }
 
 export const serviceProto: ServiceProto<ServiceType> = {
-    "version": 1,
+    "version": 2,
     "services": [
         {
             "id": 0,
@@ -37,6 +39,11 @@ export const serviceProto: ServiceProto<ServiceType> = {
             "name": "Chat",
             "type": "msg"
         },
+        {
+            "id": 4,
+            "name": "Test",
+            "type": "msg"
+        },
         {
             "id": 2,
             "name": "ObjId",
@@ -115,6 +122,18 @@ export const serviceProto: ServiceProto<ServiceType> = {
                 }
             ]
         },
+        "MsgTest/MsgTest": {
+            "type": "Interface",
+            "properties": [
+                {
+                    "id": 0,
+                    "name": "content",
+                    "type": {
+                        "type": "String"
+                    }
+                }
+            ]
+        },
         "PtlObjId/ReqObjId": {
             "type": "Interface",
             "properties": [