Obsolete Microsoft.AspNetCore.HttpOverrides.IPNetwork

[WeihanLi]

Obsolete Microsoft.AspNetCore.HttpOverrides.IPNetwork

• You've read the Contributor Guide and Code of Conduct.
• You've included unit or integration tests for your change, where applicable.
• You've included inline docs for your change, where applicable.
• There's an open issue for the PR that you are making. If you'd like to propose a new feature or change, please open an issue to discuss the change or find an existing issue.

Obsolete Microsoft.AspNetCore.HttpOverrides.IPNetwork to prefer System.Net.IPNetwork

Description

• Update ForwardedHeadersOptions, obsolete KnownNetworks, and add KnownIPNetworks to prefer System.Net.IPNetwork
• Mark Microsoft.AspNetCore.HttpOverrides.IPNetwork as Obsolete

fixes #46157

[MihaZupan]

I don't think this change should go through until dotnet/runtime#117114 is addressed.
As-is this is bound to break people due to differences in behavior.

[WeihanLi]

Yeah, thanks, that's why still makes it as draft

[halter73]

I agree we should obsolete Microsoft.AspNetCore.HttpOverrides.IPNetwork type to avoid confusion, but we may never actually delete it. I think we can keep any methods used convert from the old type to System.Net.IPNetwork for the purposes of backwards compatibility internal. It's not like HttpOverrides.IPNetwork was an exchange type, and it's very similar to the new type, so it should be pretty easy to migrate code to use a new System.Net.IPNetwork-property without needing us to provide public conversion methods.

The big question is what to name the new System.Net-based version of the ForwardedHeadersOptions.KnownNetworks property now that the good name has been burned by the to-be-obsoleted type. We cannot simply change the type and retain binary compatibility with an API we've shipped since at least .NET Core 2.

How does KnownIPNetworks sound? We could update #46157 to be an API proposal issue with this name and mark it api-ready-for-review. Using the [Obsolete] attribute on the existing KnownNetworks property can point people to the right popertiy to use.

[WeihanLi]

We could update #46157 to be an API proposal issue with this name and mark it api-ready-for-review. Using the [Obsolete] attribute on the existing KnownNetworks property can point people to the right popertiy to use.

@halter73 I assume I should wait for the API approval to get approved before moving ahead

[BrennanConroy]

I assume I should wait for the API approval to get approved before moving ahead

API has been approved, please move ahead with the change! 😃

[WeihanLi]

There're still some differences between System.Net.IPNetwork and Microsoft.AspNetCore.HttpOverrides.IPNetwork like the Prefix/BaseAddress, which would break the test cases, and there's no Obsolete for Microsoft.AspNetCore.HttpOverrides.IPNetwork from the API approval, so I reverted the change for Microsoft.AspNetCore.HttpOverrides.IPNetwork

[BrennanConroy]

Oh that's a mistake, we definitely want to obsolete the HttpOverrides.IpNetwork type.

[BrennanConroy]

Thanks @WeihanLi !