Added support for type parameters in the ParseXXX functions
#271
Conversation
This file contains 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
Following the discussion in #269, this PR serves as a playground for a jwt version with generics aka type parameters. This basically breaks all the tests for now since they are non-typed but the examples in `example_test.go` work.
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| @@ -42,29 +42,29 @@ func ParseFromRequest(req *http.Request, extractor Extractor, keyFunc jwt.Keyfun | |||
| // ParseFromRequestWithClaims is an alias for ParseFromRequest but with custom Claims type. | |||
| // | |||
| // Deprecated: use ParseFromRequest and the WithClaims option | |||
| func ParseFromRequestWithClaims(req *http.Request, extractor Extractor, claims jwt.Claims, keyFunc jwt.Keyfunc) (token *jwt.Token, err error) { | |||
| func ParseFromRequestWithClaims[T jwt.Claims](req *http.Request, extractor Extractor, claims T, keyFunc jwt.Keyfunc[T]) (token *jwt.Token[T], err error) { | |||
| return ParseFromRequest(req, extractor, keyFunc, WithClaims(claims)) | |||
| @@ -42,29 +42,29 @@ func ParseFromRequest(req *http.Request, extractor Extractor, keyFunc jwt.Keyfun | |||
| // ParseFromRequestWithClaims is an alias for ParseFromRequest but with custom Claims type. | |||
| // | |||
| // Deprecated: use ParseFromRequest and the WithClaims option | |||
| func ParseFromRequestWithClaims(req *http.Request, extractor Extractor, claims jwt.Claims, keyFunc jwt.Keyfunc) (token *jwt.Token, err error) { | |||
| func ParseFromRequestWithClaims[T jwt.Claims](req *http.Request, extractor Extractor, claims T, keyFunc jwt.Keyfunc[T]) (token *jwt.Token[T], err error) { | |||
| return ParseFromRequest(req, extractor, keyFunc, WithClaims(claims)) | |||
| @@ -42,29 +42,29 @@ func ParseFromRequest(req *http.Request, extractor Extractor, keyFunc jwt.Keyfun | |||
| // ParseFromRequestWithClaims is an alias for ParseFromRequest but with custom Claims type. | |||
| // | |||
| // Deprecated: use ParseFromRequest and the WithClaims option | |||
| func ParseFromRequestWithClaims(req *http.Request, extractor Extractor, claims jwt.Claims, keyFunc jwt.Keyfunc) (token *jwt.Token, err error) { | |||
| func ParseFromRequestWithClaims[T jwt.Claims](req *http.Request, extractor Extractor, claims T, keyFunc jwt.Keyfunc[T]) (token *jwt.Token[T], err error) { | |||
| return ParseFromRequest(req, extractor, keyFunc, WithClaims(claims)) | |||
map_claims_test.go
Outdated
| @@ -56,13 +56,13 @@ func TestVerifyAud(t *testing.T) { | |||
|
|
|||
| for _, test := range tests { | |||
| t.Run(test.Name, func(t *testing.T) { | |||
| var opts []ParserOption | |||
| var opts []ParserOption[MapClaims] | |||
map_claims_test.go
Outdated
|
|
||
| if test.Required { | ||
| opts = append(opts, WithAudience(test.Comparison)) | ||
| opts = append(opts, WithAudience[MapClaims](test.Comparison)) |
map_claims_test.go
Outdated
| @@ -77,7 +77,7 @@ func TestMapclaimsVerifyIssuedAtInvalidTypeString(t *testing.T) { | |||
| "iat": "foo", | |||
| } | |||
| want := false | |||
| got := newValidator(WithIssuedAt()).Validate(mapClaims) | |||
| got := newValidator[MapClaims](WithIssuedAt[MapClaims]()).Validate(mapClaims) | |||
map_claims_test.go
Outdated
| @@ -112,25 +112,78 @@ func TestMapClaimsVerifyExpiresAtExpire(t *testing.T) { | |||
| "exp": float64(exp.Unix()), | |||
| } | |||
| want := false | |||
| got := newValidator(WithTimeFunc(func() time.Time { | |||
| got := newValidator[MapClaims](WithTimeFunc[MapClaims](func() time.Time { | |||
map_claims_test.go
Outdated
| return exp | ||
| })).Validate(mapClaims) | ||
| if want != (got == nil) { | ||
| t.Fatalf("Failed to verify claims, wanted: %v got %v", want, (got == nil)) | ||
| } | ||
|
|
||
| got = newValidator(WithTimeFunc(func() time.Time { | ||
| got = newValidator[MapClaims](WithTimeFunc[MapClaims](func() time.Time { |
map_claims_test.go
Outdated
| return exp.Add(1 * time.Second) | ||
| })).Validate(mapClaims) | ||
| if want != (got == nil) { | ||
| t.Fatalf("Failed to verify claims, wanted: %v got %v", want, (got == nil)) | ||
| } | ||
|
|
||
| want = true | ||
| got = newValidator(WithTimeFunc(func() time.Time { | ||
| got = newValidator[MapClaims](WithTimeFunc[MapClaims](func() time.Time { |
oxisto
changed the title
ParseXXX functions
|
Will continue discussion in #272 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Following the discussion in #269, this PR adds support for type parameters (or generics) in the
ParseXXXfunctions, basically allowing one to directly access a specific claims type without any uncomfortable type assertions in either thekeyfuncor the resultingTokenstruct.