Merge pull request #1245 from tdakkota/fix/respect-array-parameter-se…

…mantic

fix(gen): properly encode optional array parameter

_testdata/positive/parameters.json

@@ -5,6 +5,47 @@
     "version": "0.1.0"
   },
   "paths": {
+    "/optionalArrayParameter": {
+      "get": {
+        "operationId": "optionalArrayParameter",
+        "parameters": [
+          {
+            "name": "query",
+            "in": "query",
+            "required": false,
+            "schema": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            }
+          },
+          {
+            "name": "header",
+            "in": "header",
+            "required": false,
+            "schema": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Ok",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "string"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
     "/objectQueryParameter": {
       "get": {
         "operationId": "objectQueryParameter",

gen/_template/json/encode.tmpl

@@ -63,7 +63,7 @@ if {{ $.Var }}.Set {
 		{{- template "json/enc_array_elems" $ -}}
 	}
 {{- else -}}
-{{ errorf "unexpected nil semantic %s" $t.NilSemantic }}
+	{{ errorf "unexpected nil semantic %s" $t.NilSemantic }}
 {{- end -}}
 {{- end }}
 

gen/_template/uri/encode.tmpl

@@ -7,16 +7,16 @@
 {{- else if $t.IsEnum }}
 	return e.EncodeValue(conv.{{ $t.ToString }}({{ $t.Primitive.String }}({{ $var }})))
 {{- else if $t.IsArray  }}
-	return e.EncodeArray(func(e uri.Encoder) error {
-		for i, item := range {{ $var }} {
-			if err := func() error {
-				{{- template "uri/encode" elem $t.Item "item" }}
-			}(); err != nil {
-				return errors.Wrapf(err, "[%d]", i)
-			}
+	{{- if $t.NilSemantic.Invalid -}}
+		{{- template "uri/encode_array_elems" $ }}
+	{{- else if $t.NilSemantic.Optional -}}
+		if {{ $.Var }} != nil {
+			{{- template "uri/encode_array_elems" $ }}
 		}
 		return nil
-	})
+	{{- else -}}
+		{{ errorf "unexpected nil semantic %s" $t.NilSemantic }}
+	{{- end -}}
 {{- else if $t.IsAlias }}
 	if unwrapped := {{ $t.AliasTo.Go }}({{ $var }}); true {
 		{{- template "uri/encode" elem $t.AliasTo "unwrapped" }}
@@ -38,3 +38,16 @@
 	{{ errorf "unexpected kind %s" $t.Kind }}
 {{- end }}
 {{- end }}
+
+{{- define "uri/encode_array_elems" }}
+return e.EncodeArray(func(e uri.Encoder) error {
+	for i, item := range {{ $.Var }} {
+		if err := func() error {
+			{{- template "uri/encode" elem $.Type.Item "item" }}
+		}(); err != nil {
+			return errors.Wrapf(err, "[%d]", i)
+		}
+	}
+	return nil
+})
+{{- end }}

internal/integration/parameters_test.go

@@ -3,6 +3,8 @@ package integration
 import (
 	"context"
 	"fmt"
+	"io"
+	"net/http"
 	"net/http/httptest"
 	"testing"
 
@@ -15,6 +17,12 @@ import (
 
 type testParameters struct{}
 
+var _ api.Handler = (*testParameters)(nil)
+
+func (s *testParameters) OptionalArrayParameter(ctx context.Context, params api.OptionalArrayParameterParams) (string, error) {
+	return "", nil
+}
+
 func (s *testParameters) ObjectQueryParameter(ctx context.Context, params api.ObjectQueryParameterParams) (*api.ObjectQueryParameterOK, error) {
 	if param, ok := params.FormObject.Get(); ok {
 		return &api.ObjectQueryParameterOK{
@@ -175,3 +183,30 @@ func TestParameters(t *testing.T) {
 		assert.Equal(t, user, resp.Cookie)
 	})
 }
+
+func TestOptionalArrayParameter(t *testing.T) {
+	ctx := context.Background()
+
+	s := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		// Ensure that client does not send these query parameters and headers.
+		if q := r.URL.Query(); q.Has("query") {
+			http.Error(w, "must have not query", http.StatusBadRequest)
+			return
+		}
+		if h := r.Header; len(h.Values("header")) > 0 {
+			http.Error(w, "must have not header", http.StatusBadRequest)
+			return
+		}
+		w.Header().Set("Content-Type", "application/json")
+		w.WriteHeader(200)
+		_, _ = io.WriteString(w, `"ok"`)
+	}))
+	defer s.Close()
+
+	client, err := api.NewClient(s.URL, api.WithClient(s.Client()))
+	require.NoError(t, err)
+
+	resp, err := client.OptionalArrayParameter(ctx, api.OptionalArrayParameterParams{})
+	require.NoError(t, err)
+	require.Equal(t, "ok", resp)
+}