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
LoadedFeaturesIndex#register: Ignore absolute paths entirely #385
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
casperisfine
force-pushed
the
zeitwerk-compat
branch
2 times, most recently
from
January 10, 2022 09:41
26569b3
to
4ae8cf4
Compare
casperisfine
force-pushed
the
zeitwerk-compat
branch
2 times, most recently
from
January 10, 2022 12:33
1754753
to
81f0dfa
Compare
Not the original issue owner, but we saw this too and can confirm this PR fixes the issue here. Thanks! |
fxn
reviewed
Jan 10, 2022
CHANGELOG.md
Outdated
@@ -1,5 +1,9 @@ | |||
# Unreleased | |||
|
|||
* Ignore absolute paths in the loaded feature index. (#385) | |||
This fixes a compatibility issue with Zeitwerk when Zeitwerk is loaded before bootsnap. It also should | |||
Reduce the memory usage and improve load performance of Zeitwerk managed files. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggested change
Reduce the memory usage and improve load performance of Zeitwerk managed files. | |
reduce the memory usage and improve load performance of Zeitwerk managed files. |
Tried and works as expected. Thanks @casperisfine ❤️. |
Fix: #383 Ref: fxn/zeitwerk#198 The loaded feature index goal is to prevent requiring the same "feature" twice if the `$LOAD_PATH` was mutated. e.g: ```ruby require "bundler" # ~/gems/bundler/lib/bundler.rb $LOAD_PATH.unshift("some/path") require "bundler" # some/path/bundler.rb ``` In such scenario Ruby remember that you require "bundler" already and even though it now maps to a new path, it won't load it again. This was causing issues with Zeitwerk if it is loaded before bootsnap (see refs), because the cache wouldn't be cleared. But ultimately Zeitwerk always require absolute paths, and the concern described above simply doesn't apply to absolute paths. So we can simply bail out early in these cases. That fixes the bug, and also means less work and a smaller index, so win-win.
casperisfine
force-pushed
the
zeitwerk-compat
branch
from
January 10, 2022 21:20
81f0dfa
to
6253a68
Compare
1.9.4 is out! |
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.
Fix: #383
Ref: fxn/zeitwerk#198
The loaded feature index goal is to prevent requiring the same "feature" twice if the
$LOAD_PATH
was mutated. e.g:In such scenario Ruby remember that you require "bundler" already and even though it now maps to a new path, it won't load it again.
This was causing issues with Zeitwerk if it is loaded before bootsnap (see refs), because the cache wouldn't be cleared.
But ultimately Zeitwerk always require absolute paths, and the concern described above simply doesn't apply to absolute paths. So we can simply bail out early in these cases. That fixes the bug, and also means less work and a smaller index, so win-win.
cc @fxn