Merge branch 'release/4.1.0'

Jericho · Jericho · commit 08b3fc5d07f4 · 2020-03-21T21:45:42.000-04:00
diff --git a/Source/HttpMultipartParser.UnitTests/ParserScenarios/MultipleFilesWithEmptyName.cs b/Source/HttpMultipartParser.UnitTests/ParserScenarios/MultipleFilesWithEmptyName.cs
@@ -10,7 +10,7 @@ namespace HttpMultipartParser.UnitTests.ParserScenarios
     /// <summary>
     ///     Test case for multiple files with no name.
     /// </summary>
-    public class MultipleFilesWithNoName
+    public class MultipleFilesWithEmptyName
     {
         private static readonly string MultipleFilesSameName_testData = TestUtil.TrimAllLines(@"--boundry
               Content-Disposition: form-data; name="""";filename=""file1.txt"";
@@ -39,7 +39,7 @@ This is text file 3 1234567890
             }
         );
 
-        public MultipleFilesWithNoName()
+        public MultipleFilesWithEmptyName()
         {
         }
 
@@ -50,7 +50,7 @@ public MultipleFilesWithNoName()
         [Fact]
         public void MultipleFilesWithNoNameTest()
         {
-            using (Stream stream = TestUtil.StringToStream(MultipleFilesSameName_testData, Encoding.UTF8))
+            using (Stream stream = TestUtil.StringToStream(_testCase.Request, Encoding.UTF8))
             {
                 var parser = MultipartFormDataParser.Parse(stream, "boundry", Encoding.UTF8, 16);
                 Assert.True(_testCase.Validate(parser));
diff --git a/Source/HttpMultipartParser.UnitTests/ParserScenarios/MultipleFilesWithOmittedName.cs b/Source/HttpMultipartParser.UnitTests/ParserScenarios/MultipleFilesWithOmittedName.cs
@@ -0,0 +1,70 @@
+using System.Collections.Generic;
+using System.IO;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+using Xunit;
+
+namespace HttpMultipartParser.UnitTests.ParserScenarios
+{
+    /// <summary>
+    ///     Test case for multiple files with omitted name.
+    /// </summary>
+    public class MultipleFilesWithOmittedName
+    {
+        private static readonly string MultipleFilesWithOmittedName_testData = TestUtil.TrimAllLines(@"--boundry
+              Content-Disposition: form-data; filename=""file1.txt"";
+              Content-Type: text/plain
+
+              THIS IS TEXT FILE 1
+              --boundry
+              Content-Disposition: form-data; filename=""file2.txt"";
+              Content-Type: text/plain
+
+              THIS IS TEXT FILE 2 !!!
+              --boundry
+              Content-Disposition: form-data; filename=""file3.txt"";
+              Content-Type: text/plain
+
+              This is text file 3 1234567890
+              --boundry--");
+
+        private static readonly TestData _testCase = new TestData(
+            MultipleFilesWithOmittedName_testData,
+            Enumerable.Empty<ParameterPart>().ToList(),
+            new List<FilePart> {
+                new FilePart( null, "file1.txt", TestUtil.StringToStreamNoBom("THIS IS TEXT FILE 1")),
+                new FilePart( null, "file2.txt", TestUtil.StringToStreamNoBom("THIS IS TEXT FILE 2 !!!")),
+                new FilePart( null, "file3.txt", TestUtil.StringToStreamNoBom("This is text file 3 1234567890"))
+            }
+        );
+
+        public MultipleFilesWithOmittedName()
+        {
+        }
+
+        /// <summary>
+        ///     Checks that multiple files don't get in the way of parsing each other
+        ///     and that everything parses correctly.
+        /// </summary>
+        [Fact]
+        public void MultipleFilesWithOmittedNameTest()
+        {
+            using (Stream stream = TestUtil.StringToStream(_testCase.Request, Encoding.UTF8))
+            {
+                var parser = MultipartFormDataParser.Parse(stream, "boundry", Encoding.UTF8, 16);
+                Assert.True(_testCase.Validate(parser));
+            }
+        }
+
+        [Fact]
+        public async Task MultipleFilesWithOmittedNameAsync()
+        {
+            using (Stream stream = TestUtil.StringToStream(_testCase.Request, Encoding.UTF8))
+            {
+                var parser = await MultipartFormDataParser.ParseAsync(stream, "boundry", Encoding.UTF8, 16).ConfigureAwait(false);
+                Assert.True(_testCase.Validate(parser));
+            }
+        }
+    }
+}
diff --git a/Source/HttpMultipartParser.UnitTests/ParserScenarios/MultipleFilesWithSameName.cs b/Source/HttpMultipartParser.UnitTests/ParserScenarios/MultipleFilesWithSameName.cs
@@ -50,7 +50,7 @@ public MultipleFilesWithSameName()
         [Fact]
         public void MultipleFilesWithSameNameTest()
         {
-            using (Stream stream = TestUtil.StringToStream(MultipleFilesSameName_testData, Encoding.UTF8))
+            using (Stream stream = TestUtil.StringToStream(_testCase.Request, Encoding.UTF8))
             {
                 var parser = MultipartFormDataParser.Parse(stream, "boundry", Encoding.UTF8, 16);
                 Assert.True(_testCase.Validate(parser));
diff --git a/Source/HttpMultipartParser/BinaryStreamStack.cs b/Source/HttpMultipartParser/BinaryStreamStack.cs
@@ -142,10 +142,7 @@ public void Push(byte[] data)
         /// </param>
         public void Push(byte[] data, int offset, int count)
         {
-            var stream = Utilities.MemoryStreamManager.GetStream();
-            stream.Write(data, offset, count);
-            stream.Position = 0;
-
+            var stream = Utilities.MemoryStreamManager.GetStream($"{typeof(BinaryStreamStack).FullName}.{nameof(Push)}", data, offset, count);
             streams.Push(new BinaryReader(stream, CurrentEncoding));
         }
 
@@ -306,7 +303,7 @@ public byte[] ReadByteLine(out bool hitStreamEnd)
             byte[] ignore = CurrentEncoding.GetBytes(new[] { '\r' });
             byte[] search = CurrentEncoding.GetBytes(new[] { '\n' });
             int searchPos = 0;
-            using (var builder = Utilities.MemoryStreamManager.GetStream())
+            using (var builder = Utilities.MemoryStreamManager.GetStream($"{typeof(BinaryStreamStack).FullName}.{nameof(ReadByteLine)}"))
             {
                 while (true)
                 {
diff --git a/Source/HttpMultipartParser/HttpMultipartParser.csproj b/Source/HttpMultipartParser/HttpMultipartParser.csproj
@@ -38,7 +38,7 @@
 
   <ItemGroup>
     <PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.0.0" PrivateAssets="All" />
-    <PackageReference Include="Microsoft.IO.RecyclableMemoryStream" Version="1.3.2" />
+    <PackageReference Include="Microsoft.IO.RecyclableMemoryStream" Version="1.3.3" />
     <PackageReference Include="StyleCop.Analyzers" Version="1.1.118" PrivateAssets="All" />
     <PackageReference Include="System.Buffers" Version="4.5.0" />
   </ItemGroup>
diff --git a/Source/HttpMultipartParser/MultipartFormDataParser.cs b/Source/HttpMultipartParser/MultipartFormDataParser.cs
@@ -562,7 +562,7 @@ private void ParseStream(Stream stream, string boundary, Encoding encoding, int
                 if (partNumber == 0)
                 {
                     // create file with first partNo
-                    Files.Add(new FilePart(name, fileName, Utilities.MemoryStreamManager.GetStream(), type, disposition));
+                    Files.Add(new FilePart(name, fileName, Utilities.MemoryStreamManager.GetStream($"{typeof(MultipartFormDataParser).FullName}.{nameof(ParseStream)}"), type, disposition));
                 }
 
                 Files[Files.Count - 1].Data.Write(buffer, 0, bytes);
@@ -607,7 +607,7 @@ private async Task ParseStreamAsync(Stream stream, string boundary, Encoding enc
                 if (partNumber == 0)
                 {
                     // create file with first partNo
-                    Files.Add(new FilePart(name, fileName, Utilities.MemoryStreamManager.GetStream(), type, disposition));
+                    Files.Add(new FilePart(name, fileName, Utilities.MemoryStreamManager.GetStream($"{typeof(MultipartFormDataParser).FullName}.{nameof(ParseStreamAsync)}"), type, disposition));
                 }
 
                 Files[Files.Count - 1].Data.Write(buffer, 0, bytes);
diff --git a/Source/HttpMultipartParser/RebufferableBinaryReader.cs b/Source/HttpMultipartParser/RebufferableBinaryReader.cs
@@ -265,7 +265,7 @@ public int Read(char[] buffer, int index, int count)
         /// </returns>
         public byte[] ReadByteLine()
         {
-            using (var builder = Utilities.MemoryStreamManager.GetStream())
+            using (var builder = Utilities.MemoryStreamManager.GetStream($"{typeof(RebufferableBinaryReader).FullName}.{nameof(ReadByteLine)}"))
             {
                 while (true)
                 {
@@ -424,7 +424,7 @@ public async Task<int> ReadAsync(char[] buffer, int index, int count, Cancellati
         /// </returns>
         public async Task<byte[]> ReadByteLineAsync(CancellationToken cancellationToken = default)
         {
-            using (var builder = Utilities.MemoryStreamManager.GetStream())
+            using (var builder = Utilities.MemoryStreamManager.GetStream($"{typeof(RebufferableBinaryReader).FullName}.{nameof(ReadByteLineAsync)}"))
             {
                 while (true)
                 {
diff --git a/Source/HttpMultipartParser/StreamingMultipartFormDataParser.cs b/Source/HttpMultipartParser/StreamingMultipartFormDataParser.cs
@@ -545,7 +545,7 @@ private async Task ParseAsync(RebufferableBinaryReader reader, CancellationToken
         ///     Parses a section of the stream that is known to be file data.
         /// </summary>
         /// <param name="parameters">
-        ///     The header parameters of this file, expects "name" and "filename" to be valid keys.
+        ///     The header parameters of this file.
         /// </param>
         /// <param name="reader">
         ///     The StreamReader to read the data from.
@@ -554,17 +554,17 @@ private void ParseFilePart(Dictionary<string, string> parameters, RebufferableBi
         {
             int partNumber = 0; // begins count parts of file from 0
 
-            string name = parameters["name"];
-            string filename = parameters["filename"];
-
+            // Read the parameters
+            parameters.TryGetValue("name", out string name);
+            parameters.TryGetValue("filename", out string filename);
             parameters.TryGetValue("content-type", out string contentType);
-            if (contentType == null) contentType = "text/plain";
-
             parameters.TryGetValue("content-disposition", out string contentDisposition);
+
+            // Default values if expected parameters are missing
+            if (contentType == null) contentType = "text/plain";
             if (contentDisposition == null) contentDisposition = "form-data";
 
-            // We want to create a stream and fill it with the data from the
-            // file.
+            // We want to create a stream and fill it with the data from the file.
             var curBuffer = Utilities.ArrayPool.Rent(BinaryBufferSize);
             var prevBuffer = Utilities.ArrayPool.Rent(BinaryBufferSize);
             var fullBuffer = Utilities.ArrayPool.Rent(BinaryBufferSize * 2);
@@ -655,7 +655,7 @@ private void ParseFilePart(Dictionary<string, string> parameters, RebufferableBi
                     // We also want to chop off the newline that is inserted by the protocl.
                     // We can do this by reducing endPos by the length of newline in this environment
                     // and encoding
-                    FileHandler(name, filename, contentType, contentDisposition, fullBuffer, endPos - bufferNewlineLength, partNumber);
+                    FileHandler(name, filename, contentType, contentDisposition, fullBuffer, endPos - bufferNewlineLength, partNumber++);
 
                     int writeBackOffset = endPos + endPosLength + boundaryNewlineOffset;
                     int writeBackAmount = (prevLength + curLength) - writeBackOffset;
@@ -665,8 +665,7 @@ private void ParseFilePart(Dictionary<string, string> parameters, RebufferableBi
                 }
 
                 // No end, consume the entire previous buffer
-                FileHandler(name, filename, contentType, contentDisposition, prevBuffer, prevLength, partNumber);
-                partNumber++; // increase part counter
+                FileHandler(name, filename, contentType, contentDisposition, prevBuffer, prevLength, partNumber++);
 
                 // Now we want to swap the two buffers, we don't care
                 // what happens to the data from prevBuffer so we set
@@ -706,13 +705,14 @@ private async Task ParseFilePartAsync(Dictionary<string, string> parameters, Reb
         {
             int partNumber = 0; // begins count parts of file from 0
 
-            string name = parameters["name"];
-            string filename = parameters["filename"];
-
+            // Read the parameters
+            parameters.TryGetValue("name", out string name);
+            parameters.TryGetValue("filename", out string filename);
             parameters.TryGetValue("content-type", out string contentType);
-            if (contentType == null) contentType = "text/plain";
-
             parameters.TryGetValue("content-disposition", out string contentDisposition);
+
+            // Default values if expected parameters are missing
+            if (contentType == null) contentType = "text/plain";
             if (contentDisposition == null) contentDisposition = "form-data";
 
             // We want to create a stream and fill it with the data from the
@@ -807,7 +807,7 @@ private async Task ParseFilePartAsync(Dictionary<string, string> parameters, Reb
                     // We also want to chop off the newline that is inserted by the protocl.
                     // We can do this by reducing endPos by the length of newline in this environment
                     // and encoding
-                    FileHandler(name, filename, contentType, contentDisposition, fullBuffer, endPos - bufferNewlineLength, partNumber);
+                    FileHandler(name, filename, contentType, contentDisposition, fullBuffer, endPos - bufferNewlineLength, partNumber++);
 
                     int writeBackOffset = endPos + endPosLength + boundaryNewlineOffset;
                     int writeBackAmount = (prevLength + curLength) - writeBackOffset;
@@ -817,8 +817,7 @@ private async Task ParseFilePartAsync(Dictionary<string, string> parameters, Reb
                 }
 
                 // No end, consume the entire previous buffer
-                FileHandler(name, filename, contentType, contentDisposition, prevBuffer, prevLength, partNumber);
-                partNumber++; // increase part counter
+                FileHandler(name, filename, contentType, contentDisposition, prevBuffer, prevLength, partNumber++);
 
                 // Now we want to swap the two buffers, we don't care
                 // what happens to the data from prevBuffer so we set
@@ -979,16 +978,17 @@ private void ParseSection(RebufferableBinaryReader reader)
                     throw new MultipartParseException("Unexpected end of section");
                 }
 
-                // This line parses the header values into a set of key/value pairs. For example:
-                // Content-Disposition: form-data; name="textdata"
-                // ["content-disposition"] = "form-data"
-                // ["name"] = "textdata"
-                // Content-Disposition: form-data; name="file"; filename="data.txt"
-                // ["content-disposition"] = "form-data"
-                // ["name"] = "file"
-                // ["filename"] = "data.txt"
-                // Content-Type: text/plain
-                // ["content-type"] = "text/plain"
+                // This line parses the header values into a set of key/value pairs.
+                // For example:
+                //   Content-Disposition: form-data; name="textdata"
+                //     ["content-disposition"] = "form-data"
+                //     ["name"] = "textdata"
+                //   Content-Disposition: form-data; name="file"; filename="data.txt"
+                //     ["content-disposition"] = "form-data"
+                //     ["name"] = "file"
+                //     ["filename"] = "data.txt"
+                //   Content-Type: text/plain
+                //     ["content-type"] = "text/plain"
                 Dictionary<string, string> values = SplitBySemicolonIgnoringSemicolonsInQuotes(line)
                     .Select(x => x.Split(new[] { ':', '=' }, 2))
 
@@ -1072,16 +1072,17 @@ private async Task ParseSectionAsync(RebufferableBinaryReader reader, Cancellati
                     throw new MultipartParseException("Unexpected end of section");
                 }
 
-                // This line parses the header values into a set of key/value pairs. For example:
-                // Content-Disposition: form-data; name="textdata"
-                // ["content-disposition"] = "form-data"
-                // ["name"] = "textdata"
-                // Content-Disposition: form-data; name="file"; filename="data.txt"
-                // ["content-disposition"] = "form-data"
-                // ["name"] = "file"
-                // ["filename"] = "data.txt"
-                // Content-Type: text/plain
-                // ["content-type"] = "text/plain"
+                // This line parses the header values into a set of key/value pairs.
+                // For example:
+                //   Content-Disposition: form-data; name="textdata"
+                //     ["content-disposition"] = "form-data"
+                //     ["name"] = "textdata"
+                //   Content-Disposition: form-data; name="file"; filename="data.txt"
+                //     ["content-disposition"] = "form-data"
+                //     ["name"] = "file"
+                //     ["filename"] = "data.txt"
+                //   Content-Type: text/plain
+                //     ["content-type"] = "text/plain"
                 Dictionary<string, string> values = SplitBySemicolonIgnoringSemicolonsInQuotes(line)
                     .Select(x => x.Split(new[] { ':', '=' }, 2))
 
diff --git a/build.cake b/build.cake
@@ -5,10 +5,10 @@
 #tool dotnet:?package=BenchmarkDotNet.Tool&version=0.12.0
 
 // Install tools.
-#tool nuget:?package=GitVersion.CommandLine&version=5.1.3
-#tool nuget:?package=GitReleaseManager&version=0.10.3
+#tool nuget:?package=GitVersion.CommandLine&version=5.2.4
+#tool nuget:?package=GitReleaseManager&version=0.11.0
 #tool nuget:?package=OpenCover&version=4.7.922
-#tool nuget:?package=ReportGenerator&version=4.5.0
+#tool nuget:?package=ReportGenerator&version=4.5.2
 #tool nuget:?package=coveralls.io&version=1.4.2
 #tool nuget:?package=xunit.runner.console&version=2.4.1
 

Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@ namespace HttpMultipartParser.UnitTests.ParserScenarios`
`10`	`10`	`/// <summary>`
`11`	`11`	`/// Test case for multiple files with no name.`
`12`	`12`	`/// </summary>`
`13`		`- public class MultipleFilesWithNoName`
	`13`	`+ public class MultipleFilesWithEmptyName`
`14`	`14`	`{`
`15`	`15`	`private static readonly string MultipleFilesSameName_testData = TestUtil.TrimAllLines(@"--boundry`
`16`	`16`	`Content-Disposition: form-data; name="""";filename=""file1.txt"";`
`@@ -39,7 +39,7 @@ This is text file 3 1234567890`
`39`	`39`	`}`
`40`	`40`	`);`
`41`	`41`
`42`		`- public MultipleFilesWithNoName()`
	`42`	`+ public MultipleFilesWithEmptyName()`
`43`	`43`	`{`
`44`	`44`	`}`
`45`	`45`
`@@ -50,7 +50,7 @@ public MultipleFilesWithNoName()`
`50`	`50`	`[Fact]`
`51`	`51`	`public void MultipleFilesWithNoNameTest()`
`52`	`52`	`{`
`53`		`- using (Stream stream = TestUtil.StringToStream(MultipleFilesSameName_testData, Encoding.UTF8))`
	`53`	`+ using (Stream stream = TestUtil.StringToStream(_testCase.Request, Encoding.UTF8))`
`54`	`54`	`{`
`55`	`55`	`var parser = MultipartFormDataParser.Parse(stream, "boundry", Encoding.UTF8, 16);`
`56`	`56`	`Assert.True(_testCase.Validate(parser));`
Original file line number	Diff line number	Diff line change
`@@ -142,10 +142,7 @@ public void Push(byte[] data)`
`142`	`142`	`/// </param>`
`143`	`143`	`public void Push(byte[] data, int offset, int count)`
`144`	`144`	`{`
`145`		`- var stream = Utilities.MemoryStreamManager.GetStream();`
`146`		`- stream.Write(data, offset, count);`
`147`		`- stream.Position = 0;`
`148`		`-`
	`145`	`+ var stream = Utilities.MemoryStreamManager.GetStream($"{typeof(BinaryStreamStack).FullName}.{nameof(Push)}", data, offset, count);`
`149`	`146`	`streams.Push(new BinaryReader(stream, CurrentEncoding));`
`150`	`147`	`}`
`151`	`148`
`@@ -306,7 +303,7 @@ public byte[] ReadByteLine(out bool hitStreamEnd)`
`306`	`303`	`byte[] ignore = CurrentEncoding.GetBytes(new[] { '\r' });`
`307`	`304`	`byte[] search = CurrentEncoding.GetBytes(new[] { '\n' });`
`308`	`305`	`int searchPos = 0;`
`309`		`- using (var builder = Utilities.MemoryStreamManager.GetStream())`
	`306`	`+ using (var builder = Utilities.MemoryStreamManager.GetStream($"{typeof(BinaryStreamStack).FullName}.{nameof(ReadByteLine)}"))`
`310`	`307`	`{`
`311`	`308`	`while (true)`
`312`	`309`	`{`
Original file line number	Diff line number	Diff line change
`@@ -562,7 +562,7 @@ private void ParseStream(Stream stream, string boundary, Encoding encoding, int`
`562`	`562`	`if (partNumber == 0)`
`563`	`563`	`{`
`564`	`564`	`// create file with first partNo`
`565`		`- Files.Add(new FilePart(name, fileName, Utilities.MemoryStreamManager.GetStream(), type, disposition));`
	`565`	`+ Files.Add(new FilePart(name, fileName, Utilities.MemoryStreamManager.GetStream($"{typeof(MultipartFormDataParser).FullName}.{nameof(ParseStream)}"), type, disposition));`
`566`	`566`	`}`
`567`	`567`
`568`	`568`	`Files[Files.Count - 1].Data.Write(buffer, 0, bytes);`
`@@ -607,7 +607,7 @@ private async Task ParseStreamAsync(Stream stream, string boundary, Encoding enc`
`607`	`607`	`if (partNumber == 0)`
`608`	`608`	`{`
`609`	`609`	`// create file with first partNo`
`610`		`- Files.Add(new FilePart(name, fileName, Utilities.MemoryStreamManager.GetStream(), type, disposition));`
	`610`	`+ Files.Add(new FilePart(name, fileName, Utilities.MemoryStreamManager.GetStream($"{typeof(MultipartFormDataParser).FullName}.{nameof(ParseStreamAsync)}"), type, disposition));`
`611`	`611`	`}`
`612`	`612`
`613`	`613`	`Files[Files.Count - 1].Data.Write(buffer, 0, bytes);`
Original file line number	Diff line number	Diff line change
`@@ -265,7 +265,7 @@ public int Read(char[] buffer, int index, int count)`
`265`	`265`	`/// </returns>`
`266`	`266`	`public byte[] ReadByteLine()`
`267`	`267`	`{`
`268`		`- using (var builder = Utilities.MemoryStreamManager.GetStream())`
	`268`	`+ using (var builder = Utilities.MemoryStreamManager.GetStream($"{typeof(RebufferableBinaryReader).FullName}.{nameof(ReadByteLine)}"))`
`269`	`269`	`{`
`270`	`270`	`while (true)`
`271`	`271`	`{`
`@@ -424,7 +424,7 @@ public async Task<int> ReadAsync(char[] buffer, int index, int count, Cancellati`
`424`	`424`	`/// </returns>`
`425`	`425`	`public async Task<byte[]> ReadByteLineAsync(CancellationToken cancellationToken = default)`
`426`	`426`	`{`
`427`		`- using (var builder = Utilities.MemoryStreamManager.GetStream())`
	`427`	`+ using (var builder = Utilities.MemoryStreamManager.GetStream($"{typeof(RebufferableBinaryReader).FullName}.{nameof(ReadByteLineAsync)}"))`
`428`	`428`	`{`
`429`	`429`	`while (true)`
`430`	`430`	`{`