Define an experimental event stream version and use it to conditionalize relevant content #1287
+70
−26
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
…ize relevant content
|
@swift-ci please test |
grynspan
reviewed
Aug 26, 2025
grynspan
reviewed
Aug 26, 2025
plemarquand
reviewed
Aug 26, 2025
|
@swift-ci please test |
|
@swift-ci please test |
grynspan
reviewed
Aug 27, 2025
plemarquand
added a commit
to plemarquand/vscode-swift
that referenced
this pull request
Aug 27, 2025
swiftlang/swift-testing#1287 gates the `_testCase` field behind the experimental version number check, which will be tied to the swift version of the client, supplied by vs code. Set the `SWT_ENABLE_EXPERIMENTAL_EVENT_STREAM_TEST_CASE_ENCODING` flag to allow any version of swift-testing to continue to work with the extension.
3 tasks
|
@swift-ci please test |
5c325db to
cbb9d89
Compare
|
@swift-ci please test |
grynspan
reviewed
Aug 28, 2025
Sources/Testing/ABI/ABI.swift
Outdated
| /// | ||
| /// Otherwise, the value of this property is `false`. | ||
| static var includesExperimentalFields: Bool { | ||
| versionNumber < ABI.v6_3.versionNumber |
There was a problem hiding this comment.
This might be more readable as a range switch.
grynspan
reviewed
Aug 28, 2025
| @@ -376,7 +376,7 @@ struct SwiftPMTests { | |||
| } | |||
| #expect(testRecords.count == 1) | |||
| for testRecord in testRecords { | |||
| if version.versionNumber >= ABI.v6_3.versionNumber { | |||
| if version.versionNumber < ABI.v6_3.versionNumber || version.versionNumber >= ABI.ExperimentalVersion.versionNumber { | |||
There was a problem hiding this comment.
Suggested change
| if version.versionNumber < ABI.v6_3.versionNumber || version.versionNumber >= ABI.ExperimentalVersion.versionNumber { | |
| if version.includesExperimentalFields { |
grynspan
approved these changes
Aug 28, 2025
plemarquand
added a commit
to swiftlang/vscode-swift
that referenced
this pull request
Sep 2, 2025
* Set env var to preserve test case encoding w/ swift testing swiftlang/swift-testing#1287 gates the `_testCase` field behind the experimental version number check, which will be tied to the swift version of the client, supplied by vs code. Set the `SWT_ENABLE_EXPERIMENTAL_EVENT_STREAM_TEST_CASE_ENCODING` flag to allow any version of swift-testing to continue to work with the extension.
|
@swift-ci please test |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in 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 formally defines an "experimental" event stream version (named
ABI.ExperimentalVersion) which represents content that is considered experimental. It then adopts the new experimental version in several places to conditionalize the inclusion of fields on event stream models which are not yet officially included in any defined, supported version. Finally, it uses this new version everywhere that intentionally always uses the highest experimental version, such as the exit test back channel and the recently-added experimental console output recorder.Motivation:
The event stream now has an established versioning system (as of #956) and can easily conditionalize content based on version. As a general rule, we prefer to exclude content which has not gone through Swift Evolution review when delivering data to event stream consumers which expect to receive content from a supported version. The fields this PR conditionalizes have underscore prefixes and have code-level documentation indicating their unofficial-ness, but the fact that they are included at all in supported/non-experimental version streams could lead to misuse or unintentional breakages in the future if the names or semantics of these fields change.
Checklist: