Add analyzer for trim-unsafe casts to projected runtime class types #1956
Conversation
ef36376 to
a92f6a8
Compare
src/Authoring/WinRT.SourceGenerator/Analyzers/RuntimeClassCastAnalyzer.cs
Outdated
Show resolved
Hide resolved
| <data name="RuntimeClassCast_Brief" xml:space="preserve"> | ||
| <value>Casts to WinRT runtime class types are not trim-safe</value> | ||
| </data> | ||
| <data name="RuntimeClassCast_Text" xml:space="preserve"> |
There was a problem hiding this comment.
I feel like both error messages, but especially this one, is missing the context on when it is not trim-safe / might be trimmed which is when they are declared as object / lacking static type information.
There was a problem hiding this comment.
Well the problem is that it's more complicated than that. It's not just when there's no static type information. Casting to a derived class is also not trim-safe, even if the source type is not just object. I can update the messages and include this info too, was just not sure how verbose and long we wanted the messages to be? 😅
There was a problem hiding this comment.
Well I would still consider the latter to be lack of static type information but with respect to not being aware of derived type. We can probably generalize it with something along the lines of can't be determined with static type information or so?
There was a problem hiding this comment.
How about
Casting to type '{0}' where the type being cast to is never instantiated in the C# implementation is not trim-safe as the type can be trimmed.
or
Casting to type '{0}' where the type being cast to was statically not known about when the C# wrapper was created is not trim-safe as the type can be trimmed.
| <value>Casts to WinRT 'IReference`1<T>' unboxed values are not trim-safe</value> | ||
| </data> | ||
| <data name="IReferenceTypeCast_Text" xml:space="preserve"> | ||
| <value>Casting to type '{0}' is not trim-safe, as it is unboxing a WinRT 'IReference`1<T>' value type. Consider using the 'WinRT.CastExtensions.Cast<T>' extension method instead, which will ensure the necessary metadata is kept. Alternatively, you can use '[DynamicDependency]' to manually root the necessary metadata, and suppress the warning via '[UnconditionalSuppressMessage]'.</value> |
There was a problem hiding this comment.
| <value>Casting to type '{0}' is not trim-safe, as it is unboxing a WinRT 'IReference`1<T>' value type. Consider using the 'WinRT.CastExtensions.Cast<T>' extension method instead, which will ensure the necessary metadata is kept. Alternatively, you can use '[DynamicDependency]' to manually root the necessary metadata, and suppress the warning via '[UnconditionalSuppressMessage]'.</value> | |
| <value>Casting to type '{0}' is not trim-safe, as it is unboxing a WinRT 'IReference`1<T>' value type that was statically not known. Consider using the 'WinRT.CastExtensions.Cast<T>' extension method instead, which will ensure the necessary metadata is kept. Alternatively, you can use '[DynamicDependency]' to manually root the necessary metadata, and suppress the warning via '[UnconditionalSuppressMessage]'.</value> |
Closes #1860, #1342
This PR adds a new analyzer to warn when doing trim-unsafe casts to projected runtime classes.