release v3.0.1

chore(deps): bump lodash from 4.17.15 to 4.17.19

.travis.yml

@@ -36,17 +36,19 @@ matrix:
 
     android:
       components:
+        - tools
         - platform-tools
         - build-tools-28.0.3
-        - android-27
+        - android-28
         - extra-android-support
         - extra-android-m2repository
         - extra-google-m2repository
 
     before_install:
     - export LANG=en_US.UTF-8 &&
-      curl -sL https://deb.nodesource.com/setup_8.x | sudo -E bash - &&
+      curl -sL https://deb.nodesource.com/setup_10.x | sudo -E bash - &&
       sudo apt-get install -y nodejs
+    - yes | sdkmanager --update
 
     install:
     - npm install

CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## 3.0.1
+
+- Fixed #359: memory leakage leads to app crashes on Android
+- Fixed #355: responseType "json" not working with valid JSON response on browser (thanks millerg6711)
+
+## 3.0.0
+
+- Feature #158: support removing headers which were previously set via "setHeader"
+
+- Fixed #345: empty file names are not handled correctly (thanks ikosta)
+
+- :warning: **Breaking Change**: Dropped support for Android < 5.1
+- :warning: **Breaking Change**: Removed "disableRedirect", use "setFollowRedirect" instead
+- :warning: **Breaking Change**: Removed "setSSLCertMode", use "setServerTrustMode" instead
+
 ## 2.5.1
 
 - Fixed #334: empty JSON response triggers error even though request is successful (thanks antikalk)

README.md

@@ -61,7 +61,7 @@ cordova.plugin.http.useBasicAuth('user', 'password');
 ```
 
 ### setHeader<a name="setHeader"></a>
-Set a header for all future requests to a specified host. Takes a hostname, a header and a value (must be a string value).
+Set a header for all future requests to a specified host. Takes a hostname, a header and a value (must be a string value or null).
 
 ```js
 cordova.plugin.http.setHeader('Hostname', 'Header', 'Value');
@@ -210,12 +210,6 @@ Configure X.509 client certificate authentication. Takes mode and options. `mode
   cordova.plugin.http.setClientAuthMode('none', {}, success, fail);
 ```
 
-### disableRedirect (deprecated)
-This function was deprecated in 2.0.9. Use ["setFollowRedirect"](#setFollowRedirect) instead.
-
-### setSSLCertMode (deprecated)
-This function was deprecated in 2.0.8. Use ["setServerTrustMode"](#setServerTrustMode) instead.
-
 ### removeCookies
 Remove all cookies associated with a given URL.
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "cordova-plugin-advanced-http",
-  "version": "2.5.1",
+  "version": "3.0.1",
   "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",
@@ -58,15 +58,12 @@
   },
   "homepage": "https://github.com/silkimen/cordova-plugin-advanced-http#readme",
   "devDependencies": {
-    "chai": "4.1.2",
-    "chai-as-promised": "7.1.1",
-    "colors": "1.1.2",
-    "cordova": "8.1.2",
-    "mocha": "4.0.0",
-    "mock-require": "2.0.2",
-    "mz": "2.7.0",
+    "chai": "4.2.0",
+    "colors": "1.4.0",
+    "cordova": "9.0.0",
+    "mocha": "8.0.1",
     "umd-tough-cookie": "2.4.3",
-    "wd": "1.4.1",
-    "xml2js": "0.4.19"
+    "wd": "1.12.1",
+    "xml2js": "0.4.23"
   }
 }

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.5.1">
+<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="3.0.1">
   <name>Advanced HTTP plugin</name>
   <description>
         Cordova / Phonegap plugin for communicating with HTTP servers using SSL pinning
@@ -79,11 +79,8 @@
     <source-file src="src/android/com/silkimen/http/HttpRequest.java" target-dir="src/com/silkimen/http"/>
     <source-file src="src/android/com/silkimen/http/JsonUtils.java" target-dir="src/com/silkimen/http"/>
     <source-file src="src/android/com/silkimen/http/KeyChainKeyManager.java" target-dir="src/com/silkimen/http"/>
-    <source-file src="src/android/com/silkimen/http/OkConnectionFactory.java" target-dir="src/com/silkimen/http"/>
     <source-file src="src/android/com/silkimen/http/TLSConfiguration.java" target-dir="src/com/silkimen/http"/>
     <source-file src="src/android/com/silkimen/http/TLSSocketFactory.java" target-dir="src/com/silkimen/http"/>
-    <preference name="OKHTTP_VERSION" default="3.10.0"/>
-    <framework src="com.squareup.okhttp3:okhttp-urlconnection:$OKHTTP_VERSION"/>
   </platform>
   <platform name="browser">
     <config-file target="config.xml" parent="/*">

scripts/update-plugin-xml.js

@@ -1,5 +1,5 @@
 const args = process.argv.slice(2);
-const fs = require('mz/fs');
+const fs = require('fs');
 const path = require('path');
 const xml2js = require('xml2js');
 const xmlPath = path.join(__dirname, '..', 'plugin.xml');
@@ -22,10 +22,12 @@ const stringify = obj => {
   return builder.buildObject(obj);
 };
 
-fs.readFile(xmlPath, 'utf-8')
-  .then(xml => parse(xml))
-  .then(parsed => {
-    parsed.plugin.$.version = args[0];
+const update = async (version) => {
+  const xml = fs.readFileSync(xmlPath, 'utf-8');
+  const parsed = await parse(xml);
 
-    return fs.writeFile(xmlPath, stringify(parsed));
-  });
+  parsed.plugin.$.version = version;
+  fs.writeFileSync(xmlPath, stringify(parsed));
+};
+
+return update(args[0]);

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

@@ -16,7 +16,6 @@ import com.silkimen.http.HttpBodyDecoder;
 import com.silkimen.http.HttpRequest;
 import com.silkimen.http.HttpRequest.HttpRequestException;
 import com.silkimen.http.JsonUtils;
-import com.silkimen.http.OkConnectionFactory;
 import com.silkimen.http.TLSConfiguration;
 
 import org.apache.cordova.CallbackContext;
@@ -80,6 +79,7 @@ abstract class CordovaHttpBase implements Runnable {
       this.prepareRequest(request);
       this.sendBody(request);
       this.processResponse(request, response);
+      request.disconnect();
     } catch (HttpRequestException e) {
       if (e.getCause() instanceof SSLException) {
         response.setStatus(-2);
@@ -124,7 +124,6 @@ abstract class CordovaHttpBase implements Runnable {
     request.readTimeout(this.timeout);
     request.acceptCharset("UTF-8");
     request.uncompress(true);
-    HttpRequest.setConnectionFactory(new OkConnectionFactory());
 
     if (this.tlsConfiguration.getHostnameVerifier() != null) {
       request.setHostnameVerifier(this.tlsConfiguration.getHostnameVerifier());

src/android/com/silkimen/http/OkConnectionFactory.java

@@ -1,26 +0,0 @@
-package com.silkimen.http;
-
-import okhttp3.OkHttpClient;
-import okhttp3.OkUrlFactory;
-
-import java.net.URL;
-import java.net.HttpURLConnection;
-import java.net.URLStreamHandler;
-import java.net.Proxy;
-
-public class OkConnectionFactory implements HttpRequest.ConnectionFactory {
-  private final OkHttpClient client = new OkHttpClient();
-
-  public HttpURLConnection create(URL url) {
-    OkUrlFactory urlFactory = new OkUrlFactory(this.client);
-
-    return (HttpURLConnection) urlFactory.open(url);
-  }
-
-  public HttpURLConnection create(URL url, Proxy proxy) {
-    OkHttpClient clientWithProxy = new OkHttpClient.Builder().proxy(proxy).build();
-    OkUrlFactory urlFactory = new OkUrlFactory(clientWithProxy);
-
-    return (HttpURLConnection) urlFactory.open(url);
-  }
-}

src/browser/cordova-http-plugin.js

@@ -20,7 +20,7 @@ function serializePrimitive(key, value) {
 }
 
 function serializeArray(key, values) {
-  return values.map(function(value) {
+  return values.map(function (value) {
     return encodeURIComponent(key) + '[]=' + encodeURIComponent(value);
   }).join('&');
 }
@@ -28,7 +28,7 @@ function serializeArray(key, values) {
 function serializeParams(params) {
   if (params === null) return '';
 
-  return Object.keys(params).map(function(key) {
+  return Object.keys(params).map(function (key) {
     if (jsUtil.getTypeOf(params[key]) === 'Array') {
       return serializeArray(key, params[key]);
     }
@@ -38,11 +38,11 @@ function serializeParams(params) {
 }
 
 function decodeB64(dataString) {
-  var binarString = atob(dataString);
-  var bytes = new Uint8Array(binarString.length);
+  var binaryString = atob(dataString);
+  var bytes = new Uint8Array(binaryString.length);
 
-  for (var i = 0; i < binarString.length; ++i) {
-      bytes[i] = binarString.charCodeAt(i);
+  for (var i = 0; i < binaryString.length; ++i) {
+    bytes[i] = binaryString.charCodeAt(i);
   }
 
   return bytes.buffer;
@@ -60,7 +60,7 @@ function processMultipartData(data) {
     var type = data.types[i];
 
     if (fileName) {
-      fd.append(name, new Blob([decodeB64(buffer)], {type: type}), fileName);
+      fd.append(name, new Blob([decodeB64(buffer)], { type: type }), fileName);
     } else {
       // we assume it's plain text if no filename was given
       fd.append(name, atob(buffer));
@@ -118,7 +118,7 @@ function createXhrFailureObject(xhr) {
 function getHeaderValue(headers, headerName) {
   let result = null;
 
-  Object.keys(headers).forEach(function(key) {
+  Object.keys(headers).forEach(function (key) {
     if (key.toLowerCase() === headerName.toLowerCase()) {
       result = headers[key];
     }
@@ -134,7 +134,7 @@ function setDefaultContentType(headers, contentType) {
 }
 
 function setHeaders(xhr, headers) {
-  Object.keys(headers).forEach(function(key) {
+  Object.keys(headers).forEach(function (key) {
     if (key.toLowerCase() === 'cookie') return;
 
     xhr.setRequestHeader(key, headers[key]);
@@ -196,7 +196,7 @@ function sendRequest(method, withData, opts, success, failure) {
 
     case 'multipart':
       const contentType = getHeaderValue(headers, 'Content-Type');
-      
+
       // intentionally don't set a default content type
       // it's set by the browser together with the content disposition string
       if (contentType) {
@@ -212,15 +212,16 @@ function sendRequest(method, withData, opts, success, failure) {
       break;
   }
 
+  // requesting text instead of JSON because it's parsed in the response handler
+  xhr.responseType = responseType === 'json' ? 'text' : responseType;
   xhr.timeout = timeout * 1000;
-  xhr.responseType = responseType;
   setHeaders(xhr, headers);
 
   xhr.onerror = function () {
     return failure(createXhrFailureObject(xhr));
   };
 
-  xhr.ontimeout = function () { 
+  xhr.ontimeout = function () {
     return failure({
       status: -4,
       error: 'Request timed out',

test/e2e-app-template/config.xml

@@ -22,9 +22,9 @@
         <allow-intent href="itms:*" />
         <allow-intent href="itms-apps:*" />
     </platform>
-    <engine name="android" spec="7.1.0" />
-    <engine name="browser" spec="5.0.0" />
-    <engine name="ios" spec="5.0.1" />
-    <plugin name="cordova-plugin-file" spec="6.0.1" />
+    <engine name="android" spec="8.1.0" />
+    <engine name="browser" spec="6.0.0" />
+    <engine name="ios" spec="5.1.0" />
+    <plugin name="cordova-plugin-file" spec="6.0.2" />
     <preference name="AndroidPersistentFileLocation" value="Internal" />
 </widget>

test/e2e-app-template/package.json

@@ -1,26 +1,26 @@
 {
-    "name": "com.ilkimen.http.demo",
-    "displayName": "HttpDemo",
-    "version": "1.0.0",
-    "description": "A sample Apache Cordova application that demonstrates advanced HTTP plugin.",
-    "main": "index.js",
-    "scripts": {
-        "build": "scripts/build.sh",
-        "test": "npm run build && scripts/test.sh"
-    },
-    "author": "Sefa Ilkimen",
-    "license": "Apache-2.0",
-    "dependencies": {
-        "cordova": "7.0.1",
-        "cordova-android": "7.1.0",
-        "cordova-browser": "5.0.0",
-        "cordova-ios": "5.0.1"
-    },
-    "cordova": {
-        "platforms": [
-            "android",
-            "ios"
-        ]
-    },
-    "devDependencies": {}
-}
+  "name": "com.ilkimen.http.demo",
+  "displayName": "HttpDemo",
+  "version": "1.0.0",
+  "description": "A sample Apache Cordova application that demonstrates advanced HTTP plugin.",
+  "main": "index.js",
+  "scripts": {
+    "build": "scripts/build.sh",
+    "test": "npm run build && scripts/test.sh"
+  },
+  "author": "Sefa Ilkimen",
+  "license": "Apache-2.0",
+  "dependencies": {
+    "cordova": "9.0.0",
+    "cordova-android": "8.1.0",
+    "cordova-browser": "6.0.0",
+    "cordova-ios": "5.1.0"
+  },
+  "cordova": {
+    "platforms": [
+      "android",
+      "ios"
+    ]
+  },
+  "devDependencies": {}
+}

test/e2e-specs.js

@@ -288,25 +288,25 @@ const tests = [
       JSON.parse(result.data.data).form.should.eql({ test: 'testString' });
     }
   },
-  {
-    description: 'should resolve correct URL after redirect (GET) #33',
-    expected: 'resolved: {"status": 200, url: "http://httpbin.org/anything", ...',
-    func: function (resolve, reject) { cordova.plugin.http.get('http://httpbin.org/redirect-to?url=http://httpbin.org/anything', {}, {}, resolve, reject); },
-    validationFunc: function (driver, result) {
-      result.type.should.be.equal('resolved');
-      result.data.url.should.be.equal('http://httpbin.org/anything');
-    }
-  },
-  {
-    description: 'should not follow 302 redirect when following redirects is disabled',
-    expected: 'rejected: {"status": 302, ...',
-    before: function (resolve, reject) { cordova.plugin.http.disableRedirect(true, resolve, reject) },
-    func: function (resolve, reject) { cordova.plugin.http.get('http://httpbin.org/redirect-to?url=http://httpbin.org/anything', {}, {}, resolve, reject); },
-    validationFunc: function (driver, result) {
-      result.type.should.be.equal('rejected');
-      result.data.status.should.be.equal(302);
-    }
-  },
+  // {
+  //   description: 'should resolve correct URL after redirect (GET) #33',
+  //   expected: 'resolved: {"status": 200, url: "http://httpbin.org/anything", ...',
+  //   func: function (resolve, reject) { cordova.plugin.http.get('http://httpbin.org/redirect-to?url=http://httpbin.org/anything', {}, {}, resolve, reject); },
+  //   validationFunc: function (driver, result) {
+  //     result.type.should.be.equal('resolved');
+  //     result.data.url.should.be.equal('http://httpbin.org/anything');
+  //   }
+  // },
+  // {
+  //   description: 'should not follow 302 redirect when following redirects is disabled',
+  //   expected: 'rejected: {"status": 302, ...',
+  //   before: function (resolve, reject) { cordova.plugin.http.disableRedirect(true, resolve, reject) },
+  //   func: function (resolve, reject) { cordova.plugin.http.get('http://httpbin.org/redirect-to?url=http://httpbin.org/anything', {}, {}, resolve, reject); },
+  //   validationFunc: function (driver, result) {
+  //     result.type.should.be.equal('rejected');
+  //     result.data.status.should.be.equal(302);
+  //   }
+  // },
   {
     description: 'should download a file from given URL to given path in local filesystem',
     expected: 'resolved: {"content": "<?xml version=\'1.0\' encoding=\'us-ascii\'?>\\n\\n<!--  A SAMPLE set of slides  -->" ...',

test/e2e-tooling/test.js

@@ -1,13 +1,10 @@
 const wd = require('wd');
 const chai = require('chai');
-const chaiAsPromised = require('chai-as-promised');
 const logging = require('./logging');
 const capsConfig = require('./caps');
 const serverConfig = require('./server');
 const testDefinitions = require('../e2e-specs');
 
-chai.use(chaiAsPromised);
-chaiAsPromised.transferPromiseness = wd.transferPromiseness;
 global.should = chai.should();
 
 describe('Advanced HTTP e2e test suite', function () {

test/js-specs.js

@@ -1,5 +1,4 @@
 const chai = require('chai');
-const mock = require('mock-require');
 const util = require('util');
 const should = chai.should();
 
@@ -50,6 +49,13 @@ describe('Advanced HTTP public interface', function () {
     http.getHeaders('*').myKey.should.equal('myValue');
   });
 
+  it('clears global headers correctly when value is undefined', () => {
+    http.setHeader('*', 'myKey', 'myValue');
+    http.setHeader('*', 'myKey', null);
+    should.equal(undefined, http.getHeaders('*').myKey);
+    Object.keys(http.getHeaders('*')).length.should.be.equal(0);
+  });
+
   it('sets host headers correctly #24', () => {
     http.setHeader('www.google.de', 'myKey', 'myValue');
     http.getHeaders('www.google.de').myKey.should.equal('myValue');
@@ -623,6 +629,44 @@ describe('Common helpers', function () {
       });
     });
 
+    it('processes data correctly when serializer "multipart" is configured and form data contains file value (filename set)', (cb) => {
+      const formData = new FormDataMock();
+      formData.append('myFile', new BlobMock([testString], { type: 'application/octet-stream' }), 'file.name');
+
+      helpers.processData(formData, 'multipart', (data) => {
+        data.buffers.length.should.be.equal(1);
+        data.names.length.should.be.equal(1);
+        data.fileNames.length.should.be.equal(1);
+        data.types.length.should.be.equal(1);
+
+        data.buffers[0].should.be.eql(testStringBase64);
+        data.names[0].should.be.equal('myFile');
+        data.fileNames[0].should.be.equal('file.name');
+        data.types[0].should.be.equal('application/octet-stream');
+
+        cb();
+      });
+    });
+
+    it('processes data correctly when serializer "multipart" is configured and form data contains file value (filename empty)', (cb) => {
+      const formData = new FormDataMock();
+      formData.append('myFile', new BlobMock([testString], { type: 'application/octet-stream' }), '');
+
+      helpers.processData(formData, 'multipart', (data) => {
+        data.buffers.length.should.be.equal(1);
+        data.names.length.should.be.equal(1);
+        data.fileNames.length.should.be.equal(1);
+        data.types.length.should.be.equal(1);
+
+        data.buffers[0].should.be.eql(testStringBase64);
+        data.names[0].should.be.equal('myFile');
+        data.fileNames[0].should.be.equal('');
+        data.types[0].should.be.equal('application/octet-stream');
+
+        cb();
+      });
+    });
+
     it('processes data correctly when serializer "raw" is configured', (cb) => {
       const byteArray = new Uint8Array([1, 2, 3]);
       helpers.processData(byteArray, 'raw', (data) => {

test/mocks/File.mock.js

@@ -3,7 +3,7 @@ const BlobMock = require('./Blob.mock');
 module.exports = class FileMock extends BlobMock {
   constructor(blob, fileName) {
     super(blob, { type: blob.type });
-    this._fileName = fileName || '';
+    this._fileName = fileName !== undefined ? fileName : 'blob';
     this.__lastModifiedDate = new Date();
   }
 

www/helpers.js

@@ -187,7 +187,9 @@ module.exports = function init(global, jsUtil, cookieHandler, messages, base64,
   }
 
   function checkForInvalidHeaderValue(value) {
-    if (jsUtil.getTypeOf(value) !== 'String') {
+    var type = jsUtil.getTypeOf(value);
+
+    if (type !== 'String' && type !== 'Null') {
       throw new Error(messages.INVALID_HEADER_VALUE);
     }
 
@@ -451,7 +453,7 @@ module.exports = function init(global, jsUtil, cookieHandler, messages, base64,
       reader.onload = function () {
         result.buffers.push(base64.fromArrayBuffer(reader.result));
         result.names.push(entry.value[0]);
-        result.fileNames.push(entry.value[1].name || 'blob');
+        result.fileNames.push(entry.value[1].name !== undefined ? entry.value[1].name : 'blob');
         result.types.push(entry.value[1].type || '');
         processFormDataIterator(iterator, textEncoder, result, onFinished);
       };

www/messages.js

@@ -11,7 +11,7 @@ module.exports = {
   INVALID_DATA_SERIALIZER: 'advanced-http: invalid serializer, supported serializers are:',
   INVALID_DOWNLOAD_FILE_PATH: 'advanced-http: invalid "filePath" value, needs to be a string, <filePath: string>',
   INVALID_FOLLOW_REDIRECT_VALUE: 'advanced-http: invalid follow redirect value, needs to be a boolean value, <followRedirect: boolean>',
-  INVALID_HEADER_VALUE: 'advanced-http: invalid header value, needs to be a string, <header: string>',
+  INVALID_HEADER_VALUE: 'advanced-http: invalid header value, needs to be a string or null, <header: string | null>',
   INVALID_HTTP_METHOD: 'advanced-http: invalid HTTP method, supported methods are:',
   INVALID_RESPONSE_TYPE: 'advanced-http: invalid response type, supported types are:',
   INVALID_SSL_CERT_MODE: 'advanced-http: invalid SSL cert mode, supported modes are:',

www/ponyfills.js

@@ -16,7 +16,7 @@ module.exports = function init(global) {
     } else if (global.Blob && value instanceof global.Blob) {
       // mimic File instance by adding missing properties
       value.lastModifiedDate = new Date();
-      value.name = filename || '';
+      value.name = filename !== undefined ? filename : 'blob';
     } else {
       value = String(value);
     }
@@ -44,4 +44,4 @@ module.exports = function init(global) {
   }
 
   return interface;
-};
+};

www/public-interface.js

@@ -14,10 +14,6 @@ module.exports = function init(exec, cookieHandler, urlUtil, helpers, globalConf
     setRequestTimeout: setRequestTimeout,
     getFollowRedirect: getFollowRedirect,
     setFollowRedirect: setFollowRedirect,
-    // @DEPRECATED
-    disableRedirect: disableRedirect,
-    // @DEPRECATED
-    setSSLCertMode: setServerTrustMode,
     setServerTrustMode: setServerTrustMode,
     setClientAuthMode: setClientAuthMode,
     sendRequest: sendRequest,
@@ -62,7 +58,12 @@ module.exports = function init(exec, cookieHandler, urlUtil, helpers, globalConf
     helpers.checkForInvalidHeaderValue(value);
 
     globalConfigs.headers[host] = globalConfigs.headers[host] || {};
-    globalConfigs.headers[host][header] = value;
+
+    if (value === null) {
+      delete globalConfigs.headers[host][header];
+    } else {
+      globalConfigs.headers[host][header] = value;
+    }
   }
 
   function getDataSerializer() {
@@ -105,14 +106,6 @@ module.exports = function init(exec, cookieHandler, urlUtil, helpers, globalConf
     globalConfigs.followRedirect = helpers.checkFollowRedirectValue(follow);
   }
 
-  // @DEPRECATED
-  function disableRedirect(disable, success, failure) {
-    helpers.handleMissingCallbacks(success, failure);
-
-    setFollowRedirect(!disable);
-    success();
-  }
-
   function setServerTrustMode(mode, success, failure) {
     helpers.handleMissingCallbacks(success, failure);
 
@@ -154,7 +147,7 @@ module.exports = function init(exec, cookieHandler, urlUtil, helpers, globalConf
       case 'post':
       case 'put':
       case 'patch':
-        return helpers.processData(options.data, options.serializer, function(data) {
+        return helpers.processData(options.data, options.serializer, function (data) {
           exec(onSuccess, onFail, 'CordovaHttpPlugin', options.method, [url, data, options.serializer, headers, options.timeout, options.followRedirect, options.responseType]);
         });
       case 'upload':