refactor: always parse inbound messages as strings

Author: mikuso

README.md

@@ -398,7 +398,7 @@ Emitted when the underlying WebSocket has disconnected. If the client is configu
 #### Event: 'message'
 
 * `event` {Object}
-  * `buffer` {Buffer} - The message payload.
+  * `message` {Buffer|String} - The message payload.
   * `outbound` {Boolean} - This will be `true` if the message originated locally.
 
 Emitted whenever a message is sent or received over client's WebSocket. Useful for logging or debugging.

lib/client.js

@@ -164,15 +164,15 @@ class RPCClient extends EventEmitter {
 
     /**
      * Send a message to the RPCServer. While socket is connecting, the message is queued and send when open.
-     * @param {Buffer|String} buffer - String to send via websocket
+     * @param {Buffer|String} message - String to send via websocket
      */
-    sendRaw(buffer) {
+    sendRaw(message) {
         if ([OPEN, CLOSING].includes(this._state) && this._ws) {
             // can send while closing so long as websocket doesn't mind
-            this._ws.send(buffer);
-            this.emit('message', {buffer, outbound: true});
+            this._ws.send(message);
+            this.emit('message', {message, outbound: true});
         } else if (this._state === CONNECTING) {
-            this._outboundMsgBuffer.push(buffer);
+            this._outboundMsgBuffer.push(message);
         } else {
             throw Error(`Cannot send message in this state`);
         }
@@ -561,17 +561,16 @@ class RPCClient extends EventEmitter {
     }
 
     _onMessage(buffer) {
-        this.emit('message', {buffer, outbound: false});
+        const message = buffer.toString('utf8');
+        this.emit('message', {message, outbound: false});
 
         let msgId = '-1';
         let messageType;
 
         try {
-            const msg = buffer.toString('utf8');
-
             let payload;
             try {
-                payload = JSON.parse(msg);
+                payload = JSON.parse(message);
             } catch (err) {
                 throw createRPCError("RpcFrameworkError", "Message must be a JSON structure", {});
             }

test/client.js

@@ -196,7 +196,7 @@ describe('RPCClient', function(){
             const messages = [];
             await cli.connect();
             cli.on('message', m => messages.push({
-                payload: JSON.parse(m.buffer.toString('utf8')),
+                payload: JSON.parse(m.message.toString('utf8')),
                 outbound: m.outbound,
             }));
             await cli.call('Echo', {val: 123});
@@ -235,7 +235,7 @@ describe('RPCClient', function(){
             const messages = [];
             await cli.connect();
             cli.on('message', m => messages.push({
-                payload: JSON.parse(m.buffer.toString('utf8')),
+                payload: JSON.parse(m.message.toString('utf8')),
                 outbound: m.outbound,
             }));