Pagination Rewrite (#268)

linode · Aug 18, 2022 · 38b1365 · 38b1365
1 parent 4783c42
commit 38b1365
Show file tree

Hide file tree

Showing 186 changed files with 3,168 additions and 3,114 deletions.
diff --git a/account_events.go b/account_events.go
@@ -6,6 +6,7 @@ import (
 	"fmt"
 	"time"
 
+	"github.com/go-resty/resty/v2"
 	"github.com/linode/linodego/internal/duration"
 	"github.com/linode/linodego/internal/parseabletime"
 )
@@ -180,11 +181,11 @@ const (
 // can be used to access it.
 type EventEntity struct {
 	// ID may be a string or int, it depends on the EntityType
-	ID     interface{} `json:"id"`
-	Label  string      `json:"label"`
-	Type   EntityType  `json:"type"`
-	Status string      `json:"status"`
-	URL    string      `json:"url"`
+	ID     any        `json:"id"`
+	Label  string     `json:"label"`
+	Type   EntityType `json:"type"`
+	Status string     `json:"status"`
+	URL    string     `json:"url"`
 }
 
 // EventsPagedResponse represents a paginated Events API response
@@ -194,7 +195,7 @@ type EventsPagedResponse struct {
 }
 
 // endpoint gets the endpoint URL for Event
-func (EventsPagedResponse) endpoint(c *Client) string {
+func (EventsPagedResponse) endpoint(c *Client, _ ...any) string {
 	endpoint, err := c.Events.Endpoint()
 	if err != nil {
 		panic(err)
@@ -237,9 +238,14 @@ func (i Event) endpointWithID(c *Client) string {
 	return endpoint
 }
 
-// appendData appends Events when processing paginated Event responses
-func (resp *EventsPagedResponse) appendData(r *EventsPagedResponse) {
-	resp.Data = append(resp.Data, r.Data...)
+func (resp *EventsPagedResponse) castResult(r *resty.Request, e string) (int, int, error) {
+	res, err := coupleAPIErrors(r.SetResult(EventsPagedResponse{}).Get(e))
+	if err != nil {
+		return 0, 0, err
+	}
+	castedRes := res.Result().(*EventsPagedResponse)
+	resp.Data = append(resp.Data, castedRes.Data...)
+	return castedRes.Pages, castedRes.Results, nil
 }
 
 // ListEvents gets a collection of Event objects representing actions taken

diff --git a/account_invoices.go b/account_invoices.go
@@ -6,6 +6,7 @@ import (
 	"fmt"
 	"time"
 
+	"github.com/go-resty/resty/v2"
 	"github.com/linode/linodego/internal/parseabletime"
 )
 
@@ -35,7 +36,7 @@ type InvoicesPagedResponse struct {
 }
 
 // endpoint gets the endpoint URL for Invoice
-func (InvoicesPagedResponse) endpoint(c *Client) string {
+func (InvoicesPagedResponse) endpoint(c *Client, _ ...any) string {
 	endpoint, err := c.Invoices.Endpoint()
 	if err != nil {
 		panic(err)
@@ -44,9 +45,14 @@ func (InvoicesPagedResponse) endpoint(c *Client) string {
 	return endpoint
 }
 
-// appendData appends Invoices when processing paginated Invoice responses
-func (resp *InvoicesPagedResponse) appendData(r *InvoicesPagedResponse) {
-	resp.Data = append(resp.Data, r.Data...)
+func (resp *InvoicesPagedResponse) castResult(r *resty.Request, e string) (int, int, error) {
+	res, err := coupleAPIErrors(r.SetResult(InvoicesPagedResponse{}).Get(e))
+	if err != nil {
+		return 0, 0, err
+	}
+	castedRes := res.Result().(*InvoicesPagedResponse)
+	resp.Data = append(resp.Data, castedRes.Data...)
+	return castedRes.Pages, castedRes.Results, nil
 }
 
 // ListInvoices gets a paginated list of Invoices against the Account
@@ -125,7 +131,8 @@ type InvoiceItemsPagedResponse struct {
 }
 
 // endpointWithID gets the endpoint URL for InvoiceItems associated with a specific Invoice
-func (InvoiceItemsPagedResponse) endpointWithID(c *Client, id int) string {
+func (InvoiceItemsPagedResponse) endpoint(c *Client, ids ...any) string {
+	id := ids[0].(int)
 	endpoint, err := c.InvoiceItems.endpointWithParams(id)
 	if err != nil {
 		panic(err)
@@ -134,15 +141,20 @@ func (InvoiceItemsPagedResponse) endpointWithID(c *Client, id int) string {
 	return endpoint
 }
 
-// appendData appends InvoiceItems when processing paginated Invoice Item responses
-func (resp *InvoiceItemsPagedResponse) appendData(r *InvoiceItemsPagedResponse) {
-	resp.Data = append(resp.Data, r.Data...)
+func (resp *InvoiceItemsPagedResponse) castResult(r *resty.Request, e string) (int, int, error) {
+	res, err := coupleAPIErrors(r.SetResult(InvoiceItemsPagedResponse{}).Get(e))
+	if err != nil {
+		return 0, 0, err
+	}
+	castedRes := res.Result().(*InvoiceItemsPagedResponse)
+	resp.Data = append(resp.Data, castedRes.Data...)
+	return castedRes.Pages, castedRes.Results, nil
 }
 
 // ListInvoiceItems gets the invoice items associated with a specific Invoice
 func (c *Client) ListInvoiceItems(ctx context.Context, id int, opts *ListOptions) ([]InvoiceItem, error) {
 	response := InvoiceItemsPagedResponse{}
-	err := c.listHelperWithID(ctx, &response, id, opts)
+	err := c.listHelper(ctx, &response, opts, id)
 	if err != nil {
 		return nil, err
 	}

diff --git a/account_notifications.go b/account_notifications.go
@@ -5,6 +5,7 @@ import (
 	"encoding/json"
 	"time"
 
+	"github.com/go-resty/resty/v2"
 	"github.com/linode/linodego/internal/parseabletime"
 )
 
@@ -63,7 +64,7 @@ type NotificationsPagedResponse struct {
 }
 
 // endpoint gets the endpoint URL for Notification
-func (NotificationsPagedResponse) endpoint(c *Client) string {
+func (NotificationsPagedResponse) endpoint(c *Client, _ ...any) string {
 	endpoint, err := c.Notifications.Endpoint()
 	if err != nil {
 		panic(err)
@@ -72,9 +73,14 @@ func (NotificationsPagedResponse) endpoint(c *Client) string {
 	return endpoint
 }
 
-// appendData appends Notifications when processing paginated Notification responses
-func (resp *NotificationsPagedResponse) appendData(r *NotificationsPagedResponse) {
-	resp.Data = append(resp.Data, r.Data...)
+func (resp *NotificationsPagedResponse) castResult(r *resty.Request, e string) (int, int, error) {
+	res, err := coupleAPIErrors(r.SetResult(NotificationsPagedResponse{}).Get(e))
+	if err != nil {
+		return 0, 0, err
+	}
+	castedRes := res.Result().(*NotificationsPagedResponse)
+	resp.Data = append(resp.Data, castedRes.Data...)
+	return castedRes.Pages, castedRes.Results, nil
 }
 
 // ListNotifications gets a collection of Notification objects representing important,

diff --git a/account_oauth_client.go b/account_oauth_client.go
@@ -4,6 +4,8 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
+
+	"github.com/go-resty/resty/v2"
 )
 
 // OAuthClientStatus constants start with OAuthClient and include Linode API Instance Status values
@@ -89,7 +91,7 @@ type OAuthClientsPagedResponse struct {
 }
 
 // endpoint gets the endpoint URL for OAuthClient
-func (OAuthClientsPagedResponse) endpoint(c *Client) string {
+func (OAuthClientsPagedResponse) endpoint(c *Client, _ ...any) string {
 	endpoint, err := c.OAuthClients.Endpoint()
 	if err != nil {
 		panic(err)
@@ -98,9 +100,14 @@ func (OAuthClientsPagedResponse) endpoint(c *Client) string {
 	return endpoint
 }
 
-// appendData appends OAuthClients when processing paginated OAuthClient responses
-func (resp *OAuthClientsPagedResponse) appendData(r *OAuthClientsPagedResponse) {
-	resp.Data = append(resp.Data, r.Data...)
+func (resp *OAuthClientsPagedResponse) castResult(r *resty.Request, e string) (int, int, error) {
+	res, err := coupleAPIErrors(r.SetResult(OAuthClientsPagedResponse{}).Get(e))
+	if err != nil {
+		return 0, 0, err
+	}
+	castedRes := res.Result().(*OAuthClientsPagedResponse)
+	resp.Data = append(resp.Data, castedRes.Data...)
+	return castedRes.Pages, castedRes.Results, nil
 }
 
 // ListOAuthClients lists OAuthClients

diff --git a/account_payments.go b/account_payments.go
@@ -6,6 +6,7 @@ import (
 	"fmt"
 	"time"
 
+	"github.com/go-resty/resty/v2"
 	"github.com/linode/linodego/internal/parseabletime"
 )
 
@@ -63,7 +64,7 @@ type PaymentsPagedResponse struct {
 }
 
 // endpoint gets the endpoint URL for Payment
-func (PaymentsPagedResponse) endpoint(c *Client) string {
+func (PaymentsPagedResponse) endpoint(c *Client, _ ...any) string {
 	endpoint, err := c.Payments.Endpoint()
 	if err != nil {
 		panic(err)
@@ -72,9 +73,14 @@ func (PaymentsPagedResponse) endpoint(c *Client) string {
 	return endpoint
 }
 
-// appendData appends Payments when processing paginated Payment responses
-func (resp *PaymentsPagedResponse) appendData(r *PaymentsPagedResponse) {
-	resp.Data = append(resp.Data, r.Data...)
+func (resp *PaymentsPagedResponse) castResult(r *resty.Request, e string) (int, int, error) {
+	res, err := coupleAPIErrors(r.SetResult(PaymentsPagedResponse{}).Get(e))
+	if err != nil {
+		return 0, 0, err
+	}
+	castedRes := res.Result().(*PaymentsPagedResponse)
+	resp.Data = append(resp.Data, castedRes.Data...)
+	return castedRes.Pages, castedRes.Results, nil
 }
 
 // ListPayments lists Payments

diff --git a/account_users.go b/account_users.go
@@ -4,6 +4,8 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
+
+	"github.com/go-resty/resty/v2"
 )
 
 // User represents a User object
@@ -52,7 +54,7 @@ type UsersPagedResponse struct {
 }
 
 // endpoint gets the endpoint URL for User
-func (UsersPagedResponse) endpoint(c *Client) string {
+func (UsersPagedResponse) endpoint(c *Client, _ ...any) string {
 	endpoint, err := c.Users.Endpoint()
 	if err != nil {
 		panic(err)
@@ -61,9 +63,14 @@ func (UsersPagedResponse) endpoint(c *Client) string {
 	return endpoint
 }
 
-// appendData appends Users when processing paginated User responses
-func (resp *UsersPagedResponse) appendData(r *UsersPagedResponse) {
-	resp.Data = append(resp.Data, r.Data...)
+func (resp *UsersPagedResponse) castResult(r *resty.Request, e string) (int, int, error) {
+	res, err := coupleAPIErrors(r.SetResult(UsersPagedResponse{}).Get(e))
+	if err != nil {
+		return 0, 0, err
+	}
+	castedRes := res.Result().(*UsersPagedResponse)
+	resp.Data = append(resp.Data, castedRes.Data...)
+	return castedRes.Pages, castedRes.Results, nil
 }
 
 // ListUsers lists Users on the account

diff --git a/databases.go b/databases.go
@@ -6,6 +6,7 @@ import (
 	"fmt"
 	"time"
 
+	"github.com/go-resty/resty/v2"
 	"github.com/linode/linodego/internal/parseabletime"
 )
 
@@ -57,50 +58,68 @@ type DatabasesPagedResponse struct {
 	Data []Database `json:"data"`
 }
 
-func (DatabasesPagedResponse) endpoint(c *Client) string {
+func (DatabasesPagedResponse) endpoint(c *Client, _ ...any) string {
 	endpoint, err := c.Databases.Endpoint()
 	if err != nil {
 		panic(err)
 	}
 	return fmt.Sprintf("%s/instances", endpoint)
 }
 
-func (resp *DatabasesPagedResponse) appendData(r *DatabasesPagedResponse) {
-	resp.Data = append(resp.Data, r.Data...)
+func (resp *DatabasesPagedResponse) castResult(r *resty.Request, e string) (int, int, error) {
+	res, err := coupleAPIErrors(r.SetResult(DatabasesPagedResponse{}).Get(e))
+	if err != nil {
+		return 0, 0, err
+	}
+	castedRes := res.Result().(*DatabasesPagedResponse)
+	resp.Data = append(resp.Data, castedRes.Data...)
+	return castedRes.Pages, castedRes.Results, nil
 }
 
 type DatabaseEnginesPagedResponse struct {
 	*PageOptions
 	Data []DatabaseEngine `json:"data"`
 }
 
-func (DatabaseEnginesPagedResponse) endpoint(c *Client) string {
+func (DatabaseEnginesPagedResponse) endpoint(c *Client, _ ...any) string {
 	endpoint, err := c.Databases.Endpoint()
 	if err != nil {
 		panic(err)
 	}
 	return fmt.Sprintf("%s/engines", endpoint)
 }
 
-func (resp *DatabaseEnginesPagedResponse) appendData(r *DatabaseEnginesPagedResponse) {
-	resp.Data = append(resp.Data, r.Data...)
+func (resp *DatabaseEnginesPagedResponse) castResult(r *resty.Request, e string) (int, int, error) {
+	res, err := coupleAPIErrors(r.SetResult(DatabaseEnginesPagedResponse{}).Get(e))
+	if err != nil {
+		return 0, 0, err
+	}
+	castedRes := res.Result().(*DatabaseEnginesPagedResponse)
+	resp.Data = append(resp.Data, castedRes.Data...)
+	return castedRes.Pages, castedRes.Results, nil
 }
 
 type DatabaseTypesPagedResponse struct {
 	*PageOptions
 	Data []DatabaseType `json:"data"`
 }
 
-func (DatabaseTypesPagedResponse) endpoint(c *Client) string {
+func (DatabaseTypesPagedResponse) endpoint(c *Client, _ ...any) string {
 	endpoint, err := c.Databases.Endpoint()
 	if err != nil {
 		panic(err)
 	}
 	return fmt.Sprintf("%s/types", endpoint)
 }
 
-func (resp *DatabaseTypesPagedResponse) appendData(r *DatabaseTypesPagedResponse) {
-	resp.Data = append(resp.Data, r.Data...)
+func (resp *DatabaseTypesPagedResponse) castResult(r *resty.Request, e string) (int, int, error) {
+	res, err := coupleAPIErrors(r.SetResult(DatabaseTypesPagedResponse{}).Get(e))
+	if err != nil {
+		return 0, 0, err
+	}
+	castedRes := res.Result().(*DatabaseTypesPagedResponse)
+	resp.Data = append(resp.Data, castedRes.Data...)
+	return castedRes.Pages, castedRes.Results, nil
 }
 
 // A Database is a instance of Linode Managed Databases

diff --git a/domain_records.go b/domain_records.go
@@ -4,6 +4,8 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
+
+	"github.com/go-resty/resty/v2"
 )
 
 // DomainRecord represents a DomainRecord object
@@ -88,7 +90,8 @@ type DomainRecordsPagedResponse struct {
 }
 
 // endpoint gets the endpoint URL for InstanceConfig
-func (DomainRecordsPagedResponse) endpointWithID(c *Client, id int) string {
+func (DomainRecordsPagedResponse) endpoint(c *Client, ids ...any) string {
+	id, _ := ids[0].(int)
 	endpoint, err := c.DomainRecords.endpointWithParams(id)
 	if err != nil {
 		panic(err)
@@ -97,15 +100,20 @@ func (DomainRecordsPagedResponse) endpointWithID(c *Client, id int) string {
 	return endpoint
 }
 
-// appendData appends DomainRecords when processing paginated DomainRecord responses
-func (resp *DomainRecordsPagedResponse) appendData(r *DomainRecordsPagedResponse) {
-	resp.Data = append(resp.Data, r.Data...)
+func (resp *DomainRecordsPagedResponse) castResult(r *resty.Request, e string) (int, int, error) {
+	res, err := coupleAPIErrors(r.SetResult(DomainRecordsPagedResponse{}).Get(e))
+	if err != nil {
+		return 0, 0, err
+	}
+	castedRes := res.Result().(*DomainRecordsPagedResponse)
+	resp.Data = append(resp.Data, castedRes.Data...)
+	return castedRes.Pages, castedRes.Results, nil
 }
 
 // ListDomainRecords lists DomainRecords
 func (c *Client) ListDomainRecords(ctx context.Context, domainID int, opts *ListOptions) ([]DomainRecord, error) {
 	response := DomainRecordsPagedResponse{}
-	err := c.listHelperWithID(ctx, &response, domainID, opts)
+	err := c.listHelper(ctx, &response, opts, domainID)
 	if err != nil {
 		return nil, err
 	}