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

Use ThrowIfCancellationRequested instead of simply returning #5343

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Use ThrowIfCancellationRequested instead of simply returning #5343

Show file tree
Hide file tree
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
5 changes: 1 addition & 4 deletions src/Platform/Microsoft.Testing.Extensions.AzureDevOps/AzureDevOpsReporter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,10 +75,7 @@ public Task<bool> IsEnabledAsync()

public async Task ConsumeAsync(IDataProducer dataProducer, IData value, CancellationToken cancellationToken)
{
if (cancellationToken.IsCancellationRequested)
{
return;
}
cancellationToken.ThrowIfCancellationRequested();

if (value is not TestNodeUpdateMessage nodeUpdateMessage)
{
Expand Down
8 changes: 4 additions & 4 deletions src/Platform/Microsoft.Testing.Extensions.CrashDump/CrashDumpProcessLifetimeHandler.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,12 +51,12 @@ public Task<bool> IsEnabledAsync()

public Task BeforeTestHostProcessStartAsync(CancellationToken _) => Task.CompletedTask;

public Task OnTestHostProcessStartedAsync(ITestHostProcessInformation testHostProcessInformation, CancellationToken cancellation) => Task.CompletedTask;
public Task OnTestHostProcessStartedAsync(ITestHostProcessInformation testHostProcessInformation, CancellationToken cancellationToken) => Task.CompletedTask;

public async Task OnTestHostProcessExitedAsync(ITestHostProcessInformation testHostProcessInformation, CancellationToken cancellation)
public async Task OnTestHostProcessExitedAsync(ITestHostProcessInformation testHostProcessInformation, CancellationToken cancellationToken)
{
if (cancellation.IsCancellationRequested
|| testHostProcessInformation.HasExitedGracefully
cancellationToken.ThrowIfCancellationRequested();
if (testHostProcessInformation.HasExitedGracefully
|| (AppDomain.CurrentDomain.GetData("ProcessKilledByHangDump") is string processKilledByHangDump && processKilledByHangDump == "true"))
{
return;
Expand Down
7 changes: 4 additions & 3 deletions src/Platform/Microsoft.Testing.Extensions.HangDump/HangDumpActivityIndicator.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,8 +89,9 @@ public Task<bool> IsEnabledAsync() => Task.FromResult(_commandLineOptions.IsOpti
public async Task OnTestSessionStartingAsync(SessionUid sessionUid, CancellationToken cancellationToken)
{
ApplicationStateGuard.Ensure(_namedPipeClient is not null);
cancellationToken.ThrowIfCancellationRequested();

if (!await IsEnabledAsync() || cancellationToken.IsCancellationRequested)
if (!await IsEnabledAsync())
{
return;
}
Expand Down Expand Up @@ -156,8 +157,8 @@ private async Task<IResponse> CallbackAsync(IRequest request)

public async Task ConsumeAsync(IDataProducer dataProducer, IData value, CancellationToken cancellationToken)
{
if (cancellationToken.IsCancellationRequested
|| value is not TestNodeUpdateMessage nodeChangedMessage)
cancellationToken.ThrowIfCancellationRequested();
if (value is not TestNodeUpdateMessage nodeChangedMessage)
{
return;
}
Expand Down
17 changes: 7 additions & 10 deletions src/Platform/Microsoft.Testing.Extensions.HangDump/HangDumpProcessLifetimeHandler.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ private async Task<IResponse> CallbackAsync(IRequest request)
}
}

public async Task OnTestHostProcessStartedAsync(ITestHostProcessInformation testHostProcessInformation, CancellationToken cancellation)
public async Task OnTestHostProcessStartedAsync(ITestHostProcessInformation testHostProcessInformation, CancellationToken cancellationToken)
{
ApplicationStateGuard.Ensure(_waitConnectionTask is not null);
ApplicationStateGuard.Ensure(_singleConnectionNamedPipeServer is not null);
Expand All @@ -184,27 +184,24 @@ public async Task OnTestHostProcessStartedAsync(ITestHostProcessInformation test
await _logger.LogDebugAsync($"Wait for test host connection to the server pipe '{_singleConnectionNamedPipeServer.PipeName.Name}'");
await _waitConnectionTask.TimeoutAfterAsync(TimeoutHelper.DefaultHangTimeSpanTimeout);
using CancellationTokenSource timeout = new(TimeoutHelper.DefaultHangTimeSpanTimeout);
using var linkedCancellationToken = CancellationTokenSource.CreateLinkedTokenSource(cancellation, timeout.Token);
using var linkedCancellationToken = CancellationTokenSource.CreateLinkedTokenSource(cancellationToken, timeout.Token);
_waitConsumerPipeName.Wait(linkedCancellationToken.Token);
ApplicationStateGuard.Ensure(_namedPipeClient is not null);
await _namedPipeClient.ConnectAsync(cancellation).TimeoutAfterAsync(TimeoutHelper.DefaultHangTimeSpanTimeout);
await _namedPipeClient.ConnectAsync(cancellationToken).TimeoutAfterAsync(TimeoutHelper.DefaultHangTimeSpanTimeout);
await _logger.LogDebugAsync($"Connected to the test host server pipe '{_namedPipeClient.PipeName}'");

// Keep the custom thread to avoid to waste one from thread pool.
_activityIndicatorTask = _task.RunLongRunning(ActivityTimerAsync, "[HangDump] ActivityTimerAsync", cancellation);
_activityIndicatorTask = _task.RunLongRunning(ActivityTimerAsync, "[HangDump] ActivityTimerAsync", cancellationToken);
}
catch (OperationCanceledException) when (cancellation.IsCancellationRequested)
catch (OperationCanceledException) when (cancellationToken.IsCancellationRequested)
{
return;
}
}

public async Task OnTestHostProcessExitedAsync(ITestHostProcessInformation testHostProcessInformation, CancellationToken cancellation)
public async Task OnTestHostProcessExitedAsync(ITestHostProcessInformation testHostProcessInformation, CancellationToken cancellationToken)
{
if (cancellation.IsCancellationRequested)
{
return;
}
cancellationToken.ThrowIfCancellationRequested();

if (!testHostProcessInformation.HasExitedGracefully)
{
Expand Down
5 changes: 1 addition & 4 deletions src/Platform/Microsoft.Testing.Extensions.MSBuild/MSBuildConsumer.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,10 +61,7 @@ public Task OnTestSessionFinishingAsync(SessionUid sessionUid, CancellationToken

public async Task ConsumeAsync(IDataProducer dataProducer, IData value, CancellationToken cancellationToken)
{
if (cancellationToken.IsCancellationRequested)
{
return;
}
cancellationToken.ThrowIfCancellationRequested();

// Avoid processing messages if the session has ended.
if (_sessionEnded)
Expand Down
5 changes: 1 addition & 4 deletions src/Platform/Microsoft.Testing.Extensions.Telemetry/AppInsightsProvider.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,10 +118,7 @@ public AppInsightsProvider(
// Initialize the telemetry client and start ingesting events.
private async Task IngestLoopAsync()
{
if (_testApplicationCancellationTokenSource.CancellationToken.IsCancellationRequested)
{
return;
}
_testApplicationCancellationTokenSource.CancellationToken.ThrowIfCancellationRequested();

try
{
Expand Down
9 changes: 6 additions & 3 deletions src/Platform/Microsoft.Testing.Extensions.TrxReport/TrxDataConsumer.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,8 @@ public TrxReportGenerator(

public Task ConsumeAsync(IDataProducer dataProducer, IData value, CancellationToken cancellationToken)
{
if (!_isEnabled || cancellationToken.IsCancellationRequested)
cancellationToken.ThrowIfCancellationRequested();
if (!_isEnabled)
{
return Task.CompletedTask;
}
Expand Down Expand Up @@ -163,7 +164,8 @@ public Task ConsumeAsync(IDataProducer dataProducer, IData value, CancellationTo

public async Task OnTestSessionStartingAsync(SessionUid _, CancellationToken cancellationToken)
{
if (!_isEnabled || cancellationToken.IsCancellationRequested)
cancellationToken.ThrowIfCancellationRequested();
if (!_isEnabled)
{
return;
}
Expand Down Expand Up @@ -206,7 +208,8 @@ await _trxTestApplicationLifecycleCallbacks.NamedPipeClient.RequestReplyAsync<Te

public async Task OnTestSessionFinishingAsync(SessionUid sessionUid, CancellationToken cancellationToken)
{
if (!_isEnabled || cancellationToken.IsCancellationRequested)
cancellationToken.ThrowIfCancellationRequested();
if (!_isEnabled)
{
return;
}
Expand Down
11 changes: 4 additions & 7 deletions src/Platform/Microsoft.Testing.Extensions.TrxReport/TrxProcessLifetimeHandler.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,12 +137,9 @@ public Task ConsumeAsync(IDataProducer dataProducer, IData value, CancellationTo
return Task.CompletedTask;
}

public async Task OnTestHostProcessExitedAsync(ITestHostProcessInformation testHostProcessInformation, CancellationToken cancellation)
public async Task OnTestHostProcessExitedAsync(ITestHostProcessInformation testHostProcessInformation, CancellationToken cancellationToken)
{
if (cancellation.IsCancellationRequested)
{
return;
}
cancellationToken.ThrowIfCancellationRequested();

Dictionary<IExtension, List<SessionFileArtifact>> artifacts = new();

Expand All @@ -168,7 +165,7 @@ public async Task OnTestHostProcessExitedAsync(ITestHostProcessInformation testH
new TestAdapterInfo(_testAdapterInformationRequest!.TestAdapterId, _testAdapterInformationRequest.TestAdapterVersion),
_startTime,
testHostProcessInformation.ExitCode,
cancellation);
cancellationToken);

(string fileName, string? warning) = await trxReportGeneratorEngine.GenerateReportAsync(
isTestHostCrashed: true,
Expand Down Expand Up @@ -204,7 +201,7 @@ await _messageBus.PublishAsync(
new TestAdapterInfo(_testAdapterInformationRequest!.TestAdapterId, _testAdapterInformationRequest.TestAdapterVersion),
_startTime,
testHostProcessInformation.ExitCode,
cancellation);
cancellationToken);

await trxReportGeneratorEngine.AddArtifactsAsync(trxFile, artifacts);
}
Expand Down
4 changes: 3 additions & 1 deletion src/Platform/Microsoft.Testing.Extensions.TrxReport/TrxTestApplicationLifecycleCallbacks.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,9 @@ public TrxTestApplicationLifecycleCallbacks(

public async Task BeforeRunAsync(CancellationToken cancellationToken)
{
if (!_isEnabled || cancellationToken.IsCancellationRequested)
cancellationToken.ThrowIfCancellationRequested();

if (!_isEnabled)
{
return;
}
Expand Down
10 changes: 2 additions & 8 deletions src/Platform/Microsoft.Testing.Platform/Messages/AsynchronousMessageBus.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,10 +89,7 @@ public override async Task PublishAsync(IDataProducer dataProducer, IData data)
throw new InvalidOperationException("The message bus has not been built yet.");
}

if (_testApplicationCancellationTokenSource.CancellationToken.IsCancellationRequested)
{
return;
}
_testApplicationCancellationTokenSource.CancellationToken.ThrowIfCancellationRequested();

if (_isTraceLoggingEnabled)
{
Expand Down Expand Up @@ -141,10 +138,7 @@ public override async Task DrainDataAsync()
CancellationToken cancellationToken = _testApplicationCancellationTokenSource.CancellationToken;
while (anotherRound)
{
if (cancellationToken.IsCancellationRequested)
{
return;
}
cancellationToken.ThrowIfCancellationRequested();

if (totalNumberOfDrainAttempt == 0)
{
Expand Down
5 changes: 1 addition & 4 deletions src/Platform/Microsoft.Testing.Platform/Messages/ChannelConsumerDataProcessor.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,10 +131,7 @@ public async Task<long> DrainDataAsync()
while (Interlocked.CompareExchange(ref _totalPayloadReceived, totalPayloadReceived, totalPayloadProcessed) != totalPayloadProcessed)
{
// When we cancel we throw inside ConsumeAsync and we won't drain anymore any data
if (_cancellationToken.IsCancellationRequested)
{
break;
}
_cancellationToken.ThrowIfCancellationRequested();

await _task.Delay(currentDelayTimeMs);
currentDelayTimeMs = Math.Min(currentDelayTimeMs + minDelayTimeMs, 200);
Expand Down
5 changes: 1 addition & 4 deletions src/Platform/Microsoft.Testing.Platform/Messages/ConsumingEnumerableConsumerDataProcessor.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,10 +120,7 @@ public async Task<long> DrainDataAsync()
while (Interlocked.CompareExchange(ref _totalPayloadReceived, totalPayloadReceived, totalPayloadProcessed) != totalPayloadProcessed)
{
// When we cancel we throw inside ConsumeAsync and we won't drain anymore any data
if (_cancellationToken.IsCancellationRequested)
{
break;
}
_cancellationToken.ThrowIfCancellationRequested();

await _task.Delay(currentDelayTimeMs);
currentDelayTimeMs = Math.Min(currentDelayTimeMs + minDelayTimeMs, 200);
Expand Down
10 changes: 2 additions & 8 deletions src/Platform/Microsoft.Testing.Platform/OutputDevice/BrowserOutputDevice.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,10 +233,7 @@ public async Task DisplayAfterSessionEndRunAsync()

public Task OnTestSessionStartingAsync(SessionUid sessionUid, CancellationToken cancellationToken)
{
if (cancellationToken.IsCancellationRequested)
{
return Task.CompletedTask;
}
cancellationToken.ThrowIfCancellationRequested();

// We implement IDataConsumerService and IOutputDisplayService.
// So the engine is calling us before as IDataConsumerService and after as IOutputDisplayService.
Expand Down Expand Up @@ -327,10 +324,7 @@ private void OnFailedTest(TestNodeUpdateMessage testNodeStateChanged, TestNodeSt

public Task ConsumeAsync(IDataProducer dataProducer, IData value, CancellationToken cancellationToken)
{
if (cancellationToken.IsCancellationRequested)
{
return Task.CompletedTask;
}
cancellationToken.ThrowIfCancellationRequested();

switch (value)
{
Expand Down
7 changes: 4 additions & 3 deletions src/Platform/Microsoft.Testing.Platform/OutputDevice/TerminalOutputDevice.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -325,7 +325,8 @@ private async Task DisplayAfterSessionEndRunInternalAsync()

public Task OnTestSessionStartingAsync(SessionUid sessionUid, CancellationToken cancellationToken)
{
if (_isServerMode || cancellationToken.IsCancellationRequested)
cancellationToken.ThrowIfCancellationRequested();
if (_isServerMode)
{
return Task.CompletedTask;
}
Expand Down Expand Up @@ -390,8 +391,8 @@ public async Task DisplayAsync(IOutputDeviceDataProducer producer, IOutputDevice
public Task ConsumeAsync(IDataProducer dataProducer, IData value, CancellationToken cancellationToken)
{
RoslynDebug.Assert(_terminalTestReporter is not null);

if (_isServerMode || cancellationToken.IsCancellationRequested)
cancellationToken.ThrowIfCancellationRequested();
if (_isServerMode)
{
return Task.CompletedTask;
}
Expand Down
15 changes: 3 additions & 12 deletions ...form/Microsoft.Testing.Platform/ServerMode/JsonRpc/PerRequestServerDataConsumerService.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,10 +85,7 @@ public TestNodeStatistics GetTestNodeStatistics()

private async Task ProcessTestNodeUpdateAsync(TestNodeUpdateMessage update, CancellationToken cancellationToken)
{
if (cancellationToken.IsCancellationRequested)
{
return;
}
cancellationToken.ThrowIfCancellationRequested();

try
{
Expand Down Expand Up @@ -146,10 +143,7 @@ private async Task SendTestNodeUpdatesOnIdleAsync(Guid runId)
Guard.NotNull(_task);
await Task.WhenAny(_task.Delay(TimeSpan.FromMilliseconds(TestNodeUpdateDelayInMs), cancellationToken), _testSessionEnd.Task);

if (cancellationToken.IsCancellationRequested)
{
return;
}
cancellationToken.ThrowIfCancellationRequested();

await SendTestNodeUpdatesIfNecessaryAsync(runId, cancellationToken);
}
Expand Down Expand Up @@ -210,10 +204,7 @@ public async Task OnTestSessionFinishingAsync(SessionUid sessionUid, Cancellatio

public async Task ConsumeAsync(IDataProducer dataProducer, IData value, CancellationToken cancellationToken)
{
if (cancellationToken.IsCancellationRequested)
{
return;
}
cancellationToken.ThrowIfCancellationRequested();

switch (value)
{
Expand Down