refactor: add better logging when cancelling refresh

Belphemur · Dec 13, 2023 · 29f986b · 29f986b
1 parent 2df1449
commit 29f986b
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 6 deletions.
diff --git a/SoundSwitch/Framework/Audio/Lister/CachedAudioDeviceLister.cs b/SoundSwitch/Framework/Audio/Lister/CachedAudioDeviceLister.cs
@@ -90,10 +90,12 @@ private void DeviceChanged(object sender, DeviceChangedEventBase e)
 
         public void Refresh(CancellationToken cancellationToken = default)
         {
+            var logContext = _context.ForContext("TaskId", Task.CurrentId);
             // Cancel the previous refresh operation, if any
             var previousCts = Interlocked.Exchange(ref _refreshCancellationTokenSource, CancellationTokenSource.CreateLinkedTokenSource(cancellationToken));
             if (previousCts != null)
             {
+                logContext.Info("Cancelling Previous Context");
                 previousCts.Cancel();
                 previousCts.Dispose();
             }
@@ -108,13 +110,13 @@ public void Refresh(CancellationToken cancellationToken = default)
 
                 using var registration = cancellationToken.Register(_ =>
                 {
-                    _context.Warning("Cancellation received.");
+                    logContext.Warning("Cancellation received.");
                     throw new OperationCanceledException("Stop refreshing", cancellationToken);
                 }, null);
 
                 try
                 {
-                    _context.Information("Refreshing all devices");
+                    logContext.Information("Refreshing all devices");
                     var enumerator = new MMDeviceEnumerator();
                     using var _ = enumerator.DisposeOnCancellation(cancellationToken);
                     foreach (var endPoint in enumerator.EnumerateAudioEndPoints(DataFlow.All, _state))
@@ -144,7 +146,7 @@ public void Refresh(CancellationToken cancellationToken = default)
                         }
                         catch (Exception e)
                         {
-                            _context.Warning(e, "Can't get name of device {device}", endPoint.ID);
+                            logContext.Warning(e, "Can't get name of device {device}", endPoint.ID);
                         }
                     }
 
@@ -157,15 +159,15 @@ public void Refresh(CancellationToken cancellationToken = default)
                     RecordingDevices = recordingDevices.Values.ToArray();
 
 
-                    _context.Information("Refreshed all devices in {@StopTime}. {@Recording}/rec, {@Playback}/play", stopWatch.Elapsed, recordingDevices.Count, playbackDevices.Count);
+                    logContext.Information("Refreshed all devices in {@StopTime}. {@Recording}/rec, {@Playback}/play", stopWatch.Elapsed, recordingDevices.Count, playbackDevices.Count);
                 }
                 //If cancellation token is cancelled, its expected to throw null since the device enumerator has been disposed
                 catch (NullReferenceException e) when (!cancellationToken.IsCancellationRequested)
                 {
-                    _context.Error(e, "Can't refresh the devices");
+                    logContext.Error(e, "Can't refresh the devices");
                 } catch(NullReferenceException e) when (cancellationToken.IsCancellationRequested)
                 {
-                    _context.Information(e, "Cancellation requested and enumerator is disposed, ignoring");
+                    logContext.Information(e, "Cancellation requested and enumerator is disposed, ignoring");
                 }
             }
             finally

diff --git a/SoundSwitch/Framework/Audio/Lister/Job/DebounceRefreshJob.cs b/SoundSwitch/Framework/Audio/Lister/Job/DebounceRefreshJob.cs
@@ -35,6 +35,12 @@ public Task OnFailure(JobException exception)
             _logger.Warning("Refresh of device interrupted");
             return Task.CompletedTask;
         }
+
+        if(exception.InnerException is AggregateException aggregateException && aggregateException.InnerExceptions.FirstOrDefault() is OperationCanceledException)
+        {
+            _logger.Warning("Refresh of device interrupted");
+            return Task.CompletedTask;
+        }
 
         _logger.Warning(exception, "Can't refresh devices");
         return Task.CompletedTask;