feat: support for symbol file signatures (#59)

* Support for symbol file signatures * Moved signature to a default parameter for the public API * Extracted new function AddFormDataOptionalSignature() * Better variable names * Use string.IsNullOrEmpty() * Removed unneeded files * chore: code review suggestions * chore: update BugSplatDotNetStandard/Api/VersionsClient.cs * chore: update BugSplatDotNetStandard/Api/VersionsClient.cs Co-authored-by: Bobby Galli <[email protected]>
BugSplat-Git · Sep 8, 2022 · 68d3b7d · 68d3b7d
1 parent c4ea4c7
commit 68d3b7d
Show file tree

Hide file tree

Showing 3 changed files with 61 additions and 12 deletions.
diff --git a/BugSplatDotNetStandard.Test/SymbolUploader.cs b/BugSplatDotNetStandard.Test/SymbolUploader.cs
@@ -32,7 +32,7 @@ public void SymbolUploader_UploadSymbolFile_ShouldUploadSymbolFileToBugSplat()
             var sut = SymbolUploader.CreateSymbolUploader(email, password);
             var symbolFileInfo = new FileInfo("Files/myConsoleCrasher.exe");
             var response = sut.UploadSymbolFile(
-                "fred",
+                database,
                 "myConsoleCrasher",
                 "2022.5.2.0",
                 symbolFileInfo
@@ -52,7 +52,7 @@ public void SymbolUploader_UploadSymbolFiles_ShouldUploadSymbolFilesToBugSplat()
                 new FileInfo("Files/myConsoleCrasher.pdb")
             };
             var responses = sut.UploadSymbolFiles(
-                "fred",
+                database,
                 "myConsoleCrasher",
                 "2022.5.2.0",
                 symbolFileInfos
@@ -64,5 +64,22 @@ public void SymbolUploader_UploadSymbolFiles_ShouldUploadSymbolFilesToBugSplat()
                 Assert.AreEqual(HttpStatusCode.OK, response.StatusCode);
             }
         }
+
+        [Test]
+        public void SymbolUploader_UploadSymbolFileWithSignature_ShouldUploadSymbolFileToBugSplat()
+        {
+            var sut = SymbolUploader.CreateSymbolUploader(email, password);
+            var symbolFileInfo = new FileInfo("Files/myConsoleCrasher.exe");
+            var response = sut.UploadSymbolFile(
+                database,
+                "myConsoleCrasher",
+                "2022.5.2.0",
+                symbolFileInfo,
+                "62702A2F26000"
+            ).Result;
+            var body = response.Content.ReadAsStringAsync().Result;
+
+            Assert.AreEqual(HttpStatusCode.OK, response.StatusCode);
+        }
     }
 }
diff --git a/BugSplatDotNetStandard/Api/VersionsClient.cs b/BugSplatDotNetStandard/Api/VersionsClient.cs
@@ -63,11 +63,13 @@ public async Task<HttpResponseMessage> GetVersions(string database)
         /// <param name="application">BugSplat application value to associate with the symbol file</param>
         /// <param name="version">BugSplat version value to associate with the symbol file</param>
         /// <param name="symbolFileInfo">The symbol file that will be uploaded to BugSplat</param>
+        /// <param name="signature">Optional, the unique symbol file signature</param>
         public async Task<HttpResponseMessage> UploadSymbolFile(
             string database,
             string application,
             string version,
-            FileInfo symbolFileInfo
+            FileInfo symbolFileInfo,
+            string optionalSignature = null
         )
         {
             ThrowIfArgumentIsNullOrEmpty(database, "database");
@@ -82,15 +84,28 @@ FileInfo symbolFileInfo
             {
                 var zipFileInfo = ZipUtils.CreateZipFile(zipFileFullName, new List<FileInfo>() { symbolFileInfo });
 
+                var optionalSymbolFileLastWriteTimeStr = string.Empty;
+                var optionalModuleName = string.Empty;
+                if (!string.IsNullOrEmpty(optionalSignature))
+                {
+                    var symbolFileLastWriteTime = File.GetLastWriteTime(symbolFileInfo.FullName);
+                    var unixTime = ((DateTimeOffset)symbolFileLastWriteTime).ToUnixTimeSeconds();
+                    optionalSymbolFileLastWriteTimeStr = unixTime.ToString();
+                    optionalModuleName = symbolFileInfo.Name;
+                }
+
                 using (var zipFileStream = ZipUtils.CreateZipFileStream(zipFileFullName))
                 using (
                     var presignedUrlResponse = await this.GetSymbolUploadUrl(
-                        database,
-                        application,
-                        version,
-                        zipFileInfo.Length,
-                        zipFileInfo.Name
-                    )
+                            database,
+                            application,
+                            version,
+                            zipFileInfo.Length,
+                            zipFileInfo.Name,
+                            optionalModuleName,
+                            optionalSymbolFileLastWriteTimeStr,
+                            optionalSignature
+                        )
                 )
                 {
                     ThrowIfHttpRequestFailed(presignedUrlResponse);
@@ -136,7 +151,10 @@ private async Task<HttpResponseMessage> GetSymbolUploadUrl(
             string application,
             string version,
             long symbolFileSize,
-            string symbolFileName
+            string symbolFileName,
+            string moduleName = null,
+            string lastModified = null,
+            string signature = null
         )
         {
             var route = "/api/versions";
@@ -150,7 +168,20 @@ string symbolFileName
                 { new StringContent(symbolFileName), "symFileName" },
             };
 
+            AddFormDataOptionalSignature(formData, moduleName, signature, lastModified);
+
             return await this.bugsplatApiClient.PostAsync(route, formData);
         }
+
+        private void AddFormDataOptionalSignature(MultipartFormDataContent formData, string moduleName, string signature, string lastModified)
+        {
+            if(!string.IsNullOrEmpty(moduleName) && !string.IsNullOrEmpty(lastModified) && !string.IsNullOrEmpty(signature))
+            {
+                formData.Add(new StringContent("bsv1"), "SendPdbsVersion");
+                formData.Add(new StringContent(moduleName), "moduleName");
+                formData.Add(new StringContent(lastModified), "lastModified");
+                formData.Add(new StringContent(signature), "dbgId");
+            }
+        }
     }
 }
diff --git a/BugSplatDotNetStandard/SymbolUploader.cs b/BugSplatDotNetStandard/SymbolUploader.cs
@@ -57,14 +57,15 @@ public static SymbolUploader CreateSymbolUploader(string email, string password)
         /// <param name="application">BugSplat application value to associate with the symbol file</param>
         /// <param name="version">BugSplat version value to associate with the symbol file</param>
         /// <param name="symbolFileInfo">The symbol file that will be uploaded to BugSplat</param>
-        public async Task<HttpResponseMessage> UploadSymbolFile(string database, string application, string version, FileInfo symbolFileInfo)
+        /// <param name="signature">Optional, the unique symbol file signature</param>
+        public async Task<HttpResponseMessage> UploadSymbolFile(string database, string application, string version, FileInfo symbolFileInfo, string signature=null)
         {
             if (!bugsplatApiClient.Authenticated)
             {
                 await bugsplatApiClient.Authenticate();
             }
 
-            return await versionsClient.UploadSymbolFile(database, application, version, symbolFileInfo);
+            return await versionsClient.UploadSymbolFile(database, application, version, symbolFileInfo, signature);
         }
 
         /// <summary>