Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add support for listing and getting repository/organization webhook deliveries #1934

Merged
merged 15 commits into from
Jul 13, 2021
Merged

Add support for listing and getting repository/organization webhook deliveries #1934

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
54e5502
Add support for listing and getting repository webhook deliveries
mumoshu Jul 3, 2021
f5889f8
Add test for HookDelivery.ParseRequestPayload
mumoshu Jul 6, 2021
f6d688a
Restructure populatePageValues to reduce nesting
mumoshu Jul 6, 2021
ff5a47a
Use Timestamp instead of time.Time for delivered_at
mumoshu Jul 6, 2021
dffbb1c
Fix HookResponse.Header to Headers for consistency with the underlyin…
mumoshu Jul 6, 2021
5f0e1e4
Use %v instead of %d for formatting int64
mumoshu Jul 6, 2021
431c77c
Add more tests for ParseRequestPayload
mumoshu Jul 6, 2021
23922a8
Enhance cursor pagination test for more coverage
mumoshu Jul 6, 2021
72c3380
Make it clear that cursor and page are mutually exclusive
mumoshu Jul 8, 2021
5b86aff
Add periods to field comments
mumoshu Jul 8, 2021
194eff6
Add comments on HookRequest and HookResponse
mumoshu Jul 8, 2021
1381c0f
Accept suggestions from gmlewis with thanks :)
mumoshu Jul 9, 2021
0a3739c
Add support for listing and getting organization webhook deliveries
mumoshu Jul 11, 2021
fc8d20f
Add copyright notice to orgs_hooks_deliveries.go
mumoshu Jul 12, 2021
123bafa
Add blank after if err block for consistency
mumoshu Jul 12, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
136 changes: 136 additions & 0 deletions github/github-accessors.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

161 changes: 161 additions & 0 deletions github/github-accessors_test.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

22 changes: 22 additions & 0 deletions github/github-stringify_test.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

25 changes: 23 additions & 2 deletions github/github.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -212,6 +212,9 @@ type ListCursorOptions struct {

// A cursor, as given in the Link header. If specified, the query only searches for events before this cursor.
Before string `url:"before,omitempty"`

// A cursor, as given in the Link header. If specified, the query continues the search using this cursor.
Cursor string `url:"cursor,omitempty"`
gmlewis marked this conversation as resolved.
Show resolved Hide resolved
}

// UploadOptions specifies the parameters to methods that support uploads.
Expand Down Expand Up @@ -445,6 +448,11 @@ type Response struct {
// calling the endpoint again.
NextPageToken string

// For APIs that support cursor pagination, such as RepositoryService.ListRepositoryHookDeliveries,
// the following field will be populated to point to the next page.
// Set ListCursorOptions.Cursor to this value when calling the endpoint again.
Cursor string

// Explicitly specify the Rate type so Rate's String() receiver doesn't
// propagate to Response.
Rate Rate
Expand Down Expand Up @@ -481,7 +489,21 @@ func (r *Response) populatePageValues() {
if err != nil {
continue
}
page := url.Query().Get("page")

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmmm... I'm not sure I'm happy with this section (especially regarding increasing the already-deep indentation levels).

Since "cursor" is the less-common and smaller case, let's please handle it first, and let's revert all the changes made to the handling of the "page" section, except maybe to pull out the shared query first... something like this:

q := url.Query()
if cursor := q.Get("cursor"); cursor != "" {
...
}

page := q.Get("page")
if page == "" {
  continue
}
...

Copy link
Contributor Author

@mumoshu mumoshu Jul 6, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! Addressed in f6d688a

q := url.Query()

if cursor := q.Get("cursor"); cursor != "" {
for _, segment := range segments[1:] {
switch strings.TrimSpace(segment) {
case `rel="next"`:
r.Cursor = cursor
}
}

continue
}
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are "cursor" and "page" mutually exclusive? (I think the answer is "yes" but I could be wrong.)

If so, do you want to add a continue within this if block just to make that clear?
I'm actually fine either way... your call.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! Yes, I believe so, although it isn't documented anywhere. Added continue in 72c3380


page := q.Get("page")
if page == "" {
continue
}
Expand All @@ -499,7 +521,6 @@ func (r *Response) populatePageValues() {
case `rel="last"`:
r.LastPage, _ = strconv.Atoi(page)
}

}
}
}
Expand Down
Loading