github/cordova-plugin-advanced-http
4
0
Fork 0
mirror of https://github.com/silkimen/cordova-plugin-advanced-http.git synced 2026-04-05 00:04:16 +08:00
Code Issues Packages Projects Releases Wiki Activity

WIP: support deeply structured query params (fix #48)

Browse Source
This commit is contained in:
Sefa Ilkimen
2019-04-02 12:51:20 +02:00
parent 230de36618
commit 8a83a940cb
2 changed files with 100 additions and 57 deletions
Download Patch File Download Diff File Expand all files Collapse all files

53
test/js-mocha-specs.js
View File

@@ -24,8 +24,6 @@ describe('Advanced HTTP public interface', function () {
http = require('../www/public-interface')(deps.exec, deps.cookieHandler, deps.urlUtil, deps.helpers, deps.globalConfigs);
};
this.timeout(900000);
beforeEach(() => {
// mocked btoa function (base 64 encoding strings)
global.btoa = decoded => new Buffer(decoded).toString('base64');
@@ -132,12 +130,12 @@ describe('Advanced HTTP public interface', function () {
});
});
describe('URL handler', function () {
describe('URL util', function () {
const helpers = require('../www/helpers')(null, null);
const handler = require('../www/url-util')(helpers);
const util = require('../www/url-util')(helpers);
it('parses URL with protocol, hostname and path correctly', () => {
handler.parseUrl('http://ilkimen.net/test').should.include({
util.parseUrl('http://ilkimen.net/test').should.include({
protocol: 'http:',
host: 'ilkimen.net',
hostname: 'ilkimen.net',
@@ -149,7 +147,7 @@ describe('URL handler', function () {
});
it('parses URL with protocol, hostname, port and path correctly', () => {
handler.parseUrl('http://ilkimen.net:8080/test').should.include({
util.parseUrl('http://ilkimen.net:8080/test').should.include({
protocol: 'http:',
host: 'ilkimen.net:8080',
hostname: 'ilkimen.net',
@@ -161,7 +159,7 @@ describe('URL handler', function () {
});
it('parses URL with protocol, hostname, port, path and query string correctly', () => {
handler.parseUrl('http://ilkimen.net:8080/test?param=value').should.include({
util.parseUrl('http://ilkimen.net:8080/test?param=value').should.include({
protocol: 'http:',
host: 'ilkimen.net:8080',
hostname: 'ilkimen.net',
@@ -173,7 +171,7 @@ describe('URL handler', function () {
});
it('parses URL with protocol, hostname, port, path, query string and hash param correctly', () => {
handler.parseUrl('http://ilkimen.net:8080/test?param=value#myHash').should.include({
util.parseUrl('http://ilkimen.net:8080/test?param=value#myHash').should.include({
protocol: 'http:',
host: 'ilkimen.net:8080',
hostname: 'ilkimen.net',
@@ -184,39 +182,52 @@ describe('URL handler', function () {
});
});
it('serializes query params correctly without URL encoding', () => {
handler.serializeQueryParams({
it('serializes query params correctly', () => {
util.serializeQueryParams({
param1: 'value with spaces',
param2: 'value with special character äöü%'
}, false).should.equal('param1=value with spaces&param2=value with special character äöü%');
});
it('serializes array of query params correctly without URL encoding', () => {
handler.serializeQueryParams({
myArray: ['val1', 'val2', 'val3'],
myString: 'testString'
}, false).should.equal('myArray[]=val1&myArray[]=val2&myArray[]=val3&myString=testString');
});
it('serializes query params correctly with URL encoding enabled', () => {
handler.serializeQueryParams({
util.serializeQueryParams({
param1: 'value with spaces',
param2: 'value with special character äöü%&'
}, true).should.equal('param1=value%20with%20spaces&param2=value%20with%20special%20character%20%C3%A4%C3%B6%C3%BC%25%26');
});
it('serializes array of query params correctly', () => {
util.serializeQueryParams({
myArray: ['val1', 'val2', 'val3'],
myString: 'testString'
}, false).should.equal('myArray[]=val1&myArray[]=val2&myArray[]=val3&myString=testString');
});
it('serializes deeply structured array of query params correctly', () => {
util.serializeQueryParams({
myArray: [['val1.1', 'val1.2', 'val1.3'], 'val2', 'val3'],
myString: 'testString'
}, false).should.equal('myArray[][]=val1.1&myArray[][]=val1.2&myArray[][]=val1.3&myArray[]=val2&myArray[]=val3&myString=testString');
});
it('serializes deeply structured object of query params correctly', () => {
util.serializeQueryParams({
myObject: { obj1: { 'param1.1': 'val1.1', 'param1.2': 'val1.2' }, param2: 'val2' }
}, false).should.equal('myObject[obj1][param1.1]=val1.1&myObject[obj1][param1.2]=val1.2&myObject[param2]=val2');
});
it('appends query params string correctly to given URL without query parameters', () => {
handler.appendQueryParamsString('http://ilkimen.net/', 'param1=value1')
util.appendQueryParamsString('http://ilkimen.net/', 'param1=value1')
.should.equal('http://ilkimen.net/?param1=value1');
});
it('appends query params string correctly to given URL with existing query parameters', () => {
handler.appendQueryParamsString('http://ilkimen.net/?myParam=myValue', 'param1=value1')
util.appendQueryParamsString('http://ilkimen.net/?myParam=myValue', 'param1=value1')
.should.equal('http://ilkimen.net/?myParam=myValue&param1=value1');
});
it('appends query params string correctly to given URL with existing query parameters and hash value', () => {
handler.appendQueryParamsString('http://ilkimen.net/?myParam=myValue#myHash', 'param1=value1')
util.appendQueryParamsString('http://ilkimen.net/?myParam=myValue#myHash', 'param1=value1')
.should.equal('http://ilkimen.net/?myParam=myValue&param1=value1#myHash');
});
});

104
www/url-util.js
View File

@@ -1,8 +1,8 @@
module.exports = function init(helpers) {
return {
parseUrl: parseUrl,
serializeQueryParams: serializeQueryParams,
appendQueryParamsString: appendQueryParamsString
appendQueryParamsString: appendQueryParamsString,
serializeQueryParams: serializeQueryParams
}
function parseUrl(url) {
@@ -19,40 +19,6 @@ module.exports = function init(helpers) {
}
}
function serializeQueryParams(params, encode) {
return serializeObject(params, encode);
}
function serializeObject(object, encode) {
var fragments = [];
for (var key in object) {
if (!object.hasOwnProperty(key)) {
continue;
}
if (helpers.getTypeOf(object[key]) === 'Array') {
fragments.push(serializeArray(object[key], encode));
continue;
} else if (helpers.getTypeOf(object[key]) === 'Object') {
fragments.push(serializeObject(object[key], encode));
continue;
}
if (encode) {
fragments.push(encodeURIComponent(key) + '=' + encodeURIComponent(object[key]));
} else {
fragments.push(key + '=' + object[key]);
}
}
return fragments.join('&');
}
function serializeArray(array, encode) {
}
function appendQueryParamsString(url, params) {
if (!url.length || !params.length) {
return url;
@@ -67,5 +33,71 @@ module.exports = function init(helpers) {
+ (parsed.search.length ? parsed.search + '&' + params : '?' + params)
+ parsed.hash;
}
function serializeQueryParams(params, encode) {
return serializeObject('', params, encode);
}
function serializeObject(parentKey, object, encode) {
var parts = [];
for (var key in object) {
if (!object.hasOwnProperty(key)) {
continue;
}
var identifier = parentKey.length ? parentKey + '[' + key + ']' : key;
if (helpers.getTypeOf(object[key]) === 'Array') {
parts.push(serializeArray(identifier, object[key], encode));
continue;
} else if (helpers.getTypeOf(object[key]) === 'Object') {
parts.push(serializeObject(identifier, object[key], encode));
continue;
}
parts.push(serializeIdentifier(parentKey, key, encode) + '=' + serializeValue(object[key], encode));
}
return parts.join('&');
}
function serializeArray(parentKey, array, encode) {
var parts = [];
for (var i = 0; i < array.length; ++i) {
if (helpers.getTypeOf(array[i]) === 'Array') {
parts.push(serializeArray(parentKey + '[]', array[i], encode));
continue;
} else if (helpers.getTypeOf(array[i]) === 'Object') {
parts.push(serializeObject(parentKey + '[]' + array[i], encode));
continue;
}
parts.push(serializeIdentifier(parentKey, '', encode) + '=' + serializeValue(array[i], encode));
}
return parts.join('&');
}
function serializeIdentifier(parentKey, key, encode) {
if (!parentKey.length) {
return key;
}
if (encode) {
return encodeURIComponent(parentKey) + '[' + encodeURIComponent(key) + ']';
} else {
return parentKey + '[' + key + ']';
}
}
function serializeValue(value, encode) {
if (encode) {
return encodeURIComponent(value);
} else {
return value;
}
}
};