PostgresNIO 1.19.0

What is better than one PostgresConnection? Multiple PostgresConnections! This is why PostgresNIO now features an experimental
PostgresClient that is backed by a new ConnectionPool implementation.

The new PostgresClient and its underlying ConnectionPool implementation are large new features that are in an early experimental stage. We encourage PostgresNIO users to try them and provide feedback. The implementation is so new, and the feature scope so large, that we don't make any API stability promises for PostgresClient yet; it is therefore exposed as an SPI import.

If you want to start playing with the new PostgresClient, start with a pattern like this:

@_spi(ConnectionPool) import PostgresNIO

let client = PostgresClient(configuration: configuration, logger: logger)
await withTaskGroup(of: Void.self) {
  taskGroup.addTask {
    // 🚨 The PostgresClient only works if its `run()` method is executed in a long-running task.
    // This ensures that all background work shall be executed in a way that plays 
    // nicely with structured concurrency.
    client.run()
  }

  taskGroup.addTask {
    client.withConnection { connection in
      do {
        let rows = try await connection.query("SELECT userID, name, age FROM users;")
        for try await (userID, name, age) in rows.decode((UUID, String, Int).self) {
          // do something with the values
        }
      } catch {
        // handle errors
      }
    }
  }
}

We are currently working with the ServiceLifecycle maintainers to enable simple integration (however, we do not intend to depend on ServiceLifecycle directly).

If you run into any problems, please open a new Issue.

SPI(ConnectionPool) changes

• Add new ConnectionPoolModule, PostgresClient (#412, #416, #417, #418, #419, #420, #421, #422, #424, #425, #426, #427, #428, #429, #430)

SemVer Minor

• Fix PostgresDecodable inference for RawRepresentable enums (#423, patch credit to @MahdiBM)
• Remove warn-concurrency warnings (#408)
• Update minimum Swift requirement to 5.7 (#414)

Other Changes

• Update SSWG Graduation Level (#409)

PostgresNIO 1.18.1

PostgresNIO 1.18.0 introduced an issue that could lead to Segmentation faults when using the Swift 5.8 compiler. This patch works around the underlying Swift compiler bug.

SemVer Patch

• Fix Segmentation faults in Swift 5.8 (#406)

Other Changes

• Improve the logo image used by the DocC catalog (#404)

PostgresNIO 1.18.0

🚀 This PostgresNIO release adds a number of changes that allow users to fully embrace structured concurrency:

1. Prepared statement async/await support
2. Notification listen async/await support
3. Users don't need to provide EventLoops when creating a connection

🚨 This release changes the behavior of PostgresConnection.close(). Before this release a call to close() triggered a graceful shutdown of the connection. This means that all previously enqueued queries got executed before the connection was closed. Starting with 1.18.0 close() leads to a direct connection closure cancelling the running and all queued queries. This change is necessary to get rid of connections to servers where the server stopped responding. The previous behavior can be achieved using the new closeGracefully() function on PostgresConnection.

SemVer Minor

• Add async listen; Refactor all listen code (#264, #392)
• Add PostgresDynamicTypeThrowingEncodable and PostgresDynamicTypeEncodable (#365, patch credit to @marius-se)
• Use EventLoop provided by SwiftNIO's MultiThreadedEventLoopGroup.singleton (#389, patch credit to @tkrajacic)
• async/await prepared statement API (#390, patch credit to @mariosangiorgio)
• close() closes immediately; Add new closeGracefully() (#383, #397, #400)

SemVer Patch

• Use variadic generics in Swift 5.9 (#341)
• Crash fix: Multiple bad messages could trigger reentrancy issue (#379)
• Move PostgresFrontendMessage to tests (#381, #395, #399)
• PostgresBackendMessage.ID should be backed by UInt8 directly (#386)
• Remove PrepareStatementStateMachine (#391)
• Fix a few inaccurate or confusing precondition failure messages (#398)

Other Changes

• Fix multiple warnings generated by the documentation build (#378)
• Typo: Storiage -> Storage (#387)
• Use README header image compatible with light/dark mode (#393)

PostgresNIO 1.17.0

SemVer Minor

• Ensure PostgresConnection.Configuration.TLS is concurrency safe by making property disable computed (#376, patch credit to @sidepelican)

New Contributors

• @sidepelican made their first contribution in #376

PostgresNIO 1.16.0

Semver Minor

• Add many, many missing types to PostgresDataType (#371)
• Add PSQLError debugDescription (#372)

Full Changelog: 1.15.0...1.16.0

PostgresNIO 1.15.0

SemVer Minor

• Make PostgresCodable typealias public (#363)
• Add support for int4range, int8range, int4range[], int8range[] (#330 by @rausnitz)

SemVer Patch

• Decode .bpchar as String (#368)
• Rename generic type from B to Bound in PostgresRange (#367)

Other Changes

• Various cleanups to CI (#359, #362, #369)
• Add testSelectActiveConnection test (#364)
• Add Postgres 15 to docker compose (#366 by @marius-se)

New Contributors

• @marius-se made their first contribution in #366

Full Changelog: 1.14.2...1.15.0

PostgresNIO 1.14.2

Address CVE-2023-31136 - PostgresNIO processes unencrypted bytes from man-in-the-middle. See the CVE-2023-31136 security advisory for details.

Thanks to PostgreSQL's Tom Lane <tgl@sss.pgh.pa.us> for reporting this issue!

PostgresNIO 1.14.1

SemVer Patch

• Use #fileID and #filePath instead of #file (#348, #355)
• Fix crash in row streams that are cancelled and timeout (#347, #351, #353)
• Add PostgresRow decoding tests, reformat Package.swift (#346)

Other Changes

• Update README (#344, #345)

Full Changelog: 1.14.0...1.14.1

PostgresNIO 1.14.0

SemVer Minor

• Make PostgresBindings.append(PostgresData) public (#332)
• Drop support for Swift 5.5 (#336)
• Mark RowDescription.Column (#338)
• Make PSQLError public (#342)
• Deprecating PostgresDataConvertible, PostgresMessageType (#313)
• Add support for UDS and existing Channels (#335)

SemVer Patch

• Require new swift-nio versions (#343)

Other changes

• Update CI in preparation for bumping to 5.6 min version (#337)

Full Changelog: 1.13.0...1.14.0

PostgresNIO 1.13.0

SemVer Minor

• Add new protocol PostgresNonThrowingEncodable (#322)
• PostgresQuery and PostgresBindings should be Sendable (#328)
• Make Decodable autoconformance to PostgresDecodable public (#331 by @jtouzy)

SemVer Patch

• Use NIOFoundationCompat for UUID <-> ByteBuffer (#319)
• PostgresCodable should be a typealias (#321)
• Fix en- and decoding of NULL values in arrays (#324 by @ehpi)

Other Changes

• Update SPI info to point to our hosted docs (#325)
• Update API Docs Workflow (#329)

New Contributors

• @ehpi made their first contribution in #324
• @jtouzy made their first contribution in #331

Full Changelog: 1.12.1...1.13.0