[Essentials] Add DateTimeOffset overload in Preferences

[Cheesebaron]

Description of Change

Adds overload in Preferences to store and retrieve DateTimeOffset.

There is no ToBinary() method on DateTimeOffset so I am storing it as a ###string.

I have an issue with the roslyn analyzer that checks for PublicAPI, it keeps complaining no matter what I add to either file. ~~

Issues Fixed

Fixes #22786

[dotnet-policy-service]

Hey there @Cheesebaron! Thank you so much for your PR! Someone from the team will get assigned to your PR shortly and we'll get it reviewed.

[jfversluis]

I have an issue with the roslyn analyzer that checks for PublicAPI, it keeps complaining no matter what I add to either file.

Yeah its kind of annoying, but it probably keeps complaining because you have to add it to every txt file for every platform where this API is introduced.

[Cheesebaron]

I have an issue with the roslyn analyzer that checks for PublicAPI, it keeps complaining no matter what I add to either file.

Yeah its kind of annoying, but it probably keeps complaining because you have to add it to every txt file for every platform where this API is introduced.

Do I add it to .Shipped or .Unshipped?

[mattleibow]

Unshipped.

[Cheesebaron]

Ah let me fix that

[mattleibow]

I see you are using ToString("O") - how does this work when the culture or timezone changes on the device? I don't see docs on the O format, and is it better to save using invariant culture and then a parse exact?

[Cheesebaron]

I see you are using ToString("O") - how does this work when the culture or timezone changes on the device? I don't see docs on the O format, and is it better to save using invariant culture and then a parse exact?

Looking at standard format strings here: https://learn.microsoft.com/en-us/dotnet/standard/base-types/standard-date-and-time-format-strings

O format saves in ISO 8601 which doesn't affect the format regardless of culture. It is also the only format that also contains the offset part.

[mattleibow]

/azp run

[azure-pipelines]

Azure Pipelines successfully started running 3 pipeline(s).

[jsuarezruiz]

/azp run

[azure-pipelines]

Azure Pipelines successfully started running 3 pipeline(s).

[Cheesebaron]

Sorry for the many pushes, I can't build UWP on my machine 😢

[mattleibow]

/azp run

[azure-pipelines]

Azure Pipelines successfully started running 3 pipeline(s).

[mattleibow]

Sorry for the many pushes, I can't build UWP on my machine 😢

No prob, I also do CI driven dev because I am to lazy to boot a windows machine or launch a new devbox.

[mattleibow]

Windows is having a few failures:

System.InvalidCastException : Invalid cast from 'System.String' to 'System.DateTimeOffset'.

Stack trace

   at System.Convert.DefaultToType(IConvertible value, Type targetType, IFormatProvider provider)
   at Microsoft.Maui.Storage.UnpackagedPreferencesImplementation.Get[T](String key, T defaultValue, String sharedName) in /_/src/Essentials/src/Preferences/Preferences.uwp.cs:line 210
   at Microsoft.Maui.Storage.PreferencesImplementation.Get[T](String key, T defaultValue, String sharedName) in /_/src/Essentials/src/Preferences/Preferences.uwp.cs:line 37
   at Microsoft.Maui.Essentials.DeviceTests.Preferences_Tests.DateTimeOffsetPreservesOffset_NonStatic(String sharedName, TimeSpan offset) in /_/src/Essentials/test/DeviceTests/Tests/Preferences_Tests.cs:line 497
   at InvokeStub_Preferences_Tests.DateTimeOffsetPreservesOffset_NonStatic(Object, Span`1)
   at System.Reflection.MethodBaseInvoker.InvokeWithFewArgs(Object obj, BindingFlags invokeAttr, Binder binder, Object[] parameters, CultureInfo culture)

[mattleibow]

Since this has a new API, it probably needs to target net9.0 instead.

[Cheesebaron]

Windows is having a few failures:

System.InvalidCastException : Invalid cast from 'System.String' to 'System.DateTimeOffset'.

Stack trace

   at System.Convert.DefaultToType(IConvertible value, Type targetType, IFormatProvider provider)
   at Microsoft.Maui.Storage.UnpackagedPreferencesImplementation.Get[T](String key, T defaultValue, String sharedName) in /_/src/Essentials/src/Preferences/Preferences.uwp.cs:line 210
   at Microsoft.Maui.Storage.PreferencesImplementation.Get[T](String key, T defaultValue, String sharedName) in /_/src/Essentials/src/Preferences/Preferences.uwp.cs:line 37
   at Microsoft.Maui.Essentials.DeviceTests.Preferences_Tests.DateTimeOffsetPreservesOffset_NonStatic(String sharedName, TimeSpan offset) in /_/src/Essentials/test/DeviceTests/Tests/Preferences_Tests.cs:line 497
   at InvokeStub_Preferences_Tests.DateTimeOffsetPreservesOffset_NonStatic(Object, Span`1)
   at System.Reflection.MethodBaseInvoker.InvokeWithFewArgs(Object obj, BindingFlags invokeAttr, Binder binder, Object[] parameters, CultureInfo culture)

Gotta fire up my Windows machine to see what is up here. Thanks!

I need to figure out what is up with this UnpackagedPreferencesImplementation and why it behaves as it does.

[Cheesebaron]

So seems like DateTime was skipped in the device tests for unpackaged UWP. I've gone ahead and fixed that so that test isn't skipped and made sure DateTimeOffset tests also work. If this is not what you want I can also just skip the DateTimeOffset tests on upackaged UWP. Let me know which direction you want to go.

[jsuarezruiz]

/azp run

[azure-pipelines]

Azure Pipelines successfully started running 3 pipeline(s).

[Cheesebaron]

Looks like the failing pipelines are unrelated to the changes in this PR

[mattleibow]

Looking good, now to see what is going on with ci and UI tests

[Cheesebaron]

Not to be pushy, but any chance this gets in before .NET 9 comes out of preview?