Provide an opt-out conditional for lazy attachment encoding. #811
Conversation
This file contains hidden or 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 PR provides a compile-time conditional, `SWT_NO_LAZY_ATTACHMENTS`, which when set causes Swift Testing's new experimental attachments feature to always eagerly encode/serialize/whatever attachments even if they're copyable and sendable. We anticipate using this functionality in Embedded Swift in the future. Note that support for Embedded Swift is not (yet!) a planned feature.
grynspan
added
enhancement
grynspan
requested review from
stmontgomery,
dennisweissmann,
briancroom,
SeanROlszewski and
suzannaratcliff
as code owners
|
@swift-ci test |
stmontgomery
reviewed
Nov 6, 2024
Comment on lines
163
to
164
| // BUG: the borrow checker thinks that withErrorRecording() is consuming | ||
| // attachableValue, so get around it with an additional do/catch clause. |
There was a problem hiding this comment.
I'm wondering if we ought to propagate caught Errors in this initializer? Unlike the other one, where encoding the attachment is deferred, and it does make sense to catch it and record an Issue, this one might be better to propagate and let the test author decide how to handle it.
There was a problem hiding this comment.
I thought about it, but my reasoning was that:
- Errors adding attachments are probably going to be pretty rare;
- You'd have to
tryfor non-sendable or move-only attachments, but not if the attachment is sendable and copyable, which is inconsistent and potentially confusing; and - An error that occurs when creating an attachment is probably not a test failure, but an infrastructure failure, so it should not cause a test to halt execution—which it would unless you wrote
try?, in which case we lose the error.
stmontgomery
approved these changes
Nov 6, 2024
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR provides a compile-time conditional,
SWT_NO_LAZY_ATTACHMENTS, which when set causes Swift Testing's new experimental attachments feature to always eagerly encode/serialize/whatever attachments even if they're copyable and sendable.We anticipate using this functionality in Embedded Swift in the future. Note that support for Embedded Swift is not (yet!) a planned feature.
"Why not make Attachment generic?"
I've got a separate branch that tries to do this. It has a significantly more complex implementation and is brittle because we need to type-erase the attachable value in order to pass it into the event-handling machinery (which entails having a bunch of special-casing since
any Test.Attachabledoes not conform toTest.Attachable.)Attachmentis already meant to represent a type-erasedAttachablevalue.Checklist: