bit more cheese

Author: grynspan

Sources/Testing/ABI/Encoded/ABI.EncodedIssue.swift

@@ -58,6 +58,12 @@ extension ABI {
     /// - Warning: Errors are not yet part of the JSON schema.
     var _error: EncodedError<V>?
 
+    /// The comment associated with the call to `withKnownIssue()` that
+    /// generated this issue.
+    ///
+    /// - Warning: This field is not yet part of the JSON schema.
+    var _knownIssueComment: String?
+
     init(encoding issue: borrowing Issue, in eventContext: borrowing Event.Context) {
       // >= v0
       isKnown = issue.isKnown
@@ -80,6 +86,9 @@ extension ABI {
         if let error = issue.error {
           _error = EncodedError(encoding: error, in: eventContext)
         }
+        if let knownIssueContext = issue.knownIssueContext {
+          _knownIssueComment = knownIssueContext.comment?.rawValue
+        }
       }
     }
   }
@@ -89,47 +98,3 @@ extension ABI {
 
 extension ABI.EncodedIssue: Codable {}
 extension ABI.EncodedIssue.Severity: Codable {}
-
-// MARK: - Converting back to an Issue
-
-extension Issue {
-  /// Attempt to reconstruct an instance of ``Issue`` from the given encoded
-  /// event.
-  ///
-  /// - Parameters:
-  ///   - event: The event that may contain an encoded issue.
-  ///
-  /// If `event` does not represent an issue, this initializer returns `nil`.
-  init?<V>(_ event: ABI.EncodedEvent<V>) {
-    guard let issue = event.issue else {
-      return nil
-    }
-
-    // Translate the issue back into a "real" issue and record it
-    // in the parent process. This translation is, of course, lossy
-    // due to the process boundary, but we make a best effort.
-    let comments: [Comment] = event.messages.map(\.text).map(Comment.init(rawValue:))
-    let issueKind: Issue.Kind = if let error = issue._error {
-      .errorCaught(error)
-    } else {
-      // TODO: improve fidelity of issue kind reporting (especially those without associated values)
-      .unconditional
-    }
-    let severity: Issue.Severity = switch issue.severity {
-    case .warning:
-        .warning
-    case nil, .error:
-        .error
-    }
-    let sourceContext = SourceContext(
-      backtrace: nil, // `issue._backtrace` will have the wrong address space.
-      sourceLocation: issue.sourceLocation
-    )
-    self.init(kind: issueKind, severity: severity, comments: comments, sourceContext: sourceContext)
-    if issue.isKnown {
-      // The known issue comment, if there was one, is already included in
-      // the `comments` array above.
-      knownIssueContext = Issue.KnownIssueContext()
-    }
-  }
-}

Sources/Testing/Events/Event+FallbackHandler.swift

@@ -33,8 +33,26 @@ extension Event {
       sourceLocation: event._sourceLocation
     )
     lazy var skipInfo = SkipInfo(comment: comments.first, sourceContext: sourceContext)
-    if let issue = Issue(event) {
-      issue.record()
+    if let issue = event.issue {
+      // Translate the issue back into a "real" issue and record it in the
+      // parent process. This translation is, of course, lossy due to the ABI
+      // and/or process boundary, but we make a best effort.
+      let issueKind: Issue.Kind = if let error = issue._error {
+        .errorCaught(error)
+      } else {
+        // TODO: improve fidelity of issue kind reporting (especially those without associated values)
+        .unconditional
+      }
+      let severity: Issue.Severity = switch issue.severity {
+      case .warning: .warning
+      case nil, .error: .error
+      }
+      var issueCopy = Issue(kind: issueKind, severity: severity, comments: comments, sourceContext: sourceContext)
+      if issue.isKnown {
+        issueCopy.knownIssueContext = Issue.KnownIssueContext()
+        issueCopy.knownIssueContext?.comment = issue._knownIssueComment.map(Comment.init(rawValue:))
+      }
+      issueCopy.record()
     } else if let attachment = event.attachment {
       Attachment.record(attachment, sourceLocation: event._sourceLocation!)
     } else if case .testCancelled = event.kind {
@@ -44,17 +62,6 @@ extension Event {
     }
   }
 
-  /// The implementation of ``fallbackEventHandler``.
-  ///
-  /// - Parameters:
-  ///   - abi: The ABI version to use for decoding `recordJSON`.
-  ///   - recordJSON: The JSON encoding of an event record.
-  ///
-  /// - Throws: Any error that prevented handling the encoded record.
-  private static func _fallbackEventHandler<V>(_ abi: V.Type, _ recordJSON: UnsafeRawBufferPointer) throws where V: ABI.Version {
-    try handle(recordJSON, encodedWith: abi)
-  }
-
   /// The fallback event handler to set when Swift Testing is the active testing
   /// library.
   private static let _fallbackEventHandler: FallbackEventHandler = { recordJSONSchemaVersionNumber, recordJSONBaseAddress, recordJSONByteCount, _ in
@@ -63,7 +70,7 @@ extension Event {
       .flatMap(ABI.version(forVersionNumber:))
     if let abi {
       let recordJSON = UnsafeRawBufferPointer(start: recordJSONBaseAddress, count: recordJSONByteCount)
-      try! Self._fallbackEventHandler(abi, recordJSON)
+      try! Self.handle(recordJSON, encodedWith: abi)
     }
   }
 

Tests/TestingTests/EventTests.swift

@@ -128,7 +128,7 @@ private func MockXCTAssert(_ condition: Bool, _ message: String, _ sourceLocatio
   }
 }
 
-private func MockXCTAttachmentAdd(_ string: String, named name: String) {
+private func MockXCTAttachmentAdd(_ string: String, named name: String, _ sourceLocation: SourceLocation = #_sourceLocation) {
   #expect(throws: Never.self) {
     guard let fallbackEventHandler = fallbackEventHandler() else {
       return
@@ -150,6 +150,15 @@ private func MockXCTAttachmentAdd(_ string: String, named name: String) {
           "_preferredName": name
         ],
         "messages": [],
+        "_comments": [
+          "comment #1",
+        ],
+        "_sourceLocation": [
+          "fileID": sourceLocation.fileID,
+          "_filePath": sourceLocation._filePath,
+          "line": sourceLocation.line,
+          "column": sourceLocation.column,
+        ]
       ],
     ]