🐛 bug: Respect DisablePathNormalizing during client requests (#3773)

Author: gaby

client/client.go

@@ -55,9 +55,10 @@ type Client struct {
 	userResponseHooks    []ResponseHook
 	builtinResponseHooks []ResponseHook
 
-	timeout time.Duration
-	mu      sync.RWMutex
-	debug   bool
+	timeout                time.Duration
+	mu                     sync.RWMutex
+	debug                  bool
+	disablePathNormalizing bool
 }
 
 // R creates a new Request associated with the client.
@@ -353,6 +354,17 @@ func (c *Client) SetReferer(r string) *Client {
 	return c
 }
 
+// DisablePathNormalizing reports whether path normalizing is disabled for the client.
+func (c *Client) DisablePathNormalizing() bool {
+	return c.disablePathNormalizing
+}
+
+// SetDisablePathNormalizing configures the client to disable or enable path normalizing.
+func (c *Client) SetDisablePathNormalizing(disable bool) *Client {
+	c.disablePathNormalizing = disable
+	return c
+}
+
 // PathParam returns the value of the specified path parameter. Returns an empty string if it does not exist.
 func (c *Client) PathParam(key string) string {
 	if val, ok := (*c.path)[key]; ok {
@@ -529,6 +541,7 @@ func (c *Client) Reset() {
 	c.referer = ""
 	c.retryConfig = nil
 	c.debug = false
+	c.disablePathNormalizing = false
 
 	if c.cookieJar != nil {
 		c.cookieJar.Release()
@@ -545,18 +558,19 @@ func (c *Client) Reset() {
 // JSON is used as the default serialization mechanism. The priority is:
 // Body > FormData > File.
 type Config struct {
-	Ctx          context.Context //nolint:containedctx // It's needed to be stored in the config.
-	Body         any
-	Header       map[string]string
-	Param        map[string]string
-	Cookie       map[string]string
-	PathParam    map[string]string
-	FormData     map[string]string
-	UserAgent    string
-	Referer      string
-	File         []*File
-	Timeout      time.Duration
-	MaxRedirects int
+	Ctx                    context.Context //nolint:containedctx // It's needed to be stored in the config.
+	Body                   any
+	Header                 map[string]string
+	Param                  map[string]string
+	Cookie                 map[string]string
+	PathParam              map[string]string
+	FormData               map[string]string
+	UserAgent              string
+	Referer                string
+	File                   []*File
+	Timeout                time.Duration
+	MaxRedirects           int
+	DisablePathNormalizing bool
 }
 
 // setConfigToRequest sets the parameters passed via Config to the Request.
@@ -602,6 +616,10 @@ func setConfigToRequest(req *Request, config ...Config) {
 		req.SetMaxRedirects(cfg.MaxRedirects)
 	}
 
+	if cfg.DisablePathNormalizing {
+		req.SetDisablePathNormalizing(true)
+	}
+
 	if cfg.Body != nil {
 		req.SetJSON(cfg.Body)
 		return

client/hooks.go

@@ -93,7 +93,12 @@ func parserRequestURL(c *Client, req *Request) error {
 	}
 
 	// Set the URI in the raw request.
+	disablePathNormalizing := c.DisablePathNormalizing() || req.DisablePathNormalizing()
 	req.RawRequest.SetRequestURI(uri)
+	req.RawRequest.URI().DisablePathNormalizing = disablePathNormalizing
+	if disablePathNormalizing {
+		req.RawRequest.URI().SetPathBytes(req.RawRequest.URI().PathOriginal())
+	}
 
 	// Merge query parameters.
 	hashSplit := strings.Split(splitURL[1], "#")

client/hooks_test.go

@@ -207,6 +207,37 @@ func Test_Parser_Request_URL(t *testing.T) {
 		require.True(t, flag2)
 		require.True(t, flag3)
 	})
+
+	t.Run("request disable path normalizing should be respected", func(t *testing.T) {
+		t.Parallel()
+		client := New()
+		req := AcquireRequest().
+			SetURL("https://example.my.host/other.host%2Fpath%2Fto%2Fdata%23123").
+			SetDisablePathNormalizing(true)
+
+		t.Cleanup(func() {
+			ReleaseRequest(req)
+		})
+
+		err := parserRequestURL(client, req)
+		require.NoError(t, err)
+		require.Equal(t, "https://example.my.host/other.host%2Fpath%2Fto%2Fdata%23123", req.RawRequest.URI().String())
+	})
+
+	t.Run("client disable path normalizing should be respected", func(t *testing.T) {
+		t.Parallel()
+		client := New().SetDisablePathNormalizing(true)
+		req := AcquireRequest().
+			SetURL("https://example.my.host/other.host%2Fpath%2Fto%2Fdata%23123")
+
+		t.Cleanup(func() {
+			ReleaseRequest(req)
+		})
+
+		err := parserRequestURL(client, req)
+		require.NoError(t, err)
+		require.Equal(t, "https://example.my.host/other.host%2Fpath%2Fto%2Fdata%23123", req.RawRequest.URI().String())
+	})
 }
 
 func Test_Parser_Request_Header(t *testing.T) {

client/request.go

@@ -68,6 +68,8 @@ type Request struct {
 	maxRedirects int
 
 	bodyType bodyType
+
+	disablePathNormalizing bool
 }
 
 // Method returns the HTTP method set in the Request.
@@ -605,6 +607,18 @@ func (r *Request) SetMaxRedirects(count int) *Request {
 	return r
 }
 
+// DisablePathNormalizing reports whether path normalizing is disabled for the Request.
+func (r *Request) DisablePathNormalizing() bool {
+	return r.disablePathNormalizing
+}
+
+// SetDisablePathNormalizing configures the Request to disable or enable path normalizing.
+func (r *Request) SetDisablePathNormalizing(disable bool) *Request {
+	r.disablePathNormalizing = disable
+	r.RawRequest.URI().DisablePathNormalizing = disable
+	return r
+}
+
 // checkClient ensures that a Client is set. If none is set, it defaults to the global defaultClient.
 func (r *Request) checkClient() {
 	if r.client == nil {
@@ -671,6 +685,7 @@ func (r *Request) Reset() {
 	r.maxRedirects = 0
 	r.bodyType = noBody
 	r.boundary = boundary
+	r.disablePathNormalizing = false
 
 	for len(r.files) != 0 {
 		t := r.files[0]