Skip to content

Make erroneous @DatabaseFunction applications easier to debug #219

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 2 commits into from
Oct 29, 2025
+67 −45
Merged

Make erroneous @DatabaseFunction applications easier to debug #219

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8acf58a
Make erroneous `@DatabaseFunction` applications easier to debug
stephencelis Oct 29, 2025
be8c2a8
wip
stephencelis Oct 29, 2025
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 Sources/StructuredQueriesSQLiteCore/DatabaseFunction.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,3 +115,21 @@ extension AggregateDatabaseFunction {
}
}
}

// NB: Provides better error diagnostics for '@DatabaseFunction' macro-generated code.
//
// - Type 'CKShare' has no member '_columnWidth'
// + Global function '_columnWidth' requires that 'CKShare' conform to 'QueryExpression'
@_transparent
public func _columnWidth<T: QueryExpression>(_: T.Type) -> Int {
T._columnWidth
}

// NB: Provides better error diagnostics for '@DatabaseFunction' macro-generated code.
//
// - No exact matches in call to instance method 'decode'
// + Global function '_requireQueryRepresentable' requires that 'CKShare' conform to 'QueryRepresentable'
@_transparent
public func _requireQueryRepresentable<T: QueryRepresentable>(_: T.Type) -> T.Type {
T.self
}
10 changes: 7 additions & 3 deletions Sources/StructuredQueriesSQLiteMacros/DatabaseFunctionMacro.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,9 @@ extension DatabaseFunctionMacro: PeerMacro {
argumentBindings.append(secondName)

argumentCounts.append("\(type)")
decodings.append("let \(secondName) = try decoder.decode(\(type).self)")
decodings.append(
"let \(secondName) = try decoder.decode(_requireQueryRepresentable(\(type).self))"
)
decodingUnwrappings.append(
"guard let \(secondName) else { throw InvalidInvocation() }"
)
Expand Down Expand Up @@ -270,7 +272,9 @@ extension DatabaseFunctionMacro: PeerMacro {
argumentBindings.append(parameterName)

argumentCounts.append("\(type)")
decodings.append("let \(parameterName) = try decoder.decode(\(type).self)")
decodings.append(
"let \(parameterName) = try decoder.decode(_requireQueryRepresentable(\(type).self))"
)
decodingUnwrappings.append("guard let \(parameterName) else { throw InvalidInvocation() }")
canThrowInvalidInvocation = true
}
Expand Down Expand Up @@ -321,7 +325,7 @@ extension DatabaseFunctionMacro: PeerMacro {
? "0"
: """
var argumentCount = 0
\(argumentCounts.map { "argumentCount += \($0)._columnWidth\n" }.joined())\
\(argumentCounts.map { "argumentCount += _columnWidth(\($0).self)\n" }.joined())\
return argumentCount
"""

Expand Down
84 changes: 42 additions & 42 deletions Tests/StructuredQueriesMacrosTests/DatabaseFunctionMacroTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ extension SnapshotTests {
public let name = "jsonCapitalize"
public var argumentCount: Int? {
var argumentCount = 0
argumentCount += [String].JSONRepresentation._columnWidth
argumentCount += _columnWidth([String].JSONRepresentation.self)
return argumentCount
}
public let isDeterministic = false
Expand All @@ -147,7 +147,7 @@ extension SnapshotTests {
public func invoke(
_ decoder: inout some QueryDecoder
) throws -> StructuredQueriesCore.QueryBinding {
let strings = try decoder.decode([String].JSONRepresentation.self)
let strings = try decoder.decode(_requireQueryRepresentable([String].JSONRepresentation.self))
guard let strings else {
throw InvalidInvocation()
}
Expand Down Expand Up @@ -237,7 +237,7 @@ extension SnapshotTests {
public let name = "currentDate"
public var argumentCount: Int? {
var argumentCount = 0
argumentCount += String._columnWidth
argumentCount += _columnWidth(String.self)
return argumentCount
}
public let isDeterministic = false
Expand All @@ -255,7 +255,7 @@ extension SnapshotTests {
public func invoke(
_ decoder: inout some QueryDecoder
) throws -> StructuredQueriesCore.QueryBinding {
let format = try decoder.decode(String.self)
let format = try decoder.decode(_requireQueryRepresentable(String.self))
guard let format else {
throw InvalidInvocation()
}
Expand Down Expand Up @@ -295,7 +295,7 @@ extension SnapshotTests {
public let name = "currentDate"
public var argumentCount: Int? {
var argumentCount = 0
argumentCount += String._columnWidth
argumentCount += _columnWidth(String.self)
return argumentCount
}
public let isDeterministic = false
Expand All @@ -313,7 +313,7 @@ extension SnapshotTests {
public func invoke(
_ decoder: inout some QueryDecoder
) throws -> StructuredQueriesCore.QueryBinding {
let format = try decoder.decode(String.self)
let format = try decoder.decode(_requireQueryRepresentable(String.self))
guard let format else {
throw InvalidInvocation()
}
Expand Down Expand Up @@ -353,7 +353,7 @@ extension SnapshotTests {
public let name = "currentDate"
public var argumentCount: Int? {
var argumentCount = 0
argumentCount += String._columnWidth
argumentCount += _columnWidth(String.self)
return argumentCount
}
public let isDeterministic = false
Expand All @@ -371,7 +371,7 @@ extension SnapshotTests {
public func invoke(
_ decoder: inout some QueryDecoder
) throws -> StructuredQueriesCore.QueryBinding {
let format = try decoder.decode(String.self)
let format = try decoder.decode(_requireQueryRepresentable(String.self))
guard let format else {
throw InvalidInvocation()
}
Expand Down Expand Up @@ -411,7 +411,7 @@ extension SnapshotTests {
public let name = "currentDate"
public var argumentCount: Int? {
var argumentCount = 0
argumentCount += String._columnWidth
argumentCount += _columnWidth(String.self)
return argumentCount
}
public let isDeterministic = false
Expand All @@ -429,7 +429,7 @@ extension SnapshotTests {
public func invoke(
_ decoder: inout some QueryDecoder
) throws -> StructuredQueriesCore.QueryBinding {
let format = try decoder.decode(String.self)
let format = try decoder.decode(_requireQueryRepresentable(String.self))
guard let format else {
throw InvalidInvocation()
}
Expand Down Expand Up @@ -469,8 +469,8 @@ extension SnapshotTests {
public let name = "concat"
public var argumentCount: Int? {
var argumentCount = 0
argumentCount += String._columnWidth
argumentCount += String._columnWidth
argumentCount += _columnWidth(String.self)
argumentCount += _columnWidth(String.self)
return argumentCount
}
public let isDeterministic = false
Expand All @@ -488,8 +488,8 @@ extension SnapshotTests {
public func invoke(
_ decoder: inout some QueryDecoder
) throws -> StructuredQueriesCore.QueryBinding {
let first = try decoder.decode(String.self)
let second = try decoder.decode(String.self)
let first = try decoder.decode(_requireQueryRepresentable(String.self))
let second = try decoder.decode(_requireQueryRepresentable(String.self))
guard let first else {
throw InvalidInvocation()
}
Expand Down Expand Up @@ -549,7 +549,7 @@ extension SnapshotTests {
public let name = "currentDate"
public var argumentCount: Int? {
var argumentCount = 0
argumentCount += String?._columnWidth
argumentCount += _columnWidth(String?.self)
return argumentCount
}
public let isDeterministic = false
Expand All @@ -567,7 +567,7 @@ extension SnapshotTests {
public func invoke(
_ decoder: inout some QueryDecoder
) throws -> StructuredQueriesCore.QueryBinding {
let format = try decoder.decode(String?.self)
let format = try decoder.decode(_requireQueryRepresentable(String?.self))
guard let format else {
throw InvalidInvocation()
}
Expand Down Expand Up @@ -1041,8 +1041,8 @@ extension SnapshotTests {
public let name = "min"
public var argumentCount: Int? {
var argumentCount = 0
argumentCount += Int._columnWidth
argumentCount += Int._columnWidth
argumentCount += _columnWidth(Int.self)
argumentCount += _columnWidth(Int.self)
return argumentCount
}
public let isDeterministic = false
Expand All @@ -1063,8 +1063,8 @@ extension SnapshotTests {
public func invoke(
_ decoder: inout some QueryDecoder
) throws -> StructuredQueriesCore.QueryBinding {
let x = try decoder.decode(Int.self)
let y = try decoder.decode(Int.self)
let x = try decoder.decode(_requireQueryRepresentable(Int.self))
let y = try decoder.decode(_requireQueryRepresentable(Int.self))
guard let x else {
throw InvalidInvocation()
}
Expand Down Expand Up @@ -1108,8 +1108,8 @@ extension SnapshotTests {
public let name = "min"
public var argumentCount: Int? {
var argumentCount = 0
argumentCount += Int._columnWidth
argumentCount += Int._columnWidth
argumentCount += _columnWidth(Int.self)
argumentCount += _columnWidth(Int.self)
return argumentCount
}
public let isDeterministic = false
Expand All @@ -1130,8 +1130,8 @@ extension SnapshotTests {
public func invoke(
_ decoder: inout some QueryDecoder
) throws -> StructuredQueriesCore.QueryBinding {
let x = try decoder.decode(Int.self)
let y = try decoder.decode(Int.self)
let x = try decoder.decode(_requireQueryRepresentable(Int.self))
let y = try decoder.decode(_requireQueryRepresentable(Int.self))
guard let x else {
throw InvalidInvocation()
}
Expand Down Expand Up @@ -1172,8 +1172,8 @@ extension SnapshotTests {
public let name = "isValid"
public var argumentCount: Int? {
var argumentCount = 0
argumentCount += Reminder._columnWidth
argumentCount += Bool._columnWidth
argumentCount += _columnWidth(Reminder.self)
argumentCount += _columnWidth(Bool.self)
return argumentCount
}
public let isDeterministic = false
Expand All @@ -1191,8 +1191,8 @@ extension SnapshotTests {
public func invoke(
_ decoder: inout some QueryDecoder
) throws -> StructuredQueriesCore.QueryBinding {
let reminder = try decoder.decode(Reminder.self)
let override = try decoder.decode(Bool.self)
let reminder = try decoder.decode(_requireQueryRepresentable(Reminder.self))
let override = try decoder.decode(_requireQueryRepresentable(Bool.self))
guard let reminder else {
throw InvalidInvocation()
}
Expand Down Expand Up @@ -1238,7 +1238,7 @@ extension SnapshotTests {
public let name = "sum"
public var argumentCount: Int? {
var argumentCount = 0
argumentCount += Int._columnWidth
argumentCount += _columnWidth(Int.self)
return argumentCount
}
public let isDeterministic = false
Expand All @@ -1256,7 +1256,7 @@ extension SnapshotTests {
public func step(
_ decoder: inout some QueryDecoder
) throws -> Int {
let xs = try decoder.decode(Int.self)
let xs = try decoder.decode(_requireQueryRepresentable(Int.self))
guard let xs else {
throw InvalidInvocation()
}
Expand Down Expand Up @@ -1298,7 +1298,7 @@ extension SnapshotTests {
public let name = "sum"
public var argumentCount: Int? {
var argumentCount = 0
argumentCount += Int._columnWidth
argumentCount += _columnWidth(Int.self)
return argumentCount
}
public let isDeterministic = false
Expand All @@ -1316,7 +1316,7 @@ extension SnapshotTests {
public func step(
_ decoder: inout some QueryDecoder
) throws -> Int {
let xs = try decoder.decode(Int.self)
let xs = try decoder.decode(_requireQueryRepresentable(Int.self))
guard let xs else {
throw InvalidInvocation()
}
Expand Down Expand Up @@ -1370,8 +1370,8 @@ extension SnapshotTests {
public let name = "joined"
public var argumentCount: Int? {
var argumentCount = 0
argumentCount += String._columnWidth
argumentCount += String._columnWidth
argumentCount += _columnWidth(String.self)
argumentCount += _columnWidth(String.self)
return argumentCount
}
public let isDeterministic = false
Expand All @@ -1389,8 +1389,8 @@ extension SnapshotTests {
public func step(
_ decoder: inout some QueryDecoder
) throws -> (String, separator: String) {
let p0 = try decoder.decode(String.self)
let separator = try decoder.decode(String.self)
let p0 = try decoder.decode(_requireQueryRepresentable(String.self))
let separator = try decoder.decode(_requireQueryRepresentable(String.self))
guard let p0 else {
throw InvalidInvocation()
}
Expand Down Expand Up @@ -1437,7 +1437,7 @@ extension SnapshotTests {
public let name = "joined"
public var argumentCount: Int? {
var argumentCount = 0
argumentCount += [String].JSONRepresentation._columnWidth
argumentCount += _columnWidth([String].JSONRepresentation.self)
return argumentCount
}
public let isDeterministic = false
Expand All @@ -1455,7 +1455,7 @@ extension SnapshotTests {
public func step(
_ decoder: inout some QueryDecoder
) throws -> [String] {
let arrays = try decoder.decode([String].JSONRepresentation.self)
let arrays = try decoder.decode(_requireQueryRepresentable([String].JSONRepresentation.self))
guard let arrays else {
throw InvalidInvocation()
}
Expand Down Expand Up @@ -1501,7 +1501,7 @@ extension SnapshotTests {
public let name = "print"
public var argumentCount: Int? {
var argumentCount = 0
argumentCount += Int._columnWidth
argumentCount += _columnWidth(Int.self)
return argumentCount
}
public let isDeterministic = false
Expand All @@ -1519,7 +1519,7 @@ extension SnapshotTests {
public func step(
_ decoder: inout some QueryDecoder
) throws -> Int {
let xs = try decoder.decode(Int.self)
let xs = try decoder.decode(_requireQueryRepresentable(Int.self))
guard let xs else {
throw InvalidInvocation()
}
Expand Down Expand Up @@ -1570,7 +1570,7 @@ extension SnapshotTests {
public let name = "validatePositive"
public var argumentCount: Int? {
var argumentCount = 0
argumentCount += Int._columnWidth
argumentCount += _columnWidth(Int.self)
return argumentCount
}
public let isDeterministic = false
Expand All @@ -1588,7 +1588,7 @@ extension SnapshotTests {
public func step(
_ decoder: inout some QueryDecoder
) throws -> Int {
let xs = try decoder.decode(Int.self)
let xs = try decoder.decode(_requireQueryRepresentable(Int.self))
guard let xs else {
throw InvalidInvocation()
}
Expand Down