Enable async methods for postProcess (#1338)

- Add tests
- Update readme

Co-authored-by: kpetrovic <[email protected]>
Co-authored-by: aussieboi <[email protected]>
Co-authored-by: Marko Boskovic <[email protected]>
Co-authored-by: Vasily Martynov <[email protected]>

Author: 5 people

Readme.md

@@ -695,6 +695,32 @@ You must specify all of the namespaces and namespace prefixes yourself.  The ele
    }})
  ```
 
+- Making `postProcess` either synchronous or asynchronous with a `Promise`:
+  - Synchronous (classic):
+    ```javascript
+      // ...
+      client.registerUser(requestBody, {
+        postProcess: (xml) => {
+          const testString = "Jane"
+          xml = xml.replace("John", testString)
+          return xml;
+        }
+      }
+      // ...
+    ```
+  - Asynchronous (resolves promise on async invoke of `postProcess`):
+    ```javascript
+      // ...
+      client.registerUser(requestBody, {
+        postProcess: async (xml) => {
+          const testString = await new Promise(resolve => setTimeout(() => resolve("Jane"), 50));
+          xml = xml.replace("John", testString)
+          return xml;
+        }
+      }
+      // ...
+    ```
+
 #### Extra Headers (optional)
 
 Object properties define extra HTTP headers to be sent on the request.

src/client.ts

@@ -298,7 +298,7 @@ export class Client extends EventEmitter {
     }
   }
 
-  private _invoke(method: OperationElement, args, location: string, callback, options, extraHeaders) {
+  private async _invoke(method: OperationElement, args, location: string, callback, options, extraHeaders) {
     const name = method.$name;
     const input = method.input;
     const output = method.output;
@@ -459,7 +459,7 @@ export class Client extends EventEmitter {
     }
 
     if (options && options.postProcess) {
-      xml = options.postProcess(xml);
+        xml = await options.postProcess(xml);
     }
 
     this.lastMessage = message;

test/client-test.js

@@ -1834,6 +1834,93 @@ describe('Client posting complex body', () => {
       });
     }, baseUrl);
   });
+
+
+  it('should resolve promise on async invoke postProcess', function (done) {
+    soap.createClient(__dirname + '/wsdl/complex/registration-common.wsdl', function (err, client) {
+      if (err) {
+        return void done(err);
+      }
+      assert.ok(client);
+
+      var requestBody = {
+        id: 'ID00000000000000000000000000000000',
+        lastName: 'Doe',
+        firstName: 'John',
+        dateOfBirth: '1970-01-01',
+        correspondenceLanguage: 'ENG',
+        emailAddress: '[email protected]',
+        lookupPermission: 'ALLOWED',
+        companyAddress: {
+          address: {
+            streetName: 'Street',
+            postalCode: 'Code',
+            city: 'City',
+            countryCode: 'US'
+          },
+          companyName: 'ACME'
+        }
+      }
+
+      client.registerUser(requestBody, {
+        postProcess: async (xml) => {
+          const testString = await new Promise(resolve => setTimeout(() => resolve("Jane"), 50));
+
+          xml = xml.replace("John", testString)
+          return xml;
+        }
+      }, function (err, result) {
+        assert.ok(client.lastRequest);
+        const expectedBody = '<?xml version="1.0" encoding="utf-8"?><soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  xmlns:tns="http://test-soap.com/api/registration" xmlns:registrationMessages="http://test-soap.com/api/registration/messages" xmlns:commonMessages="http://test-soap.com/api/common/messages"><soap:Body><registrationMessages:registerUserRequest xmlns:registrationMessages="http://test-soap.com/api/registration/messages" xmlns="http://test-soap.com/api/registration/messages"><registrationMessages:id>ID00000000000000000000000000000000</registrationMessages:id><registrationMessages:lastName>Doe</registrationMessages:lastName><registrationMessages:firstName>Jane</registrationMessages:firstName><registrationMessages:dateOfBirth>1970-01-01</registrationMessages:dateOfBirth><registrationMessages:correspondenceLanguage>ENG</registrationMessages:correspondenceLanguage><registrationMessages:emailAddress>[email protected]</registrationMessages:emailAddress><registrationMessages:lookupPermission>ALLOWED</registrationMessages:lookupPermission><registrationMessages:companyAddress><ct:address xmlns:ct="http://test-soap.com/api/common/types"><ct:streetName>Street</ct:streetName><ct:postalCode>Code</ct:postalCode><ct:city>City</ct:city><ct:countryCode>US</ct:countryCode></ct:address><ct:companyName xmlns:ct="http://test-soap.com/api/common/types">ACME</ct:companyName></registrationMessages:companyAddress></registrationMessages:registerUserRequest></soap:Body></soap:Envelope>'
+        assert.strictEqual(client.lastRequest, expectedBody);
+
+        done();
+      });
+    }, baseUrl);
+  })
+
+  it('should resolve sync invoke postProcess', function (done) {
+    soap.createClient(__dirname + '/wsdl/complex/registration-common.wsdl', function (err, client) {
+      if (err) {
+        return void done(err);
+      }
+      assert.ok(client);
+
+      var requestBody = {
+        id: 'ID00000000000000000000000000000000',
+        lastName: 'Doe',
+        firstName: 'John',
+        dateOfBirth: '1970-01-01',
+        correspondenceLanguage: 'ENG',
+        emailAddress: '[email protected]',
+        lookupPermission: 'ALLOWED',
+        companyAddress: {
+          address: {
+            streetName: 'Street',
+            postalCode: 'Code',
+            city: 'City',
+            countryCode: 'US'
+          },
+          companyName: 'ACME'
+        }
+      }
+
+      client.registerUser(requestBody, {
+        postProcess: (xml) => {
+          const testString = "Jane"
+
+          xml = xml.replace("John", testString)
+          return xml;
+        }
+      }, function (err, result) {
+        assert.ok(client.lastRequest);
+        const expectedBody = '<?xml version="1.0" encoding="utf-8"?><soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  xmlns:tns="http://test-soap.com/api/registration" xmlns:registrationMessages="http://test-soap.com/api/registration/messages" xmlns:commonMessages="http://test-soap.com/api/common/messages"><soap:Body><registrationMessages:registerUserRequest xmlns:registrationMessages="http://test-soap.com/api/registration/messages" xmlns="http://test-soap.com/api/registration/messages"><registrationMessages:id>ID00000000000000000000000000000000</registrationMessages:id><registrationMessages:lastName>Doe</registrationMessages:lastName><registrationMessages:firstName>Jane</registrationMessages:firstName><registrationMessages:dateOfBirth>1970-01-01</registrationMessages:dateOfBirth><registrationMessages:correspondenceLanguage>ENG</registrationMessages:correspondenceLanguage><registrationMessages:emailAddress>[email protected]</registrationMessages:emailAddress><registrationMessages:lookupPermission>ALLOWED</registrationMessages:lookupPermission><registrationMessages:companyAddress><ct:address xmlns:ct="http://test-soap.com/api/common/types"><ct:streetName>Street</ct:streetName><ct:postalCode>Code</ct:postalCode><ct:city>City</ct:city><ct:countryCode>US</ct:countryCode></ct:address><ct:companyName xmlns:ct="http://test-soap.com/api/common/types">ACME</ct:companyName></registrationMessages:companyAddress></registrationMessages:registerUserRequest></soap:Body></soap:Envelope>'
+        assert.strictEqual(client.lastRequest, expectedBody);
+
+        done();
+      });
+    }, baseUrl);
+  })
 });
 
 describe('Connection header', () => {