Receive and pass context.Context by value in IndexConnection methods
#20
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
…a pointer in IndexConnection and its methods, update README
austin-denoble
commented
May 1, 2024
| @@ -1,5 +1,5 @@ | |||
| > **Warning** | |||
| > | |||
There was a problem hiding this comment.
Prettier did a bunch of auto-formatting on some of this locally, sorry about that. 😬
austin-denoble
commented
May 1, 2024
| @@ -4,12 +4,13 @@ import ( | |||
| "context" | |||
| "crypto/tls" | |||
| "fmt" | |||
| "log" | |||
There was a problem hiding this comment.
My gofmt settings seem to rearrange imports. Should look into turning that off maybe...
austin-denoble
commented
May 1, 2024
| @@ -46,7 +47,7 @@ func (idx *IndexConnection) Close() error { | |||
| return err | |||
| } | |||
|
|
|||
| func (idx *IndexConnection) UpsertVectors(ctx *context.Context, in []*Vector) (uint32, error) { | |||
| func (idx *IndexConnection) UpsertVectors(ctx context.Context, in []*Vector) (uint32, error) { | |||
There was a problem hiding this comment.
I think this is fine, especially given akCtx returns by value, and you pass context.Context in Client methods. At least that's my understanding.
austin-denoble
changed the title
context.Context by value in IndexConnectioncontext.Context by value in IndexConnection methods
2 tasks
haruska
approved these changes
May 1, 2024
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.
Problem
From this issue: #19
We're receiving and passing
*context.ContextinIndexConnectionmethods. This differs from ourClientmethods and is non-standard for how most libraries handleContext.Solution
context.Contextby value rather than a pointer inIndexConnectionmethods, update README example to account.Type of Change
Test Plan
CI Testing, make sure you can
just testlocally orgo build