Merge pull request #6037 from retailcoder/versioncheckservice

retailcoder · web-flow · commit 089ad0c092be · 2022-10-21T18:05:30.000-04:00
Version check service
diff --git a/Rubberduck.Core/App.cs b/Rubberduck.Core/App.cs
@@ -26,7 +26,7 @@ public sealed class App : IDisposable
         private readonly IConfigurationService<Configuration> _configService;
         private readonly IAppMenu _appMenus;
         private readonly IRubberduckHooks _hooks;
-        private readonly IVersionCheck _version;
+        private readonly IVersionCheckService _version;
         private readonly CommandBase _checkVersionCommand;
 
         private static readonly Logger Logger = LogManager.GetCurrentClassLogger();
@@ -38,7 +38,7 @@ public App(IMessageBox messageBox,
             IConfigurationService<Configuration> configService,
             IAppMenu appMenus,
             IRubberduckHooks hooks,
-            IVersionCheck version,
+            IVersionCheckService version,
             CommandBase checkVersionCommand,
             IFileSystem filesystem)
         {
diff --git a/Rubberduck.Core/Rubberduck.Core.csproj b/Rubberduck.Core/Rubberduck.Core.csproj
@@ -77,6 +77,7 @@
     <PackageReference Include="HtmlAgilityPack">
       <Version>1.8.4</Version>
     </PackageReference>
+    <PackageReference Include="Newtonsoft.Json" Version="13.0.1" />
     <PackageReference Include="NLog">
       <Version>4.5.10</Version>
     </PackageReference>
diff --git a/Rubberduck.Core/UI/About/AboutControlViewModel.cs b/Rubberduck.Core/UI/About/AboutControlViewModel.cs
@@ -12,10 +12,10 @@ namespace Rubberduck.UI.About
 {
     public class AboutControlViewModel
     {
-        private readonly IVersionCheck _version;
+        private readonly IVersionCheckService _version;
         private readonly IWebNavigator _web;
 
-        public AboutControlViewModel(IVersionCheck version, IWebNavigator web)
+        public AboutControlViewModel(IVersionCheckService version, IWebNavigator web)
         {
             _version = version;
             _web = web;
diff --git a/Rubberduck.Core/UI/About/AboutDialog.cs b/Rubberduck.Core/UI/About/AboutDialog.cs
@@ -5,7 +5,7 @@ namespace Rubberduck.UI.About
 {
     public partial class AboutDialog : Form
     {
-        public AboutDialog(IVersionCheck versionCheck, IWebNavigator web) : this()
+        public AboutDialog(IVersionCheckService versionCheck, IWebNavigator web) : this()
         {
             ViewModel = new AboutControlViewModel(versionCheck, web);
         }
diff --git a/Rubberduck.Core/UI/Command/AboutCommand.cs b/Rubberduck.Core/UI/Command/AboutCommand.cs
@@ -10,13 +10,13 @@ namespace Rubberduck.UI.Command
     [ComVisible(false)]
     public class AboutCommand : CommandBase
     {
-        public AboutCommand(IVersionCheck versionService, IWebNavigator web)
+        public AboutCommand(IVersionCheckService versionService, IWebNavigator web)
         {
             _versionService = versionService;
             _web = web;
         }
 
-        private readonly IVersionCheck _versionService;
+        private readonly IVersionCheckService _versionService;
         private readonly IWebNavigator _web;
 
         protected override void OnExecute(object parameter)
diff --git a/Rubberduck.Core/UI/Command/VersionCheckCommand.cs b/Rubberduck.Core/UI/Command/VersionCheckCommand.cs
@@ -28,12 +28,12 @@ public void Start(string fileName)
 
     public class VersionCheckCommand : CommandBase
     {
-        private readonly IVersionCheck _versionCheck;
+        private readonly IVersionCheckService _versionCheck;
         private readonly IMessageBox _prompt;
         private readonly IExternalProcess _process;
         IConfigurationService<Configuration> _config;
 
-        public VersionCheckCommand(IVersionCheck versionCheck, IMessageBox prompt, IExternalProcess process, IConfigurationService<Configuration> config)
+        public VersionCheckCommand(IVersionCheckService versionCheck, IMessageBox prompt, IExternalProcess process, IConfigurationService<Configuration> config)
         {
             _versionCheck = versionCheck;
             _prompt = prompt;
diff --git a/Rubberduck.Core/UI/Splash2021.cs b/Rubberduck.Core/UI/Splash2021.cs
@@ -11,7 +11,7 @@ public Splash2021()
             InitializeComponent();
         }
 
-        public Splash2021(IVersionCheck versionCheck) : this()
+        public Splash2021(IVersionCheckService versionCheck) : this()
         {
             VersionLabel.Text = string.Format(Resources.RubberduckUI.Rubberduck_AboutBuild, versionCheck.VersionString);
             VersionLabel.Parent = pictureBox1;
diff --git a/Rubberduck.Core/VersionCheck/IVersionCheckService.cs b/Rubberduck.Core/VersionCheck/IVersionCheckService.cs
@@ -5,7 +5,7 @@
 
 namespace Rubberduck.VersionCheck
 {
-    public interface IVersionCheck
+    public interface IVersionCheckService
     {
         Task<Version> GetLatestVersionAsync(GeneralSettings settings, CancellationToken token = default);
         Version CurrentVersion { get; }
diff --git a/Rubberduck.Core/VersionCheck/VersionCheck.cs b/Rubberduck.Core/VersionCheck/VersionCheck.cs
diff --git a/Rubberduck.Core/VersionCheck/VersionCheckService.cs b/Rubberduck.Core/VersionCheck/VersionCheckService.cs
@@ -0,0 +1,80 @@
+﻿using Newtonsoft.Json;
+using Rubberduck.Settings;
+using System;
+using System.Linq;
+using System.Net.Http;
+using System.Threading;
+using System.Threading.Tasks;
+
+namespace Rubberduck.VersionCheck
+{
+    public class VersionCheckService : IVersionCheckService
+    {
+        /// <param name="version">That would be the version of the assembly for the <c>_Extension</c> class.</param>
+        public VersionCheckService(Version version)
+        {
+            CurrentVersion = version;
+#if DEBUG
+            IsDebugBuild = true;
+#endif
+            VersionString = IsDebugBuild
+                ? $"{version.Major}.{version.Minor}.{version.Build}.x (debug)"
+                : version.ToString();
+        }
+
+        private Version _latestVersion;
+        public async Task<Version> GetLatestVersionAsync(GeneralSettings settings, CancellationToken token = default)
+        {
+            if (_latestVersion != default) { return _latestVersion; }
+
+            try
+            {
+                return settings.IncludePreRelease 
+                    ? await GetGitHubNext() 
+                    : await GetGitHubMain();
+            }
+            catch
+            {
+                return _latestVersion;
+            }
+        }
+
+        public Version CurrentVersion { get; }
+        public bool IsDebugBuild { get; }
+        public string VersionString { get; }
+
+        private async Task<Version> GetGitHubMain()
+        {
+            var url = new Uri("https://github.com/repos/rubberduck-vba/Rubberduck/releases/latest");
+            using (var client = new HttpClient())
+            {
+                client.DefaultRequestHeaders.UserAgent.Add(new System.Net.Http.Headers.ProductInfoHeaderValue("rubberduck.version-check"));
+                using (var response = await client.GetAsync(url))
+                {
+                    var content = await response.Content.ReadAsStringAsync();
+                    var tagName = (string)JsonConvert.DeserializeObject<dynamic>(content).tag_name;
+
+                    // assumes a tag name like "v2.5.3.0"
+                    return new Version(tagName.Substring("v".Length));
+                }
+            }
+        }
+
+        private async Task<Version> GetGitHubNext()
+        {
+            var url = new Uri("https://github.com/repos/rubberduck-vba/Rubberduck/releases");
+            using (var client = new HttpClient())
+            {
+                client.DefaultRequestHeaders.UserAgent.Add(new System.Net.Http.Headers.ProductInfoHeaderValue("rubberduck.version-check"));
+                using (var response = await client.GetAsync(url))
+                {
+                    var content = await response.Content.ReadAsStringAsync();
+                    var tagName = (string)JsonConvert.DeserializeObject<dynamic>(content)[0].tag_name;
+
+                    // assumes a tag name like "Prerelease-v2.5.2.1234"
+                    return new Version(tagName.Substring("Prerelease-v".Length));
+                }
+            }
+        }
+    }
+}
diff --git a/Rubberduck.Main/Extension.cs b/Rubberduck.Main/Extension.cs
@@ -193,7 +193,7 @@ private void InitializeAddIn()
 
                 if (_initialSettings?.CanShowSplash ?? false)
                 {
-                    splash = new Splash2021(new VersionCheck.VersionCheck(typeof(Splash2021).Assembly.GetName().Version));
+                    splash = new Splash2021(new VersionCheck.VersionCheckService(typeof(Splash2021).Assembly.GetName().Version));
                     splash.Show();
                     splash.Refresh();
                 }
diff --git a/RubberduckTests/VersionCheckTests.cs b/RubberduckTests/VersionCheckTests.cs
@@ -24,7 +24,7 @@ private Configuration CreateConfig(bool includePreReleases)
             return new Configuration(settings);
         }
 
-        private VersionCheckCommand CreateSUT(Configuration config, Version currentVersion, Version latestVersion, out Mock<IMessageBox> mockPrompt, out Mock<IVersionCheck> mockService)
+        private VersionCheckCommand CreateSUT(Configuration config, Version currentVersion, Version latestVersion, out Mock<IMessageBox> mockPrompt, out Mock<IVersionCheckService> mockService)
         {
             mockPrompt = new Mock<IMessageBox>();
             mockPrompt.Setup(m => m.Question(It.IsAny<string>(), It.IsAny<string>()));
@@ -33,7 +33,7 @@ private VersionCheckCommand CreateSUT(Configuration config, Version currentVersi
             var mockConfig = new Mock<IConfigurationService<Configuration>>();
             mockConfig.Setup(m => m.Read()).Returns(() => config);
 
-            mockService = new Mock<IVersionCheck>();
+            mockService = new Mock<IVersionCheckService>();
             
             mockService.Setup(m => m.CurrentVersion)
                        .Returns(() => currentVersion);

Original file line number	Diff line number	Diff line change
`@@ -12,10 +12,10 @@ namespace Rubberduck.UI.About`
`12`	`12`	`{`
`13`	`13`	`public class AboutControlViewModel`
`14`	`14`	`{`
`15`		`- private readonly IVersionCheck _version;`
	`15`	`+ private readonly IVersionCheckService _version;`
`16`	`16`	`private readonly IWebNavigator _web;`
`17`	`17`
`18`		`- public AboutControlViewModel(IVersionCheck version, IWebNavigator web)`
	`18`	`+ public AboutControlViewModel(IVersionCheckService version, IWebNavigator web)`
`19`	`19`	`{`
`20`	`20`	`_version = version;`
`21`	`21`	`_web = web;`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@ namespace Rubberduck.UI.About`
`5`	`5`	`{`
`6`	`6`	`public partial class AboutDialog : Form`
`7`	`7`	`{`
`8`		`- public AboutDialog(IVersionCheck versionCheck, IWebNavigator web) : this()`
	`8`	`+ public AboutDialog(IVersionCheckService versionCheck, IWebNavigator web) : this()`
`9`	`9`	`{`
`10`	`10`	`ViewModel = new AboutControlViewModel(versionCheck, web);`
`11`	`11`	`}`
Original file line number	Diff line number	Diff line change
`@@ -10,13 +10,13 @@ namespace Rubberduck.UI.Command`
`10`	`10`	`[ComVisible(false)]`
`11`	`11`	`public class AboutCommand : CommandBase`
`12`	`12`	`{`
`13`		`- public AboutCommand(IVersionCheck versionService, IWebNavigator web)`
	`13`	`+ public AboutCommand(IVersionCheckService versionService, IWebNavigator web)`
`14`	`14`	`{`
`15`	`15`	`_versionService = versionService;`
`16`	`16`	`_web = web;`
`17`	`17`	`}`
`18`	`18`
`19`		`- private readonly IVersionCheck _versionService;`
	`19`	`+ private readonly IVersionCheckService _versionService;`
`20`	`20`	`private readonly IWebNavigator _web;`
`21`	`21`
`22`	`22`	`protected override void OnExecute(object parameter)`
Original file line number	Diff line number	Diff line change
`@@ -28,12 +28,12 @@ public void Start(string fileName)`
`28`	`28`
`29`	`29`	`public class VersionCheckCommand : CommandBase`
`30`	`30`	`{`
`31`		`- private readonly IVersionCheck _versionCheck;`
	`31`	`+ private readonly IVersionCheckService _versionCheck;`
`32`	`32`	`private readonly IMessageBox _prompt;`
`33`	`33`	`private readonly IExternalProcess _process;`
`34`	`34`	`IConfigurationService<Configuration> _config;`
`35`	`35`
`36`		`- public VersionCheckCommand(IVersionCheck versionCheck, IMessageBox prompt, IExternalProcess process, IConfigurationService<Configuration> config)`
	`36`	`+ public VersionCheckCommand(IVersionCheckService versionCheck, IMessageBox prompt, IExternalProcess process, IConfigurationService<Configuration> config)`
`37`	`37`	`{`
`38`	`38`	`_versionCheck = versionCheck;`
`39`	`39`	`_prompt = prompt;`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ public Splash2021()`
`11`	`11`	`InitializeComponent();`
`12`	`12`	`}`
`13`	`13`
`14`		`- public Splash2021(IVersionCheck versionCheck) : this()`
	`14`	`+ public Splash2021(IVersionCheckService versionCheck) : this()`
`15`	`15`	`{`
`16`	`16`	`VersionLabel.Text = string.Format(Resources.RubberduckUI.Rubberduck_AboutBuild, versionCheck.VersionString);`
`17`	`17`	`VersionLabel.Parent = pictureBox1;`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@`
`5`	`5`
`6`	`6`	`namespace Rubberduck.VersionCheck`
`7`	`7`	`{`
`8`		`- public interface IVersionCheck`
	`8`	`+ public interface IVersionCheckService`
`9`	`9`	`{`
`10`	`10`	`Task<Version> GetLatestVersionAsync(GeneralSettings settings, CancellationToken token = default);`
`11`	`11`	`Version CurrentVersion { get; }`