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.

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

Update log_entry.go to accept a context.Context #291

Merged
merged 1 commit into from
Mar 10, 2021
Merged
Changes from all commits
Commits
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
27 changes: 22 additions & 5 deletions log_entry.go
Original file line number Diff line number Diff line change
Expand Up @@ -60,20 +60,29 @@ type ListLogEntriesOptions struct {
Includes []string `url:"include,omitempty,brackets"`
}

// ListLogEntries lists all of the incident log entries across the entire account.
// ListLogEntries lists all of the incident log entries across the entire
// account. It's recommended to use ListLogEntriesWithContext instead.
func (c *Client) ListLogEntries(o ListLogEntriesOptions) (*ListLogEntryResponse, error) {
return c.ListLogEntriesWithContext(context.Background(), o)
}

// ListLogEntriesWithContext lists all of the incident log entries across the entire account.
func (c *Client) ListLogEntriesWithContext(ctx context.Context, o ListLogEntriesOptions) (*ListLogEntryResponse, error) {
v, err := query.Values(o)
if err != nil {
return nil, err
}
resp, err := c.get(context.TODO(), "/log_entries?"+v.Encode())

resp, err := c.get(ctx, "/log_entries?"+v.Encode())
if err != nil {
return nil, err
}

var result ListLogEntryResponse
if err := c.decodeJSON(resp, &result); err != nil {
if err = c.decodeJSON(resp, &result); err != nil {
return nil, err
}

return &result, err
}

Expand All @@ -83,13 +92,20 @@ type GetLogEntryOptions struct {
Includes []string `url:"include,omitempty,brackets"`
}

// GetLogEntry list log entries for the specified incident.
// GetLogEntry list log entries for the specified incident. It's recommended to
// use GetLogEntryWithContext instead.
func (c *Client) GetLogEntry(id string, o GetLogEntryOptions) (*LogEntry, error) {
return c.GetLogEntryWithContext(context.Background(), id, o)
}

// GetLogEntryWithContext list log entries for the specified incident.
func (c *Client) GetLogEntryWithContext(ctx context.Context, id string, o GetLogEntryOptions) (*LogEntry, error) {
v, err := query.Values(o)
if err != nil {
return nil, err
}
resp, err := c.get(context.TODO(), "/log_entries/"+id+"?"+v.Encode())

resp, err := c.get(ctx, "/log_entries/"+id+"?"+v.Encode())
if err != nil {
return nil, err
}
Expand All @@ -103,6 +119,7 @@ func (c *Client) GetLogEntry(id string, o GetLogEntryOptions) (*LogEntry, error)
if !ok {
return nil, fmt.Errorf("JSON response does not have log_entry field")
}

return &le, nil
}

Expand Down