🩹 Allow parsing of square bracket query param #1818

ninadingole · 2022-03-13T20:59:22Z

Explain the details for making this change. What existing problem does the pull request solve?

The PR solves the issue of parsing query params that contains array key in [] format. Following type of keys are parsed and the tests are added:

data[]=john&data[]=doe
data[0][name]=john&data[0][age]=10&data[1][name]=doe&data[1][age]=12 // This will be parsed to a struct
data.0.name=john&data.0.age=10&data.1.name=doe&data.1.age=12

welcome · 2022-03-13T20:59:24Z

Thanks for opening this pull request! 🎉 Please check out our contributing guidelines. If you need help or want to chat with us, join us on Discord https://gofiber.io/discord

ReneWerner87 · 2022-03-13T21:24:11Z

Please add a benchmark
Look more closely tomorrow

efectn

Can you add before/after benchmark results of queryparser?
Also, can you add new benchmark for this feature?

ctx.go

ctx_test.go

ctx.go

ninadingole · 2022-03-16T19:45:24Z

I did the benchmarking:

BEFORE:

go test -v  -run=^\$ -bench=Benchmark_Ctx_QueryParser -benchmem -count=4                                                              25.5m  Wed Mar 16 20:38:39 2022
goos: darwin
goarch: amd64
pkg: github.com/gofiber/fiber/v2
cpu: Intel(R) Core(TM) i9-9880H CPU @ 2.30GHz
Benchmark_Ctx_QueryParser
Benchmark_Ctx_QueryParser-16          	  349766	      3171 ns/op	     856 B/op	      38 allocs/op
Benchmark_Ctx_QueryParser-16          	  364510	      3176 ns/op	     856 B/op	      38 allocs/op
Benchmark_Ctx_QueryParser-16          	  355460	      3161 ns/op	     856 B/op	      38 allocs/op
Benchmark_Ctx_QueryParser-16          	  361420	      3171 ns/op	     856 B/op	      38 allocs/op
Benchmark_Ctx_QueryParser_Comma
Benchmark_Ctx_QueryParser_Comma-16    	  309963	      3514 ns/op	     929 B/op	      44 allocs/op
Benchmark_Ctx_QueryParser_Comma-16    	  309619	      3565 ns/op	     929 B/op	      44 allocs/op
Benchmark_Ctx_QueryParser_Comma-16    	  286914	      3519 ns/op	     929 B/op	      44 allocs/op
Benchmark_Ctx_QueryParser_Comma-16    	  328557	      3532 ns/op	     929 B/op	      44 allocs/op
PASS
ok  	github.com/gofiber/fiber/v2	9.755s

go test -v  -run=^\$ -bench=Benchmark_Ctx_QueryParser_Comma -benchmem -count=4                                                            10.4s  Wed Mar 16 20:38:54 2022
goos: darwin
goarch: amd64
pkg: github.com/gofiber/fiber/v2
cpu: Intel(R) Core(TM) i9-9880H CPU @ 2.30GHz
Benchmark_Ctx_QueryParser_Comma
Benchmark_Ctx_QueryParser_Comma-16    	  307441	      3551 ns/op	     929 B/op	      44 allocs/op
Benchmark_Ctx_QueryParser_Comma-16    	  335578	      3562 ns/op	     929 B/op	      44 allocs/op
Benchmark_Ctx_QueryParser_Comma-16    	  296473	      3554 ns/op	     929 B/op	      44 allocs/op
Benchmark_Ctx_QueryParser_Comma-16    	  327487	      3525 ns/op	     929 B/op	      44 allocs/op
PASS
ok  	github.com/gofiber/fiber/v2	4.887s

AFTER:

go test -v  -run=^\$ -bench=Benchmark_Ctx_QueryParser -benchmem -count=4                                                                   5.5s  Wed Mar 16 20:39:39 2022
goos: darwin
goarch: amd64
pkg: github.com/gofiber/fiber/v2
cpu: Intel(R) Core(TM) i9-9880H CPU @ 2.30GHz
Benchmark_Ctx_QueryParser
Benchmark_Ctx_QueryParser-16          	  335406	      3427 ns/op	     856 B/op	      38 allocs/op
Benchmark_Ctx_QueryParser-16          	  356060	      3241 ns/op	     856 B/op	      38 allocs/op
Benchmark_Ctx_QueryParser-16          	  342423	      3223 ns/op	     856 B/op	      38 allocs/op
Benchmark_Ctx_QueryParser-16          	  351063	      3250 ns/op	     856 B/op	      38 allocs/op
Benchmark_Ctx_QueryParser_Comma
Benchmark_Ctx_QueryParser_Comma-16    	  316597	      3587 ns/op	     929 B/op	      44 allocs/op
Benchmark_Ctx_QueryParser_Comma-16    	  313954	      3590 ns/op	     929 B/op	      44 allocs/op
Benchmark_Ctx_QueryParser_Comma-16    	  308415	      3626 ns/op	     929 B/op	      44 allocs/op
Benchmark_Ctx_QueryParser_Comma-16    	  322690	      3647 ns/op	     929 B/op	      44 allocs/op
PASS
ok  	github.com/gofiber/fiber/v2	9.642s

go test -v  -run=^\$ -bench=Benchmark_Ctx_QueryParser_Comma -benchmem -count=4                                                            10.2s  Wed Mar 16 20:40:05 2022
goos: darwin
goarch: amd64
pkg: github.com/gofiber/fiber/v2
cpu: Intel(R) Core(TM) i9-9880H CPU @ 2.30GHz
Benchmark_Ctx_QueryParser_Comma
Benchmark_Ctx_QueryParser_Comma-16    	  297918	      3614 ns/op	     929 B/op	      44 allocs/op
Benchmark_Ctx_QueryParser_Comma-16    	  321032	      3583 ns/op	     929 B/op	      44 allocs/op
Benchmark_Ctx_QueryParser_Comma-16    	  323709	      3608 ns/op	     929 B/op	      44 allocs/op
Benchmark_Ctx_QueryParser_Comma-16    	  312877	      3606 ns/op	     929 B/op	      44 allocs/op
PASS
ok  	github.com/gofiber/fiber/v2	4.915s

Benchmarking for the method parseQuery:

go test -v  -run=^\$ -bench=Benchmark_Ctx_parseQuery -benchmem -count=4                                                                     5.5s  Wed Mar 16 20:44:41 2022
goos: darwin
goarch: amd64
pkg: github.com/gofiber/fiber/v2
cpu: Intel(R) Core(TM) i9-9880H CPU @ 2.30GHz
Benchmark_Ctx_parseQuery
Benchmark_Ctx_parseQuery-16    	  401638	      2637 ns/op	     753 B/op	      29 allocs/op
Benchmark_Ctx_parseQuery-16    	  451958	      2637 ns/op	     753 B/op	      29 allocs/op
Benchmark_Ctx_parseQuery-16    	  454078	      2664 ns/op	     753 B/op	      29 allocs/op
Benchmark_Ctx_parseQuery-16    	  432850	      2669 ns/op	     753 B/op	      29 allocs/op
PASS
ok  	github.com/gofiber/fiber/v2	5.246s

ninadingole · 2022-03-16T19:48:50Z

I also tried with Replacer

rep := strings.NewReplacer("[]", ".", "[", ".", "]", "")

Benchmarking:

go test -v  -run=^\$ -bench=Benchmark_Ctx_QueryParser -benchmem -count=4                                                                    6.4s  Wed Mar 16 20:44:53 2022
goos: darwin
goarch: amd64
pkg: github.com/gofiber/fiber/v2
cpu: Intel(R) Core(TM) i9-9880H CPU @ 2.30GHz
Benchmark_Ctx_QueryParser
Benchmark_Ctx_QueryParser-16          	  335710	      3016 ns/op	     856 B/op	      38 allocs/op
Benchmark_Ctx_QueryParser-16          	  386149	      3042 ns/op	     856 B/op	      38 allocs/op
Benchmark_Ctx_QueryParser-16          	  363243	      3301 ns/op	     856 B/op	      38 allocs/op
Benchmark_Ctx_QueryParser-16          	  377787	      3140 ns/op	     856 B/op	      38 allocs/op
Benchmark_Ctx_QueryParser_Comma
Benchmark_Ctx_QueryParser_Comma-16    	  329350	      3717 ns/op	     929 B/op	      44 allocs/op
Benchmark_Ctx_QueryParser_Comma-16    	  337248	      3575 ns/op	     929 B/op	      44 allocs/op
Benchmark_Ctx_QueryParser_Comma-16    	  337785	      3409 ns/op	     929 B/op	      44 allocs/op
Benchmark_Ctx_QueryParser_Comma-16    	  335216	      3315 ns/op	     929 B/op	      44 allocs/op
PASS
ok  	github.com/gofiber/fiber/v2	11.173s

go test -v  -run=^\$ -bench=Benchmark_Ctx_QueryParser_Comma -benchmem -count=4                                                            12.5s  Wed Mar 16 20:46:40 2022
goos: darwin
goarch: amd64
pkg: github.com/gofiber/fiber/v2
cpu: Intel(R) Core(TM) i9-9880H CPU @ 2.30GHz
Benchmark_Ctx_QueryParser_Comma
Benchmark_Ctx_QueryParser_Comma-16    	  316009	      3499 ns/op	     929 B/op	      44 allocs/op
Benchmark_Ctx_QueryParser_Comma-16    	  356570	      3519 ns/op	     929 B/op	      44 allocs/op
Benchmark_Ctx_QueryParser_Comma-16    	  292567	      3841 ns/op	     929 B/op	      44 allocs/op
Benchmark_Ctx_QueryParser_Comma-16    	  301339	      3866 ns/op	     929 B/op	      44 allocs/op
PASS
ok  	github.com/gofiber/fiber/v2	6.371s

Benchmark the only method:

 go test -v  -run=^\$ -bench=Benchmark_Ctx_parseQuery -benchmem -count=4                                                                    7.7s  Wed Mar 16 20:47:56 2022
goos: darwin
goarch: amd64
pkg: github.com/gofiber/fiber/v2
cpu: Intel(R) Core(TM) i9-9880H CPU @ 2.30GHz
Benchmark_Ctx_parseQuery
Benchmark_Ctx_parseQuery-16    	  211260	      5311 ns/op	    2371 B/op	      47 allocs/op
Benchmark_Ctx_parseQuery-16    	  232926	      5309 ns/op	    2371 B/op	      47 allocs/op
Benchmark_Ctx_parseQuery-16    	  212172	      5251 ns/op	    2371 B/op	      47 allocs/op
Benchmark_Ctx_parseQuery-16    	  210127	      5377 ns/op	    2371 B/op	      47 allocs/op
PASS
ok  	github.com/gofiber/fiber/v2	5.162s

efectn

Check linter and gosec error.

ReneWerner87 · 2022-03-16T20:36:22Z

thx

pls check the comment from efectn

Check linter and gosec error.

ninadingole · 2022-03-16T21:30:22Z

thx

pls check the comment from efectn

Check linter and gosec error.

I handled the error handling, don't know if it is valid to panic, please let me know if the changes are good to merge the PR. Thank you!

ctx.go

efectn · 2022-03-16T21:33:50Z

thx
pls check the comment from efectn

Check linter and gosec error.

I handled the error handling, don't know if it is valid to panic, please let me know if the changes are good to merge the PR. Thank you!

Check my last comment

efectn · 2022-03-18T10:23:55Z

I think we can add add example for this usage to docs. It would be helpful also. What about @ninadingole

ninadingole · 2022-03-18T18:28:11Z

I think we can add add example for this usage to docs. It would be helpful also. What about @ninadingole

will update the doc

welcome · 2022-03-22T08:13:58Z

Congrats on merging your first pull request! 🎉 We here at Fiber are proud of you! If you need help or want to chat with us, join us on Discord https://gofiber.io/discord

ninadingole force-pushed the patch/parse-array-query-param branch from ced5220 to effe03e Compare March 13, 2022 21:01

efectn added the ✏️ Feature label Mar 13, 2022

efectn requested changes Mar 13, 2022

View reviewed changes

efectn reviewed Mar 13, 2022

View reviewed changes

ctx.go Outdated Show resolved Hide resolved

ReneWerner87 requested changes Mar 13, 2022

View reviewed changes

ctx_test.go Outdated Show resolved Hide resolved

ctx.go Outdated Show resolved Hide resolved

ninadingole force-pushed the patch/parse-array-query-param branch from effe03e to 5a7744d Compare March 16, 2022 19:41

efectn requested changes Mar 16, 2022

View reviewed changes

ninadingole force-pushed the patch/parse-array-query-param branch from 5a7744d to 422315a Compare March 16, 2022 21:27

efectn reviewed Mar 16, 2022

View reviewed changes

ctx.go Outdated Show resolved Hide resolved

🩹 Allow parsing of square bracket query param

ac6ed60

ninadingole force-pushed the patch/parse-array-query-param branch from 422315a to ac6ed60 Compare March 17, 2022 19:40

efectn approved these changes Mar 17, 2022

View reviewed changes

ninadingole requested a review from ReneWerner87 March 17, 2022 19:58

ReneWerner87 approved these changes Mar 18, 2022

View reviewed changes

ReneWerner87 merged commit 44bfdc3 into gofiber:master Mar 22, 2022

trim21 pushed a commit to trim21/fiber that referenced this pull request Aug 15, 2022

🩹 Allow parsing of square bracket query param (gofiber#1818)

fa6bac8

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

🩹 Allow parsing of square bracket query param #1818

🩹 Allow parsing of square bracket query param #1818

ninadingole commented Mar 13, 2022

welcome bot commented Mar 13, 2022

ReneWerner87 commented Mar 13, 2022

efectn left a comment

ninadingole commented Mar 16, 2022

ninadingole commented Mar 16, 2022

efectn left a comment

ReneWerner87 commented Mar 16, 2022

ninadingole commented Mar 16, 2022

efectn commented Mar 16, 2022

efectn commented Mar 18, 2022 •

edited

ninadingole commented Mar 18, 2022

welcome bot commented Mar 22, 2022

🩹 Allow parsing of square bracket query param #1818

🩹 Allow parsing of square bracket query param #1818

Conversation

ninadingole commented Mar 13, 2022

welcome bot commented Mar 13, 2022

ReneWerner87 commented Mar 13, 2022

efectn left a comment

Choose a reason for hiding this comment

ninadingole commented Mar 16, 2022

ninadingole commented Mar 16, 2022

efectn left a comment

Choose a reason for hiding this comment

ReneWerner87 commented Mar 16, 2022

ninadingole commented Mar 16, 2022

efectn commented Mar 16, 2022

efectn commented Mar 18, 2022 • edited

ninadingole commented Mar 18, 2022

welcome bot commented Mar 22, 2022

efectn commented Mar 18, 2022 •

edited