feat: fail user list pages that omit pagination data #39
There are no files selected for viewing
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| package hubspot | ||
|
|
||
| import ( | ||
| "context" | ||
| "errors" | ||
| "net/http" | ||
| "net/http/httptest" | ||
| "testing" | ||
|
|
||
| "github.com/conductorone/baton-sdk/pkg/uhttp" | ||
| ) | ||
|
|
||
| // newTestClient spins up a server that always replies with body and returns a | ||
| // client pointed at it. Each case gets its own server so uhttp's response cache | ||
| // never serves one case's body to another. | ||
| func newTestClient(t *testing.T, body string) *Client { | ||
| t.Helper() | ||
|
|
||
| server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { | ||
| w.Header().Set("Content-Type", "application/json") | ||
|
Contributor
There was a problem hiding this comment. 🟡 Suggestion: the handler replies with the same body for any path, so nothing in the suite pins which endpoint |
||
| _, _ = w.Write([]byte(body)) | ||
| })) | ||
| t.Cleanup(server.Close) | ||
|
|
||
| client, err := NewClient("token", server.Client(), server.URL+"/") | ||
| if err != nil { | ||
| t.Fatalf("NewClient: %v", err) | ||
| } | ||
| return client | ||
| } | ||
|
|
||
| func TestGetUsersReturnsNextPage(t *testing.T) { | ||
| client := newTestClient(t, `{"results":[{"id":"1","email":"a@example.com"}],"paging":{"next":{"after":"50"}}}`) | ||
|
|
||
| users, nextPage, _, err := client.GetUsers(context.Background(), GetUsersVars{Limit: 50}) | ||
| if err != nil { | ||
| t.Fatalf("GetUsers: %v", err) | ||
| } | ||
| if len(users) != 1 || users[0].Id != "1" { | ||
| t.Errorf("got users %+v, want a single user with id 1", users) | ||
| } | ||
| if nextPage != "50" { | ||
| t.Errorf("got next page %q, want %q", nextPage, "50") | ||
| } | ||
| } | ||
|
|
||
| // The last page still carries a paging object, just without a cursor. | ||
| func TestGetUsersLastPage(t *testing.T) { | ||
| client := newTestClient(t, `{"results":[{"id":"1","email":"a@example.com"}],"paging":{}}`) | ||
|
|
||
| users, nextPage, _, err := client.GetUsers(context.Background(), GetUsersVars{Limit: 50}) | ||
| if err != nil { | ||
| t.Fatalf("GetUsers: %v", err) | ||
| } | ||
| if len(users) != 1 { | ||
| t.Errorf("got %d users, want 1", len(users)) | ||
| } | ||
| if nextPage != "" { | ||
| t.Errorf("got next page %q, want empty", nextPage) | ||
| } | ||
| } | ||
|
|
||
| // A 200 with results but no paging object means the API truncated the list | ||
| // without telling us. That must be an error, not a short sync. | ||
| func TestGetUsersMissingPagingErrors(t *testing.T) { | ||
|
Contributor
There was a problem hiding this comment. 🟡 Suggestion (high confidence): all three tests call |
||
| client := newTestClient(t, `{"results":[{"id":"1","email":"a@example.com"}]}`) | ||
|
|
||
| _, _, _, err := client.GetUsers(context.Background(), GetUsersVars{Limit: 50}) | ||
| if err == nil { | ||
| t.Fatal("GetUsers: expected an error when the response omits paging") | ||
| } | ||
| if !errors.Is(err, uhttp.ErrMissingPaginationData) { | ||
| t.Errorf("got error %v, want it to wrap ErrMissingPaginationData", err) | ||
| } | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
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.
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.
🟡 Suggestion: the PR description says this pins an unmerged SDK branch pseudo-version, but the diff now pins released
v0.28.0— worth updating the description. Also worth confirminggo mod vendorwas re-run after the retarget: the vendoredpkg/sdk/version.goreportsv0.27.0under av0.28.0module, andgo build -mod=vendorwon't catch vendored content that doesn't match the released module. (low confidence — the const may simply lag upstream releases.)