Remove all usage of Device throughout the repo #4982

mattleibow · 2022-03-01T11:42:51Z

Description of Change

The Device class now no longer holds any new or useful functionality that cannot be found in a better and more coherent place after #1965 .

This PR now goes and marks Device as obsolete and then replaces all usages with the new and improved APIs. Device now just exists as an obsolete compatibility API.

Issues Fixed

Fixes #4549

Eilon

The Blazor changes look fine to me.

jonathanpeppers · 2022-03-01T17:58:38Z

src/Compatibility/ControlGallery/src/Core/ControlGalleryPages/CellForceUpdateSizeGalleryPage.cs

-						if (Device.RuntimePlatform == Device.iOS)
+						if (DeviceInfo.Platform == DevicePlatform.iOS)


Should checks like these use the OperatingSystem class?

https://docs.microsoft.com/dotnet/api/system.operatingsystem.isios?view=net-6.0

Do we even need DeviceInfo.Platform?

I agree, OperatingSystem is the recommended API going forward.

It also makes it easier for the linker to trim out code since e.g. OperatingSystem.IsIOS() is hardcoded to true in the BCL on these platforms (though one thing to keep in mind is that IsIOS() also returns true on Catalyst, so you need to check !IsMacCatalyst() if you really only mean iOS).

I guess one issue is that DevicePlatform has entries for UWP/Tizen which OperatingSystem does not, though it should still be worthwhile to switch the other cases.

Is it possible for the BCL API to have a more generic API? Instead of IsXxx and have a string based one? Or even mark some api as a "this method returns true on platform X"? So we can add our own platforms and then inform the linker?

I suppose IsOSPlatform("Tizen") exists and is linker-friendly? Maybe we can use that? If Samsung implemented it...

yeah OperatingSystem.IsOSPlatform("Tizen") should work (assuming they implement it), but it won't be linker friendly since the linker can't tell it from the string I think.

Looking around in dotnet/runtime it seems that they instead opted to be regarded as a Linux distribution like Ubuntu, Debian, etc. and just return true for .IsLinux().

mattleibow · 2022-03-01T17:53:58Z

src/BlazorWebView/src/Maui/Android/BlazorWebViewHandler.Android.cs

+			_webviewManager = new AndroidWebKitWebViewManager(
+				PlatformView,
+				Services!,
+				new MauiDispatcher(Services!.GetRequiredService<IDispatcher>()),


Instead of using the Device.Invoke we can just capture the dispatcher at the time of adding the view to the UI. This changes for all platforms.

mattleibow · 2022-03-01T17:59:51Z

src/Compatibility/Core/src/Android/AppCompat/NavigationPageRenderer.cs

-			Device.StartTimer(TimeSpan.FromMilliseconds(10), () =>
-			{
-				UpdateToolbar();
-				return false;
-			});
+			PostDelayed(() => UpdateToolbar(), 10);


In some cases I just used the native "run on UI thread" stuff as that means we don't need to care about passing a dispatcher or the maui control in.

mattleibow · 2022-03-01T18:04:09Z

src/Compatibility/Core/src/Android/CollectionView/ItemsSourceFactory.cs

-		public static IItemsViewSource Create(IEnumerable itemsSource, ICollectionChangedNotifier notifier)
+		public static IItemsViewSource Create(IEnumerable itemsSource, BindableObject container, ICollectionChangedNotifier notifier)


@PureWeen I saw this was done for ObservableItemTemplateCollection for Windows, so I copied that. Mainly just for the dispatcher, but if we pass the view in, then we never have to worry about reaching out into the Application. or Device. worlds.

Not sure if this is going to do terrible things with lifetime and/or memory. If so, we can change and find another way.

mattleibow · 2022-03-01T18:04:51Z

src/Compatibility/Core/src/Android/CollectionView/ObservableGroupedSource.cs

-				var source = ItemsSourceFactory.Create(_groupSource[n] as IEnumerable, this);
+				var source = ItemsSourceFactory.Create(_groupSource[n] as IEnumerable, _groupableItemsView, this);


Here is an example of apssing in the groupable view itself into the items source collection thing above.

mattleibow · 2022-03-01T18:06:04Z

src/Compatibility/Core/src/Android/Forms.cs

+		[Obsolete]
 		public static void Init(IActivationState activationState, InitializationOptions? options = null) =>
 			Init(activationState.Context, options);


I marked all of the Init things in the Forms type obsolete so that everyone knows not to use it. It is still used internally for now, but this is basically a non-public thing with all the work for the hosting and registration.

mattleibow · 2022-03-01T18:06:48Z

src/Compatibility/Core/src/AppHostBuilderExtensions.Android.cs

+#pragma warning disable CS0612 // Type or member is obsolete
 					Forms.Init(state, new InitializationOptions { Flags = InitializationFlags.SkipRenderers });
+#pragma warning restore CS0612 // Type or member is obsolete


In order for us to still use the Forms.Init in the builder, we can just do this. Eventually, all this goes away and it is pretty slim right now anyway.

mattleibow · 2022-03-01T18:23:36Z

src/Compatibility/Core/tests/Android/ObservrableItemsSourceTests.cs

-			var ois = ItemsSourceFactory.Create(source, new MockCollectionChangedNotifier());
+			var ois = ItemsSourceFactory.Create(source, Application.Current, new MockCollectionChangedNotifier());


This is weird, but this is exactly what Device.InvokeOnMainThread did. And in the case of a test, the "container" is the app. So... yeah?

mattleibow · 2022-03-01T18:35:06Z

src/Controls/src/Core/Device.cs

@@ -10,30 +10,41 @@
 namespace Microsoft.Maui.Controls
 {
 	/// <include file="../../docs/Microsoft.Maui.Controls/Device.xml" path="Type[@FullName='Microsoft.Maui.Controls.Device']/Docs" />
+	//[Obsolete]


Can't go 100% removed because of Device.GetNamedSize and potentially Device.Styles

mattleibow · 2022-03-01T18:38:03Z

src/Controls/src/Core/Registrar.cs

+		[Obsolete]
 		public static void RegisterAll(Type[] attrTypes, IFontRegistrar fontRegistrar = null)


Made the RegisterAll methods obsolete as these are probably not the droids users are looking for.

mattleibow · 2022-03-01T18:40:17Z

src/Controls/src/Xaml/MarkupExtensions/OnPlatformExtension.cs

-			if (Device.RuntimePlatform == Device.GTK && GTK != s_notset)
+			if (DeviceInfo.Platform == DevicePlatform.Create("GTK") && GTK != s_notset)


This is probably not worth the code and will be removed in #4491 but it is here for now and does not break anything.

This reverts commit 40291b0.

* Implement IBorder on Windows (#5008) * Implement IBorder on Windows * Fix rectangles Co-authored-by: redth <jondick@gmail.com> * Remove all usage of Device throughout the repo (#4982) Co-authored-by: Javier Suárez <javiersuarezruiz@hotmail.com> Co-authored-by: Matthew Leibowitz <mattleibow@live.com>

* Implement IBorder on Windows (#5008) * Implement IBorder on Windows * Fix rectangles Co-authored-by: redth <jondick@gmail.com> * Remove all usage of Device throughout the repo (#4982) * Remove unsupported targets in Device class (#4491) * Remove unsupported targets in Device class * Fixed broken tests * Deprecate UWP target * Allow to use UWP target on XAML * Fix build errors * comments * UWP == WinUI * Fix Build errors * Added more tests * fix * vbnm * More fixes * things Co-authored-by: Matthew Leibowitz <mattleibow@live.com> Co-authored-by: Javier Suárez <javiersuarezruiz@hotmail.com> Co-authored-by: Matthew Leibowitz <mattleibow@live.com>

* Implement IBorder on Windows (#5008) * Implement IBorder on Windows * Fix rectangles Co-authored-by: redth <jondick@gmail.com> * Remove all usage of Device throughout the repo (#4982) * Remove unsupported targets in Device class (#4491) * Remove unsupported targets in Device class * Fixed broken tests * Deprecate UWP target * Allow to use UWP target on XAML * Fix build errors * comments * UWP == WinUI * Fix Build errors * Added more tests * fix * vbnm * More fixes * things Co-authored-by: Matthew Leibowitz <mattleibow@live.com> * [ci] Remove image override (#5053) * [ci] Remove image override * [ci] Don't provisioning windows Co-authored-by: Javier Suárez <javiersuarezruiz@hotmail.com> Co-authored-by: Matthew Leibowitz <mattleibow@live.com> Co-authored-by: Rui Marinho <me@ruimarinho.net>

Try and remove all usage of Device

98656fd

mattleibow marked this pull request as draft March 1, 2022 11:51

mattleibow added 3 commits March 1, 2022 20:09

w00t!

8b0fec6

moar bildy

99f132b

add better errors

ebdecea

mattleibow self-assigned this Mar 1, 2022

mattleibow added this to the 6.0.300-preview.14 milestone Mar 1, 2022

mattleibow requested review from PureWeen, Redth, hartez, rmarinho and jsuarezruiz March 1, 2022 13:35

mattleibow marked this pull request as ready for review March 1, 2022 13:35

mattleibow requested a review from Eilon March 1, 2022 15:58

mattleibow marked this pull request as draft March 1, 2022 15:58

mattleibow added 2 commits March 2, 2022 00:11

more fixes

7aa7179

ws

fe0bed6

Eilon approved these changes Mar 1, 2022

View reviewed changes

moar

e3b1ebf

mattleibow changed the title ~~Try and remove all usage of Device~~ Remove all usage of Device throughout the repo Mar 1, 2022

jonathanpeppers reviewed Mar 1, 2022

View reviewed changes

mattleibow commented Mar 1, 2022

View reviewed changes

mattleibow added 3 commits March 2, 2022 02:46

maybe final?

4dd3c33

Merge remote-tracking branch 'origin/main' into dev/obsolete-device

31af21d

the IDE is a pain

ea42fef

mattleibow marked this pull request as ready for review March 3, 2022 10:26

mattleibow requested a review from a team as a code owner March 3, 2022 10:26

mattleibow added 2 commits March 3, 2022 19:20

Merge remote-tracking branch 'origin/main' into dev/obsolete-device

fe56a96

asdfsd

ecfe261

Redth approved these changes Mar 3, 2022

View reviewed changes

mattleibow added 4 commits March 3, 2022 23:00

Merge remote-tracking branch 'origin/main' into dev/obsolete-device

d73c02a

Merge remote-tracking branch 'origin/main' into dev/obsolete-device

07eb32a

sdaf

40291b0

Revert "sdaf"

0b98e68

This reverts commit 40291b0.

mattleibow changed the base branch from main to release/6.0.2xx-preview14 March 3, 2022 15:47

mattleibow merged commit b915256 into release/6.0.2xx-preview14 Mar 3, 2022

mattleibow deleted the dev/obsolete-device branch March 3, 2022 17:29

mattleibow mentioned this pull request May 2, 2022

OnIdiom issue with Windows #5014

Closed

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

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Remove all usage of Device throughout the repo #4982

Remove all usage of Device throughout the repo #4982

mattleibow commented Mar 1, 2022 •

edited

Loading

Eilon left a comment

jonathanpeppers Mar 1, 2022

akoeplinger Mar 1, 2022 •

edited

Loading

akoeplinger Mar 1, 2022

mattleibow Mar 1, 2022

mattleibow Mar 1, 2022 •

edited

Loading

akoeplinger Mar 3, 2022

mattleibow Mar 1, 2022

mattleibow Mar 1, 2022

mattleibow Mar 1, 2022

mattleibow Mar 1, 2022

mattleibow Mar 1, 2022

mattleibow Mar 1, 2022

mattleibow Mar 1, 2022

mattleibow Mar 1, 2022

mattleibow Mar 1, 2022

mattleibow Mar 1, 2022

		if (Device.RuntimePlatform == Device.iOS)
		if (DeviceInfo.Platform == DevicePlatform.iOS)

		public static IItemsViewSource Create(IEnumerable itemsSource, ICollectionChangedNotifier notifier)
		public static IItemsViewSource Create(IEnumerable itemsSource, BindableObject container, ICollectionChangedNotifier notifier)

		var source = ItemsSourceFactory.Create(_groupSource[n] as IEnumerable, this);
		var source = ItemsSourceFactory.Create(_groupSource[n] as IEnumerable, _groupableItemsView, this);

		var ois = ItemsSourceFactory.Create(source, new MockCollectionChangedNotifier());
		var ois = ItemsSourceFactory.Create(source, Application.Current, new MockCollectionChangedNotifier());

		[Obsolete]
		public static void RegisterAll(Type[] attrTypes, IFontRegistrar fontRegistrar = null)

		if (Device.RuntimePlatform == Device.GTK && GTK != s_notset)
		if (DeviceInfo.Platform == DevicePlatform.Create("GTK") && GTK != s_notset)

Remove all usage of Device throughout the repo #4982

Remove all usage of Device throughout the repo #4982

Conversation

mattleibow commented Mar 1, 2022 • edited Loading

Description of Change

Issues Fixed

Eilon left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

akoeplinger Mar 1, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mattleibow Mar 1, 2022 • edited Loading

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

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

mattleibow commented Mar 1, 2022 •

edited

Loading

akoeplinger Mar 1, 2022 •

edited

Loading

mattleibow Mar 1, 2022 •

edited

Loading