@litert/televoke 0.4.6 → 1.0.0-0

package/src/lib/Client/TLSClient.ts

@@ -1,422 +0,0 @@
-/**
- * Copyright 2021 Angus.Fenying <fenying@litert.org>
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *   https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-import * as $TLS from 'tls';
-import * as C from './Common';
-import * as G from '../Common';
-import { Promises, Events } from '@litert/observable';
-import * as E from './Errors';
-import { createDecoder } from '../Encoder/Decoder';
-import { createEncoder } from '../Encoder/Encoder';
-
-enum EStatus {
-
-    IDLE,
-    CONNECTING,
-    CLOSING,
-    WORKING,
-}
-
-interface IRequest {
-
-    api: string;
-
-    cst: number;
-
-    returnRaw: boolean;
-
-    pr: Promises.IPromiseHandle;
-
-    timer?: NodeJS.Timeout;
-
-    packet?: G.IRawRequest;
-}
-
-class TLSClient extends Events.EventEmitter<Events.ICallbackDefinitions> implements C.IClient {
-
-    private static readonly _$promises = Promises.getGlobalFactory();
-
-    private static _$clientCounter = 0;
-
-    private _socket!: $TLS.TLSSocket;
-
-    private _status: EStatus = EStatus.IDLE;
-
-    private readonly _clientId: number = TLSClient._$clientCounter++;
-
-    private readonly _connPrId: string;
-
-    private readonly _closePrId: string;
-
-    private _sent: Record<string, IRequest> = {};
-
-    private _sentQty: number = 0;
-
-    private _sending: Record<string, IRequest> = {};
-
-    private _sendingQty: number = 0;
-
-    private readonly _encoder = createEncoder();
-
-    public constructor(
-        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();
-
-        this._connPrId = `litert:televoke:tcp:client:${this._clientId}:connect`;
-        this._closePrId = `litert:televoke:tcp:client:${this._clientId}:close`;
-    }
-
-    public invoke(api: any, ...args: any[]): Promise<any> {
-
-        return this._call(api, false, args);
-    }
-
-    public call(api: any, ...args: any[]): Promise<any> {
-
-        return this._call(api, true, args);
-    }
-
-    private _call(api: any, returnRaw: boolean, args: any[]): Promise<any> {
-
-        const rid = this._ridGenerator();
-
-        let pr: Promises.IPromiseHandle;
-
-        switch (this._status) {
-
-            case EStatus.IDLE:
-                return Promise.reject(new E.E_CONN_NOT_READY());
-            case EStatus.WORKING: {
-                const NOW = Date.now();
-                this._encoder.encode(this._socket, {
-                    ttl: this._timeout,
-                    rid,
-                    cst: NOW,
-                    args,
-                    api: this._apiNameWrapper ? this._apiNameWrapper(api) : api
-                });
-                this._sentQty++;
-                this._sent[rid] = {
-                    api,
-                    cst: NOW,
-                    returnRaw,
-                    pr: pr = TLSClient._$promises.createPromise(),
-                    timer: this._timeout > 0 ? setTimeout(() => {
-
-                        const req = this._sent[rid];
-
-                        if (req) {
-
-                            delete this._sent[rid];
-                            this._sentQty--;
-                            req.pr.reject(new E.E_REQUEST_TIMEOUT({
-                                metadata: { api: req.api, requestId: rid, time: req.cst, details: null }
-                            }));
-                        }
-
-                        if (this._status === EStatus.CLOSING && !this._sentQty) {
-
-                            this._socket.destroy();
-                            this._status = EStatus.IDLE;
-                        }
-
-                    }, this._timeout) : undefined
-                };
-                break;
-            }
-            case EStatus.CONNECTING: {
-                const NOW = Date.now();
-                this._sendingQty++;
-                this._sending[rid] = {
-                    api,
-                    pr: pr = TLSClient._$promises.createPromise(),
-                    cst: NOW,
-                    returnRaw,
-                    packet: {
-                        ttl: this._timeout,
-                        rid,
-                        cst: NOW,
-                        args,
-                        api: this._apiNameWrapper ? this._apiNameWrapper(api) : api
-                    },
-                    timer: this._timeout > 0 ? setTimeout(() => {
-
-                        let req = this._sent[rid];
-
-                        if (req) {
-
-                            delete this._sent[rid];
-
-                            this._sentQty--;
-
-                            req.pr.reject(new E.E_REQUEST_TIMEOUT({
-                                metadata: { api: req.api, requestId: rid, time: req.cst, details: null }
-                            }));
-
-                            if (this._status === EStatus.CLOSING && !this._sentQty) {
-
-                                this._socket.destroy();
-                                this._status = EStatus.IDLE;
-                            }
-
-                            return;
-                        }
-
-                        req = this._sending[rid];
-
-                        if (req) {
-
-                            delete this._sending[rid];
-
-                            this._sendingQty--;
-
-                            req.pr.reject(new E.E_REQUEST_TIMEOUT({
-                                metadata: { api: req.api, requestId: rid, time: req.cst, details: null }
-                            }));
-
-                            if (this._status === EStatus.CLOSING && !this._sentQty) {
-
-                                this._socket.destroy();
-                                this._status = EStatus.IDLE;
-                            }
-                        }
-
-                    }, this._timeout) : undefined
-                };
-
-                break;
-            }
-            case EStatus.CLOSING:
-                throw new E.E_CONN_CLOSING();
-        }
-
-        return pr.promise;
-    }
-
-    public connect(): Promise<void> {
-
-        switch (this._status) {
-
-            case EStatus.WORKING:
-                return Promise.resolve();
-            case EStatus.CONNECTING:
-                return TLSClient._$promises.findPromise(this._connPrId)!.promise;
-            case EStatus.CLOSING:
-                this._status = EStatus.WORKING;
-                break;
-            case EStatus.IDLE:
-                break;
-        }
-
-        this._socket = $TLS.connect({
-            host: this._host,
-            port: this._port,
-            ...this._tlsOptions
-        });
-
-        const pr = TLSClient._$promises.createPromise({ id: this._connPrId });
-
-        this._socket.once('connect', () => {
-
-            this._status = EStatus.WORKING;
-
-            this._socket.removeAllListeners('error');
-
-            const decoder = createDecoder<G.IRawResponse>();
-
-            decoder.onLogicError = (e: unknown) => this.emit('error', e);
-            decoder.onProtocolError = (e: unknown) => this.emit('error', e);
-
-            decoder.onData = (rawData: G.IRawResponse): void => {
-
-                const data = rawData as C.IResponse<any>;
-
-                const req = this._sent[data.rid];
-
-                if (!req) {
-
-                    return;
-                }
-
-                data.cst = req.cst;
-                data.crt = Date.now();
-
-                this._sentQty--;
-                delete this._sent[data.rid];
-
-                if (req.timer) {
-
-                    clearTimeout(req.timer);
-                }
-
-                if (this._status === EStatus.CLOSING && !this._sentQty) {
-
-                    this._socket.end();
-                    this._status = EStatus.IDLE;
-                }
-
-                switch (data.code) {
-                    case G.EResponseCode.OK:
-                        req.pr.resolve(req.returnRaw ? data : data.body);
-                        break;
-                    case G.EResponseCode.SYSTEM_ERROR:
-                        req.pr.reject(new E.E_SERVER_INTERNAL_ERROR({
-                            api: req.api, ...data
-                        }));
-                        break;
-                    case G.EResponseCode.FAILURE:
-                        req.pr.reject(new E.E_SERVER_LOGIC_FAILURE({
-                            api: req.api, ...data
-                        }));
-                        break;
-                    case G.EResponseCode.API_NOT_FOUND:
-                        req.pr.reject(new E.E_API_NOT_FOUND({
-                            api: req.api, ...data
-                        }));
-                        break;
-                    default:
-                        req.pr.reject(new E.E_SERVER_UNKNOWN_ERROR({
-                            api: req.api, ...data
-                        }));
-                        break;
-                }
-            };
-
-            this._socket.on('data', decoder.decode.bind(decoder)).on('end', () => {
-
-                if (this._sentQty) {
-
-                    const ls = this._sent;
-
-                    this._sent = {};
-
-                    for (const rid in ls) {
-
-                        this._sent[rid].pr.reject(new E.E_CONN_LOST());
-                    }
-
-                    this._sentQty = 0;
-                }
-            });
-
-            if (this._sendingQty) {
-
-                for (const rid in this._sending) {
-
-                    const req = this._sending[rid];
-
-                    this._encoder.encode(this._socket, req.packet);
-
-                    this._sent[rid] = req;
-                    this._sentQty++;
-                    delete req.packet;
-                }
-
-                this._sending = {};
-                this._sendingQty = 0;
-            }
-
-            pr.resolve();
-
-        }).once('error', (e) => {
-
-            this._socket = undefined as any;
-            pr.reject(e);
-        });
-
-        return pr.promise;
-    }
-
-    public close(): Promise<void> {
-
-        switch (this._status) {
-
-            case EStatus.IDLE:
-                return Promise.resolve();
-            case EStatus.CLOSING:
-                return TLSClient._$promises.findPromise(this._closePrId)!.promise;
-            case EStatus.WORKING:
-                break;
-            case EStatus.CONNECTING:
-                TLSClient._$promises.findPromise(this._connPrId)!.reject(new E.E_OPERATION_ABORTED());
-        }
-
-        if (this._sentQty) {
-
-            this._status = EStatus.CLOSING;
-
-            return TLSClient._$promises.createPromise({ id: this._closePrId }).promise;
-        }
-
-        if (this._sendingQty) {
-
-            for (const rid in this._sending) {
-
-                const req = this._sending[rid];
-
-                req.pr.reject(new E.E_CONN_LOST({
-                    metadata: { api: req.api, requestId: rid, time: Date.now(), details: null }
-                }));
-            }
-
-            this._sending = {};
-        }
-
-        this._socket.destroy();
-        this._socket = undefined as any;
-        this._status = EStatus.IDLE;
-        return Promise.resolve();
-    }
-}
-
-export interface ITLSClientOptions {
-
-    host: string;
-
-    /**
-     * The port of TLS server.
-     *
-     * @default 443
-     */
-    port?: number;
-
-    ridGenerator: C.IRIDGenerator;
-
-    timeout?: number;
-
-    apiNameWrapper?: (name: string) => string;
-
-    tlsOptions?: $TLS.ConnectionOptions;
-}
-
-export function createTLSClient<TAPIs extends G.IServiceAPIs>(opts: ITLSClientOptions): C.IClient<TAPIs> {
-
-    return new TLSClient(
-        opts.host,
-        opts.port ?? 443,
-        opts.ridGenerator,
-        opts.timeout,
-        opts.apiNameWrapper,
-        opts.tlsOptions
-    );
-}

package/src/lib/Client/index.ts

@@ -1,23 +0,0 @@
-/**
- * Copyright 2021 Angus.Fenying <fenying@litert.org>
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *   https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-export * from './Errors';
-export * from './Common';
-export * from './TCPClient';
-export * from './TLSClient';
-export * from './HttpClient';
-export * from './HttpsClient';
-export * from './BuiltInRIDGenerator';

package/src/lib/Common/API.ts

@@ -1,20 +0,0 @@
-/**
- * Copyright 2021 Angus.Fenying <fenying@litert.org>
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *   https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-// eslint-disable-next-line @typescript-eslint/no-empty-interface
-export interface IServiceAPIs {}
-
-export type IFunction = (...args: any[]) => any;

package/src/lib/Common/Encoding.ts

@@ -1,42 +0,0 @@
-/**
- * Copyright 2021 Angus.Fenying <fenying@litert.org>
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *   https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-export const MAX_PACKET_SIZE = 67108864;
-
-export interface IWritable {
-
-    write(buf: Buffer | string, cb?: () => void): void;
-
-    writable: boolean;
-}
-
-export interface IEncoder {
-
-    encode(socket: IWritable, content: any): void;
-}
-
-export interface IDecoder<T> {
-
-    onProtocolError: (e: unknown) => void;
-
-    onLogicError: (e: unknown) => void;
-
-    onData: (data: T) => void;
-
-    decode(chunk: Buffer): void;
-
-    reset(): void;
-}

package/src/lib/Common/Request.ts

@@ -1,28 +0,0 @@
-/**
- * Copyright 2021 Angus.Fenying <fenying@litert.org>
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *   https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-export interface IRawRequest<T = any> {
-
-    ttl: number;
-
-    api: string;
-
-    args: T;
-
-    cst: number;
-
-    rid: string | number;
-}

package/src/lib/Common/Response.ts

@@ -1,67 +0,0 @@
-/**
- * Copyright 2021 Angus.Fenying <fenying@litert.org>
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *   https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-export enum EResponseCode {
-
-    /**
-     * API was called succeed
-     */
-    OK,
-    /**
-     * The invoked API does not exist on the remote server.
-     */
-    API_NOT_FOUND,
-    /**
-     * Some unexpected error happened.
-     */
-    SYSTEM_ERROR,
-    /**
-     * Logical error happened inside the API handler.
-     */
-    FAILURE,
-    /**
-     * The arguments inside the request is malformed.
-     */
-    MALFORMED_ARGUMENTS
-}
-
-export interface IRawResponse<T = any> {
-
-    /**
-     * The time when server sent the response.
-     */
-    sst: number;
-
-    /**
-     * The time when server received the request.
-     */
-    srt: number;
-
-    /**
-     * The identity of the request.
-     */
-    rid: string | number;
-
-    /**
-     * The protocol status code of the response.
-     */
-    code: number;
-
-    /**
-     * The content of API response.
-     */
-    body: T;
-}

package/src/lib/Common/index.ts

@@ -1,20 +0,0 @@
-/**
- * Copyright 2021 Angus.Fenying <fenying@litert.org>
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *   https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-export * from './Encoding';
-export * from './Request';
-export * from './Response';
-export * from './API';