Skip to content

Fix bug #395

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions .js
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
const queryString = require('./index');

// Example data that includes null and empty strings
const params = {
list: ['item', '', null, 'last']
};

// Options to reproduce the bug
const options = {
arrayFormat: 'comma',
skipNull: false,
skipEmptyString: false
};

// Stringify the parameters with the options
const result = queryString.stringify(params, options);

// Log the result to console
console.log(result); // Expected to incorrectly skip null and empty strings based on the bug
Comment on lines +1 to +19
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This example should be in the comment of the PR or expressed via a passing unit test. This file can't be merged into main

5 changes: 5 additions & 0 deletions index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -229,6 +229,11 @@ export interface StringifyOptions {

queryString.stringify({foo: [1, 2, 3]}, {arrayFormat: 'comma'});
//=> 'foo=1,2,3'

queryString.stringify({foo: [1, null, '']}, {arrayFormat: 'comma'});
//=> 'foo=1,,'
// Note that typing information for null values is lost
// and `.parse('foo=1,,')` would return `{foo: [1, '', '']}`.
```

- `separator`: Serialize arrays by separating elements with character:
Expand Down
12 changes: 10 additions & 2 deletions index.js
Original file line number Diff line number Diff line change
Expand Up @@ -49,12 +49,20 @@ function encoderForArrayFormat(options) {
case 'comma':
case 'separator':
return key => (result, value) => {
if (value === null || value === undefined || value.length === 0) {
if (
value === undefined ||
(options.skipNull && value === null) ||
(options.skipEmptyString && value === '')
) {
return result;
}

if (result.length === 0) {
return [[encode(key, options), '=', encode(value, options)].join('')];
return [[encode(key, options), '=', encode(value === null ? '' : value, options)].join('')];
}

if (value === null || value === '') {
return [[result, ''].join(options.arrayFormatSeparator)];
}

return [[result, encode(value, options)].join(options.arrayFormatSeparator)];
Expand Down
5 changes: 5 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,11 @@ const queryString = require('query-string');

queryString.stringify({foo: [1, 2, 3]}, {arrayFormat: 'comma'});
//=> 'foo=1,2,3'

queryString.stringify({foo: [1, null, '']}, {arrayFormat: 'comma'});
//=> 'foo=1,,'
// Note that typing information for null values is lost
// and `.parse('foo=1,,')` would return `{foo: [1, '', '']}`.
```

- `'none'`: Serialize arrays by using duplicate keys:
Expand Down
31 changes: 29 additions & 2 deletions test/parse.js
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@ test('query strings having ordered index arrays and format option as `index`', t
}), {bat: 'buz', foo: ['zero', 'two', 'one', 'three']});
});

test('circuit parse -> stringify', t => {
test('circuit parse stringify', t => {
const original = 'foo[3]=foo&foo[2]&foo[1]=one&foo[0]=&bat=buz';
const sortedOriginal = 'bat=buz&foo[0]=&foo[1]=one&foo[2]&foo[3]=foo';
const expected = {bat: 'buz', foo: ['', 'one', null, 'foo']};
Expand All @@ -226,7 +226,7 @@ test('circuit parse -> stringify', t => {
t.is(queryString.stringify(expected, options), sortedOriginal);
});

test('circuit original -> parse - > stringify -> sorted original', t => {
test('circuit original parse stringify sorted original', t => {
const original = 'foo[21474836471]=foo&foo[21474836470]&foo[1]=one&foo[0]=&bat=buz';
const sortedOriginal = 'bat=buz&foo[0]=&foo[1]=one&foo[2]&foo[3]=foo';
const options = {
Expand All @@ -236,6 +236,33 @@ test('circuit original -> parse - > stringify -> sorted original', t => {
t.deepEqual(queryString.stringify(queryString.parse(original, options), options), sortedOriginal);
});

test('circuit parse → stringify with array commas', t => {
const original = 'c=,a,,&b=&a=';
const sortedOriginal = 'a=&b=&c=,a,,';
const expected = {
c: ['', 'a', '', ''],
b: '',
a: ''
};
const options = {
arrayFormat: 'comma'
};

t.deepEqual(queryString.parse(original, options), expected);

t.is(queryString.stringify(expected, options), sortedOriginal);
});

test('circuit original → parse → stringify with array commas → sorted original', t => {
const original = 'c=,a,,&b=&a=';
const sortedOriginal = 'a=&b=&c=,a,,';
const options = {
arrayFormat: 'comma'
};

t.deepEqual(queryString.stringify(queryString.parse(original, options), options), sortedOriginal);
});

test('decode keys and values', t => {
t.deepEqual(queryString.parse('st%C3%A5le=foo'), {ståle: 'foo'});
t.deepEqual(queryString.parse('foo=%7B%ab%%7C%de%%7D+%%7Bst%C3%A5le%7D%'), {foo: '{%ab%|%de%} %{ståle}%'});
Expand Down
35 changes: 30 additions & 5 deletions test/stringify.js
Original file line number Diff line number Diff line change
Expand Up @@ -126,13 +126,38 @@ test('array stringify representation with array commas', t => {
}), 'bar=one,two&foo');
});

test('array stringify representation with array commas and null value', t => {
test('array stringify representation with array commas and null/empty values', t => {
const result = queryString.stringify({
list: ['item', null, 'last', '']
}, {
arrayFormat: 'comma',
skipNull: false,
skipEmptyString: false
});

t.is(result, 'list=item,,last,');
});

test('array stringify representation with array commas, null & empty string', t => {
t.is(queryString.stringify({
foo: [null, 'a', null, ''],
bar: [null]
c: [null, 'a', '', null],
b: [null],
a: ['']
}, {
arrayFormat: 'comma'
}), 'foo=a');
}), 'a=&b=&c=,a,,');
});

test('array stringify representation with array commas, null & empty string (skip both)', t => {
t.is(queryString.stringify({
c: [null, 'a', '', null],
b: [null],
a: ['']
}, {
skipNull: true,
skipEmptyString: true,
arrayFormat: 'comma'
}), 'c=a');
});

test('array stringify representation with array commas and 0 value', t => {
Expand All @@ -141,7 +166,7 @@ test('array stringify representation with array commas and 0 value', t => {
bar: [null]
}, {
arrayFormat: 'comma'
}), 'foo=a,0');
}), 'bar=&foo=a,,0');
});

test('array stringify representation with a bad array format', t => {
Expand Down