[msbuild] Add support for bundling original resources in libraries. Fixes #19028. #20557

rolfbjarne · 2024-05-03T08:38:16Z

If a library references resources, until now we've pre-compile/pre-processed
some of those before embedding them the library. This applies to resources of
the following item groups:

AtlasTexture
BundleResource
Collada
CoreMLModel
ImageAsset
InterfaceDefinition
SceneKitAsset

However, pre-processing resources as a few problems:

It requires a native (Xcode) toolchain.
- This is unfortunate when building from Windows: the current approach is
  that when building a library as a referenced project, the remoting part
  is skipped, so all such resources are just dropped.
- It also means building on Linux doesn't work.
It makes it impossible to merge resources with the same name, if we wanted
to do that.

So I'm adding support for bundling the original resources in library projects.

This is enabled using the MSBuild property BundleOriginalResources=true,
which is turned off by default for .NET 8 and turned on by default for .NET 9+.

Additionally I've added PartialAppManifest items to the list of bundled
resources from class libraries.

Fixes #19028.

This looks like an incorrect merge conflict resolution: the property _UnpackLibraryResourcesDependsOn was declared twice, the second time overwriting the first. Pick the first declaration, since it's the newest and more complete one (70a5d0d).

… reuse possible

…ixes xamarin#19028. If a library references resources, until now we've pre-compile/pre-processed some of those before embedding them the library. This applies to resources of the following item groups: * AtlasTexture * BundleResource * Collada * CoreMLModel * ImageAsset * InterfaceDefinition * SceneKitAsset However, pre-processing resources as a few problems: * It requires a native (Xcode) toolchain. * This is unfortunate when building from Windows: the current approach is that when building a library as a referenced project, the remoting part is skipped, so all such resources are just dropped. * It also means building on Linux doesn't work. * It makes it impossible to merge resources with the same name, if we wanted to do that. So I'm adding support for bundling the original resources in library projects. This is enabled using the MSBuild property `BundleOriginalResources=true`, which is turned off by default for .NET 8 and turned on by default for .NET 9. Fixes xamarin#19028.

Also enable nullability and fix any issues.

The SceneKitAsset items contains all the resources within a .scnasset directory. However, we need to pass the .scnasset directory to the native tooling, so we compute the path to the .scnasset directory, and create a new item for it. This new item must have the correct LogicalName set, which is accomplished by: * Not deleting the LogicalName from the original item before using it to compute the new item's LogicalName. * Compute the correct LogicalName for the .scnasset, and actually set it. This fixes an issue where we'd be unable to detec previously processed SceneKitAsset items in universal builds, because the files wouldn't located where they should be on disk.

github-actions · 2024-05-03T08:42:00Z

⚠️ Your code has been reformatted. ⚠️

If this is not desired, add the actions-disable-autoformat label, and revert the reformatting commit.

If files unrelated to your change were modified, try reverting the reformatting commit + merging with the target branch (and push those changes).

…al-resources-in-libraries

vs-mobiletools-engineering-service2 · 2024-05-24T13:59:44Z

❌ [CI Build] Windows Integration Tests failed ❌

❌ Failed ❌

Pipeline on Agent
Hash: cfa94e1abef604ed91d661d6524143c9cad9fc77 [PR build]

vs-mobiletools-engineering-service2 · 2024-05-24T14:04:18Z

💻 [PR Build] Tests on macOS M1 - Mac Monterey (12) passed 💻

✅ All tests on macOS M1 - Mac Monterey (12) passed.

Pipeline on Agent
Hash: [PR build]

vs-mobiletools-engineering-service2 · 2024-05-24T14:05:15Z

💻 [PR Build] Tests on macOS M1 - Mac Ventura (13) passed 💻

✅ All tests on macOS M1 - Mac Ventura (13) passed.

Pipeline on Agent
Hash: [PR build]

vs-mobiletools-engineering-service2 · 2024-05-24T14:08:05Z

💻 [PR Build] Tests on macOS M1 - Mac Big Sur (11) passed 💻

✅ All tests on macOS M1 - Mac Big Sur (11) passed.

Pipeline on Agent
Hash: [PR build]

vs-mobiletools-engineering-service2 · 2024-05-24T14:23:51Z

✅ API diff for current PR / commit

Legacy Xamarin (No breaking changes)

~~iOS~~ (no change detected)
~~tvOS~~ (no change detected)
~~watchOS~~ (no change detected)
~~macOS~~ (no change detected)

NET (empty diffs)

~~iOS~~: (empty diff detected)
~~tvOS~~: (empty diff detected)
~~MacCatalyst~~: (empty diff detected)
~~macOS~~: (empty diff detected)

✅ API diff vs stable

Legacy Xamarin (No breaking changes)

iOS: vsdrops gist (No breaking changes)
tvOS: vsdrops gist (No breaking changes)
watchOS: vsdrops gist (No breaking changes)
macOS: vsdrops gist (No breaking changes)

.NET (No breaking changes)

iOS: vsdrops gist (No breaking changes)
tvOS: vsdrops gist (No breaking changes)
MacCatalyst: vsdrops gist (No breaking changes)
macOS: vsdrops gist (No breaking changes)
Microsoft.iOS vs Microsoft.MacCatalyst: vsdrops gist

Legacy Xamarin (stable) vs .NET

iOS: vsdrops gist
tvOS: vsdrops gist
macOS: vsdrops gist

ℹ️ Generator diff

Generator Diff: vsdrops (html) vsdrops (raw diff) gist (raw diff) - Please review changes)

Pipeline on Agent
Hash: cfa94e1abef604ed91d661d6524143c9cad9fc77 [PR build]

vs-mobiletools-engineering-service2 · 2024-05-24T15:25:45Z

❌ [PR Build] Tests on macOS X64 - Mac Sonoma (14) failed ❌

Failed tests are:

introspection
xammac_tests
monotouch-test

Pipeline on Agent
Hash: [PR build]

vs-mobiletools-engineering-service2 · 2024-05-24T16:52:02Z

🔥 [CI Build] Test results 🔥

Test results

❌ Tests failed on VSTS: test results

0 tests crashed, 6 tests failed, 166 tests passed.

Failures

❌ monotouch tests (tvOS)

5 tests failed, 8 tests passed.

monotouch-test/tvOS - simulator/Debug (static registrar) [dotnet]: TimedOut
monotouch-test/tvOS - simulator/Debug (managed static registrar) [dotnet]: Failed
monotouch-test/tvOS - simulator/Release (managed static registrar, all optimizations) [dotnet]: Failed
monotouch-test/tvOS - simulator/Release (NativeAOT, x64) [dotnet]: Crashed
monotouch-test/tvOS - simulator/Release (all optimizations): Failed

Html Report (VSDrops) Download

❌ msbuild tests

1 tests failed, 1 tests passed.

MSBuild tests/Integration: Failed (Execution failed with exit code 1)

Html Report (VSDrops) Download

Successes

✅ cecil: All 1 tests passed. Html Report (VSDrops) Download
✅ dotnettests (iOS): All 1 tests passed. Html Report (VSDrops) Download
✅ dotnettests (MacCatalyst): All 1 tests passed. Html Report (VSDrops) Download
✅ dotnettests (macOS): All 1 tests passed. Html Report (VSDrops) Download
✅ dotnettests (Multiple platforms): All 1 tests passed. Html Report (VSDrops) Download
✅ dotnettests (tvOS): All 1 tests passed. Html Report (VSDrops) Download
✅ framework: All 8 tests passed. Html Report (VSDrops) Download
✅ fsharp: All 7 tests passed. Html Report (VSDrops) Download
✅ generator: All 2 tests passed. Html Report (VSDrops) Download
✅ install-source: All 1 tests passed. Html Report (VSDrops) Download
✅ interdependent-binding-projects: All 7 tests passed. Html Report (VSDrops) Download
✅ introspection: All 8 tests passed. Html Report (VSDrops) Download
✅ linker: All 65 tests passed. Html Report (VSDrops) Download
✅ mac-binding-project: All 1 tests passed. Html Report (VSDrops) Download
✅ mmp: All 2 tests passed. Html Report (VSDrops) Download
✅ mononative: All 6 tests passed. Html Report (VSDrops) Download
✅ monotouch (iOS): All 11 tests passed. Html Report (VSDrops) Download
✅ monotouch (MacCatalyst): All 7 tests passed. Html Report (VSDrops) Download
✅ monotouch (macOS): All 8 tests passed. Html Report (VSDrops) Download
✅ monotouch (watchOS): All 4 tests passed. Html Report (VSDrops) Download
✅ mtouch: All 1 tests passed. Html Report (VSDrops) Download
✅ xammac: All 3 tests passed. Html Report (VSDrops) Download
✅ xcframework: All 8 tests passed. Html Report (VSDrops) Download
✅ xtro: All 2 tests passed. Html Report (VSDrops) Download

Pipeline on Agent
Hash: [PR build]

vs-mobiletools-engineering-service2 · 2024-05-24T18:08:27Z

❌ [PR Build] Tests on macOS X64 - Mac Sonoma (14) failed ❌

Failed tests are:

introspection
xammac_tests
monotouch-test

Pipeline on Agent
Hash: [PR build]

rolfbjarne and others added 10 commits May 3, 2024 10:35

[msbuild] Refactor out function in CollectBundleResource to make code…

02aa4c3

… reuse possible

[msbuild] Refactor out function in CompileSceneKitAssets to make code…

c55bab1

… reuse possible

[msbuild] Add support for packing/unpacking PartialAppManifest items.

490614e

[tests] Automatically set properties for remote builds.

e14dfc5

[tests] Add test.

85fa443

[msbuild] Honor the LogicalName metadata on TextureAtlas items.

efbb53c

Also enable nullability and fix any issues.

Auto-format source code

bb1e94c

This comment has been minimized.

Sign in to view

Merge remote-tracking branch 'origin/main' into msbuild-bundle-origin…

2177ffd

…al-resources-in-libraries

This comment has been minimized.

Sign in to view

Merge branch 'main' into msbuild-bundle-original-resources-in-libraries

8ecc619

This comment has been minimized.

Sign in to view

Merge remote-tracking branch 'origin/main' into msbuild-bundle-origin…

cfa94e1

…al-resources-in-libraries

[msbuild] Add support for bundling original resources in libraries. Fixes #19028. #20557

Are you sure you want to change the base?

[msbuild] Add support for bundling original resources in libraries. Fixes #19028. #20557

Conversation

rolfbjarne commented May 3, 2024 • edited

github-actions bot commented May 3, 2024

⚠️ Your code has been reformatted. ⚠️

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.

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.

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.

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.

vs-mobiletools-engineering-service2 commented May 24, 2024

❌ [CI Build] Windows Integration Tests failed ❌

vs-mobiletools-engineering-service2 commented May 24, 2024

💻 [PR Build] Tests on macOS M1 - Mac Monterey (12) passed 💻

vs-mobiletools-engineering-service2 commented May 24, 2024

💻 [PR Build] Tests on macOS M1 - Mac Ventura (13) passed 💻

vs-mobiletools-engineering-service2 commented May 24, 2024

💻 [PR Build] Tests on macOS M1 - Mac Big Sur (11) passed 💻

vs-mobiletools-engineering-service2 commented May 24, 2024

✅ API diff for current PR / commit

✅ API diff vs stable

ℹ️ Generator diff

vs-mobiletools-engineering-service2 commented May 24, 2024

❌ [PR Build] Tests on macOS X64 - Mac Sonoma (14) failed ❌

vs-mobiletools-engineering-service2 commented May 24, 2024

🔥 [CI Build] Test results 🔥

Test results

Failures

❌ monotouch tests (tvOS)

❌ msbuild tests

Successes

vs-mobiletools-engineering-service2 commented May 24, 2024

❌ [PR Build] Tests on macOS X64 - Mac Sonoma (14) failed ❌

rolfbjarne commented May 3, 2024 •

edited