Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[msbuild] Copy files to be signed into the correct directory for Hot Restart. Fixes #19278. #19302

Merged

Conversation

rolfbjarne
Copy link
Member

  1. Move the signing to after we copy files that must be signed into the app bundle
    that will be signed: we sign in the _CodesignHotRestartAppBundle target, so this
    means the targets _CopyHotRestartBundleResources and _CopyFilesToHotRestartSignedAppDirContents
    must execute first.

  2. Try to clear up some confusion about the directories involved. The HotRestartSignedAppOutputDir
    property indicates the location of the signed app bundle, which means no files
    should be added there. Instead files that should be signed (or present when the
    app launches) must be placed in the HotRestartAppBundlePath directory.

  3. Document each property involved to try to avoid more mistakes in the future.

Fixes #19278.

…Restart. Fixes xamarin#19278.

1. Move the signing to after we copy files that must be signed into the app bundle
   that will be signed: we sign in the _CodesignHotRestartAppBundle target, so this
   means the targets _CopyHotRestartBundleResources and _CopyFilesToHotRestartSignedAppDirContents
   must execute first.

2. Try to clear up some confusion about the directories involved. The HotRestartSignedAppOutputDir
   property indicates the location of the _signed_ app bundle, which means no files
   should be added there. Instead files that should be signed (or present when the
   app launches) must be placed in the HotRestartAppBundlePath directory.

3. Document each property involved to try to avoid more mistakes in the future.

Fixes xamarin#19278.
@emaf
Copy link
Contributor

emaf commented Oct 23, 2023

Thanks for documenting the properties, @rolfbjarne!

_CopyHotRestartBundleResources;
_CopyFilesToHotRestartSignedAppDirContents;
_CodesignHotRestartAppBundle;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I remember I had to change the order of that target because it was causing unwanted behaviors. I don't know if you checked that as part of this changes. There are more comments in my PR: 495ebc9

The related ones are:

- Ensure the _CodesignHotRestartAppBundle target is executed before the copy of the content files and not after: Hot Restart content files doesn't affect the code signing, so they don't need to be copied before the signing process. Copying the content files before the code sign was causing unwanted behaviors and errors since the code sign logic will try to clear the signing folder before the execution, to avoid mixing old and new content

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mauroa I checked your changes, and now we're signing in the middle of copying files: files that must be signed are copied, then we sign, then content files are copied: https://github.com/rolfbjarne/xamarin-macios/blob/3a2860296c2fc742f16c3d3a42e3fc0e1ee6c7df/msbuild/Xamarin.iOS.Tasks.Windows/Xamarin.iOS.HotRestart.targets#L249-L253

That's the intention at least - but how do I test that your scenario still works?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right, I didn't realize the order was not exactly the same as the one before my changes. My bad I didn't add the bug link to my PR, I'll see If I can track it somehow

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mauroa were you able to find the bug link?

_CopyHotRestartBundleResources;
_CopyFilesToHotRestartSignedAppDirContents;
_CodesignHotRestartAppBundle;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right, I didn't realize the order was not exactly the same as the one before my changes. My bad I didn't add the bug link to my PR, I'll see If I can track it somehow

@vs-mobiletools-engineering-service2
Copy link
Collaborator

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

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

Pipeline on Agent
Hash: [PR build]

@vs-mobiletools-engineering-service2
Copy link
Collaborator

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

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

Pipeline on Agent
Hash: [PR build]

@vs-mobiletools-engineering-service2
Copy link
Collaborator

💻 [CI Build] Windows Integration Tests passed 💻

All Windows Integration Tests passed.

Pipeline on Agent
Hash: 3a2860296c2fc742f16c3d3a42e3fc0e1ee6c7df [PR build]

@vs-mobiletools-engineering-service2
Copy link
Collaborator

📚 [PR Build] Artifacts 📚

Artifacts were not provided.

Pipeline on Agent
Hash: [PR build]

@vs-mobiletools-engineering-service2
Copy link
Collaborator

✅ 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)
.NET (No breaking changes)
Legacy Xamarin (stable) vs .NET

ℹ️ Generator diff

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

Pipeline on Agent
Hash: 3a2860296c2fc742f16c3d3a42e3fc0e1ee6c7df [PR build]

@vs-mobiletools-engineering-service2

This comment has been minimized.

@vs-mobiletools-engineering-service2
Copy link
Collaborator

🚀 [CI Build] Test results 🚀

Test results

✅ All tests passed on VSTS: simulator tests.

🎉 All 235 tests passed 🎉

Tests counts

✅ bcl: All 69 tests passed. [attempt 2] Html Report (VSDrops) Download
✅ cecil: All 1 tests passed. Html Report (VSDrops) Download
✅ dotnettests: All 1 tests passed. Html Report (VSDrops) Download
✅ fsharp: All 7 tests passed. Html Report (VSDrops) Download
✅ framework: All 8 tests passed. Html Report (VSDrops) Download
✅ generator: All 2 tests passed. Html Report (VSDrops) Download
✅ interdependent_binding_projects: All 7 tests passed. Html Report (VSDrops) Download
✅ install_source: All 1 tests passed. Html Report (VSDrops) Download
✅ introspection: All 8 tests passed. Html Report (VSDrops) Download
✅ linker: All 65 tests passed. [attempt 2] Html Report (VSDrops) Download
✅ mac_binding_project: All 1 tests passed. [attempt 2] Html Report (VSDrops) Download
✅ mmp: All 2 tests passed. [attempt 2] Html Report (VSDrops) Download
✅ mononative: All 6 tests passed. [attempt 2] Html Report (VSDrops) Download
✅ monotouch: All 41 tests passed. [attempt 2] Html Report (VSDrops) Download
✅ msbuild: All 2 tests passed. [attempt 2] Html Report (VSDrops) Download
✅ mtouch: All 1 tests passed. [attempt 2] Html Report (VSDrops) Download
✅ xammac: All 3 tests passed. [attempt 2] 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: 3a2860296c2fc742f16c3d3a42e3fc0e1ee6c7df [PR build]

@vs-mobiletools-engineering-service2
Copy link
Collaborator

📚 [PR Build] Artifacts 📚

Packages generated

View packages

Pipeline on Agent
Hash: [PR build]

@rolfbjarne rolfbjarne merged commit 25393b9 into xamarin:main Oct 25, 2023
78 checks passed
@rolfbjarne rolfbjarne deleted the hotrestart-fix-signing-frameworks branch October 25, 2023 06:45
@rolfbjarne
Copy link
Member Author

/sudo backport release/8.0.1xx

@vs-mobiletools-engineering-service2
Copy link
Collaborator

Backport Job to branch release/8.0.1xx Created! The magic is happening here

@vs-mobiletools-engineering-service2
Copy link
Collaborator

Hooray! Backport succeeded! Please see https://devdiv.visualstudio.com/DevDiv/_build/results?buildId=8590474 for more details.

dalexsoto pushed a commit that referenced this pull request Oct 26, 2023
…directory for Hot Restart. Fixes #19278. (#19335)

1. Move the signing to after we copy files that must be signed into the
app bundle
that will be signed: we sign in the _CodesignHotRestartAppBundle target,
so this
means the targets _CopyHotRestartBundleResources and
_CopyFilesToHotRestartSignedAppDirContents
   must execute first.

2. Try to clear up some confusion about the directories involved. The
HotRestartSignedAppOutputDir
property indicates the location of the _signed_ app bundle, which means
no files
should be added there. Instead files that should be signed (or present
when the
app launches) must be placed in the HotRestartAppBundlePath directory.

3. Document each property involved to try to avoid more mistakes in the
future.

Fixes #19278.


Backport of #19302

Co-authored-by: Rolf Bjarne Kvinge <rolf@xamarin.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[regression/8.0.0] SkiaSharp signature check fails for deployment (Visual Studio local iOS device)
6 participants