Allow tracing of specific uploads on back end. (#6433)

* Allow tracing of specific uploads on back end.
* Move key extraction to a new helper. Move guid generation to serverside
* Adding null check. Fix tests.

Author: ryuyu

src/NuGetGallery.Core/CoreConstants.cs

@@ -39,5 +39,7 @@ public static class CoreConstants
         public const string SymbolPackagesFolderName = "symbol-packages";
         public const string NuGetSymbolPackageFileExtension = ".snupkg";
         public const string SymbolPackageBackupsFolderName = "symbol-package-backups";
+
+        public const string UploadTracingKeyHeaderName = "upload-id";
     }
 }

src/NuGetGallery/Authentication/AsyncFileUpload/AsyncFileUploadExtensions.cs

@@ -7,27 +7,27 @@ namespace NuGetGallery.AsyncFileUpload
 {
     public static class AsyncFileUploadExtensions
     {
-        public static void SetProgress(this ICacheService cacheService, string username, AsyncFileUploadProgress progress)
+        public static void SetProgress(this ICacheService cacheService, string uploadKey, AsyncFileUploadProgress progress)
         {
-            string cacheKey = GetUpdateCacheKey(username);
+            string cacheKey = GetUpdateCacheKey(uploadKey);
             cacheService.SetItem(cacheKey, progress, TimeSpan.FromHours(1));
         }
 
-        public static AsyncFileUploadProgress GetProgress(this ICacheService cacheService, string username)
+        public static AsyncFileUploadProgress GetProgress(this ICacheService cacheService, string uploadKey)
         {
-            string cacheKey = GetUpdateCacheKey(username);
+            string cacheKey = GetUpdateCacheKey(uploadKey);
             return cacheService.GetItem(cacheKey) as AsyncFileUploadProgress;
         }
 
-        public static void RemoveProgress(this ICacheService cacheService, string username)
+        public static void RemoveProgress(this ICacheService cacheService, string uploadKey)
         {
-            string cacheKey = GetUpdateCacheKey(username);
+            string cacheKey = GetUpdateCacheKey(uploadKey);
             cacheService.RemoveItem(cacheKey);
         }
 
-        private static string GetUpdateCacheKey(string username)
+        private static string GetUpdateCacheKey(string uploadKey)
         {
-            return "upload-" + username;
+            return "upload-" + uploadKey;
         }
     }
 }

src/NuGetGallery/Authentication/AsyncFileUpload/AsyncFileUploadModule.cs

@@ -1,11 +1,13 @@
 // 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.
 using System;
+using System.Collections.Generic;
 using System.Diagnostics;
 using System.IO;
 using System.Web;
 using Autofac;
 using Autofac.Integration.Mvc;
+using NuGetGallery.Helpers;
 
 namespace NuGetGallery.AsyncFileUpload
 {
@@ -50,8 +52,12 @@ private void PostAuthorizeRequest(object sender, EventArgs e)
             string boundary = "--" + contentType.Substring(boundaryIndex + 9);
             var requestParser = new AsyncFileUploadRequestParser(boundary, request.ContentEncoding);
 
+            var headers = request.Headers;
+            string uploadTracingKey = UploadHelper.GetUploadTracingKey(headers);
+
             var progress = new AsyncFileUploadProgress(request.ContentLength);
-            _cacheService.SetProgress(username, progress);
+            var uploadKey = username + uploadTracingKey;
+            _cacheService.SetProgress(uploadKey, progress);
 
             if (request.ReadEntityBodyMode != ReadEntityBodyMode.None)
             {
@@ -61,11 +67,11 @@ private void PostAuthorizeRequest(object sender, EventArgs e)
             Stream uploadStream = request.GetBufferedInputStream();
             Debug.Assert(uploadStream != null);
 
-            ReadStream(uploadStream, request, username, progress, requestParser);
+            ReadStream(uploadStream, request, uploadKey, progress, requestParser);
         }
 
         [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Usage", "CA1801:ReviewUnusedParameters", MessageId = "request", Justification="'request' parameter is used in debug build.")]
-        private void ReadStream(Stream stream, HttpRequest request, string username, AsyncFileUploadProgress progress, AsyncFileUploadRequestParser parser)
+        private void ReadStream(Stream stream, HttpRequest request, string uploadKey, AsyncFileUploadProgress progress, AsyncFileUploadRequestParser parser)
         {
             const int bufferSize = 1024 * 4; // in bytes
 
@@ -83,7 +89,7 @@ private void ReadStream(Stream stream, HttpRequest request, string username, Asy
                     progress.FileName = parser.CurrentFileName;
                 }
 
-                _cacheService.SetProgress(username, progress);
+                _cacheService.SetProgress(uploadKey, progress);
 
 #if DEBUG
                 if (request.IsLocal)

src/NuGetGallery/Controllers/PackagesController.cs

@@ -138,8 +138,11 @@ public PackagesController(
         public virtual JsonResult UploadPackageProgress()
         {
             string username = User.Identity.Name;
+            string uploadTracingKey = UploadHelper.GetUploadTracingKey(Request.Headers);
 
-            AsyncFileUploadProgress progress = _cacheService.GetProgress(username);
+            var uploadKey = username + uploadTracingKey;
+
+            AsyncFileUploadProgress progress = _cacheService.GetProgress(uploadKey);
             if (progress == null)
             {
                 return Json(HttpStatusCode.NotFound, null, JsonRequestBehavior.AllowGet);
@@ -226,6 +229,8 @@ public virtual async Task<JsonResult> UploadPackage(HttpPostedFileBase uploadFil
         {
             var currentUser = GetCurrentUser();
 
+            string uploadTracingKey = UploadHelper.GetUploadTracingKey(Request.Headers);
+
             using (var existingUploadFile = await _uploadFileService.GetUploadFileAsync(currentUser.Key))
             {
                 if (existingUploadFile != null)
@@ -288,7 +293,9 @@ public virtual async Task<JsonResult> UploadPackage(HttpPostedFileBase uploadFil
                 }
                 finally
                 {
-                    _cacheService.RemoveProgress(currentUser.Username);
+                    var username = currentUser.Username;
+                    var uploadKey = username + uploadTracingKey;
+                    _cacheService.RemoveProgress(uploadKey);
                 }
 
                 NuspecReader nuspec;

src/NuGetGallery/Helpers/UploadHelper.cs

@@ -0,0 +1,36 @@
+// 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.
+
+using System;
+using System.Collections.Generic;
+using System.Collections.Specialized;
+
+namespace NuGetGallery.Helpers
+{
+    public static class UploadHelper
+    {
+        public static string GetUploadTracingKey(NameValueCollection headers)
+        {
+            if (headers == null)
+            {
+                return Guid.Empty.ToString();
+            }
+
+            string uploadTracingKey;
+            try
+            {
+                uploadTracingKey = headers[CoreConstants.UploadTracingKeyHeaderName];
+                Guid.Parse(uploadTracingKey);
+            }
+            catch (Exception ex) when (ex is FormatException || ex is KeyNotFoundException)
+            {
+                // An upload tracing key was not found
+                // Simultaneous UI uploads might have strange behaviour.
+                // Note that we might have this case if an old client sends to new Server.
+                uploadTracingKey = Guid.Empty.ToString();
+            }
+
+            return uploadTracingKey;
+        }
+    }
+}

src/NuGetGallery/NuGetGallery.csproj

@@ -295,6 +295,7 @@
     <Compile Include="Helpers\PermissionsHelpers.cs" />
     <Compile Include="Helpers\RegexEx.cs" />
     <Compile Include="Helpers\RouteUrlTemplate.cs" />
+    <Compile Include="Helpers\UploadHelper.cs" />
     <Compile Include="Helpers\UriExtensions.cs" />
     <Compile Include="Infrastructure\Authentication\ApiKeyV3.cs" />
     <Compile Include="Infrastructure\Authentication\ApiKeyV4.cs" />

src/NuGetGallery/Scripts/gallery/async-file-upload.js

@@ -14,8 +14,10 @@
         var _pingUrl;
         var _isUploadInProgress;
         var _uploadStartTime;
+        var _uploadId;
 
-        this.init = function (pingUrl, formId, jQueryUrl, actionUrl, cancelUrl, submitVerifyUrl) {
+        this.init = function (pingUrl, formId, jQueryUrl, actionUrl, cancelUrl, submitVerifyUrl, uploadTracingKey) {
+            _uploadId = uploadTracingKey;
             _pingUrl = pingUrl;
             _uploadFormId = formId;
             _actionUrl = actionUrl;
@@ -104,6 +106,10 @@
 
                 data: _uploadFormData,
 
+                headers: {
+                    "upload-id": _uploadId
+                },
+
                 cache: false,
                 contentType: false,
                 processData: false,
@@ -127,6 +133,10 @@
 
                 data: new FormData($('#verify-metadata-form')[0]),
 
+                headers: {
+                    "upload-id": _uploadId
+                },
+
                 cache: false,
                 contentType: false,
                 processData: false,
@@ -150,6 +160,10 @@
 
                 data: new FormData($('#cancel-form')[0]),
 
+                headers: {
+                    "upload-id": _uploadId
+                },
+
                 cache: false,
                 contentType: false,
                 processData: false,
@@ -305,6 +319,9 @@
                 type: 'GET',
                 dataType: 'json',
                 url: _pingUrl,
+                headers: {
+                    "upload-id": _uploadId
+                },
                 success: onGetProgressSuccess,
                 error: onGetProgressError
             });

src/NuGetGallery/Views/Packages/UploadPackage.cshtml

@@ -74,7 +74,8 @@
                 '@Scripts.Url("~/Scripts/jquery")',
                 '@Url.UploadPackage()',
                 '@Url.CancelUpload()',
-                '@Url.VerifyPackage()');
+                '@Url.VerifyPackage()',
+                '@Guid.NewGuid()');
         });
     </script>
 }

tests/NuGetGallery.Facts/Controllers/PackagesControllerFacts.cs

@@ -5480,7 +5480,7 @@ public async Task WillApplyReadMeForWrittenReadMeData(EditPackageVersionReadMeRe
 
         public class TheUploadProgressAction : TestContainer
         {
-            private static readonly string FakeUploadName = "upload-" + TestUtility.FakeUserName;
+            private static readonly string FakeUploadName = "upload-" + TestUtility.FakeUserName + Guid.Empty.ToString();
 
             [Fact]
             public void WillReturnHttpNotFoundForUnknownUser()