Fix external library repeated build issue by avoiding in-place artifact modification #2681
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.
Problem
When building a binary project with external shared libraries using maturin, the second build would fail with an error like:
This issue occurred because maturin was modifying the original binary artifacts in-place during the wheel repair process, causing subsequent builds to look for hashed library names instead of the original library files.
Root Cause
The issue was in the external library handling workflow in
build_context.rs
:libTypeTreeGeneratorAPI.so
, maturin copies it with a hash suffix (libTypeTreeGeneratorAPI-849c9bc2.so
) and modifies the binary's DT_NEEDED entries to point to the hashed namelibTypeTreeGeneratorAPI-849c9bc2.so
instead of the originallibTypeTreeGeneratorAPI.so
Solution
Restructured the external library handling workflow to avoid modifying original artifacts:
Key Changes
prepare_modified_artifacts()
function that creates temporary copies of artifacts before any wheel writing beginswrite_bin_wheel()
to use these modified copies for both wheel content and patchelf operationsCode Flow
Testing
Verified the fix with the reproduction case from jakobhellermann/repro:
All existing unit tests pass, confirming no regressions.
Fixes
Closes #2680
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.