fix: use RequiresNilCheck for all params (#2263)

mromaszewicz · claude · web-flow · commit c966b373e95f · 2026-03-02T06:16:57.000-08:00
PR #2237 fixed query parameters to use RequiresNilCheck instead of HasOptionalPointer for nil-check guards, but the same bug remained in the header and cookie parameter sections of client.tmpl. This caused optional array params (e.g. []string) to be sent even when nil, because prefer-skip-optional-pointer removes the pointer wrapper and HasOptionalPointer returns false, skipping the nil check entirely. Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
diff --git a/internal/test/issues/issue-2238/config.yaml b/internal/test/issues/issue-2238/config.yaml
@@ -0,0 +1,7 @@
+package: issue2238
+generate:
+  models: true
+  client: true
+output-options:
+  prefer-skip-optional-pointer: true
+output: issue2238.gen.go
diff --git a/internal/test/issues/issue-2238/generate.go b/internal/test/issues/issue-2238/generate.go
@@ -0,0 +1,3 @@
+package issue2238
+
+//go:generate go run github.com/oapi-codegen/oapi-codegen/v2/cmd/oapi-codegen --config=config.yaml openapi.yaml
diff --git a/internal/test/issues/issue-2238/issue2238.gen.go b/internal/test/issues/issue-2238/issue2238.gen.go
diff --git a/internal/test/issues/issue-2238/issue2238_test.go b/internal/test/issues/issue-2238/issue2238_test.go
@@ -0,0 +1,56 @@
+package issue2238
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+func TestNewGetTestRequest(t *testing.T) {
+	t.Run("nil header array param is not sent", func(t *testing.T) {
+		params := GetTestParams{
+			XTags: nil,
+		}
+
+		req, err := NewGetTestRequest("https://localhost", &params)
+		require.NoError(t, err)
+
+		assert.Empty(t, req.Header.Values("X-Tags"))
+	})
+
+	t.Run("non-nil header array param is sent", func(t *testing.T) {
+		params := GetTestParams{
+			XTags: []string{"a", "b"},
+		}
+
+		req, err := NewGetTestRequest("https://localhost", &params)
+		require.NoError(t, err)
+
+		assert.NotEmpty(t, req.Header.Values("X-Tags"))
+	})
+
+	t.Run("nil cookie array param is not sent", func(t *testing.T) {
+		params := GetTestParams{
+			Tags: nil,
+		}
+
+		req, err := NewGetTestRequest("https://localhost", &params)
+		require.NoError(t, err)
+
+		assert.Empty(t, req.Cookies())
+	})
+
+	t.Run("non-nil cookie array param is sent", func(t *testing.T) {
+		params := GetTestParams{
+			Tags: []string{"a", "b"},
+		}
+
+		req, err := NewGetTestRequest("https://localhost", &params)
+		require.NoError(t, err)
+
+		cookies := req.Cookies()
+		require.Len(t, cookies, 1)
+		assert.Equal(t, "tags", cookies[0].Name)
+	})
+}
diff --git a/internal/test/issues/issue-2238/openapi.yaml b/internal/test/issues/issue-2238/openapi.yaml
@@ -0,0 +1,22 @@
+openapi: "3.0.0"
+info:
+  version: 1.0.0
+  title: Issue 2238
+paths:
+  /test:
+    get:
+      parameters:
+        - name: X-Tags
+          in: header
+          schema:
+            type: array
+            items:
+              type: string
+          required: false
+        - name: tags
+          in: cookie
+          schema:
+            type: array
+            items:
+              type: string
+          required: false
diff --git a/pkg/codegen/templates/client.tmpl b/pkg/codegen/templates/client.tmpl
@@ -236,7 +236,7 @@ func New{{$opid}}Request{{if .HasBody}}WithBody{{end}}(server string{{genParamAr
 {{ if .HeaderParams }}
     if params != nil {
     {{range $paramIdx, $param := .HeaderParams}}
-        {{if .HasOptionalPointer}} if params.{{.GoName}} != nil { {{end}}
+        {{if .RequiresNilCheck}} if params.{{.GoName}} != nil { {{end}}
         var headerParam{{$paramIdx}} string
         {{if .IsPassThrough}}
         headerParam{{$paramIdx}} = {{if .HasOptionalPointer}}*{{end}}params.{{.GoName}}
@@ -256,15 +256,15 @@ func New{{$opid}}Request{{if .HasBody}}WithBody{{end}}(server string{{genParamAr
         }
         {{end}}
         req.Header.Set("{{.ParamName}}", headerParam{{$paramIdx}})
-        {{if .HasOptionalPointer}}}{{end}}
+        {{if .RequiresNilCheck}}}{{end}}
     {{end}}
     }
 {{- end }}{{/* if .HeaderParams */}}
 
 {{ if .CookieParams }}
     if params != nil {
     {{range $paramIdx, $param := .CookieParams}}
-        {{if .HasOptionalPointer}} if params.{{.GoName}} != nil { {{end}}
+        {{if .RequiresNilCheck}} if params.{{.GoName}} != nil { {{end}}
         var cookieParam{{$paramIdx}} string
         {{if .IsPassThrough}}
         cookieParam{{$paramIdx}} = {{if .HasOptionalPointer}}*{{end}}params.{{.GoName}}
@@ -288,7 +288,7 @@ func New{{$opid}}Request{{if .HasBody}}WithBody{{end}}(server string{{genParamAr
             Value:cookieParam{{$paramIdx}},
         }
         req.AddCookie(cookie{{$paramIdx}})
-        {{if .HasOptionalPointer}}}{{end}}
+        {{if .RequiresNilCheck}}}{{end}}
     {{ end -}}
     }
 {{- end }}{{/* if .CookieParams */}}

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+package issue2238`
	`2`	`+`
	`3`	`+//go:generate go run github.com/oapi-codegen/oapi-codegen/v2/cmd/oapi-codegen --config=config.yaml openapi.yaml`