experiemntal: add StoreController to allowing extending interface#752
Closed
experiemntal: add StoreController to allowing extending interface#752
Conversation
mfridman
commented
Apr 21, 2024
| // | ||
| // If the Store does not implement a method, it will either return a [ErrNotSupported] error or fall | ||
| // back to the default behavior. | ||
| func NewStoreController(store Store) *StoreController { |
Collaborator
Author
There was a problem hiding this comment.
The downside with this pattern is external implementations don't have a type assertion to lean on, and so it's really easy to believe a method is implemented, but in reality the method signature doesn't match. You lose that nice compile-time check.
Another pattern could be to have a second interface like StoreExtender that's a superset of Store.
type StoreExtender interface {
Store
// TableExists is an optional method that checks if the version table exists in the database. It is
// recommended to implement this method if the database supports it, as it can be used to optimize
// certain operations.
TableExists(ctx context.Context, db DBTxConn) (bool, error)
}There's pros/cons to both approaches, need to sleep on this a bit and chat with folks to get feedback.
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
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.
This PR adds a
*database.StoreControllertype to allow us to extend goose behavior without breaking the coreStoreinterface.We can document any optional methods by having a well-defined type like the
*database.StoreController. It becomes much easier to reason about in the code than the type assertions and hidden interfaces. A good example of this in the wild is the ResponseController added to the net/http package in Go.For a practical example see #461. The request here was to support a more graceful operation for checking whether the version table exists or not.
I've gone ahead and implemented the Postgres-specific version of the
TableExists()method. And the nice thing is we can incrementally update the rest of the dialect implementations piecemeal.But we always fallback to some less optimized version if
ErrNotSupportedis returned.