Fixed: Unable to load UI if Quality Profiles contain removed Custom Format items

Closes #5323

src/NzbDrone.Core.Test/Housekeeping/Housekeepers/CleanupQualityProfileFormatItemsFixture.cs

@@ -0,0 +1,81 @@
+using System.Collections.Generic;
+using System.Linq;
+using FizzWare.NBuilder;
+using FluentAssertions;
+using NUnit.Framework;
+using NzbDrone.Core.CustomFormats;
+using NzbDrone.Core.Datastore;
+using NzbDrone.Core.Housekeeping.Housekeepers;
+using NzbDrone.Core.Messaging.Events;
+using NzbDrone.Core.Profiles;
+using NzbDrone.Core.Profiles.Qualities;
+using NzbDrone.Core.Test.Framework;
+
+namespace NzbDrone.Core.Test.Housekeeping.Housekeepers
+{
+    [TestFixture]
+    public class CleanupQualityProfileFormatItemsFixture : DbTest<CleanupQualityProfileFormatItems, QualityProfile>
+    {
+        [SetUp]
+        public void Setup()
+        {
+            Mocker.SetConstant<IQualityProfileFormatItemsCleanupRepository>(
+                new QualityProfileFormatItemsCleanupRepository(Mocker.Resolve<IMainDatabase>(), Mocker.Resolve<IEventAggregator>()));
+        }
+
+        [Test]
+        public void should_remove_orphaned_custom_formats()
+        {
+            var qualityProfile = Builder<QualityProfile>.CreateNew()
+                .With(h => h.Items = Qualities.QualityFixture.GetDefaultQualities())
+                .With(h => h.MinFormatScore = 50)
+                .With(h => h.CutoffFormatScore = 100)
+                .With(h => h.FormatItems = Builder<ProfileFormatItem>.CreateListOfSize(1).Build().ToList())
+                .BuildNew();
+
+            Db.Insert(qualityProfile);
+            Subject.Clean();
+
+            var result = AllStoredModels;
+
+            result.Should().HaveCount(1);
+            result.First().FormatItems.Should().BeEmpty();
+            result.First().MinFormatScore.Should().Be(0);
+            result.First().CutoffFormatScore.Should().Be(0);
+        }
+
+        [Test]
+        public void should_not_remove_unorphaned_custom_formats()
+        {
+            var minFormatScore = 50;
+            var cutoffFormatScore = 100;
+
+            var customFormat = Builder<CustomFormat>.CreateNew()
+                .With(h => h.Specifications = new List<ICustomFormatSpecification>())
+                .BuildNew();
+
+            Db.Insert(customFormat);
+
+            var qualityProfile = Builder<QualityProfile>.CreateNew()
+                .With(h => h.Items = Qualities.QualityFixture.GetDefaultQualities())
+                .With(h => h.MinFormatScore = minFormatScore)
+                .With(h => h.CutoffFormatScore = cutoffFormatScore)
+                .With(h => h.FormatItems = new List<ProfileFormatItem>
+                {
+                    Builder<ProfileFormatItem>.CreateNew().With(f => f.Id = customFormat.Id).Build()
+                })
+
+                .BuildNew();
+
+            Db.Insert(qualityProfile);
+
+            Subject.Clean();
+            var result = AllStoredModels;
+
+            result.Should().HaveCount(1);
+            result.First().FormatItems.Should().HaveCount(1);
+            result.First().MinFormatScore.Should().Be(minFormatScore);
+            result.First().CutoffFormatScore.Should().Be(cutoffFormatScore);
+        }
+    }
+}

src/NzbDrone.Core/Housekeeping/Housekeepers/CleanupQualityProfileFormatItems.cs

@@ -0,0 +1,72 @@
+using System.Collections.Generic;
+using System.Linq;
+using Dapper;
+using NzbDrone.Common.Extensions;
+using NzbDrone.Core.Datastore;
+using NzbDrone.Core.Messaging.Events;
+using NzbDrone.Core.Profiles.Qualities;
+
+namespace NzbDrone.Core.Housekeeping.Housekeepers
+{
+    public class CleanupQualityProfileFormatItems : IHousekeepingTask
+    {
+        private readonly IMainDatabase _database;
+        private readonly IQualityProfileFormatItemsCleanupRepository _repository;
+
+        public CleanupQualityProfileFormatItems(IMainDatabase database, IQualityProfileFormatItemsCleanupRepository repository)
+        {
+            _database = database;
+            _repository = repository;
+        }
+
+        public void Clean()
+        {
+            var customFormatIds = GetCustomFormatIds();
+            var profiles = _repository.All();
+            var updatedProfiles = new List<QualityProfile>();
+
+            foreach (var profile in profiles)
+            {
+                var formatItems = profile.FormatItems.Where(f => customFormatIds.Contains(f.Id)).ToList();
+
+                if (formatItems.Count != profile.FormatItems.Count)
+                {
+                    profile.FormatItems = formatItems;
+
+                    if (profile.FormatItems.Empty())
+                    {
+                        profile.MinFormatScore = 0;
+                        profile.CutoffFormatScore = 0;
+                    }
+
+                    updatedProfiles.Add(profile);
+                }
+            }
+
+            if (updatedProfiles.Any())
+            {
+                _repository.SetFields(updatedProfiles, p => p.FormatItems, p => p.MinFormatScore, p => p.CutoffFormatScore);
+            }
+        }
+
+        private HashSet<int> GetCustomFormatIds()
+        {
+            using (var mapper = _database.OpenConnection())
+            {
+                return new HashSet<int>(mapper.Query<int>("SELECT Id FROM CustomFormats"));
+            }
+        }
+    }
+
+    public interface IQualityProfileFormatItemsCleanupRepository : IBasicRepository<QualityProfile>
+    {
+    }
+
+    public class QualityProfileFormatItemsCleanupRepository : BasicRepository<QualityProfile>, IQualityProfileFormatItemsCleanupRepository
+    {
+        public QualityProfileFormatItemsCleanupRepository(IMainDatabase database, IEventAggregator eventAggregator)
+            : base(database, eventAggregator)
+        {
+        }
+    }
+}

src/NzbDrone.Core/Profiles/Qualities/QualityProfileRepository.cs

@@ -34,10 +34,20 @@ namespace NzbDrone.Core.Profiles.Qualities
             // all the custom formats
             foreach (var profile in profiles)
             {
+                var formatItems = new List<ProfileFormatItem>();
+
                 foreach (var formatItem in profile.FormatItems)
                 {
-                    formatItem.Format = cfs[formatItem.Format.Id];
+                    // Skip any format that has been removed, but the profile wasn't updated properly
+                    if (cfs.ContainsKey(formatItem.Format.Id))
+                    {
+                        formatItem.Format = cfs[formatItem.Format.Id];
+
+                        formatItems.Add(formatItem);
+                    }
                 }
+
+                profile.FormatItems = formatItems;
             }
 
             return profiles;

src/NzbDrone.Core/Profiles/Qualities/QualityProfileService.cs

@@ -1,6 +1,7 @@
 using System.Collections.Generic;
 using System.Linq;
 using NLog;
+using NzbDrone.Common.Extensions;
 using NzbDrone.Core.CustomFormats;
 using NzbDrone.Core.CustomFormats.Events;
 using NzbDrone.Core.ImportLists;
@@ -149,6 +150,7 @@ namespace NzbDrone.Core.Profiles.Qualities
         public void Handle(CustomFormatAddedEvent message)
         {
             var all = All();
+
             foreach (var profile in all)
             {
                 profile.FormatItems.Insert(0, new ProfileFormatItem
@@ -167,7 +169,8 @@ namespace NzbDrone.Core.Profiles.Qualities
             foreach (var profile in all)
             {
                 profile.FormatItems = profile.FormatItems.Where(c => c.Format.Id != message.CustomFormat.Id).ToList();
-                if (!profile.FormatItems.Any())
+
+                if (profile.FormatItems.Empty())
                 {
                     profile.MinFormatScore = 0;
                     profile.CutoffFormatScore = 0;