Cache the dynamic AppTheme value in Controls (and not Essentials) by jsuarezruiz · Pull Request #11200 · dotnet/maui

jsuarezruiz · 2022-11-08T13:24:02Z

Description of Change

Previously, the RequestedAppTheme and RequestedLayoutDiection values were cached on first access and this was incorrect as they can change at runtime - both by the OS and the user.

This PR makes a few changes:

Don't cache the theme and layout in Essentials as there is no way to update the cache
Don't cache the layout anywhere because this is only accessed once when the window is [re]created
Cache the theme in the Controls Application where the events can actually handle.

Issues Fixed

Fixes #8236 also related with #11005
Fixes (partially) #11299
Fixes #8606

This issue was inadvertently introduced in #7996 when all the Essentials fields were cached, when a few were dynamic.

Tasks

src/Essentials/src/AppInfo/AppInfo.android.cs

jonathanpeppers

What is the LOLs per second impact of this change?

You can try this app: https://github.com/jonathanpeppers/lols/tree/net7.0

src/Essentials/src/AppInfo/AppInfo.android.cs

UkeHa · 2023-02-23T12:16:51Z

what's the ETA of this issue being resolved?

The RequestedThemeChanged-Event is flimsy at best in both Android and iOS. With the trigger reacting only once in a blue moon and the app turning completely blank if you change the theme from the settings menu in iOS and try to switch back to the running app.

A bunch of changes so the code is fairly different.

src/Essentials/src/AppInfo/AppInfo.android.cs

src/Controls/src/Core/Application.cs

jonathanpeppers · 2023-03-08T14:44:19Z

src/Controls/src/Core/HandlerImpl/Window/Window.Impl.cs

-				FlowController.EffectiveFlowDirection = mauiContext.GetFlowDirection().ToEffectiveFlowDirection(true);
+				var flowDirection = Application?.PlatformLayoutDirection.ToFlowDirection() ?? FlowDirection.LeftToRight;
+				FlowController.EffectiveFlowDirection = flowDirection.ToEffectiveFlowDirection(true);


Is this only called once per new Window created?

Reverting the layout direction changes as this is a larger thing and affect locale. Android supports configuration changes on Application and Activity, and each have different effects and requirements.

I still reverted the lazy layout direction in the AppInfo as this just fires once when the handler changes - which should basically be once. This code also means that the Activity will need to restart if the locale changes. And this is done automatically by the OS because we don't have the ConfigChanges.Locale on the [Activity].

src/Controls/src/Core/Application.cs

src/Controls/src/Core/HandlerImpl/Application/Application.Impl.cs

src/Controls/src/Core/HandlerImpl/Window/Window.Impl.cs

-				FlowController.EffectiveFlowDirection = mauiContext.GetFlowDirection().ToEffectiveFlowDirection(true);
+				var flowDirection = Application?.PlatformLayoutDirection.ToFlowDirection() ?? FlowDirection.LeftToRight;
+				FlowController.EffectiveFlowDirection = flowDirection.ToEffectiveFlowDirection(true);


src/Essentials/src/AppInfo/AppInfo.android.cs

mattleibow · 2023-03-09T17:28:04Z

src/Controls/src/Core/HandlerImpl/Application/Application.Impl.cs

 		void IApplication.ThemeChanged()
 		{
-			if (UserAppTheme != AppTheme.Unspecified)
-				return;
-
-			TriggerThemeChangedActual();
+			PlatformAppTheme = AppInfo.RequestedTheme;
 		}


Instead of being smart here, we just cache the new value from the OS and let the application decide what it wants to do. It is the same class, but now the property responds in a normal way to raise an event if the value has changed.

mattleibow · 2023-03-09T17:28:54Z

src/Essentials/src/AppInfo/AppInfo.android.cs

-		static readonly Lazy<AppTheme> _requestedTheme = new Lazy<AppTheme>(GetRequestedTheme);
-		static readonly Lazy<LayoutDirection> _layoutDirection = new Lazy<LayoutDirection>(GetLayoutDirection);


We can't cache these as things in the Application.Context.Resources.Configuration are all dynamic - changeable by both the use and the OS internal processing.

Redth · 2023-03-15T14:09:44Z

/backport to net7.0

github-actions · 2023-03-15T14:10:00Z

Started backporting to net7.0: https://github.com/dotnet/maui/actions/runs/4427242243

github-actions · 2023-03-15T14:10:20Z

@Redth backporting to net7.0 failed, the patch most likely resulted in conflicts:

$ git am --3way --ignore-whitespace --keep-non-patch changes.patch

Applying: Fix RequestedThemeChanged on Android
Using index info to reconstruct a base tree...
M	src/Essentials/src/AppInfo/AppInfo.android.cs
Falling back to patching base and 3-way merge...
Auto-merging src/Essentials/src/AppInfo/AppInfo.android.cs
CONFLICT (content): Merge conflict in src/Essentials/src/AppInfo/AppInfo.android.cs
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
Patch failed at 0001 Fix RequestedThemeChanged on Android
When you have resolved this problem, run "git am --continue".
If you prefer to skip this patch, run "git am --skip" instead.
To restore the original branch and stop patching, run "git am --abort".
Error: The process '/usr/bin/git' failed with exit code 128

Please backport manually!

github-actions · 2023-03-15T14:10:21Z

@Redth an error occurred while backporting to net7.0, please check the run log for details!

Error: git am failed, most likely due to a merge conflict.

…1200) Previously, the RequestedAppTheme and RequestedLayoutDiection values were cached on first access and this was incorrect as they can change at runtime - both by the OS and the user. This PR makes a few changes: Don't cache the theme and layout in Essentials as there is no way to update the cache Don't cache the layout anywhere because this is only accessed once when the window is [re]created Cache the theme in the Controls Application where the events can actually handle. --------- Co-authored-by: Rui Marinho <me@ruimarinho.net> Co-authored-by: Matthew Leibowitz <mattleibow@live.com> # Conflicts: # src/Essentials/src/AppInfo/AppInfo.android.cs

…1200) (#13963) Previously, the RequestedAppTheme and RequestedLayoutDiection values were cached on first access and this was incorrect as they can change at runtime - both by the OS and the user. This PR makes a few changes: Don't cache the theme and layout in Essentials as there is no way to update the cache Don't cache the layout anywhere because this is only accessed once when the window is [re]created Cache the theme in the Controls Application where the events can actually handle. --------- Co-authored-by: Rui Marinho <me@ruimarinho.net> Co-authored-by: Matthew Leibowitz <mattleibow@live.com> # Conflicts: # src/Essentials/src/AppInfo/AppInfo.android.cs Co-authored-by: Javier Suárez <javiersuarezruiz@hotmail.com>

…1200) Previously, the RequestedAppTheme and RequestedLayoutDiection values were cached on first access and this was incorrect as they can change at runtime - both by the OS and the user. This PR makes a few changes: Don't cache the theme and layout in Essentials as there is no way to update the cache Don't cache the layout anywhere because this is only accessed once when the window is [re]created Cache the theme in the Controls Application where the events can actually handle. --------- Co-authored-by: Rui Marinho <me@ruimarinho.net> Co-authored-by: Matthew Leibowitz <mattleibow@live.com> # Conflicts: # src/Essentials/src/AppInfo/AppInfo.android.cs

…1200) (#14072) Previously, the RequestedAppTheme and RequestedLayoutDiection values were cached on first access and this was incorrect as they can change at runtime - both by the OS and the user. This PR makes a few changes: Don't cache the theme and layout in Essentials as there is no way to update the cache Don't cache the layout anywhere because this is only accessed once when the window is [re]created Cache the theme in the Controls Application where the events can actually handle. --------- Co-authored-by: Rui Marinho <me@ruimarinho.net> Co-authored-by: Matthew Leibowitz <mattleibow@live.com> # Conflicts: # src/Essentials/src/AppInfo/AppInfo.android.cs Co-authored-by: Javier Suárez <javiersuarezruiz@hotmail.com>

StepKie · 2023-05-30T16:57:19Z

Not sure why but I am on the latest Visual Studio (17.6.2) Maui version, and I still see #8236 - it will only fire once (i.e. if I register in App constructor, RequestThemeChanged will fire exactly the first time the user manually changes the system theme. Subsequent changes do not raise the event (ie. breakpoint is not hit)

This is NOT FIXED.

public App()
{
       RequestedThemeChanged += (s, a) => ConfigureTheme(a.RequestedTheme);
      // ... more initialization logic
}

private void ConfigureTheme(AppTheme requestedTheme)
{
       // On Android: Breakpoint here will only hit on first toggle between Light and Dark Mode
       //ConfigChanges.UiMode is set in MainActivity.cs according to MS documentation
       Log.Debug($"Requested {requestedTheme} theme.");
       UserAppTheme = requestedTheme;
}

Fix RequestedThemeChanged on Android

0df031b

jsuarezruiz added t/bug Something isn't working area-xaml XAML, CSS, Triggers, Behaviors platform/android labels Nov 8, 2022

jsuarezruiz mentioned this pull request Nov 15, 2022

Auto theme change doesn't behave as expected on .NET 7 whereas the same works fine on .NET 6 #11299

Closed

Merge branch 'main' into fix-8236

76e7a76

jsuarezruiz requested a review from jfversluis November 22, 2022 15:17

Redth previously requested changes Nov 22, 2022

View reviewed changes

src/Essentials/src/AppInfo/AppInfo.android.cs Outdated Show resolved Hide resolved

PureWeen requested review from Redth and jonathanpeppers December 5, 2022 23:20

jonathanpeppers reviewed Dec 5, 2022

View reviewed changes

src/Essentials/src/AppInfo/AppInfo.android.cs Outdated Show resolved Hide resolved

rmarinho and others added 3 commits February 1, 2023 15:25

Merge branch 'main' into fix-8236

1b8e5a3

Merge branch 'main' into fix-8236

9d38c70

Fix build error

14b4cf3

jsuarezruiz and others added 3 commits February 23, 2023 14:31

Merge branch 'main' into fix-8236

bc5225b

Merge branch 'main' into fix-8236

3911e83

ws

ee5d862

mattleibow changed the title ~~[Android] Fix RequestedThemeChanged event~~ [Android] Don't cache the dynamic AppTheme and LayoutDirection values Mar 7, 2023

Cache the changing theme values when they change

5da32cd

mattleibow changed the title ~~[Android] Don't cache the dynamic AppTheme and LayoutDirection values~~ Only cache the dynamic AppTheme and LayoutDirection values in Controls Mar 8, 2023

mattleibow requested review from PureWeen, jamesmontemagno, jonathanpeppers and mattleibow March 8, 2023 00:45

mattleibow self-assigned this Mar 8, 2023

mattleibow added the area-theme Themes, theming label Mar 8, 2023

jonathanpeppers reviewed Mar 8, 2023

View reviewed changes

mattleibow reviewed Mar 8, 2023

View reviewed changes

mattleibow requested review from PureWeen and mattleibow March 9, 2023 17:26

mattleibow reviewed Mar 9, 2023

View reviewed changes

jonathanpeppers approved these changes Mar 9, 2023

View reviewed changes

Merge branch 'main' into fix-8236

8c7735c

mattleibow approved these changes Mar 13, 2023

View reviewed changes

mattleibow enabled auto-merge (squash) March 13, 2023 17:09

mattleibow disabled auto-merge March 13, 2023 17:09

mattleibow enabled auto-merge (squash) March 13, 2023 17:09

mattleibow merged commit f14de87 into main Mar 14, 2023

mattleibow deleted the fix-8236 branch March 14, 2023 01:20

mattleibow mentioned this pull request Mar 15, 2023

[essentials] use Lazy<T> for Android application-wide values #7996

Merged

Redth added backport/suggested The PR author or issue review has suggested that the change should be backported. backport/approved After some discussion or review, this PR or change was approved to be backported. labels Mar 15, 2023

mattleibow mentioned this pull request Mar 15, 2023

[net7.0] Cache the dynamic AppTheme value in Controls (and not Essentials) (#11200) #13963

Merged

jsuarezruiz mentioned this pull request Apr 3, 2023

AppThemeBinding doesn't work on iOS in runtime #8606

Closed

mattleibow mentioned this pull request May 12, 2023

The theme does not apply on iOS #7733

Closed

StepKie mentioned this pull request May 31, 2023

Application.Current.RequestedThemeChanged event only raises once #15350

Closed

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

samhouts added the fixed-in-8.0.0-preview.3.8149 Look for this fix in 8.0.0-preview.3.8149! label Aug 2, 2024

		static readonly Lazy<AppTheme> _requestedTheme = new Lazy<AppTheme>(GetRequestedTheme);
		static readonly Lazy<LayoutDirection> _layoutDirection = new Lazy<LayoutDirection>(GetLayoutDirection);

Conversation

jsuarezruiz commented Nov 8, 2022 • edited by samhouts Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description of Change

Issues Fixed

Tasks

Uh oh!

Uh oh!

jonathanpeppers left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

UkeHa commented Feb 23, 2023

Uh oh!

Uh oh!

Uh oh!

jonathanpeppers Mar 8, 2023

Choose a reason for hiding this comment

Uh oh!

This comment was marked as outdated.

Uh oh!

mattleibow Mar 9, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

This comment was marked as outdated.

Uh oh!

Uh oh!

mattleibow Mar 9, 2023

Choose a reason for hiding this comment

Uh oh!

mattleibow Mar 9, 2023

Choose a reason for hiding this comment

Uh oh!

Redth commented Mar 15, 2023

Uh oh!

github-actions bot commented Mar 15, 2023

Uh oh!

github-actions bot commented Mar 15, 2023

Uh oh!

github-actions bot commented Mar 15, 2023

Uh oh!

StepKie commented May 30, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

10 participants

jsuarezruiz commented Nov 8, 2022 •

edited by samhouts

Loading

StepKie commented May 30, 2023 •

edited

Loading