shared/api/url: Fix double path encoding issue

Go's net.URL requires Path to be populated with unencoded path and
RawPath to be populated with the hint on how we want Path to be
encoded.

This avoids double path encoding when calling url.EscapedPath(),
which is used in url.String().

Fixes #12398

Signed-off-by: Thomas Parrott <[email protected]>

shared/api/url.go

@@ -32,14 +32,20 @@ func (u *URL) Host(host string) *URL {
 // Path sets the path of the URL from one or more path parts.
 // It appends each of the pathParts (escaped using url.PathEscape) prefixed with "/" to the URL path.
 func (u *URL) Path(pathParts ...string) *URL {
-	var b strings.Builder
+	var path, rawPath strings.Builder
 
 	for _, pathPart := range pathParts {
-		b.WriteString("/") // Build an absolute URL.
-		b.WriteString(url.PathEscape(pathPart))
+		// Generate unencoded path.
+		path.WriteString("/") // Build an absolute URL.
+		path.WriteString(pathPart)
+
+		// Generate encoded path hint (this will be used by u.URL.EncodedPath() to decide its methodology).
+		rawPath.WriteString("/") // Build an absolute URL.
+		rawPath.WriteString(url.PathEscape(pathPart))
 	}
 
-	u.URL.Path = b.String()
+	u.URL.Path = path.String()
+	u.URL.RawPath = rawPath.String()
 
 	return u
 }

shared/api/url_test.go

@@ -6,19 +6,19 @@ import (
 
 func ExampleURL() {
 	u := NewURL()
-	fmt.Println(u.Path("1.0", "networks", "name-with-/-in-it"))
+	fmt.Println(u.Path("1.0", "networks", "name-with-/-in-it").String())
 	fmt.Println(u.Project("default"))
 	fmt.Println(u.Project("project-with-%-in-it"))
 	fmt.Println(u.Target(""))
 	fmt.Println(u.Target("member-with-%-in-it"))
 	fmt.Println(u.Host("example.com"))
 	fmt.Println(u.Scheme("https"))
 
-	// Output: /1.0/networks/name-with-%252F-in-it
-	// /1.0/networks/name-with-%252F-in-it
-	// /1.0/networks/name-with-%252F-in-it?project=project-with-%25-in-it
-	// /1.0/networks/name-with-%252F-in-it?project=project-with-%25-in-it
-	// /1.0/networks/name-with-%252F-in-it?project=project-with-%25-in-it&target=member-with-%25-in-it
-	// //example.com/1.0/networks/name-with-%252F-in-it?project=project-with-%25-in-it&target=member-with-%25-in-it
-	// https://example.com/1.0/networks/name-with-%252F-in-it?project=project-with-%25-in-it&target=member-with-%25-in-it
+	// Output: /1.0/networks/name-with-%2F-in-it
+	// /1.0/networks/name-with-%2F-in-it
+	// /1.0/networks/name-with-%2F-in-it?project=project-with-%25-in-it
+	// /1.0/networks/name-with-%2F-in-it?project=project-with-%25-in-it
+	// /1.0/networks/name-with-%2F-in-it?project=project-with-%25-in-it&target=member-with-%25-in-it
+	// //example.com/1.0/networks/name-with-%2F-in-it?project=project-with-%25-in-it&target=member-with-%25-in-it
+	// https://example.com/1.0/networks/name-with-%2F-in-it?project=project-with-%25-in-it&target=member-with-%25-in-it
 }