import * as _ from 'lodash'; import * as WebSocket from 'websocket'; import { OrderbookChannel, OrderbookChannelHandler, OrderbookChannelMessageTypes, OrderbookChannelSubscriptionOpts, WebsocketClientEventType, WebsocketConnectionEventType, } from './types'; import { assert } from './utils/assert'; import { orderbookChannelMessageParser } from './utils/orderbook_channel_message_parser'; interface Subscription { subscriptionOpts: OrderbookChannelSubscriptionOpts; handler: OrderbookChannelHandler; } /** * This class includes all the functionality related to interacting with a websocket endpoint * that implements the standard relayer API v0 in a browser environment */ export class BrowserWebSocketOrderbookChannel implements OrderbookChannel { private _apiEndpointUrl: string; private _clientIfExists?: WebSocket.w3cwebsocket; private _subscriptions: Subscription[] = []; /** * Instantiates a new WebSocketOrderbookChannel instance * @param url The relayer API base WS url you would like to interact with * @return An instance of WebSocketOrderbookChannel */ constructor(url: string) { assert.isUri('url', url); this._apiEndpointUrl = url; } /** * Subscribe to orderbook snapshots and updates from the websocket * @param subscriptionOpts An OrderbookChannelSubscriptionOpts instance describing which * token pair to subscribe to * @param handler An OrderbookChannelHandler instance that responds to various * channel updates */ public subscribe(subscriptionOpts: OrderbookChannelSubscriptionOpts, handler: OrderbookChannelHandler): void { assert.isOrderbookChannelSubscriptionOpts('subscriptionOpts', subscriptionOpts); assert.isOrderbookChannelHandler('handler', handler); const newSubscription: Subscription = { subscriptionOpts, handler, }; this._subscriptions.push(newSubscription); const subscribeMessage = { type: 'subscribe', channel: 'orderbook', requestId: this._subscriptions.length - 1, payload: subscriptionOpts, }; if (_.isUndefined(this._clientIfExists)) { this._clientIfExists = new WebSocket.w3cwebsocket(this._apiEndpointUrl); this._clientIfExists.onopen = () => { this._sendMessage(subscribeMessage); }; this._clientIfExists.onerror = error => { this._alertAllHandlersToError(error); }; this._clientIfExists.onclose = () => { _.forEach(this._subscriptions, subscription => { subscription.handler.onClose(this, subscription.subscriptionOpts); }); }; this._clientIfExists.onmessage = message => { this._handleWebSocketMessage(message); }; } else { this._sendMessage(subscribeMessage); } } /** * Close the websocket and stop receiving updates */ public close(): void { if (!_.isUndefined(this._clientIfExists)) { this._clientIfExists.close(); } } /** * Send a message to the client if it has been instantiated and it is open */ private _sendMessage(message: any): void { if (!_.isUndefined(this._clientIfExists) && this._clientIfExists.readyState === WebSocket.w3cwebsocket.OPEN) { this._clientIfExists.send(JSON.stringify(message)); } } /** * For use in cases where we need to alert all handlers of an error */ private _alertAllHandlersToError(error: Error): void { _.forEach(this._subscriptions, subscription => { subscription.handler.onError(this, subscription.subscriptionOpts, error); }); } private _handleWebSocketMessage(message: any): void { // if we get a message with no data, alert all handlers and return if (_.isUndefined(message.data)) { this._alertAllHandlersToError(new Error(`Message does not contain utf8Data`)); return; } // try to parse the message data and route it to the correct handler try { const utf8Data = message.data; const parserResult = orderbookChannelMessageParser.parse(utf8Data); const subscription = this._subscriptions[parserResult.requestId]; if (_.isUndefined(subscription)) { this._alertAllHandlersToError(new Error(`Message has unknown requestId: ${utf8Data}`)); return; } const handler = subscription.handler; const subscriptionOpts = subscription.subscriptionOpts; switch (parserResult.type) { case OrderbookChannelMessageTypes.Snapshot: { handler.onSnapshot(this, subscriptionOpts, parserResult.payload); break; } case OrderbookChannelMessageTypes.Update: { handler.onUpdate(this, subscriptionOpts, parserResult.payload); break; } default: { handler.onError( this, subscriptionOpts, new Error(`Message has unknown type parameter: ${utf8Data}`), ); } } } catch (error) { this._alertAllHandlersToError(error); } } }