Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

arrayFormat for parse #329

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Conversation

dreyks
Copy link
Contributor

@dreyks dreyks commented Sep 6, 2019

added basic tests. without arrayFormat parse's behavior does not change

don't think we want to allow specifying several formats simultaneously?

@ljharb
Copy link
Owner

ljharb commented Sep 8, 2019

Are these tests expected to pass as-is, or fail?

@dreyks
Copy link
Contributor Author

dreyks commented Sep 8, 2019

they’re expected to fail. i just wanted to be sure that this is the behavior we want. if you’re ok with it - i’ll proceed to the implementation

@ljharb
Copy link
Owner

ljharb commented Sep 8, 2019

@dreyks i think it would be helpful to have two commits - one with passing tests, and another with the tests that fail. It makes it much easier for me to see what's breaking or not, and what requires a new option or not.

@dreyks
Copy link
Contributor Author

dreyks commented Sep 8, 2019

oh. gotcha. ok will do

@dreyks
Copy link
Contributor Author

dreyks commented Sep 8, 2019

done

@@ -34,17 +34,31 @@ test('parse()', function (t) {

t.test('arrayFormat: brackets allows only explicit arrays', function (st) {
st.deepEqual(qs.parse('a[]=b&a[]=c', { arrayFormat: 'brackets' }), { a: ['b', 'c'] });
st.deepEqual(qs.parse('a[0]=b&a[1]=c', { arrayFormat: 'brackets' }), { 'a[0]': 'b', 'a[1]': 'c' });
Copy link
Owner

Choose a reason for hiding this comment

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

i see how this seems correct, because it's currently set to brackets but is parsing indices.

However, the current behavior matches what PHP, Rails, and express all do, so I'm not sure it should change.

Copy link
Contributor Author

@dreyks dreyks Sep 21, 2019

Choose a reason for hiding this comment

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

yeah, i'm not very sure on this one too, though you have to explicitly state you want this behavior so maybe it's ok

alternatively allowing arrayFormat to be an array itself could solve it

t.deepEqual(qs.parse('a[0]=b&a[1]=c', { arrayFormat: ['brackets', 'indices'] }), { 'a': ['b',  'c'] });
t.deepEqual(qs.parse('a[]=b&a[]=c', { arrayFormat: ['brackets', 'indices'] }), { 'a': ['b',  'c'] });

st.deepEqual(qs.parse('a=b,c', { arrayFormat: 'brackets' }), { a: 'b,c' });
st.deepEqual(qs.parse('a=b&a=c', { arrayFormat: 'brackets' }), { a: ['b', 'c'] });
st.deepEqual(qs.parse('a=b&a=c', { arrayFormat: 'brackets' }), { a: 'c' });
Copy link
Owner

Choose a reason for hiding this comment

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

i see how this seems correct, because it's currently set to brackets but is parsing as repeat.

However, the current behavior matches what PHP, Rails, and express all do, so I'm not sure it should change.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Rails and PHP actually parse it as overwriting

this is the reason I've started all this: in my rails app I've switched from "chaos and anarchy " to qs and got one spec failure where the suite was appending params and with qs that lead to an array

Copy link
Owner

Choose a reason for hiding this comment

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

hmm, thanks for correcting me then. i'll think on this one.

@AlanKnightly

This comment was marked as spam.

@ljharb

This comment was marked as resolved.

@ljharb
Copy link
Owner

ljharb commented Sep 14, 2023

@dreyks ok, so, here's how i think this needs to work:

  • arrayFormat must take all the options stringify does - brackets, indices, repeat, comma - and produce an object that, when re-stringified with the same format, produces the original parse input (ie, roundtripping)
  • The current behavior must be described by one of the arrayFormat options. if none of the 4 formats above match, we may need to make a 5th one.

One important goal is that the default behavior of Rails, PHP, and express should all be expressible with an option - ideally the same one, and I suspect that's "brackets".

It'd be great to get this revived :-)

@dreyks
Copy link
Contributor Author

dreyks commented Sep 15, 2023

oof, lemme recollect what's going on here, it's been 4 years and not the easiest ones :D

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants