Skip to content

Include code comments before expectations which are preceded by try/await in recorded issues #1092

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.

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
Apr 24, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
11 changes: 10 additions & 1 deletion Sources/TestingMacros/ConditionMacro.swift
Original file line number Diff line number Diff line change
Expand Up @@ -157,8 +157,17 @@ extension ConditionMacro {
expandedFunctionName = conditionArgument.expandedFunctionName
}

// Capture any comments as well (either in source or as a macro argument.)
// Capture any comments as well -- either in source, preceding the
// expression macro or one of its lexical context nodes, or as an argument
// to the macro.
let commentsArrayExpr = ArrayExprSyntax {
// Lexical context is ordered innermost-to-outermost, so reverse it to
// maintain the expected order.
for lexicalSyntaxNode in context.lexicalContext.trailingEffectExpressions.reversed() {
for commentTraitExpr in createCommentTraitExprs(for: lexicalSyntaxNode) {
ArrayElementSyntax(expression: commentTraitExpr)
}
}
for commentTraitExpr in createCommentTraitExprs(for: macro) {
ArrayElementSyntax(expression: commentTraitExpr)
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import SwiftSyntax
import SwiftSyntaxBuilder
import SwiftSyntaxMacros

// MARK: - Finding effect keywords
// MARK: - Finding effect keywords and expressions

/// A syntax visitor class that looks for effectful keywords in a given
/// expression.
Expand Down Expand Up @@ -69,6 +69,21 @@ func findEffectKeywords(in node: some SyntaxProtocol, context: some MacroExpansi
return effectFinder.effectKeywords
}

extension BidirectionalCollection<Syntax> {
/// The suffix of syntax nodes in this collection which are effectful
/// expressions, such as those for `try` or `await`.
var trailingEffectExpressions: some Collection<Syntax> {
reversed()
.prefix { node in
// This could be simplified if/when swift-syntax introduces a protocol
// which all effectful expression syntax node types conform to.
// See https://github.com/swiftlang/swift-syntax/issues/3040
node.is(TryExprSyntax.self) || node.is(AwaitExprSyntax.self) || node.is(UnsafeExprSyntax.self)
}
.reversed()
}
}

// MARK: - Inserting effect keywords/thunks

/// Make a function call expression to an effectful thunk function provided by
Expand Down
53 changes: 53 additions & 0 deletions Tests/TestingMacrosTests/ConditionMacroTests.swift
Original file line number Diff line number Diff line change
Expand Up @@ -240,6 +240,59 @@ struct ConditionMacroTests {
// Capture me
Testing.__checkValue(try x(), expression: .__fromSyntaxNode("try x()"), comments: [.__line("// Capture me")], isRequired: false, sourceLocation: Testing.SourceLocation.__here()).__expected()
""",

"""
// Capture me
try #expect(x)
""":
"""
// Capture me
try Testing.__checkValue(x, expression: .__fromSyntaxNode("x"), comments: [.__line("// Capture me")], isRequired: false, sourceLocation: Testing.SourceLocation.__here()).__expected()
""",

"""
// Capture me
await #expect(x)
""":
"""
// Capture me
await Testing.__checkValue(x, expression: .__fromSyntaxNode("x"), comments: [.__line("// Capture me")], isRequired: false, sourceLocation: Testing.SourceLocation.__here()).__expected()
""",

"""
// Ignore me

// Comment for try
try
// Comment for await
await
// Comment for expect
#expect(x)
""":
"""
// Comment for try
try
// Comment for await
await
// Comment for expect
Testing.__checkValue(x, expression: .__fromSyntaxNode("x"), comments: [.__line("// Comment for try"), .__line("// Comment for await"), .__line("// Comment for expect")], isRequired: false, sourceLocation: Testing.SourceLocation.__here()).__expected()
""",

"""
// Ignore me
func example() {
// Capture me
#expect(x())
}
""":
"""
func example() {
// Capture me
Testing.__checkFunctionCall((), calling: { _ in
x()
}, expression: .__fromFunctionCall(nil, "x"), comments: [.__line("// Capture me")], isRequired: false, sourceLocation: Testing.SourceLocation.__here()).__expected()
}
""",
]
)
func commentCapture(input: String, expectedOutput: String) throws {
Expand Down