Skip to content

fix: keep every enum value when a deduplicated name collides with another #2669

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

Open
56steve wants to merge 1 commit into
base: main
Choose a base branch
from
+62 −5
Open

fix: keep every enum value when a deduplicated name collides with another #2669

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
31 changes: 26 additions & 5 deletions pkg/codegen/utils.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -912,18 +912,39 @@ func SanitizeEnumNames(enumNames, enumValues []string) map[string]string {
dupCheck[n] = 0
}

sanitizedNames := make([]string, len(deDup))
reserved := make(map[string]struct{}, len(deDup))
for i, p := range deDup {
sanitizedNames[i] = SanitizeGoIdentity(SchemaNameToTypeName(p[0]))
reserved[sanitizedNames[i]] = struct{}{}
}

dupCheck = make(map[string]int, len(deDup))
sanitizedDeDup := make(map[string]string, len(deDup))

for _, p := range deDup {
n, v := p[0], p[1]
sanitized := SanitizeGoIdentity(SchemaNameToTypeName(n))
for i, p := range deDup {
v := p[1]
sanitized := sanitizedNames[i]

if _, dup := dupCheck[sanitized]; !dup {
sanitizedDeDup[sanitized] = v
} else {
sanitizedDeDup[sanitized+strconv.Itoa(dupCheck[sanitized])] = v
dupCheck[sanitized] = 1
continue
}

// Append a numeric suffix, skipping any name another value already
// owns so that a suffixed name never overwrites a different value.
candidate := sanitized + strconv.Itoa(dupCheck[sanitized])
for {
_, isReserved := reserved[candidate]
_, isUsed := sanitizedDeDup[candidate]
if !isReserved && !isUsed {
break
}
dupCheck[sanitized]++
candidate = sanitized + strconv.Itoa(dupCheck[sanitized])
}
sanitizedDeDup[candidate] = v
dupCheck[sanitized]++
}

Expand Down
36 changes: 36 additions & 0 deletions pkg/codegen/utils_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1259,3 +1259,39 @@ paths:
})
require.NoError(t, err)
}

func TestSanitizeEnumNames_NumericSuffixDoesNotCollide(t *testing.T) {
tests := []struct {
name string
values []string
want map[string]string
}{
{
name: "no collisions keep their names",
values: []string{"a", "A", "b"},
want: map[string]string{"A": "a", "A1": "A", "B": "b"},
},
{
name: "deduplicated name does not overwrite a later value",
values: []string{"A", "a", "A1"},
want: map[string]string{"A": "A", "A2": "a", "A1": "A1"},
},
{
name: "deduplicated name does not overwrite an earlier value",
values: []string{"A", "A1", "a"},
want: map[string]string{"A": "A", "A1": "A1", "A2": "a"},
},
{
name: "several duplicates around an explicit suffixed value",
values: []string{"a", "A", "A1", "_a"},
want: map[string]string{"A": "a", "A2": "A", "A1": "A1", "UnderscoreA": "_a"},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
got := SanitizeEnumNames(nil, tt.values)
assert.Equal(t, tt.want, got)
assert.Len(t, got, len(tt.values), "every enum value must keep its own constant name")
})
}
}
Loading