-
-
Notifications
You must be signed in to change notification settings - Fork 727
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #384 from groue/conversionDebugInfo
Improve database value decoding diagnostics
- Loading branch information
Showing
44 changed files
with
1,511 additions
and
277 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,182 @@ | ||
| #if SWIFT_PACKAGE | ||
| import CSQLite | ||
| #elseif !GRDBCUSTOMSQLITE && !GRDBCIPHER | ||
| import SQLite3 | ||
| #endif | ||
|
|
||
| // MARK: - Conversion Context and Errors | ||
|
|
||
| /// A type that helps the user understanding value conversion errors | ||
| struct ValueConversionContext { | ||
| private enum Column { | ||
| case columnIndex(Int) | ||
| case columnName(String) | ||
| } | ||
| var row: Row? | ||
| var sql: String? | ||
| var arguments: StatementArguments? | ||
| private var column: Column? | ||
|
|
||
| func atColumn(_ columnIndex: Int) -> ValueConversionContext { | ||
| var result = self | ||
| result.column = .columnIndex(columnIndex) | ||
| return result | ||
| } | ||
|
|
||
| func atColumn(_ columnName: String) -> ValueConversionContext { | ||
| var result = self | ||
| result.column = .columnName(columnName) | ||
| return result | ||
| } | ||
|
|
||
| var columnIndex: Int? { | ||
| guard let column = column else { return nil } | ||
| switch column { | ||
| case .columnIndex(let index): | ||
| return index | ||
| case .columnName(let name): | ||
| return row?.index(ofColumn: name) | ||
| } | ||
| } | ||
|
|
||
| var columnName: String? { | ||
| guard let column = column else { return nil } | ||
| switch column { | ||
| case .columnIndex(let index): | ||
| guard let row = row else { return nil } | ||
| let rowIndex = row.index(row.startIndex, offsetBy: index) | ||
| return row[rowIndex].0 | ||
| case .columnName(let name): | ||
| return name | ||
| } | ||
| } | ||
| } | ||
|
|
||
| extension ValueConversionContext { | ||
| init(_ statement: SelectStatement) { | ||
| self.init( | ||
| row: Row(statement: statement).copy(), | ||
| sql: statement.sql, | ||
| arguments: statement.arguments, | ||
| column: nil) | ||
| } | ||
|
|
||
| init(_ row: Row) { | ||
| if let statement = row.statement { | ||
| self.init( | ||
| row: row.copy(), | ||
| sql: statement.sql, | ||
| arguments: statement.arguments, | ||
| column: nil) | ||
| } else { | ||
| self.init( | ||
| row: row.copy(), | ||
| sql: nil, | ||
| arguments: nil, | ||
| column: nil) | ||
| } | ||
| } | ||
|
|
||
| init(sql: String, arguments: StatementArguments?) { | ||
| self.init( | ||
| row: nil, | ||
| sql: sql, | ||
| arguments: arguments, | ||
| column: nil) | ||
| } | ||
| } | ||
|
|
||
| /// The canonical conversion error message | ||
| /// | ||
| /// - parameter dbValue: nil means "missing column" | ||
| func conversionErrorMessage<T>(to: T.Type, from dbValue: DatabaseValue?, conversionContext: ValueConversionContext?) -> String { | ||
| var message: String | ||
| var extras: [String] = [] | ||
|
|
||
| if let dbValue = dbValue { | ||
| message = "could not convert database value \(dbValue) to \(T.self)" | ||
| if let columnName = conversionContext?.columnName { | ||
| extras.append("column: `\(columnName)`") | ||
| } | ||
| if let columnIndex = conversionContext?.columnIndex { | ||
| extras.append("column index: \(columnIndex)") | ||
| } | ||
| } else { | ||
| message = "could not read \(T.self) from missing column" | ||
| if let columnName = conversionContext?.columnName { | ||
| message += " `\(columnName)`" | ||
| } | ||
| } | ||
|
|
||
| if let row = conversionContext?.row { | ||
| extras.append("row: \(row)") | ||
| } | ||
|
|
||
| if let sql = conversionContext?.sql { | ||
| extras.append("sql: `\(sql)`") | ||
| if let arguments = conversionContext?.arguments, arguments.isEmpty == false { | ||
| extras.append("arguments: \(arguments)") | ||
| } | ||
| } | ||
|
|
||
| if extras.isEmpty == false { | ||
| message += " (" + extras.joined(separator: ", ") + ")" | ||
| } | ||
| return message | ||
| } | ||
|
|
||
| /// The canonical conversion fatal error | ||
| /// | ||
| /// - parameter dbValue: nil means "missing column", for consistency with (row["missing"] as DatabaseValue? == nil) | ||
| func fatalConversionError<T>(to: T.Type, from dbValue: DatabaseValue?, conversionContext: ValueConversionContext?, file: StaticString = #file, line: UInt = #line) -> Never { | ||
| fatalError(conversionErrorMessage(to: T.self, from: dbValue, conversionContext: conversionContext), file: file, line: line) | ||
| } | ||
|
|
||
| // MARK: - DatabaseValueConvertible | ||
|
|
||
| extension DatabaseValueConvertible { | ||
| /// Performs lossless conversion from a database value. | ||
| @inline(__always) | ||
| static func decode(from dbValue: DatabaseValue, conversionContext: @autoclosure () -> ValueConversionContext?) -> Self { | ||
| if let value = fromDatabaseValue(dbValue) { | ||
| return value | ||
| } else { | ||
| fatalConversionError(to: Self.self, from: dbValue, conversionContext: conversionContext()) | ||
| } | ||
| } | ||
|
|
||
| /// Performs lossless conversion from a database value. | ||
| @inline(__always) | ||
| static func decodeIfPresent(from dbValue: DatabaseValue, conversionContext: @autoclosure () -> ValueConversionContext?) -> Self? { | ||
| // Use fromDatabaseValue before checking for null: this allows DatabaseValue to convert NULL to .null. | ||
| if let value = fromDatabaseValue(dbValue) { | ||
| return value | ||
| } else if dbValue.isNull { | ||
| return nil | ||
| } else { | ||
| fatalConversionError(to: Self.self, from: dbValue, conversionContext: conversionContext()) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // MARK: - DatabaseValueConvertible & StatementColumnConvertible | ||
|
|
||
| extension DatabaseValueConvertible where Self: StatementColumnConvertible { | ||
| /// Performs lossless conversion from a statement value. | ||
| @inline(__always) | ||
| static func fastDecode(from sqliteStatement: SQLiteStatement, index: Int32, conversionContext: @autoclosure () -> ValueConversionContext?) -> Self { | ||
| if sqlite3_column_type(sqliteStatement, index) == SQLITE_NULL { | ||
| fatalConversionError(to: Self.self, from: .null, conversionContext: conversionContext()) | ||
| } | ||
| return self.init(sqliteStatement: sqliteStatement, index: index) | ||
| } | ||
|
|
||
| /// Performs lossless conversion from a statement value. | ||
| @inline(__always) | ||
| static func fastDecodeIfPresent(from sqliteStatement: SQLiteStatement, index: Int32) -> Self? { | ||
| if sqlite3_column_type(sqliteStatement, index) == SQLITE_NULL { | ||
| return nil | ||
| } | ||
| return self.init(sqliteStatement: sqliteStatement, index: index) | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.