Handle circular object structures in Errors correctly. (detect and ignore them)

ebdrup · ebdrup · commit 9d9d9318fd1d · 2012-08-28T21:49:21.000+02:00
diff --git a/lib/util/getSerializableError.js b/lib/util/getSerializableError.js
@@ -2,9 +2,15 @@
 module.exports = function getSerializableError(err) {
 	//this copying of properties is needed to get Error properties serialized by JSON.stringify
 	var output = {};
-	Object.getOwnPropertyNames(err).forEach(function (i) {
-		if (err[i] && i !== "arguments") {
-			output[i] = err[i];
+	Object.getOwnPropertyNames(err).forEach(function (property) {
+		if (err[property]) {
+			try{
+				//only add properties that can be stringified
+				JSON.stringify(err[property]);
+				output[property] = err[property];
+			} catch (ex){
+
+			}
 		}
 	});
 	return output;
diff --git a/package.json b/package.json
@@ -1,7 +1,8 @@
 {
 	"author":"Allan Ebdrup",
 	"name":"nodeerrors",
-	"version":"1.0.3",
+	"description": "error handling module for node",
+	"version":"1.0.4",
 	"repository":{
 		"type":"git",
 		"url":"https://github.com/Muscula/nodeerrors"
diff --git a/test/unit/getSerializableError.spec.js b/test/unit/getSerializableError.spec.js
@@ -15,4 +15,16 @@ describe("when passed an error", function () {
 		expect(serialized.stack).to.be.ok;
 		expect(error).to.eql(serialized);
 	});
+	it('will make only copy properties that can be JSON.serialized', function () {
+		var getSerialiazableError = require("../../lib/util/getSerializableError");
+		var sourceError = new Error("This is my error");
+		//create circular reference
+		var o= { circle : {}};
+		o.circle = o;
+		sourceError.test = o;
+		var error = getSerialiazableError(sourceError);
+		var serialized = JSON.parse(JSON.stringify(error));
+		expect(serialized.stack).to.be.ok;
+		expect(error).to.eql(serialized);
+	});
 });
