-
-
Notifications
You must be signed in to change notification settings - Fork 2.5k
Fix confusing names #579
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
Merged
Merged
Fix confusing names #579
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -17,9 +17,9 @@ const ( | |
| bearerFormat string = "Bearer %s" | ||
| ) | ||
|
|
||
| // ToHTTPContext moves JWT token from request header to context. Particularly | ||
| // HTTPToContext moves a JWT from request header to context. Particularly | ||
| // useful for servers. | ||
| func ToHTTPContext() http.RequestFunc { | ||
| func HTTPToContext() http.RequestFunc { | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. "Context" seems to be in all of these names, so is it redundant? Would To/FromHTTP and To/FromGRPC be equally clear? I haven't taken a close look at the whole file, and I've never used the package, so I'm genuinely asking. :) If not, the names look good! |
||
| return func(ctx context.Context, r *stdhttp.Request) context.Context { | ||
| token, ok := extractTokenFromAuthHeader(r.Header.Get("Authorization")) | ||
| if !ok { | ||
|
|
@@ -30,9 +30,9 @@ func ToHTTPContext() http.RequestFunc { | |
| } | ||
| } | ||
|
|
||
| // FromHTTPContext moves JWT token from context to request header. Particularly | ||
| // ContextToHTTP moves a JWT from context to request header. Particularly | ||
| // useful for clients. | ||
| func FromHTTPContext() http.RequestFunc { | ||
| func ContextToHTTP() http.RequestFunc { | ||
| return func(ctx context.Context, r *stdhttp.Request) context.Context { | ||
| token, ok := ctx.Value(JWTTokenContextKey).(string) | ||
| if ok { | ||
|
|
@@ -42,9 +42,9 @@ func FromHTTPContext() http.RequestFunc { | |
| } | ||
| } | ||
|
|
||
| // ToGRPCContext moves JWT token from grpc metadata to context. Particularly | ||
| // GRPCToContext moves a JWT from grpc metadata to context. Particularly | ||
| // userful for servers. | ||
| func ToGRPCContext() grpc.ServerRequestFunc { | ||
| func GRPCToContext() grpc.ServerRequestFunc { | ||
| return func(ctx context.Context, md metadata.MD) context.Context { | ||
| // capital "Key" is illegal in HTTP/2. | ||
| authHeader, ok := md["authorization"] | ||
|
|
@@ -61,9 +61,9 @@ func ToGRPCContext() grpc.ServerRequestFunc { | |
| } | ||
| } | ||
|
|
||
| // FromGRPCContext moves JWT token from context to grpc metadata. Particularly | ||
| // ContextToGRPC moves a JWT from context to grpc metadata. Particularly | ||
| // useful for clients. | ||
| func FromGRPCContext() grpc.ClientRequestFunc { | ||
| func ContextToGRPC() grpc.ClientRequestFunc { | ||
| return func(ctx context.Context, md *metadata.MD) context.Context { | ||
| token, ok := ctx.Value(JWTTokenContextKey).(string) | ||
| if ok { | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The "a" article use is now inconsistent (present with "JWT", absent with "request header" and "context"), not sure if that's intentional, not a big deal.