refactor(pagination): move paginationRequestToMap to package go-utils/pagination

EtienneM · EtienneM · commit ffc429b741ac · 2026-03-04T16:29:18.000+01:00
diff --git a/deployments.go b/deployments.go
@@ -152,7 +152,7 @@ func (c *Client) DeploymentList(ctx context.Context, app string) ([]*Deployment,
 
 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", paginationRequestToMap(paginationReq), &deployments)
+	err := c.ScalingoAPI().SubresourceList(ctx, "apps", app, "deployments", paginationReq.ToURLValues(), &deployments)
 	if err != nil {
 		return []*Deployment{}, pagination.Meta{}, errors.Wrap(ctx, err, "list the deployments with pagination")
 	}
diff --git a/events.go b/events.go
@@ -30,7 +30,7 @@ type EventsRes struct {
 
 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", paginationRequestToMap(paginationReq), &eventsRes)
+	err := c.ScalingoAPI().SubresourceList(ctx, "apps", app, "events", paginationReq.ToURLValues(), &eventsRes)
 	if err != nil {
 		return nil, pagination.Meta{}, errors.Wrap(ctx, err, "list app events")
 	}
@@ -44,7 +44,7 @@ func (c *Client) EventsList(ctx context.Context, app string, paginationReq pagin
 func (c *Client) UserEventsList(ctx context.Context, paginationReq pagination.Request) (Events, pagination.Meta, error) {
 	req := &http.APIRequest{
 		Endpoint: "/events",
-		Params:   paginationRequestToMap(paginationReq),
+		Params:   paginationReq.ToURLValues(),
 	}
 
 	var eventsRes EventsRes
diff --git a/events_test.go b/events_test.go
@@ -49,7 +49,7 @@ func TestEventsList(t *testing.T) {
 			apiMock := httpmock.NewMockClient(ctrl)
 			client.apiClient = apiMock
 
-			apiMock.EXPECT().SubresourceList(gomock.Any(), "apps", c.App, "events", paginationRequestToMap(c.PaginationReq), 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)
diff --git a/go.mod b/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.1.3-0.20260304151724-6f86a56889dd
 	github.com/golang-jwt/jwt/v5 v5.3.1
 	github.com/golang/mock v1.6.0
 	github.com/gorilla/websocket v1.5.3
diff --git a/go.sum b/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.1.3-0.20260304151724-6f86a56889dd h1:Xyl43LW+DHKE7CBkWGtnh1DDz8mpVQBnSZ85mtplHLk=
+github.com/Scalingo/go-utils/pagination v1.1.3-0.20260304151724-6f86a56889dd/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=
diff --git a/http/api_request.go b/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)
diff --git a/invoices.go b/invoices.go
@@ -61,7 +61,7 @@ type InvoiceRes struct {
 
 func (c *Client) InvoicesList(ctx context.Context, paginationReq pagination.Request) (Invoices, pagination.Meta, error) {
 	var invoicesRes InvoicesRes
-	err := c.ScalingoAPI().ResourceList(ctx, "account/invoices", paginationRequestToMap(paginationReq), &invoicesRes)
+	err := c.ScalingoAPI().ResourceList(ctx, "account/invoices", paginationReq.ToURLValues(), &invoicesRes)
 	if err != nil {
 		return nil, pagination.Meta{}, errors.Wrap(ctx, err, "list invoices")
 	}
diff --git a/maintenance.go b/maintenance.go
@@ -63,7 +63,7 @@ type ListMaintenanceResponse struct {
 
 func (c *Client) DatabaseListMaintenance(ctx context.Context, app, addonID string, paginationReq pagination.Request) ([]*Maintenance, pagination.Meta, error) {
 	var maintenanceRes ListMaintenanceResponse
-	err := c.DBAPI(app, addonID).SubresourceList(ctx, "databases", addonID, "maintenance", paginationRequestToMap(paginationReq), &maintenanceRes)
+	err := c.DBAPI(app, addonID).SubresourceList(ctx, "databases", addonID, "maintenance", paginationReq.ToURLValues(), &maintenanceRes)
 	if err != nil {
 		return nil, pagination.Meta{}, errors.Wrapf(ctx, err, "list database '%v' maintenance", addonID)
 	}
diff --git a/pagination.go b/pagination.go
diff --git a/scm_repo_link.go b/scm_repo_link.go
@@ -117,7 +117,7 @@ var _ SCMRepoLinkService = (*Client)(nil)
 
 func (c *Client) SCMRepoLinkList(ctx context.Context, paginationReq pagination.Request) ([]*SCMRepoLink, pagination.Meta, error) {
 	var res SCMRepoLinksResponse
-	err := c.ScalingoAPI().ResourceList(ctx, "scm_repo_links", paginationRequestToMap(paginationReq), &res)
+	err := c.ScalingoAPI().ResourceList(ctx, "scm_repo_links", paginationReq.ToURLValues(), &res)
 	if err != nil {
 		return nil, pagination.Meta{}, errors.Wrap(ctx, err, "list SCM repo links")
 	}

Original file line number	Diff line number	Diff line change
`@@ -152,7 +152,7 @@ func (c Client) DeploymentList(ctx context.Context, app string) ([]Deployment,`
`152`	`152`
`153`	`153`	`func (c Client) DeploymentListWithPagination(ctx context.Context, app string, paginationReq pagination.Request) ([]Deployment, pagination.Meta, error) {`
`154`	`154`	`var deployments DeploymentList`
`155`		`- err := c.ScalingoAPI().SubresourceList(ctx, "apps", app, "deployments", paginationRequestToMap(paginationReq), &deployments)`
	`155`	`+ err := c.ScalingoAPI().SubresourceList(ctx, "apps", app, "deployments", paginationReq.ToURLValues(), &deployments)`
`156`	`156`	`if err != nil {`
`157`	`157`	`return []*Deployment{}, pagination.Meta{}, errors.Wrap(ctx, err, "list the deployments with pagination")`
`158`	`158`	`}`
Original file line number	Diff line number	Diff line change
`@@ -61,7 +61,7 @@ type InvoiceRes struct {`
`61`	`61`
`62`	`62`	`func (c *Client) InvoicesList(ctx context.Context, paginationReq pagination.Request) (Invoices, pagination.Meta, error) {`
`63`	`63`	`var invoicesRes InvoicesRes`
`64`		`- err := c.ScalingoAPI().ResourceList(ctx, "account/invoices", paginationRequestToMap(paginationReq), &invoicesRes)`
	`64`	`+ err := c.ScalingoAPI().ResourceList(ctx, "account/invoices", paginationReq.ToURLValues(), &invoicesRes)`
`65`	`65`	`if err != nil {`
`66`	`66`	`return nil, pagination.Meta{}, errors.Wrap(ctx, err, "list invoices")`
`67`	`67`	`}`
Original file line number	Diff line number	Diff line change
`@@ -63,7 +63,7 @@ type ListMaintenanceResponse struct {`
`63`	`63`
`64`	`64`	`func (c Client) DatabaseListMaintenance(ctx context.Context, app, addonID string, paginationReq pagination.Request) ([]Maintenance, pagination.Meta, error) {`
`65`	`65`	`var maintenanceRes ListMaintenanceResponse`
`66`		`- err := c.DBAPI(app, addonID).SubresourceList(ctx, "databases", addonID, "maintenance", paginationRequestToMap(paginationReq), &maintenanceRes)`
	`66`	`+ err := c.DBAPI(app, addonID).SubresourceList(ctx, "databases", addonID, "maintenance", paginationReq.ToURLValues(), &maintenanceRes)`
`67`	`67`	`if err != nil {`
`68`	`68`	`return nil, pagination.Meta{}, errors.Wrapf(ctx, err, "list database '%v' maintenance", addonID)`
`69`	`69`	`}`
Original file line number	Diff line number	Diff line change
`@@ -117,7 +117,7 @@ var _ SCMRepoLinkService = (*Client)(nil)`
`117`	`117`
`118`	`118`	`func (c Client) SCMRepoLinkList(ctx context.Context, paginationReq pagination.Request) ([]SCMRepoLink, pagination.Meta, error) {`
`119`	`119`	`var res SCMRepoLinksResponse`
`120`		`- err := c.ScalingoAPI().ResourceList(ctx, "scm_repo_links", paginationRequestToMap(paginationReq), &res)`
	`120`	`+ err := c.ScalingoAPI().ResourceList(ctx, "scm_repo_links", paginationReq.ToURLValues(), &res)`
`121`	`121`	`if err != nil {`
`122`	`122`	`return nil, pagination.Meta{}, errors.Wrap(ctx, err, "list SCM repo links")`
`123`	`123`	`}`