Augment JSON ABI #1429

bkhouri · 2025-11-26T20:46:25Z

TO BE COMPLETED.

Add tags, bug and timeLimit traits to the ABI JSON data.

[One line description of your change]

Motivation:

[Explain here the context, and why you're making that change. What is the problem you're trying to solve.]

Modifications:

[Describe the modifications you've done.]

Checklist:

Code and documentation should follow the style of the Style Guide.
If public symbols are renamed or modified, DocC references should be updated.

grynspan · 2025-12-02T14:37:16Z

Documentation/ABI/JSON.md

+<bug> ::= {
+  ["url": <string>,] ; the bug url
+  ["id": <string>,] ; the bug id
+  "title": <string> ; the human readable bug title


"title" should be optional.

You're write.. I thought I had seen it as required. My mistake.

BTW, nice catch.

grynspan · 2025-12-02T14:37:34Z

Documentation/ABI/JSON.md

+<tags> ::= <string> ; a string representation of a tag
+
+<bug> ::= {
+  ["url": <string>,] ; the bug url


Suggested change

["url": <string>,] ; the bug url

["url": <string>,] ; the bug URL

(Nitpick)

grynspan · 2025-12-02T14:38:17Z

Sources/Testing/ABI/Encoded/ABI.EncodedTest.swift

+    var bugs: [Bug]?
+
+    /// The time limits associated with the test.
+    var timeLimit: Int?


Suggested change

var timeLimit: Int?

var timeLimit: Double?

Subsecond precision is possible, at least nominally.

grynspan · 2025-12-02T14:41:07Z

Sources/Testing/ABI/Encoded/ABI.EncodedTest.swift

+          self.bugs = bugs
+        }
+        if #available(_clockAPI , *) {
+          if let seconds = test.timeLimit?.components.seconds {


Suggested change

if let seconds = test.timeLimit?.components.seconds {

self.timeLimit = test.timeLimit

.map(TimeValue.init)

.map(Double.init)

(Brain-compiled.)

Hmmm.. that code delta looks wild. Our of curiosity, how does the TimeValue.init know to call the initializer with the value of test.timeLimit?

I'm not sure what you mean. It "knows" because TimeValue.init takes a single value which is the value passed to map() if test.timeLimit is not nil.

grynspan · 2025-12-02T14:43:53Z

Sources/Testing/ABI/Encoded/ABI.EncodedTest.swift

-    ///
-    /// - Warning: Tags are not yet part of the JSON schema.
-    var _tags: [String]?
+    var tags: [String]?


Suggested change

var tags: [String]?

///

/// @Metadata {

/// @Available(Swift, introduced: 6.3)

/// }

var tags: [String]?

grynspan · 2025-12-02T14:44:06Z

Sources/Testing/ABI/Encoded/ABI.EncodedTest.swift

-    var _tags: [String]?
+    var tags: [String]?
+
+    // The bugs associated with the test.


Suggested change

// The bugs associated with the test.

// The bugs associated with the test.

///

/// @Metadata {

/// @Available(Swift, introduced: 6.3)

/// }

grynspan · 2025-12-02T14:44:15Z

Sources/Testing/ABI/Encoded/ABI.EncodedTest.swift

+    // The bugs associated with the test.
+    var bugs: [Bug]?
+
+    /// The time limits associated with the test.


Suggested change

/// The time limits associated with the test.

/// The time limits associated with the test.

///

/// @Metadata {

/// @Available(Swift, introduced: 6.3)

/// }

bkhouri · 2025-12-11T05:14:21Z

Documentation/ABI/JSON.md


 <test-id> ::= <string> ; an opaque string representing the test case
+
+<tag> ::= "." <string> ; a string representation of a tag


chore (blocking): Update to reflect actual behaviour

Drop the "." from the definition please! Even if it's mandated, this wouldn't be syntactically correct.

Add tags, bug and timeLimit traits to the test ABI JSON data.

grynspan · 2025-12-31T15:18:30Z

Documentation/ABI/JSON.md

+  ["url": <string>,] ; the bug URL
+  ["id": <string>,] ; the bug id
+  ["title": <string>] ; the human readable bug title
+} ;


Suggested change

} ;

}

The trailing semicolon introduces a comment, but none is here. (Nitpick!)

grynspan · 2025-12-31T15:20:05Z

Sources/Testing/Traits/Tags/Tag.swift

    switch kind {
    case let .staticMember(name):
-      ".\(name)"
+      "\(name)"


This is a breaking change, please revert. If you need a property that exposes name without the period, we can reasonably add one.

grynspan · 2025-12-31T15:20:12Z

Sources/Testing/Traits/Tags/Tag.swift


  /// This instance represented as a string, suitable for encoding.
-  private var _codableStringValue: String {
+  package var _codableStringValue: String {


Why package?

grynspan · 2025-12-31T15:22:22Z

Tests/TestingTests/SwiftPMTests.swift

+        let testTags = try #require(testRecord.tags)
+        #expect(testTags.count >= 1)
+        for tag in testTags {
+          #expect(!tag._codableStringValue.starts(with: "."))


You should be able to touch kind here directly, so I don't think any changes to Tag itself are necessary.

grynspan · 2025-12-31T15:23:59Z

Sources/Testing/ABI/Encoded/ABI.EncodedTest.swift

+    /// @Metadata {
+    ///   @Available(Swift, introduced: 6.3)
+    /// }
+    var tags: Set<Tag>?


Suggested change

var tags: Set<Tag>?

var tags: [Tag]?

No need for uniquing/hashing in the encoded form, so it's just overhead.

grynspan · 2025-12-31T15:25:35Z

Sources/Testing/ABI/Encoded/ABI.EncodedTest.swift

+          self.bugs = bugs
+        }
+        if #available(_clockAPI , *) {
+          self.timeLimit = test.timeLimit.map(TimeValue.init).map(Double.init)


It's informal house style to put the functional calls (e.g. .map()) on newlines if there's more than one, otherwise it can be hard to read the whole expression. (Nitpick.)

grynspan assigned bkhouri Nov 26, 2025

grynspan added enhancement New feature or request tools integration 🛠️ Integration of swift-testing into tools/IDEs public-api Affects public API traits Issues and PRs related to the trait subsystem or built-in traits labels Nov 26, 2025

bkhouri force-pushed the t/main/augment_event_stream_json branch 3 times, most recently from eb44837 to 46c32f1 Compare November 27, 2025 14:33

bkhouri mentioned this pull request Dec 1, 2025

SwiftTesting: Include metadata for tags, bug, and time limit traits in event stream swiftlang/swift-evolution#3040

Open

grynspan reviewed Dec 2, 2025

View reviewed changes

bkhouri force-pushed the t/main/augment_event_stream_json branch 3 times, most recently from 95d2763 to b3bda79 Compare December 11, 2025 05:13

bkhouri commented Dec 11, 2025

View reviewed changes

Augment JSON ABI

15034be

Add tags, bug and timeLimit traits to the test ABI JSON data.

bkhouri force-pushed the t/main/augment_event_stream_json branch from b3bda79 to 15034be Compare December 18, 2025 04:02

grynspan reviewed Dec 31, 2025

View reviewed changes

	["url": <string>,] ; the bug url
	["url": <string>,] ; the bug URL


		<test-id> ::= <string> ; an opaque string representing the test case

		<tag> ::= "." <string> ; a string representation of a tag

Augment JSON ABI #1429

Are you sure you want to change the base?

Augment JSON ABI #1429

Uh oh!

Conversation

bkhouri commented Nov 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Motivation:

Modifications:

Checklist:

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

grynspan Dec 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

bkhouri commented Nov 26, 2025 •

edited

Loading

grynspan Dec 2, 2025 •

edited

Loading