Add obsolete attribute to DisablePrivateReflectionAttribute #49550

annchous · 2021-03-12T19:53:26Z

annchous · 2021-03-12T22:04:19Z

It seems to me that a more appropriate tag is area-System.Runtime.CompilerServices

annchous · 2021-03-12T22:32:11Z

stephentoub · 2021-03-12T22:38:33Z

...tem.Private.CoreLib/src/System/Runtime/CompilerServices/DisablePrivateReflectionAttribute.cs

@@ -3,6 +3,7 @@

 namespace System.Runtime.CompilerServices
 {
+    [Obsolete("DisablePrivateReflectionAttribute has no effect in .NET Core and .NET 5.0+ applications.")]


Thanks for working on this.

Per #43247 (comment), this needs an ID set on it. That ID will need to be recorded in https://github.com/dotnet/runtime/blob/0c3cc15f90f0e3b81ce3199be1ac217564043635/src/libraries/Common/src/System/Obsoletions.cs. You can see other examples in that file and how they're used in call sites.

In addition, this is editing the src file, but the class in the reference assembly file https://github.com/dotnet/runtime/blob/79ae74f5ca5c8a6fe3a48935e85bd7374959c570/src/libraries/System.Runtime/ref/System.Runtime.cs will also need to have the attribute applied.

stephentoub · 2021-03-12T23:06:24Z

...tem.Private.CoreLib/src/System/Runtime/CompilerServices/DisablePrivateReflectionAttribute.cs

@@ -3,6 +3,7 @@

 namespace System.Runtime.CompilerServices
 {
+    [Obsolete(Obsoletions.EscapeUriStringMessage, DiagnosticId = Obsoletions.EscapeUriStringDiagId, UrlFormat = Obsoletions.SharedUrlFormat)]


This needs a new message and new diagnostic ID for this particular obsoletion added to that file, and then those new values used here. It shouldn't use the existing ones, which aren't relevant to this API.

stephentoub · 2021-03-12T23:06:45Z

src/libraries/System.Runtime/ref/System.Runtime.cs

@@ -9381,6 +9381,7 @@ public sealed partial class DependencyAttribute : System.Attribute
        public string DependentAssembly { get { throw null; } }
        public System.Runtime.CompilerServices.LoadHint LoadHint { get { throw null; } }
    }
+    [System.ObsoleteAttribute("DisablePrivateReflectionAttribute has no effect in .NET Core and .NET 5.0+ applications.", DiagnosticId = "SYSLIB0013", UrlFormat = "https://aka.ms/dotnet-warnings/{0}")]


SYSLIB0013 is already taken. A new obsoletion ID is needed.

It was mentioned in the commentary on this issue, so I decided that it was necessary to use it. Thanks for the explanation. Can I take SYSLIB0015 instead?

I hope I did it right :)

annchous · 2021-03-12T23:32:24Z

@stephentoub should I contribute the new obsoletion ID here https://github.com/dotnet/runtime/blob/main/docs/project/list-of-obsoletions.md?

stephentoub · 2021-03-13T01:20:27Z

should I contribute the new obsoletion ID here

Yes, please. Thanks.

stephentoub

Thanks.

annchous · 2021-03-13T08:39:16Z

@stephentoub I've finished with docs. Thank you too.

annchous · 2021-03-13T17:24:46Z

I see that some of the checks failed (exactly half). It is necessary to somehow mark in which places there should be no warnings that the attribute is now obsolete. How should this be done?

jkotas · 2021-03-13T18:40:04Z

src/libraries/Common/src/System/Obsoletions.cs

@@ -48,5 +48,8 @@ internal static class Obsoletions

        internal const string WebRequestMessage = "Use HttpClient instead.";
        internal const string WebRequestDiagId = "SYSLIB0014";
+
+        internal const string DisablePrivateReflectionAttributeMessage = "DisablePrivateReflectionAttribute has no effect in .NET Core and .NET 5.0+ applications.";


This attribute still has effect in a few corner cases in CoreCLR. Search for DisablePrivateReflection under src\coreclr and delete everything found.

Also, we may want to say .NET 6.0+ in the error message.

annchous · 2021-03-13T20:08:29Z

@jkotas I've finished with changes that you requested. But there is some trouble with building libs:

C:\runtime\artifacts\obj\netstandard\net6.0-Debug\netstandard.Forwards.cs(1524,67): error SYSLIB0015: "DisablePrivateReflectionAttribute" is obsolete: 
'DisablePrivateReflectionAttribute has no effect in .NET Core and .NET 6.0+ applications.' [C:\runtime\src\libraries\shims\generated\netstandard.csproj]

How can this be fixed?

jkotas · 2021-03-13T21:00:46Z

Could you please also delete this: https://github.com/dotnet/runtime/blob/main/src/coreclr/inc/corhdr.h#L1824-L1827

jkotas · 2021-03-13T21:05:27Z

How can this be fixed?

Try to add <NoWarn>$(NoWarn);SYSLIB0015</NoWarn> to src\libraries\shims\generated\netstandard.csproj .

annchous · 2021-03-13T21:14:33Z

Try to add <NoWarn>$(NoWarn);SYSLIB0015</NoWarn> to src\libraries\shims\generated\netstandard.csproj .

Yes, I've tried that. This cleared the error from netstandard, but followed in turn by the same error from mscorelib (src\libraries\shims\generated\mscorlib.csproj). If you insert NoWarn in src\libraries\shims\generated\mscorlib.csproj, then the error occurs in System.Runtime.csproj.

jkotas · 2021-03-13T21:19:18Z

Ok, then try this central place instead: https://github.com/dotnet/runtime/blob/main/src/libraries/Directory.Build.targets#L20

annchous · 2021-03-13T21:22:43Z

@jkotas I've tried to add <NoWarn>$(NoWarn);SYSLIB0015</NoWarn> to every project file I mentioned above. Now it builds successfully, but is it ok to do like that?

jkotas · 2021-03-13T21:26:12Z

I think it is ok.

annchous · 2021-03-13T21:29:33Z

Ok, then try this central place instead: https://github.com/dotnet/runtime/blob/main/src/libraries/Directory.Build.targets#L20

@jkotas That works nice and looks better than adding NoWarn to every project file. I will commit this change. Thank you!

annchous · 2021-03-13T23:42:00Z

@jkotas I think I have definitely finished working on this now. The checks are going well. Anything else?

stephentoub · 2021-03-14T01:04:58Z

src/libraries/Common/src/System/Obsoletions.cs

@@ -48,5 +48,8 @@ internal static class Obsoletions

        internal const string WebRequestMessage = "Use HttpClient instead.";
        internal const string WebRequestDiagId = "SYSLIB0014";
+
+        internal const string DisablePrivateReflectionAttributeMessage = "DisablePrivateReflectionAttribute has no effect in .NET Core and .NET 6.0+ applications.";


Suggested change

internal const string DisablePrivateReflectionAttributeMessage = "DisablePrivateReflectionAttribute has no effect in .NET Core and .NET 6.0+ applications.";

internal const string DisablePrivateReflectionAttributeMessage = "DisablePrivateReflectionAttribute has no effect in .NET 6.0+ applications.";

stephentoub · 2021-03-14T01:05:16Z

src/libraries/System.Runtime/ref/System.Runtime.cs

@@ -9381,6 +9381,7 @@ public sealed partial class DependencyAttribute : System.Attribute
        public string DependentAssembly { get { throw null; } }
        public System.Runtime.CompilerServices.LoadHint LoadHint { get { throw null; } }
    }
+    [System.ObsoleteAttribute("DisablePrivateReflectionAttribute has no effect in .NET Core and .NET 6.0+ applications.", DiagnosticId = "SYSLIB0015", UrlFormat = "https://aka.ms/dotnet-warnings/{0}")]


Suggested change

[System.ObsoleteAttribute("DisablePrivateReflectionAttribute has no effect in .NET Core and .NET 6.0+ applications.", DiagnosticId = "SYSLIB0015", UrlFormat = "https://aka.ms/dotnet-warnings/{0}")]

[System.ObsoleteAttribute("DisablePrivateReflectionAttribute has no effect in .NET 6.0+ applications.", DiagnosticId = "SYSLIB0015", UrlFormat = "https://aka.ms/dotnet-warnings/{0}")]

jkotas

Thank you!

Add obsolete attribute to DisablePrivateReflectionAttribute

8d3ba91

dotnet-issue-labeler bot added the area-System.Runtime.InteropServices label Mar 12, 2021

stephentoub reviewed Mar 12, 2021

View reviewed changes

stephentoub added area-System.Runtime.CompilerServices and removed area-System.Runtime.InteropServices labels Mar 12, 2021

annchous added 2 commits March 13, 2021 01:51

Attribute added to ref file

9c85c63

fix ref file and attribute

80d431e

annchous requested a review from stephentoub March 12, 2021 23:04

stephentoub reviewed Mar 12, 2021

View reviewed changes

annchous added 3 commits March 13, 2021 02:13

Add new diagnostic ID

0ba620f

Fix obsolete attribute

31532f7

Fix obsolete attribute in ref file

47d3f99

stephentoub approved these changes Mar 13, 2021

View reviewed changes

Add new obsoletion ID to documentation

420faa7

jkotas reviewed Mar 13, 2021

View reviewed changes

annchous added 2 commits March 13, 2021 23:00

Removed all references of DisablePrivateReflection in src/coreclr

1ab8ff0

Fixed error message of obsoletion

5b44c5e

Fixed documentation

ee26ac4

Removed reference of DisablePrivateReflection

b7a8c48

Add NoWarn for new obsoletion ID

fd6c291

annchous requested review from stephentoub and jkotas March 13, 2021 21:30

Add pragma to tests

d5fb2ba

stephentoub reviewed Mar 14, 2021

View reviewed changes

Fix error message of new obsoletion

1c9f137

annchous requested a review from stephentoub March 14, 2021 02:37

Fix new obsoletion description in documentation

f0740ff

jkotas approved these changes Mar 14, 2021

View reviewed changes

runfoapp bot mentioned this pull request Mar 15, 2021

Mono System.Text.Json.Tests on Windows timing out #42677

Open

stephentoub approved these changes Mar 16, 2021

View reviewed changes

stephentoub merged commit 0b7bcf0 into dotnet:main Mar 17, 2021

ghost locked as resolved and limited conversation to collaborators Apr 16, 2021

karelz added this to the 6.0.0 milestone May 20, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add obsolete attribute to DisablePrivateReflectionAttribute #49550

Add obsolete attribute to DisablePrivateReflectionAttribute #49550

annchous commented Mar 12, 2021

annchous commented Mar 12, 2021 •

edited

Loading

annchous commented Mar 12, 2021

stephentoub Mar 12, 2021 •

edited

Loading

stephentoub Mar 12, 2021

stephentoub Mar 12, 2021

annchous Mar 12, 2021

annchous Mar 12, 2021

annchous commented Mar 12, 2021

stephentoub commented Mar 13, 2021

stephentoub left a comment

annchous commented Mar 13, 2021

annchous commented Mar 13, 2021

jkotas Mar 13, 2021

jkotas Mar 13, 2021

annchous commented Mar 13, 2021 •

edited

Loading

jkotas commented Mar 13, 2021

jkotas commented Mar 13, 2021 •

edited

Loading

annchous commented Mar 13, 2021

jkotas commented Mar 13, 2021

annchous commented Mar 13, 2021

jkotas commented Mar 13, 2021

annchous commented Mar 13, 2021

annchous commented Mar 13, 2021

stephentoub Mar 14, 2021

stephentoub Mar 14, 2021

jkotas left a comment

	internal const string DisablePrivateReflectionAttributeMessage = "DisablePrivateReflectionAttribute has no effect in .NET Core and .NET 6.0+ applications.";
	internal const string DisablePrivateReflectionAttributeMessage = "DisablePrivateReflectionAttribute has no effect in .NET 6.0+ applications.";

	[System.ObsoleteAttribute("DisablePrivateReflectionAttribute has no effect in .NET Core and .NET 6.0+ applications.", DiagnosticId = "SYSLIB0015", UrlFormat = "https://aka.ms/dotnet-warnings/{0}")]
	[System.ObsoleteAttribute("DisablePrivateReflectionAttribute has no effect in .NET 6.0+ applications.", DiagnosticId = "SYSLIB0015", UrlFormat = "https://aka.ms/dotnet-warnings/{0}")]

Add obsolete attribute to DisablePrivateReflectionAttribute #49550

Add obsolete attribute to DisablePrivateReflectionAttribute #49550

Conversation

annchous commented Mar 12, 2021

annchous commented Mar 12, 2021 • edited Loading

annchous commented Mar 12, 2021

stephentoub Mar 12, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

annchous commented Mar 12, 2021

stephentoub commented Mar 13, 2021

stephentoub left a comment

Choose a reason for hiding this comment

annchous commented Mar 13, 2021

annchous commented Mar 13, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

annchous commented Mar 13, 2021 • edited Loading

jkotas commented Mar 13, 2021

jkotas commented Mar 13, 2021 • edited Loading

annchous commented Mar 13, 2021

jkotas commented Mar 13, 2021

annchous commented Mar 13, 2021

jkotas commented Mar 13, 2021

annchous commented Mar 13, 2021

annchous commented Mar 13, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jkotas left a comment

Choose a reason for hiding this comment

annchous commented Mar 12, 2021 •

edited

Loading

stephentoub Mar 12, 2021 •

edited

Loading

annchous commented Mar 13, 2021 •

edited

Loading

jkotas commented Mar 13, 2021 •

edited

Loading