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

AS-8430: Update history API to accept timestamp query params #888

Merged
merged 2 commits into from May 18, 2022
Merged

AS-8430: Update history API to accept timestamp query params #888

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
56ad0f3
AS-8430: Update history API to accept timestamp query params
May 18, 2022
7d7b436
notifications: use go-querystring for filtering URI params
jacobbednarz May 18, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
28 changes: 23 additions & 5 deletions notifications.go
View file
Open in desktop
Expand Up @@ -405,19 +405,37 @@ func (api *API) GetAvailableNotificationTypes(ctx context.Context, accountID str
return r, nil
}

// TimeRange is an object for filtering the alert history based on timestamp.
type TimeRange struct {
Since string `json:"since,omitempty"`
jacobbednarz marked this conversation as resolved.
Show resolved Hide resolved
Before string `json:"before,omitempty"`
}

// AlertHistoryFilter is an object for filtering the alert history response from the api.
type AlertHistoryFilter struct {
TimeRange TimeRange
Pagination PaginationOptions
}

// ListNotificationHistory will return the history of alerts sent for
// a given account. The time period varies based on zone plan.
// Free, Biz, Pro = 30 days
// Ent = 90 days
//
// API Reference: https://api.cloudflare.com/#notification-history-list-history
func (api *API) ListNotificationHistory(ctx context.Context, accountID string, pageOpts PaginationOptions) ([]NotificationHistory, ResultInfo, error) {
func (api *API) ListNotificationHistory(ctx context.Context, accountID string, alertHistoryFilter AlertHistoryFilter) ([]NotificationHistory, ResultInfo, error) {
v := url.Values{}
if pageOpts.PerPage > 0 {
v.Set("per_page", strconv.Itoa(pageOpts.PerPage))
if alertHistoryFilter.Pagination.PerPage > 0 {
v.Set("per_page", strconv.Itoa(alertHistoryFilter.Pagination.PerPage))
}
if alertHistoryFilter.Pagination.Page > 0 {
v.Set("page", strconv.Itoa(alertHistoryFilter.Pagination.Page))
}
if alertHistoryFilter.TimeRange.Since != "" {
v.Set("since", alertHistoryFilter.TimeRange.Since)
}
if pageOpts.Page > 0 {
v.Set("page", strconv.Itoa(pageOpts.Page))
if alertHistoryFilter.TimeRange.Before != "" {
v.Set("before", alertHistoryFilter.TimeRange.Before)
}

baseURL := fmt.Sprintf("/accounts/%s/alerting/v3/history", accountID)
Expand Down
9 changes: 8 additions & 1 deletion notifications_test.go
View file
Open in desktop
Expand Up @@ -531,6 +531,13 @@ func TestListNotificationHistory(t *testing.T) {
Page: 1,
}

timeRange := TimeRange{
Since: time.Now().Add(-15 * time.Minute).Format(time.RFC3339),
Before: time.Now().Format(time.RFC3339),
}

historyFilters := AlertHistoryFilter{TimeRange: timeRange, Pagination: pageOptions}

alertHistory, err := json.Marshal(expected)
require.NoError(t, err)
require.NotNil(t, alertHistory)
Expand Down Expand Up @@ -558,7 +565,7 @@ func TestListNotificationHistory(t *testing.T) {

mux.HandleFunc("/accounts/"+testAccountID+"/alerting/v3/history", handler)

actualResult, actualResultInfo, err := client.ListNotificationHistory(context.Background(), testAccountID, pageOptions)
actualResult, actualResultInfo, err := client.ListNotificationHistory(context.Background(), testAccountID, historyFilters)
require.Nil(t, err)
require.NotNil(t, actualResult)
require.Equal(t, expected, actualResult)
Expand Down