Updated Templates for Blazor apps for MacCatalyst #14196

dustin-wojciechowski · 2023-03-24T23:38:13Z

Description of Change

I updated the Maui templates to address issues brought up in #12293. I set this to draft because I am unsure of some of the approaches I've taken. I created a PR in Xamarin-macios to address the maccatalyst templates we have there: xamarin/xamarin-macios#17830

Created comment section in csproj explaining how to set the correct RuntimeIdentifiers when publishing.
Created conditional property groups based on Debug and Release to handle codesigning, package signing, etc.
Created two Entitlement files, Debug and Release. The two were necessary because <key>com.apple.security.get-task-allow<key> is necessary to be able to use Dev tools while debugging Blazor apps, while com.apple.security.app-sandbox is required by the App Store for publishing and com.apple.security.network.client is necessary for Blazor apps when sandbox is enabled.
Two keys added to the Info.plist: <ITSAppUsesNonExemptEncryption> and <LSApplicationCategoryType>

Also, if these are transferrable to other macios/iOS templates, I could also add them to their respective templates in future PR's.

Fixes #5561
Fixes #14219
Fixes #13080
Fixes #7706

ed comments in csproj for publishing to Mac App store. Modified Info.plist to add necessary keys for publishing.

dustin-wojciechowski · 2023-03-24T23:46:01Z

/azp run

azure-pipelines · 2023-03-24T23:46:16Z

Azure Pipelines successfully started running 2 pipeline(s).

jfversluis

We also need this for the regular templates, at least the Entitlements.Debug.plist so that we can also inspect WebViews there. In that case also add this one to the "fixes" list: #7706

And some failing tests...

jfversluis · 2023-03-30T07:40:09Z

src/Templates/src/templates/maui-blazor/MauiApp.1.csproj

+    <!-- Notes for Publishing on the Mac App Store:
+    1. For macOS it's possible to sign both the app bundle (EnableCodesigning=true) and the package (*.pkg) (EnablePackageSigning=true),
+       and these are signed separately and with different certificates.
+          CodesignKey: this is the signing key used for the app bundle
+          PackageSigningKey: this is the signing key used for the package
+    2. Publishing to the App Store requires signing both the app bundle and the package.
+          Must be 'Apple Distribution: ...' for the app bundle. Note that apps signed like this will not execute locally.
+          They have to be published to the App Store and then downloaded (Apple will resign the app with a different signing identity that allows for local execution).
+          Must be '3rd Party Mac Developer Installer: ...' for the pkg
+    3. Publishing outside of the App Store (i.e. only notarizing) requires:
+          Must be 'Developer ID Application: ...' for the app bundle
+          Must be 'Developer ID Installer: ...' for the pkg
+    4. During development, use the 'Apple Development: ...' signing key (typically to verify that the app works when is signed and entitlements are enforced).
+    5. Depending on the entitlements the app needs, a specific provisioning profile (CodesignProvision) might be needed.
+    6. UseHardenedRuntime must be set to true when app sandbox is enabled in Info.plist.
+    -->


While this is pretty epic!!!!

Should we consider moving this to a more lively document with an aka.ms link maybe? That will give us the ability to update it needed without publishing an update. And also I'm not sure if people would be really happy with paragraphs of comments in their csproj?

Ah, I'll remove it and perhaps make a link to some documentation. Would this be the right section for it? https://learn.microsoft.com/en-us/dotnet/maui/mac-catalyst/deployment/?view=net-maui-7.0

jfversluis · 2023-03-30T07:40:32Z

src/Templates/src/templates/maui-blazor/MauiApp.1.csproj

+    <!--
+    <CodesignProvision>YOUR PROFILE NAME</CodesignProvision>
+    <CodesignKey>Apple Development: YOURNAME (*******)</CodesignKey>
+    -->


Is this intentional? Should it have some instructions as well?

jfversluis · 2023-03-30T07:40:50Z

src/Templates/src/templates/maui-blazor/MauiApp.1.csproj

+    <!--
+    <CodesignKey>Apple Development: YOURNAME (*******)</CodesignKey>
+    <CodesignProvision>YOUR PROFILE NAME</CodesignProvision>
+    <PackageSigningKey>3rd Party Mac Developer Installer: YOURNAME (*******)</PackageSigningKey>
+    -->


Same as above. We have docs about this now, maybe also aka.ms link those?

jfversluis · 2023-03-30T07:46:45Z

src/Templates/src/templates/maui-blazor/MauiApp.1.csproj

+    <EnableCodeSigning>True</EnableCodeSigning>
+    <ProvisionType>Manual</ProvisionType>
+    <CreatePackage>true</CreatePackage>
+    <EnablePackageSigning>true</EnablePackageSigning>
+    <CodesignEntitlements>Platforms/MacCatalyst/Entitlements.Release.plist</CodesignEntitlements>
+    <UseHardenedRuntime>true</UseHardenedRuntime>


This is probably why the test is failing. Should we enable this or just add some instructions?
First, this will complicate our pipeline and we need to manually add valid certs each year etc.

Second, this is not something people have today and I think the tooling will now already help get some of this in there? Or at the very least the documentation is there... But not sure what the best option is to do this.

… relocate those to docs.

dustin-wojciechowski · 2023-04-04T03:39:57Z

Per @jfversluis, I've removed the content from the csproj and will update it with a link to the documentation when it's been updated. Also working on getting as much in here without breaking any tests.

Eilon · 2023-04-05T19:42:18Z

src/Templates/src/templates/maui-blazor/MauiApp.1.csproj

@@ -60,6 +60,9 @@
        <PackageReference Include="Microsoft.Extensions.Logging.Debug" Version="MS_EXT_VERSION" />
    </ItemGroup>

+  <!-- Build Properties must be defined within these property groups to ensure successful publishing
+       to the App Store. See "Define build properties in your project file" here:
+       https://learn.microsoft.com/en-us/dotnet/maui/mac-catalyst/deployment/publish-app-store -->


This needs to be an aka.ms link

Make sure you remove the en-us from the URL so that people don't always go to the English-US docs. If you omit the en-us then it will auto-redirect to the docs in the user's preferred locale

(Same applies to all other links.)

Eilon · 2023-04-05T19:45:04Z

Per @jfversluis 's comment, the same changes need to be present in the maui-mobile template as well (they can also use WebViews, or people can add a BlazorWebView to them).

Eilon · 2023-04-07T18:42:31Z

src/Templates/src/templates/maui-blazor/MauiApp.1.csproj

+         <!-- Note for MacCatalyst:
+            The default runtime is maccatalyst-x64, except in Release config, in which case the default is maccatalyst-x64;maccatalyst-arm64.
+            When specifying both architectures, use the plural <RuntimeIdentifiers> instead of the singular <RuntimeIdentifer>.
+            The App Store will NOT accept apps with ONLY maccatalyst-arm64 indicated;


Suggested change

The App Store will NOT accept apps with ONLY maccatalyst-arm64 indicated;

The Mac App Store will NOT accept apps with ONLY maccatalyst-arm64 indicated;

In case any reader is unfamiliar with the generic sounding term "App Store," I suggest adding "Mac" to the name.

The Apple App Store guidelines specifically mention that either form is acceptable, but I think the more specific one could be more helpful.

Guidelines: https://developer.apple.com/app-store/marketing/guidelines/

App Store
Always typeset App Store with an uppercase A and an uppercase S followed by lowercase letters.

Refer to just the App Store unless you need to be more specific; in that case, you can use App Store for iPhone, App Store for iPad, Mac App Store, App Store for Apple TV, App Store for Apple Watch, or App Store for iMessage. To refer to all the versions, use this order: App Store for iPhone, iPad, Mac, Apple Watch, Apple TV, and iMessage. Don’t use terms such as Apple Watch App Store or App Store for watchOS.

Eilon · 2023-04-07T18:44:20Z

src/Templates/src/templates/maui-blazor/Platforms/MacCatalyst/Info.plist

@@ -2,6 +2,15 @@
 <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
 <plist version="1.0">
 <dict>
+    <!-- The App store requires you specify if the app uses encryption. -->


Suggested change





(At a minimum the S needs to be capitalized, but I suggest also prefixing Mac.)

Eilon · 2023-04-07T18:45:36Z

src/Templates/src/templates/maui-mobile/MauiApp.1.csproj

@@ -48,7 +56,23 @@
 	</ItemGroup>

 	<ItemGroup>
-		<PackageReference Include="Microsoft.Extensions.Logging.Debug" Version="MS_EXT_VERSION" />
+		<PackageReference Include="Microsoft.Extensions.Logging.Debug" Version="$(MicrosoftExtensionsPackageVersion)" />


Hmm is this change deliberate? These templates have some funky pre-processing that is applied as part of the build to substitute a specific version that ends up baked into the shipped template.

Oof, accidentally got modified, thanks!

Eilon

Looks really good! Just a few small comments for you to consider.

Eilon · 2023-04-10T19:03:07Z

src/Templates/src/templates/maui-mobile/MauiApp.1.csproj

+  <PropertyGroup Condition="'$(Configuration)|$(TargetFramework)|$(Platform)'=='Debug|DOTNET_TFM-ios|AnyCPU'">
+    <CreatePackage>false</CreatePackage>
+  </PropertyGroup>
+  <PropertyGroup Condition="'$(Configuration)|$(TargetFramework)|$(Platform)'=='Release|DOTNET_TFM-ios|AnyCPU'">
+    <CreatePackage>false</CreatePackage>
+  </PropertyGroup>


These 6 lines (72-77) appear here, but not in the maui-blazor template. Is that deliberate? If so, why?

Sorry, I'm not sure how this got in there, I'm not quite sure if that was generated by VS for Mac or if I mistakenly included it somehow :(

Eilon

Just one last comment 😄

Eilon

Looks great to me!

Eilon · 2023-04-10T21:45:36Z

@dustin-wojciechowski I appreciate all your effort and patience in this issue. Updating templates is both the easiest thing in the world, and the most difficult thing in the world 😁

Redth · 2023-08-16T15:30:53Z

Linking this for more context: #16355

We talked about cleaning up the templates so that we can remove the entitlements files from the template, as well as the csproj entries. We can instead have some of the basic entitlements set by default in the macios SDK so that this is all unnecessary to be included in our MAUI templates, and users are still able to disable the default entitlements included in these scenarios.

Redth · 2023-08-16T15:31:50Z

Here's the macios PR: xamarin/xamarin-macios#18669

dustin-wojciechowski added 3 commits March 24, 2023 14:54

For Maui Blazor Templates: Added Debug and Release Entitlements. Add

ae35394

ed comments in csproj for publishing to Mac App store. Modified Info.plist to add necessary keys for publishing.

Corrected keys in info.plist not within <dict>

fda811d

Added missing newlines to end of Entitlements plists.

64490b4

dustin-wojciechowski added platform/macOS 🍏 macOS / Mac Catalyst area-templates Project templates, Item Templates for Blazor and MAUI Blazor ❤️ MAUI Issues in MAUI functionality that affect Blazor, but are not bugs in Blazor itself labels Mar 24, 2023

jfversluis requested changes Mar 30, 2023

View reviewed changes

jfversluis reviewed Mar 30, 2023

View reviewed changes

rmarinho requested a review from Eilon March 30, 2023 10:52

Eilon added the area-blazor Blazor Hybrid / Desktop, BlazorWebView label Mar 30, 2023

Removed commented directions from csproj and code sign portions. Will…

2e3900e

… relocate those to docs.

Added links to the Maui Publishing docs where relevant.

fddeb41

dustin-wojciechowski marked this pull request as ready for review April 5, 2023 00:01

dustin-wojciechowski requested a review from a team as a code owner April 5, 2023 00:01

dustin-wojciechowski requested a review from jfversluis April 5, 2023 00:01

Eilon reviewed Apr 5, 2023

View reviewed changes

dustin-wojciechowski added 2 commits April 6, 2023 20:42

Modified links to use aka.ms

6c76422

Modified templates for maccatalyst for maui-mobile. Reworded comment.

33cb804

Eilon reviewed Apr 7, 2023

View reviewed changes

Eilon requested changes Apr 7, 2023

View reviewed changes

dustin-wojciechowski added 2 commits April 10, 2023 10:30

Correct usage to 'Mac App Store' in comments

1da4de6

Reverted back Logging version that got changed by accident

82dcbc3

Eilon reviewed Apr 10, 2023

View reviewed changes

Removed unnecessary code from csproj

56036d6

dustin-wojciechowski requested a review from Eilon April 10, 2023 19:22

Eilon approved these changes Apr 10, 2023

View reviewed changes

jfversluis approved these changes Apr 11, 2023

View reviewed changes

rmarinho closed this Apr 11, 2023

rmarinho reopened this Apr 11, 2023

rmarinho enabled auto-merge (squash) April 11, 2023 16:03

rmarinho merged commit 9fdfc84 into main Apr 11, 2023
30 checks passed

rmarinho deleted the dev/Update-Blazor-Templates branch April 11, 2023 18:44

dustin-wojciechowski mentioned this pull request Apr 12, 2023

Developing a Maui Blazor MacCatalyst app for Apple macOS store is a terrible experience #12293

Closed

24 tasks

samhouts added the backport/suggested The PR author or issue review has suggested that the change should be backported. label Jul 28, 2023

hartez added the backport/NO This change should not be backported. It may break customers. label Aug 16, 2023

github-actions bot locked and limited conversation to collaborators Dec 12, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Updated Templates for Blazor apps for MacCatalyst #14196

Updated Templates for Blazor apps for MacCatalyst #14196

dustin-wojciechowski commented Mar 24, 2023 •

edited

dustin-wojciechowski commented Mar 24, 2023

azure-pipelines bot commented Mar 24, 2023

jfversluis left a comment •

edited

jfversluis Mar 30, 2023

dustin-wojciechowski Apr 3, 2023

jfversluis Mar 30, 2023

jfversluis Mar 30, 2023

jfversluis Mar 30, 2023

dustin-wojciechowski commented Apr 4, 2023

Eilon Apr 5, 2023

Eilon Apr 5, 2023

Eilon commented Apr 5, 2023

Eilon Apr 7, 2023

Eilon Apr 7, 2023

Eilon Apr 7, 2023

dustin-wojciechowski Apr 10, 2023

Eilon left a comment

Eilon Apr 10, 2023

dustin-wojciechowski Apr 10, 2023

Eilon left a comment

Eilon left a comment

Eilon commented Apr 10, 2023

Redth commented Aug 16, 2023

Redth commented Aug 16, 2023

	The App Store will NOT accept apps with ONLY maccatalyst-arm64 indicated;
	The Mac App Store will NOT accept apps with ONLY maccatalyst-arm64 indicated;

	<!-- The App store requires you specify if the app uses encryption. -->
	<!-- The Mac App Store requires you specify if the app uses encryption. -->

Updated Templates for Blazor apps for MacCatalyst #14196

Updated Templates for Blazor apps for MacCatalyst #14196

Conversation

dustin-wojciechowski commented Mar 24, 2023 • edited

Description of Change

dustin-wojciechowski commented Mar 24, 2023

azure-pipelines bot commented Mar 24, 2023

jfversluis left a comment • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dustin-wojciechowski commented Apr 4, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Eilon commented Apr 5, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Eilon left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Eilon left a comment

Choose a reason for hiding this comment

Eilon left a comment

Choose a reason for hiding this comment

Eilon commented Apr 10, 2023

Redth commented Aug 16, 2023

Redth commented Aug 16, 2023

dustin-wojciechowski commented Mar 24, 2023 •

edited

jfversluis left a comment •

edited