[OOBE]Add What's New page - SCOOBE (#16478)

* [Oobe]Add a What's New page * Show What's New when version changes * Add link to GitHub * Use generic icon for now * Get only the latest 5 releases * fix spellchecker * rename last_version_run.json * Remove UserControl_Loaded * Remove installer hash from the release notes * constexpr some strings * Add check your internet connection message
2026-04-11 05:52:19 +02:00 · 2022-02-22 11:02:08 +00:00
parent e9dccf82ab
commit 87bb89ab15
18 changed files with 322 additions and 25 deletions
--- a/src/settings-ui/Settings.UI/OOBE/Views/OobeWhatsNew.xaml.cs
+++ b/src/settings-ui/Settings.UI/OOBE/Views/OobeWhatsNew.xaml.cs
@@ -0,0 +1,118 @@
+// Copyright (c) Microsoft Corporation
+// The Microsoft Corporation licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for more information.
+
+using System;
+using System.Collections.Generic;
+using System.Diagnostics;
+using System.Linq;
+using System.Net.Http;
+using System.Text;
+using System.Text.Json;
+using System.Text.Json.Serialization;
+using System.Text.RegularExpressions;
+using System.Threading.Tasks;
+using Microsoft.PowerToys.Settings.UI.Library.Utilities;
+using Microsoft.PowerToys.Settings.UI.OOBE.Enums;
+using Microsoft.PowerToys.Settings.UI.OOBE.ViewModel;
+using Microsoft.PowerToys.Settings.UI.Views;
+using Windows.ApplicationModel.Resources;
+using Windows.UI.Xaml.Controls;
+using Windows.UI.Xaml.Navigation;
+
+namespace Microsoft.PowerToys.Settings.UI.OOBE.Views
+{
+    public sealed partial class OobeWhatsNew : Page
+    {
+        // Contains information for a release. Used to deserialize release JSON info from GitHub.
+        private class PowerToysReleaseInfo
+        {
+            [JsonPropertyName("published_at")]
+            public DateTimeOffset PublishedDate { get; set; }
+
+            [JsonPropertyName("name")]
+            public string Name { get; set; }
+
+            [JsonPropertyName("tag_name")]
+            public string TagName { get; set; }
+
+            [JsonPropertyName("body")]
+            public string ReleaseNotes { get; set; }
+        }
+
+        public OobePowerToysModule ViewModel { get; set; }
+
+        public OobeWhatsNew()
+        {
+            this.InitializeComponent();
+            ViewModel = new OobePowerToysModule(OobeShellPage.OobeShellHandler.Modules[(int)PowerToysModulesEnum.WhatsNew]);
+            DataContext = ViewModel;
+        }
+
+        private async Task<string> GetReleaseNotesMarkdown()
+        {
+            string releaseNotesJSON = string.Empty;
+            using (HttpClient getReleaseInfoClient = new HttpClient())
+            {
+                // GitHub APIs require sending an user agent
+                // https://docs.github.com/en/rest/overview/resources-in-the-rest-api#user-agent-required
+                getReleaseInfoClient.DefaultRequestHeaders.TryAddWithoutValidation("User-Agent", "PowerToys");
+                releaseNotesJSON = await getReleaseInfoClient.GetStringAsync("https://api.github.com/repos/microsoft/PowerToys/releases");
+            }
+
+            IList<PowerToysReleaseInfo> releases = JsonSerializer.Deserialize<IList<PowerToysReleaseInfo>>(releaseNotesJSON);
+
+            // Get the latest releases
+            var latestReleases = releases.OrderByDescending(release => release.PublishedDate).Take(5);
+
+            StringBuilder releaseNotesHtmlBuilder = new StringBuilder(string.Empty);
+
+            // Regex to remove installer hash sections from the release notes.
+            Regex removeHashRegex = new Regex(@"(\r\n)+#+ installer( SHA256)? hash(\r\n)+[0-9A-F]{64}", RegexOptions.Compiled | RegexOptions.Multiline | RegexOptions.IgnoreCase | RegexOptions.CultureInvariant);
+
+            foreach (var release in latestReleases)
+            {
+                releaseNotesHtmlBuilder.AppendLine("# " + release.Name);
+                releaseNotesHtmlBuilder.AppendLine(removeHashRegex.Replace(release.ReleaseNotes, string.Empty));
+            }
+
+            return releaseNotesHtmlBuilder.ToString();
+        }
+
+        private async void Page_Loaded(object sender, Windows.UI.Xaml.RoutedEventArgs e)
+        {
+            ResourceLoader loader = ResourceLoader.GetForViewIndependentUse();
+            TitleTxt.Text = loader.GetString("Oobe_WhatsNew");
+            try
+            {
+                ReleaseNotesMarkdown.Text = await GetReleaseNotesMarkdown();
+                ReleaseNotesMarkdown.Visibility = Windows.UI.Xaml.Visibility.Visible;
+                LoadingProgressRing.Visibility = Windows.UI.Xaml.Visibility.Collapsed;
+            }
+            catch (Exception ex)
+            {
+                Logger.LogError("Exception when loading the release notes", ex);
+                LoadingProgressRing.Visibility = Windows.UI.Xaml.Visibility.Collapsed;
+                ErrorInfoBar.Visibility = Windows.UI.Xaml.Visibility.Visible;
+            }
+        }
+
+        protected override void OnNavigatedTo(NavigationEventArgs e)
+        {
+            ViewModel.LogOpeningModuleEvent();
+        }
+
+        protected override void OnNavigatedFrom(NavigationEventArgs e)
+        {
+            ViewModel.LogClosingModuleEvent();
+        }
+
+        private void ReleaseNotesMarkdown_LinkClicked(object sender, Toolkit.Uwp.UI.Controls.LinkClickedEventArgs e)
+        {
+            if (Uri.TryCreate(e.Link, UriKind.Absolute, out Uri link))
+            {
+                Process.Start(new ProcessStartInfo(link.ToString()) { UseShellExecute = true });
+            }
+        }
+    }
+}