Enable nullability in CodeDomSerializerBase by halgab · Pull Request #9099 · dotnet/winforms

halgab · 2023-05-10T11:37:35Z

This PR is pretty big, apologies for that. It enables nullability in CodeDomSerializerBase to get one foot in the door to annotate more serializers down the road,
One issue I had doing this is the lack of annoations in System.CodeDom (see dotnet/runtime#41720, dotnet/runtime#78036)

Contributes to #8342

Proposed changes

Enable nullability in CodeDomSerializerBase
Refactor CodeDomSerializerBase and fix an apparent bug
Introduce new helper functions to simplify more parts of the code

Each change is its own commit.

Microsoft Reviewers: Open in CodeFlow

halgab · 2023-05-10T12:49:23Z

...Windows.Forms.Design/src/System/ComponentModel/Design/Serialization/CodeDomSerializerBase.cs

-                        {
-                            if (statement is CodeMethodReturnStatement cmrs)
-                            {
-                                DeserializeExpression(manager, null, ces.Expression);


This looked a lot like a bug

halgab · 2023-05-10T12:49:50Z

...Windows.Forms.Design/src/System/ComponentModel/Design/Serialization/CodeDomSerializerBase.cs

@@ -1242,11 +1165,11 @@ protected object DeserializeExpression(IDesignerSerializationManager manager, st
                        //
                        for (int i = 0; i < indexes.Length; i++)
                        {
-                            IConvertible index = DeserializeExpression(manager, name, arrayIndexerEx.Indices[i]) as IConvertible;
+                            object? index = DeserializeExpression(manager, name, arrayIndexerEx.Indices[i]);


This should fix the trace in the non IConvertible case

elachlan · 2023-05-11T03:57:24Z

Thanks for working on this!

JeremyKuhne

In general, looks really good! I think there is a bit more opportunity to use pattern matching. See my comments.

JeremyKuhne · 2023-06-21T21:52:52Z

...Windows.Forms.Design/src/System/ComponentModel/Design/Serialization/CodeDomSerializerBase.cs

            {
-                typename.Append(',');
+                typeName.Append('[');


This would be further improved by aggregating these Append calls into a single Append($',[{GetTypeNameFromCodeTypeReferenceHelper(manager, childref, typeName)}],). Same for other cases where we're making multiple calls in a row.

Done. In the end there weren't many opportunities to do so, as line 93 isn't a direct Append call

JeremyKuhne · 2023-06-21T21:55:37Z

...Windows.Forms.Design/src/System/ComponentModel/Design/Serialization/CodeDomSerializerBase.cs

@@ -194,7 +180,7 @@ protected static Type GetReflectionTypeHelper(IDesignerSerializationManager mana
        Type type = instance.GetType();
        if (type.IsValueType)
        {
-            TypeDescriptionProvider targetProvider = GetTargetFrameworkProvider(manager, instance);
+            TypeDescriptionProvider? targetProvider = GetTargetFrameworkProvider(manager, instance);


It's better to use pattern matching here. if (GetTargetFrameworkProvider(manager, instance) is TypeDescriptionProvider targetProvider)

I took the opportunity to move this logic to a helper to reduce code duplication

...Windows.Forms.Design/src/System/ComponentModel/Design/Serialization/CodeDomSerializerBase.cs

JeremyKuhne · 2023-06-21T22:07:35Z

...Windows.Forms.Design/src/System/ComponentModel/Design/Serialization/CodeDomSerializerBase.cs

    private static object ExecuteBinaryOperator(IConvertible left, IConvertible right, CodeBinaryOperatorType op)
    {
        TypeCode leftType = left.GetTypeCode();
        TypeCode rightType = right.GetTypeCode();

        // The compatible types are listed in order from lowest bitness to highest.  We must operate on the highest bitness to keep fidelity.
-        TypeCode[] compatibleTypes = new TypeCode[]
+        ReadOnlySpan<TypeCode> compatibleTypes = new TypeCode[]


Why change this to ReadOnlySpan?

Now that dotnet/runtime#60948 is closed it should remove the array allocation

...mitives/src/System/ComponentModel/Design/Serialization/DesignerSerializationManagerHelper.cs

JeremyKuhne

Looks good, thanks for this!

steveharter · 2023-08-02T14:32:55Z

What is left to fully address #8342?

halgab · 2023-08-03T07:52:30Z

There are quite a lot of files that still need annotating. I count 192 as of current main branch.

ghost assigned halgab May 10, 2023

ghost added area-NRT draft draft PR labels May 10, 2023

halgab force-pushed the code-dom-ser-base-null branch from 893a2c0 to 04d0979 Compare May 10, 2023 12:47

halgab commented May 10, 2023

View reviewed changes

halgab force-pushed the code-dom-ser-base-null branch from 04d0979 to 11dbb2e Compare May 10, 2023 13:06

halgab marked this pull request as ready for review May 10, 2023 13:29

halgab requested a review from a team as a code owner May 10, 2023 13:29

ghost removed the draft draft PR label May 10, 2023

halgab added 3 commits May 12, 2023 13:32

add nullability to CodeDomSerializerBase

03d6ac8

code cleanup

38775ba

DesignerSerializationManagerHelper

f6e78ce

halgab force-pushed the code-dom-ser-base-null branch from 11dbb2e to f6e78ce Compare May 12, 2023 11:32

dreddy-work added the waiting-on-team This work item needs to be discussed with team or is waiting on team action in order to proceed label Jun 21, 2023

JeremyKuhne requested changes Jun 21, 2023

View reviewed changes

ghost added the waiting-author-feedback The team requires more information from the author label Jun 21, 2023

dreddy-work removed the waiting-on-team This work item needs to be discussed with team or is waiting on team action in order to proceed label Jun 21, 2023

ghost removed the waiting-author-feedback The team requires more information from the author label Jun 22, 2023

review feedback and fix indent

90360e9

halgab requested a review from JeremyKuhne June 24, 2023 21:28

halgab mentioned this pull request Jul 6, 2023

Changes to fix issues in DemoConsole #9419

Merged

JeremyKuhne approved these changes Jul 12, 2023

View reviewed changes

dreddy-work merged commit 664b9f6 into dotnet:main Jul 12, 2023

ghost added this to the 8.0 Preview7 milestone Jul 12, 2023

halgab deleted the code-dom-ser-base-null branch July 13, 2023 05:49

This was referenced Jul 16, 2023

Enable nullability in CodeDomSerializer #9501

Merged

Enable nullability in TypeCodeDomSerializer #9529

Merged

ghost locked as resolved and limited conversation to collaborators Sep 2, 2023

Conversation

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

Uh oh!

Proposed changes

Microsoft Reviewers: Open in CodeFlow

Uh oh!

halgab May 10, 2023

Choose a reason for hiding this comment

Uh oh!

halgab May 10, 2023

Choose a reason for hiding this comment

Uh oh!

elachlan commented May 11, 2023

Uh oh!

JeremyKuhne left a comment

Choose a reason for hiding this comment

Uh oh!

JeremyKuhne Jun 21, 2023

Choose a reason for hiding this comment

Uh oh!

halgab Jun 22, 2023

Choose a reason for hiding this comment

Uh oh!

JeremyKuhne Jun 21, 2023

Choose a reason for hiding this comment

Uh oh!

halgab Jun 22, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

JeremyKuhne Jun 21, 2023

Choose a reason for hiding this comment

Uh oh!

halgab Jun 22, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

JeremyKuhne left a comment

Choose a reason for hiding this comment

Uh oh!

steveharter commented Aug 2, 2023

Uh oh!

halgab commented Aug 3, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

halgab commented May 10, 2023 •

edited

Loading

halgab Jun 22, 2023 •

edited

Loading