feat(constraints): add per-specifier provenance tracking#1189
Conversation
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughThe Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes 🚥 Pre-merge checks | ✅ 4✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@src/fromager/constraints.py`:
- Around line 168-177: get_provenance currently returns a shallow copy of
self._provenance so callers can mutate nested lists and change internal state;
update get_provenance to return a deep copy of the provenance mapping (e.g., use
copy.deepcopy on self._provenance[canonicalize_name(name)] or construct a new
dict copying each list) so callers cannot modify internal data structures
accessed via get_provenance; ensure you still canonicalize the name with
canonicalize_name(name) and return an empty dict when missing.
In `@tests/test_constraints.py`:
- Around line 306-307: Update the test that asserts InvalidConstraintError from
c.add_constraint to ensure the exception message contains both conflicting
sources: change the pytest.raises regex (the match= argument) to require both
"base.txt" and "override.txt" (for example using a positive lookahead pattern
like (?=.*base\.txt)(?=.*override\.txt)) so the test fails if either source is
missing from the error message; target the assertion surrounding the
c.add_constraint call that raises InvalidConstraintError.
- Around line 275-281: The test test_provenance_returns_copy currently only
verifies the outer dict is copied; update it to also check for nested mutation
leakage by mutating a list value returned by Constraints.get_provenance and
asserting that the internal provenance inside the Constraints instance is not
changed. Specifically, after using Constraints.add_constraint("foo>=1.0",
source="a.txt") call c.get_provenance("foo"), append/modify the returned list
(from the dict value) and then call c.get_provenance("foo") again to assert the
original list value remains unchanged, ensuring get_provenance returns
deep-copied (or otherwise protected) list values.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 46b1bdaf-7ff4-4858-b8d0-c2bc42261980
📒 Files selected for processing (5)
src/fromager/constraints.pysrc/fromager/resolver.pytests/test_constraints.pytests/test_context.pytests/test_resolver.py
424ccfb to
071002e
Compare
071002e to
4c18d3a
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@src/fromager/constraints.py`:
- Around line 64-71: The provenance parameter in the add_constraint method is
stored and rendered directly in error messages (lines 107-112) and in
merged-constraints.txt output (lines 156-159) without sanitization, which could
expose credentials in URLs or allow CR/LF injection to corrupt the output file.
Sanitize the provenance string when it is received in the add_constraint method
by removing or escaping any credentials, query parameters, and CR/LF characters,
then use this sanitized version consistently everywhere provenance is rendered
in error messages and dumped comments throughout the add_constraint and any
related output methods.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 06334e11-e44a-412d-b78d-2b6b0a1371a5
📒 Files selected for processing (5)
src/fromager/constraints.pysrc/fromager/resolver.pytests/test_constraints.pytests/test_context.pytests/test_resolver.py
✅ Files skipped from review due to trivial changes (1)
- tests/test_resolver.py
🚧 Files skipped from review as they are similar to previous changes (1)
- src/fromager/resolver.py
|
A minor thing. You should add some additional tests that are missing: No test for provenance when |
The earlier design required provenance as a mandatory parameter. With the latest changes making it optional (None default), I've added test_add_constraint_without_provenance and test_conflict_error_without_provenance to cover that path. For the resolver error and debug logging paths, format_provenance() is already unit-tested directly in test_format_provenance. Testing consumers of that method would be integration-level scope rather than provenance unit tests. |
ce18d79 to
d25829a
Compare
Track which constraint files contributed each package constraint so that engineers can quickly identify the source of a conflicting specifier when a build fails. - Store provenance alongside constraints in a single `_data` dict as `dict[NormalizedName, tuple[Requirement, set[str]]]` - Add optional `provenance` parameter to `add_constraint()` - `load_constraints_file()` passes the file path as provenance - `dump_constraints()` writes source files as comments above each line - Add `get_constraint_with_provenance()` and `format_provenance()` methods - Enrich `InvalidConstraintError` and resolver error messages with source file info Co-Authored-By: Claude <claude@anthropic.com> Closes: python-wheel-build#1186 Signed-off-by: Shanmukh Pawan <smoparth@redhat.com>
d25829a to
477f850
Compare
Track which constraint files contributed each package constraint so that
engineers can quickly identify the source of a conflicting specifier when
a build fails.
_datadict asdict[NormalizedName, tuple[Requirement, set[str]]]provenanceparameter toadd_constraint()load_constraints_file()passes the file path as provenancedump_constraints()writes source files as comments above each lineget_constraint_with_provenance()andformat_provenance()methodsInvalidConstraintErrorand resolver error messages withsource file info
Closes: #1186
Pull Request Description
What
Why