Deprecate parsing non-lockfile content in LockfileParser#9502
Open
kurotaky wants to merge 1 commit intoruby:masterfrom
Open
Deprecate parsing non-lockfile content in LockfileParser#9502kurotaky wants to merge 1 commit intoruby:masterfrom
kurotaky wants to merge 1 commit intoruby:masterfrom
Conversation
Bundler::LockfileParser#initialize silently accepted any string input, including Gemfiles or arbitrary text, producing an empty parser with no indication that the input was invalid. This caused downstream tooling like bundler-audit to operate on unvalidated content. Detect non-lockfile content by checking for any of the known section headers; empty input is left untouched for backward compatibility. Rather than raising immediately, emit a deprecation warning via SharedHelpers.feature_deprecated! announcing that a future Bundler version will raise LockfileError. Expose LockfileParser#valid? so callers can branch on the result without string-matching the message. Fixes ruby#8932
kurotaky
force-pushed
the
fix/lockfile-parser-reject-non-lockfile
branch
from
3bd470c to
7117610
Compare
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
What was the end-user or developer problem that led to this PR?
Bundler::LockfileParser#initializesilently accepts any string input — including Gemfiles, READMEs, or arbitrary text — producing an empty parser with no indication that the input was invalid. Downstream tooling such as bundler-audit (via its--gemfile-lock FILEoption) has no way to confirm that the file it was handed is actually a lockfile. See #8932.What is your fix for the problem, implemented in this PR?
Detect non-lockfile content at parse time by checking for any of the known section headers (
GEM,GIT,PATH,PLATFORMS,DEPENDENCIES, etc.). Empty input is left untouched for backward compatibility.Instead of raising immediately — which would be a hard break for anyone unknowingly relying on the old silent-accept behavior — the parser now:
SharedHelpers.feature_deprecated!announcing that a future Bundler version will raiseLockfileError;LockfileParser#valid?predicate so callers can branch on the result without string-matching the deprecation message.Specs cover both default and
strict: truecases, for non-lockfile text and a Gemfile-as-lockfile regression.Fixes #8932.
Make sure the following tasks are checked