9821665098

Committed 06 Jul 2024 07:39PM UTC coverage: 83.223% (+0.06%) from 83.163%

Build # 9821665098

Build Type

push

github

Committed by

web-flow

Commit Message

Stability fixes (#1131)

* Make the disposing of application context thread safe

* Fix the example app using get calendar events

* Make the handling of cancellation more roboust to avoid the source to be disposed before all tasks been completed

* added tests

* Fixed the throw instead

* Ignore and tracelog the operation cancelled exception in background task

* revert throwifcanceled #1

* revert throwif cancelled #2

* Add the Flush feature on BackgroundTaskTracker

* Fix the scheduler to be more robust and not call actions on disposed schedulers

* Fix the code comment using interlocked instead

* Fix warning and missing setting the disposed flag

* add test

* Added context tests

* Added even more tests

* add tests

* fix test

* remove the last of throwifcancelled

* Add one more test

* renaming

* Fix comments and from discussion

* removed timing using TaskSource

* using interlocked on more places

* removed the disposable timer

* fix last interlocked case

* forgott the test

* revert back to volatile bools

* Added more checks for disposed and throws if so

* added test for multople dispose

* fix from comment

Run Details

903 of 1239 branches covered (72.88%)

Branch coverage included in aggregate %.

56 of 66 new or added lines in 7 files covered. (84.85%)

1 existing line in 1 file now uncovered.

3363 of 3887 relevant lines covered (86.52%)

647.61 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

85.71

/src/HassModel/NetDeamon.HassModel/Internal/BackgroundTaskTracker.cs

﻿using System.Collections.Concurrent;

namespace NetDaemon.HassModel.Internal;

internal class BackgroundTaskTracker : IBackgroundTaskTracker
{
    private readonly ILogger<BackgroundTaskTracker> _logger;
    private volatile bool _isDisposed;

    internal readonly ConcurrentDictionary<Task, object?> BackgroundTasks = new();

    public BackgroundTaskTracker(ILogger<BackgroundTaskTracker> logger)
    {
        _logger = logger;
    }

    public void TrackBackgroundTask(Task? task, string? description = null)
    {
        ArgumentNullException.ThrowIfNull(task, nameof(task));

        BackgroundTasks.TryAdd(task, null);

        [SuppressMessage("", "CA1031")]
        async Task Wrap()
        {
            try
            {
                await task.ConfigureAwait(false);
            }
            catch (OperationCanceledException)
            {
                _logger.LogTrace("Task was canceled processing Home Assistant event: {Description}", description ?? "");
            }
            catch (Exception e)
            {
                _logger.LogError(e, "Exception processing Home Assistant event: {Description}", description ?? "");
            }
            finally
            {
                BackgroundTasks.TryRemove(task, out var _);
            }
        }

        // We do not handle task here cause exceptions
        // are handled in the Wrap local functions and
        // all tasks should be cancelable
        _ = Wrap();
    }

    public async ValueTask DisposeAsync()
    {
        if (_isDisposed) return;
        _isDisposed = true;

        var timeoutTask = Task.Delay(TimeSpan.FromSeconds(5));

        // Using a while look here incase new tasks are added while we are waiting
        while (!BackgroundTasks.IsEmpty)
        {
            var task = await Task.WhenAny( Task.WhenAll(BackgroundTasks.Keys), timeoutTask).ConfigureAwait(false);
            if (task == timeoutTask)
                break;
        }
    }
}

1	using System.Collections.Concurrent;
2
3	namespace NetDaemon.HassModel.Internal;
4
5	internal class BackgroundTaskTracker : IBackgroundTaskTracker
6	{
7	private readonly ILogger<BackgroundTaskTracker> _logger;
8	private volatile bool _isDisposed;
9
10	internal readonly ConcurrentDictionary<Task, object?> BackgroundTasks = new();	32✔
11
12	public BackgroundTaskTracker(ILogger<BackgroundTaskTracker> logger)	32✔
13	{
14	_logger = logger;	32✔
15	}	32✔
16
17	public void TrackBackgroundTask(Task? task, string? description = null)
18	{
19	ArgumentNullException.ThrowIfNull(task, nameof(task));	21✔
20
21	BackgroundTasks.TryAdd(task, null);	21✔
22
23	[SuppressMessage("", "CA1031")]
24	async Task Wrap()
25	{
26	try
27	{
28	await task.ConfigureAwait(false);	21✔
29	}	20✔
NEW 30	catch (OperationCanceledException)	×
31	{
NEW 32	_logger.LogTrace("Task was canceled processing Home Assistant event: {Description}", description ?? "");	×
NEW 33	}	×
34	catch (Exception e)	1✔
35	{
36	_logger.LogError(e, "Exception processing Home Assistant event: {Description}", description ?? "");	1✔
37	}	1✔
38	finally
39	{
40	BackgroundTasks.TryRemove(task, out var _);	21✔
41	}
42	}	21✔
43
44	// We do not handle task here cause exceptions
45	// are handled in the Wrap local functions and
46	// all tasks should be cancelable
47	_ = Wrap();	21✔
48	}	21✔
49
50	public async ValueTask DisposeAsync()
51	{
52	if (_isDisposed) return;	92✔
53	_isDisposed = true;	20✔
54
55	var timeoutTask = Task.Delay(TimeSpan.FromSeconds(5));	20✔
56
57	// Using a while look here incase new tasks are added while we are waiting
58	while (!BackgroundTasks.IsEmpty)	732,079✔
59	{
60	var task = await Task.WhenAny( Task.WhenAll(BackgroundTasks.Keys), timeoutTask).ConfigureAwait(false);	732,060✔
61	if (task == timeoutTask)	732,060✔
62	break;
63	}
64	}	56✔
65	}

net-daemon / netdaemon / 9821665098

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous