PR feedback

Author: stmontgomery

Documentation/ABI/JSON.md

@@ -197,20 +197,10 @@ sufficient information to display the event in a human-readable format.
   "runEnded" ; additional event kinds may be added in the future
 
 <issue> ::= {
-<!--
-  TODO: Publicize the severity field.
-  "severity" ::= <issue-severity>, ; the severity of the issue
--->
   "isKnown": <bool>, ; is this a known issue or not?
   ["sourceLocation": <source-location>,] ; where the issue occurred, if known
 }
 
-<!--
-  TODO: Publicize the severity field.
-<issue-severity> ::= "warning" | "error" ; additional severity levels may be
-                                         ; added in the future
--->
-
 <message> ::= {
   "symbol": <message-symbol>,
   "text": <string>, ; the human-readable text of this message
@@ -220,6 +210,12 @@ sufficient information to display the event in a human-readable format.
   "fail" | "difference" | "warning" | "details"
 ```
 
+<!--
+  TODO: Publicize issue severity.
+<issue-severity> ::= "warning" | "error" ; additional severity levels may be
+                                         ; added in the future
+-->
+
 <!--
   ["testID": <test-id>,
     ["testCase": <test-case>]]

Sources/Testing/ABI/EntryPoints/EntryPoint.swift

@@ -551,7 +551,7 @@ public func configurationForEntryPoint(from args: __CommandLineArguments_v0) thr
   case .some(...0):
     // If the event stream version was specified explicitly to a value < 1,
     // disable delivery of warning issue events to maintain legacy behavior.
-    configuration.eventHandlingOptions.isWarningIssueEventDeliveryEnabled = false
+    configuration.eventHandlingOptions.isWarningIssueRecordedEventEnabled = false
   default:
     break
   }

Sources/Testing/Events/Event.swift

@@ -314,9 +314,9 @@ extension Configuration.EventHandlingOptions {
   fileprivate func shouldHandleEvent(_ event: borrowing Event) -> Bool {
     switch event.kind {
     case let .issueRecorded(issue):
-      issue.severity > .warning || isWarningIssueEventDeliveryEnabled
+      issue.severity > .warning || isWarningIssueRecordedEventEnabled
     case .expectationChecked:
-      isExpectationCheckedEventDeliveryEnabled
+      isExpectationCheckedEventEnabled
     default:
       true
     }

Sources/Testing/Running/Configuration.swift

@@ -185,11 +185,11 @@ public struct Configuration: Sendable {
     /// containing issues with warning (or lower) severity should be delivered
     /// to the event handler of the configuration these options are applied to.
     ///
-    /// By default, events matching this criteria are delivered to event
-    /// handlers unless the entry point specifies an event stream version which
-    /// predates the introduction of warning issues, in which case this is
-    /// disabled to maintain legacy behavior.
-    public var isWarningIssueEventDeliveryEnabled: Bool = true
+    /// By default, events matching this criteria are not delivered to event
+    /// handlers since this is an experimental feature.
+    ///
+    /// - Warning: Warning issues are not yet an approved feature.
+    public var isWarningIssueRecordedEventEnabled: Bool = false
 
     /// Whether or not events of the kind
     /// ``Event/Kind-swift.enum/expectationChecked(_:)`` should be delivered to
@@ -198,7 +198,7 @@ public struct Configuration: Sendable {
     /// By default, events of this kind are not delivered to event handlers
     /// because they occur frequently in a typical test run and can generate
     /// significant back-pressure on the event handler.
-    public var isExpectationCheckedEventDeliveryEnabled: Bool = false
+    public var isExpectationCheckedEventEnabled: Bool = false
   }
 
   /// The options to use when delivering events to this configuration's event
@@ -347,13 +347,13 @@ extension Configuration {
   }
 #endif
 
-  @available(*, deprecated, message: "Set eventHandlingOptions.isExpectationCheckedEventDeliveryEnabled instead.")
+  @available(*, deprecated, message: "Set eventHandlingOptions.isExpectationCheckedEventEnabled instead.")
   public var deliverExpectationCheckedEvents: Bool {
     get {
-      eventHandlingOptions.isExpectationCheckedEventDeliveryEnabled
+      eventHandlingOptions.isExpectationCheckedEventEnabled
     }
     set {
-      eventHandlingOptions.isExpectationCheckedEventDeliveryEnabled = newValue
+      eventHandlingOptions.isExpectationCheckedEventEnabled = newValue
     }
   }
 }