Preview readme when uploading packages(#8160) (#8160)

lyndaidaii · web-flow · commit 48058f70cbcc · 2020-08-19T15:40:51.000-07:00
diff --git a/src/Bootstrap/dist/css/bootstrap-theme.css b/src/Bootstrap/dist/css/bootstrap-theme.css
diff --git a/src/Bootstrap/less/theme/all.less b/src/Bootstrap/less/theme/all.less
@@ -5,6 +5,7 @@
 @import "common-licenses.less";
 @import "common-list-packages.less";
 @import "common-multi-select-dropdown.less";
+@import "common-readme.less";
 @import "common-user-package-list.less";
 @import "page-about.less";
 @import "page-account-settings.less";
diff --git a/src/Bootstrap/less/theme/common-readme.less b/src/Bootstrap/less/theme/common-readme.less
@@ -0,0 +1,12 @@
+.readme {
+    .readme-container{
+        display: block;
+        padding: 10.5px;
+        background-color: @pre-bg;
+        border: 1px solid #ccc;
+        word-break: normal;
+        margin-bottom: @default-margin-bottom;
+        overflow: auto;
+        max-height: 450px;
+    }
+}
diff --git a/src/NuGetGallery.Services/PackageManagement/PackageService.cs b/src/NuGetGallery.Services/PackageManagement/PackageService.cs
@@ -692,6 +692,7 @@ public virtual Package EnrichPackageFromNuGetPackage(
             package.EmbeddedLicenseType = GetEmbeddedLicenseType(packageMetadata);
             package.LicenseExpression = GetLicenseExpression(packageMetadata);
             package.HasEmbeddedIcon = !string.IsNullOrWhiteSpace(packageMetadata.IconFile);
+            package.HasReadMe = !string.IsNullOrWhiteSpace(packageMetadata.ReadmeFile);
             package.EmbeddedReadmeType = GetEmbeddedReadmeType(packageMetadata);
 
             return package;
@@ -750,7 +751,7 @@ private static EmbeddedReadmeFileType GetEmbeddedReadmeType(PackageMetadata pack
 
             var extension = Path.GetExtension(packageMetadata.ReadmeFile);
 
-            if (MarkdownFileExtension.Equals(extension, StringComparison.OrdinalIgnoreCase) || string.Empty == extension)
+            if (MarkdownFileExtension.Equals(extension, StringComparison.OrdinalIgnoreCase))
             {
                 return EmbeddedReadmeFileType.Markdown;
             }
diff --git a/src/NuGetGallery/Controllers/PackagesController.cs b/src/NuGetGallery/Controllers/PackagesController.cs
@@ -17,6 +17,7 @@
 using System.Web;
 using System.Web.Caching;
 using System.Web.Mvc;
+using System.Windows.Forms;
 using NuGet.Packaging;
 using NuGet.Services.Entities;
 using NuGet.Services.Licenses;
@@ -343,6 +344,8 @@ private async Task<ActionResult> UploadPackageInternal(SubmitPackageRequest mode
             verifyRequest.IsSymbolsPackage = false;
             verifyRequest.LicenseFileContents = await GetLicenseFileContentsOrNullAsync(packageMetadata, packageArchiveReader);
             verifyRequest.LicenseExpressionSegments = GetLicenseExpressionSegmentsOrNull(packageMetadata.LicenseMetadata);
+            verifyRequest.ReadmeFileContents = await GetReadmeFileContentsOrNullAsync(packageMetadata, packageArchiveReader);
+
             model.InProgressUpload = verifyRequest;
             return View(model);
         }
@@ -613,6 +616,7 @@ private async Task<JsonResult> GetVerifyPackageView(User currentUser,
             model.Warnings.AddRange(packageContentData.Warnings.Select(w => new JsonValidationMessage(w)));
             model.LicenseFileContents = packageContentData.LicenseFileContents;
             model.LicenseExpressionSegments = packageContentData.LicenseExpressionSegments;
+            model.ReadmeFileContents = packageContentData.ReadmeFileContents;
 
             if (packageContentData.EmbeddedIconInformation != null)
             {
@@ -635,13 +639,15 @@ public PackageContentData(
                 IReadOnlyList<IValidationMessage> warnings,
                 string licenseFileContents,
                 IReadOnlyCollection<CompositeLicenseExpressionSegmentViewModel> licenseExpressionSegments,
-                EmbeddedIconInformation embeddedIconInformation)
+                EmbeddedIconInformation embeddedIconInformation,
+                string readmeFileContents)
             {
                 PackageMetadata = packageMetadata;
                 Warnings = warnings;
                 LicenseFileContents = licenseFileContents;
                 LicenseExpressionSegments = licenseExpressionSegments;
                 EmbeddedIconInformation = embeddedIconInformation;
+                ReadmeFileContents = readmeFileContents;
             }
 
             public JsonResult ErrorResult { get; }
@@ -650,6 +656,7 @@ public PackageContentData(
             public string LicenseFileContents { get; }
             public IReadOnlyCollection<CompositeLicenseExpressionSegmentViewModel> LicenseExpressionSegments { get; }
             public EmbeddedIconInformation EmbeddedIconInformation { get; }
+            public string ReadmeFileContents { get; }
         }
 
         private class EmbeddedIconInformation
@@ -673,6 +680,7 @@ private async Task<PackageContentData> ValidateAndProcessPackageContents(User cu
             IReadOnlyCollection<CompositeLicenseExpressionSegmentViewModel> licenseExpressionSegments = null;
             PackageMetadata packageMetadata = null;
             EmbeddedIconInformation embeddedIconInformation = null;
+            string readmeFileContents = null;
 
             using (Stream uploadedFile = await _uploadFileService.GetUploadFileAsync(currentUser.Key))
             {
@@ -720,6 +728,7 @@ private async Task<PackageContentData> ValidateAndProcessPackageContents(User cu
                     licenseFileContents = await GetLicenseFileContentsOrNullAsync(packageMetadata, packageArchiveReader);
                     licenseExpressionSegments = GetLicenseExpressionSegmentsOrNull(packageMetadata.LicenseMetadata);
                     embeddedIconInformation = await GetEmbeddedIconOrNullAsync(packageMetadata, packageArchiveReader);
+                    readmeFileContents = await GetReadmeFileContentsOrNullAsync(packageMetadata, packageArchiveReader);          
                 }
                 catch (Exception ex)
                 {
@@ -730,7 +739,7 @@ private async Task<PackageContentData> ValidateAndProcessPackageContents(User cu
                 }
             }
 
-            return new PackageContentData(packageMetadata, warnings, licenseFileContents, licenseExpressionSegments, embeddedIconInformation);
+            return new PackageContentData(packageMetadata, warnings, licenseFileContents, licenseExpressionSegments, embeddedIconInformation, readmeFileContents);
         }
 
         private IReadOnlyCollection<CompositeLicenseExpressionSegmentViewModel> GetLicenseExpressionSegmentsOrNull(LicenseMetadata licenseMetadata)
@@ -788,6 +797,18 @@ private static async Task<EmbeddedIconInformation> GetEmbeddedIconOrNullAsync(Pa
             return new EmbeddedIconInformation(imageContentType, imageData);
         }
 
+        private async Task<string> GetReadmeFileContentsOrNullAsync(PackageMetadata packageMetadata, PackageArchiveReader packageArchiveReader)
+        {
+            if (string.IsNullOrWhiteSpace(packageMetadata.ReadmeFile))
+            {
+                return null;
+            }
+
+            var readmeFilename = FileNameHelper.GetZipEntryPath(packageMetadata.ReadmeFile);
+            var readmeResult = await _readMeService.GetReadMeHtmlAsync(readmeFilename, packageArchiveReader, Encoding.UTF8);
+            return readmeResult?.Content;
+        }
+
         private static async Task<byte[]> ReadPackageFile(PackageArchiveReader packageArchiveReader, string filename)
         {
             using (var packageFileStream = packageArchiveReader.GetStream(filename))
@@ -2600,9 +2621,14 @@ protected virtual async Task<JsonResult> VerifyPackageInternal(
                 {
                     return afterValidationJsonResult;
                 }
-
+                
                 if (formData.Edit != null)
                 {
+                    if (package.HasReadMe && package.EmbeddedReadmeType != EmbeddedReadmeFileType.Absent)
+                    {
+                        return Json(HttpStatusCode.BadRequest, new[] { new JsonValidationMessage(Strings.ReadmeNotEditableWithEmbeddedReadme) });
+                    }
+
                     try
                     {
                         if (await _readMeService.SaveReadMeMdIfChanged(
diff --git a/src/NuGetGallery/RequestModels/VerifyPackageRequest.cs b/src/NuGetGallery/RequestModels/VerifyPackageRequest.cs
@@ -110,6 +110,7 @@ public VerifyPackageRequest(PackageMetadata packageMetadata, IEnumerable<User> p
         public string RepositoryUrl { get; set; }
         public string RepositoryType { get; set; }
         public string ReleaseNotes { get; set; }
+        public string ReadmeFileContents { get; set; }
         public bool RequiresLicenseAcceptance { get; set; }
         public string Summary { get; set; }
         public string Tags { get; set; }
diff --git a/src/NuGetGallery/Scripts/gallery/async-file-upload.js b/src/NuGetGallery/Scripts/gallery/async-file-upload.js
@@ -255,6 +255,11 @@
                 $(reportContainerElement).attr("data-bind", "template: { name: 'verify-metadata-template', data: data }");
                 $("#verify-package-container").append(reportContainerElement);
                 ko.applyBindings({ data: model }, reportContainerElement);
+                if (model.ReadmeFileContents) {
+                    $('#import-readme-container').addClass('hidden');
+                } else {
+                    $('#import-readme-container').removeClass('hidden');
+                }
 
                 var submitContainerElement = document.createElement("div");
                 $(submitContainerElement).attr("id", "submit-block");
diff --git a/src/NuGetGallery/Services/IReadMeService.cs b/src/NuGetGallery/Services/IReadMeService.cs
@@ -3,6 +3,7 @@
 
 using System.Text;
 using System.Threading.Tasks;
+using NuGet.Packaging;
 using NuGet.Services.Entities;
 
 namespace NuGetGallery
@@ -30,6 +31,16 @@ public interface IReadMeService
         /// <returns>ReadMe converted to HTML.</returns>
         Task<RenderedReadMeResult> GetReadMeHtmlAsync(Package package);
 
+        /// <summary>
+        /// Get the converted HTML from the package with Readme markdown.
+        /// </summary>
+        /// <param name="readmeFileName">The path of Readme markdown.</param>
+        /// <param name="packageArchiveReader">
+        /// The <see cref="PackageArchiveReader"/> instance providing the package metadata.
+        /// </param>
+        /// <returns>ReadMe converted to HTML.</returns>
+        Task<RenderedReadMeResult> GetReadMeHtmlAsync(string readmeFileName, PackageArchiveReader packageArchiveReader, Encoding encoding);
+
         /// <summary>
         /// Get package ReadMe markdown from storage.
         /// </summary>
diff --git a/src/NuGetGallery/Services/ReadMeService.cs b/src/NuGetGallery/Services/ReadMeService.cs
@@ -11,6 +11,7 @@
 using System.Web;
 using CommonMark;
 using CommonMark.Syntax;
+using NuGet.Packaging;
 using NuGet.Services.Entities;
 
 namespace NuGetGallery
@@ -98,6 +99,28 @@ public async Task<RenderedReadMeResult> GetReadMeHtmlAsync(Package package)
                 GetReadMeHtml(readMeMd);
         }
 
+        /// <summary>
+        /// Get the converted HTML from the package with Readme markdown.
+        /// </summary>
+        /// <param name="readmeFileName">The path of Readme markdown.</param>
+        /// <param name="packageArchiveReader">
+        /// The <see cref="PackageArchiveReader"/> instance providing the package metadata.
+        /// </param>
+        /// <returns>ReadMe converted to HTML.</returns>
+        public async Task<RenderedReadMeResult> GetReadMeHtmlAsync(string readmeFileName, PackageArchiveReader packageArchiveReader, Encoding encoding)
+        {
+            var readmeMd = await GetReadMeMdAsync(readmeFileName, packageArchiveReader, encoding);
+            var result = new RenderedReadMeResult
+            {
+                Content = readmeMd,
+                ImagesRewritten = false
+            };
+
+            return string.IsNullOrEmpty(readmeMd) ?
+                result :
+                GetReadMeHtml(readmeMd);
+        }
+
         /// <summary>
         /// Get package ReadMe markdown from storage.
         /// </summary>
@@ -113,6 +136,23 @@ public async Task<string> GetReadMeMdAsync(Package package)
             return null;
         }
 
+        /// <summary>
+        /// Get content of Readme markdown.
+        /// </summary>
+        /// <param name="readmeFileName">Package entity associated with the ReadMe.</param>
+        /// <param name="packageArchiveReader">
+        /// The <see cref="PackageArchiveReader"/> instance providing the package metadata.
+        /// </param>
+        /// <returns>ReadMe markdown from package metadata.</returns>
+        private async Task<string> GetReadMeMdAsync(string readmeFileName, PackageArchiveReader packageArchiveReader, Encoding encoding)
+        {
+            using (var readmeFileStream = packageArchiveReader.GetStream(readmeFileName))
+            using (var streamReader = new StreamReader(readmeFileStream, encoding))
+            {
+                 return await streamReader.ReadToEndAsync();
+            }
+        }
+
         /// <summary>
         /// Save a pending ReadMe if changes are detected.
         /// </summary>
diff --git a/src/NuGetGallery/Strings.Designer.cs b/src/NuGetGallery/Strings.Designer.cs
diff --git a/src/NuGetGallery/Strings.resx b/src/NuGetGallery/Strings.resx
@@ -1181,4 +1181,7 @@ The {1} Team</value>
   <data name="ODataParametersDisabled" xml:space="preserve">
     <value>The combination of parameters provided to this OData endpoint is not supported.</value>
   </data>
+  <data name="ReadmeNotEditableWithEmbeddedReadme" xml:space="preserve">
+    <value>The readme is not editable with the package has the embedded readme</value>
+  </data>
 </root>
diff --git a/src/NuGetGallery/Views/Packages/_VerifyMetadata.cshtml b/src/NuGetGallery/Views/Packages/_VerifyMetadata.cshtml
@@ -251,6 +251,12 @@
                 </div>
             </div>
             <!-- /ko -->
+            <!-- ko if: $data.ReadmeFileContents -->
+            <div class="verify-package-field readme">
+                <label class="verify-package-field-heading">Readme File</label>
+                <div class="readme-container" data-bind="html: $data.ReadmeFileContents"></div>
+            </div>
+            <!-- /ko -->
             <!-- /ko -->
         </div>
     </div>
diff --git a/tests/NuGetGallery.Facts/Services/PackageServiceFacts.cs b/tests/NuGetGallery.Facts/Services/PackageServiceFacts.cs
@@ -297,7 +297,8 @@ public async Task WillReadThePropertiesFromTheNuGetPackageWhenCreatingANewPackag
                     licenseUrl: new Uri("http://thelicenseurl/"),
                     projectUrl: new Uri("http://theprojecturl/"),
                     iconUrl: new Uri("http://theiconurl/"),
-                    licenseFilename: "license.txt");
+                    licenseFilename: "license.txt",
+                    readmeFilename:"readme.md");
                 var currentUser = new User();
 
                 var package = await service.CreatePackageAsync(nugetPackage.Object, new PackageStreamMetadata(), currentUser, currentUser, isVerified: false);
@@ -321,6 +322,7 @@ public async Task WillReadThePropertiesFromTheNuGetPackageWhenCreatingANewPackag
                 Assert.Equal("theTitle", package.Title);
                 Assert.Equal("theCopyright", package.Copyright);
                 Assert.Equal(EmbeddedLicenseFileType.PlainText, package.EmbeddedLicenseType);
+                Assert.Equal(EmbeddedReadmeFileType.Markdown, package.EmbeddedReadmeType);
                 Assert.Null(package.Language);
                 Assert.False(package.IsPrerelease);
 
@@ -3176,6 +3178,51 @@ public void SetsEmbeddedIconFlagProperly(string iconFilename, bool expectedFlag)
 
                 Assert.Equal(expectedFlag, package.HasEmbeddedIcon);
             }
+
+            [Theory]
+            [InlineData("readme.md", true)]
+            [InlineData(null, false)]
+            public void SetsHasReadmeFlagProperly(string readmeFilename, bool expectedFlag)
+            {
+                var service = CreateService();
+                var package = new Package
+                {
+                    PackageRegistration = new PackageRegistration
+                    {
+                        Id = "SomePackage"
+                    },
+                    HasReadMe = false,
+                };
+
+                // the EnrichPackageFromNuGetPackage method does not read readme filename from the PackageArchiveReader
+                // so we won't bother setting it up here.
+                var packageStream = PackageServiceUtility.CreateNuGetPackageStream(package.Id);
+
+                var packageArchiveReader = new PackageArchiveReader(packageStream);
+
+                var metadataDictionary = new Dictionary<string, string>
+                {
+                    { "version", "1.2.3" },
+                };
+
+                if (readmeFilename != null)
+                {
+                    metadataDictionary.Add("readme", readmeFilename);
+                }
+
+                var packageMetadata = new PackageMetadata(
+                    metadataDictionary,
+                    Enumerable.Empty<PackageDependencyGroup>(),
+                    Enumerable.Empty<FrameworkSpecificGroup>(),
+                    Enumerable.Empty<NuGet.Packaging.Core.PackageType>(),
+                    new NuGetVersion(3, 2, 1),
+                    repositoryMetadata: null,
+                    licenseMetadata: null);
+
+                service.EnrichPackageFromNuGetPackage(package, packageArchiveReader, packageMetadata, new PackageStreamMetadata(), new User());
+
+                Assert.Equal(expectedFlag, package.HasReadMe);
+            }
         }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -692,6 +692,7 @@ public virtual Package EnrichPackageFromNuGetPackage(`
`692`	`692`	`package.EmbeddedLicenseType = GetEmbeddedLicenseType(packageMetadata);`
`693`	`693`	`package.LicenseExpression = GetLicenseExpression(packageMetadata);`
`694`	`694`	`package.HasEmbeddedIcon = !string.IsNullOrWhiteSpace(packageMetadata.IconFile);`
	`695`	`+ package.HasReadMe = !string.IsNullOrWhiteSpace(packageMetadata.ReadmeFile);`
`695`	`696`	`package.EmbeddedReadmeType = GetEmbeddedReadmeType(packageMetadata);`
`696`	`697`
`697`	`698`	`return package;`
`@@ -750,7 +751,7 @@ private static EmbeddedReadmeFileType GetEmbeddedReadmeType(PackageMetadata pack`
`750`	`751`
`751`	`752`	`var extension = Path.GetExtension(packageMetadata.ReadmeFile);`
`752`	`753`
`753`		`- if (MarkdownFileExtension.Equals(extension, StringComparison.OrdinalIgnoreCase) \|\| string.Empty == extension)`
	`754`	`+ if (MarkdownFileExtension.Equals(extension, StringComparison.OrdinalIgnoreCase))`
`754`	`755`	`{`
`755`	`756`	`return EmbeddedReadmeFileType.Markdown;`
`756`	`757`	`}`