@litert/televoke 0.4.4 → 0.4.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@litert/televoke",
-  "version": "0.4.4",
+  "version": "0.4.6",
   "description": "A simple RPC service framework.",
   "main": "lib/index.js",
   "scripts": {
@@ -36,14 +36,12 @@
   "types": "lib/index.d.ts",
   "typings": "lib/index.d.ts",
   "devDependencies": {
-    "@commitlint/cli": "^12.1.4",
-    "@commitlint/config-conventional": "^12.1.4",
-    "@types/node": "^16.3.1",
-    "@typescript-eslint/eslint-plugin": "^4.28.2",
-    "@typescript-eslint/parser": "^4.28.2",
-    "eslint": "^7.30.0",
-    "husky": "^7.0.1",
-    "typescript": "^4.3.5"
+    "@commitlint/cli": "^17.7.2",
+    "@commitlint/config-conventional": "^17.6.6",
+    "@litert/eslint-plugin-rules": "^0.1.5",
+    "@types/node": "^20.8.4",
+    "husky": "^8.0.3",
+    "typescript": "^5.2.2"
   },
   "engines": {
     "node": ">=12.0.0"

package/src/lib/Client/Common.ts

@@ -32,7 +32,8 @@ export interface IResponse<T> extends G.IRawResponse<T> {
     crt: number;
 }
 
-export interface IClient<TAPIs extends G.IServiceAPIs = G.IServiceAPIs> extends Events.IObservable<Events.ICallbackDefinitions> {
+export interface IClient<TAPIs extends G.IServiceAPIs = G.IServiceAPIs>
+    extends Events.IObservable<Events.ICallbackDefinitions> {
 
     connect(): Promise<void>;
 

package/src/lib/Client/HttpClient.ts

@@ -23,17 +23,17 @@ import { Events } from '@litert/observable';
 
 class HttpClient extends Events.EventEmitter<Events.ICallbackDefinitions> implements C.IClient {
 
-    private _agent: $Http.Agent;
+    private readonly _agent: $Http.Agent;
 
     public onError!: any;
 
     public constructor(
-        private _host: string,
-        private _port: number,
-        private _ridGenerator: C.IRIDGenerator,
-        private _path: string = '/',
-        private _timeout: number = 30000,
-        private _apiNameWrapper?: (name: string) => string
+        private readonly _host: string,
+        private readonly _port: number,
+        private readonly _ridGenerator: C.IRIDGenerator,
+        private readonly _path: string = '/',
+        private readonly _timeout: number = 30000,
+        private readonly _apiNameWrapper?: (name: string) => string
     ) {
 
         super();
@@ -75,7 +75,7 @@ class HttpClient extends Events.EventEmitter<Events.ICallbackDefinitions> implem
 
             if (length > G.MAX_PACKET_SIZE) {
 
-                return reject(new GE.E_PACKET_TOO_LARGE());
+                reject(new GE.E_PACKET_TOO_LARGE()); return;
             }
 
             const req = $Http.request({
@@ -85,21 +85,22 @@ class HttpClient extends Events.EventEmitter<Events.ICallbackDefinitions> implem
                 agent: this._agent,
                 method: 'POST',
                 headers: {
-                    'content-length': Buffer.byteLength(content)
+                    'content-length': Buffer.byteLength(content),
+                    'x-tv-ver': 1
                 },
                 timeout: this._timeout
             }, (resp) => {
 
                 if (!resp.headers['content-length']) {
 
-                    return reject(new E.E_INVALID_RESPONSE());
+                    reject(new E.E_INVALID_RESPONSE()); return;
                 }
 
                 const length = parseInt(resp.headers['content-length']);
 
                 if (!Number.isSafeInteger(length) || length > G.MAX_PACKET_SIZE) { // Maximum request packet is 64MB
 
-                    return reject(new GE.E_PACKET_TOO_LARGE());
+                    reject(new GE.E_PACKET_TOO_LARGE()); return;
                 }
 
                 const buf = Buffer.allocUnsafe(length);
@@ -118,7 +119,7 @@ class HttpClient extends Events.EventEmitter<Events.ICallbackDefinitions> implem
                         resp.removeAllListeners('data');
                         resp.destroy();
 
-                        return reject(new GE.E_INVALID_PACKET());
+                        reject(new GE.E_INVALID_PACKET()); return;
                     }
 
                     chunk.copy(buf, index);
@@ -133,7 +134,7 @@ class HttpClient extends Events.EventEmitter<Events.ICallbackDefinitions> implem
                     }
                     catch {
 
-                        return reject(new GE.E_INVALID_PACKET());
+                        reject(new GE.E_INVALID_PACKET()); return;
                     }
 
                     const data = rawData as C.IResponse<any>;
@@ -168,9 +169,11 @@ class HttpClient extends Events.EventEmitter<Events.ICallbackDefinitions> implem
                 });
             });
 
-            req.once('timeout', () => reject(new E.E_REQUEST_TIMEOUT({
-                metadata: { api, requestId: rid, time: Date.now(), details: null }
-            })));
+            req.once('timeout', () => {
+                reject(new E.E_REQUEST_TIMEOUT({
+                    metadata: { api, requestId: rid, time: Date.now(), details: null }
+                }));
+            });
 
             req.once('error', reject);
 

package/src/lib/Client/HttpsClient.ts

@@ -23,17 +23,17 @@ import { Events } from '@litert/observable';
 
 class HttpsClient extends Events.EventEmitter<Events.ICallbackDefinitions> implements C.IClient {
 
-    private _agent: $Https.Agent;
+    private readonly _agent: $Https.Agent;
 
     public onError!: any;
 
     public constructor(
-        private _host: string,
-        private _port: number,
-        private _ridGenerator: C.IRIDGenerator,
-        private _path: string = '',
-        private _timeout: number = 30000,
-        private _apiNameWrapper?: (name: string) => string,
+        private readonly _host: string,
+        private readonly _port: number,
+        private readonly _ridGenerator: C.IRIDGenerator,
+        private readonly _path: string = '',
+        private readonly _timeout: number = 30000,
+        private readonly _apiNameWrapper?: (name: string) => string,
         tlsAgentOptions?: $Https.AgentOptions
     ) {
 
@@ -78,7 +78,7 @@ class HttpsClient extends Events.EventEmitter<Events.ICallbackDefinitions> imple
 
             if (length > G.MAX_PACKET_SIZE) {
 
-                return reject(new GE.E_PACKET_TOO_LARGE());
+                reject(new GE.E_PACKET_TOO_LARGE()); return;
             }
 
             const req = $Https.request({
@@ -88,21 +88,22 @@ class HttpsClient extends Events.EventEmitter<Events.ICallbackDefinitions> imple
                 agent: this._agent,
                 method: 'POST',
                 headers: {
-                    'content-length': Buffer.byteLength(content)
+                    'content-length': Buffer.byteLength(content),
+                    'x-tv-ver': 1
                 },
                 timeout: this._timeout
             }, (resp) => {
 
                 if (!resp.headers['content-length']) {
 
-                    return reject(new E.E_INVALID_RESPONSE());
+                    reject(new E.E_INVALID_RESPONSE()); return;
                 }
 
                 const length = parseInt(resp.headers['content-length']);
 
                 if (!Number.isSafeInteger(length) || length > G.MAX_PACKET_SIZE) { // Maximum request packet is 64MB
 
-                    return reject(new GE.E_PACKET_TOO_LARGE());
+                    reject(new GE.E_PACKET_TOO_LARGE()); return;
                 }
 
                 const buf = Buffer.allocUnsafe(length);
@@ -121,7 +122,7 @@ class HttpsClient extends Events.EventEmitter<Events.ICallbackDefinitions> imple
                         resp.removeAllListeners('data');
                         resp.destroy();
 
-                        return reject(new GE.E_INVALID_PACKET());
+                        reject(new GE.E_INVALID_PACKET()); return;
                     }
 
                     chunk.copy(buf, index);
@@ -136,7 +137,7 @@ class HttpsClient extends Events.EventEmitter<Events.ICallbackDefinitions> imple
                     }
                     catch {
 
-                        return reject(new GE.E_INVALID_PACKET());
+                        reject(new GE.E_INVALID_PACKET()); return;
                     }
 
                     const data = rawData as C.IResponse<any>;
@@ -171,9 +172,11 @@ class HttpsClient extends Events.EventEmitter<Events.ICallbackDefinitions> imple
                 });
             });
 
-            req.once('timeout', () => reject(new E.E_REQUEST_TIMEOUT({
-                metadata: { api, requestId: rid, time: Date.now(), details: null }
-            })));
+            req.once('timeout', () => {
+                reject(new E.E_REQUEST_TIMEOUT({
+                    metadata: { api, requestId: rid, time: Date.now(), details: null }
+                }));
+            });
 
             req.once('error', reject);
 

package/src/lib/Client/TCPClient.ts

@@ -17,11 +17,10 @@
 import * as $Net from 'net';
 import * as C from './Common';
 import * as G from '../Common';
-import { Promises } from '@litert/observable';
+import { Promises, Events } from '@litert/observable';
 import * as E from './Errors';
 import { createDecoder } from '../Encoder/Decoder';
 import { createEncoder } from '../Encoder/Encoder';
-import { Events } from '@litert/observable';
 
 enum EStatus {
 
@@ -48,7 +47,7 @@ interface IRequest {
 
 class TCPClient extends Events.EventEmitter<Events.ICallbackDefinitions> implements C.IClient {
 
-    private static _$promises = Promises.getGlobalFactory();
+    private static readonly _$promises = Promises.getGlobalFactory();
 
     private static _$clientCounter = 0;
 
@@ -56,11 +55,11 @@ class TCPClient extends Events.EventEmitter<Events.ICallbackDefinitions> impleme
 
     private _status: EStatus = EStatus.IDLE;
 
-    private _clientId: number = TCPClient._$clientCounter++;
+    private readonly _clientId: number = TCPClient._$clientCounter++;
 
-    private _connPrId: string;
+    private readonly _connPrId: string;
 
-    private _closePrId: string;
+    private readonly _closePrId: string;
 
     private _sent: Record<string, IRequest> = {};
 
@@ -70,14 +69,14 @@ class TCPClient extends Events.EventEmitter<Events.ICallbackDefinitions> impleme
 
     private _sendingQty: number = 0;
 
-    private _encoder = createEncoder();
+    private readonly _encoder = createEncoder();
 
     public constructor(
-        private _host: string,
-        private _port: number,
-        private _ridGenerator: C.IRIDGenerator,
-        private _timeout: number = 30000,
-        private _apiNameWrapper?: (name: string) => string
+        private readonly _host: string,
+        private readonly _port: number,
+        private readonly _ridGenerator: C.IRIDGenerator,
+        private readonly _timeout: number = 30000,
+        private readonly _apiNameWrapper?: (name: string) => string
     ) {
 
         super();
@@ -404,6 +403,11 @@ export interface ITCPClientOptions {
     apiNameWrapper?: (name: string) => string;
 }
 
+/**
+ * Create a client of TCP-base televoke/1 protocol.
+ *
+ * @deprecated This legacy TCP-based televoke/1 protocol is no longer maintained, and will be removed in v2.0.0
+ */
 export function createTCPClient<TAPIs extends G.IServiceAPIs>(opts: ITCPClientOptions): C.IClient<TAPIs> {
 
     return new TCPClient(

package/src/lib/Client/TLSClient.ts

@@ -17,11 +17,10 @@
 import * as $TLS from 'tls';
 import * as C from './Common';
 import * as G from '../Common';
-import { Promises } from '@litert/observable';
+import { Promises, Events } from '@litert/observable';
 import * as E from './Errors';
 import { createDecoder } from '../Encoder/Decoder';
 import { createEncoder } from '../Encoder/Encoder';
-import { Events } from '@litert/observable';
 
 enum EStatus {
 
@@ -48,7 +47,7 @@ interface IRequest {
 
 class TLSClient extends Events.EventEmitter<Events.ICallbackDefinitions> implements C.IClient {
 
-    private static _$promises = Promises.getGlobalFactory();
+    private static readonly _$promises = Promises.getGlobalFactory();
 
     private static _$clientCounter = 0;
 
@@ -56,11 +55,11 @@ class TLSClient extends Events.EventEmitter<Events.ICallbackDefinitions> impleme
 
     private _status: EStatus = EStatus.IDLE;
 
-    private _clientId: number = TLSClient._$clientCounter++;
+    private readonly _clientId: number = TLSClient._$clientCounter++;
 
-    private _connPrId: string;
+    private readonly _connPrId: string;
 
-    private _closePrId: string;
+    private readonly _closePrId: string;
 
     private _sent: Record<string, IRequest> = {};
 
@@ -70,15 +69,15 @@ class TLSClient extends Events.EventEmitter<Events.ICallbackDefinitions> impleme
 
     private _sendingQty: number = 0;
 
-    private _encoder = createEncoder();
+    private readonly _encoder = createEncoder();
 
     public constructor(
-        private _host: string,
-        private _port: number,
-        private _ridGenerator: C.IRIDGenerator,
-        private _timeout: number = 30000,
-        private _apiNameWrapper?: (name: string) => string,
-        private _tlsOptions?: $TLS.ConnectionOptions
+        private readonly _host: string,
+        private readonly _port: number,
+        private readonly _ridGenerator: C.IRIDGenerator,
+        private readonly _timeout: number = 30000,
+        private readonly _apiNameWrapper?: (name: string) => string,
+        private readonly _tlsOptions?: $TLS.ConnectionOptions
     ) {
 
         super();

package/src/lib/Common/Request.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-export interface IRawRequest<T extends any = any> {
+export interface IRawRequest<T = any> {
 
     ttl: number;
 

package/src/lib/Encoder/Decoder.ts

@@ -37,7 +37,7 @@ class Decoder implements C.IDecoder<any> {
 
     private _packetLength!: number;
 
-    private _plBuf: Buffer = Buffer.allocUnsafe(4);
+    private readonly _plBuf: Buffer = Buffer.allocUnsafe(8);
 
     private _plBufLength: number = 0;
 
@@ -72,7 +72,7 @@ class Decoder implements C.IDecoder<any> {
 
                     try {
 
-                        data = JSON.parse(chunk.slice(0, this._packetLength).toString());
+                        data = JSON.parse(chunk.subarray(0, this._packetLength).toString());
                     }
                     catch (e) {
 
@@ -81,7 +81,7 @@ class Decoder implements C.IDecoder<any> {
                         return;
                     }
 
-                    chunk = chunk.slice(this._packetLength);
+                    chunk = chunk.subarray(this._packetLength);
                     this.reset();
 
                     try {
@@ -98,15 +98,15 @@ class Decoder implements C.IDecoder<any> {
 
                 if (chunk.length + this._bufLength >= this._packetLength) {
 
-                    let restLength = this._packetLength - this._bufLength;
+                    const restLength = this._packetLength - this._bufLength;
                     chunk.copy(this._buf, this._bufLength, 0, this._packetLength - this._bufLength);
-                    chunk = chunk.slice(restLength);
+                    chunk = chunk.subarray(restLength);
 
                     let data: any;
 
                     try {
 
-                        data = JSON.parse(this._buf.slice(0, this._packetLength).toString());
+                        data = JSON.parse(this._buf.subarray(0, this._packetLength).toString());
                     }
                     catch (e) {
 
@@ -137,13 +137,21 @@ class Decoder implements C.IDecoder<any> {
 
                 if (this._plBufLength) {
 
-                    if (this._plBufLength + chunk.byteLength >= 4) {
+                    if (this._plBufLength + chunk.byteLength >= 8) {
 
-                        chunk.copy(this._plBuf, this._plBufLength, 0, 4 - this._plBufLength);
+                        chunk.copy(this._plBuf, this._plBufLength, 0, 8 - this._plBufLength);
+
+                        chunk = chunk.subarray(8 - this._plBufLength);
+
+                        if (this._plBuf.readUInt32LE(0) !== 1) {
+
+                            this.onProtocolError(new GE.E_INVALID_PACKET());
+                            this.reset();
+                            return;
+                        }
 
-                        chunk = chunk.slice(4 - this._plBufLength);
                         this._plBufLength = 0;
-                        this._packetLength = this._plBuf.readUInt32LE(0);
+                        this._packetLength = this._plBuf.readUInt32LE(4);
                     }
                     else {
 
@@ -155,10 +163,17 @@ class Decoder implements C.IDecoder<any> {
                 }
                 else {
 
-                    if (chunk.length >= 4) {
+                    if (chunk.length >= 8) {
+
+                        if (chunk.readUInt32LE(0) !== 1) {
+
+                            this.onProtocolError(new GE.E_INVALID_PACKET());
+                            this.reset();
+                            return;
+                        }
 
-                        this._packetLength = chunk.readUInt32LE(0);
-                        chunk = chunk.slice(4);
+                        this._packetLength = chunk.readUInt32LE(4);
+                        chunk = chunk.subarray(8);
                         this._plBufLength = 0;
                     }
                     else {

package/src/lib/Encoder/Encoder.ts

@@ -22,16 +22,15 @@ class Encoder implements C.IEncoder {
 
         content = JSON.stringify(content);
 
-        const contentLength = Buffer.byteLength(content);
+        const ret = Buffer.allocUnsafe(8);
 
-        const ret = Buffer.allocUnsafe(contentLength + 4);
-
-        ret.writeUInt32LE(contentLength, 0);
-        ret.write(content, 4);
+        ret.writeUInt32LE(1, 0);
+        ret.writeUInt32LE(Buffer.byteLength(content), 4);
 
         if (socket.writable) {
 
             socket.write(ret);
+            socket.write(content);
         }
     }
 }

package/src/lib/Server/Common/Gateway.ts

@@ -20,6 +20,10 @@ export type IReplyCallbak = (data: IRawResponse) => void;
 
 export interface IGateway {
 
+    readonly host: string;
+
+    readonly port: number;
+
     onRequest?: (
         request: IRawRequest,
         reply: IReplyCallbak

package/src/lib/Server/Common/Request.ts

@@ -16,7 +16,9 @@
 
 import { IRawRequest } from '../../Common';
 
-export interface IRequest<T extends any = any> extends IRawRequest<T> {
+export interface IRequest<T = any> extends IRawRequest<T> {
 
     srt: number;
+
+    ip: string;
 }

package/src/lib/Server/Common/Router.ts

@@ -16,9 +16,14 @@
 
 import { IRequest } from './Request';
 
-export type IHandler<TAPI extends (...args: any[]) => any> = (...args: Parameters<TAPI>) => ReturnType<TAPI> | Promise<ReturnType<TAPI>>;
+export type IHandler<TApi extends (...args: any[]) => any> = (
+    ...args: Parameters<TApi>
+) => ReturnType<TApi> | Promise<ReturnType<TApi>>;
 
-export type IHandlerEx<TAPI extends (...args: any[]) => any> = (req: IRequest<Parameters<TAPI>>, ...args: Parameters<TAPI>) => ReturnType<TAPI> | Promise<ReturnType<TAPI>>;
+export type IHandlerEx<TApi extends (...args: any[]) => any> = (
+    req: IRequest<Parameters<TApi>>,
+    ...args: Parameters<TApi>
+) => ReturnType<TApi> | Promise<ReturnType<TApi>>;
 
 export interface IRouter {
 

package/src/lib/Server/Common/Server.ts

@@ -35,6 +35,13 @@ export interface IServer extends Events.IObservable<IServerEvents> {
      */
     addGateway(name: string, gateway: IGateway): this;
 
+    /**
+     * Get a mounted gateway by name.
+     *
+     * @param name      The name of the gateway.
+     */
+    getGateway(name: string): IGateway;
+
     /**
      * Unmount a gateway.
      *

package/src/lib/Server/Errors.ts

@@ -71,3 +71,10 @@ export const E_GATEWAY_BUSY = errorRegistry.register({
     metadata: {},
     type: 'public'
 });
+
+export const E_GATEWAY_NOT_FOUND = errorRegistry.register({
+    name: 'gateway_not_found',
+    message: 'No such a gateway.',
+    metadata: {},
+    type: 'public'
+});

package/src/lib/Server/Gateways/Http.ts

@@ -14,6 +14,7 @@
  * limitations under the License.
  */
 
+import * as $Net from 'net';
 import * as C from '../Common';
 import * as G from '../../Common';
 import * as E from '../Errors';
@@ -27,9 +28,28 @@ enum EStatus {
     CLOSING,
 }
 
+const INVALID_REQUEST_RESPONSE = Buffer.from('{"rid":"null","body":INVALID REQUEST,"sst":1698886839989,"srt":0,"code":4}');
+
+function refuseBadRequest(resp: $Http.ServerResponse): void {
+
+    try {
+
+        resp.writeHead(400, {
+            'content-length': INVALID_REQUEST_RESPONSE.byteLength,
+        });
+        const socket = resp.socket!;
+        resp.end(INVALID_REQUEST_RESPONSE);
+        socket.destroy();
+    }
+    catch {
+
+        // do nothing.
+    }
+}
+
 class HttpGateway implements C.IGateway {
 
-    private _server: $Http.Server = $Http.createServer(this._onRequest.bind(this));
+    private readonly _server: $Http.Server = $Http.createServer(this._onRequest.bind(this));
 
     private _status: EStatus = EStatus.IDLE;
 
@@ -41,16 +61,16 @@ class HttpGateway implements C.IGateway {
     ) => void;
 
     public constructor(
-        private _host: string,
-        private _port: number
+        public host: string,
+        public port: number,
+        private readonly _backlog?: number,
     ) { }
 
     private _onRequest(req: $Http.IncomingMessage, resp: $Http.ServerResponse): void {
 
         if (req.method !== 'POST' || !req.headers['content-length']) {
 
-            // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
-            resp.socket!.destroy();
+            refuseBadRequest(resp);
             return;
         }
 
@@ -58,8 +78,7 @@ class HttpGateway implements C.IGateway {
 
         if (!Number.isSafeInteger(length) || length > G.MAX_PACKET_SIZE) { // Maximum request packet is 64MB
 
-            // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
-            resp.socket!.destroy();
+            refuseBadRequest(resp);
             return;
         }
 
@@ -79,7 +98,7 @@ class HttpGateway implements C.IGateway {
 
                 req.removeAllListeners('end');
                 req.removeAllListeners('data');
-                req.destroy();
+                refuseBadRequest(resp);
                 return;
             }
 
@@ -91,11 +110,12 @@ class HttpGateway implements C.IGateway {
             try {
 
                 input = JSON.parse(buf as any);
+                input.ip = (req.socket.address() as any).address;
             }
             catch (e) {
 
+                refuseBadRequest(resp);
                 this.onError(e);
-                req.destroy();
                 return;
             }
 
@@ -130,11 +150,15 @@ class HttpGateway implements C.IGateway {
 
                 return new Promise((resolve, reject) => {
 
-                    this._server.listen(this._port, this._host)
+                    this._server.listen(this.port, this.host, this._backlog)
                         .once('listening', () => {
 
                             this._server.removeAllListeners('error');
                             this._status = EStatus.WORKING;
+                            if (this.port === 0) {
+
+                                this.port = (this._server.address() as $Net.AddressInfo).port;
+                            }
                             resolve();
                         })
                         .once('error', (e) => {
@@ -167,13 +191,13 @@ class HttpGateway implements C.IGateway {
             case EStatus.WORKING:
                 return new Promise((resolve) => {
 
-                    this._server.close(() => resolve());
+                    this._server.close(() => { resolve(); });
                 });
         }
     }
 }
 
-export function createHttpGateway(host: string, port: number): C.IGateway {
+export function createHttpGateway(host: string, port: number, backlog?: number): C.IGateway {
 
-    return new HttpGateway(host, port);
+    return new HttpGateway(host, port, backlog);
 }