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.

Sign up for GitHub

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

Jump to bottom

feat: add option to control using proto text name as key during URL encoding #3311

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

feat: add option to control using proto text name as key during URL encoding #3311

wants to merge 2 commits into from

Conversation

demoManito
Copy link
Member

@demoManito demoManito commented Apr 30, 2024 •
edited
Loading

Description (what this PR does / why we need it):

  • binding.EncodeURL and form.EncodeValues and form.EncodeFieldMask add form.EncodeOption, used to control whether to use proto text name as key when encoding. and it will not affect the original logic
  • cmd/protoc-gen-go-http add the -prototext_encodeurl parameter to control whether to use the json tag defined in proto as the key when encoding. The default is false and will not change the original generated code logic. (example: kratos proto client api/test.proto -- --go-http_opt=prototext_encodeurl=true)
func (c *GreeterHTTPClientImpl) SayHello(ctx context.Context, in *HelloRequest, opts ...http.CallOption) (*HelloReply, error) {
	var out HelloReply
	pattern := "/helloworld/{name}"
-	path := binding.EncodeURL(pattern, in, true)
+	path := binding.EncodeURL(pattern, in, true, form.Encode().UseProtoTextAsKey(false))
	opts = append(opts, http.Operation(OperationGreeterSayHello))
	opts = append(opts, http.PathTemplate(pattern))
	err := c.cc.Invoke(ctx, "GET", path, nil, &out, opts...)
	if err != nil {
		return nil, err
	}
	return &out, nil
}

Which issue(s) this PR fixes (resolves / be part of):

resolves: #3141
resolves: #2761
resolves: #3331
resolves: #3560

Other special notes for the reviewers:

@dosubot dosubot bot added the size:L This PR changes 100-499 lines, ignoring generated files. label Apr 30, 2024
@demoManito demoManito changed the title feat(transport/http/binding): controls whether to use proto text name… feat(transport/http/binding): controls whether to use proto text name as the key of the parameter Apr 30, 2024
@codecov-commenter
Copy link

codecov-commenter commented Apr 30, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 82.08%. Comparing base (d0d5761) to head (d2fd00e).
Report is 3 commits behind head on main.

❗ Current head d2fd00e differs from pull request most recent head b1b008c

Please upload reports for the commit b1b008c to get more accurate results.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main    #3311      +/-   ##
==========================================
+ Coverage   81.83%   82.08%   +0.25%     
==========================================
  Files          92       93       +1     
  Lines        4205     4220      +15     
==========================================
+ Hits         3441     3464      +23     
+ Misses        582      578       -4     
+ Partials      182      178       -4

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@demoManito demoManito changed the title feat(transport/http/binding): controls whether to use proto text name as the key of the parameter feat(transport/http/binding): controls whether to use proto text name as the key of the params Apr 30, 2024
@demoManito demoManito changed the title feat(transport/http/binding): controls whether to use proto text name as the key of the params feat(transport/http/binding): add option to control using proto text name as key during URL encoding Apr 30, 2024
@demoManito demoManito force-pushed the feat/encode-json branch 2 times, most recently from 4e5659c to b417873 Compare May 8, 2024 09:49
@demoManito demoManito changed the title feat(transport/http/binding): add option to control using proto text name as key during URL encoding feat: add option to control using proto text name as key during URL encoding May 9, 2024
@ghost ghost mentioned this pull request May 27, 2024
Closed
@demoManito demoManito force-pushed the feat/encode-json branch 2 times, most recently from 1c38aba to b1b008c Compare June 2, 2024 03:56
@demoManito
Copy link
Member Author

Please take a look at this if you have time @shenqidebaozi. For users, there will be deviations in the use of EncodeURL. There are already multiple issues that have feedback on this.

shenqidebaozi
shenqidebaozi reviewed Mar 14, 2025
View reviewed changes
encoding/form/option/encode.go Outdated
Copy link
Member

Choose a reason for hiding this comment

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

Why do we need to separate this package? It looks strange to see it here

Copy link
Member Author

Choose a reason for hiding this comment

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

It's true that a single package doesn't make much sense, it's already moved out @shenqidebaozi

@dosubot dosubot bot added size:XL This PR changes 500-999 lines, ignoring generated files. and removed size:L This PR changes 100-499 lines, ignoring generated files. labels Mar 14, 2025
@demoManito demoManito force-pushed the feat/encode-json branch 2 times, most recently from 1ccdc98 to 4857741 Compare March 20, 2025 08:27
@shenqidebaozi
Copy link
Member

Is it necessary to process in encoding and can it be processed in gen code

@demoManito
Copy link
Member Author

Is it necessary to process in encoding and can it be processed in gen code是否需要在编码中处理，是否可以在 gen code 中处理

What does gen code mean? Since the code specifies using json name as a parameter, it seems that only this method will not affect the previous compatibility @shenqidebaozi

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@shenqidebaozi shenqidebaozi shenqidebaozi left review comments

At least 2 approving reviews are required to merge this pull request.

Assignees
No one assigned
Labels
size:XL This PR changes 500-999 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
3 participants
@demoManito @codecov-commenter @shenqidebaozi