[NuGet Symbol Server] Add download symbols support to Package details page (#6320)

shishirx34 · web-flow · commit bc0954b5ca8c · 2018-08-16T16:25:48.000-07:00
diff --git a/src/NuGetGallery/App_Start/Routes.cs b/src/NuGetGallery/App_Start/Routes.cs
@@ -656,6 +656,12 @@ public static void RegisterApiV2Routes(RouteCollection routes)
                 defaults: new { controller = "Api", action = "GetPackageApi", version = UrlParameter.Optional },
                 constraints: new { httpMethod = new HttpMethodConstraint("GET") });
 
+            routes.MapRoute(
+                "v2" + RouteName.DownloadSymbolsPackage,
+                "api/v2/symbolpackage/{id}/{version}",
+                defaults: new { controller = "Api", action = "GetSymbolPackageApi", version = UrlParameter.Optional },
+                constraints: new { httpMethod = new HttpMethodConstraint("GET") });
+
             routes.MapRoute(
                 "v2" + RouteName.PushPackageApi,
                 "api/v2/package",
diff --git a/src/NuGetGallery/Controllers/ApiController.cs b/src/NuGetGallery/Controllers/ApiController.cs
@@ -55,6 +55,7 @@ public partial class ApiController
         public IReservedNamespaceService ReservedNamespaceService { get; set; }
         public IPackageUploadService PackageUploadService { get; set; }
         public IPackageDeleteService PackageDeleteService { get; set; }
+        public ISymbolPackageFileService SymbolPackageFileService { get; set; }
         public ISymbolPackageService SymbolPackageService { get; set; }
         public ISymbolPackageUploadService SymbolPackageUploadService { get; set; }
         public IContentObjectService ContentObjectService { get; set; }
@@ -85,6 +86,7 @@ public ApiController(
             IReservedNamespaceService reservedNamespaceService,
             IPackageUploadService packageUploadService,
             IPackageDeleteService packageDeleteService,
+            ISymbolPackageFileService symbolPackageFileService,
             ISymbolPackageService symbolPackageService,
             ISymbolPackageUploadService symbolPackageUploadService,
             IContentObjectService contentObjectService)
@@ -109,6 +111,7 @@ public ApiController(
             ReservedNamespaceService = reservedNamespaceService;
             PackageUploadService = packageUploadService;
             StatisticsService = null;
+            SymbolPackageFileService = symbolPackageFileService;
             SymbolPackageService = symbolPackageService;
             SymbolPackageUploadService = symbolPackageUploadService;
             ContentObjectService = contentObjectService;
@@ -136,21 +139,35 @@ public ApiController(
             IReservedNamespaceService reservedNamespaceService,
             IPackageUploadService packageUploadService,
             IPackageDeleteService packageDeleteService,
+            ISymbolPackageFileService symbolPackageFileService,
             ISymbolPackageService symbolPackageService,
             ISymbolPackageUploadService symbolPackageUploadServivce,
             IContentObjectService contentObjectService)
             : this(apiScopeEvaluator, entitiesContext, packageService, packageFileService, userService, contentService,
                   indexingService, searchService, autoCuratePackage, statusService, messageService, auditingService,
                   configurationService, telemetryService, authenticationService, credentialBuilder, securityPolicies,
-                  reservedNamespaceService, packageUploadService, packageDeleteService, symbolPackageService, symbolPackageUploadServivce,
-                  contentObjectService)
+                  reservedNamespaceService, packageUploadService, packageDeleteService, symbolPackageFileService, 
+                  symbolPackageService, symbolPackageUploadServivce, contentObjectService)
         {
             StatisticsService = statisticsService;
         }
 
+
+        [HttpGet]
+        [ActionName("GetSymbolPackageApi")]
+        public virtual async Task<ActionResult> GetSymbolPackage(string id, string version)
+        {
+            return await GetPackageInternal(id, version, isSymbolPackage: true);
+        }
+
         [HttpGet]
         [ActionName("GetPackageApi")]
         public virtual async Task<ActionResult> GetPackage(string id, string version)
+        {
+            return await GetPackageInternal(id, version, isSymbolPackage: false);
+        }
+
+        protected internal async Task<ActionResult> GetPackageInternal(string id, string version, bool isSymbolPackage = false)
         {
             // some security paranoia about URL hacking somehow creating e.g. open redirects
             // validate user input: explicit calls to the same validators used during Package Registrations
@@ -160,61 +177,86 @@ public virtual async Task<ActionResult> GetPackage(string id, string version)
                 return new HttpStatusCodeWithBodyResult(HttpStatusCode.BadRequest, "The format of the package id is invalid");
             }
 
-            // if version is non-null, check if it's semantically correct and normalize it.
-            if (!String.IsNullOrEmpty(version))
+            Package package = null;
+            try
             {
-                NuGetVersion dummy;
-                if (!NuGetVersion.TryParse(version, out dummy))
+                if (!string.IsNullOrEmpty(version))
                 {
-                    return new HttpStatusCodeWithBodyResult(HttpStatusCode.BadRequest, "The package version is not a valid semantic version");
-                }
+                    // if version is non-null, check if it's semantically correct and normalize it.
+                    NuGetVersion dummy;
+                    if (!NuGetVersion.TryParse(version, out dummy))
+                    {
+                        return new HttpStatusCodeWithBodyResult(HttpStatusCode.BadRequest, "The package version is not a valid semantic version");
+                    }
 
-                // Normalize the version
-                version = NuGetVersionFormatter.Normalize(version);
-            }
-            else
-            {
-                // If version is null, get the latest version from the database.
-                // This ensures that on package restore scenario where version will be non null, we don't hit the database.
-                try
+                    // Normalize the version
+                    version = NuGetVersionFormatter.Normalize(version);
+
+                    if (isSymbolPackage)
+                    {
+                        package = PackageService.FindPackageByIdAndVersionStrict(id, version);
+                    }
+                }
+                else
                 {
-                    var package = PackageService.FindPackageByIdAndVersion(
+                    // If version is null, get the latest version from the database.
+                    // This ensures that on package restore scenario where version will be non null, we don't hit the database.
+                    package = PackageService.FindPackageByIdAndVersion(
                         id,
                         version,
                         SemVerLevelKey.SemVer2,
                         allowPrerelease: false);
 
                     if (package == null)
                     {
-                        return new HttpStatusCodeWithBodyResult(HttpStatusCode.NotFound, String.Format(CultureInfo.CurrentCulture, Strings.PackageWithIdAndVersionNotFound, id, version));
+                        return new HttpStatusCodeWithBodyResult(HttpStatusCode.NotFound, string.Format(CultureInfo.CurrentCulture, Strings.PackageWithIdAndVersionNotFound, id, version));
                     }
-                    version = package.NormalizedVersion;
 
+                    version = package.NormalizedVersion;
                 }
-                catch (SqlException e)
-                {
-                    QuietLog.LogHandledException(e);
+            }
+            catch (SqlException e)
+            {
+                QuietLog.LogHandledException(e);
 
-                    // Database was unavailable and we don't have a version, return a 503
-                    return new HttpStatusCodeWithBodyResult(HttpStatusCode.ServiceUnavailable, Strings.DatabaseUnavailable_TrySpecificVersion);
-                }
-                catch (DataException e)
-                {
-                    QuietLog.LogHandledException(e);
+                // Database was unavailable and we don't have a version, return a 503
+                return new HttpStatusCodeWithBodyResult(HttpStatusCode.ServiceUnavailable, Strings.DatabaseUnavailable_TrySpecificVersion);
+            }
+            catch (DataException e)
+            {
+                QuietLog.LogHandledException(e);
 
-                    // Database was unavailable and we don't have a version, return a 503
-                    return new HttpStatusCodeWithBodyResult(HttpStatusCode.ServiceUnavailable, Strings.DatabaseUnavailable_TrySpecificVersion);
-                }
+                // Database was unavailable and we don't have a version, return a 503
+                return new HttpStatusCodeWithBodyResult(HttpStatusCode.ServiceUnavailable, Strings.DatabaseUnavailable_TrySpecificVersion);
             }
 
-            if (ConfigurationService.Features.TrackPackageDownloadCountInLocalDatabase)
+            if (isSymbolPackage)
             {
-                await PackageService.IncrementDownloadCountAsync(id, version);
+                var latestSymbolPackage = package?
+                    .SymbolPackages
+                    .OrderByDescending(sp => sp.Created)
+                    .FirstOrDefault();
+
+                if (latestSymbolPackage == null || latestSymbolPackage.StatusKey != PackageStatus.Available)
+                {
+                    return new HttpStatusCodeWithBodyResult(HttpStatusCode.NotFound, string.Format(CultureInfo.CurrentCulture, Strings.SymbolsPackage_PackageNotAvailable, id, version));
+                }
+
+                return await SymbolPackageFileService.CreateDownloadSymbolPackageActionResultAsync(
+                    HttpContext.Request.Url,
+                    id, version);
             }
+            else
+            {
+                if (ConfigurationService.Features.TrackPackageDownloadCountInLocalDatabase)
+                {
+                    await PackageService.IncrementDownloadCountAsync(id, version);
+                }
 
-            return await PackageFileService.CreateDownloadPackageActionResultAsync(
-                HttpContext.Request.Url,
-                id, version);
+                return await PackageFileService.CreateDownloadPackageActionResultAsync(
+                    HttpContext.Request.Url,
+                    id, version);
+            }
         }
 
         [HttpGet]
@@ -303,7 +345,7 @@ private async Task<HttpStatusCodeWithBodyResult> VerifyPackageKeyInternalAsync(U
             if (package == null)
             {
                 return new HttpStatusCodeWithBodyResult(
-                    HttpStatusCode.NotFound, String.Format(CultureInfo.CurrentCulture, Strings.PackageWithIdAndVersionNotFound, id, version));
+                    HttpStatusCode.NotFound, string.Format(CultureInfo.CurrentCulture, Strings.PackageWithIdAndVersionNotFound, id, version));
             }
 
             // Write an audit record
@@ -806,7 +848,7 @@ public virtual async Task<ActionResult> DeletePackage(string id, string version)
             if (package == null)
             {
                 return new HttpStatusCodeWithBodyResult(
-                    HttpStatusCode.NotFound, String.Format(CultureInfo.CurrentCulture, Strings.PackageWithIdAndVersionNotFound, id, version));
+                    HttpStatusCode.NotFound, string.Format(CultureInfo.CurrentCulture, Strings.PackageWithIdAndVersionNotFound, id, version));
             }
 
             // Check if the current user's scopes allow listing/unlisting the current package ID
@@ -838,7 +880,7 @@ public virtual async Task<ActionResult> PublishPackage(string id, string version
             if (package == null)
             {
                 return new HttpStatusCodeWithBodyResult(
-                    HttpStatusCode.NotFound, String.Format(CultureInfo.CurrentCulture, Strings.PackageWithIdAndVersionNotFound, id, version));
+                    HttpStatusCode.NotFound, string.Format(CultureInfo.CurrentCulture, Strings.PackageWithIdAndVersionNotFound, id, version));
             }
 
             // Check if the current user's scopes allow listing/unlisting the current package ID
diff --git a/src/NuGetGallery/RouteName.cs b/src/NuGetGallery/RouteName.cs
@@ -27,6 +27,7 @@ public static class RouteName
         public const string Profile = "Profile";
         public const string DisplayPackage = "package-route";
         public const string DownloadPackage = "DownloadPackage";
+        public const string DownloadSymbolsPackage = "DownloadSymbolsPackage";
         public const string DownloadNuGetExe = "DownloadNuGetExe";
         public const string Home = "Home";
         public const string Stats = "Stats";
diff --git a/src/NuGetGallery/Services/FileSystemFileStorageService.cs b/src/NuGetGallery/Services/FileSystemFileStorageService.cs
@@ -278,6 +278,7 @@ private static string GetContentType(string folderName)
             switch (folderName)
             {
                 case CoreConstants.PackagesFolderName:
+                case CoreConstants.SymbolPackagesFolderName:
                     return CoreConstants.PackageContentType;
 
                 case CoreConstants.DownloadsFolderName:
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
@@ -968,4 +968,7 @@ Policy violations: {0}</value>
     <value>The previous package version '{0}' is author signed but the uploaded package is unsigned. To avoid this warning, sign the package before uploading.</value>
     <comment>{0} is the previous package's normalized version.</comment>
   </data>
+  <data name="SymbolsPackage_PackageNotAvailable" xml:space="preserve">
+    <value>No available symbols package found for ID {0} and version {1}.</value>
+  </data>
 </root>
diff --git a/src/NuGetGallery/UrlExtensions.cs b/src/NuGetGallery/UrlExtensions.cs
@@ -307,6 +307,26 @@ public static string PackageDownload(
             return version == null ? EnsureTrailingSlash(result) : result;
         }
 
+        public static string SymbolPackageDownload(
+            this UrlHelper url,
+            int feedVersion,
+            string id,
+            string version,
+            bool relativeUrl = true)
+        {
+            string result = GetRouteLink(
+                url,
+                routeName: $"v{feedVersion}{RouteName.DownloadSymbolsPackage}",
+                relativeUrl: false,
+                routeValues: new RouteValueDictionary
+                {
+                    { "Id", id },
+                    { "Version", version }
+                });
+
+            // Ensure trailing slashes for versionless package URLs, as a fix for package filenames that look like known file extensions
+            return version == null ? EnsureTrailingSlash(result) : result;
+        }
         public static string ExplorerDeepLink(
             this UrlHelper url,
             int feedVersion,
diff --git a/src/NuGetGallery/ViewModels/DisplayPackageViewModel.cs b/src/NuGetGallery/ViewModels/DisplayPackageViewModel.cs
@@ -26,6 +26,11 @@ public DisplayPackageViewModel(Package package, User currentUser, IOrderedEnumer
             PushedBy = GetPushedBy(package, currentUser);
             PackageFileSize = package.PackageFileSize;
 
+            LatestSymbolPackage = package
+                .SymbolPackages
+                .OrderByDescending(sp => sp.Created)
+                .FirstOrDefault();
+
             if (packageHistory.Any())
             {
                 // calculate the number of days since the package registration was created
@@ -62,6 +67,7 @@ public DisplayPackageViewModel(Package package, User currentUser, string pushedB
         public int DownloadsPerDay { get; private set; }
         public int TotalDaysSinceCreated { get; private set; }
         public long PackageFileSize { get; private set; }
+        public SymbolPackage LatestSymbolPackage { get; private set; }
 
         public bool HasSemVer2Version { get; }
         public bool HasSemVer2Dependency { get; }
diff --git a/src/NuGetGallery/Views/Packages/DisplayPackage.cshtml b/src/NuGetGallery/Views/Packages/DisplayPackage.cshtml
@@ -9,6 +9,8 @@
 
     var absolutePackageUrl = Url.Absolute(Url.Package(Model.Id));
 
+    var hasSymbolPackageAvailable = Model.LatestSymbolPackage != null && Model.LatestSymbolPackage.StatusKey == PackageStatus.Available;
+
     PackageManagerViewModel[] packageManagers;
 
     if (Model.IsDotnetToolPackageType)
@@ -627,9 +629,17 @@
                 {
                     <li>
                         <i class="ms-Icon ms-Icon--CloudDownload" aria-hidden="true"></i>
-                        <a href="@Url.PackageDownload(2, Model.Id, Model.Version)" data-track="outbound-manual-download" title="Download the raw nupkg file." rel="nofollow">Download</a>
+                        <a href="@Url.PackageDownload(2, Model.Id, Model.Version)" data-track="outbound-manual-download" title="Download the raw nupkg file." rel="nofollow">Download Package</a>
                         &nbsp;(@Model.PackageFileSize.ToUserFriendlyBytesLabel())
                     </li>
+                    if (hasSymbolPackageAvailable)
+                    {
+                        <li>
+                            <i class="ms-Icon ms-Icon--CloudDownload" aria-hidden="true"></i>
+                            <a href="@Url.SymbolPackageDownload(2, Model.Id, Model.Version)" data-track="outbound-manual-download" title="Download the raw snupkg file." rel="nofollow">Download Symbols</a>
+                            &nbsp;(@Model.LatestSymbolPackage.FileSize.ToUserFriendlyBytesLabel())
+                        </li>
+                    }
                     <li class="no-clickonce">
                         <i class="ms-Icon ms-Icon--OpenInNewWindow" aria-hidden="true"></i>
                         <a href="@Url.ExplorerDeepLink(2, Model.Id, Model.Version)" title="Explore the nupkg with the NuGet Package Explorer (IE only)" rel="nofollow">Open in Package Explorer</a>
diff --git a/tests/NuGetGallery.Facts/Controllers/ApiControllerFacts.cs b/tests/NuGetGallery.Facts/Controllers/ApiControllerFacts.cs
diff --git a/tests/NuGetGallery.Facts/Services/FileSystemFileStorageServiceFacts.cs b/tests/NuGetGallery.Facts/Services/FileSystemFileStorageServiceFacts.cs
diff --git a/tests/NuGetGallery.Facts/ViewModels/DisplayPackageViewModelFacts.cs b/tests/NuGetGallery.Facts/ViewModels/DisplayPackageViewModelFacts.cs

Original file line number	Diff line number	Diff line change
`@@ -278,6 +278,7 @@ private static string GetContentType(string folderName)`
`278`	`278`	`switch (folderName)`
`279`	`279`	`{`
`280`	`280`	`case CoreConstants.PackagesFolderName:`
	`281`	`+ case CoreConstants.SymbolPackagesFolderName:`
`281`	`282`	`return CoreConstants.PackageContentType;`
`282`	`283`
`283`	`284`	`case CoreConstants.DownloadsFolderName:`