Problem

We're seeing the following typecheck error in one of our projects that runs Rails main:

sorbet/rbi/gems/actionpack@7.2.0.alpha-6c9967f85ada90f8ca58e794a850e887ceb45132.rbi:5372: Malformed sig. Type not specified for argument block https://srb.help/5003
    5372 |  def merge!(other_hash, &block); end
                                    ^^^^^
    sorbet/rbi/annotations/actionpack.rbi:78: Signature
    78 |  sig { params(other_hash: T.untyped).returns(ActionController::Parameters) }
          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Context

• Gem name: actionpack
• Gem version: 7.2.0.alpha-6c9967f85ada90f8ca58e794a850e887ceb45132
• Gem source: https://github.com/rails/rails/blob/b4d8603bd3a9f814e0a233ee39b1cdcee2e60e29/actionpack/lib/action_controller/metal/strong_parameters.rb#L864
• Gem API doc: https://edgeapi.rubyonrails.org/classes/ActionController/Parameters.html#method-i-merge-21
• Tapioca version: 0.11.9
• Sorbet version: 0.5.11044

Problem

When running type on a project that uses the latest sidekiq version, I will get this type error:

sorbet/rbi/gems/[email protected]:2965: Cannot initialize the module Worker by constant assignment https://srb.help/4022
    2965 |Sidekiq::Worker = Sidekiq::Job
          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    sorbet/rbi/annotations/sidekiq.rbi:79: Previously defined as a module here
    79 |module Sidekiq::Worker
        ^^^^^^^^^^^^^^^^^^^^^^
  Note:
    Sorbet does not allow treating constant assignments as class or module definitions,
    even if the initializer computes a Module object at runtime. See the docs for more.

At first glance this doesn't seem to an issue of annotations, but changing all references of Sidekiq::Worker to Sidekiq::Job in sorbet/rbi/annotations/sidekiq.rbi fixes the issue.

Weirdly enough, when changing the references in a project that uses sidekiq < 7.0.0 also causes an error:

Method sidekiq_options does not exist on T.class_of(MyJob) https://srb.help/7003

Seems like a good use case for versioning

Context

I'm using include Sidekiq::Job in all my workers (in 6.0. and 7.0)

Sidekiq aliases Sidekiq::Job to Sidekiq::Worker. Weirdly enough this has not been introduced in 7.0 and has been there before.

• Gem name: sidekiq
• Gem version: 7.0.0
• Tapioca version: 0.10.2
• Sorbet version: 0.5.10517

Problem

The lhm.rbi and lhm-shopify.rbi annotations don't play nicely with each other. This error ends up raised during a typecheck:

Looks like these are the conflicting lines:

Context

• Gem name: lhm & shopify_lhm
• Gem version: lhm is 3.3.4 & shopify_lhm is 1.0.1.
• Gem source: https://github.com/Shopify/lhm & https://github.com/Shopify/shopify_lhm
• Gem API doc:
• Tapioca version: 0.10.0
• Sorbet version:0.6.11

Problem

The graphql gem renamed an argument: https://github.com/rmosolgo/graphql-ruby/pull/4344/files#diff-0959b89df256ca790c7183690e64e4b50c705325da6180e521a458c5388f3bbcL45
This makes the graphql annotation incorrect: https://github.com/Shopify/rbi-central/blob/main/rbi/annotations/graphql.rbi#L5

Context

• Gem name: graphql
• Gem version: 2.0.18 and up
• Gem source: https://github.com/Shopify/rbi-central/blob/main/rbi/annotations/graphql.rbi#L5
• Gem API doc: https://graphql-ruby.org/api-doc/2.0.19/GraphQL#parse-class_method
• Tapioca version: 0.11.2
• Sorbet version: 0.5.10712

One of the steps to improve CI as outlined in #8

It'd be cleaner to have a minimal root directory with things like Gemfile, Gemfile.lock, .rubocop.yml and dev.yml stored in a sub directory without hindering UX.

It's worth investing some time into it to see what are some possible options and go on from there if there's a suitable one.

Problem

> bundle exec srb tc
sorbet/rbi/annotations/actionmailer.rbi:8: Unable to resolve constant Mail https://srb.help/5002
     8 |  sig { params(headers: T.untyped, block: T.nilable(T.proc.void)).returns(Mail::Message) }
                                                                                  ^^^^
  Did you mean Spoom::Cli::Main? Use -a to autocorrect
    sorbet/rbi/annotations/actionmailer.rbi:8: Replace with Spoom::Cli::Main
     8 |  sig { params(headers: T.untyped, block: T.nilable(T.proc.void)).returns(Mail::Message) }
                                                                                  ^^^^
    sorbet/rbi/gems/[email protected]:217: Spoom::Cli::Main defined here
     217 |class Spoom::Cli::Main < ::Thor
          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  Did you mean ActionMailer::Base? Use -a to autocorrect
    sorbet/rbi/annotations/actionmailer.rbi:8: Replace with ActionMailer::Base
     8 |  sig { params(headers: T.untyped, block: T.nilable(T.proc.void)).returns(Mail::Message) }
                                                                                  ^^^^
    sorbet/rbi/annotations/actionmailer.rbi:7: ActionMailer::Base defined here
     7 |class ActionMailer::Base
        ^^^^^^^^^^^^^^^^^^^^^^^^

Context

Rails latest 7.0.8, fresh project, fresh install of latest sorbet/tapioca. Ran bin/tapioca gem to generate from installed gems.

I checked and sorbet/rbi/annotations/actionmailer.rbi in my project is the same as in this repo:
https://github.com/Shopify/rbi-central/blob/main/rbi/annotations/actionmailer.rbi

sorbet/rbi/gems/[email protected] is empty however - is this because it's missing in thetapioca repo?

What should be done here? It seems like the only path is to add this constant to the todo - but that command is actively deprecating?

• Gem name: actionmailer / rails
• Gem version: 7.0.8
• Gem source: https://github.com/rails/rails/tree/main/actionmailer
• Gem API doc: https://api.rubyonrails.org/classes/ActionMailer/Base.html
• Tapioca version:
• Sorbet version:

> bundle list | ack '(tapioca|sorbet)'
  * sorbet (0.5.11014)
  * sorbet-runtime (0.5.11014)
  * sorbet-static (0.5.11014)
  * sorbet-static-and-runtime (0.5.11014)
  * tapioca (0.11.9)
  * yard-sorbet (0.8.1)

Problem

Available constants, methods and signatures may vary depending on the version of the gem.

• rbi-central should provide a way to annotates specific versions of a gem
• tapioca should pull only relevant annotations for the considered version of a gem

Possible solution

Annotate the annotations with the gem version concerned when we need to make a distinction between two versions:

module Foo
  # This annotation is defined in all versions
  def foo; end

  # This annotation is only available in versions > 1.0
  # @version > 1.0
  def bar(x); end

  # This annotation is only available in versions <= 1.0
  # @version <= 1.0
  def bar; end
end

Some of the CI scripts could be use as Git pre commit or push hooks to make sure wrong RBIs are not even pushed to the repo.

Problem

https://github.com/Shopify/rbi-central/actions/runs/7702547117/job/20991065604#step:4:458

So we can be sure that super classes and mixins are correct.

Problem

ActiveSupport Array#extract! accepts an optional block arg but the RBI does not include the block argument:

https://github.com/Shopify/rbi-central/blob/main/rbi/annotations/activesupport.rbi#L145-L146

Context

• Gem name: activesupport
• Gem version: 6.1.7.3
• Gem source: https://github.com/rails/rails/blob/main/activesupport/lib/active_support/core_ext/array/extract.rb
• Gem API doc: Latest Version . The signature of this method has never changed
• Tapioca version: 0.11.6
• Sorbet version: 0.5.10845

Problem

Right now we only operate a few checks on the runtime validity of an annotations file:

• Require can be done
• Constants
• Constants are of the right kind (ie. classes are classes)
• Method exists (or can be delegated to method_missing

But we currently do not check if:

• The method arity in the RBI is correct
• The params are of the right type in the signature
• The return type is of the right type in the signature

This would be another step in ensuring our annotations are correct.

• How to interact with the repo?
• What are annotations?
• What are some CI checks currently available?
• Overall goal of the repo

Problem

sorbet-typed was allowing users to attach a test file to each annotation so it could be checked with Sorbet.

In rbi-central, since we check the RBIs against Sorbet and Tapioca we already cover a large part of this.
What's is missing is the ability to exercise the signatures as sorbet-typed does.

Blocked by #24

• Internally used annotations that could bring value
• sorbet-typed

Problem

I believe the signature here is too restrictive:

e.g.

[1] pry(main)> ae = ActiveModel::Errors.new(Object.new)
=> #<ActiveModel::Errors []>
[2] pry(main)> ae.add(:foo, "bar")
=> #<ActiveModel::Error attribute=foo, type=bar, options={}>
[3] pry(main)> ae.details
=> {:foo=>[{:error=>"bar"}]}

I think it should instead be:

sig { returns(T::Hash[Symbol, T::Array[T::Hash[Symbol, T.untyped]]]) }
def details; end

Context

n/a

If we run tapioca gem before scripts/check_types we could reduce the number of suppressed errors in CI:

It'd be nice to have a tapioca gem foo --in-isolation flag that could create the gem RBI without a proper project that we can utilize in CI.

We need to make sure no annotations for private gems are being pushed. We can have a CI check that queries rubygems.org to confirm a gem is public.

An edge case to watch for is internal gems that are on rubygems.org but aren't actually public. Their version number is always 9001.0, ie. https://rubygems.org/gems/shopify-adt

See #224 (review)

Let's make sure all files are committed at typed: strict strictness level

To make sure we encourage contributors to provide the required information about what they're trying to describe or do.

• Add a script that populates the next command with modified RBIs
• Run CI only on modified RBIs
• Lint index.json
• Enforce index.json entries match rbi/annotations/*.rbi files

Problem

Currently, we skip the validation of @missing_method if the method is a singleton method: https://github.com/Shopify/rbi-central/blob/main/gem/lib/rbi-central/runtime/context.rb#L206 but this case can actually happen: https://github.com/sidekiq-scheduler/sidekiq-scheduler/blob/8ad1f746b2743c13ba9b37309271bd41aff2a4f1/lib/sidekiq-scheduler/scheduler.rb#L39-L41. We should validate in all cases.

• A step to do bundle install upon dev up
• A step to run bundle exec rubocop upon dev style

You can find the extensions within this folder in the Rails repo.

• #139
• BigDecimal
• Class
• Date
• DateTime
• Digest
• Enumerable
• File
• Hash
• Integer
• Kernel
• LoadError
• Module
• NameError
• Numeric
• Object
• Pathname
• Range
• Regexp
• SecureRandom
• String #185
• Symbol
• Time
• URI

Annotations don't have a final newline, which will trigger linting errors if they're imported to a project that uses Rubocop or another linter. I'm wondering if we should use do some sort of linting on annotation files so they don't cause linting errors in other projects.

Problem

When we use the type annotations for action_mailer we get this error Expected type ActionMailer::MessageDelivery, got type Mail::Message with value. From what I can tell the #mail method returns a Mail::Message type, see return here and instance variable set here.

Context

• Gem name: action_mailer
• Gem version: we are using action_mailer -v (6.1.6.1) (but I think this is applicable to later versions as well)
• Gem source: https://github.com/rails/rails/tree/main/actionmailer/lib/action_mailer
• Gem API doc: https://guides.rubyonrails.org/action_mailer_basics.html
• Tapioca version: 0.10.2
• Sorbet version: 0.5.10470

Problem

We're currently using @method_missing to represent method being delegated to another class:

class MyClass

  # This method is actually delegated
  # @method_missing: delegated to MyOtherClass
  def my_method; end
end

The goal of this annotation is making it easier for the maintainer to find where the implementation of the method is and to define the right signature.

I wonder if we could be smarter and also validate that the target class does indeed provide the said method?

error: Couldn't find delegated `my_method` in `MyOtherClass`

Problem

See https://github.com/Shopify/rbi-central/actions/runs/3099119037/jobs/5017870862 for example.

Adding an annotations file and an entry to the index seem to trigger the checks twice in the same PR.