fix: JWKS leaking goroutine issue #156
Merged
Conversation
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
rishabhpoddar
suggested changes
Jul 18, 2022
recipe/thirdparty/providers/apple.go
Outdated
Comment on lines
181
to
186
| // Create the keyfunc options. Refresh the JWKS every hour and log errors. | ||
| refreshInterval := time.Hour | ||
| options := keyfunc.Options{ | ||
| RefreshInterval: refreshInterval, | ||
| // https://github.com/supertokens/supertokens-golang/issues/155 | ||
| // This causes a leak as the pointer to JWKS would be held in the goroutine and | ||
| // also results in compounding refresh requests | ||
| // RefreshInterval: time.Hour, | ||
| } |
Contributor
There was a problem hiding this comment.
Please see how other people do this and if this needs to be done in a "global" scope instead of doing it here.
Collaborator
Author
There was a problem hiding this comment.
Updated to use a cache, as that's more efficient compared to this. Have used the standard golang's approach for global stuff.
rishabhpoddar
approved these changes
Jul 18, 2022
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.
Summary of change
Passing refresh interval to the Keyfunc was causing background goroutine to keep the pointer and also ended up compounding refresh requests over time. Caching JWKS using url -> JWKS map and reusing the instance with each call.
Related issues
Test Plan
Have manually tested that the Apple login works and also ensured the shared instance is getting used for subsequent calls.
Documentation changes
(If relevant, please create a PR in our docs repo, or create a checklist here highlighting the necessary changes)
Checklist for important updates
coreDriverInterfaceSupported.jsonfile has been updated (if needed)Along with the associated array insupertokens/constants.gofrontendDriverInterfaceSupported.jsonfile has been updated (if needed)supertokens/constants.go > version variablegit tag) in the formatvX.Y.Z, and then find the latest branch (git branch --all) whoseX.Yis greater than the latest released tag.Remaining TODOs for this PR