feat!: Introduce interface for Collection to make it easier to test #31
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
jakoblorz
added a commit
to jakoblorz/colt
that referenced
this pull request
Nov 27, 2024
Following jensteichert#31, `Collection` is an interface now, which means a pointer to it does not make sense anymore.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Currently it is difficult to unit test code that uses colt's
Collection. It is not possible to mock aCollectionas it is just a struct and it is not possible to override the underlying Mongo collection as the collection attribute is not exported.Introducing an interface would make it a breeze to mock a
Collectionand therefore benefit the testability of consumers. However, currently consumers use pointers to aCollection, which is no longer possible with this change, therefore making it a breaking change.