From e0d46ded6cb6974d55a255ab122d1aa6ca0cd60e Mon Sep 17 00:00:00 2001
From: Adriano Sela Aviles <adriano.selaviles@gmail.com>
Date: Sat, 18 May 2024 19:48:07 -0700
Subject: [PATCH] fix(context): verify URL is Non-nil in initQueryCache()
(#3969)
---
context.go | 2 +-
context_test.go | 43 +++++++++++++++++++++++++++++++++++++++++++
2 files changed, 44 insertions(+), 1 deletion(-)
diff --git a/context.go b/context.go
index d2d5497e..baa4b0f9 100644
--- a/context.go
+++ b/context.go
@@ -475,7 +475,7 @@ func (c *Context) QueryArray(key string) (values []string) {
func (c *Context) initQueryCache() {
if c.queryCache == nil {
- if c.Request != nil {
+ if c.Request != nil && c.Request.URL != nil {
c.queryCache = c.Request.URL.Query()
} else {
c.queryCache = url.Values{}
diff --git a/context_test.go b/context_test.go
index b700389a..8bbf2700 100644
--- a/context_test.go
+++ b/context_test.go
@@ -423,6 +423,49 @@ func TestContextQuery(t *testing.T) {
assert.Empty(t, c.PostForm("foo"))
}
+func TestContextInitQueryCache(t *testing.T) {
+ validURL, err := url.Parse("https://github.com/gin-gonic/gin/pull/3969?key=value&otherkey=othervalue")
+ assert.Nil(t, err)
+
+ tests := []struct {
+ testName string
+ testContext *Context
+ expectedQueryCache url.Values
+ }{
+ {
+ testName: "queryCache should remain unchanged if already not nil",
+ testContext: &Context{
+ queryCache: url.Values{"a": []string{"b"}},
+ Request: &http.Request{URL: validURL}, // valid request for evidence that values weren't extracted
+ },
+ expectedQueryCache: url.Values{"a": []string{"b"}},
+ },
+ {
+ testName: "queryCache should be empty when Request is nil",
+ testContext: &Context{Request: nil}, // explicit nil for readability
+ expectedQueryCache: url.Values{},
+ },
+ {
+ testName: "queryCache should be empty when Request.URL is nil",
+ testContext: &Context{Request: &http.Request{URL: nil}}, // explicit nil for readability
+ expectedQueryCache: url.Values{},
+ },
+ {
+ testName: "queryCache should be populated when it not yet populated and Request + Request.URL are non nil",
+ testContext: &Context{Request: &http.Request{URL: validURL}}, // explicit nil for readability
+ expectedQueryCache: url.Values{"key": []string{"value"}, "otherkey": []string{"othervalue"}},
+ },
+ }
+
+ for _, test := range tests {
+ t.Run(test.testName, func(t *testing.T) {
+ test.testContext.initQueryCache()
+ assert.Equal(t, test.expectedQueryCache, test.testContext.queryCache)
+ })
+ }
+
+}
+
func TestContextDefaultQueryOnEmptyRequest(t *testing.T) {
c, _ := CreateTestContext(httptest.NewRecorder()) // here c.Request == nil
assert.NotPanics(t, func() {