Skip to content

Commit 74a0f6a

Browse files
committed
[Robustness] utils: enforce arrayLimit consistently across merge's array paths
`utils.merge` had two paths that grew an array past `arrayLimit` without the conversion/throw that `utils.combine` already performs: - the primitive-into-array branch was off by one (it tested the pre-append length with `> arrayLimit`, allowing `arrayLimit + 1` elements through) - the array-into-array branch did not consult `arrayLimit` at all Both now convert to an overflow object, or throw under `throwOnLimitExceeded`, once the resulting length exceeds `arrayLimit`, matching `combine` and the indexed and duplicate-bracket paths. So `a[0]=x&a[]=y` no longer stays a 2-element array at `arrayLimit: 1`.
1 parent f4938f5 commit 74a0f6a

3 files changed

Lines changed: 85 additions & 1 deletion

File tree

‎lib/utils.js‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ var merge = function merge(target, source, options) {
8989
if (typeof source !== 'object' && typeof source !== 'function') {
9090
if (isArray(target)) {
9191
var nextIndex = target.length;
92-
if (options && typeof options.arrayLimit === 'number' && nextIndex > options.arrayLimit) {
92+
if (options && typeof options.arrayLimit === 'number' && nextIndex >= options.arrayLimit) {
9393
if (options.throwOnLimitExceeded) {
9494
throw new RangeError('Array limit exceeded. Only ' + options.arrayLimit + ' element' + (options.arrayLimit === 1 ? '' : 's') + ' allowed in an array.');
9595
}
@@ -158,6 +158,12 @@ var merge = function merge(target, source, options) {
158158
target[i] = item;
159159
}
160160
});
161+
if (options && typeof options.arrayLimit === 'number' && target.length > options.arrayLimit) {
162+
if (options.throwOnLimitExceeded) {
163+
throw new RangeError('Array limit exceeded. Only ' + options.arrayLimit + ' element' + (options.arrayLimit === 1 ? '' : 's') + ' allowed in an array.');
164+
}
165+
return markOverflow(arrayToObject(target, options), target.length - 1);
166+
}
161167
return target;
162168
}
163169

‎test/parse.js‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1437,6 +1437,32 @@ test('parse()', function (t) {
14371437
sst.end();
14381438
});
14391439

1440+
st.test('enforces arrayLimit on merge at the boundary, consistently with combine', function (sst) {
1441+
sst['throws'](
1442+
function () { qs.parse('a[0]=x&a=y', { arrayLimit: 1, throwOnLimitExceeded: true }); },
1443+
new RangeError('Array limit exceeded. Only 1 element allowed in an array.'),
1444+
'a trailing scalar merged into an at-limit array throws'
1445+
);
1446+
sst.deepEqual(
1447+
qs.parse('a[0]=x&a=y', { arrayLimit: 1 }),
1448+
{ a: { 0: 'x', 1: 'y' } },
1449+
'and converts to an overflow object without throwOnLimitExceeded'
1450+
);
1451+
1452+
sst['throws'](
1453+
function () { qs.parse('a[0]=x&a[]=y', { arrayLimit: 1, throwOnLimitExceeded: true }); },
1454+
new RangeError('Array limit exceeded. Only 1 element allowed in an array.'),
1455+
'mixed index and bracket notation merged past the limit throws'
1456+
);
1457+
sst.deepEqual(
1458+
qs.parse('a[0]=x&a[]=y', { arrayLimit: 1 }),
1459+
{ a: { 0: 'x', 1: 'y' } },
1460+
'mixed index and bracket notation converts like duplicate-bracket combine'
1461+
);
1462+
1463+
sst.end();
1464+
});
1465+
14401466
st.test('does not throw when cumulative comma combine stays within arrayLimit', function (sst) {
14411467
var result = qs.parse('a=1,2,3&a=4', { comma: true, arrayLimit: 5, throwOnLimitExceeded: true });
14421468
sst.deepEqual(result, { a: ['1', '2', '3', '4'] }, 'combined array within limit is preserved');

‎test/utils.js‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,7 @@ test('merge()', function (t) {
6565
observed[0] = observed[0]; // eslint-disable-line no-self-assign
6666
st.equal(setCount, 1);
6767
st.equal(getCount, 2);
68+
6869
st.end();
6970
}
7071
);
@@ -78,6 +79,7 @@ test('merge()', function (t) {
7879
s2t.ok(utils.isOverflow(overflow), 'overflow object is marked');
7980
var merged = utils.merge(overflow, 'd');
8081
s2t.deepEqual(merged, { 0: 'a', 1: 'b', 2: 'c', 3: 'd' }, 'adds primitive at next numeric index');
82+
8183
s2t.end();
8284
});
8385

@@ -93,6 +95,7 @@ test('merge()', function (t) {
9395
var obj = { foo: 'bar' };
9496
var merged = utils.merge(obj, 'baz');
9597
s2t.deepEqual(merged, { foo: 'bar', baz: true }, 'adds primitive as key with value true');
98+
9699
s2t.end();
97100
});
98101

@@ -110,6 +113,7 @@ test('merge()', function (t) {
110113
var merged = utils.merge('c', overflow);
111114
s2t.ok(utils.isOverflow(merged), 'result is also marked as overflow');
112115
s2t.deepEqual(merged, { 0: 'c', 1: 'a', 2: 'b' }, 'creates object with primitive at 0, source values shifted');
116+
113117
s2t.end();
114118
});
115119

@@ -119,6 +123,7 @@ test('merge()', function (t) {
119123
var merged = utils.merge('c', overflow, { plainObjects: true });
120124
s2t.ok(utils.isOverflow(merged), 'result is also marked as overflow');
121125
s2t.deepEqual(merged, { __proto__: null, 0: 'c', 1: 'a', 2: 'b' }, 'creates null-proto object with primitive at 0');
126+
122127
s2t.end();
123128
});
124129

@@ -128,13 +133,15 @@ test('merge()', function (t) {
128133
s2t.ok(utils.isOverflow(overflow), 'overflow object is marked');
129134
var merged = utils.merge('a', overflow);
130135
s2t.deepEqual(merged, { 0: 'a', 1: 'b', 2: 'c', 3: 'd' }, 'shifts all source indices by 1');
136+
131137
s2t.end();
132138
});
133139

134140
st.test('merges regular object into primitive as array', function (s2t) {
135141
var obj = { foo: 'bar' };
136142
var merged = utils.merge('a', obj);
137143
s2t.deepEqual(merged, ['a', { foo: 'bar' }], 'creates array with primitive and object');
144+
138145
s2t.end();
139146
});
140147

@@ -143,13 +150,56 @@ test('merge()', function (t) {
143150
var merged = utils.merge(arr, 'd', { arrayLimit: 1 });
144151
s2t.ok(utils.isOverflow(merged), 'result is marked as overflow');
145152
s2t.deepEqual(merged, { 0: 'a', 1: 'b', 2: 'c', 3: 'd' }, 'converts to overflow object with primitive appended');
153+
146154
s2t.end();
147155
});
148156

149157
st.test('merges array into primitive that exceeds arrayLimit', function (s2t) {
150158
var merged = utils.merge('a', ['b', 'c'], { arrayLimit: 1 });
151159
s2t.ok(utils.isOverflow(merged), 'result is marked as overflow');
152160
s2t.deepEqual(merged, { 0: 'a', 1: 'b', 2: 'c' }, 'converts to overflow object');
161+
162+
s2t.end();
163+
});
164+
165+
st.test('merges primitive into array at the arrayLimit boundary, consistently with combine', function (s2t) {
166+
var merged = utils.merge(['a'], 'b', { arrayLimit: 1 });
167+
s2t.ok(utils.isOverflow(merged), 'result is marked as overflow at the boundary');
168+
s2t.deepEqual(merged, { 0: 'a', 1: 'b' }, 'converts to overflow object instead of a length-2 array');
169+
170+
s2t.end();
171+
});
172+
173+
st.test('merges two arrays that exceed arrayLimit into an overflow object', function (s2t) {
174+
var merged = utils.merge(['a'], ['b'], { arrayLimit: 1 });
175+
s2t.ok(utils.isOverflow(merged), 'result is marked as overflow');
176+
s2t.deepEqual(merged, { 0: 'a', 1: 'b' }, 'array-into-array merge enforces arrayLimit like combine');
177+
178+
s2t.end();
179+
});
180+
181+
st.test('throws at the arrayLimit boundary when merging a primitive into an array with throwOnLimitExceeded', function (s2t) {
182+
s2t['throws'](
183+
function () { utils.merge(['a'], 'b', { arrayLimit: 1, throwOnLimitExceeded: true }); },
184+
new RangeError('Array limit exceeded. Only 1 element allowed in an array.'),
185+
'throws when the resulting length would exceed arrayLimit'
186+
);
187+
188+
s2t.end();
189+
});
190+
191+
st.test('throws when merging two arrays past arrayLimit with throwOnLimitExceeded', function (s2t) {
192+
s2t['throws'](
193+
function () { utils.merge(['a'], ['b'], { arrayLimit: 1, throwOnLimitExceeded: true }); },
194+
new RangeError('Array limit exceeded. Only 1 element allowed in an array.'),
195+
'array-into-array merge throws rather than silently exceeding arrayLimit'
196+
);
197+
s2t['throws'](
198+
function () { utils.merge(['a', 'b', 'c'], ['d', 'e', 'f'], { arrayLimit: 2, throwOnLimitExceeded: true }); },
199+
new RangeError('Array limit exceeded. Only 2 elements allowed in an array.'),
200+
'uses the plural message when arrayLimit is not 1'
201+
);
202+
153203
s2t.end();
154204
});
155205

@@ -164,6 +214,7 @@ test('merge()', function (t) {
164214
new RangeError('Array limit exceeded. Only 2 elements allowed in an array.'),
165215
'uses the plural message when arrayLimit is not 1'
166216
);
217+
167218
s2t.end();
168219
});
169220

@@ -178,6 +229,7 @@ test('merge()', function (t) {
178229
new RangeError('Array limit exceeded. Only 2 elements allowed in an array.'),
179230
'uses the plural message when arrayLimit is not 1'
180231
);
232+
181233
s2t.end();
182234
});
183235

0 commit comments

Comments
 (0)