updated tscript, added error cause information to _wsSend.

Author: mmorton

lib/client.js

@@ -15,6 +15,25 @@ var shortid = require('shortid');
     ConnectionStatus[ConnectionStatus["Authenticated"] = 3] = "Authenticated";
 })(exports.ConnectionStatus || (exports.ConnectionStatus = {}));
 var ConnectionStatus = exports.ConnectionStatus;
+(function (MessageSendErrorCause) {
+    MessageSendErrorCause[MessageSendErrorCause["NoAuth"] = 1] = "NoAuth";
+    MessageSendErrorCause[MessageSendErrorCause["NoAck"] = 2] = "NoAck";
+    MessageSendErrorCause[MessageSendErrorCause["Serialization"] = 3] = "Serialization";
+    MessageSendErrorCause[MessageSendErrorCause["Transport"] = 4] = "Transport";
+    MessageSendErrorCause[MessageSendErrorCause["Promise"] = 5] = "Promise";
+})(exports.MessageSendErrorCause || (exports.MessageSendErrorCause = {}));
+var MessageSendErrorCause = exports.MessageSendErrorCause;
+var MessageSendError = (function (_super) {
+    __extends(MessageSendError, _super);
+    function MessageSendError(message, cause, source, data) {
+        _super.call(this, message);
+        this.cause = cause;
+        this.source = source;
+        this.data = data;
+    }
+    return MessageSendError;
+})(Error);
+exports.MessageSendError = MessageSendError;
 var Client = (function (_super) {
     __extends(Client, _super);
     function Client(_a) {
@@ -157,23 +176,23 @@ var Client = (function (_super) {
         var _this = this;
         if (timeout === void 0) { timeout = this.timeout; }
         if (this.status < ConnectionStatus.Connected) {
-            return Promise.reject(new Error('Cannot send data across a socket that is not connected.'));
+            return Promise.reject(new MessageSendError('Cannot send data across a socket that is not connected.', MessageSendErrorCause.NoAuth));
         }
         var data;
         try {
             data = JSON.stringify(message);
         }
         catch (err) {
             this.emit('protocol:error', err);
-            return Promise.reject(err);
+            return Promise.reject(new MessageSendError('Could not serialize message.', MessageSendErrorCause.Serialization, err, message));
         }
+        this.emit('raw:outgoing', data);
         try {
-            this.emit('raw:outgoing', data);
             this._socket.send(data);
         }
         catch (err) {
             this.emit('transport:error', err);
-            return Promise.reject(err);
+            return Promise.reject(new MessageSendError('An error occurred in the transport.', MessageSendErrorCause.Transport, err, message));
         }
         if (message.id) {
             var id = message.id;
@@ -182,7 +201,9 @@ var Client = (function (_super) {
                 id: id,
                 message: message,
                 deferred: deferred,
-                timeout: setTimeout(function () { return deferred.reject(new Error('no ack')); }, timeout)
+                timeout: setTimeout(function () {
+                    deferred.reject(new MessageSendError('Did not receive acknowledgement in the timeout period.', MessageSendErrorCause.NoAck, void 0, message));
+                }, timeout)
             };
             var cleanup = function () {
                 clearTimeout(pending.timeout);
@@ -193,7 +214,7 @@ var Client = (function (_super) {
                 return ack;
             }, function (err) {
                 cleanup();
-                throw err;
+                throw new MessageSendError('An error occurred during promise resolution', MessageSendErrorCause.Promise, err, message);
             });
         }
         else {

npm-shrinkwrap.json

@@ -19,6 +19,6 @@
     "karma-chrome-launcher": "^0.2.0",
     "karma-jasmine": "^0.3.5",
     "karma-typescript-preprocessor": "0.0.19",
-    "typescript": "^1.5.0-beta"
+    "typescript": "^1.5.3"
   }
 }

package.json

@@ -43,6 +43,28 @@ export interface ExtensionAsFunc {
     (client: Client): void;
 }
 
+export enum MessageSendErrorCause {
+    NoAuth = 1,
+    NoAck = 2,
+    Serialization = 3,
+    Transport = 4,
+    Promise = 5
+}
+
+export class MessageSendError extends Error {
+    data: Message;
+    cause: MessageSendErrorCause;
+    source: any;
+
+    constructor(message: string, cause: MessageSendErrorCause, source?: any, data?: Message) {
+        super(message);
+
+        this.cause = cause;
+        this.source = source;
+        this.data = data;
+    }
+}
+
 /**
  */
 export class Client extends EventEmitter {
@@ -205,23 +227,24 @@ export class Client extends EventEmitter {
 
     protected _wsSend(message: Message, timeout: number = this.timeout): Promise<Ack> {
         if (this.status < ConnectionStatus.Connected) {
-            return Promise.reject(new Error('Cannot send data across a socket that is not connected.'));
+            return Promise.reject(new MessageSendError('Cannot send data across a socket that is not connected.', MessageSendErrorCause.NoAuth));
         }
 
         var data;
         try {
             data = JSON.stringify(message);
         } catch (err) {
             this.emit('protocol:error', err);
-            return Promise.reject(err);
+            return Promise.reject(new MessageSendError('Could not serialize message.', MessageSendErrorCause.Serialization, err, message));
         }
 
+        this.emit('raw:outgoing', data);
+
         try {
-            this.emit('raw:outgoing', data);
             this._socket.send(data);
         } catch (err) {
             this.emit('transport:error', err);
-            return Promise.reject(err);
+            return Promise.reject(new MessageSendError('An error occurred in the transport.', MessageSendErrorCause.Transport, err, message));
         }
 
         if (message.id) {
@@ -231,7 +254,9 @@ export class Client extends EventEmitter {
                 id: id,
                 message: message,
                 deferred: deferred,
-                timeout: setTimeout(() => deferred.reject(new Error('no ack')), timeout)
+                timeout: setTimeout(() => {
+                    deferred.reject(new MessageSendError('Did not receive acknowledgement in the timeout period.', MessageSendErrorCause.NoAck, void 0, message))
+                }, timeout)
             };
             var cleanup = () => {
                 clearTimeout(pending.timeout);
@@ -242,7 +267,7 @@ export class Client extends EventEmitter {
                 return ack;
             }, (err) => {
                 cleanup();
-                throw err;
+                throw new MessageSendError('An error occurred during promise resolution', MessageSendErrorCause.Promise, err, message);
             });
         } else {
             return Promise.resolve();