Skip to content

Update ASP.NET Core to use C# 8's nullable reference types #5680

Closed
Closed
Update ASP.NET Core to use C# 8's nullable reference types#5680
#31338 (+3)
Assignees
JamesNK
Labels
affected-mediumThis issue impacts approximately half of our customersarea-identityIncludes: Identity and providersreevaluateWe need to reevaluate the issue and make a decision about itseverity-blockingThis label is used by an internal tooltask
Milestone
.NET 7 Planning

Description

@JamesNK
JamesNK
opened on Dec 17, 2018

Updating ASP.NET Core to use C# 8's nullable reference types would:

  1. Help ASP.NET Core libraries avoid null reference exceptions internally. It will help us find and prevent our bugs and increase our developer productivity
  2. Provide guidance to developers who are using ASP.NET Core about which APIs can accept and return a null reference and which APIs can't. This would improve the developer experience of using ASP.NET Core

@rynowak @davidfowl @DamianEdwards @Eilon

Projects in no particular order

  • Microsoft.AspNetCore.DataProtection.EntityFrameworkCore
  • Microsoft.AspNetCore.DataProtection.StackExchangeRedis
  • Microsoft.AspNetCore.TestHost
  • Microsoft.AspNetCore.Hosting.WindowsServices
  • Microsoft.AspNetCore.ApiAuthorization.IdentityServer
  • Microsoft.AspNetCore.Identity.EntityFrameworkCore
  • Microsoft.AspNetCore.Identity.Specification.Tests
  • Microsoft.AspNetCore.Identity.UI
  • Microsoft.AspNetCore.Authentication.Certificate
  • Microsoft.AspNetCore.Authentication.Facebook
  • Microsoft.AspNetCore.Authentication.Google
  • Microsoft.AspNetCore.Authentication.JwtBearer
  • Microsoft.AspNetCore.Authentication.MicrosoftAccount
  • Microsoft.AspNetCore.Authentication.Negotiate
  • Microsoft.AspNetCore.Authentication.OpenIdConnect
  • Microsoft.AspNetCore.Authentication.Twitter
  • Microsoft.AspNetCore.Authentication.WsFederation
  • Microsoft.Extensions.Logging.AzureAppServices
  • Microsoft.AspNetCore.ConcurrencyLimiter
  • Microsoft.AspNetCore.Diagnostics.EntityFrameworkCore
  • Microsoft.AspNetCore.HeaderPropagation
  • Microsoft.Extensions.Diagnostics.HealthChecks.EntityFrameworkCore
  • Microsoft.AspNetCore.MiddlewareAnalysis
  • Microsoft.AspNetCore.SpaServices.Extensions
  • Microsoft.AspNetCore.Mvc.NewtonsoftJson
  • Microsoft.AspNetCore.Mvc.Razor.RuntimeCompilation
  • Microsoft.AspNetCore.Mvc.Testing
  • Microsoft.AspNetCore.AzureAppServicesIntegration
  • Microsoft.AspNetCore.SignalR.Client.Core
  • Microsoft.AspNetCore.SignalR.Client
  • Microsoft.AspNetCore.Http.Connections.Client
  • Microsoft.AspNetCore.SignalR.Protocols.MessagePack
  • Microsoft.AspNetCore.SignalR.Protocols.NewtonsoftJson
  • Microsoft.AspNetCore.SignalR.Specification.Tests
  • Microsoft.AspNetCore.SignalR.StackExchangeRedis
  • Microsoft.Authentication.WebAssembly.Msal
  • Microsoft.JSInterop.WebAssembly
  • Microsoft.AspNetCore.Components.WebAssembly.Server
  • Microsoft.AspNetCore.Components.WebAssembly.Authentication
  • Microsoft.AspNetCore.Components.WebAssembly
  • Microsoft.AspNetCore
  • Microsoft.AspNetCore.DataProtection.Abstractions
  • Microsoft.AspNetCore.Cryptography.Internal
  • Microsoft.AspNetCore.Cryptography.KeyDerivation
  • Microsoft.AspNetCore.DataProtection
  • Microsoft.AspNetCore.DataProtection.Extensions
  • Microsoft.AspNetCore.Antiforgery
  • Microsoft.AspNetCore.Hosting.Abstractions
  • Microsoft.AspNetCore.Hosting
  • Microsoft.AspNetCore.Hosting.Server.Abstractions
  • Microsoft.AspNetCore.Authentication.Abstractions
  • Microsoft.AspNetCore.Authentication.Core
  • Microsoft.Net.Http.Headers
  • Microsoft.AspNetCore.Http.Abstractions
  • Microsoft.AspNetCore.Http.Extensions
  • Microsoft.AspNetCore.Http.Features
  • Microsoft.AspNetCore.Http
  • Microsoft.AspNetCore.Metadata
  • Microsoft.AspNetCore.Routing.Abstractions
  • Microsoft.AspNetCore.Routing
  • Microsoft.AspNetCore.WebUtilities
  • Microsoft.AspNetCore.Html.Abstractions
  • Microsoft.AspNetCore.Identity
  • Microsoft.Extensions.Identity.Core
  • Microsoft.Extensions.Identity.Stores
  • Microsoft.AspNetCore.Connections.Abstractions
  • Microsoft.AspNetCore.Server.HttpSys
  • Microsoft.AspNetCore.Server.IISIntegration
  • Microsoft.AspNetCore.Server.IIS
  • Microsoft.AspNetCore.Server.Kestrel.Core
  • Microsoft.AspNetCore.Server.Kestrel
  • Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets
  • Microsoft.AspNetCore.Authentication.Cookies
  • Microsoft.AspNetCore.Authentication
  • Microsoft.AspNetCore.Authentication.OAuth
  • Microsoft.AspNetCore.Authorization
  • Microsoft.AspNetCore.Authorization.Policy
  • Microsoft.AspNetCore.CookiePolicy
  • Microsoft.AspNetCore.Cors
  • Microsoft.AspNetCore.Diagnostics.Abstractions
  • Microsoft.AspNetCore.Diagnostics
  • Microsoft.AspNetCore.Diagnostics.HealthChecks
  • Microsoft.AspNetCore.HostFiltering
  • Microsoft.AspNetCore.HttpOverrides
  • Microsoft.AspNetCore.HttpsPolicy
  • Microsoft.AspNetCore.Localization.Routing
  • Microsoft.AspNetCore.Localization
  • Microsoft.AspNetCore.ResponseCaching.Abstractions
  • Microsoft.AspNetCore.ResponseCaching
  • Microsoft.AspNetCore.ResponseCompression
  • Microsoft.AspNetCore.Rewrite
  • Microsoft.AspNetCore.Session
  • Microsoft.AspNetCore.StaticFiles
  • Microsoft.AspNetCore.WebSockets
  • Microsoft.AspNetCore.Razor.Runtime
  • Microsoft.AspNetCore.Razor
  • Microsoft.AspNetCore.Mvc.Abstractions
  • Microsoft.AspNetCore.Mvc.ApiExplorer
  • Microsoft.AspNetCore.Mvc.Core
  • Microsoft.AspNetCore.Mvc.Cors
  • Microsoft.AspNetCore.Mvc.DataAnnotations
  • Microsoft.AspNetCore.Mvc.Formatters.Json
  • Microsoft.AspNetCore.Mvc.Formatters.Xml
  • Microsoft.AspNetCore.Mvc.Localization
  • Microsoft.AspNetCore.Mvc.RazorPages
  • Microsoft.AspNetCore.Mvc.Razor
  • Microsoft.AspNetCore.Mvc.TagHelpers
  • Microsoft.AspNetCore.Mvc.ViewFeatures
  • Microsoft.AspNetCore.Mvc
  • Microsoft.AspNetCore.Http.Connections.Common
  • Microsoft.AspNetCore.Http.Connections
  • Microsoft.AspNetCore.SignalR.Protocols.Json
  • Microsoft.AspNetCore.SignalR.Common
  • Microsoft.AspNetCore.SignalR.Core
  • Microsoft.AspNetCore.SignalR
  • Microsoft.AspNetCore.Components.Authorization
  • Microsoft.AspNetCore.Components
  • Microsoft.AspNetCore.Components.Forms
  • Microsoft.AspNetCore.Components.Server
  • Microsoft.AspNetCore.Components.Web
  • Microsoft.Extensions.FileProviders.Embedded
  • Microsoft.Extensions.Caching.SqlServer
  • Microsoft.Extensions.Caching.StackExchangeRedis
  • Microsoft.Extensions.Configuration.KeyPerFile
  • Microsoft.Extensions.Localization.Abstractions
  • Microsoft.Extensions.Localization
  • Microsoft.Extensions.ObjectPool
  • Microsoft.JSInterop
  • Microsoft.Extensions.WebEncoders
  • Microsoft.Extensions.Diagnostics.HealthChecks.Abstractions
  • Microsoft.Extensions.Diagnostics.HealthChecks

Skipped (potentially no longer commonly used, potential future removal, only used in tests, internal project, etc)

  • Microsoft.AspNetCore.Owin
  • Microsoft.AspNetCore.Testing
  • Microsoft.AspNetCore.Server.Kestrel.Transport.Libuv
  • Microsoft.AspNetCore.Authentication.AzureAD.UI
  • Microsoft.AspNetCore.Authentication.AzureADB2C.UI
  • Microsoft.AspNetCore.JsonPatch
  • Microsoft.AspNetCore.NodeServices
  • Microsoft.AspNetCore.SpaServices

Skipped (not for public consumption)

  • Microsoft.AspNetCore.DeveloperCertificates.XPlat

Activity

  1. JamesNK
    added
    Needs: DesignThis issue requires design work before implementating.
    feature
    on Dec 17, 2018

  2. rynowak commented on Dec 17, 2018

    @rynowak
    rynowak
    on Dec 17, 2018
    Contributor

    I hereby certify this idea as good.

  3. Eilon
    added
    certified good 👍
    on Dec 17, 2018
  4. JamesNK
    changed the title [-]Update ASP.NET Core to use C# 8's nullable types[/-] [+]Update ASP.NET Core to use C# 8's nullable reference types[/+] on Dec 17, 2018
  5. Eilon
    assigned
    JamesNK
    on Dec 18, 2018

  6. Eilon commented on Dec 18, 2018

    @Eilon
    Eilon
    on Dec 18, 2018
    Contributor

    Assigning to @JamesNK to give this some more thought on what can concretely be done in ASP.NET Core and what value it would provide.

  7. JamesNK commented on Dec 18, 2018

    @JamesNK
    JamesNK
    on Dec 18, 2018
    MemberAuthor

    Over Christmas I'm going to play around with C# 8.0 and update Newtonsoft.Json to use nullable reference types. Will be able to give some more feedback then about how ready the feature is and much work it will be to use it. I suspect it will be large.

    Some random thoughts:

    1. It will probably require VS2019. VS2017 won't understand the syntax and will no longer compile
    2. Lower level libraries should be updated first, e.g. Http should be updated before MVC so that MVC doesn't need to unnecessarily assert that types that come from Http are not null

  8. rynowak commented on Dec 18, 2018

    @rynowak
    rynowak
    on Dec 18, 2018
    Contributor

    It will probably require VS2019. VS2017 won't understand the syntax and will no longer compile

    If this is the case, then we'd probably want to wait until 2019 is RTM. We try to avoid requiring that contributors have previews of stuff. But given all of the other stuff going on in 3.0 it's possible we might need to require that for other reasons.

  9. rynowak commented on Dec 18, 2018

    @rynowak
    rynowak
    on Dec 18, 2018
    Contributor

    @Eilon thanks for creating that label. As you know I am unable to create labels.

  10. JamesNK commented on Dec 18, 2018

    @JamesNK
    JamesNK
    on Dec 18, 2018
    MemberAuthor

    If you had certified it spicy then you would have this label to use

    certified spicy 🌶️

    🙃

  11. JamesNK commented on Jan 2, 2019

    @JamesNK
    JamesNK
    on Jan 2, 2019
    MemberAuthor

    Findings from converting Newtonsoft.Json over the break:

    • a couple of days of work
    • VS2019 Preview 1 null analysis is good but has some false positives. Should wait until it is closer to 3.0 before updating anything
    • it will help prevent NREs
    • the CI build should be updated to not fail on null reference related warnings. I think that as corefx and other dep libraries add support for nullable reference types then new warnings will automatically appear. Speaking of corefx, does anyone know if they have a plan for supporting nullable metadata in 3.0?

  12. Eilon commented on Jan 2, 2019

    @Eilon
    Eilon
    on Jan 2, 2019
    Contributor

    @JamesNK - maybe start with @joshfree to see if his team is planning to take advantage of this.

  13. rynowak commented on Jan 2, 2019

    @rynowak
    rynowak
    on Jan 2, 2019
    Contributor

    the CI build should be updated to not fail on null reference related warnings. I think that as corefx and other dep libraries add support for nullable reference types then new warnings will automatically appear.

    This is concerning because we all really enjoy warnings as errors. I think it in this case it would probably be fine to support this guy into the libraries get stables.

    Something interesting about this is that you get a new flavour of the classic warnings problem. Adding a warning is always a breaking change. Is nullability part of netstandard2.0? Can it ever change?

  14. JamesNK commented on Jan 2, 2019

    @JamesNK
    JamesNK
    on Jan 2, 2019
    MemberAuthor

    This is concerning because we all really enjoy warnings as errors.

    Totes, warning as errors is the best. But there is a way to allow-list (@Eilon 😋) some warnings. See WarningsNotAsErrors - https://github.com/dotnet/project-system/pull/4404/files#diff-6483fde6c45c90fdfe98ca72eadfa651

  15. 89 remaining items

  16. mkArtakMSFT
    added
    area-identityIncludes: Identity and providers
    on Jun 15, 2021
  17. mkArtakMSFT
    unassigned
    pranavkm
    on Jun 15, 2021

  18. mkArtakMSFT commented on Jun 15, 2021

    @mkArtakMSFT
    mkArtakMSFT
    on Jun 15, 2021
    Contributor

    Moving to area-identity as that's where next set of changes need to happen

  19. msschl
    added a commit that references this issue on Jul 30, 2021

    Contributes to dotnet#5680

    7f18d6c
  20. pranavkm
    added a commit that references this issue on Aug 3, 2021

    Add member 'Principal' and 'Properties' to MemberNotNullWhenAttribute (…

    413f48f
  21. adityamandaleeka
    modified the milestones: Next sprint planning, .NET 7-Candidate on Aug 11, 2021
  22. pranavkm
    added 4 commits that reference this issue on Feb 10, 2022

    Add nullable annotations to Identity.Extensions (#40007)

    05b2afb

    Add nullability to Identity / Identity.UI (#40167)

    84c0baa

    Annotate SqlServer and Redis caches for nullability

    bdf8abf
  23. dougbu
    added a commit that references this issue on Feb 23, 2022

    Annotate SqlServer and Redis caches for nullability (#40319)

    8ca5d1e

  24. JamesNK commented on Aug 22, 2022

    @JamesNK
    JamesNK
    on Aug 22, 2022
    MemberAuthor

    I split the remaining projects that are missing nullability into separate issues. Closing this issue.

  25. JamesNK
    closed this as completedon Aug 22, 2022
  26. ghost locked as resolved and limited conversation to collaborators on Sep 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

affected-mediumThis issue impacts approximately half of our customersarea-identityIncludes: Identity and providersreevaluateWe need to reevaluate the issue and make a decision about itseverity-blockingThis label is used by an internal tooltask

Type

No type

Projects

No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions