release v2.0.11

- increment version

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 2.0.11
+
+- Fixed #221: headers not set on Android when request fails due to non-success status code
+
+## 2.0.10
+
+- Fixed #218: headers are used as params on browser platform
+
 ## 2.0.9
 
 - Fixed #204: broken support for cordova-android  < 7.0

README.md

@@ -93,7 +93,7 @@ You can choose one of these:
 * `json`: send data as JSON encoded content in body (content type "application/json")
 * `utf8`: send data as plain UTF8 encoded string in body (content type "plain/text")
 
-You can also override the default content type headers by specifying your own headers (see [setHeader](#setHeader)).
+This defaults to `urlencoded`. You can also override the default content type headers by specifying your own headers (see [setHeader](#setHeader)).
 
 __Caution__: `urlencoded` does not support serializing deep structures whereas `json` does.
 

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "cordova-plugin-advanced-http",
-  "version": "2.0.9",
+  "version": "2.0.11",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "cordova-plugin-advanced-http",
-  "version": "2.0.9",
+  "version": "2.0.11",
   "description": "Cordova / Phonegap plugin for communicating with HTTP servers using SSL pinning",
   "scripts": {
     "updatecert": "node ./scripts/update-e2e-server-cert.js && node ./scripts/update-e2e-client-cert.js",

plugin.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
-<plugin xmlns="http://www.phonegap.com/ns/plugins/1.0" xmlns:android="http://schemas.android.com/apk/res/android" id="cordova-plugin-advanced-http" version="2.0.9">
+<plugin xmlns="http://www.phonegap.com/ns/plugins/1.0" xmlns:android="http://schemas.android.com/apk/res/android" id="cordova-plugin-advanced-http" version="2.0.11">
   <name>Advanced HTTP plugin</name>
   <description>
         Cordova / Phonegap plugin for communicating with HTTP servers using SSL pinning

src/android/com/silkimen/cordovahttp/CordovaHttpResponse.java

@@ -56,13 +56,15 @@ class CordovaHttpResponse {
     json.put("status", this.status);
     json.put("url", this.url);
 
+    if (this.headers != null && !this.headers.isEmpty()) {
+      json.put("headers", new JSONObject(getFilteredHeaders()));
+    }
+
     if (this.hasFailed) {
       json.put("error", this.error);
     } else if (this.isFileOperation) {
-      json.put("headers", new JSONObject(getFilteredHeaders()));
       json.put("file", this.fileEntry);
     } else {
-      json.put("headers", new JSONObject(getFilteredHeaders()));
       json.put("data", this.body);
     }
 
@@ -72,10 +74,6 @@ class CordovaHttpResponse {
   private Map<String, String> getFilteredHeaders() throws JSONException {
     Map<String, String> filteredHeaders = new HashMap<String, String>();
 
-    if (this.headers == null || this.headers.isEmpty()) {
-      return filteredHeaders;
-    }
-
     for (Map.Entry<String, List<String>> entry : this.headers.entrySet()) {
       String key = entry.getKey();
       List<String> value = entry.getValue();

src/browser/cordova-http-plugin.js

@@ -101,12 +101,20 @@ function setHeaders(xhr, headers) {
 }
 
 function sendRequest(method, withData, opts, success, failure) {
-  var data = withData ? opts[1] : null;
-  var params = withData ? null : serializeParams(opts[1]);
-  var serializer = withData ? opts[2] : null;
-  var headers = withData ? opts[3] : opts[2];
-  var timeout = withData ? opts[4] : opts[3];
-  var url = params ? opts[0] + '?' + params : opts[0];
+  var data, serializer, headers, timeout, followRedirect;
+  var url = opts[0];
+
+  if (withData) {
+    data = opts[1];
+    serializer = opts[2];
+    headers = opts[3];
+    timeout = opts[4];
+    followRedirect = opts[5];
+  } else {
+    headers = opts[1];
+    timeout = opts[2];
+    followRedirect = opts[3];
+  }
 
   var processedData = null;
   var xhr = new XMLHttpRequest();
@@ -117,6 +125,10 @@ function sendRequest(method, withData, opts, success, failure) {
     return failure('advanced-http: custom cookies not supported on browser platform');
   }
 
+  if (!followRedirect) {
+    return failure('advanced-http: disabling follow redirect not supported on browser platform');
+  }
+
   switch (serializer) {
     case 'json':
       setDefaultContentType(headers, 'application/json; charset=utf8');
@@ -160,24 +172,24 @@ function sendRequest(method, withData, opts, success, failure) {
 }
 
 var browserInterface = {
-  post: function (success, failure, opts) {
-    return sendRequest('post', true, opts, success, failure);
-  },
   get: function (success, failure, opts) {
     return sendRequest('get', false, opts, success, failure);
   },
+  head: function (success, failure, opts) {
+    return sendRequest('head', false, opts, success, failure);
+  },
+  delete: function (success, failure, opts) {
+    return sendRequest('delete', false, opts, success, failure);
+  },
+  post: function (success, failure, opts) {
+    return sendRequest('post', true, opts, success, failure);
+  },
   put: function (success, failure, opts) {
     return sendRequest('put', true, opts, success, failure);
   },
   patch: function (success, failure, opts) {
     return sendRequest('patch', true, opts, success, failure);
   },
-  delete: function (success, failure, opts) {
-    return sendRequest('delete', false, opts, success, failure);
-  },
-  head: function (success, failure, opts) {
-    return sendRequest('head', false, opts, success, failure);
-  },
   uploadFile: function (success, failure, opts) {
     return failure('advanced-http: function "uploadFile" not supported on browser platform');
   },
@@ -189,9 +201,6 @@ var browserInterface = {
   },
   setClientAuthMode: function (success, failure, opts) {
     return failure('advanced-http: function "setClientAuthMode" not supported on browser platform');
-  },
-  disableRedirect: function (success, failure, opts) {
-    return failure('advanced-http: function "disableRedirect" not supported on browser platform');
   }
 };
 

test/e2e-specs.js

@@ -3,6 +3,11 @@ const hooks = {
     cordova.plugin.http.clearCookies();
 
     helpers.enableFollowingRedirect(function() {
+      // server trust mode is not supported on brpwser platform
+      if (cordova.platformId === 'browser') {
+        return resolve();
+      }
+
       helpers.setDefaultServerTrustMode(function () {
         // @TODO: not ready yet
         // helpers.setNoneClientAuthMode(resolve, reject);
@@ -624,6 +629,60 @@ const tests = [
       result.data.content.should.be.equal("<?xml version='1.0' encoding='us-ascii'?>\n\n<!--  A SAMPLE set of slides  -->\n\n<slideshow \n    title=\"Sample Slide Show\"\n    date=\"Date of publication\"\n    author=\"Yours Truly\"\n    >\n\n    <!-- TITLE SLIDE -->\n    <slide type=\"all\">\n      <title>Wake up to WonderWidgets!</title>\n    </slide>\n\n    <!-- OVERVIEW -->\n    <slide type=\"all\">\n        <title>Overview</title>\n        <item>Why <em>WonderWidgets</em> are great</item>\n        <item/>\n        <item>Who <em>buys</em> WonderWidgets</item>\n    </slide>\n\n</slideshow>");
     }
   },
+  {
+    description: 'should return header object when request failed due to non-success response from server #221',
+    expected: 'rejected:',
+    func: function (resolve, reject) { cordova.plugin.http.get('https://httpbin.org/status/418', {}, {}, resolve, reject); },
+    validationFunc: function (driver, result) {
+      result.type.should.be.equal('rejected');
+      result.data.headers.should.be.an('object');
+    }
+  },
+  {
+    description: 'should return status code when request failed due to non-success response from server',
+    expected: 'rejected:',
+    func: function (resolve, reject) { cordova.plugin.http.get('https://httpbin.org/status/418', {}, {}, resolve, reject); },
+    validationFunc: function (driver, result) {
+      result.type.should.be.equal('rejected');
+      result.data.status.should.be.equal(418);
+    }
+  },
+  {
+    description: 'should return url string when request failed due to non-success response from server',
+    expected: 'rejected:',
+    func: function (resolve, reject) { cordova.plugin.http.get('https://httpbin.org/status/418', {}, {}, resolve, reject); },
+    validationFunc: function (driver, result) {
+      result.type.should.be.equal('rejected');
+      result.data.url.should.be.equal('https://httpbin.org/status/418');
+    }
+  },
+  {
+    description: 'shouldn\'t return header object when request failed before receiving response from server',
+    expected: 'rejected:',
+    func: function (resolve, reject) { cordova.plugin.http.get('https://not_existing_url', {}, {}, resolve, reject); },
+    validationFunc: function (driver, result) {
+      result.type.should.be.equal('rejected');
+      should.equal(result.data.headers, undefined);
+    }
+  },
+  {
+    description: 'should return status code when request failed before receiving response from server',
+    expected: 'rejected:',
+    func: function (resolve, reject) { cordova.plugin.http.get('https://not_existing_url', {}, {}, resolve, reject); },
+    validationFunc: function (driver, result) {
+      result.type.should.be.equal('rejected');
+      result.data.status.should.be.a('number');
+    }
+  },
+  {
+    description: 'shouldn\'t return url string when request failed before receiving response from server',
+    expected: 'rejected:',
+    func: function (resolve, reject) { cordova.plugin.http.get('https://not_existing_url', {}, {}, resolve, reject); },
+    validationFunc: function (driver, result) {
+      result.type.should.be.equal('rejected');
+      should.equal(result.data.url, undefined);
+    }
+  }
   // @TODO: not ready yet
   // {
   //   description: 'should authenticate correctly when client cert auth is configured with a PKCS12 container',

test/e2e-tooling/helpers/caps.js

@@ -26,7 +26,7 @@ const local = {
 const sauce = {
   iosDevice: {
     browserName: '',
-    'appium-version': '1.7.1',
+    'appium-version': '1.9.1',
     platformName: 'iOS',
     platformVersion: '10.3',
     deviceName: 'iPhone 6',
@@ -35,7 +35,7 @@ const sauce = {
   },
   iosEmulator: {
     browserName: '',
-    'appium-version': '1.7.1',
+    'appium-version': '1.9.1',
     platformName: 'iOS',
     platformVersion: '10.3',
     deviceName: 'iPhone Simulator',
@@ -44,7 +44,7 @@ const sauce = {
   },
   androidEmulator: {
     browserName: '',
-    'appium-version': '1.7.1',
+    'appium-version': '1.9.1',
     platformName: 'Android',
     platformVersion: '5.1',
     deviceName: 'Android Emulator',

test/e2e-tooling/helpers/setup.js

@@ -1,12 +0,0 @@
-const wd = require("wd");
-
-require('colors');
-
-const chai = require('chai');
-const chaiAsPromised = require('chai-as-promised');
-chai.use(chaiAsPromised);
-
-const should = chai.should();
-chaiAsPromised.transferPromiseness = wd.transferPromiseness;
-
-exports.should = should;

test/e2e-tooling/test.js

@@ -1,12 +1,18 @@
-require('./helpers/setup');
-
 const wd = require('wd');
+const chai = require('chai');
+const chaiAsPromised = require('chai-as-promised');
 const apps = require('./helpers/apps');
 const caps = Object.assign({}, require('./helpers/caps'));
 const serverConfig = require('./helpers/server');
 const testDefinitions = require('../e2e-specs');
 const pkgjson = require('../../package.json');
 
+chai.use(chaiAsPromised);
+chaiAsPromised.transferPromiseness = wd.transferPromiseness;
+global.should = chai.should();
+
+require('colors');
+
 describe('Advanced HTTP', function() {
   const isDevice = process.argv.includes('--device');
   const isAndroid = process.argv.includes('--android');
@@ -49,7 +55,7 @@ describe('Advanced HTTP', function() {
         if (value === 'finished') {
           resolve();
         } else if (Date.now() > timeoutTimestamp) {
-          reject('Test function timed out!');
+          reject(new Error('Test function timed out!'));
         } else {
           setTimeout(checkIfFinished, 500);
         }