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 incorrect return type in Walker.normalize_ast #75

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

apiology
Copy link

As of Solargraph 0.51.0, I started hitting exceptions from walker.rb like this:

[WARN] wrong number of arguments (given 3, expected 1..2)
.../solargraph-rails/lib/solargraph/rails/walker.rb:78:in `initialize'
/Users/broz/src/solargraph-rails/lib/solargraph/rails/walker.rb:67:in `new'
/Users/broz/src/solargraph-rails/lib/solargraph/rails/walker.rb:67:in `from_source'
/Users/broz/src/solargraph-rails/lib/solargraph/rails/model.rb:15:in `process'
/Users/broz/src/solargraph-rails/lib/solargraph-rails.rb:48:in `block in local'
/Users/broz/src/solargraph-rails/lib/solargraph-rails.rb:61:in `run_feature'
/Users/broz/src/solargraph-rails/lib/solargraph-rails.rb:48:in `local'
/Users/broz/.rbenv/versions/3.1.6/lib/ruby/gems/3.1.0/gems/solargraph-0.51.0/lib/solargraph/convention.rb:28:in `block in for_local'
/Users/broz/.rbenv/versions/3.1.6/lib/ruby/3.1.0/set.rb:511:in `each_key'
/Users/broz/.rbenv/versions/3.1.6/lib/ruby/3.1.0/set.rb:511:in `each'
/Users/broz/.rbenv/versions/3.1.6/lib/ruby/gems/3.1.0/gems/solargraph-0.51.0/lib/solargraph/convention.rb:27:in `for_local'
/Users/broz/.rbenv/versions/3.1.6/lib/ruby/gems/3.1.0/gems/solargraph-0.51.0/lib/solargraph/source_map.rb:32:in `initialize'
/Users/broz/.rbenv/versions/3.1.6/lib/ruby/gems/3.1.0/gems/solargraph-0.51.0/lib/solargraph/source_map.rb:158:in `new'
/Users/broz/.rbenv/versions/3.1.6/lib/ruby/gems/3.1.0/gems/solargraph-0.51.0/lib/solargraph/source_map.rb:158:in `map'
/Users/broz/.rbenv/versions/3.1.6/lib/ruby/gems/3.1.0/gems/solargraph-0.51.0/lib/solargraph/api_map.rb:54:in `map'
/Users/broz/src/solargraph-rails/spec/helpers.rb:4:in `load_string'
/Users/broz/src/solargraph-rails/spec/solargraph-rails/model_spec.rb:80:in `block (3 levels) in <top (required)>'

It looks like it happens in cases where Solargraph's source.node is a ::Parser::AST::Node. There's a special case in Walker.normalize_ast() that is triggering that does not look correct on its face - it should always return an array of nodes, since the result is splatted in Walker.from_source.

The spec added reproduces this in newer solargraphs.

As of Solargraph 0.51.0, I started hitting exceptions from walker.rb like this:

```
[WARN] wrong number of arguments (given 3, expected 1..2)
.../solargraph-rails/lib/solargraph/rails/walker.rb:78:in `initialize'
/Users/broz/src/solargraph-rails/lib/solargraph/rails/walker.rb:67:in `new'
/Users/broz/src/solargraph-rails/lib/solargraph/rails/walker.rb:67:in `from_source'
/Users/broz/src/solargraph-rails/lib/solargraph/rails/model.rb:15:in `process'
/Users/broz/src/solargraph-rails/lib/solargraph-rails.rb:48:in `block in local'
/Users/broz/src/solargraph-rails/lib/solargraph-rails.rb:61:in `run_feature'
/Users/broz/src/solargraph-rails/lib/solargraph-rails.rb:48:in `local'
/Users/broz/.rbenv/versions/3.1.6/lib/ruby/gems/3.1.0/gems/solargraph-0.51.0/lib/solargraph/convention.rb:28:in `block in for_local'
/Users/broz/.rbenv/versions/3.1.6/lib/ruby/3.1.0/set.rb:511:in `each_key'
/Users/broz/.rbenv/versions/3.1.6/lib/ruby/3.1.0/set.rb:511:in `each'
/Users/broz/.rbenv/versions/3.1.6/lib/ruby/gems/3.1.0/gems/solargraph-0.51.0/lib/solargraph/convention.rb:27:in `for_local'
/Users/broz/.rbenv/versions/3.1.6/lib/ruby/gems/3.1.0/gems/solargraph-0.51.0/lib/solargraph/source_map.rb:32:in `initialize'
/Users/broz/.rbenv/versions/3.1.6/lib/ruby/gems/3.1.0/gems/solargraph-0.51.0/lib/solargraph/source_map.rb:158:in `new'
/Users/broz/.rbenv/versions/3.1.6/lib/ruby/gems/3.1.0/gems/solargraph-0.51.0/lib/solargraph/source_map.rb:158:in `map'
/Users/broz/.rbenv/versions/3.1.6/lib/ruby/gems/3.1.0/gems/solargraph-0.51.0/lib/solargraph/api_map.rb:54:in `map'
/Users/broz/src/solargraph-rails/spec/helpers.rb:4:in `load_string'
/Users/broz/src/solargraph-rails/spec/solargraph-rails/model_spec.rb:80:in `block (3 levels) in <top (required)>'
```

It looks like it happens in cases where Solargraph's source.node is a ::Parser::AST::Node.  There's a special case in Walker.normalize_ast() that is triggering that does not look correct on its face - it should always return an array of nodes, since the result is splatted in Walker.from_source.

The spec added reproduces this in newer solargraphs.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant