Properly attribute RBIs created by ActiveSupport.on_load
#2050
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
egiurleo
force-pushed
the
emily/flipper-bug
branch
from
be4cfd5
to
dcc0f83
Compare
When flipper/flipper-active_record version 1.3.1 is included in the Gemfile, Flipper-related code gets added to the activerecord gemfile.
egiurleo
force-pushed
the
emily/flipper-bug
branch
from
dcc0f83
to
0157b52
Compare
egiurleo
changed the title
ActiveSupport.on_load
egiurleo
force-pushed
the
emily/flipper-bug
branch
from
0157b52
to
252e7f2
Compare
…hooks We are mistakenly attributing code that is loaded by ActiveSupport.on_load to Rails, rather than whatever gem performs the hook.
egiurleo
force-pushed
the
emily/flipper-bug
branch
from
252e7f2
to
0e6e73e
Compare
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.
Closes #2016
Closes #2048
Motivation
Currently, Tapioca is incorrectly attributing mixins performed by the
ActiveSupport.on_loadhooks.A quick summary of how things currently work: whenever a mixin (
include,extend,prepend) is performed by a gem for which Tapioca is generating RBIs, we attribute that mixin to a specific location by looking at the backtrace of the call toinclude/extend/prependand finding the line that is tagged<top (required)>(or<main>if there is no other tag). This location may be in the gem code, or it may be in the code of another gem entirely.Then, we can filter those mixins based on where they happen -- only the mixins attributed to a gem get put in that gem's RBI.
This approach does not work when a mixin is performed based on an
ActiveSupport.on_loadhook because the location that is tagged<top (required)>will be in Rails gem that is being hooked into, rather than in the gem that is performing theon_loadhook in the first place.Implementation
To fix this, we need to change how we choose the location for mixin attribution. The current implementation of this PR has it looking for
block in <class:ActiveRecord>. I'm not super confident in this implementation because I'm sure it can be generalized for other use cases.Tests
See automated tests