dotnet / fsharp

The F# compiler, F# core library, F# language service, and F# tooling integration for Visual Studio
https://dotnet.microsoft.com/languages/fsharp
MIT License
3.92k stars 785 forks source link

Nullness issue - Downcasting should preserve nullness information #17532

Open kerams opened 2 months ago

kerams commented 2 months ago

Issue description

Downcasting is an operation that returns null when input is null. However, when the explicit coercion type is not nullable, the downcasting result currently won't be nullable either. Either a nullable type should be required (:?> string | null) or the downcasting operator should automatically adjust nullness based on the input type.

Choose one or more from the following categories of impact

Operating System

Windows (Default)

What .NET runtime/SDK kind are you seeing the issue on

.NET SDK (.NET Core, .NET 5+)

.NET Runtime/SDK version

9.0.0-preview.7.24405.7

Reproducible code snippet and actual behavior

((null: obj | null) :?> string).Length

No warning, throws NRE.

Possible workarounds

No response

kerams commented 2 months ago

Desribed in https://github.com/fsharp/fslang-design/blob/main/RFCs/FS-1060-nullable-reference-types.md#meaning-of-unbox, perhaps forgotten or ignored for the time being?

T-Gro commented 2 months ago

I think there are two perspectives:

  1. Admit that with downcasting, the code is inherently dangerous at runtime. i.e. allow downcasting e.g. a nullable obj into a DU
  2. Try to maintain nullness (similar to [NotNullIfNotNull] in C# flow analysis), even though this might complicate downcasting-heavy code.

This is further complicated by the fslib Unboxing functions doing a runtime lookup, where nullness information is no longer known.

A solution which would insist on downcasting a nullable source into a nullable target ( :?> string | null) would only work on target types which can carry nullness, which is not equal to all types that can be downcasted to (tuples, anon records).

T-Gro commented 2 months ago

A safe but not all-scenarios-covering change would be:

Would that meet the expectations here?

charlesroddie commented 1 month ago
((null: obj | null) :?> string).Length

This shouldn't throw an NRE but should throw an exception during the :?> string cast.

f(x: string | null) = x :?> string should succeed if x is a string, and fail if x is null (since, post NRTs, null is not a string).

No separate warning should be given since now new danger is introduced: :?> is known to throw if the LHS is not of the type on the RHS.

If there is a warning it should apply to all uses of :?> ("don't use this").

kerams commented 1 month ago

but should throw an exception during the :?> string cast

Feel free to take up that breaking change (which is what a different exception constitutes, I think) with the runtime team (unless you're suggesting F# should start injecting extra null checks before the unbox.any instruction).