rpclibrary/src/Frontend.ts

'use strict'

import bsock = require('bsock');

import * as T from './Types'; 
import * as I from './Interfaces';
import { stripAfterEquals, appendComma } from './Utils';



/**
 * A websocket-on-steroids with built-in RPC capabilities
 */
export class RPCSocket implements I.Socket{
    static async makeSocket<T extends T.RPCInterface = T.RPCInterface>(port:number, server: string, sesame?:string, conf?:T.SocketConf): Promise<RPCSocket & T> {
        const socket = new RPCSocket(port, server, conf)
        return await socket.connect<T>(sesame)
    }

    private socket: I.Socket
    private closeHandlers: T.CloseHandler[] = []
    private errorHandlers: T.ErrorHandler[] = []
    private hooks : {[name in string]: T.AnyFunction} = {} 

    /**
     * 
     * @param port Port to connect to
     * @param server Server address
     * @param tls @default false use TLS
     */
    constructor(public port:number, private server: string, private conf:T.SocketConf = { tls: false }){
        Object.defineProperty(this, 'socket', {value: undefined, writable: true})
    }

    /**
     * Hooks a handler to a function name. Use {@link call} to trigger it.
     * @param name The function name to listen on
     * @param handler The handler to attach
     */
    public hook(name: string, handler: (...args:any[]) => any | Promise<any>){
        if(!this.socket){
            this.hooks[name] = handler
        }else{
            this.socket.hook(name, handler)
        }
    }

    /**
     * Removes a {@link hook} listener by name.
     * @param name The function name 
     */
    public unhook(name: string){
        if(!this.socket){
            delete this.hooks[name]
        }else{
            this.socket.unhook(name)
        }
    }

    /**
     * Attach a listener to error or close events
     * @param type 'error' or 'close'
     * @param f The listener to attach
     */
    public on<T extends "error" | "close">(type: T, f: T.HandlerType[T]){
        if(!this.socket){
            switch(type){
                case "error": this.errorHandlers.push(<T.HandlerType['error']> f); break;
                case "close": this.closeHandlers.push(<T.HandlerType['close']> f); break;
                default: throw new Error('socket.on only supports ´error´ and ´close´ as first parameter. Got: ´'+type+'´')
            }
        }else{
            this.socket.on(type, f)
        }
    }

    /**
     * Destroys the socket
     */
    public destroy(){
        if(!this.socket) return;
        this.socket.destroy()
    }

    /**
     * Closes the socket. It may attempt to reconnect.
     */
    public close(){
        if(!this.socket) return;
        this.socket.close()
    }

    /**
     * Trigger a hooked handler on the server
     * @param rpcname The function to call
     * @param args other arguments
     */
    public async call (rpcname: string, ...args: any[]) : Promise<any>{
        if(!this.socket) throw new Error("The socket is not connected! Use socket.connect() first")
        return await this.socket.call.apply(this.socket, [rpcname, ...args])
    }

    /**
     * An alternative to call that does not wait for confirmation and doesn't return a value.
     * @param rpcname The function to call
     * @param args other arguments
     */
    public async fire(rpcname: string, ...args: any[]) : Promise<void>{
        if(!this.socket) throw new Error("The socket is not connected! Use socket.connect() first")
        await this.socket.fire.apply(this.socket, [rpcname, ...args])
    }
    
    /**
     * Connects to the server and attaches available RPCs to this object
     */
    public async connect<T extends T.RPCInterface= T.RPCInterface>( sesame?: string ) : Promise<RPCSocket & T>{
        this.socket = await bsock.connect(this.port, this.server, this.conf.tls?this.conf.tls:false)
        this.errorHandlers.forEach(h => this.socket.on('error', h))
        this.closeHandlers.forEach(h => this.socket.on('close', h))
        Object.entries(this.hooks).forEach((kv: [string, T.AnyFunction]) => {
            this.socket.hook(kv[0], kv[1])
        })

        const info:T.ExtendedRpcInfo[] = await this.info()
        info.forEach(i => {
            let f: any
            
            switch (i.type) {
                case 'Call':
                    f = this.callGenerator(i.uniqueName, i.argNames, sesame)    
                    break                
                case 'Hook':
                    f = this.frontEndHookGenerator(i.uniqueName, i.argNames, sesame)                    
                    break
            }
            if(this[i.owner] == null)
                this[i.owner] = {}
            this[i.owner][i.name] = f
            this[i.owner][i.name].bind(this)
        })
        return <RPCSocket & T.RPCInterface<T>> (this as any) 
    }

    /**
     * Get a list of available RPCs from the server
     */
    public async info(){
        if(!this.socket) throw new Error("The socket is not connected! Use socket.connect() first")
        return await this.socket.call('info')
    }

    /**
     * Utility {@link AsyncFunction} generator
     * @param fnName The function name
     * @param fnArgs A string-list of parameters
     */
    private callGenerator(fnName: string, fnArgs:string[], sesame?:string): T.AnyFunction{
        const headerArgs = fnArgs.join(",")
        const argParams = fnArgs.map(stripAfterEquals).join(",")
        sesame = appendComma(sesame)

        return eval(`async (${headerArgs}) => { return await this.socket.call("${fnName}", ${sesame} ${argParams})}`)
    }

    /**
     * Utility {@link HookFunction} generator
     * @param fnName The function name
     * @param fnArgs A string-list of parameters
     */
    private frontEndHookGenerator(fnName: string, fnArgs:string[], sesame?:string): T.HookFunction{
        
        if(sesame)
            fnArgs.shift()

        let headerArgs = fnArgs.join(",")
        const argParams = fnArgs.map(stripAfterEquals).join(",")
        sesame = appendComma(sesame, true)
        headerArgs = fnArgs.length>0?headerArgs+",":headerArgs 

        return eval( `
        async (${headerArgs} callback) => {

            const r = await this.socket.call("${fnName}", ${sesame} ${argParams})
            if(r && r.result === 'Success'){
                this.socket.hook(r.uuid, callback)
            }
            return r
        }`)
    }
}