Skip to content

17.4: Convert symbol-search crash to NFW #65280

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

Merged
arunchndr merged 1 commit into from
Nov 16, 2022
Merged

17.4: Convert symbol-search crash to NFW #65280

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
34 changes: 24 additions & 10 deletions src/Features/Core/Portable/SymbolSearch/Windows/SymbolSearchUpdateEngine.Update.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -510,23 +510,22 @@ private async Task<XElement> DownloadFileAsync(string serverPath, CancellationTo
{
cancellationToken.ThrowIfCancellationRequested();

var resultOpt = await TryDownloadFileAsync(client, cancellationToken).ConfigureAwait(false);
if (resultOpt == null)
var (element, delay) = await TryDownloadFileAsync(client, cancellationToken).ConfigureAwait(false);
if (element == null)
{
var delay = _service._delayService.CachePollDelay;
await LogInfoAsync($"File not downloaded. Trying again in {delay}", cancellationToken).ConfigureAwait(false);
await Task.Delay(delay, cancellationToken).ConfigureAwait(false);
}
else
{
// File was downloaded.
return resultOpt;
return element;
}
}
}

/// <summary>Returns 'null' if download is not available and caller should keep polling.</summary>
private async Task<XElement> TryDownloadFileAsync(IFileDownloader fileDownloader, CancellationToken cancellationToken)
private async Task<(XElement element, TimeSpan delay)> TryDownloadFileAsync(IFileDownloader fileDownloader, CancellationToken cancellationToken)
{
await LogInfoAsync("Read file from client", cancellationToken).ConfigureAwait(false);

Expand All @@ -535,7 +534,7 @@ private async Task<XElement> TryDownloadFileAsync(IFileDownloader fileDownloader
if (stream == null)
{
await LogInfoAsync("Read file completed. Client returned no data", cancellationToken).ConfigureAwait(false);
return null;
return (element: null, _service._delayService.CachePollDelay);
}

await LogInfoAsync("Read file completed. Client returned data", cancellationToken).ConfigureAwait(false);
Expand All @@ -551,11 +550,26 @@ private async Task<XElement> TryDownloadFileAsync(IFileDownloader fileDownloader
XmlResolver = null
};

using var reader = XmlReader.Create(stream, settings);
// This code must always succeed. If it does not, that means that either the server reported bogus data
// to the file-downloader, or the file-downloader is serving us bogus data. In other event, there is
// something wrong with those components, and we should both report the issue to Watson, and stop doing
// the update.
try
{
using var reader = XmlReader.Create(stream, settings);

var result = XElement.Load(reader);
await LogInfoAsync("Converting data to XElement completed", cancellationToken).ConfigureAwait(false);
return result;
var element = XElement.Load(reader);
await LogInfoAsync("Converting data to XElement completed", cancellationToken).ConfigureAwait(false);
return (element, delay: default);
}
catch (Exception e) when (_service._reportAndSwallowExceptionUnlessCanceled(e, cancellationToken))
Copy link
Member

@dibarbet dibarbet Nov 8, 2022

Choose a reason for hiding this comment

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

same q on the _service here

Copy link
Contributor Author

@CyrusNajmabadi CyrusNajmabadi Nov 8, 2022

Choose a reason for hiding this comment

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

Answered in other PR. this allows the tests to actually validate tehse codepaths without actually invoking FatalError (which kills tests).

{
// We retrieved bytes from the server, but we couldn't make parse it an xml. out of it. That's very
// bad. Just trying again one minute later isn't going to help. We need to wait until there is
// good data on the server for us to download.
await LogInfoAsync($"Unable to parse file as XElement", cancellationToken).ConfigureAwait(false);
return (element: null, _service._delayService.CatastrophicFailureDelay);
}
}

private async Task RepeatIOAsync(Func<CancellationToken, Task> action, CancellationToken cancellationToken)
Expand Down