[581] fix: Fix broken Documentation link in UI (#583)

* [581] fix: Fix broken Documentation link in UI

* fix test

src/Api.Service/Api.Service.csproj

@@ -7,7 +7,7 @@
  </PropertyGroup>
 
  <ItemGroup>
- <PackageReference Include="Philosowaffle.Capability.ReleaseChecks" Version="1.0.0" />
+ <PackageReference Include="Philosowaffle.Capability.ReleaseChecks" Version="1.1.0" />
  </ItemGroup>
 
  <ItemGroup>

src/Api.Service/ApiStartupServices.cs

@@ -55,7 +55,8 @@ public static void ConfigureP2GApiServices(this IServiceCollection services)
  services.AddSingleton<ISyncStatusDb, SyncStatusDb>();
  services.AddSingleton<ISyncService, SyncService>();
 
- // SYSTEM INFO
+ // SYSTEM INFO
+ services.AddSingleton<IVersionInformationService, VersionInformationService>();
  services.AddSingleton<ISystemInfoService, SystemInfoService>();
 
  // USERS

src/Api.Service/SystemInfoService.cs

@@ -1,9 +1,9 @@
 using Api.Contract;
+using Api.Service;
 using Common;
 using Common.Dto;
 using Common.Observe;
 using Common.Service;
-using Core.GitHub;
 using Philosowaffle.Capability.ReleaseChecks.Model;
 
 namespace Api.Services;
@@ -16,12 +16,12 @@ public interface ISystemInfoService
 
 public class SystemInfoService : ISystemInfoService
 {
- private readonly IGitHubReleaseCheckService _gitHubService;
+ private readonly IVersionInformationService _versionInformationService;
  private readonly ISettingsService _settingsService;
 
- public SystemInfoService(IGitHubReleaseCheckService gitHubService, ISettingsService settingsService)
+ public SystemInfoService(ISettingsService settingsService, IVersionInformationService versionInformationService)
  {
- _gitHubService = gitHubService;
+ _versionInformationService = versionInformationService;
  _settingsService = settingsService;
  }
 
@@ -30,7 +30,9 @@ public async Task<SystemInfoGetResponse> GetAsync(SystemInfoGetRequest request,
  LatestReleaseInformation? versionInformation = null;
 
  if (request.CheckForUpdate)
- versionInformation = await _gitHubService.GetLatestReleaseInformationAsync("philosowaffle", "peloton-to-garmin", Constants.AppVersion);
+ versionInformation = await _versionInformationService.GetLatestReleaseInformationAsync();
+
+ var documentationVersion = versionInformation?.IsInstalledVersionReleaseCandidate ?? true ? "master" : $"v{Constants.AppVersion}";
 
  var settings = await _settingsService.GetSettingsAsync();
 
@@ -52,7 +54,7 @@ public async Task<SystemInfoGetResponse> GetAsync(SystemInfoGetRequest request,
  } : null,
 
  GitHub = "https://github.com/philosowaffle/peloton-to-garmin",
- Documentation = "https://philosowaffle.github.io/peloton-to-garmin/",
+ Documentation = $"https://philosowaffle.github.io/peloton-to-garmin/{documentationVersion}",
  Forums = "https://github.com/philosowaffle/peloton-to-garmin/discussions",
  Donate = "https://www.buymeacoffee.com/philosowaffle",
  Issues = "https://github.com/philosowaffle/peloton-to-garmin/issues",

src/Api.Service/VersionInformationService.cs

@@ -0,0 +1,52 @@
+using Common;
+using Common.Observe;
+using Core.GitHub;
+using Microsoft.Extensions.Caching.Memory;
+using Philosowaffle.Capability.ReleaseChecks.Model;
+using Serilog;
+
+namespace Api.Service;
+
+public interface IVersionInformationService
+{
+ Task<LatestReleaseInformation> GetLatestReleaseInformationAsync();
+}
+
+public class VersionInformationService : IVersionInformationService
+{
+ private static readonly ILogger _logger = LogContext.ForClass<VersionInformationService>();
+ private static readonly object _lock = new object();
+
+ private readonly IGitHubReleaseCheckService _gitHubService;
+ private readonly IMemoryCache _cache;
+
+ public VersionInformationService(IGitHubReleaseCheckService gitHubService, IMemoryCache cache)
+ {
+ _gitHubService = gitHubService;
+ _cache = cache;
+ }
+
+ public Task<LatestReleaseInformation> GetLatestReleaseInformationAsync()
+ {
+ using var tracing = Tracing.Trace($"{nameof(VersionInformationService)}.{nameof(GetLatestReleaseInformationAsync)}");
+
+ try
+ {
+ lock (_lock)
+ {
+ var key = $"LatestReleaseInformation";
+ return _cache.GetOrCreateAsync(key, (cacheEntry) =>
+ {
+ cacheEntry.AbsoluteExpirationRelativeToNow = TimeSpan.FromMinutes(5);
+
+ return _gitHubService.GetLatestReleaseInformationAsync("philosowaffle", "peloton-to-garmin", Constants.AppVersion);
+ });
+ }
+ }
+ catch (Exception e)
+ {
+ _logger.Error("Failed to fetch Latest P2G Release information.", e);
+ return Task.FromResult(new LatestReleaseInformation());
+ }
+ }
+}

src/SharedUI/Pages/Settings.razor

@@ -56,8 +56,10 @@
  private async Task LoadDataAsync()
  {
  using var tracing = Tracing.ClientTrace($"{nameof(Settings)}.{nameof(LoadDataAsync)}", kind: ActivityKind.Client);
- var systemInfo = await _apiClient.SystemInfoGetAsync(new SystemInfoGetRequest() { CheckForUpdate = false });
 
- configDocumentation = systemInfo.Documentation + "/configuration/json.html";
+ var settings = await _apiClient.SettingsGetAsync();
+ var systemInfo = await _apiClient.SystemInfoGetAsync(new SystemInfoGetRequest() { CheckForUpdate = settings.App.CheckForUpdates });
+
+ configDocumentation = systemInfo.Documentation + "/configuration/json";
  }
 }

src/UnitTests/Api.Service/SystemInfoServiceTests.cs

@@ -1,4 +1,5 @@
 using Api.Contract;
+using Api.Service;
 using Api.Services;
 using Common;
 using Core.GitHub;
@@ -42,9 +43,9 @@ public async Task GetAsync_WhenRequest_Enriches_LatestVersionInfo()
  // SETUP
  var autoMocker = new AutoMocker();
  var controller = autoMocker.CreateInstance<SystemInfoService>();
- var ghService = autoMocker.GetMock<IGitHubReleaseCheckService>();
+ var ghService = autoMocker.GetMock<IVersionInformationService>();
 
- ghService.Setup(x => x.GetLatestReleaseInformationAsync("philosowaffle", "peloton-to-garmin", Constants.AppVersion))
+ ghService.Setup(x => x.GetLatestReleaseInformationAsync())
  .ReturnsAsync(new LatestReleaseInformation()
  {
  IsReleaseNewerThanInstalledVersion = true,
@@ -64,6 +65,6 @@ public async Task GetAsync_WhenRequest_Enriches_LatestVersionInfo()
  response.NewerVersionAvailable.Should().NotBeNull();
  response.LatestVersionInformation.Should().NotBeNull();
 
- ghService.Verify(x => x.GetLatestReleaseInformationAsync("philosowaffle", "peloton-to-garmin", Constants.AppVersion), Times.Once());
+ ghService.Verify(x => x.GetLatestReleaseInformationAsync(), Times.Once());
  }
 }

vNextReleaseNotes.md

@@ -6,6 +6,10 @@
 - [#564] Set a custom title prefix on Workouts
 - [#559] Ability to exclude Outdoor Cycling workouts from sycning
 
+## Fixes
+
+- [#581] Fix broken Documentation link in UI
+
 ## Docker Tags
 
 - Console