ipfs / go-datastore

key-value datastore interfaces
MIT License
228 stars 64 forks source link

feat: add context to interfaces #181

Closed guseggert closed 2 years ago

guseggert commented 2 years ago

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.

welcome[bot] commented 2 years ago

Thank you for submitting this PR! A maintainer will be here shortly to review it. We are super grateful, but we are also overloaded! Help us by making sure that:

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. Next steps:

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. We are very grateful for your contribution!

burdiyan commented 2 years ago

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.

lanzafame commented 2 years ago

@aschmahmann Why was this not a v2 release?