SystemSerializer update for BaseObjectStorageHelper

[michael-hawker]

Fixes #3692

This introduces a new light-weight serializer which we can use within the toolkit for the SystemInformation class still. And then developers with more complex type needs can specify their own serializer for the BaseObjectStorageHelper classes. See the related issue for more details.

Follow-on to #3637 and #3414

PR Type

What kind of change does this PR introduce?

• Feature

• Refactoring (no functional changes, no api changes)

What is the current behavior?

Using DataContractJsonSerializer, though we had used Newtonsoft.Json in 6.1.

What is the new behavior?

Use new SystemSerializer which passes values to/from the Windows ApplicationDataContainer APIs directly. Updates our internal usages of this to the new system. Requires developer using the BaseObjectStorageHelper to provide a serializer implementation.

This of course does provide a 'default'/system information within the toolkit now compared to our original thought of providing none at all before the SystemInformation problem was identified.

PR Checklist

Please check if your PR fulfills the following requirements:

• Tested code with current supported SDKs
• Pull Request has been submitted to the documentation repository instructions. Link:
• Sample in sample app has been added / updated (for bug fixes / features)
  • Icon has been created (if new sample) following the Thumbnail Style Guide and templates
• New major technical changes in the toolkit have or will be added to the Wiki e.g. build changes, source generators, testing infrastructure, sample creation changes, etc...
• Tests for the changes have been added (for bug fixes / features) (if applicable)
• Header has been added to all new source files (run build/UpdateHeaders.bat)
• Contains NO breaking changes

Other information

I tested copying the system.dat file from the Settings folder of our 6.1 sample app to the development version with the changes, no issues with SystemInformation reading the old data.

Updated/added unit tests to test the old json layer vs. reading from the new SystemSerializer as well as just testing a new System.Text.Json complex scenario. Added tests for exceptions.

TODO:

• Add more tests?
• Run XAML Islands SystemInformation test
• Do we want SystemSerializer to handle a few more 'basic' (but non-primitive) types? E.g. @Sergio0694 has a similar implementation for a different related system
• ???

[ghost]

Thanks michael-hawker for opening a Pull Request! The reviewers will test the PR and highlight if there is any conflict or changes required. If the PR is approved we will proceed to merge the pull request 🙌

[michael-hawker]

Hmm, the UITests failed... I'll try a full build locally to check.

[michael-hawker]

Just built locally fine:

@azchohfi I think I've noticed this a couple of times where the UI Tests just fail still in the CI... anything we can do to figure out what might have caused it?

[azchohfi]

This is the test that failed:
Failed Test_StorageHelper_DateTestFailure [15 ms]

Data of this type is not supported.

Error trying to serialize the value to be written to the application data store
  Stack Trace:
     at System.Runtime.InteropServices.WindowsRuntime.IMapSharedReferenceTypesStubClass.Insert[TKey, TValue](IDictionary`2, TKey, TValue) + 0xb4
   at System.Runtime.InteropServices.WindowsRuntime.IMapSharedReferenceTypesRCWAdapter.Indexer_Set[TKey, TValue](IDictionary`2, TKey, TValue) + 0x24
   at Windows.Storage.ApplicationDataCompositeValue.global::System.Collections.Generic.IDictionary<System.String,System.Object>.set_Item(String, Object) + 0x14
   at Microsoft.Toolkit.Uwp.Helpers.BaseObjectStorageHelper.Save[T](String, T) + 0x69
   at UnitTests.Helpers.Test_StorageHelper.Test_StorageHelper_DateTestFailure() + 0x2a
   at _$ILCT$.$ILT$ReflectionDynamicInvoke$.InvokeRetV(Object, IntPtr, InvokeUtils.ArgSetupState&, Boolean) + 0x2f
   at System.InvokeUtils.CalliIntrinsics.Call(IntPtr, Object, IntPtr, InvokeUtils.ArgSetupState&, Boolean) + 0x2c
   at System.InvokeUtils.CallDynamicInvokeMethod(Object, IntPtr, Object, IntPtr, IntPtr, Object, Object[], BinderBundle, Boolean, Boolean, Boolean) + 0x119

[michael-hawker]

@azchohfi this test is passing locally it's supposed to throw an exception:

It just looks like it's throwing a slightly different exception in the CI? (System.Exception vs. System.ArgumentException)

I tried updating to use the more general [ExpectedException(typeof(Exception))] instead, but then get the opposite:

Message: 
    Test method threw exception System.ArgumentException, but exception System.Exception was expected. Exception message: System.ArgumentException: The parameter is incorrect.
    
    Error trying to write application data container value
  Stack Trace: 
    IMap`2.Insert(K key, V value)
    MapToDictionaryAdapter.Insert[K,V](IMap`2 _this, K key, V value)
    MapToDictionaryAdapter.Indexer_Set[K,V](K key, V value)
    BaseObjectStorageHelper.Save[T](String key, T value) line 126
    Test_StorageHelper.Test_StorageHelper_DateTestFailure()

[ghost]

Hello @michael-hawker!

Because this pull request has the auto merge :zap: label, I will be glad to assist with helping to merge this pull request once all check-in policies pass.

p.s. you can customize the way I help with merging this pull request, such as holding this pull request until a specific person approves. Simply @mention me (@msftbot) and give me an instruction to get started! Learn more here.

[Rosuavio]

We forgot a small thing.