Introduce new Configuration SPI controlling whether warning issues should be delivered, consolidating some similar functionality with an existing SPI. Address the ABI compatibility problem by defaulting all existing entry point versions to disable this feature, but default it to enabled so that the eventual v1 will have it enabled by default

Author: stmontgomery

Sources/Testing/ABI/EntryPoints/ABIEntryPoint.swift

@@ -47,7 +47,7 @@ extension ABIv0 {
   /// callback.
   public static var entryPoint: EntryPoint {
     return { configurationJSON, recordHandler in
-      try await Testing.entryPoint(
+      try await _entryPoint(
         configurationJSON: configurationJSON,
         recordHandler: recordHandler
       ) == EXIT_SUCCESS
@@ -87,7 +87,7 @@ typealias ABIEntryPoint_v0 = @Sendable (
 @usableFromInline func copyABIEntryPoint_v0() -> UnsafeMutableRawPointer {
   let result = UnsafeMutablePointer<ABIEntryPoint_v0>.allocate(capacity: 1)
   result.initialize { configurationJSON, recordHandler in
-    try await entryPoint(
+    try await _entryPoint(
       configurationJSON: configurationJSON,
       eventStreamVersionIfNil: -1,
       recordHandler: recordHandler
@@ -104,7 +104,7 @@ typealias ABIEntryPoint_v0 = @Sendable (
 ///
 /// This function will be removed (with its logic incorporated into
 /// ``ABIv0/entryPoint-swift.type.property``) in a future update.
-private func entryPoint(
+private func _entryPoint(
   configurationJSON: UnsafeRawBufferPointer?,
   eventStreamVersionIfNil: Int? = nil,
   recordHandler: @escaping @Sendable (_ recordJSON: UnsafeRawBufferPointer) -> Void

Sources/Testing/ABI/EntryPoints/EntryPoint.swift

@@ -547,6 +547,15 @@ public func configurationForEntryPoint(from args: __CommandLineArguments_v0) thr
   configuration.exitTestHandler = ExitTest.handlerForEntryPoint()
 #endif
 
+  switch args.eventStreamVersion {
+  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
+  default:
+    break
+  }
+
   return configuration
 }
 

Sources/Testing/Events/Event.swift

@@ -290,10 +290,7 @@ extension Event {
     if let configuration = configuration ?? Configuration.current {
       // The caller specified a configuration, or the current task has an
       // associated configuration. Post to either configuration's event handler.
-      switch kind {
-      case .expectationChecked where !configuration.deliverExpectationCheckedEvents:
-        break
-      default:
+      if configuration.eventHandlingOptions.shouldHandleEvent(self) {
         configuration.handleEvent(self, in: context)
       }
     } else {
@@ -306,6 +303,26 @@ extension Event {
   }
 }
 
+extension Configuration.EventHandlingOptions {
+  /// Determine whether the specified event should be handled according to the
+  /// options in this instance.
+  ///
+  /// - Parameters:
+  ///   - event: The event to consider handling.
+  ///
+  /// - Returns: Whether or not the event should be handled or suppressed.
+  fileprivate func shouldHandleEvent(_ event: borrowing Event) -> Bool {
+    switch event.kind {
+    case let .issueRecorded(issue):
+      issue.severity > .warning || isWarningIssueEventDeliveryEnabled
+    case .expectationChecked:
+      isExpectationCheckedEventDeliveryEnabled
+    default:
+      true
+    }
+  }
+}
+
 #if !SWT_NO_SNAPSHOT_TYPES
 // MARK: - Snapshotting
 

Sources/Testing/Running/Configuration.swift

@@ -178,14 +178,35 @@ public struct Configuration: Sendable {
 
   // MARK: - Event handling
 
-  /// Whether or not events of the kind
-  /// ``Event/Kind-swift.enum/expectationChecked(_:)`` should be delivered to
-  /// this configuration's ``eventHandler`` closure.
+  /// A type describing options to use when delivering events to this
+  /// configuration's event handler
+  public struct EventHandlingOptions: Sendable {
+    /// Whether or not events of the kind ``Event/Kind-swift.enum/issueRecorded(_:)``
+    /// 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
+
+    /// Whether or not events of the kind
+    /// ``Event/Kind-swift.enum/expectationChecked(_:)`` should be delivered to
+    /// the event handler of the configuration these options are applied to.
+    ///
+    /// 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
+  }
+
+  /// The options to use when delivering events to this configuration's event
+  /// handler.
   ///
-  /// 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 backpressure on the event handler.
-  public var deliverExpectationCheckedEvents: Bool = false
+  /// The default value of this property is an instance of ``EventHandlingOptions-swift.struct``
+  /// with its properties initialized to their default values.
+  public var eventHandlingOptions: EventHandlingOptions = .init()
 
   /// The event handler to which events should be passed when they occur.
   public var eventHandler: Event.Handler = { _, _ in }
@@ -325,4 +346,14 @@ extension Configuration {
     }
   }
 #endif
+
+  @available(*, deprecated, message: "Set eventHandlingOptions.isExpectationCheckedEventDeliveryEnabled instead.")
+  public var deliverExpectationCheckedEvents: Bool {
+    get {
+      eventHandlingOptions.isExpectationCheckedEventDeliveryEnabled
+    }
+    set {
+      eventHandlingOptions.isExpectationCheckedEventDeliveryEnabled = newValue
+    }
+  }
 }