http: support additional content type by oncilla · Pull Request #903 · uber-go/zap

oncilla · 2021-01-08T18:47:02Z

Support application/x-www-form-urlencoded as an additional content
type for AtomicLevel.ServeHTTP.

This is the default content type for curl -X POST.

With this change, interacting with the HTTP endpoint is a bit more
user friendly:

curl -X PUT localhost:8080/log/level -d level=debug

Additionally, the unit tests for the HTTP handler are transformed to
a table driven approach.

fixes #902

This change is

Support `application/x-www-form-urlencoded` as an additional content type for `AtomicLevel.ServeHTTP`. This is the default content type for `curl -X POST`. With this change, interacting with the HTTP endpoint is a bit more user friendly: ``` curl -X PUT localhost:8080/log/level -d level=debug ``` Additionally, the unit tests for the HTTP handler are transformed to a table driven approach. fixes uber-go#902

CLAassistant · 2021-01-08T18:47:08Z

All committers have signed the CLA.

codecov · 2021-01-08T18:54:46Z

Codecov Report

Merging #903 (86ae38e) into master (f8ef926) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##           master     #903   +/-   ##
=======================================
  Coverage   98.22%   98.23%           
=======================================
  Files          44       44           
  Lines        1915     1925   +10     
=======================================
+ Hits         1881     1891   +10     
  Misses         27       27           
  Partials        7        7

Impacted Files	Coverage Δ
http_handler.go	`100.00% <100.00%> (ø)`

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f8ef926...86ae38e. Read the comment docs.

abhinav

Thanks for the change! The core logic looks mostly good. I have some suggestions around style.

abhinav · 2021-01-08T20:52:39Z

+// request could look like this:
+//
+//    curl -X PUT localhost:8080/log/level -d level=debug
+//
+// For any other content type, the payload is expected to be JSON encoded and
+// look like:
+//
+//   {"level":"info"}
+//
+// An example curl request could look like this:
+//
+//    curl -X PUT localhost:8080/log/level -H "Content-Type: application/json" -d '{"level":"debug"}'


This is great documentation, thank you!

abhinav · 2021-01-08T20:57:07Z

-			}
-			if req.Level == nil {
-				return "Must specify a logging level."
+		requestedLvl, err := func(body io.Reader) (*zapcore.Level, error) {


This appears to be an effort to reduce error handling duplication. That's a good call but can we perhaps move this to its own unexported method?

requestedLevel, err := lvl.decodePutRequest(r)

Additionally, since zapcore.Level is just an int8, we don't need to return its address:

func (lvl AtomicLevel) decodePutRequest(*http.Request) (zapcore.Level, error)

It's a pointer in payload to detect the absence of the level in the JSON payload. So we can validate it's non-nil on the JSON path and dereference it.

Good point. I tried to follow the previous style, but your suggestion is more maintainable and readable IMO.

abhinav · 2021-01-08T21:01:05Z

+				if err := l.UnmarshalText([]byte(lvl)); err != nil {
+					return nil, err
+				}
+				return &l, nil


Optionally, this can be shortened.

Suggested change

if err := l.UnmarshalText([]byte(lvl)); err != nil {

return nil, err

}

return &l, nil

err := l.UnmarshalText([]byte(lvl))

return &l, err

I prefer being explicit here. Especially after switching to value type.

It is not immediately obvious whether the returned value is pre- or post-UnmarshalText without knowing that part of the spec by hart. (TBH I would need to look that up)

abhinav · 2021-01-08T21:06:28Z

+	tests := map[string]struct {
+		Method        string
+		ContentType   string
+		Body          string
+		ExpectedCode  int
+		ExpectedLevel zapcore.Level
+	}{


Thanks for making this a table test. If you wouldn't mind, we have a preference for slice-based table tests rather than maps:

tests := []struct { desc string method string contentType string ... }{ ... } for _, tt := range tests { ..

(See also https://github.com/uber-go/guide/blob/master/style.md#test-tables)

abhinav · 2021-01-08T21:09:07Z

+			ts := httptest.NewServer(lvl)
+			defer ts.Close()
+
+			req, err := http.NewRequest(test.Method, ts.URL, strings.NewReader(test.Body))


can we name the test server srv or server?

Suggested change

ts := httptest.NewServer(lvl)

defer ts.Close()

req, err := http.NewRequest(test.Method, ts.URL, strings.NewReader(test.Body))

server := httptest.NewServer(lvl)

defer server.Close()

req, err := http.NewRequest(test.Method, server.URL, strings.NewReader(test.Body))

abhinav · 2021-01-08T21:10:31Z

+		},
+	}
+
+	for name, test := range tests {


For table tests, consider renaming the test cases to tt.

for _, tt := range tests {

abhinav · 2021-01-08T21:13:00Z

+			enc.Encode(errorResponse{Error: err.Error()})
 			return
 		}
-
-		lvl.SetLevel(*req.Level)
-		enc.Encode(req)
-
+		lvl.SetLevel(*requestedLvl)
+		enc.Encode(payload{Level: requestedLvl})


Do we want a JSON output even for non-JSON input?

Maybe this is okay and we can add a plain text output later if we need it and the client has an Accepts: text/plain?

CC @prashantv

If we want to return non-JSON in the response, I would definitively go for content type negotiation through the Accepts header.

In any case, I would vote for this to be part of a follow-up PR if it is desired.

oncilla · 2021-01-10T20:12:07Z

Thanks for the swift feedback. I hope I get around to address the comments this week.

These methods do not have need of the atomic level. Turn them into functions to avoid accidentally manipulating or accessing it.

abhinav · 2021-01-15T17:44:23Z

+	if contentType == "application/x-www-form-urlencoded" {
+		return lvl.decodePutURL(body)
+	}
+	return lvl.decodePutJSON(body)


Minor: It looks like these methods could be top-level functions since they don't do anything with the AtomicLevel. I'm gonna change that.

abhinav · 2021-01-15T17:54:15Z

Sorry for the delay in reviewing. This looks great!
I'm going to get a second review on this before merging.
Thanks for the change!

prashantv

Change looks good, although one change we can make to simplify, but also provide an easier way to set the level: use ParseForm() and FormValue(..) to get the level field if it exists. It would simplify the code, while also allowing URL parameters to be used. Thoughts?

oncilla · 2021-01-25T16:52:40Z

@prashantv nice. Did not know that exists.

Should I also add tests for the URL params encoding?

prashantv · 2021-01-26T00:44:54Z

Should I also add tests for the URL params encoding?

Yes, that would be great if you could add a test for passing the parameter in a URL (and mention it in the docs). Thanks!

oncilla · 2021-01-26T08:25:34Z

Done.

prashantv

Thanks for the contribution!

Support `application/x-www-form-urlencoded` as an additional content type for `AtomicLevel.ServeHTTP`. This is the default content type for `curl -X POST`. With this change, interacting with the HTTP endpoint is a bit more user friendly: ``` curl -X PUT localhost:8080/log/level -d level=debug ``` Additionally, the unit tests for the HTTP handler are transformed to a table driven approach. fixes #902 Co-authored-by: Abhinav Gupta <abg@uber.com>

Support `application/x-www-form-urlencoded` as an additional content type for `AtomicLevel.ServeHTTP`. This is the default content type for `curl -X POST`. With this change, interacting with the HTTP endpoint is a bit more user friendly: ``` curl -X PUT localhost:8080/log/level -d level=debug ``` Additionally, the unit tests for the HTTP handler are transformed to a table driven approach. fixes uber-go#902 Co-authored-by: Abhinav Gupta <abg@uber.com>

oncilla mentioned this pull request Jan 8, 2021

http: more human friendly request body #902

Closed

cover more error branches

794c2df

abhinav reviewed Jan 8, 2021

View reviewed changes

oncilla and others added 2 commits January 11, 2021 18:09

feedback

e1be881

decode*: Turn into functions

6fe8012

These methods do not have need of the atomic level. Turn them into functions to avoid accidentally manipulating or accessing it.

abhinav approved these changes Jan 15, 2021

View reviewed changes

abhinav added the ready for second review label Jan 15, 2021

abhinav requested a review from prashantv January 15, 2021 17:52

prashantv reviewed Jan 25, 2021

View reviewed changes

use Request.FormValue

870ced4

document and test query parameters

86ae38e

prashantv approved these changes Feb 2, 2021

View reviewed changes

prashantv merged commit b274f65 into uber-go:master Feb 2, 2021

github-actions Bot mentioned this pull request Apr 10, 2022

Link Checker Report scylladb/scylla-manager#3102

Closed

github-actions Bot mentioned this pull request Apr 17, 2022

Link Checker Report scylladb/scylla-manager#3121

Closed

Conversation

oncilla commented Jan 8, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

CLAassistant commented Jan 8, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov Bot commented Jan 8, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

abhinav left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

oncilla commented Jan 10, 2021

Uh oh!

Choose a reason for hiding this comment

Uh oh!

abhinav commented Jan 15, 2021

Uh oh!

prashantv left a comment

Choose a reason for hiding this comment

Uh oh!

oncilla commented Jan 25, 2021

Uh oh!

prashantv commented Jan 26, 2021

Uh oh!

oncilla commented Jan 26, 2021

Uh oh!

prashantv left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

4 participants

oncilla commented Jan 8, 2021 •

edited

Loading

CLAassistant commented Jan 8, 2021 •

edited

Loading

codecov Bot commented Jan 8, 2021 •

edited

Loading