stringify.js 8.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260
  1. /* eslint no-extend-native:0 */
  2. // Load modules
  3. var Code = require('code');
  4. var Lab = require('lab');
  5. var Qs = require('../');
  6. // Declare internals
  7. var internals = {};
  8. // Test shortcuts
  9. var lab = exports.lab = Lab.script();
  10. var expect = Code.expect;
  11. var describe = lab.experiment;
  12. var it = lab.test;
  13. describe('stringify()', function () {
  14. it('stringifies a querystring object', function (done) {
  15. expect(Qs.stringify({ a: 'b' })).to.equal('a=b');
  16. expect(Qs.stringify({ a: 1 })).to.equal('a=1');
  17. expect(Qs.stringify({ a: 1, b: 2 })).to.equal('a=1&b=2');
  18. expect(Qs.stringify({ a: 'A_Z' })).to.equal('a=A_Z');
  19. expect(Qs.stringify({ a: '€' })).to.equal('a=%E2%82%AC');
  20. expect(Qs.stringify({ a: '' })).to.equal('a=%EE%80%80');
  21. expect(Qs.stringify({ a: 'א' })).to.equal('a=%D7%90');
  22. expect(Qs.stringify({ a: '𐐷' })).to.equal('a=%F0%90%90%B7');
  23. done();
  24. });
  25. it('stringifies a nested object', function (done) {
  26. expect(Qs.stringify({ a: { b: 'c' } })).to.equal('a%5Bb%5D=c');
  27. expect(Qs.stringify({ a: { b: { c: { d: 'e' } } } })).to.equal('a%5Bb%5D%5Bc%5D%5Bd%5D=e');
  28. done();
  29. });
  30. it('stringifies an array value', function (done) {
  31. expect(Qs.stringify({ a: ['b', 'c', 'd'] })).to.equal('a%5B0%5D=b&a%5B1%5D=c&a%5B2%5D=d');
  32. done();
  33. });
  34. it('omits array indices when asked', function (done) {
  35. expect(Qs.stringify({ a: ['b', 'c', 'd'] }, { indices: false })).to.equal('a=b&a=c&a=d');
  36. done();
  37. });
  38. it('stringifies a nested array value', function (done) {
  39. expect(Qs.stringify({ a: { b: ['c', 'd'] } })).to.equal('a%5Bb%5D%5B0%5D=c&a%5Bb%5D%5B1%5D=d');
  40. done();
  41. });
  42. it('stringifies an object inside an array', function (done) {
  43. expect(Qs.stringify({ a: [{ b: 'c' }] })).to.equal('a%5B0%5D%5Bb%5D=c');
  44. expect(Qs.stringify({ a: [{ b: { c: [1] } }] })).to.equal('a%5B0%5D%5Bb%5D%5Bc%5D%5B0%5D=1');
  45. done();
  46. });
  47. it('does not omit object keys when indices = false', function (done) {
  48. expect(Qs.stringify({ a: [{ b: 'c' }] }, { indices: false })).to.equal('a%5Bb%5D=c');
  49. done();
  50. });
  51. it('uses indices notation for arrays when indices=true', function (done) {
  52. expect(Qs.stringify({ a: ['b', 'c'] }, { indices: true })).to.equal('a%5B0%5D=b&a%5B1%5D=c');
  53. done();
  54. });
  55. it('uses indices notation for arrays when no arrayFormat is specified', function (done) {
  56. expect(Qs.stringify({ a: ['b', 'c'] })).to.equal('a%5B0%5D=b&a%5B1%5D=c');
  57. done();
  58. });
  59. it('uses indices notation for arrays when no arrayFormat=indices', function (done) {
  60. expect(Qs.stringify({ a: ['b', 'c'] }, { arrayFormat: 'indices' })).to.equal('a%5B0%5D=b&a%5B1%5D=c');
  61. done();
  62. });
  63. it('uses repeat notation for arrays when no arrayFormat=repeat', function (done) {
  64. expect(Qs.stringify({ a: ['b', 'c'] }, { arrayFormat: 'repeat' })).to.equal('a=b&a=c');
  65. done();
  66. });
  67. it('uses brackets notation for arrays when no arrayFormat=brackets', function (done) {
  68. expect(Qs.stringify({ a: ['b', 'c'] }, { arrayFormat: 'brackets' })).to.equal('a%5B%5D=b&a%5B%5D=c');
  69. done();
  70. });
  71. it('stringifies a complicated object', function (done) {
  72. expect(Qs.stringify({ a: { b: 'c', d: 'e' } })).to.equal('a%5Bb%5D=c&a%5Bd%5D=e');
  73. done();
  74. });
  75. it('stringifies an empty value', function (done) {
  76. expect(Qs.stringify({ a: '' })).to.equal('a=');
  77. expect(Qs.stringify({ a: null }, { strictNullHandling: true })).to.equal('a');
  78. expect(Qs.stringify({ a: '', b: '' })).to.equal('a=&b=');
  79. expect(Qs.stringify({ a: null, b: '' }, { strictNullHandling: true })).to.equal('a&b=');
  80. expect(Qs.stringify({ a: { b: '' } })).to.equal('a%5Bb%5D=');
  81. expect(Qs.stringify({ a: { b: null } }, { strictNullHandling: true })).to.equal('a%5Bb%5D');
  82. expect(Qs.stringify({ a: { b: null } }, { strictNullHandling: false })).to.equal('a%5Bb%5D=');
  83. done();
  84. });
  85. it('stringifies an empty object', function (done) {
  86. var obj = Object.create(null);
  87. obj.a = 'b';
  88. expect(Qs.stringify(obj)).to.equal('a=b');
  89. done();
  90. });
  91. it('returns an empty string for invalid input', function (done) {
  92. expect(Qs.stringify(undefined)).to.equal('');
  93. expect(Qs.stringify(false)).to.equal('');
  94. expect(Qs.stringify(null)).to.equal('');
  95. expect(Qs.stringify('')).to.equal('');
  96. done();
  97. });
  98. it('stringifies an object with an empty object as a child', function (done) {
  99. var obj = {
  100. a: Object.create(null)
  101. };
  102. obj.a.b = 'c';
  103. expect(Qs.stringify(obj)).to.equal('a%5Bb%5D=c');
  104. done();
  105. });
  106. it('drops keys with a value of undefined', function (done) {
  107. expect(Qs.stringify({ a: undefined })).to.equal('');
  108. expect(Qs.stringify({ a: { b: undefined, c: null } }, { strictNullHandling: true })).to.equal('a%5Bc%5D');
  109. expect(Qs.stringify({ a: { b: undefined, c: null } }, { strictNullHandling: false })).to.equal('a%5Bc%5D=');
  110. expect(Qs.stringify({ a: { b: undefined, c: '' } })).to.equal('a%5Bc%5D=');
  111. done();
  112. });
  113. it('url encodes values', function (done) {
  114. expect(Qs.stringify({ a: 'b c' })).to.equal('a=b%20c');
  115. done();
  116. });
  117. it('stringifies a date', function (done) {
  118. var now = new Date();
  119. var str = 'a=' + encodeURIComponent(now.toISOString());
  120. expect(Qs.stringify({ a: now })).to.equal(str);
  121. done();
  122. });
  123. it('stringifies the weird object from qs', function (done) {
  124. expect(Qs.stringify({ 'my weird field': '~q1!2"\'w$5&7/z8)?' })).to.equal('my%20weird%20field=~q1%212%22%27w%245%267%2Fz8%29%3F');
  125. done();
  126. });
  127. it('skips properties that are part of the object prototype', function (done) {
  128. Object.prototype.crash = 'test';
  129. expect(Qs.stringify({ a: 'b' })).to.equal('a=b');
  130. expect(Qs.stringify({ a: { b: 'c' } })).to.equal('a%5Bb%5D=c');
  131. delete Object.prototype.crash;
  132. done();
  133. });
  134. it('stringifies boolean values', function (done) {
  135. expect(Qs.stringify({ a: true })).to.equal('a=true');
  136. expect(Qs.stringify({ a: { b: true } })).to.equal('a%5Bb%5D=true');
  137. expect(Qs.stringify({ b: false })).to.equal('b=false');
  138. expect(Qs.stringify({ b: { c: false } })).to.equal('b%5Bc%5D=false');
  139. done();
  140. });
  141. it('stringifies buffer values', function (done) {
  142. expect(Qs.stringify({ a: new Buffer('test') })).to.equal('a=test');
  143. expect(Qs.stringify({ a: { b: new Buffer('test') } })).to.equal('a%5Bb%5D=test');
  144. done();
  145. });
  146. it('stringifies an object using an alternative delimiter', function (done) {
  147. expect(Qs.stringify({ a: 'b', c: 'd' }, { delimiter: ';' })).to.equal('a=b;c=d');
  148. done();
  149. });
  150. it('doesn\'t blow up when Buffer global is missing', function (done) {
  151. var tempBuffer = global.Buffer;
  152. delete global.Buffer;
  153. expect(Qs.stringify({ a: 'b', c: 'd' })).to.equal('a=b&c=d');
  154. global.Buffer = tempBuffer;
  155. done();
  156. });
  157. it('selects properties when filter=array', function (done) {
  158. expect(Qs.stringify({ a: 'b' }, { filter: ['a'] })).to.equal('a=b');
  159. expect(Qs.stringify({ a: 1 }, { filter: [] })).to.equal('');
  160. expect(Qs.stringify({ a: { b: [1, 2, 3, 4], c: 'd' }, c: 'f' }, { filter: ['a', 'b', 0, 2] })).to.equal('a%5Bb%5D%5B0%5D=1&a%5Bb%5D%5B2%5D=3');
  161. done();
  162. });
  163. it('supports custom representations when filter=function', function (done) {
  164. var calls = 0;
  165. var obj = { a: 'b', c: 'd', e: { f: new Date(1257894000000) } };
  166. var filterFunc = function (prefix, value) {
  167. calls++;
  168. if (calls === 1) {
  169. expect(prefix).to.be.empty();
  170. expect(value).to.equal(obj);
  171. }
  172. else if (prefix === 'c') {
  173. return;
  174. }
  175. else if (value instanceof Date) {
  176. expect(prefix).to.equal('e[f]');
  177. return value.getTime();
  178. }
  179. return value;
  180. };
  181. expect(Qs.stringify(obj, { filter: filterFunc })).to.equal('a=b&e%5Bf%5D=1257894000000');
  182. expect(calls).to.equal(5);
  183. done();
  184. });
  185. });