Skip to content

Warn about deprecation of old config methods instead of breaking existing code #212

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 11, 2023
Merged

Warn about deprecation of old config methods instead of breaking existing code #212

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bae9140
Yield deprecation warnings (instead of compiler errors) for previousl…
gwynne May 11, 2023
cb39774
API breakage checker is basically a joke with this package.
gwynne May 11, 2023
034271f
Fix typos
gwynne May 11, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions .api-breakage/allowlist-branch-fix-deprecations.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
API breakage: func DatabaseConfigurationFactory.postgres(configuration:maxConnectionsPerEventLoop:connectionPoolTimeout:encodingContext:decodingContext:sqlLogLevel:) has removed default argument from parameter 3
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't this file be passed to the api-breakage CI using the --breakage-allowlist-path flag (or i see there is an option for it in the reusable CI) ?

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Or at second glance, i think you've made the re-useable CI default to this path, so this should be no issue.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The reusable breakage check option looks for a file named for the branch being checked

API breakage: func DatabaseConfigurationFactory.postgres(configuration:maxConnectionsPerEventLoop:connectionPoolTimeout:encodingContext:decodingContext:sqlLogLevel:) has removed default argument from parameter 4
API breakage: func DatabaseConfigurationFactory.postgres(hostname:port:username:password:database:tlsConfiguration:maxConnectionsPerEventLoop:connectionPoolTimeout:sqlLogLevel:) has parameter 0 type change from Swift.String to PostgresKit.SQLPostgresConfiguration
API breakage: func DatabaseConfigurationFactory.postgres(hostname:port:username:password:database:tlsConfiguration:maxConnectionsPerEventLoop:connectionPoolTimeout:sqlLogLevel:) has parameter 2 type change from Swift.String to NIOCore.TimeAmount
API breakage: func DatabaseConfigurationFactory.postgres(hostname:port:username:password:database:tlsConfiguration:maxConnectionsPerEventLoop:connectionPoolTimeout:sqlLogLevel:) has parameter 3 type change from Swift.String to Logging.Logger.Level
API breakage: func DatabaseConfigurationFactory.postgres(hostname:port:username:password:database:tlsConfiguration:maxConnectionsPerEventLoop:connectionPoolTimeout:encoder:sqlLogLevel:) has parameter 0 type change from Swift.String to PostgresKit.SQLPostgresConfiguration
API breakage: func DatabaseConfigurationFactory.postgres(hostname:port:username:password:database:tlsConfiguration:maxConnectionsPerEventLoop:connectionPoolTimeout:encoder:sqlLogLevel:) has parameter 2 type change from Swift.String to NIOCore.TimeAmount
API breakage: func DatabaseConfigurationFactory.postgres(hostname:port:username:password:database:tlsConfiguration:maxConnectionsPerEventLoop:connectionPoolTimeout:encoder:sqlLogLevel:) has parameter 3 type change from Swift.String to PostgresNIO.PostgresEncodingContext<some PostgresNIO.PostgresJSONEncoder>
API breakage: func DatabaseConfigurationFactory.postgres(hostname:port:username:password:database:tlsConfiguration:maxConnectionsPerEventLoop:connectionPoolTimeout:encoder:sqlLogLevel:) has parameter 4 type change from Swift.String? to Logging.Logger.Level
API breakage: func DatabaseConfigurationFactory.postgres(hostname:port:username:password:database:tlsConfiguration:maxConnectionsPerEventLoop:connectionPoolTimeout:decoder:sqlLogLevel:) has parameter 0 type change from Swift.String to PostgresKit.SQLPostgresConfiguration
API breakage: func DatabaseConfigurationFactory.postgres(hostname:port:username:password:database:tlsConfiguration:maxConnectionsPerEventLoop:connectionPoolTimeout:decoder:sqlLogLevel:) has parameter 2 type change from Swift.String to NIOCore.TimeAmount
API breakage: func DatabaseConfigurationFactory.postgres(hostname:port:username:password:database:tlsConfiguration:maxConnectionsPerEventLoop:connectionPoolTimeout:decoder:sqlLogLevel:) has parameter 3 type change from Swift.String to PostgresNIO.PostgresDecodingContext<some PostgresNIO.PostgresJSONDecoder>
API breakage: func DatabaseConfigurationFactory.postgres(hostname:port:username:password:database:tlsConfiguration:maxConnectionsPerEventLoop:connectionPoolTimeout:decoder:sqlLogLevel:) has parameter 4 type change from Swift.String? to Logging.Logger.Level
API breakage: func DatabaseConfigurationFactory.postgres(hostname:port:username:password:database:tlsConfiguration:maxConnectionsPerEventLoop:connectionPoolTimeout:sqlLogLevel:) has been renamed to func postgres(configuration:maxConnectionsPerEventLoop:connectionPoolTimeout:sqlLogLevel:)
API breakage: func DatabaseConfigurationFactory.postgres(hostname:port:username:password:database:tlsConfiguration:maxConnectionsPerEventLoop:connectionPoolTimeout:encoder:sqlLogLevel:) has been renamed to func postgres(configuration:maxConnectionsPerEventLoop:connectionPoolTimeout:encodingContext:sqlLogLevel:)
API breakage: func DatabaseConfigurationFactory.postgres(hostname:port:username:password:database:tlsConfiguration:maxConnectionsPerEventLoop:connectionPoolTimeout:decoder:sqlLogLevel:) has been renamed to func postgres(configuration:maxConnectionsPerEventLoop:connectionPoolTimeout:decodingContext:sqlLogLevel:)
API breakage: func DatabaseConfigurationFactory.postgres(configuration:maxConnectionsPerEventLoop:connectionPoolTimeout:encoder:sqlLogLevel:) has been removed
API breakage: func DatabaseConfigurationFactory.postgres(configuration:maxConnectionsPerEventLoop:connectionPoolTimeout:decoder:sqlLogLevel:) has been removed
78 changes: 10 additions & 68 deletions Sources/FluentPostgresDriver/Deprecations/FluentPostgresConfiguration+Deprecated.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,11 @@ extension DatabaseConfigurationFactory {
public static func postgres(
hostname: String, port: Int = PostgresConfiguration.ianaPortNumber,
username: String, password: String, database: String? = nil, tlsConfiguration: TLSConfiguration? = nil,
maxConnectionsPerEventLoop: Int = 1, connectionPoolTimeout: TimeAmount = .seconds(10),
encoder: PostgresDataEncoder, decoder: PostgresDataDecoder, sqlLogLevel: Logger.Level = .debug
maxConnectionsPerEventLoop: Int = 1,
connectionPoolTimeout: TimeAmount = .seconds(10),
encoder: PostgresDataEncoder = .init(),
decoder: PostgresDataDecoder = .init(),
sqlLogLevel: Logger.Level = .debug
) -> DatabaseConfigurationFactory {
.postgres(configuration: .init(
hostname: hostname, port: port, username: username, password: password, database: database, tlsConfiguration: tlsConfiguration),
Expand All @@ -57,8 +60,11 @@ extension DatabaseConfigurationFactory {
@available(*, deprecated, message: "Use `.postgres(configuration:maxConnectionsPerEventLoop:connectionPoolTimeout:encodingContext:decodingContext:sqlLogLevel:)` instead.")
public static func postgres(
configuration: PostgresConfiguration,
maxConnectionsPerEventLoop: Int = 1, connectionPoolTimeout: TimeAmount = .seconds(10),
encoder: PostgresDataEncoder, decoder: PostgresDataDecoder, sqlLogLevel: Logger.Level = .debug
maxConnectionsPerEventLoop: Int = 1,
connectionPoolTimeout: TimeAmount = .seconds(10),
encoder: PostgresDataEncoder = .init(),
decoder: PostgresDataDecoder = .init(),
sqlLogLevel: Logger.Level = .debug
) -> DatabaseConfigurationFactory {
.postgres(
configuration: .init(legacyConfiguration: configuration),
Expand Down Expand Up @@ -115,70 +121,6 @@ extension DatabaseConfigurationFactory {
encoder: .init(), decoder: decoder, sqlLogLevel: sqlLogLevel
)
}

@available(*, deprecated, message: "Use `.postgres(configuration:.init(hostname:port:username:password:database:tls:),maxConnectionsPerEventLoop:connectionPoolTimeout:encodingContext:decodingContext:sqlLogLevel:)` instead.")
public static func postgres(
hostname: String, port: Int = PostgresConfiguration.ianaPortNumber,
username: String, password: String, database: String? = nil, tlsConfiguration: TLSConfiguration? = nil,
maxConnectionsPerEventLoop: Int = 1, connectionPoolTimeout: TimeAmount = .seconds(10),
sqlLogLevel: Logger.Level = .debug
) -> DatabaseConfigurationFactory {
.postgres(
hostname: hostname, port: port, username: username, password: password, database: database, tlsConfiguration: tlsConfiguration,
maxConnectionsPerEventLoop: maxConnectionsPerEventLoop, connectionPoolTimeout: connectionPoolTimeout,
encoder: .init(), decoder: .init(), sqlLogLevel: sqlLogLevel
)
}

@available(*, deprecated, message: "Use `.postgres(configuration:maxConnectionsPerEventLoop:connectionPoolTimeout:encodingContext:decodingContext:sqlLogLevel:)` instead.")
public static func postgres(
hostname: String, port: Int = PostgresConfiguration.ianaPortNumber,
username: String, password: String, database: String? = nil, tlsConfiguration: TLSConfiguration? = nil,
maxConnectionsPerEventLoop: Int = 1, connectionPoolTimeout: TimeAmount = .seconds(10),
encoder: PostgresDataEncoder, sqlLogLevel: Logger.Level = .debug
) -> DatabaseConfigurationFactory {
.postgres(
hostname: hostname, port: port, username: username, password: password, database: database, tlsConfiguration: tlsConfiguration,
maxConnectionsPerEventLoop: maxConnectionsPerEventLoop, connectionPoolTimeout: connectionPoolTimeout,
encoder: encoder, decoder: .init(), sqlLogLevel: sqlLogLevel
)
}

@available(*, deprecated, message: "Use `.postgres(configuration:maxConnectionsPerEventLoop:connectionPoolTimeout:encodingContext:decodingContext:sqlLogLevel:)` instead.")
public static func postgres(
hostname: String, port: Int = PostgresConfiguration.ianaPortNumber,
username: String, password: String, database: String? = nil, tlsConfiguration: TLSConfiguration? = nil,
maxConnectionsPerEventLoop: Int = 1, connectionPoolTimeout: TimeAmount = .seconds(10),
decoder: PostgresDataDecoder, sqlLogLevel: Logger.Level = .debug
) -> DatabaseConfigurationFactory {
.postgres(
hostname: hostname, port: port, username: username, password: password, database: database, tlsConfiguration: tlsConfiguration,
maxConnectionsPerEventLoop: maxConnectionsPerEventLoop, connectionPoolTimeout: connectionPoolTimeout,
encoder: .init(), decoder: decoder, sqlLogLevel: sqlLogLevel
)
}

@available(*, deprecated, message: "Use `.postgres(configuration:maxConnectionsPerEventLoop:connectionPoolTimeout:encodingContext:decodingContext:sqlLogLevel:)` instead.")
public static func postgres(
configuration: PostgresConfiguration, maxConnectionsPerEventLoop: Int = 1, connectionPoolTimeout: TimeAmount = .seconds(10),
encoder: PostgresDataEncoder, sqlLogLevel: Logger.Level = .debug
) -> DatabaseConfigurationFactory {
.postgres(configuration: configuration,
maxConnectionsPerEventLoop: maxConnectionsPerEventLoop, connectionPoolTimeout: connectionPoolTimeout,
encoder: encoder, decoder: .init(), sqlLogLevel: sqlLogLevel
)
}

@available(*, deprecated, message: "Use `.postgres(configuration:maxConnectionsPerEventLoop:connectionPoolTimeout:encodingContext:decodingContext:sqlLogLevel:)` instead.")
public static func postgres(
configuration: PostgresConfiguration, maxConnectionsPerEventLoop: Int = 1, connectionPoolTimeout: TimeAmount = .seconds(10),
decoder: PostgresDataDecoder, sqlLogLevel: Logger.Level = .debug
) -> DatabaseConfigurationFactory {
.postgres(configuration: configuration,
maxConnectionsPerEventLoop: maxConnectionsPerEventLoop, connectionPoolTimeout: connectionPoolTimeout,
encoder: .init(), decoder: decoder, sqlLogLevel: sqlLogLevel
)
}
}

// N.B.: If you change something in these two types, update the copies in PostgresKit too.
Expand Down
75 changes: 73 additions & 2 deletions Sources/FluentPostgresDriver/FluentPostgresConfiguration.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,8 +77,8 @@ extension DatabaseConfigurationFactory {
configuration: SQLPostgresConfiguration,
maxConnectionsPerEventLoop: Int = 1,
connectionPoolTimeout: TimeAmount = .seconds(10),
encodingContext: PostgresEncodingContext<some PostgresJSONEncoder> = .default,
decodingContext: PostgresDecodingContext<some PostgresJSONDecoder> = .default,
encodingContext: PostgresEncodingContext<some PostgresJSONEncoder>,
decodingContext: PostgresDecodingContext<some PostgresJSONDecoder>,
sqlLogLevel: Logger.Level = .debug
) -> DatabaseConfigurationFactory {
.init {
Expand All @@ -93,6 +93,77 @@ extension DatabaseConfigurationFactory {
}
}

/// We'd like to just default the context parameters of the "actual" method. Unfortunately, there are a few
/// cases involving the UNIX domain socket initalizer where usage can resolve to either the new
/// ``SQLPostgresConfiguration``-based method or the deprecated ``PostgresConfiguration``-based method, with no
/// obvious way to disambiguate which to call. Because the context parameters are generic, if they are defaulted,
/// the compiler resolves the ambiguity in favor of the deprecated method (which has no generic parameters).
/// However, by adding the non-defaulted-parameter variant which takes neither context, we've provided a version
/// which has no generic parameters either, which allows the compiler to resolve the ambiguity in favor of
/// the one with better availability (i.e. the one that isn't deprecated).
///
/// Example affected code:
///
/// _ = DatabaseConfigurationFactory.postgres(configuration: .init(unixDomainSocketPath: "", username: ""))
extension DatabaseConfigurationFactory {
/// ``postgres(configuration:maxConnectionsPerEventLoop:connectionPoolTimeout:encodingContext:decodingContext:sqlLogLevel:)``
/// with the `decodingContext` defaulted.
public static func postgres(
configuration: SQLPostgresConfiguration,
maxConnectionsPerEventLoop: Int = 1,
connectionPoolTimeout: TimeAmount = .seconds(10),
encodingContext: PostgresEncodingContext<some PostgresJSONEncoder>,
sqlLogLevel: Logger.Level = .debug
) -> DatabaseConfigurationFactory {
.postgres(
configuration: configuration,
maxConnectionsPerEventLoop: maxConnectionsPerEventLoop,
connectionPoolTimeout: connectionPoolTimeout,
encodingContext: encodingContext,
decodingContext: .default,
sqlLogLevel: sqlLogLevel
)
}

/// ``postgres(configuration:maxConnectionsPerEventLoop:connectionPoolTimeout:encodingContext:decodingContext:sqlLogLevel:)``
/// with the `encodingContext` defaulted.
public static func postgres(
configuration: SQLPostgresConfiguration,
maxConnectionsPerEventLoop: Int = 1,
connectionPoolTimeout: TimeAmount = .seconds(10),
decodingContext: PostgresDecodingContext<some PostgresJSONDecoder>,
sqlLogLevel: Logger.Level = .debug
) -> DatabaseConfigurationFactory {
.postgres(
configuration: configuration,
maxConnectionsPerEventLoop: maxConnectionsPerEventLoop,
connectionPoolTimeout: connectionPoolTimeout,
encodingContext: .default,
decodingContext: decodingContext,
sqlLogLevel: sqlLogLevel
)
}

/// ``postgres(configuration:maxConnectionsPerEventLoop:connectionPoolTimeout:encodingContext:decodingContext:sqlLogLevel:)``
/// with both `encodingContext` and `decodingContext` defaulted.
public static func postgres(
configuration: SQLPostgresConfiguration,
maxConnectionsPerEventLoop: Int = 1,
connectionPoolTimeout: TimeAmount = .seconds(10),
sqlLogLevel: Logger.Level = .debug
) -> DatabaseConfigurationFactory {
.postgres(
configuration: configuration,
maxConnectionsPerEventLoop: maxConnectionsPerEventLoop,
connectionPoolTimeout: connectionPoolTimeout,
encodingContext: .default,
decodingContext: .default,
sqlLogLevel: sqlLogLevel
)
}
}

/// The actual concrete configuration type produced by a configuration factory.
struct FluentPostgresConfiguration<E: PostgresJSONEncoder, D: PostgresJSONDecoder>: DatabaseConfiguration {
var middleware: [any AnyModelMiddleware] = []
let configuration: SQLPostgresConfiguration
Expand Down
4 changes: 2 additions & 2 deletions Sources/FluentPostgresDriver/FluentPostgresDatabase.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ extension _FluentPostgresDatabase: Database {
return self.withConnection { conn in
guard let sqlConn = conn as? any SQLDatabase else {
fatalError("""
Connection yieled by a Fluent+Postgres database is not also an SQLDatabase.
Connection yielded by a Fluent+Postgres database is not also an SQLDatabase.
This is a bug in Fluent; please report it at https://github.com/vapor/fluent-postgres-driver/issues
""")
}
Expand Down Expand Up @@ -124,7 +124,7 @@ extension _FluentPostgresDatabase: PostgresDatabase {
func withConnection<T>(_ closure: @escaping (PostgresConnection) -> EventLoopFuture<T>) -> EventLoopFuture<T> {
guard let psqlDb: any PostgresDatabase = self.database as? any PostgresDatabase else {
fatalError("""
Connection yieled by a Fluent+Postgres database is not also a PostgresDatabase.
Connection yielded by a Fluent+Postgres database is not also a PostgresDatabase.
This is a bug in Fluent; please report it at https://github.com/vapor/fluent-postgres-driver/issues
""")
}
Expand Down