Skip to content
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.

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

fix: avoid shadowed variable on operationv3 #1680

Merged
merged 1 commit into from
Nov 7, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
12 changes: 7 additions & 5 deletions operationv3.go
Original file line number Diff line number Diff line change
Expand Up @@ -388,27 +388,29 @@ func (o *OperationV3) ParseParamComment(commentLine string, astFile *ast.File) e
continue
}

itemParam := param // Avoid shadowed variable which could cause side effects to o.Operation.Parameters

switch {
case prop.Type[0] == ARRAY &&
prop.Items.Schema != nil &&
len(prop.Items.Schema.Spec.Type) > 0 &&
IsSimplePrimitiveType(prop.Items.Schema.Spec.Type[0]):

param = createParameterV3(paramType, prop.Description, name, prop.Type[0], prop.Items.Schema.Spec.Type[0], findInSlice(schema.Spec.Required, name), enums, o.parser.collectionFormatInQuery)
itemParam = createParameterV3(paramType, prop.Description, name, prop.Type[0], prop.Items.Schema.Spec.Type[0], findInSlice(schema.Spec.Required, name), enums, o.parser.collectionFormatInQuery)

case IsSimplePrimitiveType(prop.Type[0]):
param = createParameterV3(paramType, prop.Description, name, PRIMITIVE, prop.Type[0], findInSlice(schema.Spec.Required, name), enums, o.parser.collectionFormatInQuery)
itemParam = createParameterV3(paramType, prop.Description, name, PRIMITIVE, prop.Type[0], findInSlice(schema.Spec.Required, name), enums, o.parser.collectionFormatInQuery)
default:
o.parser.debug.Printf("skip field [%s] in %s is not supported type for %s", name, refType, paramType)

continue
}

param.Schema.Spec = prop
itemParam.Schema.Spec = prop

listItem := &spec.RefOrSpec[spec.Extendable[spec.Parameter]]{
Spec: &spec.Extendable[spec.Parameter]{
Spec: &param,
Spec: &itemParam,
},
}

Expand Down Expand Up @@ -710,7 +712,7 @@ func (o *OperationV3) parseAPIObjectSchema(commentLine, schemaType, refType stri

result := spec.NewSchemaSpec()
result.Spec.Type = spec.NewSingleOrArray("array")
result.Spec.Items = spec.NewBoolOrSchema(false, schema) //TODO: allowed?
result.Spec.Items = spec.NewBoolOrSchema(false, schema) // TODO: allowed?
return result, nil

default:
Expand Down
90 changes: 90 additions & 0 deletions operationv3_test.go
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package swag

import (
"go/ast"
goparser "go/parser"
"go/token"
"testing"
Expand Down Expand Up @@ -852,6 +853,95 @@ func TestOperation_ParseParamCommentV3(t *testing.T) {
}
})

t.Run("struct queries", func(t *testing.T) {
t.Parallel()
parser := New()
parser.packages.uniqueDefinitions["main.Object"] = &TypeSpecDef{
File: &ast.File{Name: &ast.Ident{Name: "test"}},
TypeSpec: &ast.TypeSpec{
Name: &ast.Ident{Name: "Field"},
TypeParams: &ast.FieldList{List: []*ast.Field{{Names: []*ast.Ident{{Name: "T"}}}}},
Type: &ast.StructType{
Struct: 100,
Fields: &ast.FieldList{
List: []*ast.Field{
{
Names: []*ast.Ident{
{Name: "T"},
},
Type: ast.NewIdent("string"),
},
{
Names: []*ast.Ident{
{Name: "T2"},
},
Type: ast.NewIdent("string"),
},
},
},
},
},
}
o := NewOperationV3(parser)
err := o.ParseComment(`@Param some_object query main.Object true "Some Object"`,
nil)

assert.NoError(t, err)

expectedT := &spec.RefOrSpec[spec.Extendable[spec.Parameter]]{
Spec: &spec.Extendable[spec.Parameter]{
Spec: &spec.Parameter{
Name: "t",
In: "query",
Schema: &spec.RefOrSpec[spec.Schema]{
Spec: &spec.Schema{
JsonSchema: spec.JsonSchema{
JsonSchemaCore: spec.JsonSchemaCore{
Type: typeString,
},
},
},
},
},
},
}
expectedT2 := &spec.RefOrSpec[spec.Extendable[spec.Parameter]]{
Spec: &spec.Extendable[spec.Parameter]{
Spec: &spec.Parameter{
Name: "t2",
In: "query",
Schema: &spec.RefOrSpec[spec.Schema]{
Spec: &spec.Schema{
JsonSchema: spec.JsonSchema{
JsonSchemaCore: spec.JsonSchemaCore{
Type: typeString,
},
},
},
},
},
},
}

assert.Len(t, o.Parameters, 2)
tFound := false
t2Found := false
for _, param := range o.Parameters {
switch param.Spec.Spec.Name {
case "t":
assert.EqualValues(t, expectedT, param)
tFound = true
case "t2":
assert.EqualValues(t, expectedT2, param)
t2Found = true
default:
assert.Fail(t, "unexpected result")
}
}

assert.True(t, tFound, "results should contain t")
assert.True(t, t2Found, "results should contain t2")
})
}

// Test ParseParamComment Query Params
Expand Down