Merge pull request #3 from vapor/form-data-bug

Repro: parsing multiple fields give corrupted results

Author: tanner0101

.gitignore

@@ -2,4 +2,5 @@ Packages
 .build
 .DS_Store
 *.xcodeproj
+Package.pins
 

Sources/FormData/ContentDispositionParser.swift

@@ -1,9 +1,7 @@
 import Core
 
-/**
-    Parses `Content-Disposition` header values for
-    form-data encoded messages.
-*/
+/// Parses `Content-Disposition` header values for
+/// form-data encoded messages.
 final class ContentDispositionParser {
     /// Key types expected in the content disposition.
     enum Key {
@@ -29,15 +27,13 @@ final class ContentDispositionParser {
         self.state = .none
     }
 
-    /**
-        Parse a stream of bytes by iterating over each byte
-        and calling `parse()`.
-
-        After each byte, check the `state` of the header parser.
-        - finished: a full key/value pair has been found.
-        - parsingPrefix/Key/Value: the parser is currently parsing values.
-        - none: parser has not yet received bytes.
-    */
+    /// Parse a stream of bytes by iterating over each byte
+    /// and calling `parse()`.
+    ///
+    /// After each byte, check the `state` of the header parser.
+    /// - finished: a full key/value pair has been found.
+    /// - parsingPrefix/Key/Value: the parser is currently parsing values.
+    /// - none: parser has not yet received bytes.
     func parse(_ byte: Byte) {
         main: switch state {
         case .none:

Sources/FormData/Field.swift

@@ -1,11 +1,9 @@
 import Multipart
 
-/**
-    A single form-data field with the field name,
-    optional filename, and underlying Multipart.Part.
- 
-    Headers and body reside in the Part.
-*/
+/// A single form-data field with the field name,
+/// optional filename, and underlying Multipart.Part.
+///
+/// Headers and body reside in the Part.
 public struct Field {
     public var name: String
     public var filename: String?

Sources/FormData/Parser.swift

@@ -2,11 +2,9 @@ import Core
 import Multipart
 import HTTP
 
-/**
-    Parses form-data specific elements from
-    multipart data parsed by an underlying multipart
-    parser.
-*/
+/// Parses form-data specific elements from
+/// multipart data parsed by an underlying multipart
+/// parser.
 public final class Parser {
     /// The underlying multipart parser.
     /// Subscribe to preamble and epilogue events.

Sources/FormData/Serializer.swift

@@ -1,10 +1,8 @@
 import Core
 import Multipart
 
-/**
-    Creates a multipart/form-data formatted array of bytes from Fields
-    suitable for an HTTP response or request body.
- */
+/// Creates a multipart/form-data formatted array of bytes from Fields
+/// suitable for an HTTP response or request body.
 public final class Serializer {
 
     /// The underlying multipart serializer.
@@ -15,18 +13,16 @@ public final class Serializer {
         self.multipart = multipart
     }
 
-    /**
-        This method serializes an entire Field.
-
-        This may be called as many times as needed.
-
-        After all Field have been serialized,
-        `finish()` must be called on the multipart serializer
-        to add the closing boundary.
-
-        Fields can obviously not be serialized after the
-        epilogue has been serialized.
-    */
+    /// This method serializes an entire Field.
+    ///
+    /// This may be called as many times as needed.
+    ///
+    /// After all Field have been serialized,
+    /// `finish()` must be called on the multipart serializer
+    /// to add the closing boundary.
+    ///
+    /// Fields can obviously not be serialized after the
+    /// epilogue has been serialized.
     public func serialize(_ field: Field) throws {
         var part = field.part
 

Sources/Multipart/BoundaryParser.swift

@@ -1,10 +1,8 @@
 import Core
 
-/**
-    Attempts to parse a supplied boundary out of a stream of bytes.
- 
-    Pass a stream of bytes into to the parser by continually calling `parse()`.
-*/
+/// Attempts to parse a supplied boundary out of a stream of bytes.
+///
+/// Pass a stream of bytes into to the parser by continually calling `parse()`.
 final class BoundaryParser {
     // An enum representing all possible states the parser can be in.
     enum State {
@@ -26,16 +24,14 @@ final class BoundaryParser {
         self.state = .none
     }
 
-    /**
-        Parse a stream of bytes by iterating over each byte
-        and calling `parse()`.
-     
-        After each byte, check the `state` of the boundary parser.
-        - finished: a boundary was found!
-        - parsing: the parser may have found a boundary, do not buffer bytes.
-        - invalid: what looked like a boundary is not. reclaim the skipped bytes.
-        - none: no boundary detected, continue buffering the bytes.
-    */
+    /// Parse a stream of bytes by iterating over each byte
+    /// and calling `parse()`.
+    ///
+    /// After each byte, check the `state` of the boundary parser.
+    /// - finished: a boundary was found!
+    /// - parsing: the parser may have found a boundary, do not buffer bytes.
+    /// - invalid: what looked like a boundary is not. reclaim the skipped bytes.
+    /// - none: no boundary detected, continue buffering the bytes.
     func parse(_ byte: Byte) throws {
         main: switch state {
         case .none:

Sources/Multipart/HeaderParser.swift

@@ -1,10 +1,8 @@
 import Core
 
-/**
-    Parses headers from the top of an HTTP-style message.
- 
-    Pass a stream of bytes into the parser by continually calling `parse()`.
-*/
+/// Parses headers from the top of an HTTP-style message.
+///
+/// Pass a stream of bytes into the parser by continually calling `parse()`.
 final class HeaderParser {
     // An enum representing all possible states the parser can be in.
     enum State {
@@ -22,15 +20,13 @@ final class HeaderParser {
         self.state = .none
     }
 
-    /**
-        Parse a stream of bytes by iterating over each byte
-        and calling `parse()`.
-
-        After each byte, check the `state` of the header parser.
-        - finished: a full header has been found, hold onto the key and value.
-        - parsingKey/Value: the parser is currently gathering the header.
-        - none: parser has not yet received bytes.
-    */
+    /// Parse a stream of bytes by iterating over each byte
+    /// and calling `parse()`.
+    ///
+    /// After each byte, check the `state` of the header parser.
+    /// - finished: a full header has been found, hold onto the key and value.
+    /// - parsingKey/Value: the parser is currently gathering the header.
+    /// - none: parser has not yet received bytes.
     func parse(_ byte: Byte) throws {
         main: switch state {
         case .none:

Sources/Multipart/Parser.swift

@@ -2,10 +2,8 @@ import Core
 import HTTP
 import Foundation
 
-/**
-    Parses preamble, Parts, and epilogue from a Multipart 
-    formatted sequence of bytes likely from an HTTP request or response.
-*/
+/// Parses preamble, Parts, and epilogue from a Multipart
+/// formatted sequence of bytes likely from an HTTP request or response.
 public final class Parser {
     /// The multipart boundary being used.
 	public let boundary: Bytes
@@ -95,16 +93,14 @@ public final class Parser {
     // need to be passed around.
     private var buffer: Bytes
 
-    /**
-        The main method for passing bytes into the parser.
-     
-        A copy is performed to move the bytes passed into
-        the parser's internal memory. The bytes are then
-        iterated over one by one.
-     
-        Callbacks will be made as the preamble, Parts, and
-        epilogue are discovered.
-    */
+    /// The main method for passing bytes into the parser.
+    ///
+    /// A copy is performed to move the bytes passed into
+    /// the parser's internal memory. The bytes are then
+    /// iterated over one by one.
+    ///
+    /// Callbacks will be made as the preamble, Parts, and
+    /// epilogue are discovered.
     public func parse(_ bytes: Bytes) throws {
         buffer += bytes
 
@@ -114,13 +110,11 @@ public final class Parser {
         }
     }
 
-    /**
-        Call this method when there are no bytes
-        left to parse.
-     
-        This will trigger any parsed epilogue bytes
-        to be returned.
-    */
+    /// Call this method when there are no bytes
+    /// left to parse.
+    ///
+    /// This will trigger any parsed epilogue bytes
+    /// to be returned.
     public func finish() throws {
         guard !hasFinished else {
             throw Error.hasAlreadyFinished
@@ -231,8 +225,9 @@ public final class Parser {
 
                     let raw = Array(buffer[0..<bodyEndIndex])
                     let body = Array(raw.trimmed([.newLine, .carriageReturn]))
-                    
-                    let pos = bodyEndIndex + boundarySize
+
+                    //                                    newline
+                    let pos = bodyEndIndex + boundarySize + 1
                     if pos > buffer.count {
                         buffer = []
                     } else {

Sources/Multipart/Part.swift

@@ -1,10 +1,8 @@
 import Core
 import HTTP
 
-/**
-    A single Multipart part with 0 or more
-    headers and a body.
-*/
+/// A single Multipart part with 0 or more
+/// headers and a body.
 public struct Part {
     public var headers: [HeaderKey: String]
     public var body: Bytes

Sources/Multipart/Serializer.swift

@@ -2,10 +2,8 @@ import Core
 
 private let crlf: Bytes = [.carriageReturn, .newLine]
 
-/**
-    Creates a multipart formatted array of bytes from Parts
-    suitable for an HTTP response or request body.
-*/
+/// Creates a multipart formatted array of bytes from Parts
+/// suitable for an HTTP response or request body.
 public final class Serializer {
     /// The multipart boundary being used.
     public let boundary: Bytes
@@ -28,15 +26,13 @@ public final class Serializer {
         case epilogueAlreadySerialized
     }
 
-    /**
-        Call this method to add bytes to the preamble.
-     
-        This is equivalent to simply prepending bytes
-        to the beginning of the serialized data.
-     
-        Preamble can obviously not be serialized after
-        parts or the epilogue have been serialized.
-    */
+    /// Call this method to add bytes to the preamble.
+    ///
+    /// This is equivalent to simply prepending bytes
+    /// to the beginning of the serialized data.
+    ///
+    /// Preamble can obviously not be serialized after
+    /// parts or the epilogue have been serialized.
     public func serialize(preamble: Bytes) throws {
         guard !partsSerialized else {
             throw Error.partsAlreadySerialized
@@ -45,17 +41,15 @@ public final class Serializer {
         serialize(preamble)
     }
 
-    /**
-        This method serializes an entire Part.
-     
-        This may be called as many times as needed.
-        
-        After all Parts have been serialized,
-        `finish()` must be called to add the closing boundary.
-     
-        Parts can obviously not be serialized after the
-        epilogue has been serialized.
-    */
+    /// This method serializes an entire Part.
+    ///
+    /// This may be called as many times as needed.
+    ///
+    /// After all Parts have been serialized,
+    /// `finish()` must be called to add the closing boundary.
+    ///
+    /// Parts can obviously not be serialized after the
+    /// epilogue has been serialized.
     public func serialize(_ part: Part) throws {
         guard !epilogueSerialized else {
             throw Error.epilogueAlreadySerialized
@@ -79,14 +73,12 @@ public final class Serializer {
         partsSerialized = true
     }
 
-    /**
-        This method serializes the closing boundary.
-     
-        No parts or preamble can be serialized after this
-        method is called.
-     
-        This method must be called to complete the serialized data.
-    */
+    /// This method serializes the closing boundary.
+    ///
+    /// No parts or preamble can be serialized after this
+    /// method is called.
+    ///
+    /// This method must be called to complete the serialized data.
     public func finish(epilogue: Bytes = []) throws {
         guard !epilogueSerialized else {
             throw Error.epilogueAlreadySerialized