Make srb aware of tapioca
#3332
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jez
reviewed
Jul 29, 2020
elliottt
approved these changes
Jul 31, 2020
|
This change will be untested in our repo, do you think it would be possible to add a snapshot test to |
Morriar
force-pushed
the
at-fix-srb
branch
2 times, most recently
from
b9164b1
to
c7a3773
Compare
Signed-off-by: Alexandre Terrasa <alexandre.terrasa@shopify.com>
Signed-off-by: Alexandre Terrasa <alexandre.terrasa@shopify.com>
…s used Signed-off-by: Alexandre Terrasa <alexandre.terrasa@shopify.com>
elliottt
approved these changes
Aug 19, 2020
| @@ -0,0 +1,3 @@ | |||
| #!/bin/bash | |||
|
|
|||
| bundle exec "$1" tc | |||
There was a problem hiding this comment.
This test is explicitly not calling srb init because that's not the workflow with tapioca, right?
There was a problem hiding this comment.
Exactly. We assume the user will do tapioca init instead.
Morriar
added a commit
to Shopify/spoom
that referenced
this pull request
Mar 13, 2024
By default, `srb` will look for RBIs coming from gems. Since we migrated to Prism, Sorbet is now picking up the RBI shipped with the gem which results in a lot of errors. We can disable this behavior by using Tapioca. See sorbet/sorbet#3332. Signed-off-by: Alexandre Terrasa <alexandre.terrasa@shopify.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
One difference between
srbandtapiocais the way they handle signatures coming from gems.With
srb, the developer of a gem can provide a dir calledrbi/that contains all the signatures they want to export.When the end user runs
srb tc, the content of the gemrbi/dir is cached locally then passed to sorbet along the other files to be typechecked in the project.This approach brings at least two problems: 1) Sorbet does not come with a de-facto solution to copy signatures from the code to the
rbi/folder, hence 2) there is a high probability for therbi/folder to get desynchronized from the actual lib code.tapiocatries to address this problem by automatically copying code signatures to the RBI when it generates the RBIs for all the gems in the end user project. That way, the work is transferred from the gem developer to the gem user, and ultimately totapioca. Since you likely runtapiocaevery time you change your Gemfile, you always get the up-to-date signatures from the gem code for free.While still imperfect, this solution allows the whole RBI sharing to work without intervention from the developer nor the end user and avoid desynchronization. Also, since
tapiocacomes with an exclusion list mechanism the end user can chose to completely ignore a gem RBI if they want.Now comes the problem with the current
srbbehaviour. By always copying therbi/folder, the RBI from the gem is always passed to Sorbet when one callsrb tc. Which is then in conflict with the expected behaviour of atapiocauser.To address this problem, @paracycle proposed a new environment variable controlling
srbbehaviour regarding gems RBIs:SRB_SKIP_GEM_RBIS. While it solves the problem, it can be cumbersome for the end user that always have to remember to set this variable every time they usetapiocain a project that depends on gems with arbi/folder. This problem is even bigger sincetapiocastarted depending on theparlourgem which provides arbi/folder meaning that alltapiocausers now need to set the environment variable.With this pull-request, the idea is to make
srbaware thattapiocais used in the project and copying therbi/folder is not needed. The end user get the expected behaviour without changing environment variables and nothing changes if the project does not usetapioca.Test plan
See included automated tests.