v6.5.0 - Improved error reporting

If the user throws plain objects or other non-error values, SC will now give as much detail as possible about
the object/value.

Author: jondubois

index.js

@@ -17,6 +17,7 @@ var InvalidActionError = scErrors.InvalidActionError;
 var BrokerError = scErrors.BrokerError;
 var ProcessExitError = scErrors.ProcessExitError;
 var UnknownError = scErrors.UnknownError;
+var decycle = scErrors.decycle;
 
 var socketClusterSingleton = null;
 
@@ -380,34 +381,56 @@ SocketCluster.prototype._logObject = function (obj, objType, time) {
   this.log(logMessage, time);
 };
 
-SocketCluster.prototype.errorHandler = function (err, origin) {
-  if (!(err instanceof Object)) {
-    // If a string (or null...)
+SocketCluster.prototype._convertValueToUnknownError = function (err, origin) {
+  if (err && typeof err == 'object') {
+    // If err has neither a stack or message property
+    // then the error message will be the JSON stringified object.
+    if (!err.message && !err.stack) {
+      var errorMessage;
+      try {
+        errorMessage = JSON.stringify(err);
+      } catch (e1) {
+        try {
+          errorMessage = JSON.stringify(decycle(err));
+        } catch (e2) {
+          errorMessage = '[object NotJSON]';
+        }
+      }
+      err = new UnknownError(errorMessage);
+    }
+  } else if (typeof err == 'function') {
+    var errorMessage = '[function ' + (err.name || 'anonymous') + ']';
+    err = new UnknownError(errorMessage);
+  } else if (typeof err == 'undefined') {
+    err = new UnknownError('undefined');
+  } else if (err === null) {
+    err = new UnknownError('null');
+  } else {
+    // For number, string and boolean types.
     err = new UnknownError(err);
-  } else if (err.stack == null) {
-    err.stack = err.message;
   }
+
+  err.origin = origin;
+  err.time = Date.now();
+
+  return err;
+};
+
+SocketCluster.prototype.errorHandler = function (err, origin) {
+  err = this._convertValueToUnknownError(err, origin);
+
   var annotation = this._errorAnnotations[err.code];
-  if (annotation) {
+  if (annotation && err.stack) {
     err.stack += '\n    ' + this.colorText('!!', 'red') + ' ' + annotation;
   }
 
-  err.origin = origin;
-  err.time = Date.now();
   this.emit(this.EVENT_FAIL, err);
 
   this._logObject(err, 'Error');
 };
 
 SocketCluster.prototype.warningHandler = function (warning, origin) {
-  if (!(warning instanceof Object)) {
-    // If a string (or null...)
-    warning = new UnknownError(warning);
-  } else if (warning.stack == null) {
-    warning.stack = warning.message;
-  }
-  warning.origin = origin;
-  warning.time = Date.now();
+  warning = this._convertValueToUnknownError(warning, origin);
 
   this.emit(this.EVENT_WARNING, warning);
 
@@ -416,26 +439,6 @@ SocketCluster.prototype.warningHandler = function (warning, origin) {
   }
 };
 
-SocketCluster.prototype.triggerInfo = function (info, origin) {
-  if (this._active) {
-    if (!(origin instanceof Object)) {
-      origin = {
-        type: origin
-      };
-    }
-    var infoData = {
-      origin: origin,
-      message: info,
-      time: Date.now()
-    };
-    this.emit(this.EVENT_WARNING, infoData);
-
-    if (this.options.logLevel > 0) {
-      this._logObject(infoData, 'Info', infoData.time)
-    }
-  }
-};
-
 SocketCluster.prototype._workerClusterErrorHandler = function (pid, error) {
   this.errorHandler(error, {
     type: 'WorkerCluster',
@@ -613,11 +616,10 @@ SocketCluster.prototype._launchWorkerCluster = function () {
 
   this.workerCluster.on('message', function workerHandler(m) {
     if (m.type == 'error') {
-      var error = scErrors.hydrateError(m.data.error);
       if (m.data.workerPid) {
-        self._workerErrorHandler(m.data.workerPid, error);
+        self._workerErrorHandler(m.data.workerPid, m.data.error);
       } else {
-        self._workerClusterErrorHandler(m.data.pid, error);
+        self._workerClusterErrorHandler(m.data.pid, m.data.error);
       }
     } else if (m.type == 'warning') {
       var warning = scErrors.hydrateError(m.data.error);

kubernetes/socketcluster-deployment.yaml

@@ -11,7 +11,7 @@ spec:
     spec:
       containers:
       - name: socketcluster
-        image: socketcluster/socketcluster:v6.4.0
+        image: socketcluster/socketcluster:v6.5.0
         ports:
         - containerPort: 8000
         env:

package.json

@@ -1,7 +1,7 @@
 {
   "name": "socketcluster",
   "description": "SocketCluster - A Highly parallelized WebSocket server cluster to make the most of multi-core machines/instances.",
-  "version": "6.4.0",
+  "version": "6.5.0",
   "homepage": "http://socketcluster.io",
   "contributors": [
     {
@@ -19,12 +19,12 @@
     "fs-extra": "2.0.0",
     "inquirer": "1.1.3",
     "minimist": "1.1.0",
-    "sc-auth": "~4.1.0",
+    "sc-auth": "~4.1.1",
     "sc-broker-cluster": "~4.0.3",
     "sc-domain": "~1.0.1",
     "sc-emitter": "~1.1.0",
-    "sc-errors": "~1.3.0",
-    "socketcluster-server": "~6.1.0",
+    "sc-errors": "~1.3.3",
+    "socketcluster-server": "~6.2.0",
     "uid-number": "0.0.5",
     "uuid": "3.0.1"
   },
@@ -41,6 +41,6 @@
   "license": "MIT",
   "readmeFilename": "README.md",
   "devDependencies": {
-    "socketcluster-client": "~6.2.2"
+    "socketcluster-client": "~6.3.0"
   }
 }

sample/package.json

@@ -13,13 +13,13 @@
     "express": "4.14.0",
     "minimist": "1.1.0",
     "morgan": "1.7.0",
-    "sc-errors": "~1.3.2",
+    "sc-errors": "~1.3.3",
     "sc-framework-health-check": "~1.0.0",
     "sc-hot-reboot": "~1.0.0",
-    "scc-broker-client": "~1.3.0",
+    "scc-broker-client": "~1.4.0",
     "serve-static": "1.11.2",
-    "socketcluster": "~6.4.0",
-    "socketcluster-client": "~6.2.2"
+    "socketcluster": "~6.5.0",
+    "socketcluster-client": "~6.3.0"
   },
   "keywords": [
     "websocket",