add context to public functions #4
Open
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
Almost all public functions of this library make one or more HTTP requests behind the scenes. Since this is an operation that can potentially block indefinitely, it is good practice to pass a context into these functions. That way, the operation can be cancelled "from above" if necessary. Add ...Context() variants of all public functions that end up making HTTP requests. Maintain external API compatibility by keeping the old functions as wrappers, calling the new ...Context() functions with context.Background(). An exception to this is the Client interface in nexus.go and its implementation. There, the context parameter is added directly. This is technically a breaking change, but I suspect not many people will be using this low-level interface anyway.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Almost all public functions of this library make one or more HTTP requests behind the scenes.
Since this is an operation that can potentially block indefinitely, it is good practice to pass a context into these functions. That way, the operation can be cancelled "from above" if necessary.
Add ...Context() variants of all public functions that end up making HTTP requests. Maintain external API compatibility by keeping the old functions as wrappers, calling the new ...Context() functions with context.Background().
An exception to this is the Client interface in nexus.go and its implementation. There, the context parameter is added directly. This is technically a breaking change, but I suspect not many people will be using this low-level interface anyway.