New: Show previously installed version in Updates UI

Co-Authored-By: Taloth <Taloth@users.noreply.github.com>

src/NzbDrone.Core.Test/UpdateTests/UpdatePackageProviderFixture.cs

@@ -47,7 +47,7 @@ namespace NzbDrone.Core.Test.UpdateTests
         {
             const string branch = "develop";
             UseRealHttp();
-            var recent = Subject.GetRecentUpdates(branch, new Version(2, 0));
+            var recent = Subject.GetRecentUpdates(branch, new Version(2, 0), null);
             var recentWithChanges = recent.Where(c => c.Changes != null);
 
             recent.Should().NotBeEmpty();

src/NzbDrone.Core/Datastore/Converters/SystemVersionConverter.cs

@@ -0,0 +1,24 @@
+using System;
+using System.Data;
+using Dapper;
+
+namespace NzbDrone.Core.Datastore.Converters
+{
+    public class SystemVersionConverter : SqlMapper.TypeHandler<Version>
+    {
+        public override Version Parse(object value)
+        {
+            if (value is string version)
+            {
+                return Version.Parse((string)value);
+            }
+
+            return null;
+        }
+
+        public override void SetValue(IDbDataParameter parameter, Version value)
+        {
+            parameter.Value = value.ToString();
+        }
+    }
+}

src/NzbDrone.Core/Datastore/Migration/004_add_update_history.cs

@@ -0,0 +1,20 @@
+using System;
+using System.Collections.Generic;
+using System.Data;
+using FluentMigrator;
+using NzbDrone.Core.Datastore.Migration.Framework;
+
+namespace NzbDrone.Core.Datastore.Migration
+{
+    [Migration(004)]
+    public class add_update_history : NzbDroneMigrationBase
+    {
+        protected override void LogDbUpgrade()
+        {
+            Create.TableForModel("UpdateHistory")
+                  .WithColumn("Date").AsDateTime().NotNullable().Indexed()
+                  .WithColumn("Version").AsString().NotNullable()
+                  .WithColumn("EventType").AsInt32().NotNullable();
+        }
+    }
+}

src/NzbDrone.Core/Datastore/TableMapping.cs

@@ -18,6 +18,7 @@ using NzbDrone.Core.Notifications;
 using NzbDrone.Core.Parser.Model;
 using NzbDrone.Core.Tags;
 using NzbDrone.Core.ThingiProvider;
+using NzbDrone.Core.Update.History;
 using static Dapper.SqlMapper;
 
 namespace NzbDrone.Core.Datastore
@@ -84,6 +85,7 @@ namespace NzbDrone.Core.Datastore
             Mapper.Entity<ApplicationStatus>("ApplicationStatus").RegisterModel();
 
             Mapper.Entity<CustomFilter>("CustomFilters").RegisterModel();
+            Mapper.Entity<UpdateHistory>("UpdateHistory").RegisterModel();
         }
 
         private static void RegisterMappers()
@@ -108,6 +110,7 @@ namespace NzbDrone.Core.Datastore
             SqlMapper.RemoveTypeMap(typeof(Guid?));
             SqlMapper.AddTypeHandler(new GuidConverter());
             SqlMapper.AddTypeHandler(new CommandConverter());
+            SqlMapper.AddTypeHandler(new SystemVersionConverter());
         }
 
         private static void RegisterProviderSettingConverter()

src/NzbDrone.Core/Update/Events/UpdateInstalledEvent.cs

@@ -0,0 +1,17 @@
+using System;
+using NzbDrone.Common.Messaging;
+
+namespace NzbDrone.Core.Update.History.Events
+{
+    public class UpdateInstalledEvent : IEvent
+    {
+        public Version PreviousVerison { get; set; }
+        public Version NewVersion { get; set; }
+
+        public UpdateInstalledEvent(Version previousVersion, Version newVersion)
+        {
+            PreviousVerison = previousVersion;
+            NewVersion = newVersion;
+        }
+    }
+}

src/NzbDrone.Core/Update/History/UpdateHistory.cs

@@ -0,0 +1,12 @@
+using System;
+using NzbDrone.Core.Datastore;
+
+namespace NzbDrone.Core.Update.History
+{
+    public class UpdateHistory : ModelBase
+    {
+        public DateTime Date { get; set; }
+        public Version Version { get; set; }
+        public UpdateHistoryEventType EventType { get; set; }
+    }
+}

src/NzbDrone.Core/Update/History/UpdateHistoryEventType.cs

@@ -0,0 +1,9 @@
+namespace NzbDrone.Core.Update.History
+{
+    public enum UpdateHistoryEventType
+    {
+        Unknown = 0,
+        Initiated = 1,
+        Installed = 2
+    }
+}

src/NzbDrone.Core/Update/History/UpdateHistoryRepository.cs

@@ -0,0 +1,55 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+using NzbDrone.Core.Datastore;
+using NzbDrone.Core.Messaging.Events;
+
+namespace NzbDrone.Core.Update.History
+{
+    public interface IUpdateHistoryRepository : IBasicRepository<UpdateHistory>
+    {
+        UpdateHistory LastInstalled();
+        UpdateHistory PreviouslyInstalled();
+        List<UpdateHistory> InstalledSince(DateTime dateTime);
+    }
+
+    public class UpdateHistoryRepository : BasicRepository<UpdateHistory>, IUpdateHistoryRepository
+    {
+        public UpdateHistoryRepository(ILogDatabase logDatabase, IEventAggregator eventAggregator)
+            : base(logDatabase, eventAggregator)
+        {
+        }
+
+        public UpdateHistory LastInstalled()
+        {
+            var history = Query(x => x.EventType == UpdateHistoryEventType.Installed)
+                               .OrderBy(v => v.Date)
+                               .Take(1)
+                               .FirstOrDefault();
+
+            return history;
+        }
+
+        public UpdateHistory PreviouslyInstalled()
+        {
+            var history = Query(x => x.EventType == UpdateHistoryEventType.Installed)
+                               .OrderBy(v => v.Date)
+                               .Skip(1)
+                               .Take(1)
+                               .FirstOrDefault();
+
+            return history;
+        }
+
+        public List<UpdateHistory> InstalledSince(DateTime dateTime)
+        {
+            var history = Query(v => v.EventType == UpdateHistoryEventType.Installed && v.Date >= dateTime)
+                               .OrderBy(v => v.Date)
+                               .ToList();
+
+            return history;
+        }
+    }
+}

src/NzbDrone.Core/Update/History/UpdateHistoryService.cs

@@ -0,0 +1,71 @@
+using System;
+using System.Collections.Generic;
+using NzbDrone.Common.EnvironmentInfo;
+using NzbDrone.Core.Lifecycle;
+using NzbDrone.Core.Messaging.Events;
+using NzbDrone.Core.Update.History.Events;
+
+namespace NzbDrone.Core.Update.History
+{
+    public interface IUpdateHistoryService
+    {
+        Version PreviouslyInstalled();
+        List<UpdateHistory> InstalledSince(DateTime dateTime);
+    }
+
+    public class UpdateHistoryService : IUpdateHistoryService, IHandle<ApplicationStartedEvent>, IHandleAsync<ApplicationStartedEvent>
+    {
+        private readonly IUpdateHistoryRepository _repository;
+        private readonly IEventAggregator _eventAggregator;
+        private Version _prevVersion;
+
+        public UpdateHistoryService(IUpdateHistoryRepository repository, IEventAggregator eventAggregator)
+        {
+            _repository = repository;
+            _eventAggregator = eventAggregator;
+        }
+
+        public Version PreviouslyInstalled()
+        {
+            var history = _repository.PreviouslyInstalled();
+
+            return history?.Version;
+        }
+
+        public List<UpdateHistory> InstalledSince(DateTime dateTime)
+        {
+            return _repository.InstalledSince(dateTime);
+        }
+
+        public void Handle(ApplicationStartedEvent message)
+        {
+            if (BuildInfo.Version.Major == 10)
+            {
+                // Don't save dev versions, they change constantly
+                return;
+            }
+
+            var history = _repository.LastInstalled();
+
+            if (history == null || history.Version != BuildInfo.Version)
+            {
+                _prevVersion = history.Version;
+
+                _repository.Insert(new UpdateHistory
+                {
+                    Date = DateTime.UtcNow,
+                    Version = BuildInfo.Version,
+                    EventType = UpdateHistoryEventType.Installed
+                });
+            }
+        }
+
+        public void HandleAsync(ApplicationStartedEvent message)
+        {
+            if (_prevVersion != null)
+            {
+                _eventAggregator.PublishEvent(new UpdateInstalledEvent(_prevVersion, BuildInfo.Version));
+            }
+        }
+    }
+}

src/NzbDrone.Core/Update/RecentUpdateProvider.cs

@@ -1,6 +1,8 @@
-using System.Collections.Generic;
+using System;
+using System.Collections.Generic;
 using NzbDrone.Common.EnvironmentInfo;
 using NzbDrone.Core.Configuration;
+using NzbDrone.Core.Update.History;
 
 namespace NzbDrone.Core.Update
 {
@@ -13,18 +15,23 @@ namespace NzbDrone.Core.Update
     {
         private readonly IConfigFileProvider _configFileProvider;
         private readonly IUpdatePackageProvider _updatePackageProvider;
+        private readonly IUpdateHistoryService _updateHistoryService;
 
         public RecentUpdateProvider(IConfigFileProvider configFileProvider,
-                                   IUpdatePackageProvider updatePackageProvider)
+                                    IUpdatePackageProvider updatePackageProvider,
+                                    IUpdateHistoryService updateHistoryService)
         {
             _configFileProvider = configFileProvider;
             _updatePackageProvider = updatePackageProvider;
+            _updateHistoryService = updateHistoryService;
         }
 
         public List<UpdatePackage> GetRecentUpdatePackages()
         {
             var branch = _configFileProvider.Branch;
-            return _updatePackageProvider.GetRecentUpdates(branch, BuildInfo.Version);
+            var version = BuildInfo.Version;
+            var prevVersion = _updateHistoryService.PreviouslyInstalled();
+            return _updatePackageProvider.GetRecentUpdates(branch, version, prevVersion);
         }
     }
 }

src/NzbDrone.Core/Update/UpdatePackageProvider.cs

@@ -11,7 +11,7 @@ namespace NzbDrone.Core.Update
     public interface IUpdatePackageProvider
     {
         UpdatePackage GetLatestUpdate(string branch, Version currentVersion);
-        List<UpdatePackage> GetRecentUpdates(string branch, Version currentVersion);
+        List<UpdatePackage> GetRecentUpdates(string branch, Version currentVersion, Version previousVersion = null);
     }
 
     public class UpdatePackageProvider : IUpdatePackageProvider
@@ -56,7 +56,7 @@ namespace NzbDrone.Core.Update
             return update.UpdatePackage;
         }
 
-        public List<UpdatePackage> GetRecentUpdates(string branch, Version currentVersion)
+        public List<UpdatePackage> GetRecentUpdates(string branch, Version currentVersion, Version previousVersion)
         {
             var request = _requestBuilder.Create()
                                          .Resource("/update/{branch}/changes")
@@ -67,6 +67,11 @@ namespace NzbDrone.Core.Update
                                          .AddQueryParam("runtimeVer", _platformInfo.Version)
                                          .SetSegment("branch", branch);
 
+            if (previousVersion != null && previousVersion != currentVersion)
+            {
+                request.AddQueryParam("prevVersion", previousVersion);
+            }
+
             if (_analyticsService.IsEnabled)
             {
                 // Send if the system is active so we know which versions to deprecate/ignore

src/Prowlarr.Api.V1/Update/UpdateController.cs

@@ -2,7 +2,9 @@ using System.Collections.Generic;
 using System.Linq;
 using Microsoft.AspNetCore.Mvc;
 using NzbDrone.Common.EnvironmentInfo;
+using NzbDrone.Common.Extensions;
 using NzbDrone.Core.Update;
+using NzbDrone.Core.Update.History;
 using Prowlarr.Http;
 
 namespace Prowlarr.Api.V1.Update
@@ -11,10 +13,12 @@ namespace Prowlarr.Api.V1.Update
     public class UpdateController : Controller
     {
         private readonly IRecentUpdateProvider _recentUpdateProvider;
+        private readonly IUpdateHistoryService _updateHistoryService;
 
-        public UpdateController(IRecentUpdateProvider recentUpdateProvider)
+        public UpdateController(IRecentUpdateProvider recentUpdateProvider, IUpdateHistoryService updateHistoryService)
         {
             _recentUpdateProvider = recentUpdateProvider;
+            _updateHistoryService = updateHistoryService;
         }
 
         [HttpGet]
@@ -40,6 +44,18 @@ namespace Prowlarr.Api.V1.Update
                 {
                     installed.Installed = true;
                 }
+
+                var installDates = _updateHistoryService.InstalledSince(resources.Last().ReleaseDate)
+                                                        .DistinctBy(v => v.Version)
+                                                        .ToDictionary(v => v.Version);
+
+                foreach (var resource in resources)
+                {
+                    if (installDates.TryGetValue(resource.Version, out var installDate))
+                    {
+                        resource.InstalledOn = installDate.Date;
+                    }
+                }
             }
 
             return resources;

src/Prowlarr.Api.V1/Update/UpdateResource.cs

@@ -15,6 +15,7 @@ namespace Prowlarr.Api.V1.Update
         public string FileName { get; set; }
         public string Url { get; set; }
         public bool Installed { get; set; }
+        public DateTime? InstalledOn { get; set; }
         public bool Installable { get; set; }
         public bool Latest { get; set; }
         public UpdateChanges Changes { get; set; }

src/Radarr.Api.V3/Update/UpdateResource.cs

@@ -0,0 +1,58 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using Newtonsoft.Json;
+using NzbDrone.Core.Update;
+using Radarr.Http.REST;
+
+namespace Radarr.Api.V3.Update
+{
+    public class UpdateResource : RestResource
+    {
+        [JsonConverter(typeof(Newtonsoft.Json.Converters.VersionConverter))]
+        public Version Version { get; set; }
+
+        public string Branch { get; set; }
+        public DateTime ReleaseDate { get; set; }
+        public string FileName { get; set; }
+        public string Url { get; set; }
+        public bool Installed { get; set; }
+        public DateTime? InstalledOn { get; set; }
+        public bool Installable { get; set; }
+        public bool Latest { get; set; }
+        public UpdateChanges Changes { get; set; }
+        public string Hash { get; set; }
+    }
+
+    public static class UpdateResourceMapper
+    {
+        public static UpdateResource ToResource(this UpdatePackage model)
+        {
+            if (model == null)
+            {
+                return null;
+            }
+
+            return new UpdateResource
+            {
+                Version = model.Version,
+
+                Branch = model.Branch,
+                ReleaseDate = model.ReleaseDate,
+                FileName = model.FileName,
+                Url = model.Url,
+
+                //Installed
+                //Installable
+                //Latest
+                Changes = model.Changes,
+                Hash = model.Hash,
+            };
+        }
+
+        public static List<UpdateResource> ToResource(this IEnumerable<UpdatePackage> models)
+        {
+            return models.Select(ToResource).ToList();
+        }
+    }
+}