# All files / web3-providers-ws/src index.js

33.61% Statements 40/119
8.33% Branches 4/48
38.1% Functions 8/21
33.61% Lines 40/119

    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
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    224
    225
    226
    227
    228
    229
    230
    231
    232
    233
    234
    235
    236
    237
    238
    239
    240
    241
    242
    243
    244
    245
    246
    247
    248
    249
    250
    251
    252
    253
    254
    255
    256
    257
    258
    259
    260
    261
    262
    263
    264
    265
    266
    267
    268
    269
    270
    271
    272
    273
    274
    275
    276
    277
    278
    279
    280
    281
    282
    283
    284
    285
    286
    287
    288
    289
    290
    291
    292
    293
    294
    295
    296
    297
    298
    299
    300
    301
    302
    303
    304
    305
    306
    307
    308
    309
    310
    311
    312
    313
    314
    315
    316
    317
    318
    319
    320
    321
    322
    323
    324
    325
    326
    327
    328
    329
    330
    331
    332
    333
    334
    335
    336
    337
    338

    1x
    1x

    1x
    1x

    1x

    1x
    36x
    36x
    36x
    36x

    36x

    36x

    1x
    72x

    72x
    36x

    72x
    36x

    36x

    36x

    36x
    68x
    68x

    1x

    1x

    1x
    108x

    1x

    1x

    68x

    68x

    68x
    68x

    1x

    1x

    1x
    36x
    36x

    36x

    1x

     /*
     This file is part of web3.js.

     web3.js is free software: you can redistribute it and/or modify
     it under the terms of the GNU Lesser General Public License as published by
     the Free Software Foundation, either version 3 of the License, or
     (at your option) any later version.

     web3.js is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     GNU Lesser General Public License for more details.

     You should have received a copy of the GNU Lesser General Public License
     along with web3.js.  If not, see <http://www.gnu.org/licenses/>.
     */
    /** @file WebsocketProvider.js
     * @authors:
     *   Fabian Vogelsteller <fabian@ethereum.org>
     * @date 2017
     */

    "use strict";

    var _ = require('underscore');
    var errors = require('web3-core-helpers').errors;

    var Ws = null;
    Iif (typeof window !== 'undefined') {
        Ws = window.WebSocket;
    } else {
        Ws = require('websocket').w3cwebsocket;
    }
    // Default connection ws://localhost:8546

    var WebsocketProvider = function WebsocketProvider(url)  {
        var _this = this;
        this.responseCallbacks = {};
        this.notificationCallbacks = [];
        this.connection = new Ws(url);

        this.addDefaultEvents();

        // LISTEN FOR CONNECTION RESPONSES
        this.connection.onmessage = function(e) {
            var data = (typeof e.data === 'string') ? e.data : '';

            _this._parseResponse(data).forEach(function(result){

                var id = null;

                // get the id which matches the returned id
                if(_.isArray(result)) {
                    result.forEach(function(load){
                        if(_this.responseCallbacks[load.id])
                            id = load.id;
                    });
                } else {
                    id = result.id;
                }

                // notification
                if(!id && result.method.indexOf('_subscription') !== -1) {
                    _this.notificationCallbacks.forEach(function(callback){
                        if(_.isFunction(callback))
                            callback(null, result);
                    });

                    // fire the callback
                } else if(_this.responseCallbacks[id]) {
                    _this.responseCallbacks[id](null, result);
                    delete _this.responseCallbacks[id];
                }
            });
        };
    };

    /**
     Will add the error and end event to timeout existing calls

     @method addDefaultEvents
     */
    WebsocketProvider.prototype.addDefaultEvents = function(){
        var _this = this;

        this.connection.onerror = function(){
            _this._timeout();
        };

        this.connection.onclose = function(e){
            _this._timeout();

            var noteCb = _this.notificationCallbacks;

            // reset all requests and callbacks
            _this.reset();

            // cancel subscriptions
            noteCb.forEach(function (callback) {
                Eif (_.isFunction(callback))
                    callback(e);
            });
        };

        // this.connection.on('timeout', function(){
        //     _this._timeout();
        // });
    };

    /**
     Will parse the response and make an array out of it.

     @method _parseResponse
     @param {String} data
     */
    WebsocketProvider.prototype._parseResponse = function(data) {
        var _this = this,
            returnValues = [];

        // DE-CHUNKER
        var dechunkedData = data
            .replace(/\}[\n\r]?\{/g,'}|--|{') // }{
            .replace(/\}\][\n\r]?\[\{/g,'}]|--|[{') // }][{
            .replace(/\}[\n\r]?\[\{/g,'}|--|[{') // }[{
            .replace(/\}\][\n\r]?\{/g,'}]|--|{') // }]{
            .split('|--|');

        dechunkedData.forEach(function(data){

            // prepend the last chunk
            if(_this.lastChunk)
                data = _this.lastChunk + data;

            var result = null;

            try {
                result = JSON.parse(data);

            } catch(e) {

                _this.lastChunk = data;

                // start timeout to cancel all requests
                clearTimeout(_this.lastChunkTimeout);
                _this.lastChunkTimeout = setTimeout(function(){
                    _this._timeout();
                    throw errors.InvalidResponse(data);
                }, 1000 * 15);

                return;
            }

            // cancel timeout and set chunk to null
            clearTimeout(_this.lastChunkTimeout);
            _this.lastChunk = null;

            if(result)
                returnValues.push(result);
        });

        return returnValues;
    };

    /**
     Get the adds a callback to the responseCallbacks object,
     which will be called if a response matching the response Id will arrive.

     @method _addResponseCallback
     */
    WebsocketProvider.prototype._addResponseCallback = function(payload, callback) {
        var id = payload.id || payload[0].id;
        var method = payload.method || payload[0].method;

        this.responseCallbacks[id] = callback;
        this.responseCallbacks[id].method = method;
    };

    /**
     Timeout all requests when the end/error event is fired

     @method _timeout
     */
    WebsocketProvider.prototype._timeout = function() {
        for(var key in this.responseCallbacks) {
            if(this.responseCallbacks.hasOwnProperty(key)){
                this.responseCallbacks[key](errors.InvalidConnection('on IPC'));
                delete this.responseCallbacks[key];
            }
        }
    };

    WebsocketProvider.prototype.send = function (payload, callback) {
        var _this = this;

        if (this.connection.readyState === this.connection.CONNECTING) {
            setTimeout(function () {
                _this.send(payload, callback);
            }, 10);
            return;
        }

        // try reconnect, when connection is gone
        // if(!this.connection.writable)
        //     this.connection.connect({url: this.url});
        if (this.connection.readyState !== this.connection.OPEN) {
            console.error('connection not open on send()');
            if (typeof this.connection.onerror === 'function') {
                this.connection.onerror(new Error('connection not open'));
            } else {
                console.error('no error callback');
            }
            return;
        }

        this.connection.send(JSON.stringify(payload));
        this._addResponseCallback(payload, callback);
    };

    /**
     Subscribes to provider events.provider

     @method on
     @param {String} type    'notifcation', 'connect', 'error', 'end' or 'data'
     @param {Function} callback   the callback to call
     */
    WebsocketProvider.prototype.on = function (type, callback) {

        Iif(typeof callback !== 'function')
            throw new Error('The second parameter callback must be a function.');

        switch(type){
            case 'data':
                this.notificationCallbacks.push(callback);
                break;

            case 'connect':
                this.connection.onopen = callback;
                break;

            case 'end':
                this.connection.onclose = callback;
                break;

            case 'error':
                this.connection.onerror = callback;
                break;

            // default:
            //     this.connection.on(type, callback);
            //     break;
        }
    };

    // TODO add once

    /**
     Removes event listener

     @method removeListener
     @param {String} type    'notifcation', 'connect', 'error', 'end' or 'data'
     @param {Function} callback   the callback to call
     */
    WebsocketProvider.prototype.removeListener = function (type, callback) {
        var _this = this;

        switch(type){
            case 'data':
                this.notificationCallbacks.forEach(function(cb, index){
                    if(cb === callback)
                        _this.notificationCallbacks.splice(index, 1);
                });
                break;

            // TODO remvoving connect missing

            // default:
            //     this.connection.removeListener(type, callback);
            //     break;
        }
    };

    /**
     Removes all event listeners

     @method removeAllListeners
     @param {String} type    'notifcation', 'connect', 'error', 'end' or 'data'
     */
    WebsocketProvider.prototype.removeAllListeners = function (type) {
        switch(type){
            case 'data':
                this.notificationCallbacks = [];
                break;

            // TODO remvoving connect properly missing

            case 'connect':
                this.connection.onopen = null;
                break;

            case 'end':
                this.connection.onclose = null;
                break;

            case 'error':
                this.connection.onerror = null;
                break;

            default:
                // this.connection.removeAllListeners(type);
                break;
        }
    };

    /**
     Resets the providers, clears all callbacks

     @method reset
     */
    WebsocketProvider.prototype.reset = function () {
        this._timeout();
        this.notificationCallbacks = [];

        // this.connection.removeAllListeners('error');
        // this.connection.removeAllListeners('end');
        // this.connection.removeAllListeners('timeout');

        this.addDefaultEvents();
    };

    module.exports = WebsocketProvider;