Deprecate API and add NFW telemetry for it #70365
Conversation
dotnet-issue-labeler
bot
added
Area-Compilers
untriaged
CyrusNajmabadi
force-pushed
the
deprecateAPI
branch
from
eba7ef1
to
725ba83
Compare
|
@arkalyanms @phil-allen-msft for QB. |
| @@ -194,6 +196,8 @@ public static SyntaxNode DeserializeFrom(Stream stream, CancellationToken cancel | |||
| throw new InvalidOperationException(CodeAnalysisResources.TheStreamCannotBeReadFrom); | |||
| } | |||
|
|
|||
| // Report NFW to see if this is being used in the wild. | |||
| FatalError.ReportAndPropagate(new SerializationDeprecationException()); | |||
There was a problem hiding this comment.
@jasonmalinowski does this look correct wrt to reporting a good NFW we can trak on our side?
There was a problem hiding this comment.
I'd use ReportAndCatch; as discussed it doesn't change anything beyond the return code (if it were being used in an exception filter), but this as written might make people think this will actually throw this.
There was a problem hiding this comment.
not available at this layer :)
| @@ -13,6 +13,8 @@ | |||
| using Roslyn.Test.Utilities; | |||
| using Xunit; | |||
|
|
|||
| #pragma warning disable CS0618 // Type or member is obsolete | |||
There was a problem hiding this comment.
@jasonmalinowski the presumption here is that we do not actual send NFWs for compiler unit tests.
CyrusNajmabadi
force-pushed
the
deprecateAPI
branch
from
725ba83
to
1aa6da4
Compare
CyrusNajmabadi
force-pushed
the
deprecateAPI
branch
from
1aa6da4
to
1bba049
Compare
| @@ -1403,10 +1405,26 @@ public virtual void SerializeTo(Stream stream, CancellationToken cancellationTok | |||
| throw new InvalidOperationException(CodeAnalysisResources.TheStreamCannotBeWrittenTo); | |||
| } | |||
|
|
|||
| // Report NFW to see if this is being used in the wild. | |||
| FatalError.ReportAndPropagate(new SerializationDeprecationException()); | |||
There was a problem hiding this comment.
This is the check that is causing the MVID test to fo fail.
| @@ -13,6 +13,8 @@ | |||
| using Microsoft.CodeAnalysis.CSharp.Syntax; | |||
| using Microsoft.CodeAnalysis.Text; | |||
|
|
|||
| #pragma warning disable CS0618 // Type or member is obsolete | |||
There was a problem hiding this comment.
For these you could also the class itself as [Obsolete] which might make it clearer this obsolete in it's own right.
|
@jaredpar ptal. |
CyrusNajmabadi
force-pushed
the
deprecateAPI
branch
2 times, most recently
from
dadd680
to
2489912
Compare
CyrusNajmabadi
force-pushed
the
deprecateAPI
branch
from
2489912
to
50f4112
Compare
|
@dotnet/roslyn-compiler for a second pair of eyes. @arkalyanms @phil-allen-msft as a reminder to take this for QB. |
Ready for official submission when PR merges. Tracked via https://devdiv.visualstudio.com/DevDiv/_workitems/edit/1903056 |
|
@arkalyanms integration tests seem to be the same ones we're having issues with everywhere. |
|
@333fred could you potentially review this? Since you're aware of hte API review around it? Thanks! |
In 17.9 we'd like to remove the logic to serialize syntax nodes to streams (see #70275 for more details on this and why it should be safe).
However, to build confidence that this will not be an issue, we're pre-emptively deprecating the API (but still keeping the logic for it) in 17.8 and also including an NFW so we can see if this gets hit in the wild for cases we don't know about.
API change was approved in API review.