Merge pull request #563 from mdhooge/PR557

Server translates error object thrown from method into SOAP Fault (was PR#557)
vpulim · Feb 10, 2015 · 13e8136 · 13e8136
2 parents 18b4326 + 519a289
commit 13e8136
Show file tree

Hide file tree

Showing 3 changed files with 76 additions and 26 deletions.
diff --git a/Readme.md b/Readme.md
@@ -87,6 +87,23 @@ along with data.
   };
 ```
 
+### SOAP Fault
+
+A service method can reply with a SOAP Fault to a client by `throw`ing an
+object with a `Fault` property.
+
+``` javascript
+  throw {
+    Fault: {
+      Code: {
+        Value: "soap:Sender",
+        Subcode: { value: "rpc:BadArguments" }
+      },
+      Reason: { Text: "Processing Error" }
+    }
+  };
+```
+
 ### server security example using PasswordDigest
 
 If server.authenticate is not defined no authentation will take place.

diff --git a/lib/server.js b/lib/server.js
@@ -133,7 +133,7 @@ Server.prototype._process = function(input, URL, callback) {
     body = obj.Body,
     headers = obj.Header,
     bindings = this.wsdl.definitions.bindings, binding,
-    methods, method, methodName,
+    method, methodName,
     serviceName, portName;
 
   if (typeof self.authenticate === 'function') {
@@ -183,31 +183,41 @@ Server.prototype._process = function(input, URL, callback) {
     throw new Error('Failed to bind to WSDL');
   }
 
-  methods = binding.methods;
-
-  if (binding.style === 'rpc') {
-    methodName = Object.keys(body)[0];
-    self._executeMethod({
-      serviceName: serviceName,
-      portName: portName,
-      methodName: methodName,
-      outputName: methodName + 'Response',
-      args: body[methodName],
-      headers: headers,
-      style: 'rpc'
-    }, callback);
-  } else {
-    var messageElemName = Object.keys(body)[0];
-    var pair = binding.topElements[messageElemName];
-    self._executeMethod({
-      serviceName: serviceName,
-      portName: portName,
-      methodName: pair.methodName,
-      outputName: pair.outputName,
-      args: body[messageElemName],
-      headers: headers,
-      style: 'document'
-    }, callback);
+  try {
+    if (binding.style === 'rpc') {
+      methodName = Object.keys(body)[0];
+      self._executeMethod({
+        serviceName: serviceName,
+        portName: portName,
+        methodName: methodName,
+        outputName: methodName + 'Response',
+        args: body[methodName],
+        headers: headers,
+        style: 'rpc'
+      }, callback);
+    } else {
+      var messageElemName = Object.keys(body)[0];
+      var pair = binding.topElements[messageElemName];
+      self._executeMethod({
+        serviceName: serviceName,
+        portName: portName,
+        methodName: pair.methodName,
+        outputName: pair.outputName,
+        args: body[messageElemName],
+        headers: headers,
+        style: 'document'
+      }, callback);
+    }
+  }
+  catch (e) {
+    if (e.Fault !== undefined) {
+      // 3rd param is the NS prepended to all elements
+      // It must match the NS defined in the Envelope (set by the _envelope method)
+      var fault = self.wsdl.objectToDocumentXML("Fault", e.Fault, "soap");
+      callback(self._envelope(fault));
+    }
+    else
+      throw e;
   }
 };
 

diff --git a/test/server-test.js b/test/server-test.js
@@ -16,6 +16,16 @@ test.service = {
           return { price: soapHeader.SomeToken };
         if (args.tickerSymbol === 'trigger error') {
           throw new Error('triggered server error');
+        } else if (args.tickerSymbol === 'SOAP Fault') {
+          throw {
+            Fault: {
+              Code: {
+                Value: "soap:Sender",
+                Subcode: { value: "rpc:BadArguments" }
+              },
+              Reason: { Text: "Processing Error" }
+            }
+          };
         } else {
           return { price: 19.56 };
         }
@@ -134,6 +144,19 @@ describe('SOAP Server', function() {
     });
   });
 
+  it('should return SOAP Fault body', function(done) {
+    soap.createClient(test.baseUrl + '/stockquote?wsdl', function(err, client) {
+      assert.ok(!err);
+      client.GetLastTradePrice({ tickerSymbol: 'SOAP Fault' }, function(err, response, body) {
+        assert.ok(err);
+        var fault = err.root.Envelope.Body.Fault;
+        assert.equal(fault.Code.Value, "soap:Sender");
+        assert.equal(fault.Reason.Text, "Processing Error");
+        done();
+      });
+    });
+  });
+
 // NOTE: this is actually a -client- test
 /*
 it('should return a valid error if the server stops responding': function(done) {