[Feature] Render package README from local storage in the PM UI

Directory.Packages.props

@@ -65,6 +65,7 @@
     <PackageVersion Include="Microsoft.Test.Apex.VisualStudio" Version="17.11.35005.70" />
     <PackageVersion Include="Microsoft.TestPlatform.Portable" Version="17.1.0" />
     <PackageVersion Include="Microsoft.VisualStudio.LanguageServices" Version="4.3.1" />
+    <PackageVersion Include="Microsoft.VisualStudio.Markdown.Platform" Version="17.11.119-preview" />
     <PackageVersion Include="Microsoft.VisualStudio.ProjectSystem" Version="17.4.221-pre" />
     <PackageVersion Include="Microsoft.VisualStudio.ProjectSystem.Managed" Version="17.2.0-beta1-20502-01" />
     <PackageVersion Include="Microsoft.VisualStudio.ProjectSystem.Managed.VS" Version="17.2.0-beta1-20502-01" />

NuGet.Config

@@ -15,14 +15,15 @@
   </auditSources>
   <packageSourceMapping>
     <clear />
-    <packageSource key = "dotnet-public">
+    <packageSource key="dotnet-public">
       <package pattern="Azure.Core " />
       <package pattern="ben.demystifier" />
       <package pattern="castle.core" />
       <package pattern="fluentassertions" />
       <package pattern="Humanizer.Core" />
       <package pattern="ilmerge" />
       <package pattern="lucene.net" />
+      <package pattern="Markdig.Signed" />
       <package pattern="messagepack" />
       <package pattern="messagepack.annotations" />
       <package pattern="messagepackanalyzer" />
@@ -45,14 +46,14 @@
       <package pattern="xunit.*" />
       <package pattern="xunitxml.testlogger" />
     </packageSource>
-    <packageSource key = "dotnet-eng">
+    <packageSource key="dotnet-eng">
       <package pattern="Microsoft.DotNet.*" />
     </packageSource>
-    <packageSource key = "nuget-build">
+    <packageSource key="nuget-build">
       <package pattern="nuget.client.endtoend.testdata" />
       <package pattern="nugetvalidator" />
     </packageSource>
-    <packageSource key = "vside">
+    <packageSource key="vside">
       <package pattern="envdte" />
       <package pattern="envdte100" />
       <package pattern="envdte80" />
@@ -65,7 +66,7 @@
       <package pattern="Microsoft.ServiceHub.Framework" />
       <package pattern="Microsoft.TeamFoundationServer.ExtendedClient" />
       <package pattern="microsoft.test.apex.visualstudio" />
-      <package pattern="microsoft.visualstudio.*" />
+      <package pattern="Microsoft.VisualStudio.*" />
       <package pattern="Microsoft.VisualStudioEng.MicroBuild.Core" />
       <package pattern="Microsoft.VSSDK.BuildTools" />
       <package pattern="stdole" />
@@ -83,13 +84,13 @@
       <package pattern="vslangproj90" />
       <package pattern="vswebsite.interop" />
     </packageSource>
-    <packageSource key = "myget-legacy@Local">
+    <packageSource key="myget-legacy@Local">
       <package pattern="Microsoft.Extensions.CommandLineUtils.Sources" />
     </packageSource>
-    <packageSource key = "VS">
+    <packageSource key="VS">
       <package pattern="Microsoft.DevDiv.Validation.TestPlatform.Settings.Tasks" />
     </packageSource>
-    <packageSource key = "dotnet-libraries">
+    <packageSource key="dotnet-libraries">
       <package pattern="System.CommandLine" />
     </packageSource>
   </packageSourceMapping>

src/NuGet.Clients/NuGet.PackageManagement.UI/GlobalSuppressions.cs

@@ -87,7 +87,7 @@
 [assembly: SuppressMessage("Build", "CA1501:'PackageManagerControl' has an object hierarchy '9' levels deep within the defining module. If possible, eliminate base classes within the hierarchy to decrease its hierarchy level below '6': 'UserControl, ContentControl, Control, FrameworkElement, UIElement, Visual, DependencyObject, DispatcherObject, Object'", Justification = "<Pending>", Scope = "type", Target = "~T:NuGet.PackageManagement.UI.PackageManagerControl")]
 [assembly: SuppressMessage("Build", "CA1501:'PackageItemDeprecationLabel' has an object hierarchy '9' levels deep within the defining module. If possible, eliminate base classes within the hierarchy to decrease its hierarchy level below '6': 'UserControl, ContentControl, Control, FrameworkElement, UIElement, Visual, DependencyObject, DispatcherObject, Object'", Justification = "Default WPF Hierarchy", Scope = "type", Target = "~T:NuGet.PackageManagement.UI.PackageItemDeprecationLabel")]
 [assembly: SuppressMessage("Build", "CA1501:'PackageManagerTopPanel' has an object hierarchy '9' levels deep within the defining module. If possible, eliminate base classes within the hierarchy to decrease its hierarchy level below '6': 'UserControl, ContentControl, Control, FrameworkElement, UIElement, Visual, DependencyObject, DispatcherObject, Object'", Justification = "<Pending>", Scope = "type", Target = "~T:NuGet.PackageManagement.UI.PackageManagerTopPanel")]
-[assembly: SuppressMessage("Build", "CA1501:'PackageMetadataControl' has an object hierarchy '9' levels deep within the defining module. If possible, eliminate base classes within the hierarchy to decrease its hierarchy level below '6': 'UserControl, ContentControl, Control, FrameworkElement, UIElement, Visual, DependencyObject, DispatcherObject, Object'", Justification = "<Pending>", Scope = "type", Target = "~T:NuGet.PackageManagement.UI.PackageMetadataControl")]
+[assembly: SuppressMessage("Build", "CA1501:'PackageMetadataControl' has an object hierarchy '9' levels deep within the defining module. If possible, eliminate base classes within the hierarchy to decrease its hierarchy level below '6': 'UserControl, ContentControl, Control, FrameworkElement, UIElement, Visual, DependencyObject, DispatcherObject, Object'", Justification = "<Pending>", Scope = "type", Target = "~T:NuGet.PackageManagement.UI.PackageDetailsTabControl")]
 [assembly: SuppressMessage("Build", "CA1501:'PackageRestoreBar' has an object hierarchy '9' levels deep within the defining module. If possible, eliminate base classes within the hierarchy to decrease its hierarchy level below '6': 'UserControl, ContentControl, Control, FrameworkElement, UIElement, Visual, DependencyObject, DispatcherObject, Object'", Justification = "<Pending>", Scope = "type", Target = "~T:NuGet.PackageManagement.UI.PackageRestoreBar")]
 [assembly: SuppressMessage("Build", "CA1501:'PreviewWindow' has an object hierarchy '11' levels deep within the defining module. If possible, eliminate base classes within the hierarchy to decrease its hierarchy level below '6': 'DialogWindow, DialogWindowBase, Window, ContentControl, Control, FrameworkElement, UIElement, Visual, DependencyObject, DispatcherObject, Object'", Justification = "<Pending>", Scope = "type", Target = "~T:NuGet.PackageManagement.UI.PreviewWindow")]
 [assembly: SuppressMessage("Build", "CA1501:'PRMigratorBar' has an object hierarchy '9' levels deep within the defining module. If possible, eliminate base classes within the hierarchy to decrease its hierarchy level below '6': 'UserControl, ContentControl, Control, FrameworkElement, UIElement, Visual, DependencyObject, DispatcherObject, Object'", Justification = "<Pending>", Scope = "type", Target = "~T:NuGet.PackageManagement.UI.PRMigratorBar")]

src/NuGet.Clients/NuGet.PackageManagement.UI/Models/DetailControlModel.cs

@@ -24,7 +24,7 @@ namespace NuGet.PackageManagement.UI
     /// The base class of PackageDetailControlModel and PackageSolutionDetailControlModel.
     /// When user selects an action, this triggers version list update.
     /// </summary>
-    public abstract class DetailControlModel : INotifyPropertyChanged, IDisposable
+    public abstract class DetailControlModel : TitledPageViewModelBase, IDisposable
     {
         private static readonly string StarAll = VersionRangeFormatter.Instance.Format("p", VersionRange.Parse("*"), VersionRangeFormatter.Instance);
         private static readonly string StarAllFloating = VersionRangeFormatter.Instance.Format("p", VersionRange.Parse("*-*"), VersionRangeFormatter.Instance);
@@ -70,6 +70,9 @@ protected DetailControlModel(
             _options.SelectedChanged += DependencyBehavior_SelectedChanged;
 
             _versions = new ItemsChangeObservableCollection<DisplayVersion>();
+
+            Title = Resources.Label_PackageDetails;
+            IsVisible = true;
         }
 
         /// <summary>
@@ -385,11 +388,9 @@ private async Task<IReadOnlyList<PackageDependency>> GetDependencies(IProjectCon
         // Called after package install/uninstall.
         public abstract Task RefreshAsync(CancellationToken cancellationToken);
 
-        public event PropertyChangedEventHandler PropertyChanged;
-
         protected void OnPropertyChanged(string propertyName)
         {
-            PropertyChanged?.Invoke(this, new PropertyChangedEventArgs(propertyName));
+            RaisePropertyChanged(propertyName);
         }
 
         public string Id => _searchResultPackage?.Id;

src/NuGet.Clients/NuGet.PackageManagement.UI/Models/DetailedPackageMetadata.cs

@@ -33,6 +33,7 @@ public DetailedPackageMetadata(PackageSearchMetadataContextInfo serverData, Pack
             IconUrl = serverData.IconUrl;
             LicenseUrl = serverData.LicenseUrl;
             ProjectUrl = serverData.ProjectUrl;
+            ReadmeFileUrl = serverData.ReadmeFileUrl;
             ReadmeUrl = serverData.ReadmeUrl;
             ReportAbuseUrl = serverData.ReportAbuseUrl;
             // Some server implementations send down an array with an empty string, which ends up as an empty string.
@@ -95,6 +96,8 @@ public DetailedPackageMetadata(PackageSearchMetadataContextInfo serverData, Pack
 
         public Uri? ProjectUrl { get; set; }
 
+        public string? ReadmeFileUrl { get; set; }
+
         public Uri? ReadmeUrl { get; set; }
 
         public Uri? ReportAbuseUrl { get; set; }

src/NuGet.Clients/NuGet.PackageManagement.UI/Models/PackageMetadataTab.cs

@@ -0,0 +1,11 @@
+// Copyright (c) .NET Foundation. All rights reserved.
+// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
+
+namespace NuGet.PackageManagement.UI
+{
+    public enum PackageMetadataTab
+    {
+        Readme,
+        PackageDetails,
+    }
+}

src/NuGet.Clients/NuGet.PackageManagement.UI/NuGet.PackageManagement.UI.csproj

@@ -41,6 +41,9 @@
   </ItemGroup>
 
   <ItemGroup>
+    <PackageReference Include="Microsoft.Build.Framework" />
+    <PackageReference Include="Microsoft.NET.StringTools" />
+    <PackageReference Include="Microsoft.VisualStudio.Markdown.Platform" />
     <PackageReference Include="Microsoft.VisualStudio.Sdk" />
   </ItemGroup>
 

src/NuGet.Clients/NuGet.PackageManagement.UI/Resources.resx

@@ -1076,4 +1076,23 @@ Please see https://aka.ms/troubleshoot_nuget_cache for more help.</value>
   <data name="ColumnHeader_PackageLevel" xml:space="preserve">
     <value>Package Level</value>
   </data>
+  <data name="Label_PackageDetails" xml:space="preserve">
+    <value>Package Details</value>
+  </data>
+  <data name="Error_UnableToLoadReadme" xml:space="preserve">
+    <value>An error occurred while trying to load the README.</value>
+  </data>
+  <data name="Label_Readme_Tab" xml:space="preserve">
+    <value>README</value>
+  </data>
+  <data name="Text_NoReadme" xml:space="preserve">
+    <value>Could not read package README from selected package.
+
+Only the package maintainer can add a README.
+
+If you are not the maintainer, please consider filing an issue or contacting the maintainer to request a README.
+
+For instructions on how to add a README, please visit [aka.ms/nuget/readme](https://aka.ms/nuget/readme)</value>
+    <comment>{Locked="[aka.ms/nuget/readme](https://aka.ms/nuget/readme)"} "[aka.ms/nuget/readme](https://aka.ms/nuget/readme)" this is a URL link and should not be translated</comment>
+  </data>
 </root>

src/NuGet.Clients/NuGet.PackageManagement.UI/UserSettings.cs

@@ -23,6 +23,7 @@ public UserSettings()
             SelectedFilter = ItemFilter.Installed;
             DependencyBehavior = DependencyBehavior.Lowest;
             FileConflictAction = FileConflictAction.PromptUser;
+            SelectedPackageMetadataTab = PackageMetadataTab.Readme;
             OptionsExpanded = false;
         }
 
@@ -40,6 +41,8 @@ public UserSettings()
 
         public ItemFilter SelectedFilter { get; set; }
 
+        public PackageMetadataTab SelectedPackageMetadataTab { get; set; }
+
         public DependencyBehavior DependencyBehavior { get; set; }
 
         public FileConflictAction FileConflictAction { get; set; }

src/NuGet.Clients/NuGet.PackageManagement.UI/ViewModels/PackageDetailsTabViewModel.cs

@@ -0,0 +1,115 @@
+using System;
+using System.Collections.ObjectModel;
+using System.ComponentModel;
+using System.Linq;
+using System.Threading;
+using System.Threading.Tasks;
+using Microsoft.VisualStudio.Shell;
+using NuGet.VisualStudio;
+using NuGet.VisualStudio.Internal.Contracts;
+
+namespace NuGet.PackageManagement.UI.ViewModels
+{
+    public class PackageDetailsTabViewModel : ViewModelBase, IDisposable
+    {
+        private bool _disposed = false;
+        private bool _readmeTabEnabled;
+
+        public ReadmePreviewViewModel ReadmePreviewViewModel { get; private set; }
+
+        public DetailControlModel DetailControlModel { get; private set; }
+
+        public ObservableCollection<TitledPageViewModelBase> Tabs { get; private set; }
+
+        private TitledPageViewModelBase _selectedTab;
+        public TitledPageViewModelBase SelectedTab
+        {
+            get => _selectedTab;
+            set
+            {
+                SetAndRaisePropertyChanged(ref _selectedTab, value);
+            }
+        }
+
+        public PackageDetailsTabViewModel()
+        {
+            _readmeTabEnabled = true;
+            Tabs = new ObservableCollection<TitledPageViewModelBase>();
+        }
+
+        public async Task InitializeAsync(DetailControlModel detailControlModel, INuGetPackageFileService nugetPackageFileService, ItemFilter currentFilter, PackageMetadataTab initialSelectedTab)
+        {
+            var nuGetFeatureFlagService = await ServiceLocator.GetComponentModelServiceAsync<INuGetFeatureFlagService>();
+            _readmeTabEnabled = await nuGetFeatureFlagService.IsFeatureEnabledAsync(NuGetFeatureFlagConstants.RenderReadmeInPMUI);
+
+            ReadmePreviewViewModel = new ReadmePreviewViewModel(nugetPackageFileService, currentFilter, _readmeTabEnabled);
+            DetailControlModel = detailControlModel;
+
+            Tabs.Add(ReadmePreviewViewModel);
+            Tabs.Add(DetailControlModel);
+
+            SelectedTab = Tabs.FirstOrDefault(t => t.IsVisible && ConvertFromTabType(t) == initialSelectedTab) ?? Tabs.FirstOrDefault(t => t.IsVisible);
+
+            DetailControlModel.PropertyChanged += DetailControlModel_PropertyChanged;
+
+            foreach (var tab in Tabs)
+            {
+                tab.PropertyChanged += IsVisible_PropertyChanged;
+            }
+        }
+
+        public static PackageMetadataTab ConvertFromTabType(TitledPageViewModelBase vm)
+        {
+            if (vm is DetailControlModel)
+            {
+                return PackageMetadataTab.PackageDetails;
+            }
+            return PackageMetadataTab.Readme;
+        }
+
+        public async Task SetCurrentFilterAsync(ItemFilter filter)
+        {
+            if (_readmeTabEnabled)
+            {
+                await ReadmePreviewViewModel.SetCurrentFilterAsync(filter);
+            }
+        }
+
+        public void Dispose()
+        {
+            if (_disposed)
+            {
+                return;
+            }
+            _disposed = true;
+            DetailControlModel.PropertyChanged -= DetailControlModel_PropertyChanged;
+
+            foreach (var tab in Tabs)
+            {
+                tab.PropertyChanged -= IsVisible_PropertyChanged;
+            }
+        }
+
+        private void IsVisible_PropertyChanged(object sender, PropertyChangedEventArgs e)
+        {
+            if (e.PropertyName == nameof(TitledPageViewModelBase.IsVisible))
+            {
+                if (SelectedTab == null || (SelectedTab == sender && !SelectedTab.IsVisible))
+                {
+                    SelectedTab = Tabs.FirstOrDefault(t => t.IsVisible);
+                }
+            }
+        }
+
+        private void DetailControlModel_PropertyChanged(object sender, PropertyChangedEventArgs e)
+        {
+            ThreadHelper.JoinableTaskFactory.Run(async () =>
+            {
+                if (_readmeTabEnabled)
+                {
+                    await ReadmePreviewViewModel.SetPackageMetadataAsync(DetailControlModel.PackageMetadata, CancellationToken.None);
+                }
+            });
+        }
+    }
+}