All files / src/peer inbound.ts

92.31% Statements 36/39
71.43% Branches 5/7
83.33% Functions 10/12
92.31% Lines 36/39

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132                                41x           41x                 41x             41x 2054x     41x                           2054x 2054x 2054x 215x   2054x 2032x     2032x 2032x   2032x           2054x 2x   2054x 2054x       3x 3x 3x             3999x 3999x 3999x       2x 2x                       2057x 2057x 2057x     2057x 2057x             4002x 4002x     4002x 4002x      
/*
 * Copyright © 2019 Lisk Foundation
 *
 * See the LICENSE file at the top-level directory of this distribution
 * for licensing information.
 *
 * Unless otherwise agreed in a custom licensing agreement with the Lisk Foundation,
 * no part of this software, including this file, may be copied, modified,
 * propagated, or distributed except according to the terms contained in the
 * LICENSE file.
 *
 * Removal or modification of this copyright notice is prohibited.
 *
 */
import { SCServerSocket } from 'socketcluster-server';
 
import {
	ConnectionKind,
	DEFAULT_PING_INTERVAL_MAX,
	DEFAULT_PING_INTERVAL_MIN,
	INTENTIONAL_DISCONNECT_CODE,
} from '../constants';
import {
	EVENT_CLOSE_INBOUND,
	EVENT_INBOUND_SOCKET_ERROR,
	REMOTE_EVENT_PING,
	REMOTE_SC_EVENT_MESSAGE,
	REMOTE_SC_EVENT_RPC_REQUEST,
} from '../events';
import { P2PPeerInfo } from '../p2p_types';
 
import {
	Peer,
	PeerConfig,
	SCServerSocketUpdated,
	socketErrorStatusCodes,
} from './base';
 
const getRandomPingDelay = () =>
	Math.random() * (DEFAULT_PING_INTERVAL_MAX - DEFAULT_PING_INTERVAL_MIN) +
	DEFAULT_PING_INTERVAL_MIN;
 
export class InboundPeer extends Peer {
	protected _socket: SCServerSocketUpdated;
	protected readonly _handleInboundSocketError: (error: Error) => void;
	protected readonly _handleInboundSocketClose: (
		code: number,
		reason: string | undefined,
	) => void;
	private _pingTimeoutId: NodeJS.Timer;
 
	public constructor(
		peerInfo: P2PPeerInfo,
		peerSocket: SCServerSocket,
		peerConfig: PeerConfig,
	) {
		super(peerInfo, peerConfig);
		this._peerInfo.internalState.connectionKind = ConnectionKind.INBOUND;
		this._handleInboundSocketError = (error: Error) => {
			this.emit(EVENT_INBOUND_SOCKET_ERROR, error);
		};
		this._handleInboundSocketClose = (code, reasonMessage) => {
			const reason = reasonMessage
				? reasonMessage
				: socketErrorStatusCodes[code] || 'Unknown reason';
			Eif (this._pingTimeoutId) {
				clearTimeout(this._pingTimeoutId);
			}
			this.emit(EVENT_CLOSE_INBOUND, {
				peerInfo,
				code,
				reason,
			});
		};
		this._pingTimeoutId = setTimeout(() => {
			this._sendPing();
		}, getRandomPingDelay());
		this._socket = peerSocket;
		this._bindHandlersToInboundSocket(this._socket);
	}
 
	public set socket(scServerSocket: SCServerSocket) {
		this._unbindHandlersFromInboundSocket(this._socket);
		this._socket = scServerSocket as SCServerSocketUpdated;
		this._bindHandlersToInboundSocket(this._socket);
	}
 
	public disconnect(
		code: number = INTENTIONAL_DISCONNECT_CODE,
		reason?: string,
	): void {
		super.disconnect(code, reason);
		clearTimeout(this._pingTimeoutId);
		this._unbindHandlersFromInboundSocket(this._socket);
	}
 
	private _sendPing(): void {
		const pingStart = Date.now();
		this._socket.emit(REMOTE_EVENT_PING, undefined, () => {
			this._peerInfo.internalState.latency = Date.now() - pingStart;
			this._pingTimeoutId = setTimeout(() => {
				this._sendPing();
			}, getRandomPingDelay());
		});
	}
 
	// All event handlers for the inbound socket should be bound in this method.
	private _bindHandlersToInboundSocket(
		inboundSocket: SCServerSocketUpdated,
	): void {
		inboundSocket.on('close', this._handleInboundSocketClose);
		inboundSocket.on('error', this._handleInboundSocketError);
		inboundSocket.on('message', this._handleWSMessage);
 
		// Bind RPC and remote event handlers
		inboundSocket.on(REMOTE_SC_EVENT_RPC_REQUEST, this._handleRawRPC);
		inboundSocket.on(REMOTE_SC_EVENT_MESSAGE, this._handleRawMessage);
	}
 
	// All event handlers for the inbound socket should be unbound in this method.
	private _unbindHandlersFromInboundSocket(
		inboundSocket: SCServerSocket,
	): void {
		inboundSocket.off('close', this._handleInboundSocketClose);
		inboundSocket.off('message', this._handleWSMessage);
 
		// Unbind RPC and remote event handlers
		inboundSocket.off(REMOTE_SC_EVENT_RPC_REQUEST, this._handleRawRPC);
		inboundSocket.off(REMOTE_SC_EVENT_MESSAGE, this._handleRawMessage);
	}
}