@litert/televoke 0.4.7 → 1.0.0-1

package/src/lib/Encoder/Decoder.ts

@@ -1,206 +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 GE from '../Errors';
-import * as C from '../Common';
-
-class Decoder implements C.IDecoder<any> {
-
-    public onData!: (data: any) => void;
-
-    /**
-     * When this event triggered, shutdown the socket.
-     */
-    public onProtocolError!: (e: unknown) => void;
-
-    /**
-     * When this event triggered, an unexpected exception thrown from server.
-     */
-    public onLogicError!: (e: unknown) => void;
-
-    private _buf!: Buffer;
-
-    private _bufLength!: number;
-
-    private _packetLength!: number;
-
-    private readonly _plBuf: Buffer = Buffer.allocUnsafe(8);
-
-    private _plBufLength: number = 0;
-
-    public constructor() {
-
-        this._buf = Buffer.allocUnsafe(65536);
-
-        this.reset();
-    }
-
-    public reset(): void {
-
-        this._bufLength = 0;
-
-        this._packetLength = 0;
-    }
-
-    public decode(chunk: Buffer): void {
-
-        while (1) {
-
-            if (!chunk.length) {
-
-                break;
-            }
-
-            if (this._packetLength) {
-
-                if (!this._bufLength && chunk.length >= this._packetLength) {
-
-                    let data: any;
-
-                    try {
-
-                        data = JSON.parse(chunk.subarray(0, this._packetLength).toString());
-                    }
-                    catch (e) {
-
-                        this.reset();
-                        this.onProtocolError(e);
-                        return;
-                    }
-
-                    chunk = chunk.subarray(this._packetLength);
-                    this.reset();
-
-                    try {
-
-                        this.onData(data);
-                    }
-                    catch (e) {
-
-                        this.onLogicError(e);
-                    }
-
-                    continue;
-                }
-
-                if (chunk.length + this._bufLength >= this._packetLength) {
-
-                    const restLength = this._packetLength - this._bufLength;
-                    chunk.copy(this._buf, this._bufLength, 0, this._packetLength - this._bufLength);
-                    chunk = chunk.subarray(restLength);
-
-                    let data: any;
-
-                    try {
-
-                        data = JSON.parse(this._buf.subarray(0, this._packetLength).toString());
-                    }
-                    catch (e) {
-
-                        this.reset();
-                        this.onProtocolError(e);
-                        return;
-                    }
-
-                    this.reset();
-
-                    try {
-
-                        this.onData(data);
-                    }
-                    catch (e) {
-
-                        this.onLogicError(e);
-                    }
-                }
-                else {
-
-                    chunk.copy(this._buf, this._bufLength);
-                    this._bufLength += chunk.length;
-                    return;
-                }
-            }
-            else {
-
-                if (this._plBufLength) {
-
-                    if (this._plBufLength + chunk.byteLength >= 8) {
-
-                        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;
-                        }
-
-                        this._plBufLength = 0;
-                        this._packetLength = this._plBuf.readUInt32LE(4);
-                    }
-                    else {
-
-                        chunk.copy(this._plBuf, this._plBufLength);
-
-                        this._plBufLength += chunk.byteLength;
-                        return;
-                    }
-                }
-                else {
-
-                    if (chunk.length >= 8) {
-
-                        if (chunk.readUInt32LE(0) !== 1) {
-
-                            this.onProtocolError(new GE.E_INVALID_PACKET());
-                            this.reset();
-                            return;
-                        }
-
-                        this._packetLength = chunk.readUInt32LE(4);
-                        chunk = chunk.subarray(8);
-                        this._plBufLength = 0;
-                    }
-                    else {
-
-                        chunk.copy(this._plBuf, this._plBufLength);
-
-                        this._plBufLength = chunk.byteLength;
-                        return;
-                    }
-                }
-
-                if (this._packetLength > C.MAX_PACKET_SIZE) { // Maximum packet size is 64M
-
-                    this.onProtocolError(new GE.E_PACKET_TOO_LARGE());
-                    this.reset();
-                }
-
-                if (this._buf.byteLength < this._packetLength) {
-
-                    this._buf = Buffer.allocUnsafe(this._packetLength);
-                }
-            }
-        }
-    }
-}
-
-export function createDecoder<T>(): C.IDecoder<T> {
-
-    return new Decoder();
-}

package/src/lib/Encoder/Encoder.ts

@@ -1,41 +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 C from '../Common';
-
-class Encoder implements C.IEncoder {
-
-    public encode(socket: C.IWritable, content: any): void {
-
-        content = JSON.stringify(content);
-
-        const ret = Buffer.allocUnsafe(8);
-
-        ret.writeUInt32LE(1, 0);
-        ret.writeUInt32LE(Buffer.byteLength(content), 4);
-
-        if (socket.writable) {
-
-            socket.write(ret);
-            socket.write(content);
-        }
-    }
-}
-
-export function createEncoder(): C.IEncoder {
-
-    return new Encoder();
-}

package/src/lib/Encoder/Errors.ts

@@ -1,24 +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 E from '../Errors';
-
-export const E_INVALID_LEADING_PACKET = E.errorRegistry.register({
-    name: 'invalid_leading_packet',
-    message: 'A leading packet must be at least 4 bytes.',
-    metadata: {},
-    type: 'public'
-});

package/src/lib/Errors.ts

@@ -1,40 +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 $Exceptions from '@litert/exception';
-
-export const errorRegistry = $Exceptions.createExceptionRegistry({
-    'module': 'televoke.litert.org',
-    'types': {
-        'public': {
-            'index': $Exceptions.createIncreaseCodeIndex(1)
-        }
-    }
-});
-
-export const E_PACKET_TOO_LARGE = errorRegistry.register({
-    name: 'packet_too_large',
-    message: 'The packet is larger than the maximum size of packet.',
-    metadata: {},
-    type: 'public'
-});
-
-export const E_INVALID_PACKET = errorRegistry.register({
-    name: 'invalid_packet',
-    message: 'The packet is invalid.',
-    metadata: {},
-    type: 'public'
-});

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

@@ -1,37 +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 { IRawRequest, IRawResponse } from '../../Common';
-
-export type IReplyCallbak = (data: IRawResponse) => void;
-
-export interface IGateway {
-
-    readonly host: string;
-
-    readonly port: number;
-
-    onRequest?: (
-        request: IRawRequest,
-        reply: IReplyCallbak
-    ) => void;
-
-    onError?: (e: unknown) => void;
-
-    start(): Promise<void>;
-
-    close(): Promise<void>;
-}

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

@@ -1,24 +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 { IRawRequest } from '../../Common';
-
-export interface IRequest<T = any> extends IRawRequest<T> {
-
-    srt: number;
-
-    ip: string;
-}

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

@@ -1,52 +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 { IRequest } from './Request';
-
-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 interface IRouter {
-
-    /**
-     * Try routing by the API name, and return the descriptor of the API.
-     *
-     * @param name  The name of API requested by client.
-     */
-    route(name: string): unknown | null;
-
-    /**
-     * Execute the determined API.
-     *
-     * @param request       The context object of current request.
-     * @param descriptor    The descriptor of the API.
-     */
-    execute(request: IRequest, descriptor: unknown): Promise<any>;
-
-    /**
-     * Validate the arguments inside the request.
-     *
-     * @param request       The context object of current request.
-     * @param descriptor    The descriptor of the API.
-     */
-    validate(request: IRequest, descriptor: unknown): boolean;
-}

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

@@ -1,68 +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 { IGateway } from './Gateway';
-import { IRouter } from './Router';
-import { Events } from '@litert/observable';
-
-export interface IServerEvents extends Events.ICallbackDefinitions {
-
-    /* eslint-disable @typescript-eslint/naming-convention */
-    handler_error(e: unknown): void;
-    /* eslint-enable @typescript-eslint/naming-convention */
-}
-
-export interface IServer extends Events.IObservable<IServerEvents> {
-
-    /**
-     * Mount a new gateway.
-     *
-     * @param name      The name of the gateway.
-     * @param gateway   The gateway object.
-     */
-    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.
-     *
-     * @param name      The name of the gateway.
-     */
-    removeGateway(name: string): this;
-
-    /**
-     * Inject a router object for the server.
-     *
-     * @param router    The router object.
-     */
-    setRouter(router: IRouter): this;
-
-    /**
-     * Start the server.
-     */
-    start(): Promise<void>;
-
-    /**
-     * Stop the server.
-     */
-    close(): Promise<void>;
-}

package/src/lib/Server/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 './Gateway';
-export * from './Request';
-export * from './Router';
-export * from './Server';

package/src/lib/Server/Errors.ts

@@ -1,80 +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 { errorRegistry } from '../Errors';
-
-export const E_GATEWAY_STARTING = errorRegistry.register({
-    name: 'gateway_starting',
-    message: 'A gateway has already been starting.',
-    metadata: {},
-    type: 'public'
-});
-
-export const E_GATEWAY_CLOSING = errorRegistry.register({
-    name: 'gateway_closing',
-    message: 'A gateway has already been closing.',
-    metadata: {},
-    type: 'public'
-});
-
-export const E_SERVER_STARTING = errorRegistry.register({
-    name: 'server_starting',
-    message: 'A server has already been starting.',
-    metadata: {},
-    type: 'public'
-});
-
-export const E_SERVER_CLOSING = errorRegistry.register({
-    name: 'server_closing',
-    message: 'A server has already been closing.',
-    metadata: {},
-    type: 'public'
-});
-
-export const E_SERVER_BUSY = errorRegistry.register({
-    name: 'server_busy',
-    message: 'It is not able to update server currnetly.',
-    metadata: {},
-    type: 'public'
-});
-
-export const E_NO_SERVER_ATTACHED = errorRegistry.register({
-    name: 'no_server_attached',
-    message: 'The gateway does not attach to a server.',
-    metadata: {},
-    type: 'public'
-});
-
-export const E_SERVER_NOT_READY = errorRegistry.register({
-    name: 'server_not_ready',
-    message: 'The server is not setup completely.',
-    metadata: {},
-    type: 'public'
-});
-
-export const E_GATEWAY_BUSY = errorRegistry.register({
-    name: 'gateway_busy',
-    message: 'The gateway has been attached to a server.',
-    metadata: {},
-    type: 'public'
-});
-
-export const E_GATEWAY_NOT_FOUND = errorRegistry.register({
-    name: 'gateway_not_found',
-    message: 'No such a gateway.',
-    metadata: {},
-    type: 'public'
-});