feat(dispatch): Cursor for easy pagination #1678
Merged
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
Registering MethodSets compares the MethodSet against the implementation to make sure they match each other. Add tests for dispatch to ensure common failure cases actually work.
Func implementations registered with Dispatch can return 1-3 values. Only 1 value means it must be an error. 2 values means the first is any output and the second is an error. 3 values means the first is any output, the second is a Cursor, and the third is an error. Cursor will be used for pagination of methods that support it.
b5
approved these changes
Mar 5, 2021
| @@ -95,8 +95,7 @@ func (o *CheckoutOptions) Run() (err error) { | |||
| return err | |||
| } | |||
|
|
|||
| _, err = inst.Filesys().Checkout(ctx, &lib.LinkParams{Dir: o.Dir, Refstr: ref}) | |||
| if err != nil { | |||
| if err = inst.Filesys().Checkout(ctx, &lib.LinkParams{Dir: o.Dir, Refstr: ref}); err != nil { | |||
lib/dispatch.go
Outdated
Comment on lines
31
to
33
| // as the input and output parameters for those methods, and associates a string name for each | ||
| // method. Dispatch works by looking up that method name, constructing the necessary input, | ||
| // then invoking the actual implementation. |
There was a problem hiding this comment.
mind adjusting the comment to talk about how dispatch returns a non-nil cursor for paginated responses?
lib/dispatch_test.go
Outdated
Comment on lines
99
to
101
| // Test data: methodSet and implementation | ||
|
|
||
| type animalMethods struct { |
There was a problem hiding this comment.
it's not "effective go" to label sections of code with comments. add these comments to the definition of each struct by (for example) removing line 100
| "testing" | ||
| ) | ||
|
|
||
| func TestRegisterMethods(t *testing.T) { |
Comment on lines
+108
to
+111
| // There are either 1, 2, or 3 output values: | ||
| // 1: func() (err) | ||
| // 2: func() (out, err) | ||
| // 3: func() (out, cur, err) |
There was a problem hiding this comment.
We should get this comment in a place where MethodSet implementers can find it. I think a big 'ol comment above the methodSet interface
|
Also, tests gotta pass 😄 |
|
All comments addressed, merging now! |
This was referenced Mar 5, 2021
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.
No description provided.