Fix pagination for messaging client

stephenfin · stephenfin · commit b60bf67f5bd5 · 2025-07-15T14:48:46.000+01:00
Zaqar returns paths rather than URLs in 'links' response fields and the 'Location' header. In addition, since Dalmatian, it deploys under a path ('/messaging') rather then behind a port. This combination has highlighted a bug in our pagination page handling, namely that we are ignoring the path element of the endpoint URL. While this is not an issue when the 'next' link is an absolute URL, as with most other services, it results in incomplete URLs when the link URL is relative ('/v2/messages') and the endpoint URL contains a path ('https://example.com/messaging'). Fix this by concatenating the two paths, rather than overwriting the endpoint URLs path. Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
diff --git a/openstack/messaging/v2/messages/requests.go b/openstack/messaging/v2/messages/requests.go
@@ -48,7 +48,10 @@ func List(client *gophercloud.ServiceClient, queueName string, opts ListOptsBuil
 	}
 
 	pager := pagination.NewPager(client, url, func(r pagination.PageResult) pagination.Page {
-		return MessagePage{pagination.LinkedPageBase{PageResult: r}}
+		return MessagePage{
+			serviceURL:     client.ServiceURL(),
+			LinkedPageBase: pagination.LinkedPageBase{PageResult: r},
+		}
 	})
 	return pager
 }
diff --git a/openstack/messaging/v2/messages/results.go b/openstack/messaging/v2/messages/results.go
@@ -12,6 +12,7 @@ type CreateResult struct {
 
 // MessagePage contains a single page of all clusters from a ListDetails call.
 type MessagePage struct {
+	serviceURL string
 	pagination.LinkedPageBase
 }
 
@@ -127,5 +128,5 @@ func (r MessagePage) NextPageURL() (string, error) {
 	if err != nil {
 		return "", err
 	}
-	return nextPageURL(r.String(), next)
+	return nextPageURL(r.serviceURL, next)
 }
diff --git a/openstack/messaging/v2/messages/urls.go b/openstack/messaging/v2/messages/urls.go
@@ -35,15 +35,17 @@ func messageURL(client *gophercloud.ServiceClient, queueName string, messageID s
 	return client.ServiceURL(apiVersion, apiName, queueName, "messages", messageID)
 }
 
-// Builds next page full url based on current url.
-func nextPageURL(currentURL string, next string) (string, error) {
-	base, err := url.Parse(currentURL)
+// builds next page full url based on service endpoint
+func nextPageURL(serviceURL, next string) (string, error) {
+	base, err := url.Parse(serviceURL)
 	if err != nil {
 		return "", err
 	}
 	rel, err := url.Parse(next)
 	if err != nil {
 		return "", err
 	}
-	return base.ResolveReference(rel).String(), nil
+	combined := base.JoinPath(rel.Path)
+	combined.RawQuery = rel.RawQuery
+	return combined.String(), nil
 }
diff --git a/openstack/messaging/v2/queues/requests.go b/openstack/messaging/v2/queues/requests.go
@@ -49,7 +49,10 @@ func List(client *gophercloud.ServiceClient, opts ListOptsBuilder) pagination.Pa
 	}
 
 	pager := pagination.NewPager(client, url, func(r pagination.PageResult) pagination.Page {
-		return QueuePage{pagination.LinkedPageBase{PageResult: r}}
+		return QueuePage{
+			serviceURL:     client.ServiceURL(),
+			LinkedPageBase: pagination.LinkedPageBase{PageResult: r},
+		}
 
 	})
 	return pager
diff --git a/openstack/messaging/v2/queues/results.go b/openstack/messaging/v2/queues/results.go
@@ -14,6 +14,7 @@ type commonResult struct {
 
 // QueuePage contains a single page of all queues from a List operation.
 type QueuePage struct {
+	serviceURL string
 	pagination.LinkedPageBase
 }
 
@@ -173,7 +174,7 @@ func (r QueuePage) NextPageURL() (string, error) {
 	if err != nil {
 		return "", err
 	}
-	return nextPageURL(r.String(), next)
+	return nextPageURL(r.serviceURL, next)
 }
 
 // GetCount value if it request was supplied `WithCount` param
diff --git a/openstack/messaging/v2/queues/urls.go b/openstack/messaging/v2/queues/urls.go
@@ -47,15 +47,17 @@ func purgeURL(client *gophercloud.ServiceClient, queueName string) string {
 	return client.ServiceURL(apiVersion, apiName, queueName, "purge")
 }
 
-// builds next page full url based on current url
-func nextPageURL(currentURL string, next string) (string, error) {
-	base, err := url.Parse(currentURL)
+// builds next page full url based on service endpoint
+func nextPageURL(serviceURL string, next string) (string, error) {
+	base, err := url.Parse(serviceURL)
 	if err != nil {
 		return "", err
 	}
 	rel, err := url.Parse(next)
 	if err != nil {
 		return "", err
 	}
-	return base.ResolveReference(rel).String(), nil
+	combined := base.JoinPath(rel.Path)
+	combined.RawQuery = rel.RawQuery
+	return combined.String(), nil
 }

Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,10 @@ func List(client *gophercloud.ServiceClient, queueName string, opts ListOptsBuil`
`48`	`48`	`}`
`49`	`49`
`50`	`50`	`pager := pagination.NewPager(client, url, func(r pagination.PageResult) pagination.Page {`
`51`		`- return MessagePage{pagination.LinkedPageBase{PageResult: r}}`
	`51`	`+ return MessagePage{`
	`52`	`+ serviceURL: client.ServiceURL(),`
	`53`	`+ LinkedPageBase: pagination.LinkedPageBase{PageResult: r},`
	`54`	`+ }`
`52`	`55`	`})`
`53`	`56`	`return pager`
`54`	`57`	`}`
Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,7 @@ type CreateResult struct {`
`12`	`12`
`13`	`13`	`// MessagePage contains a single page of all clusters from a ListDetails call.`
`14`	`14`	`type MessagePage struct {`
	`15`	`+ serviceURL string`
`15`	`16`	`pagination.LinkedPageBase`
`16`	`17`	`}`
`17`	`18`
`@@ -127,5 +128,5 @@ func (r MessagePage) NextPageURL() (string, error) {`
`127`	`128`	`if err != nil {`
`128`	`129`	`return "", err`
`129`	`130`	`}`
`130`		`- return nextPageURL(r.String(), next)`
	`131`	`+ return nextPageURL(r.serviceURL, next)`
`131`	`132`	`}`
Original file line number	Diff line number	Diff line change
`@@ -35,15 +35,17 @@ func messageURL(client *gophercloud.ServiceClient, queueName string, messageID s`
`35`	`35`	`return client.ServiceURL(apiVersion, apiName, queueName, "messages", messageID)`
`36`	`36`	`}`
`37`	`37`
`38`		`-// Builds next page full url based on current url.`
`39`		`-func nextPageURL(currentURL string, next string) (string, error) {`
`40`		`- base, err := url.Parse(currentURL)`
	`38`	`+// builds next page full url based on service endpoint`
	`39`	`+func nextPageURL(serviceURL, next string) (string, error) {`
	`40`	`+ base, err := url.Parse(serviceURL)`
`41`	`41`	`if err != nil {`
`42`	`42`	`return "", err`
`43`	`43`	`}`
`44`	`44`	`rel, err := url.Parse(next)`
`45`	`45`	`if err != nil {`
`46`	`46`	`return "", err`
`47`	`47`	`}`
`48`		`- return base.ResolveReference(rel).String(), nil`
	`48`	`+ combined := base.JoinPath(rel.Path)`
	`49`	`+ combined.RawQuery = rel.RawQuery`
	`50`	`+ return combined.String(), nil`
`49`	`51`	`}`
Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,7 @@ type commonResult struct {`
`14`	`14`
`15`	`15`	`// QueuePage contains a single page of all queues from a List operation.`
`16`	`16`	`type QueuePage struct {`
	`17`	`+ serviceURL string`
`17`	`18`	`pagination.LinkedPageBase`
`18`	`19`	`}`
`19`	`20`
`@@ -173,7 +174,7 @@ func (r QueuePage) NextPageURL() (string, error) {`
`173`	`174`	`if err != nil {`
`174`	`175`	`return "", err`
`175`	`176`	`}`
`176`		`- return nextPageURL(r.String(), next)`
	`177`	`+ return nextPageURL(r.serviceURL, next)`
`177`	`178`	`}`
`178`	`179`
`179`	`180`	// GetCount value if it request was supplied `WithCount` param
Original file line number	Diff line number	Diff line change
`@@ -47,15 +47,17 @@ func purgeURL(client *gophercloud.ServiceClient, queueName string) string {`
`47`	`47`	`return client.ServiceURL(apiVersion, apiName, queueName, "purge")`
`48`	`48`	`}`
`49`	`49`
`50`		`-// builds next page full url based on current url`
`51`		`-func nextPageURL(currentURL string, next string) (string, error) {`
`52`		`- base, err := url.Parse(currentURL)`
	`50`	`+// builds next page full url based on service endpoint`
	`51`	`+func nextPageURL(serviceURL string, next string) (string, error) {`
	`52`	`+ base, err := url.Parse(serviceURL)`
`53`	`53`	`if err != nil {`
`54`	`54`	`return "", err`
`55`	`55`	`}`
`56`	`56`	`rel, err := url.Parse(next)`
`57`	`57`	`if err != nil {`
`58`	`58`	`return "", err`
`59`	`59`	`}`
`60`		`- return base.ResolveReference(rel).String(), nil`
	`60`	`+ combined := base.JoinPath(rel.Path)`
	`61`	`+ combined.RawQuery = rel.RawQuery`
	`62`	`+ return combined.String(), nil`
`61`	`63`	`}`