fix(goctl): recurse into inline struct in IsTagMember (#5671)

Co-authored-by: kevin <wanjunfeng@gmail.com>

tools/goctl/api/spec/fn.go

@@ -139,18 +139,43 @@ func (m Member) IsFormMember() bool {
 	return false
 }
 
-// IsTagMember returns true if contains given tag
+// IsTagMember returns true if the member contains the given tag.
+// For inline members, it recursively checks the members of the referenced
+// struct, since inline members themselves carry no tag and any matching tag
+// must live on one of their children. This avoids spuriously reporting the
+// presence of a tag (e.g. `header`) for an inline struct whose children do
+// not actually use that tag. See go-zero #4800.
 func (m Member) IsTagMember(tagKey string) bool {
-	if m.IsInline {
-		return true
-	}
-
 	tags := m.Tags()
 	for _, tag := range tags {
 		if tag.Key == tagKey {
 			return true
 		}
 	}
+	if m.IsInline {
+		return typeContainsTag(m.Type, tagKey)
+	}
+	return false
+}
+
+func typeContainsTag(tp Type, tagKey string) bool {
+	var members []Member
+	switch v := tp.(type) {
+	case DefineStruct:
+		members = v.Members
+	case NestedStruct:
+		members = v.Members
+	case PointerType:
+		return typeContainsTag(v.Type, tagKey)
+	default:
+		return false
+	}
+
+	for _, child := range members {
+		if child.IsTagMember(tagKey) {
+			return true
+		}
+	}
 	return false
 }
 

tools/goctl/api/spec/fn_test.go

@@ -0,0 +1,167 @@
+package spec
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestMember_IsTagMember(t *testing.T) {
+	t.Run("non-inline member with matching tag returns true", func(t *testing.T) {
+		m := Member{Tag: `header:"Authorization"`}
+		assert.True(t, m.IsTagMember("header"))
+	})
+
+	t.Run("non-inline member without matching tag returns false", func(t *testing.T) {
+		m := Member{Tag: `json:"username"`}
+		assert.False(t, m.IsTagMember("header"))
+		assert.False(t, m.IsTagMember("path"))
+		assert.False(t, m.IsTagMember("form"))
+	})
+
+	t.Run("non-inline member without any tag returns false", func(t *testing.T) {
+		m := Member{}
+		assert.False(t, m.IsTagMember("header"))
+	})
+
+	t.Run("inline struct without matching child tag returns false (#4800)", func(t *testing.T) {
+		m := Member{
+			Name:     "Pagination",
+			IsInline: true,
+			Type: DefineStruct{
+				RawName: "Pagination",
+				Members: []Member{
+					{Name: "Page", Tag: `json:"page"`},
+					{Name: "PageSize", Tag: `json:"pageSize"`},
+				},
+			},
+		}
+		assert.False(t, m.IsTagMember("header"))
+		assert.False(t, m.IsTagMember("path"))
+		assert.False(t, m.IsTagMember("form"))
+	})
+
+	t.Run("inline struct whose child has matching tag returns true", func(t *testing.T) {
+		m := Member{
+			Name:     "Auth",
+			IsInline: true,
+			Type: DefineStruct{
+				RawName: "Auth",
+				Members: []Member{
+					{Name: "Token", Tag: `header:"Authorization"`},
+				},
+			},
+		}
+		assert.True(t, m.IsTagMember("header"))
+	})
+
+	t.Run("nested inline structs are recursed", func(t *testing.T) {
+		m := Member{
+			Name:     "Outer",
+			IsInline: true,
+			Type: DefineStruct{
+				RawName: "Outer",
+				Members: []Member{
+					{
+						Name:     "Inner",
+						IsInline: true,
+						Type: DefineStruct{
+							RawName: "Inner",
+							Members: []Member{
+								{Name: "Token", Tag: `header:"X-Token"`},
+							},
+						},
+					},
+				},
+			},
+		}
+		assert.True(t, m.IsTagMember("header"))
+	})
+
+	t.Run("nested inline structs without matching child return false", func(t *testing.T) {
+		m := Member{
+			Name:     "Outer",
+			IsInline: true,
+			Type: DefineStruct{
+				RawName: "Outer",
+				Members: []Member{
+					{
+						Name:     "Inner",
+						IsInline: true,
+						Type: DefineStruct{
+							RawName: "Inner",
+							Members: []Member{
+								{Name: "Page", Tag: `json:"page"`},
+							},
+						},
+					},
+				},
+			},
+		}
+		assert.False(t, m.IsTagMember("header"))
+	})
+
+	t.Run("inline NestedStruct whose child has matching tag returns true", func(t *testing.T) {
+		m := Member{
+			Name:     "Auth",
+			IsInline: true,
+			Type: NestedStruct{
+				RawName: "Auth",
+				Members: []Member{
+					{Name: "Token", Tag: `header:"Authorization"`},
+				},
+			},
+		}
+		assert.True(t, m.IsTagMember("header"))
+	})
+
+	t.Run("inline PointerType whose child has matching tag returns true", func(t *testing.T) {
+		m := Member{
+			Name:     "Auth",
+			IsInline: true,
+			Type: PointerType{
+				RawName: "*Auth",
+				Type: DefineStruct{
+					RawName: "Auth",
+					Members: []Member{
+						{Name: "Token", Tag: `header:"Authorization"`},
+					},
+				},
+			},
+		}
+		assert.True(t, m.IsTagMember("header"))
+		assert.False(t, m.IsTagMember("path"))
+	})
+
+	t.Run("empty inline struct returns false", func(t *testing.T) {
+		m := Member{
+			Name:     "Empty",
+			IsInline: true,
+			Type:     DefineStruct{RawName: "Empty"},
+		}
+		assert.False(t, m.IsTagMember("header"))
+	})
+}
+
+func TestDefineStruct_GetTagMembers_InlineRegression(t *testing.T) {
+	s := DefineStruct{
+		RawName: "QueryUserListReq",
+		Members: []Member{
+			{Name: "Username", Tag: `json:"username,optional"`},
+			{
+				Name:     "Pagination",
+				IsInline: true,
+				Type: DefineStruct{
+					RawName: "Pagination",
+					Members: []Member{
+						{Name: "Page", Tag: `json:"page"`},
+						{Name: "PageSize", Tag: `json:"pageSize"`},
+					},
+				},
+			},
+		},
+	}
+	assert.Empty(t, s.GetTagMembers("header"),
+		"inline struct without header-tagged children must not match header (#4800)")
+	assert.Empty(t, s.GetTagMembers("path"))
+}