-
Notifications
You must be signed in to change notification settings - Fork 65
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: add context to interfaces #181
Conversation
Thank you for submitting this PR!
Getting other community members to do a review would be great help too on complex PRs (you can ask in the chats/forums). If you are unsure about something, just leave us a comment.
We currently aim to provide initial feedback/triaging within two business days. Please keep an eye on any labelling actions, as these will indicate priorities and status of your contribution. |
cd5182b
to
562019f
Compare
This adds contexts to all the Datastore interfaces. The motivation for this change is for instrumentation, not cancellation, although these can certainly be used in the future for adding cancellation. We default to adding context to everything, even if we don't immediately use it, because we might need them in the future and making this change again is quite painful due to the large number of repos this fans out to. Note that we have not added context to Close() methods, due to it being surprising given that it breaks the io.Closer interface, and many Close() methods are quick and don't do much work. This also disables the fuzz test, because it has a submodule which transitively depends on this module, so it will fail to build until this change is plumbed through go-ds-flatfs.
562019f
to
5b1a067
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks. LGTM
Just updated go-datastore in a project I'm working on, and was so surprised that everything blew up between supposedly minor version change. I do support adding a context, but maybe a better way could have been by adding separate methods for each instead of breaking everything. |
@aschmahmann Why was this not a v2 release? |
This adds contexts to all the Datastore interfaces. The motivation for
this change is for instrumentation, not cancellation, although these
can certainly be used in the future for adding cancellation. We
default to adding context to everything, even if we don't immediately
use it, because we might need them in the future and making this
change again is quite painful due to the large number of repos this
fans out to.
Note that we have not added context to Close() methods, due to it
being surprising given that it breaks the io.Closer interface, and
many Close() methods are quick and don't do much work.
This also disables the fuzz test, because it has a submodule which
transitively depends on this module, so it will fail to build until
this change is plumbed through go-ds-flatfs.