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.

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

Ensure NFW gets reported before result is reported to client and remove async listener in queue #75907

Merged
merged 3 commits into from
Nov 15, 2024

Conversation

dibarbet
Copy link
Member

@dibarbet dibarbet commented Nov 14, 2024

Should resolve https://dev.azure.com/devdiv/DevDiv/_workitems/edit/2224584

Optprof web application tests have been failing for a while in VS. Tim tracked down the issue to an async listener introduced in #74530

The never completing listener were requests for workspace diagnostics. This is actually expected for workspace diagnostics requests, as they are held open indefinitely if nothing changes (see https://github.com/dotnet/roslyn/blob/main/src/LanguageServer/Protocol/Handler/Diagnostics/AbstractWorkspacePullDiagnosticsHandler.cs#L94). So as long as workspace diagnostics requests function this way, it is easy to get into a situation where there are async listeners that never complete.

The queue async listener was introduced to ensure that unit tests could reliably verify if the NFW handler was called (as handling the exception happened after the response was returned to the client).

To resolve this issue I did a couple things

  1. Move reporting NFW for request exceptions into the telemetry reporting scope. Importantly this scope is called before the result is sent back to the client. This allows unit tests to simply wait for the request to complete before checking if the NFW handler was called (no need for an async listener).
  2. Removing the async listener from the queue now that no unit tests need to wait for an action to occur in the queue.

TODO - validate optprof

@dibarbet dibarbet requested a review from a team as a code owner November 14, 2024 00:41
@dotnet-issue-labeler dotnet-issue-labeler bot added Area-IDE untriaged Issues and PRs which have not yet been triaged by a lead labels Nov 14, 2024
@dibarbet
Copy link
Member Author

@dibarbet dibarbet merged commit 11bc53d into dotnet:main Nov 15, 2024
25 checks passed
@dibarbet dibarbet deleted the fix_optprof_hang branch November 15, 2024 01:10
@dotnet-policy-service dotnet-policy-service bot added this to the Next milestone Nov 15, 2024
@jjonescz jjonescz modified the milestones: Next, 17.13 P2 Nov 25, 2024
dibarbet added a commit to dibarbet/roslyn that referenced this pull request Nov 27, 2024
…ve async listener in queue (dotnet#75907)

Should resolve
https://dev.azure.com/devdiv/DevDiv/_workitems/edit/2224584

Optprof web application tests have been failing for a while in VS. Tim
tracked down the issue to an async listener introduced in
dotnet#74530

The never completing listener were requests for workspace diagnostics.
This is actually expected for workspace diagnostics requests, as they
are held open indefinitely if nothing changes (see
https://github.com/dotnet/roslyn/blob/main/src/LanguageServer/Protocol/Handler/Diagnostics/AbstractWorkspacePullDiagnosticsHandler.cs#L94).
So as long as workspace diagnostics requests function this way, it is
easy to get into a situation where there are async listeners that never
complete.

The queue async listener was introduced to ensure that unit tests could
reliably verify if the NFW handler was called (as handling the exception
happened after the response was returned to the client).

To resolve this issue I did a couple things
1. Move reporting NFW for request exceptions into the telemetry
reporting scope. Importantly this scope is called before the result is
sent back to the client. This allows unit tests to simply wait for the
request to complete before checking if the NFW handler was called (no
need for an async listener).
2. Removing the async listener from the queue now that no unit tests
need to wait for an action to occur in the queue.

TODO - validate optprof
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area-IDE untriaged Issues and PRs which have not yet been triaged by a lead VSCode
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants