Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[wasm] Mark System.Threading.Thread APIs unsupported on Browser #41892

Closed
wants to merge 4 commits into from
Closed

[wasm] Mark System.Threading.Thread APIs unsupported on Browser #41892

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b0f9910
System.Threading.Thread enable platform attributes
Sep 4, 2020
fa2a503
[wasm] Mark System.Threading.Thread APIs unsupported on Browser
Sep 4, 2020
20ad956
System.Threading.Thread remove CurrentPrincipal false positive
Sep 4, 2020
59534f0
Mark System.Threading.Thread ResetAbort as obsolete
Sep 4, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/libraries/System.Private.CoreLib/src/System/Threading/CompressedStack.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
// The .NET Foundation licenses this file to you under the MIT license.

using System.Runtime.Serialization;
using System.Runtime.Versioning;

namespace System.Threading
{
Expand Down
2 changes: 2 additions & 0 deletions src/libraries/System.Private.CoreLib/src/System/Threading/Thread.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,7 @@ public CultureInfo CurrentUICulture

public static IPrincipal? CurrentPrincipal
{
[UnsupportedOSPlatform("browser")]
get
{
IPrincipal? principal = s_asyncLocalPrincipal?.Value;
Expand Down Expand Up @@ -189,6 +190,7 @@ public void Abort(object? stateInfo)
throw new PlatformNotSupportedException(SR.PlatformNotSupported_ThreadAbort);
}

[UnsupportedOSPlatform("browser")]
public static void ResetAbort()
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

since this throws PNSE everywhere, is there a way we can mark it as such?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if its better to stick with the convention of marking it Obsolete. I wasn't sure if a docs issue should be linked in the parameters of Obsolete. It looks like it was brought up in dotnet/docs#3825.

Another option that was brought up was to mark this as [UnsupportedOSPlatform("none")]

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jeffhandley @buyaa-n What do y'all think about [UnsupportedOSPlatform("none")]?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For the analyzer that would be treated like unsupported on a platform named "none", there is no generic naming for all platforms CC @terrajobst

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[Obsolete] would be a better approach than to fake that with an [UnsupportedOSPlatform] or [SupportedOSPlatform] attribute. I recommend we omit this annotation here and file a 6.0.0 issue to mark this API as Obsolete.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was looking at a stale page a moment ago. I think we'll have to wait to mark this as Obsolete until 6.0.0 since it's technically a breaking change. We'll want to consider using a custom diagnostic id for the obsoletion too and add it to the list of obsoletions, etc.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree with Jeff. We shouldn't annotate this API. We should obsolete, but not for .NET 5.

{
throw new PlatformNotSupportedException(SR.PlatformNotSupported_ThreadAbort);
Expand Down
1 change: 1 addition & 0 deletions src/libraries/System.Threading.Thread/Directory.Build.props
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,6 @@
<Import Project="..\Directory.Build.props" />
<PropertyGroup>
<StrongNameKeyId>Microsoft</StrongNameKeyId>
<IncludePlatformAttributes>true</IncludePlatformAttributes>
</PropertyGroup>
</Project>
3 changes: 2 additions & 1 deletion src/libraries/System.Threading.Thread/ref/System.Threading.Thread.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ public Thread(System.Threading.ThreadStart start, int maxStackSize) { }
[System.ObsoleteAttribute("The ApartmentState property has been deprecated. Use GetApartmentState, SetApartmentState or TrySetApartmentState instead.", false)]
public System.Threading.ApartmentState ApartmentState { get { throw null; } set { } }
public System.Globalization.CultureInfo CurrentCulture { get { throw null; } set { } }
public static System.Security.Principal.IPrincipal? CurrentPrincipal { get { throw null; } set { } }
public static System.Security.Principal.IPrincipal? CurrentPrincipal { [System.Runtime.Versioning.UnsupportedOSPlatformAttribute("browser")] get { throw null; } set { } }
public static System.Threading.Thread CurrentThread { get { throw null; } }
public System.Globalization.CultureInfo CurrentUICulture { get { throw null; } set { } }
public System.Threading.ExecutionContext? ExecutionContext { get { throw null; } }
Expand Down Expand Up @@ -77,6 +77,7 @@ public void Join() { }
public bool Join(int millisecondsTimeout) { throw null; }
public bool Join(System.TimeSpan timeout) { throw null; }
public static void MemoryBarrier() { }
[System.Runtime.Versioning.UnsupportedOSPlatformAttribute("browser")]
public static void ResetAbort() { }
[System.ObsoleteAttribute("Thread.Resume has been deprecated. Please use other classes in System.Threading, such as Monitor, Mutex, Event, and Semaphore, to synchronize Threads or protect resources. https://go.microsoft.com/fwlink/?linkid=14202", false)]
public void Resume() { }
Expand Down