add Client to work context, helpers to extract it #145
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
brandur
approved these changes
Jan 13, 2024
context_test.go
Outdated
| require.NoError(t, err) | ||
| require.Equal(t, client, result) | ||
|
|
||
| require.Panics(t, func() { |
There was a problem hiding this comment.
What do you think about switching to the use of require.PanicsWithError here? Just makes sure we for sure got the right panic and didn't trigger some other unexpected one by accident.
There was a problem hiding this comment.
Another handy require helper I didn't yet know about, thanks! Changed this test to assert about the specific error throughout, and also added a changelog entry.
This change adds the `*Client` to an unexported context key within the work context when the Client is started, making it available to the context for every job that's worked by that Client. Additionally, two new helper functions are added to retrieve the Client from the context within a Worker: `ClientFromContext` and `ClientFromContextSafely`. The only difference between these is that the first variant panics if the client isn't found in the context, whereas the latter returns an error. However if these are used on the context provided to a Worker's `Work()` method (or one derived from it) they should never panic/error.
7b4ff25 to
abf4732
Compare
|
I'm working on a docs PR but no reason not to merge this in the mean time. |
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.
This change adds the
*Clientto an unexported context key within the work context when the Client is started, making it available to the context for every job that's worked by that Client.Additionally, two new helper functions are added to retrieve the Client from the context within a Worker:
ClientFromContextandClientFromContextSafely. The only difference between these is that the first variant panics if the client isn't found in the context, whereas the latter returns an error. However if these are used on the context provided to a Worker'sWork()method (or one derived from it) they should never panic/error.Inspired by #87 and #144.
If we want to move forward with this, it still needs: