Skip to content

Fix endless recursion when traversing recursive types. #48

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
jake-volvo wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix endless recursion when traversing recursive types. #48

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
2 changes: 1 addition & 1 deletion internal/method/resolver.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ func NewResolveReferences(traverser *xptypes.Traverser, receiver, clientPath, re
Field: refProcessor,
Named: xptypes.NamedProcessorChain{},
}
if err := traverser.Traverse(n, cfg); err != nil {
if err := traverser.Traverse(n, cfg, []*types.Named{}); err != nil {
panic(errors.Wrapf(err, "cannot traverse the type tree of %s", n.Obj().Name()))
}
refs := refProcessor.GetReferences()
Expand Down
16 changes: 11 additions & 5 deletions internal/types/types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,8 +86,14 @@ type Traverser struct {
// constructing an error. But we keep that for future type and field processors.

// Traverse traverser given type recursively and runs given processors.
func (t *Traverser) Traverse(n *types.Named, cfg *ProcessorConfig, parentFields ...string) error { // nolint:gocyclo
func (t *Traverser) Traverse(n *types.Named, cfg *ProcessorConfig, visited []*types.Named, parentFields ...string) error { // nolint:gocyclo
// NOTE(muvaf): gocyclo is disabled due to repeated type checks.
for _, v := range visited {
if n == v {
return nil
}
}
visited = append(visited, n)
if err := cfg.Named.Process(n, t.comments.For(n.Obj())); err != nil {
return errors.Wrapf(err, "type processors failed to run for type %s", n.Obj().Name())
}
Expand All @@ -103,24 +109,24 @@ func (t *Traverser) Traverse(n *types.Named, cfg *ProcessorConfig, parentFields
}
switch ft := field.Type().(type) {
case *types.Named:
if err := t.Traverse(ft, cfg, append(parentFields, field.Name())...); err != nil {
if err := t.Traverse(ft, cfg, visited, append(parentFields, field.Name())...); err != nil {
return errors.Wrapf(err, "failed to traverse type of field %s", field.Name())
}
case *types.Pointer:
if elemType, ok := ft.Elem().(*types.Named); ok {
if err := t.Traverse(elemType, cfg, append(parentFields, "*"+field.Name())...); err != nil {
if err := t.Traverse(elemType, cfg, visited, append(parentFields, "*"+field.Name())...); err != nil {
return errors.Wrapf(err, "failed to traverse type of field %s", field.Name())
}
}
case *types.Slice:
switch elemType := ft.Elem().(type) {
case *types.Named:
if err := t.Traverse(elemType, cfg, append(parentFields, "[]"+field.Name())...); err != nil {
if err := t.Traverse(elemType, cfg, visited, append(parentFields, "[]"+field.Name())...); err != nil {
return errors.Wrapf(err, "failed to traverse type of field %s", field.Name())
}
case *types.Pointer:
if elemElemType, ok := elemType.Elem().(*types.Named); ok {
if err := t.Traverse(elemElemType, cfg, append(parentFields, "[]"+"*"+field.Name())...); err != nil {
if err := t.Traverse(elemElemType, cfg, visited, append(parentFields, "[]"+"*"+field.Name())...); err != nil {
return errors.Wrapf(err, "failed to traverse type of field %s", field.Name())
}
}
Expand Down