Merge pull request #484 from Scalingo/fix/429/use_pagination

refactor: remove use of a custom pagination structure

Author: EtienneM

CHANGELOG.md

@@ -7,6 +7,7 @@
 * refactor: replace `errgo` with `github.com/Scalingo/go-utils/errors/v3` (breaking change)
 * feat(logs): `LogsURL` returns a parsed structure (breaking change)
 * refactor: autofix by `go fix` and `golangci-lint`
+* refactor: remove use of a custom pagination structure
 
 ## 9.2.0
 

databases.go

@@ -7,6 +7,7 @@ import (
 
 	httpclient "github.com/Scalingo/go-scalingo/v9/http"
 	"github.com/Scalingo/go-utils/errors/v3"
+	"github.com/Scalingo/go-utils/pagination"
 )
 
 // DatabasesService is the interface gathering all the methods related to
@@ -17,7 +18,7 @@ type DatabasesService interface {
 	DatabaseDisableFeature(ctx context.Context, app, addonID, feature string) (DatabaseDisableFeatureResponse, error)
 	DatabaseUpdatePeriodicBackupsConfig(ctx context.Context, app, addonID string, params DatabaseUpdatePeriodicBackupsConfigParams) (Database, error)
 	DatabaseUpdateMaintenanceWindow(ctx context.Context, app, addonID string, params MaintenanceWindowParams) (Database, error)
-	DatabaseListMaintenance(ctx context.Context, app, addonID string, opts PaginationOpts) ([]*Maintenance, PaginationMeta, error)
+	DatabaseListMaintenance(ctx context.Context, app, addonID string, paginationReq pagination.Request) ([]*Maintenance, pagination.Meta, error)
 	DatabaseShowMaintenance(ctx context.Context, app, addonID, maintenanceID string) (Maintenance, error)
 }
 

deployments.go

@@ -11,11 +11,12 @@ import (
 
 	httpclient "github.com/Scalingo/go-scalingo/v9/http"
 	"github.com/Scalingo/go-utils/errors/v3"
+	"github.com/Scalingo/go-utils/pagination"
 )
 
 type DeploymentsService interface {
 	DeploymentList(ctx context.Context, app string) ([]*Deployment, error)
-	DeploymentListWithPagination(ctx context.Context, app string, opts PaginationOpts) ([]*Deployment, PaginationMeta, error)
+	DeploymentListWithPagination(ctx context.Context, app string, paginationReq pagination.Request) ([]*Deployment, pagination.Meta, error)
 	Deployment(ctx context.Context, app string, deploy string) (*Deployment, error)
 	DeploymentLogs(ctx context.Context, deployURL string) (*http.Response, error)
 	DeploymentStream(ctx context.Context, deployURL string) (*websocket.Conn, error)
@@ -119,7 +120,7 @@ func IsFinishedString(status DeploymentStatus) bool {
 type DeploymentList struct {
 	Deployments []*Deployment `json:"deployments"`
 	Meta        struct {
-		PaginationMeta PaginationMeta `json:"pagination"`
+		Pagination pagination.Meta `json:"pagination"`
 	}
 }
 
@@ -149,14 +150,14 @@ func (c *Client) DeploymentList(ctx context.Context, app string) ([]*Deployment,
 	return deployments.Deployments, nil
 }
 
-func (c *Client) DeploymentListWithPagination(ctx context.Context, app string, opts PaginationOpts) ([]*Deployment, PaginationMeta, error) {
+func (c *Client) DeploymentListWithPagination(ctx context.Context, app string, paginationReq pagination.Request) ([]*Deployment, pagination.Meta, error) {
 	var deployments DeploymentList
-	err := c.ScalingoAPI().SubresourceList(ctx, "apps", app, "deployments", opts.ToMap(), &deployments)
+	err := c.ScalingoAPI().SubresourceList(ctx, "apps", app, "deployments", paginationReq.ToURLValues(), &deployments)
 	if err != nil {
-		return []*Deployment{}, PaginationMeta{}, errors.Wrap(ctx, err, "list the deployments with pagination")
+		return []*Deployment{}, pagination.Meta{}, errors.Wrap(ctx, err, "list the deployments with pagination")
 	}
 
-	return deployments.Deployments, deployments.Meta.PaginationMeta, nil
+	return deployments.Deployments, deployments.Meta.Pagination, nil
 }
 
 func (c *Client) Deployment(ctx context.Context, app string, deploy string) (*Deployment, error) {

events.go

@@ -9,58 +9,59 @@ import (
 
 	"github.com/Scalingo/go-scalingo/v9/http"
 	"github.com/Scalingo/go-utils/errors/v3"
+	"github.com/Scalingo/go-utils/pagination"
 )
 
 type EventsService interface {
 	EventTypesList(context.Context) ([]EventType, error)
 	EventCategoriesList(context.Context) ([]EventCategory, error)
-	EventsList(ctx context.Context, app string, opts PaginationOpts) (Events, PaginationMeta, error)
-	UserEventsList(context.Context, PaginationOpts) (Events, PaginationMeta, error)
+	EventsList(ctx context.Context, app string, paginationReq pagination.Request) (Events, pagination.Meta, error)
+	UserEventsList(ctx context.Context, paginationReq pagination.Request) (Events, pagination.Meta, error)
 }
 
 var _ EventsService = (*Client)(nil)
 
 type EventsRes struct {
 	Events []*Event `json:"events"`
 	Meta   struct {
-		PaginationMeta PaginationMeta `json:"pagination"`
+		Pagination pagination.Meta `json:"pagination"`
 	}
 }
 
-func (c *Client) EventsList(ctx context.Context, app string, opts PaginationOpts) (Events, PaginationMeta, error) {
+func (c *Client) EventsList(ctx context.Context, app string, paginationReq pagination.Request) (Events, pagination.Meta, error) {
 	var eventsRes EventsRes
-	err := c.ScalingoAPI().SubresourceList(ctx, "apps", app, "events", opts.ToMap(), &eventsRes)
+	err := c.ScalingoAPI().SubresourceList(ctx, "apps", app, "events", paginationReq.ToURLValues(), &eventsRes)
 	if err != nil {
-		return nil, PaginationMeta{}, errors.Wrap(ctx, err, "list app events")
+		return nil, pagination.Meta{}, errors.Wrap(ctx, err, "list app events")
 	}
 	var events Events
 	for _, ev := range eventsRes.Events {
 		events = append(events, ev.Specialize())
 	}
-	return events, eventsRes.Meta.PaginationMeta, nil
+	return events, eventsRes.Meta.Pagination, nil
 }
 
-func (c *Client) UserEventsList(ctx context.Context, opts PaginationOpts) (Events, PaginationMeta, error) {
+func (c *Client) UserEventsList(ctx context.Context, paginationReq pagination.Request) (Events, pagination.Meta, error) {
 	req := &http.APIRequest{
 		Endpoint: "/events",
-		Params:   opts.ToMap(),
+		Params:   paginationReq.ToURLValues(),
 	}
 
 	var eventsRes EventsRes
 	res, err := c.ScalingoAPI().Do(ctx, req)
 	if err != nil {
-		return nil, PaginationMeta{}, errors.Wrap(ctx, err, "list user events")
+		return nil, pagination.Meta{}, errors.Wrap(ctx, err, "list user events")
 	}
 	defer res.Body.Close()
 
 	err = json.NewDecoder(res.Body).Decode(&eventsRes)
 	if err != nil {
-		return nil, PaginationMeta{}, errors.Wrap(ctx, err, "decode user events response")
+		return nil, pagination.Meta{}, errors.Wrap(ctx, err, "decode user events response")
 	}
 
 	var events Events
 	for _, ev := range eventsRes.Events {
 		events = append(events, ev.Specialize())
 	}
-	return events, eventsRes.Meta.PaginationMeta, nil
+	return events, eventsRes.Meta.Pagination, nil
 }

events_test.go

@@ -9,15 +9,16 @@ import (
 	"github.com/stretchr/testify/require"
 
 	"github.com/Scalingo/go-scalingo/v9/http/httpmock"
+	"github.com/Scalingo/go-utils/pagination"
 )
 
 var eventsListCases = map[string]struct {
-	PaginationOpts PaginationOpts
-	App            string
-	Body           string
-	Code           int
-	EventsCount    int
-	Error          error
+	PaginationReq pagination.Request
+	App           string
+	Body          string
+	Code          int
+	EventsCount   int
+	Error         error
 }{
 	"test get list of events with no event": {
 		App:         "app-1",
@@ -48,12 +49,12 @@ func TestEventsList(t *testing.T) {
 			apiMock := httpmock.NewMockClient(ctrl)
 			client.apiClient = apiMock
 
-			apiMock.EXPECT().SubresourceList(gomock.Any(), "apps", c.App, "events", c.PaginationOpts.ToMap(), gomock.Any()).Do(func(_ context.Context, _, _, _ string, _ any, res any) {
+			apiMock.EXPECT().SubresourceList(gomock.Any(), "apps", c.App, "events", c.PaginationReq.ToURLValues(), gomock.Any()).Do(func(_ context.Context, _, _, _ string, _ any, res any) {
 				err := json.Unmarshal([]byte(c.Body), &res)
 				require.NoError(t, err)
 			}).Return(nil)
 
-			events, _, err := client.EventsList(ctx, c.App, c.PaginationOpts)
+			events, _, err := client.EventsList(ctx, c.App, c.PaginationReq)
 			if len(events) != c.EventsCount {
 				t.Errorf("expected %d event, got %v", c.EventsCount, len(events))
 			}

go.mod

@@ -4,7 +4,7 @@ go 1.24.0
 
 require (
 	github.com/Scalingo/go-utils/errors/v3 v3.2.0
-	github.com/Scalingo/go-utils/pagination v1.1.2
+	github.com/Scalingo/go-utils/pagination v1.2.0
 	github.com/golang-jwt/jwt/v5 v5.3.1
 	github.com/golang/mock v1.6.0
 	github.com/gorilla/websocket v1.5.3

go.sum

@@ -1,7 +1,7 @@
 github.com/Scalingo/go-utils/errors/v3 v3.2.0 h1:Ks+v2oRwv3VZfe+xVB+kpfmZouXHVCPHHtwL5W60prc=
 github.com/Scalingo/go-utils/errors/v3 v3.2.0/go.mod h1:jVVNoOdYFjuNkR/BeEZWNWJVvu4jmyLY4udlsQQyBss=
-github.com/Scalingo/go-utils/pagination v1.1.2 h1:DfHxWXK76F6+UyJqmJ/XIxTuwurMIJHRFfiejmPBC+8=
-github.com/Scalingo/go-utils/pagination v1.1.2/go.mod h1:MwT1RRecXktFgVNeib+B4dnM4r0cPc93JichOPs5tj0=
+github.com/Scalingo/go-utils/pagination v1.2.0 h1:dTvce+thcZXH/S13HF5dxGNPCMdGALNsW6p2EYe2Pno=
+github.com/Scalingo/go-utils/pagination v1.2.0/go.mod h1:MwT1RRecXktFgVNeib+B4dnM4r0cPc93JichOPs5tj0=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/frankban/quicktest v1.2.2 h1:xfmOhhoH5fGPgbEAlhLpJH9p0z/0Qizio9osmvn9IUY=

http/api_request.go

@@ -81,7 +81,7 @@ func (c *client) Do(ctx context.Context, req *APIRequest) (*http.Response, error
 		}
 		body = bytes.NewReader(buffer)
 	case http.MethodGet, http.MethodDelete:
-		values, err := req.BuildQueryFromParams(ctx)
+		values, err := req.buildQueryFromParams(ctx)
 		if err != nil {
 			return nil, errors.Wrap(ctx, err, "build the query params")
 		}
@@ -161,7 +161,12 @@ func parseJSON(ctx context.Context, res *http.Response, data any) error {
 	return nil
 }
 
-func (req *APIRequest) BuildQueryFromParams(ctx context.Context) (url.Values, error) {
+func (req *APIRequest) buildQueryFromParams(ctx context.Context) (url.Values, error) {
+	urlValues, ok := req.Params.(url.Values)
+	if ok {
+		return urlValues, nil
+	}
+
 	values := url.Values{}
 	if reflect.TypeOf(req.Params).Kind() != reflect.Map {
 		return nil, errors.Errorf(ctx, "%#v is not a map", req.Params)

http/httpmock/client_mock.go

@@ -6,11 +6,12 @@ import (
 	"time"
 
 	"github.com/Scalingo/go-utils/errors/v3"
+	"github.com/Scalingo/go-utils/pagination"
 )
 
 type InvoicesService interface {
-	InvoicesList(context.Context, PaginationOpts) (Invoices, PaginationMeta, error)
-	InvoiceShow(context.Context, string) (*Invoice, error)
+	InvoicesList(ctx context.Context, paginationReq pagination.Request) (Invoices, pagination.Meta, error)
+	InvoiceShow(ctx context.Context, id string) (*Invoice, error)
 }
 
 var _ InvoicesService = (*Client)(nil)
@@ -50,21 +51,21 @@ type Invoices []*Invoice
 type InvoicesRes struct {
 	Invoices Invoices `json:"invoices"`
 	Meta     struct {
-		PaginationMeta PaginationMeta `json:"pagination"`
+		Pagination pagination.Meta `json:"pagination"`
 	}
 }
 
 type InvoiceRes struct {
 	Invoice *Invoice `json:"invoice"`
 }
 
-func (c *Client) InvoicesList(ctx context.Context, opts PaginationOpts) (Invoices, PaginationMeta, error) {
+func (c *Client) InvoicesList(ctx context.Context, paginationReq pagination.Request) (Invoices, pagination.Meta, error) {
 	var invoicesRes InvoicesRes
-	err := c.ScalingoAPI().ResourceList(ctx, "account/invoices", opts.ToMap(), &invoicesRes)
+	err := c.ScalingoAPI().ResourceList(ctx, "account/invoices", paginationReq.ToURLValues(), &invoicesRes)
 	if err != nil {
-		return nil, PaginationMeta{}, errors.Wrap(ctx, err, "list invoices")
+		return nil, pagination.Meta{}, errors.Wrap(ctx, err, "list invoices")
 	}
-	return invoicesRes.Invoices, invoicesRes.Meta.PaginationMeta, nil
+	return invoicesRes.Invoices, invoicesRes.Meta.Pagination, nil
 }
 
 func (c *Client) InvoiceShow(ctx context.Context, id string) (*Invoice, error) {