A couple of issues I saw with strict type check

[ShadiestGoat]

I have a big rails 5 project that I ran strict type checker with the latest version of solargraph-rails (master branch). Here are the things I noticed that should be fixed (I can work on some of them):

• logger isn't inherited into at least models (Rails.logger is defined though)
• Model.new is interpreted as Class#new, and it reports arity problems
• before_update, before_save, before_validation are not defined
• unresolved call to try
• reload doesn't return self
• unresolved constant Base64
• validates_with, validates, validates_uniqueness_of are not defined
• write_attribute, read_attribute & update_attributes are not defined
• unresolved call to config:

module MyApp
   class  Application < Rails:: Application
      config.load_defaults 5.2
      config.my_value = 123456
   end
end

Both configs are unresolved.

• (kind of a stretch goal tbh) config doesn't have any auto complete -- it'd be nice to auto complete known values

[ShadiestGoat]

So what's interesting is that a lot of this should already be included since it should just part of the base active record class, but for some reason that's not loaded. If it matters, if I go to the definition of that one in vscode, solargraph claims that all the modules cannot be located

[apiology]

Thanks for this list! Once castwide/solargraph#877 is merged, you'll be able to use recent solargraph versions with solargraph-rails. As a result:

• The RBS files published for Rails will be pulled in, so many more methods will be recognized.
• Various fixes that @castwide and I have put in on solargraph will come in.

You can take a look at https://github.com/iftheshoefritz/solargraph-rails/tree/main/spec/definitions to get a sense for what methods will start working. The 'skip' key in the YAML shows the versions of solargraph things where things are broken - the upcoming fixes are in the various ".alpha" versions, which map to some dev branches with improvements that are pending release. If 0.55.alpha is missing from the list, the fix is in the pipeline.

I'd expect things will look like this once modern solargraph is available and the backlog of PRs in solargraph are merged:

1. logger isn't inherited into at least models (Rails.logger is defined though)
2. Model.new is interpreted as Class#new, and it reports arity problems
3. before_update, before_save, before_validation are not defined
4. unresolved call to try
5. reload doesn't return self
6. unresolved constant Base64
7. validates_with, validates, validates_uniqueness_of are not defined
8. write_attribute, read_attribute & update_attributes are not defined
9. unresolved call to config:

If you'd like to help out further, feel free to PR in failing specs for the remaining items - thanks again for the list!

[ShadiestGoat]

That sounds fantastic! I hope I can use that (if I can make it work with ruby 2...)

[apiology]

Here's where you can add 2.whatever and see what happens in CI: https://github.com/iftheshoefritz/solargraph-rails/blob/main/.github/workflows/ruby.yml - and here for solargraph: https://github.com/castwide/solargraph/blob/master/.github/workflows/rspec.yml#L25

[ShadiestGoat]

Can't do that, at least not in solargraph - they dropped support for it since 0.53 so that rbs can work properly. I'm thinking that I'll make a PR to add a target ruby version setting in the config file, with the intention that the server eu s on ruby 3, but parses ruby 2 syntax & uses ruby 2 modules, but that's when I have some free time, haha

[apiology]

#148 addresses one of the issues above - you can yank that annotation and drop it in your app somewhere if you want to try it out before I cut another release.

[apiology]

I haven't tested each individually outside of what spec/definitions shows, but here are my updated assumptions:

1. logger isn't inherited into at least models (Rails.logger is defined though) - fixed by using RBS collection in Solargraph >=0.56.0
2. Model.new is interpreted as Class#new, and it reports arity problems - fixed in Solargraph
3. before_update, before_save, before_validation are not defined - fixed by using RBS collection in Solargraph >=0.56.0
4. unresolved call to try - fixed by using RBS collection in Solargraph >=0.56.0
5. reload doesn't return self - fixed by Add annotation for ActiveRecord::Base#reload #149
6. unresolved constant Base64 - seems to work in 0.56.0 - be sure you have a require 'base64' in the same file though
7. validates_with, validates, validates_uniqueness_of are not defined - fixed by using RBS collection in Solargraph >=0.56.0
8. write_attribute, read_attribute & update_attributes are not defined - fixed by using RBS collection in Solargraph >=0.56.0
9. unresolved call to config: - fixed in Add annotation for Rails::Application.config #148
10. (kind of a stretch goal tbh) config doesn't have any auto complete -- it'd be nice to auto complete known values - see https://github.com/ruby/gem_rbs_collection/blob/main/gems/railties/6.0/railties-generated.rbs#L124 - all of these will be available to you

[apiology]

So what's interesting is that a lot of this should already be included since it should just part of the base active record class, but for some reason that's not loaded.

Speaking super generally, there are three causes here with two different symptoms:

1. Can't chain off of call: No one has written down a return type in a machine-readable way
2. Symbol not found at all: something dynamic is going on either to define the method or to pull the method into the needed class
3. Bug in Solargraph

Dealing with the above three is a lot of the work I'm doing right now to help fill out the matrix of methods you see in spec/definitions. Some are easy, some are hard - having priorities from folks who use Rails every day is very helpful, so please keep the coming!

Writing down return types is super easy - either PR the annotations directory here or the https://github.com/ruby/gem_rbs_collection repo. At some point I'll do a large PR of our annotations back into https://github.com/ruby/gem_rbs_collection

For specifics:

• logger isn't inherited into at least models (Rails.logger is defined though)

This is related to ActiveSupport::Concern, which does some magic around class methods and module inclusion, and is used extensively in Rails. I have a PR open to address it by looking for the usage and matching the magic in Solargraph - castwide/solargraph#948

The workaround up to this point has been to add annotations that spell out the shortcuts - you can search the annotations for 'ClassMethods' to see examples.

• Model.new is interpreted as Class#new, and it reports arity problems

Solargraph bug, I believe.

• before_update, before_save, before_validation are not defined

These methods are dynamically created here via these two custom lines:

https://github.com/rails/rails/blob/778eab826538be6da355d848aecaea2245e3b8ce/activerecord/lib/active_record/callbacks.rb#L429-L430

Above there is RDoc which at least acknowledges the methods exist. From that, someone generated RBS that Solargraph now reads in.

4. unresolved call to try - fixed by using RBS collection in Solargraph >=0.56.0

Probably some combination of ActiveSupport::Concern and RBS providing a type.

5. reload doesn't return self - fixed by Add annotation for ActiveRecord::Base#reload #149

The RBS collection didn't have a type for this.

6. unresolved constant Base64 - seems to work in 0.56.0 - be sure you have a require 'base64' in the same file though

Solargraph isn't smart enough to figure out what "should" be already required in given place in the code. It doesn't default to assuming that everything is required, both for correctness reasons (better to over require than miss an important one and find it in prod) and for performance reasons - caching a gem takes time.

Solargraph does look at bundler's autorequired gems and includes those. This is a major pain with Rails projects today, as loading those up takes some time, during which Solargraph is randomly missing symbols. We do cache locally, but that cache gets blown when you upgrade Solargraph. There's probably room for some kind of prioritization and/or global caching work there.

• validates_with, validates, validates_uniqueness_of are not defined
• write_attribute, read_attribute & update_attributes are not defined

More ActiveSupport::Concern missing areas.

• unresolved call to config:
• (kind of a stretch goal tbh) config doesn't have any auto complete -- it'd be nice to auto complete known values

No one ever wrote down the return type.

[apiology]

Thanks again for the issue and a chance to talk through some of the development going on right now - if any of the above turn out not to actually be fixed or you hit new problems, keep throwing issues this way!

[ShadiestGoat]

Thanks for looking into this! As soon as I can, I'll test the changes (...if I can get the target version PR to work fully)