Skip to content

fix: use RequiresNilCheck for all params #2263

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mromaszewicz merged 1 commit into from
Mar 2, 2026
+354 −4
Merged

fix: use RequiresNilCheck for all params #2263

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions internal/test/issues/issue-2238/config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
package: issue2238
generate:
models: true
client: true
output-options:
prefer-skip-optional-pointer: true
output: issue2238.gen.go
3 changes: 3 additions & 0 deletions internal/test/issues/issue-2238/generate.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
262 changes: 262 additions & 0 deletions internal/test/issues/issue-2238/issue2238.gen.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

56 changes: 56 additions & 0 deletions internal/test/issues/issue-2238/issue2238_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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)
})
}
22 changes: 22 additions & 0 deletions internal/test/issues/issue-2238/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
8 changes: 4 additions & 4 deletions pkg/codegen/templates/client.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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}}
Expand All @@ -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}}
Expand All @@ -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 */}}
Expand Down