< Summary - Jellyfin

Information
Class: Jellyfin.Api.WebSocketListeners.ScheduledTasksWebSocketListener
Assembly: Jellyfin.Api
File(s): /srv/git/jellyfin/Jellyfin.Api/WebSocketListeners/ScheduledTasksWebSocketListener.cs
Line coverage
65%
Covered lines: 13
Uncovered lines: 7
Coverable lines: 20
Total lines: 89
Line coverage: 65%
Branch coverage
N/A
Covered branches: 0
Total branches: 0
Branch coverage: N/A
Method coverage

Feature is only available for sponsors

Upgrade to PRO version

Coverage history

Coverage history 0 25 50 75 100

Metrics

MethodBranch coverage Crap Score Cyclomatic complexity Line coverage
.ctor(...)100%11100%
get_Type()100%210%
get_StartType()100%210%
get_StopType()100%210%
GetDataToSend()100%210%
OnTaskCompleted(...)100%11100%
OnTaskExecuting(...)100%11100%
OnTaskProgress(...)100%11100%

File(s)

/srv/git/jellyfin/Jellyfin.Api/WebSocketListeners/ScheduledTasksWebSocketListener.cs

#LineLine coverage
 1using System.Collections.Generic;
 2using System.Linq;
 3using System.Threading.Tasks;
 4using Jellyfin.Data.Events;
 5using MediaBrowser.Controller.Net;
 6using MediaBrowser.Model.Session;
 7using MediaBrowser.Model.Tasks;
 8using Microsoft.Extensions.Logging;
 9
 10namespace Jellyfin.Api.WebSocketListeners;
 11
 12/// <summary>
 13/// Class ScheduledTasksWebSocketListener.
 14/// </summary>
 15public class ScheduledTasksWebSocketListener : BasePeriodicWebSocketListener<IEnumerable<TaskInfo>, WebSocketListenerSta
 16{
 17    /// <summary>
 18    /// Gets or sets the task manager.
 19    /// </summary>
 20    /// <value>The task manager.</value>
 21    private readonly ITaskManager _taskManager;
 22
 23    private bool _disposed;
 24
 25    /// <summary>
 26    /// Initializes a new instance of the <see cref="ScheduledTasksWebSocketListener"/> class.
 27    /// </summary>
 28    /// <param name="logger">Instance of the <see cref="ILogger{ScheduledTasksWebSocketListener}"/> interface.</param>
 29    /// <param name="taskManager">Instance of the <see cref="ITaskManager"/> interface.</param>
 30    public ScheduledTasksWebSocketListener(ILogger<ScheduledTasksWebSocketListener> logger, ITaskManager taskManager)
 2031        : base(logger)
 32    {
 2033        _taskManager = taskManager;
 34
 2035        _taskManager.TaskExecuting += OnTaskExecuting;
 2036        _taskManager.TaskCompleted += OnTaskCompleted;
 2037    }
 38
 39    /// <inheritdoc />
 040    protected override SessionMessageType Type => SessionMessageType.ScheduledTasksInfo;
 41
 42    /// <inheritdoc />
 043    protected override SessionMessageType StartType => SessionMessageType.ScheduledTasksInfoStart;
 44
 45    /// <inheritdoc />
 046    protected override SessionMessageType StopType => SessionMessageType.ScheduledTasksInfoStop;
 47
 48    /// <summary>
 49    /// Gets the data to send.
 50    /// </summary>
 51    /// <returns>Task{IEnumerable{TaskInfo}}.</returns>
 52    protected override Task<IEnumerable<TaskInfo>> GetDataToSend()
 53    {
 054        return Task.FromResult(_taskManager.ScheduledTasks
 055            .OrderBy(i => i.Name)
 056            .Select(ScheduledTaskHelpers.GetTaskInfo)
 057            .Where(i => !i.IsHidden));
 58    }
 59
 60    /// <inheritdoc />
 61    protected override async ValueTask DisposeAsyncCore()
 62    {
 63        if (!_disposed)
 64        {
 65            _taskManager.TaskExecuting -= OnTaskExecuting;
 66            _taskManager.TaskCompleted -= OnTaskCompleted;
 67            _disposed = true;
 68        }
 69
 70        await base.DisposeAsyncCore().ConfigureAwait(false);
 71    }
 72
 73    private void OnTaskCompleted(object? sender, TaskCompletionEventArgs e)
 74    {
 1975        e.Task.TaskProgress -= OnTaskProgress;
 1976        SendData(true);
 1977    }
 78
 79    private void OnTaskExecuting(object? sender, GenericEventArgs<IScheduledTaskWorker> e)
 80    {
 2081        SendData(true);
 2082        e.Argument.TaskProgress += OnTaskProgress;
 2083    }
 84
 85    private void OnTaskProgress(object? sender, GenericEventArgs<double> e)
 86    {
 28487        SendData(false);
 28488    }
 89}