Fixing API compat issues between ref/src for attributes on properties by ericstj · Pull Request #68432 · dotnet/runtime

ericstj · 2022-04-23T02:48:18Z

API compat had a regression about a year ago where it stopped checking attributes on members other than methods. dotnet/arcade#9168 fixes that. This PR brings us back up to date.

Marking this breaking because one member was missing obsolete in the ref assembly.

ghost · 2022-04-23T02:48:23Z

Added needs-breaking-change-doc-created label because this PR has the breaking-change label.

When you commit this breaking change:

Create and link to this PR and the issue a matching issue in the dotnet/docs repo using the breaking change documentation template, then remove this needs-breaking-change-doc-created label.
Ask a committer to mail the .NET Breaking Change Notification DL.

Tagging @dotnet/compat for awareness of the breaking change.

ghost · 2022-04-23T02:48:26Z

Note regarding the new-api-needs-documentation label:

This serves as a reminder for when your PR is modifying a ref *.cs file and adding/modifying public APIs, to please make sure the API implementation in the src *.cs file is documented with triple slash comments, so the PR reviewers can sign off that change.

ghost · 2022-04-23T02:48:26Z

I couldn't figure out the best area label to add to this PR. If you have write-permissions please help me learn by adding exactly one area label.

ericstj · 2022-04-23T02:49:37Z

    public enum SerializationFormat
    {
        Xml = 0,
+        [System.ObsoleteAttribute("SerializationFormat.Binary is obsolete and should not be used. See https://aka.ms/serializationformat-binary-obsolete for more information.", DiagnosticId = "SYSLIB0038")]


This is a breaking change: it was already made in the src but never shipped in references.

This should be fine. We already have obsolete attributes regarding binary formatter in various places; it seems we simply missed this occurrence. However, given this is in System.Data, it might be a very different scenario. /cc @roji @ajcvickers

Yeah, we did this recently in #39289 as part of obsoleting (and eventually removing) all uses of BinaryFormatter, for 7.0 (so hasn't shipped yet). It's indeed being treated and documented as a breaking change.

rzikm

System.Net.* changes LGTM.

stephentoub

Other than the mono build break, LGTM.

terrajobst · 2022-04-25T18:18:28Z

I've used the patch file to get to a quick summary of all new attributes:

All attribute additions

[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicProperties | DynamicallyAccessedMemberTypes.PublicFields)]
[EditorBrowsable(EditorBrowsableState.Advanced)]
[EditorBrowsable(EditorBrowsableState.Never)]
[Obsolete("Add(String parameterName, Object value) has been deprecated. Use AddWithValue(String parameterName, Object value) instead.")]
[Obsolete("Assembly.CodeBase and Assembly.EscapedCodeBase are only included for .NET Framework compatibility. Use Assembly.Location instead.", DiagnosticId = "SYSLIB0012", UrlFormat = "https://aka.ms/dotnet-warnings/{0}")]
[Obsolete("Assembly.CodeBase and Assembly.EscapedCodeBase are only included for .NET Framework compatibility. Use Assembly.Location.", DiagnosticId = "SYSLIB0012", UrlFormat = "https://aka.ms/dotnet-warnings/{0}")]
[Obsolete("IPAddress.Address is address family dependent and has been deprecated. Use IPAddress.Equals to perform comparisons instead.")]
[Obsolete("IsolatedStorageFile.CurrentSize has been deprecated because it is not CLS Compliant. To get the current size use IsolatedStorageFile.UsedSize instead.")]
[Obsolete("IsolatedStorageFile.MaximumSize has been deprecated because it is not CLS Compliant. To get the maximum size use IsolatedStorageFile.Quota instead.")]
[Obsolete("Marshalling arbitrary types may be unavailable in future releases. Specify the type you wish to marshal as.")]
[Obsolete("Marshalling as AnsiBStr may be unavailable in future releases.")]
[Obsolete("Marshalling as Currency may be unavailable in future releases.")]
[Obsolete("Marshalling as TBstr may be unavailable in future releases.")]
[Obsolete("Marshalling as VBByRefString may be unavailable in future releases.")]
[Obsolete("OffsetToStringData has been deprecated. Use string.GetPinnableReference() instead.")]
[Obsolete("PerformanceCounter.DefaultFileMappingSize has been deprecated and is not used. Use machine.config or an application configuration file to set the size of the PerformanceCounter file mapping instead.")]
[Obsolete("PerformanceCounterManager has been deprecated. Use the PerformanceCounters through the System.Diagnostics.PerformanceCounter class instead.")]
[Obsolete("Process.NonpagedSystemMemorySize has been deprecated because the type of the property can't represent all valid results. Use System.Diagnostics.Process.NonpagedSystemMemorySize64 instead.")]
[Obsolete("Process.PagedMemorySize has been deprecated because the type of the property can't represent all valid results. Use System.Diagnostics.Process.PagedMemorySize64 instead.")]
[Obsolete("Process.PagedSystemMemorySize has been deprecated because the type of the property can't represent all valid results. Use System.Diagnostics.Process.PagedSystemMemorySize64 instead.")]
[Obsolete("Process.PeakPagedMemorySize has been deprecated because the type of the property can't represent all valid results. Use System.Diagnostics.Process.PeakPagedMemorySize64 instead.")]
[Obsolete("Process.PeakVirtualMemorySize has been deprecated because the type of the property can't represent all valid results. Use System.Diagnostics.Process.PeakVirtualMemorySize64 instead.")]
[Obsolete("Process.PeakWorkingSet has been deprecated because the type of the property can't represent all valid results. Use System.Diagnostics.Process.PeakWorkingSet64 instead.")]
[Obsolete("Process.PrivateMemorySize has been deprecated because the type of the property can't represent all valid results. Use System.Diagnostics.Process.PrivateMemorySize64 instead.")]
[Obsolete("Process.VirtualMemorySize has been deprecated because the type of the property can't represent all valid results. Use System.Diagnostics.Process.VirtualMemorySize64 instead.")]
[Obsolete("Process.WorkingSet has been deprecated because the type of the property can't represent all valid results. Use System.Diagnostics.Process.WorkingSet64 instead.")]
[Obsolete("ReflectionPermissionAttribute.ReflectionEmit has been deprecated and is not supported.")]
[Obsolete("ReflectionPermissionAttribute.TypeInformation has been deprecated and is not supported.")]
[Obsolete("ReflectionPermissionFlag.AllFlags has been deprecated. Use PermissionState.Unrestricted to get full access.")]
[Obsolete("ReflectionPermissionFlag.ReflectionEmit  has been deprecated and is not supported.")]
[Obsolete("ReflectionPermissionFlag.TypeInformation has been deprecated and is not supported.")]
[Obsolete("RegistryPermissionAttribute.Add has been deprecated. Use ViewAndModify instead.")]
[Obsolete("SecurityProtocolType.Ssl3 has been deprecated and is not supported.")]
[Obsolete("SerializationFormat.Binary is obsolete and should not be used. See https://aka.ms/serializationformat-binary-obsolete for more information.", DiagnosticId = "SYSLIB0038")]
[Obsolete("StandardEventKeywords.CorrelationHint has an incorrect value and has been deprecated. Use CorrelationHint2 instead.")]
[Obsolete("The ApartmentState property has been deprecated. Use GetApartmentState, SetApartmentState or TrySetApartmentState instead.")]
[Obsolete("vbNewLine has been deprecated. For a carriage return and line feed, use vbCrLf. For the current platform's newline, use System.Environment.NewLine."]
[Obsolete("WaitHandle.Handle has been deprecated. Use the SafeWaitHandle property instead.")]
[RequiresAssemblyFiles("Returns <Unknown> for modules with no file path")]
[RequiresAssemblyFiles("This member throws an exception for assemblies embedded in a single-file app")]
[SupportedOSPlatform("maccatalyst")]
[UnsupportedOSPlatform("freebsd")]
[UnsupportedOSPlatform("illumos")]
[UnsupportedOSPlatform("ios")]
[UnsupportedOSPlatform("osx")]
[UnsupportedOSPlatform("solaris")]
[UnsupportedOSPlatform("tvos")]

These are the types:

DynamicallyAccessedMembers, RequiresAssemblyFiles. Linker related. I wouldn't consider them source breaking as they make it easier to troubleshoot runtime issues when trimming your app.
EditorBrowsable. Not source breaking.
Obsolete. Source breaking, but we have said in the past we're OK with that.
SupportedOSPlatform, UnsupportedOSPlatform. Platform compat annotations. I wouldn't consider them source breaking as they make it easier to troubleshoot runtime issues when running on a different operating system.

This will allow us to ensure the codebase is ready to ingest the arcade fix to ApiCompat.

ghost · 2022-04-28T20:31:27Z

Tagging subscribers to this area: @dotnet/area-infrastructure-libraries
See info in area-owners.md if you want to be subscribed.

Issue Details

API compat had a regression about a year ago where it stopped checking attributes on members other than methods. dotnet/arcade#9168 fixes that. This PR brings us back up to date.

Marking this breaking because one member was missing obsolete in the ref assembly.

Author:	ericstj
Assignees:	ericstj
Labels:	`area-Infrastructure-libraries`, `breaking-change`, `new-api-needs-documentation`, `needs-breaking-change-doc-created`
Milestone:	-

bartonjs

LGTM, except for the System.Data.Common.Tests build failures.

This was introduced by dotnet/runtime#68432. We need to mark the test as not runnable on the platforms where we are missing this property

ericstj · 2022-09-15T16:55:11Z

Doc was created in dotnet/docs#28726 and is published as https://docs.microsoft.com/en-us/dotnet/core/compatibility/core-libraries/7.0/serializationformat-binary

Fixing API compat issues between ref/src for attributes on properties

889952c

ericstj added the breaking-change Issue or PR that represents a breaking API or functional change over a previous release. label Apr 23, 2022

ericstj requested review from a team, eerhardt, stephentoub and terrajobst April 23, 2022 02:48

ericstj requested a review from MichalStrehovsky as a code owner April 23, 2022 02:48

ghost added the needs-breaking-change-doc-created Breaking changes need an issue opened with https://github.com/dotnet/docs/issues/new?template=dotnet label Apr 23, 2022

ghost assigned ericstj Apr 23, 2022

ghost added the new-api-needs-documentation label Apr 23, 2022

ericstj commented Apr 23, 2022

View reviewed changes

rzikm approved these changes Apr 25, 2022

View reviewed changes

stephentoub approved these changes Apr 25, 2022

View reviewed changes

Fix some build breaks due to obsoleted API

eb22a51

terrajobst requested review from ajcvickers and roji April 25, 2022 18:05

terrajobst approved these changes Apr 25, 2022

View reviewed changes

eerhardt reviewed Apr 25, 2022

View reviewed changes

Comment thread src/libraries/System.Diagnostics.Process/ref/System.Diagnostics.Process.cs

ericstj added 2 commits April 25, 2022 12:14

Fix remaining attribute inconsistencies

5e244ac

Update API compat baselines for the shared framework.

a04d826

ericstj requested a review from marek-safar as a code owner April 25, 2022 19:16

Temporarily suppress ApiCompat baseline validation

a7231c0

This will allow us to ensure the codebase is ready to ingest the arcade fix to ApiCompat.

ericstj commented Apr 26, 2022

View reviewed changes

Comment thread src/libraries/apicompat/ApiCompat.proj

danmoseley added the area-Infrastructure-libraries label Apr 28, 2022

bartonjs approved these changes Apr 29, 2022

View reviewed changes

Fix usage of obsolete API in Data.Common tests

260e5e3

This was referenced Apr 29, 2022

RunContinueWithStressTestsNoState timing out in CI #2271

Closed

System.Runtime.Serialization.Xml.Tests failed #59926

Closed

ericstj mentioned this pull request Apr 30, 2022

Clarify desired platform attributes on Process types #68729

Closed

ericstj merged commit 0e84780 into dotnet:main Apr 30, 2022

DrewScoggins added a commit to DrewScoggins/performance-2 that referenced this pull request May 3, 2022

Fix UnsupportedOS issue

b263096

This was introduced by dotnet/runtime#68432. We need to mark the test as not runnable on the platforms where we are missing this property

DrewScoggins mentioned this pull request May 3, 2022

Fix UnsupportedOS issue dotnet/performance#2408

Merged

ericstj removed the new-api-needs-documentation label May 3, 2022

ericstj mentioned this pull request May 3, 2022

Fix a few more API compat inconsistencies #68834

Merged

DrewScoggins added a commit to dotnet/performance that referenced this pull request May 3, 2022

Fix UnsupportedOS issue (#2408)

382ccf0

This was introduced by dotnet/runtime#68432. We need to mark the test as not runnable on the platforms where we are missing this property

ghost locked as resolved and limited conversation to collaborators Jun 3, 2022

ericstj added this to the 7.0.0 milestone Sep 15, 2022

ericstj removed the needs-breaking-change-doc-created Breaking changes need an issue opened with https://github.com/dotnet/docs/issues/new?template=dotnet label Sep 15, 2022

Navigation Menu

Repository navigation

Fixing API compat issues between ref/src for attributes on properties - #68432

Fixing API compat issues between ref/src for attributes on properties#68432
ericstj merged 6 commits into
dotnet:mainfrom
ericstj:fixPropAttrApiCompat

ericstj commented Apr 23, 2022

Uh oh!

ghost commented Apr 23, 2022

Uh oh!

ghost commented Apr 23, 2022

Uh oh!

ghost commented Apr 23, 2022

Uh oh!

ericstj Apr 23, 2022

Uh oh!

terrajobst Apr 25, 2022

Uh oh!

roji Apr 26, 2022

Uh oh!

rzikm left a comment

Uh oh!

stephentoub left a comment

Uh oh!

terrajobst commented Apr 25, 2022 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

ghost commented Apr 28, 2022

Uh oh!

bartonjs left a comment

Uh oh!

ericstj commented Sep 15, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

Conversation

ericstj commented Apr 23, 2022

Uh oh!

ghost commented Apr 23, 2022

Uh oh!

ghost commented Apr 23, 2022

Uh oh!

ghost commented Apr 23, 2022

Uh oh!

ericstj Apr 23, 2022

Choose a reason for hiding this comment

Uh oh!

terrajobst Apr 25, 2022

Choose a reason for hiding this comment

Uh oh!

roji Apr 26, 2022

Choose a reason for hiding this comment

Uh oh!

rzikm left a comment

Choose a reason for hiding this comment

Uh oh!

stephentoub left a comment

Choose a reason for hiding this comment

Uh oh!

terrajobst commented Apr 25, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ghost commented Apr 28, 2022

Uh oh!

bartonjs left a comment

Choose a reason for hiding this comment

Uh oh!

ericstj commented Sep 15, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

terrajobst commented Apr 25, 2022 •

edited

Loading