Multiple Fixes for Resizetizer (esp. Android App Icons) #8020

mattleibow · 2022-06-14T17:00:06Z

Description of Change

This PR is a massive set of changes and test data to fix issues and ensure they stay fixed. I have listed all the issues that I know have been fixed, but I actually may have fixed a few more based on visual inspection.

I have added logic so that test runs can be cached in the working folder for git, and then CI/subsequent runs can use the reference image. This is far easier that what I was doing by picking pixels and checking colors. There is no way I could have done that with the various permutations. And, it is a much better with a visual inspection.

This PR is part of the larger effort to improve Resizetizer with many issues linked from this top-level issue: #7970

This URL can be used to view the diff without all the test reference images (600 of them!): https://github.com/dotnet/maui/pull/8020/files?file-filters%5B%5D=.appxmanifest&file-filters%5B%5D=.cs&file-filters%5B%5D=.csproj&file-filters%5B%5D=.projitems&file-filters%5B%5D=.storyboard&file-filters%5B%5D=.svg&file-filters%5B%5D=.targets&file-filters%5B%5D=.xml&show-viewed-files=true

Issues Fixed

General Fixes

Fixes Android app icons do not respect foreground scale and tint #7986
Fixes SVG Icon display and scaling issues, platform dependent. #7629
Fixes Android app icons with just a single image (no ForegroundFile) do not render #7987
Fixes [Android] MauiIcon BaseSize and ForegroundScale doesn't work #7305
Fixes [Windows] MauiIcon Color and TintColor doesn't work in taskbar and is inconsistent elsewhere #7207
Fixes an issue where SVG files will still be converted to invalid android vectors if Resize=False
Improved the image generation if only 1 image was provided for an icon by making that image the foreground on top of a Color background

Splash Screen Fixes

Currently if you make any changes to the MauiSplashScreen properties (such as set a foreground tint) then it does not actually trigger a new splash to be generated.

Also, on iOS and Mac Catalyst, the generated storyboard does not actually use the new image if there was an alias/Link set.

Android Manifest Update Fixes

Moved to #8063

mattleibow · 2022-06-14T17:14:30Z

eng/automation/SignList.xml

@@ -32,7 +32,6 @@
    <ThirdParty Include="ShimSkiaSharp.dll" />
    <ThirdParty Include="Fizzler.dll" />
    <ThirdParty Include="Newtonsoft.Json.dll;" />
-    <ThirdParty Include="Svg2VectorDrawable.Net.dll" />


Removing this svg2vector as the library is not currently used nor is it super useful if it is.

mattleibow · 2022-06-14T17:18:20Z

src/SingleProject/Resizetizer/test/UnitTests/BaseTest.cs

+		protected void AssertFileMatches(string destinationFilename, object[] args = null, [CallerMemberName] string methodName = null) =>
+			AssertFileMatchesReal(destinationFilename, args, methodName);
+
+		protected void SaveImageResultFile(string destinationFilename, object[] args = null, [CallerMemberName] string methodName = null) =>
+			SaveImageResultFileReal(destinationFilename, args, methodName);


These 2 methods can be used to generate (in source folder) and then test/compare results. Typically, you would:

use SaveImageResultFile locally at the end of the tests with all the files you want

ensure the image is correct

replace with AssertFileMatches

push to git

CI will come along and run the tests and compare. And, if you use a smart git tool, the tool can show you diffs of git files and you can use runs locally to ensure you did not break anything.

Did you check if we could use an assertion library like Verify?

https://github.com/VerifyTests/Verify

Might simplify some of the test code.

There is an older one called ApprovalTests, but it only worked on Windows.

.nuspec/Microsoft.Maui.Resizetizer.targets

src/Templates/src/templates/maui-mobile/Platforms/Android/AndroidManifest.xml

.nuspec/Microsoft.Maui.Resizetizer.targets

moved to #8063

jonathanpeppers

I like all the tests!

I couldn't find any code issues to comment about, and hopefully the changes are tested well enough.

jonathanpeppers · 2022-06-15T14:11:02Z

src/SingleProject/Resizetizer/test/UnitTests/BaseTest.cs

+		protected void AssertFileMatches(string destinationFilename, object[] args = null, [CallerMemberName] string methodName = null) =>
+			AssertFileMatchesReal(destinationFilename, args, methodName);
+
+		protected void SaveImageResultFile(string destinationFilename, object[] args = null, [CallerMemberName] string methodName = null) =>
+			SaveImageResultFileReal(destinationFilename, args, methodName);


Did you check if we could use an assertion library like Verify?

https://github.com/VerifyTests/Verify

Might simplify some of the test code.

There is an older one called ApprovalTests, but it only worked on Windows.

mattleibow · 2022-06-15T16:24:39Z

Ooh, VerifyTests/Verify looks nice! I'll do that in a separate PR so that this one can be merged without ant testing changes.

janseris · 2022-06-15T19:25:03Z

Thanks. Now there are Windows issues as well with icon - aspect ratio, resizing, color, background color etc. properties. Will the fixes follow this one?

mattleibow · 2022-06-15T19:28:40Z

Thanks. Now there are Windows issues as well with icon - aspect ratio, resizing, color, background color etc. properties. Will the fixes follow this one?

@janseris this PR fixes all the platforms.

Redth · 2022-06-15T19:29:17Z

Thanks. Now there are Windows issues as well with icon - aspect ratio, resizing, color, background color etc. properties. Will the fixes follow this one?

This was just merged 7 minutes ago. It will be released in the next MAUI servicing release. There are multiple fixes in this PR, do you have a specific reproduction you can attach to a new issue for the problem you're referring to?

janseris · 2022-06-15T19:42:53Z

@Redth @mattleibow great, thank you for info.
I am referring to issues I opened some weeks ago based on the info that this mentions mostly Android.
I will try out all the features just when it is released.
What is the release date of this fix, please?

Symbai · 2022-06-16T00:00:38Z

You can try it out right now, see #7653

Syed-RI · 2022-07-12T23:01:28Z

🙌

TamerIrdais · 2022-09-11T22:14:57Z

When are all these issues are going to be officially released?

Syed-RI · 2022-09-11T22:50:59Z

Same here

TamerIrdais · 2022-09-16T11:11:28Z

Anyone care to reply please? we need to know when these changes are going to be released, this is urgent.
We still have all kind of problems with MauiIcon and MauiSplashScreen.

mattleibow · 2022-09-16T17:35:28Z

They will be released with visual studio 17.4 preview 2.1 in a few days I believe.

TamerIrdais · 2022-10-11T14:07:38Z

@mattleibow I tried these issues on VS 2022 17.4 Preview 2.1 and they are still active, MauiIcon and MauiSplashScreen looks very bad on almost all platforms, the icon is stretched and not fit also splash screen looks bad, are there any limitations on the SVG files that should be used for icon and splash screen? I can't figure this out this is so frustrating.

mattleibow · 2022-10-11T19:41:43Z

This PR was more for app icons, but the issue describe was just fixed here: #10516

TamerIrdais · 2022-10-12T05:21:00Z

@mattleibow I didn't understand your comment, the app icons are not working as expected and so is splash screen, so can you guys provide us with time estimate on when both (app icons and splash screens) are going to be working as expected?

mattleibow · 2022-10-12T06:50:39Z

This is an old PR. Please open a new issue or comment on an open issue.

Also, make sure you describe what is happening when you say not working.

And also, some issues may be fixed in rc1 or rc2 of net7.

But the main thing is that commenting on a merged PR almost always means it goes unnoticed.

janseris · 2022-10-12T07:06:54Z

The question is when this fix is released for MAUI users in Visual Studio, we don't pull and build maui repo after each commit/merge request.

mattleibow · 2022-10-12T09:34:06Z

This was released in vs preview 2.1. I am not sure what you are seeing. Can you attach a screenshot? As far as I was aware, the app icons should be fixed. If not, then something else is gone wrong or maybe I am not considering some scenarios.

Please open a new issue with screenshots of what you see and maybe the icon files in a file new template so I can make sure I get all the things tested.

"not working as expected" is very hard to debug.

TamerIrdais · 2022-10-12T17:29:44Z

@mattleibow I have reported my issues as a bug as you asked and below is the link for the new incident I opened, please take a look at it since I attached my test project along with my icon and splash screen I used and let me know your findings:

https://developercommunity.visualstudio.com/t/NET-MAUI-Icon-and-Splash-screen-Looks-B/10170967?port=1025&fsid=cb20e18e-7f70-4066-8f8f-339d741f2ef2&entry=myfeedback&ref=native&refTime=1665595654824&refUserId=da8d7ff5-f3e6-6caf-b43e-56d325e3cf9f

mattleibow requested a review from a team as a code owner June 14, 2022 17:00

This was referenced Jun 14, 2022

Fix Android adaptive icon generation #7994

Closed

Regenerate splash screen on changes and respect alias #7993

Closed

Automatically add MauiIcon to AndroidManifest.xml #7968

Closed

mattleibow added this to the 6.0-sr2 milestone Jun 14, 2022

mattleibow self-assigned this Jun 14, 2022

mattleibow added the area-single-project Splash Screen, Multi-Targeting, MauiFont, MauiImage, MauiAsset, Resizetizer label Jun 14, 2022

mattleibow changed the title ~~Multiple fixes for resizetizer~~ Multiple Fixes for Resizetizer (esp. Android App Icons) Jun 14, 2022

mattleibow commented Jun 14, 2022

View reviewed changes

src/Templates/src/templates/maui-mobile/Platforms/Android/AndroidManifest.xml Outdated Show resolved Hide resolved

mattleibow requested review from Redth and jonathanpeppers June 14, 2022 17:22

hartez approved these changes Jun 14, 2022

View reviewed changes

jonathanpeppers previously requested changes Jun 14, 2022

View reviewed changes

.nuspec/Microsoft.Maui.Resizetizer.targets Outdated Show resolved Hide resolved

This comment was marked as off-topic.

Sign in to view

jfversluis mentioned this pull request Jun 15, 2022

[Bug] <MauiImage> won't accept PNG file for Android AppIcon #2972

Closed

This comment was marked as off-topic.

Sign in to view

mattleibow removed a link to an issue Jun 15, 2022

Android does not automatically update the manifests with MauiIcon #7971

Closed

Merge all the chnages from all the PRs

d88716c

mattleibow force-pushed the dev/resizetizer branch from ccce376 to d88716c Compare June 15, 2022 13:44

mattleibow requested a review from jonathanpeppers June 15, 2022 13:48

manuelelucchi mentioned this pull request Jun 15, 2022

IsVisible doesn't work anymore #8044

Closed

jonathanpeppers approved these changes Jun 15, 2022

View reviewed changes

mattleibow merged commit abcf2be into net6.0 Jun 15, 2022

mattleibow deleted the dev/resizetizer branch June 15, 2022 19:20

mattleibow mentioned this pull request Jul 11, 2022

Replace/implement image comparison for device/unit tests #8661

Open

This was referenced Aug 30, 2022

[Android] MauiSplashScreen BaseSize doesn't work #7304

Closed

[Android] Icon shows default android image when ForegroundFile in MauiIcon is not set #7203

Closed

Android app icon not displaying #7017

Closed

janseris mentioned this pull request Sep 12, 2022

Hide "Loading..." behind the splash screen or any other solution #10044

Closed

mattleibow mentioned this pull request Nov 3, 2022

MauiImage resource not work with TintColor #8527

Closed

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

samhouts added the fixed-in-6.0.408 Look for this fix in 6.0.408! label Aug 2, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Multiple Fixes for Resizetizer (esp. Android App Icons) #8020

Multiple Fixes for Resizetizer (esp. Android App Icons) #8020

mattleibow commented Jun 14, 2022 •

edited

Loading

mattleibow Jun 14, 2022

mattleibow Jun 14, 2022

jonathanpeppers Jun 15, 2022

This comment was marked as off-topic.

This comment was marked as off-topic.

jonathanpeppers left a comment

jonathanpeppers Jun 15, 2022

mattleibow commented Jun 15, 2022

janseris commented Jun 15, 2022 •

edited

Loading

mattleibow commented Jun 15, 2022

Redth commented Jun 15, 2022

janseris commented Jun 15, 2022

Symbai commented Jun 16, 2022

Syed-RI commented Jul 12, 2022

TamerIrdais commented Sep 11, 2022

Syed-RI commented Sep 11, 2022

TamerIrdais commented Sep 16, 2022

mattleibow commented Sep 16, 2022

TamerIrdais commented Oct 11, 2022

mattleibow commented Oct 11, 2022

TamerIrdais commented Oct 12, 2022

mattleibow commented Oct 12, 2022

janseris commented Oct 12, 2022 •

edited

Loading

mattleibow commented Oct 12, 2022

TamerIrdais commented Oct 12, 2022

Multiple Fixes for Resizetizer (esp. Android App Icons) #8020

Multiple Fixes for Resizetizer (esp. Android App Icons) #8020

Conversation

mattleibow commented Jun 14, 2022 • edited Loading

Description of Change

Issues Fixed

General Fixes

Splash Screen Fixes

Android Manifest Update Fixes

mattleibow Jun 14, 2022

Choose a reason for hiding this comment

mattleibow Jun 14, 2022

Choose a reason for hiding this comment

jonathanpeppers Jun 15, 2022

Choose a reason for hiding this comment

This comment was marked as off-topic.

This comment was marked as off-topic.

jonathanpeppers left a comment

Choose a reason for hiding this comment

jonathanpeppers Jun 15, 2022

Choose a reason for hiding this comment

mattleibow commented Jun 15, 2022

janseris commented Jun 15, 2022 • edited Loading

mattleibow commented Jun 15, 2022

Redth commented Jun 15, 2022

janseris commented Jun 15, 2022

Symbai commented Jun 16, 2022

Syed-RI commented Jul 12, 2022

TamerIrdais commented Sep 11, 2022

Syed-RI commented Sep 11, 2022

TamerIrdais commented Sep 16, 2022

mattleibow commented Sep 16, 2022

TamerIrdais commented Oct 11, 2022

mattleibow commented Oct 11, 2022

TamerIrdais commented Oct 12, 2022

mattleibow commented Oct 12, 2022

janseris commented Oct 12, 2022 • edited Loading

mattleibow commented Oct 12, 2022

TamerIrdais commented Oct 12, 2022

mattleibow commented Jun 14, 2022 •

edited

Loading

janseris commented Jun 15, 2022 •

edited

Loading

janseris commented Oct 12, 2022 •

edited

Loading