Several very long overdue crash fixes (#95)

* Update package support files (dockerignore, readme, CI workflows)
* Minimal code cleanup - replace `fatalError()`s and `assert()`s with thrown errors, add escapes in comments so Xcode's inline formatting doesn't choke, add `any` to existential usage, other very minor tweaks.
* Fix the "server sends error packet when nothing else is going on causes crash" problem - fixes #87
* Add fix for the bad protocol version bug - fixes #91
* Fix the tests bug that causes problems with the `foos` table still existing when the integration tests for FluentMySQLDriver run.
* Work around weird deadlock on Linux
* Remove many unneeded !s from try!s in tests

Author: gwynne

.dockerignore

@@ -1,5 +1,7 @@
 .git
 .build
+.swiftpm
+.github
 DerivedData
 Package.resolved
 *.xcodeproj

.github/workflows/projectboard.yml

@@ -5,27 +5,7 @@ on:
     types: [reopened, closed, labeled, unlabeled, assigned, unassigned]
 
 jobs:
-  setup_matrix_input:
-    runs-on: ubuntu-latest
-
-    steps:
-      - id: set-matrix 
-        run: |
-          output=$(curl ${{ github.event.issue.url }}/labels | jq '.[] | .name') || output=""
-
-          echo '======================'
-          echo 'Process incoming data'
-          echo '======================'
-          json=$(echo $output | sed 's/"\s"/","/g')
-          echo $json
-          echo "::set-output name=matrix::$(echo $json)"
-    outputs:
-      issueTags: ${{ steps.set-matrix.outputs.matrix }}
-      
-  Manage_project_issues:
-    needs: setup_matrix_input
-    uses: vapor/ci/.github/workflows/issues-to-project-board.yml@main
-    with:
-      labelsJson: ${{ needs.setup_matrix_input.outputs.issueTags }}
-    secrets: 
-      PROJECT_BOARD_AUTOMATION_PAT: "${{ secrets.PROJECT_BOARD_AUTOMATION_PAT }}"
+  update_project_boards:
+    name: Update project boards
+    uses: vapor/ci/.github/workflows/update-project-boards-for-issue.yml@reusable-workflows
+    secrets: inherit

.github/workflows/test.yml

@@ -1,11 +1,12 @@
 name: test
 on:
-  - pull_request
+  pull_request: { types: [opened, reopened, synchronize, ready_for_review] }
+  push: { branches: [ main ] }
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
   cancel-in-progress: true
 env:
-  LOG_LEVEL: debug
+  LOG_LEVEL: into
   SWIFT_DETERMINISTIC_HASHING: 1
   MYSQL_DATABASE: 'test_database'
   MYSQL_DATABASE_A: 'test_database'
@@ -32,19 +33,8 @@ jobs:
       - name: Run API breakage check action
         uses: vapor/ci/.github/actions/ci-swift-check-api-breakage@reusable-workflows
 
-  imports-check:
-    if: ${{ !(github.event.pull_request.draft || false) }}
-    runs-on: ubuntu-latest
-    container: swift:5.8-jammy
-    steps:
-      - name: Check out code
-        uses: actions/checkout@v3
-        with: { 'fetch-depth': 0 }
-      - name: Build with re-export disabled
-        run: swift build -Xswiftc -DBUILDING_DOCC
-
   linux-all:
-    if: ${{ github.event.pull_request.draft == false }}
+    if: ${{ !(github.event.pull_request.draft || false) }}
     strategy:
       fail-fast: false
       matrix:
@@ -84,12 +74,10 @@ jobs:
       - name: Run unit tests
         run: swift test --package-path mysql-nio --enable-code-coverage --sanitize=thread
       - name: Upload code coverage
-        if: ${{ !contains(matrix.swiftver, '5.8') }}
         uses: vapor/[email protected]
-        with: {
-          package_path: 'mysql-nio', cc_flags: 'unittests', cc_verbose: true,
+        with:
+          package_path: 'mysql-nio'
           cc_env_vars: 'SWIFT_VERSION,SWIFT_PLATFORM,RUNNER_OS,RUNNER_ARCH,MYSQL_VERSION'
-        }
       - name: Check out mysql-kit dependent
         uses: actions/checkout@v3
         with: { repository: 'vapor/mysql-kit', path: 'mysql-kit' }
@@ -117,7 +105,7 @@ jobs:
         xcode:
           - latest-stable
         macos:
-          - macos-12
+          - macos-13
         include:
           - username: root
           - dbimage: mariadb
@@ -143,18 +131,16 @@ jobs:
               GRANT ALL PRIVILEGES ON $MYSQL_DATABASE.* TO $MYSQL_USERNAME@localhost;
           SQL
         timeout-minutes: 5
+      - name: Record Swift toolchain and MySQL versions
+        run: |
+          echo "SWIFT_VERSION=$(swift package tools-version --version)" >> "${GITHUB_ENV}"
+          echo 'SWIFT_PLATFORM=${{ matrix.macos }}' >> "${GITHUB_ENV}"
+          echo "MYSQL_VERSION=$(mysql --version)" >> "${GITHUB_ENV}"
       - name: Check out code
         uses: actions/checkout@v3
       - name: Run all tests
-        run: swift test
-
-  test-exports:
-    name: Test exports
-    runs-on: ubuntu-latest
-    steps:
-      - name: Check out Vapor
-        uses: actions/checkout@v3
+        run: swift test --sanitize=thread --enable-code-coverage
+      - name: Upload code coverage
+        uses: vapor/[email protected]
         with:
-          fetch-depth: 0
-      - name: Build
-        run: swift build -Xswiftc -DBUILDING_DOCC
+          cc_env_vars: 'MD_APPLE_SDK_ROOT,SWIFT_VERSION,SWIFT_PLATFORM,RUNNER_OS,RUNNER_ARCH,MYSQL_VERSION'

README.md

@@ -1,50 +1,44 @@
-<img src="https://user-images.githubusercontent.com/1342803/75577086-35280780-5a2f-11ea-8eb2-2044b0310f49.png" height="64" alt="MySQLNIO">
-
-<a href="https://docs.vapor.codes/4.0/">
-    <img src="http://img.shields.io/badge/read_the-docs-2196f3.svg" alt="Documentation">
-</a>
-<a href="https://discord.gg/vapor">
-    <img src="https://img.shields.io/discord/431917998102675485.svg" alt="Team Chat">
-</a>
-<a href="LICENSE">
-    <img src="http://img.shields.io/badge/license-MIT-brightgreen.svg" alt="MIT License">
-</a>
-<a href="https://github.com/vapor/mysql-nio/actions">
-    <img src="https://github.com/vapor/mysql-nio/workflows/test/badge.svg" alt="CI">
-</a>
-<a href="https://swift.org">
-    <img src="http://img.shields.io/badge/swift-5.2-brightgreen.svg" alt="Swift 5.2">
-</a>
-<a href="https://swift.org">
-    <img src="http://img.shields.io/badge/swift-5.5-brightgreen.svg" alt="Swift 5.5">
-</a>
-<br>
+<p align="center">
+    <img src="https://user-images.githubusercontent.com/1342803/75577086-35280780-5a2f-11ea-8eb2-2044b0310f49.png" height="64" alt="MySQLNIO">
+    <br>
+    <br>
+    <a href="https://docs.vapor.codes/4.0/">
+        <img src="http://img.shields.io/badge/read_the-docs-2196f3.svg" alt="Documentation">
+    </a>
+    <a href="https://discord.gg/vapor">
+        <img src="https://img.shields.io/discord/431917998102675485.svg" alt="Team Chat">
+    </a>
+    <a href="LICENSE">
+        <img src="http://img.shields.io/badge/license-MIT-brightgreen.svg" alt="MIT License">
+    </a>
+    <a href="https://github.com/vapor/mysql-nio/actions/workflows/test.yml">
+        <img src="https://github.com/vapor/mysql-nio/actions/workflows/test.yml/badge.svg?event=push" alt="CI">
+    </a>
+    <a href="https://swift.org">
+        <img src="http://img.shields.io/badge/swift-5.6-brightgreen.svg" alt="Swift 5.5">
+    </a>
+</p>
+
 <br>
 
 🐬 Non-blocking, event-driven Swift client for MySQL built on [SwiftNIO](https://github.com/apple/swift-nio).
 
-### Major Releases
-
-The table below shows a list of PostgresNIO major releases alongside their compatible NIO and Swift versions. 
-
-|Version|NIO|Swift|SPM|
-|---|---|---|---|
-|1.0|2.0+|5.2+|`from: "1.0.0"`|
+## Using MySQLNIO
 
-Use the SPM string to easily include the dependendency in your `Package.swift` file.
+Use standard SwiftPM syntax to include MySQLNIO as a dependency in your `Package.swift` file.
 
 ```swift
-.package(url: "https://github.com/vapor/mysql-nio.git", from: ...)
+.package(url: "https://github.com/vapor/mysql-nio.git", from: "1.0.0")
 ```
 
 ### Supported Platforms
 
 MySQLNIO supports the following platforms:
 
-- Ubuntu 16.04, 18.04, 20.04
-- macOS 10.15, 11
-- CentOS 8
-- Amazon Linux 2
+- Ubuntu 20.04+
+- macOS 10.15+
+- iOS 13+
+- tvOS 13+ and watchOS 7+ (experimental)
 
 ## Overview
 
@@ -96,14 +90,14 @@ The first step to making a query is creating a new `MySQLConnection`. The minimu
 ```swift
 import MySQLNIO
 
-let eventLoop: EventLoop = ...
-let conn = try MySQLConnection(
-    to: .makeAddressResolvingHost("my.mysql.server", port: 5432),
+let eventLoop: any EventLoop = ...
+let conn = try await MySQLConnection(
+    to: .makeAddressResolvingHost("my.mysql.server", port: 3306),
     username: "test_username",
     database: "test_database",
     password: "test_password",
     on: eventLoop
-).wait()
+).get()
 ```
 
 Note: These examples will make use of `wait()` for simplicity. This is appropriate if you are using MySQLNIO on the main thread, like for a CLI tool or in tests. However, you should never use `wait()` on an event loop.
@@ -130,7 +124,7 @@ Interaction with a server revolves around the `MySQLDatabase` protocol. This pro
 ```swift
 import MySQLNIO
 
-let db: MySQLDatabase = ...
+let db: any MySQLDatabase = ...
 // now we can use client to do queries
 ```
 
@@ -143,12 +137,12 @@ These queries are most useful for schema or transactional queries, or simple sel
 `simpleQuery` has two overloads, one that returns an array of rows, and one that accepts a closure for handling each row as it is returned.
 
 ```swift
-let rows = try db.simpleQuery("SELECT @@version").wait()
+let rows = try await db.simpleQuery("SELECT @@version").get()
 print(rows) // [["@@version": "8.x.x"]]
 
-try db.simpleQuery("SELECT @@version") { row in
+try await db.simpleQuery("SELECT @@version") { row in
     print(row) // ["@@version": "8.x.x"]
-}.wait()
+}.get()
 ```
 
 ### Parameterized Query
@@ -160,20 +154,20 @@ These queries are most useful for selecting, inserting, and updating data. Data
 Just like `simpleQuery`, `query` also offers two overloads. One that returns an array of rows, and one that accepts a closure for handling each row as it is returned.
 
 ```swift
-let rows = try db.query("SELECT * FROM planets WHERE name = ?", ["Earth"]).wait()
+let rows = try await db.query("SELECT * FROM planets WHERE name = ?", ["Earth"]).get()
 print(rows) // [["id": 42, "name": "Earth"]]
 
-try db.query("SELECT * FROM planets WHERE name = ?", ["Earth"]) { row in
+try await db.query("SELECT * FROM planets WHERE name = ?", ["Earth"]) { row in
     print(row) // ["id": 42, "name": "Earth"]
-}.wait()
+}.get()
 ```
 
 ### Rows and Data
 
 Both `simpleQuery` and `query` return the same `MySQLRow` type. Columns can be fetched from the row using the `column(_:table:)` method.
 
 ```swift
-let row: MySQLRow = ...
+let row: any MySQLRow = ...
 let version = row.column("name")
 print(version) // MySQLData?
 ```

Sources/MySQLNIO/Exports.swift

@@ -1,4 +1,13 @@
-#if !BUILDING_DOCC
+#if swift(>=5.8)
+
+@_documentation(visibility: internal) @_exported import NIO
+@_documentation(visibility: internal) @_exported import struct Logging.Logger
+@_documentation(visibility: internal) @_exported import struct NIOSSL.TLSConfiguration
+@_documentation(visibility: internal) @_exported import struct Foundation.Date
+@_documentation(visibility: internal) @_exported import struct Foundation.UUID
+@_documentation(visibility: internal) @_exported import struct Foundation.Decimal
+
+#else
 
 @_exported import NIO
 @_exported import struct Logging.Logger

Sources/MySQLNIO/MySQLConnection.swift

@@ -12,7 +12,7 @@ public final class MySQLConnection: MySQLDatabase {
         tlsConfiguration: TLSConfiguration? = .makeClientConfiguration(),
         serverHostname: String? = nil,
         logger: Logger = .init(label: "codes.vapor.mysql"),
-        on eventLoop: EventLoop
+        on eventLoop: any EventLoop
     ) -> EventLoopFuture<MySQLConnection> {
         let bootstrap = ClientBootstrap(group: eventLoop)
             .channelOption(ChannelOptions.socket(SocketOptionLevel(SOL_SOCKET), SO_REUSEADDR), value: 1)
@@ -49,19 +49,19 @@ public final class MySQLConnection: MySQLDatabase {
         }
     }
 
-    public let channel: Channel
+    public let channel: any Channel
 
-    public var eventLoop: EventLoop {
-        return self.channel.eventLoop
+    public var eventLoop: any EventLoop {
+        self.channel.eventLoop
     }
 
     public let logger: Logger
 
     public var isClosed: Bool {
-        return !self.channel.isActive
+        !self.channel.isActive
     }
 
-    internal init(channel: Channel, logger: Logger) {
+    internal init(channel: any Channel, logger: Logger) {
         self.channel = channel
         self.logger = logger
     }
@@ -73,7 +73,7 @@ public final class MySQLConnection: MySQLDatabase {
         return self.channel.close(mode: .all)
     }
 
-    public func send(_ command: MySQLCommand, logger: Logger) -> EventLoopFuture<Void> {
+    public func send(_ command: any MySQLCommand, logger: Logger) -> EventLoopFuture<Void> {
         guard self.channel.isActive else {
             return self.channel.eventLoop.makeFailedFuture(MySQLError.closed)
         }
@@ -102,7 +102,7 @@ final class ErrorHandler: ChannelInboundHandler {
 
     init() { }
 
-    func errorCaught(context: ChannelHandlerContext, error: Error) {
+    func errorCaught(context: ChannelHandlerContext, error: any Error) {
         assertionFailure("uncaught error: \(error)")
     }
 }

Sources/MySQLNIO/MySQLConnectionHandler.swift

@@ -3,7 +3,7 @@ import NIOCore
 import Logging
 
 internal struct MySQLCommandContext {
-    var handler: MySQLCommand
+    var handler: any MySQLCommand
     var promise: EventLoopPromise<Void>
 }
 
@@ -88,15 +88,29 @@ final class MySQLConnectionHandler: ChannelDuplexHandler {
                     self.sendEnqueuedCommandIfReady(context: context)
                 }
             } else {
-                assertionFailure("unhandled packet: \(packet.payload.debugDescription)")
+                if packet.isError, let errorPacket = try? packet.decode(MySQLProtocol.ERR_Packet.self, capabilities: serverCapabilities ?? .init()) {
+                    self.errorCaught(context: context, error: MySQLError.server(errorPacket))
+                    self.close(context: context, mode: .all, promise: nil)
+                } else {
+                    self.errorCaught(context: context, error: MySQLError.protocolError)
+                    context.close(mode: .all, promise: nil) // Don't send a COM_QUIT, this is a protocol error anyway
+                }
             }
         }
     }
 
     func handleHandshake(context: ChannelHandlerContext, packet: inout MySQLPacket, state: HandshakeState) throws {
+        // https://github.com/vapor/mysql-nio/issues/91
+        guard !packet.isError else {
+            let errorPacket = try packet.decode(MySQLProtocol.ERR_Packet.self, capabilities: [])
+            self.logger.trace("Received early server error before handshake: \(errorPacket)")
+            throw MySQLError.server(errorPacket)
+        }
         let handshakeRequest = try packet.decode(MySQLProtocol.HandshakeV10.self, capabilities: [])
         self.logger.trace("Handling MySQL handshake \(handshakeRequest)")
-        assert(handshakeRequest.capabilities.contains(.CLIENT_PROTOCOL_41), "Client protocol 4.1 required")
+        guard handshakeRequest.capabilities.contains(.CLIENT_PROTOCOL_41) else {
+            throw MySQLError.unsupportedServer(message: "Client protocol 4.1 required")
+        }
         self.serverCapabilities = handshakeRequest.capabilities
         if let tlsConfiguration = state.tlsConfiguration, handshakeRequest.capabilities.contains(.CLIENT_SSL) {
             var capabilities = MySQLProtocol.CapabilityFlags.clientDefault
@@ -453,7 +467,7 @@ final class MySQLConnectionHandler: ChannelDuplexHandler {
                     case .uncleanShutdown = sslError,
                     self.queue.isEmpty
                 {
-                    // we can ignore unclear shutdown errors
+                    // we can ignore unclean shutdown errors
                     // since no requests are pending
                     promise.succeed(())
                 } else {