Merge pull request #179 from vapor/deprecate-eof

fix deprecated EOF support for MySQL 5.5 and 5.6

Author: tanner0101

Sources/MySQL/Connection/MySQLConnection+Query.swift

@@ -12,7 +12,7 @@ extension MySQLConnection {
         var rows: [[MySQLColumn: MySQLData]] = []
         return self.query(query) { row in
             rows.append(row)
-        }.map(to: [[MySQLColumn: MySQLData]].self) {
+        }.map {
             return rows
         }
     }

Sources/MySQL/Connection/MySQLConnection.swift

@@ -67,16 +67,17 @@ public final class MySQLConnection: BasicWorker, DatabaseConnection {
 
     /// Sends `MySQLPacket` to the server.
     internal func send(_ messages: [MySQLPacket], onResponse: @escaping (MySQLPacket) throws -> Bool) -> Future<Void> {
+        // if the connection is closed, fail immidiately
+        guard !isClosed else {
+            return eventLoop.newFailedFuture(error: closeError)
+        }
+        
         // if currentSend is not nil, previous send has not completed
         assert(currentSend == nil, "Attempting to call `send(...)` again before previous invocation has completed.")
         switch handler.state {
         case .waiting: break
         default: assertionFailure("Attempting to call `send(...)` while handler is still: \(handler.state).")
         }
-        // if the connection is closed, fail immidiately
-        guard !isClosed else {
-            return eventLoop.newFailedFuture(error: closeError)
-        }
 
         // create a new promise and store it
         let promise = eventLoop.newPromise(Void.self)

Sources/MySQL/Connection/MySQLConnectionHandler.swift

@@ -149,8 +149,16 @@ final class MySQLConnectionHandler: ChannelInboundHandler {
     }
 
     func errorCaught(ctx: ChannelHandlerContext, error: Error) {
-        readyForQuery?.fail(error: error)
-        readyForQuery = nil
+        switch state {
+        case .nascent:
+            readyForQuery?.fail(error: error)
+            readyForQuery = nil
+        case .callback(let promise, _):
+            self.state = .waiting
+            promise.fail(error: error)
+        case .waiting:
+            ERROR("Error while waiting: \(error).")
+        }
     }
 
     /// Ask the server if it supports SSL and adds a new OpenSSLClientHandler to pipeline if it does

Sources/MySQL/Pipeline/MySQLPacketDecoder.swift

@@ -232,6 +232,13 @@ final class MySQLPacketDecoder: ByteToMessageDecoder {
             remaining -= 1
             if remaining == 0 {
                 session.connectionState = .statement(.paramsDone(ok: ok))
+                if !capabilities.contains(.CLIENT_DEPRECATE_EOF) {
+                    let res = try decodeBasicPacket(ctx: ctx, buffer: &buffer, capabilities: capabilities, forwarding: false)
+                    switch res {
+                    case .needMoreData: return .needMoreData
+                    default: break
+                    }
+                }
             } else {
                 session.connectionState = .statement(.params(ok: ok, remaining: remaining))
             }
@@ -242,10 +249,6 @@ final class MySQLPacketDecoder: ByteToMessageDecoder {
             } else {
                 session.connectionState = .statement(.columnsDone)
             }
-
-            if !capabilities.contains(.CLIENT_DEPRECATE_EOF) {
-                return try decodeBasicPacket(ctx: ctx, buffer: &buffer, capabilities: capabilities, forwarding: false)
-            }
         case .columns(var remaining):
             guard let _ = try buffer.checkPacketLength(source: .capture()) else {
                 return .needMoreData
@@ -257,15 +260,19 @@ final class MySQLPacketDecoder: ByteToMessageDecoder {
             remaining -= 1
             if remaining == 0 {
                 session.connectionState = .statement(.columnsDone)
+                if !capabilities.contains(.CLIENT_DEPRECATE_EOF) {
+                    let res = try decodeBasicPacket(ctx: ctx, buffer: &buffer, capabilities: capabilities, forwarding: false)
+                    switch res {
+                    case .needMoreData: return .needMoreData
+                    default: break
+                    }
+                }
             } else {
                 session.connectionState = .statement(.columns(remaining: remaining))
             }
 
             ctx.fireChannelRead(wrapInboundOut(.columnDefinition41(column)))
-        case .columnsDone:
-            if !capabilities.contains(.CLIENT_DEPRECATE_EOF) {
-                return try decodeBasicPacket(ctx: ctx, buffer: &buffer, capabilities: capabilities, forwarding: false)
-            }
+        case .columnsDone: break
         case .waitingExecute:
             // check for error or OK packet
             let peek = buffer.peekInteger(as: Byte.self, skipping: 4)

Tests/MySQLTests/MySQLTests.swift

@@ -19,6 +19,7 @@ class MySQLTests: XCTestCase {
             "hello".convertToMySQLData(),
             "world".convertToMySQLData()
         ])).wait()
+        print(results)
         try XCTAssertEqual(results[0].firstValue(forColumn: "test")?.decode(String.self), "helloworld")
         print(results)
     }

circle.yml

@@ -1,21 +1,6 @@
 version: 2
 
 jobs:
-
-
-  macos:
-    macos:
-      xcode: "9.2"
-    steps:
-      - run: brew install mysql
-      - run: brew services start mysql
-      - run: sleep 3 && mysqladmin -uroot create test
-      - checkout
-      - run: swift build
-      - run: echo "CREATE DATABASE vapor_test" | mysql -uroot
-      # - run: swift build -c release
-      - run: swift test
-
   5.5-linux:
     docker:
       - image: codevapor/swift:4.1
@@ -34,7 +19,24 @@ jobs:
       - run: 
           name: Run unit tests
           command: swift test
-
+  5.6-linux:
+    docker:
+      - image: codevapor/swift:4.1
+      - image: mysql:5.6
+        environment:
+          MYSQL_ALLOW_EMPTY_PASSWORD: true
+          MYSQL_DATABASE: vapor_database
+          # MYSQL_ROOT_HOST: %
+          MYSQL_USER: vapor_username
+          MYSQL_PASSWORD: vapor_password
+    steps:
+      - checkout
+      - run: 
+          name: Compile code
+          command: swift build
+      - run: 
+          name: Run unit tests
+          command: swift test
   5.7-linux:
     docker:
       - image: codevapor/swift:4.1
@@ -53,7 +55,6 @@ jobs:
       - run: 
           name: Run unit tests
           command: swift test
-
   8.0-linux:
     docker:
       - image: codevapor/swift:4.1
@@ -72,7 +73,6 @@ jobs:
       - run: 
           name: Run unit tests
           command: swift test -Xswiftc -DSSL_TESTS
-
   mariadb-10.3-linux:
     docker:
       - image: codevapor/swift:4.1
@@ -91,7 +91,6 @@ jobs:
       - run: 
           name: Run unit tests
           command: swift test
-
   8.0-linux-fluent:
     docker:
       - image: codevapor/swift:4.1
@@ -104,7 +103,7 @@ jobs:
     steps:
       - run:
           name: Clone Fluent MySQL
-          command: git clone -b gm https://github.com/vapor/fluent-mysql.git
+          command: git clone -b master https://github.com/vapor/fluent-mysql.git
           working_directory: ~/
       - run:
           name: Switch Fluent MySQL to this MySQL revision
@@ -114,7 +113,6 @@ jobs:
           name: Run Fluent MySQL unit tests
           command: swift test
           working_directory: ~/fluent-mysql
-
   linux-release:
     docker:
       - image: codevapor/swift:4.1
@@ -123,29 +121,24 @@ jobs:
       - run: 
           name: Compile code with optimizations
           command: swift build -c release
-
-
 workflows:
   version: 2
   tests:
     jobs:
-     # - macos
-     # - 5.5-linux
+      - 5.5-linux
+      - 5.6-linux
       - 5.7-linux
       - 8.0-linux
       - 8.0-linux-fluent
       - mariadb-10.3-linux
       - linux-release
-
   nightly:
     triggers:
       - schedule:
           cron: "0 0 * * *"
           filters:
             branches:
               only:
-                - master
-                
+                - master 
     jobs:
       - 8.0-linux
-      # - macos

docker-compose.yml

@@ -19,3 +19,21 @@ services:
       MYSQL_PASSWORD: vapor_password
     ports:
       - 3306:3306
+  mysql-56:
+    image: mysql:5.6
+    environment:
+      MYSQL_ALLOW_EMPTY_PASSWORD: "true"
+      MYSQL_DATABASE: vapor_database
+      MYSQL_USER: vapor_username
+      MYSQL_PASSWORD: vapor_password
+    ports:
+      - 3306:3306
+  mysql-55:
+    image: mysql:5.5
+    environment:
+      MYSQL_ALLOW_EMPTY_PASSWORD: "true"
+      MYSQL_DATABASE: vapor_database
+      MYSQL_USER: vapor_username
+      MYSQL_PASSWORD: vapor_password
+    ports:
+      - 3306:3306