[msbuild] Fix issue referencing static libraries from compressed xcframeworks. #20585
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
…ameworks. The code incorrectly assumed that the contents of a compressed xcframework would always be a framework, but this is incorrect (it can be a dynamic library (.dylib), static library (.a) or a framework (.framework). Fix this by: * Change variable and parameter names to clearly indicate that the output from an xcframework is a native library. * Unify code to handle metadata for native libraries from xcframeworks, so that the code isn't duplicated (or even worse, different) between compressed and non-compressed xcframeworks. The latter point fixes a problem where we'd compute the incorrect path to the static library inside a compressed xcframework. PR xamarin#20546 contains a test case that triggers this.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
mandel-macaque
approved these changes
May 8, 2024
Comment on lines
+279
to
+288
| if (item.ItemSpec.EndsWith (".a", StringComparison.OrdinalIgnoreCase)) { | ||
| item.SetMetadata ("Kind", "Static"); | ||
| item.SetMetadata ("PublishFolderType", "StaticLibrary"); | ||
| } else if (item.ItemSpec.EndsWith (".dylib", StringComparison.OrdinalIgnoreCase)) { | ||
| item.SetMetadata ("Kind", "Dynamic"); | ||
| item.SetMetadata ("PublishFolderType", "DynamicLibrary"); | ||
| } else { | ||
| item.SetMetadata ("Kind", "Framework"); | ||
| item.SetMetadata ("PublishFolderType", "AppleFramework"); | ||
| } |
There was a problem hiding this comment.
we could simplify that a little:
Suggested change
| if (item.ItemSpec.EndsWith (".a", StringComparison.OrdinalIgnoreCase)) { | |
| item.SetMetadata ("Kind", "Static"); | |
| item.SetMetadata ("PublishFolderType", "StaticLibrary"); | |
| } else if (item.ItemSpec.EndsWith (".dylib", StringComparison.OrdinalIgnoreCase)) { | |
| item.SetMetadata ("Kind", "Dynamic"); | |
| item.SetMetadata ("PublishFolderType", "DynamicLibrary"); | |
| } else { | |
| item.SetMetadata ("Kind", "Framework"); | |
| item.SetMetadata ("PublishFolderType", "AppleFramework"); | |
| } | |
| // defaults | |
| var kind = "Framework"; | |
| var folderType = "AppleFramework"; | |
| if (item.ItemSpec.EndsWith (".a", StringComparison.OrdinalIgnoreCase)) { | |
| kind = "Static"; | |
| folderType = "StaticLibrary); | |
| } | |
| if (item.ItemSpec.EndsWith (".dylib", StringComparison.OrdinalIgnoreCase)) { | |
| kind = "Dynamic"; | |
| folderType = "DynamicLibrary"; | |
| } | |
| item.SetMetadata ("Kind", kind); | |
| item.SetMetadata ("PublishFolderType", folderType); | |
Not a blocker to land, just a proposal.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
🔥 [CI Build] Test results 🔥Test results❌ Tests failed on VSTS: test results 0 tests crashed, 48 tests failed, 121 tests passed. Failures❌ framework tests
Html Report (VSDrops) Download ❌ fsharp tests
Html Report (VSDrops) Download ❌ interdependent-binding-projects tests
Html Report (VSDrops) Download ❌ introspection tests
Html Report (VSDrops) Download ❌ linker tests
|
💻 [PR Build] Tests on macOS X64 - Mac Sonoma (14) passed 💻✅ All tests on macOS X64 - Mac Sonoma (14) passed. Pipeline on Agent |
💻 [PR Build] Tests on macOS M1 - Mac Monterey (12) passed 💻✅ All tests on macOS M1 - Mac Monterey (12) passed. Pipeline on Agent |
💻 [PR Build] Tests on macOS M1 - Mac Ventura (13) passed 💻✅ All tests on macOS M1 - Mac Ventura (13) passed. Pipeline on Agent |
💻 [PR Build] Tests on macOS M1 - Mac Big Sur (11) passed 💻✅ All tests on macOS M1 - Mac Big Sur (11) passed. Pipeline on Agent |
📚 [PR Build] Artifacts 📚Packages generatedView packagesPipeline on Agent |
💻 [CI Build] Windows Integration Tests passed 💻✅ All Windows Integration Tests passed. Pipeline on Agent |
✅ API diff for current PR / commitLegacy Xamarin (No breaking changes)
NET (empty diffs)
✅ API diff vs stableLegacy Xamarin (No breaking changes).NET (No breaking changes)ℹ️ Generator diffGenerator Diff: vsdrops (html) vsdrops (raw diff) gist (raw diff) - Please review changes) Pipeline on Agent |
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
🚀 [CI Build] Test results 🚀Test results✅ All tests passed on VSTS: test results. 🎉 All 170 tests passed 🎉 Tests counts✅ cecil: All 1 tests passed. Html Report (VSDrops) Download Pipeline on Agent |
dalexsoto
approved these changes
May 9, 2024
emaf
approved these changes
May 9, 2024
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.
The code incorrectly assumed that the contents of a compressed xcframework would
always be a framework, but this is incorrect (it can be a dynamic library (.dylib),
static library (.a) or a framework (.framework).
Fix this by:
an xcframework is a native library.
the code isn't duplicated (or even worse, different) between compressed and non-compressed
xcframeworks.
The latter point fixes a problem where we'd compute the incorrect path to the static
library inside a compressed xcframework.
PR #20546 contains a test case that triggers this.