Add isolation to withExpectedIssue and withIssueContext (#147)

* Add isolation to `withExpectedIssue` and `withIssueContext`

* wip

Author: stephencelis

Examples/ExamplesTests/SwiftTestingTests.swift

@@ -88,9 +88,14 @@
       @Test func withExpectedIssueDoesNotFail() {
         withExpectedIssue {}
       }
+
+      @Test func withExpectedIssueDoesNotFailAsync() async {
+        await withExpectedIssue {
+          await Task.yield()
+        }
+      }
     }
   #endif
-
 #endif
 
 private struct Failure: Error {}

Sources/IssueReporting/Documentation.docc/Extensions/withExpectedIssue.md

@@ -1,7 +1,7 @@
-# ``IssueReporting/withExpectedIssue(_:isIntermittent:fileID:filePath:line:column:_:)-9pinm``
+# ``IssueReporting/withExpectedIssue(_:isIntermittent:fileID:filePath:line:column:_:)``
 
 ## Topics
 
 ### Overloads
 
-- ``IssueReporting/withExpectedIssue(_:isIntermittent:fileID:filePath:line:column:_:)-7noz2``
+- ``IssueReporting/withExpectedIssue(_:isIntermittent:isolation:fileID:filePath:line:column:_:)``

Sources/IssueReporting/Documentation.docc/Extensions/withIssueContext.md

@@ -1,7 +1,7 @@
-# ``IssueReporting/withIssueContext(fileID:filePath:line:column:operation:)-97lux``
+# ``IssueReporting/withIssueContext(fileID:filePath:line:column:operation:)``
 
 ## Topics
 
 ### Overloads
 
-- ``withIssueContext(fileID:filePath:line:column:operation:)-6o3dr``
+- ``withIssueContext(fileID:filePath:line:column:isolation:operation:)``

Sources/IssueReporting/Internal/AppHostWarning.swift

@@ -38,7 +38,7 @@ extension String {
 
         For more information (and workarounds), see "Testing gotchas":
 
-        https://pointfreeco.github.io/swift-dependencies/main/documentation/dependencies/testing#Testing-gotchas
+        https://swiftpackageindex.com/pointfreeco/swift-dependencies/main/documentation/dependencies/testing#Testing-gotchas
         """
 
       return isEmpty

Sources/IssueReporting/Internal/SwiftTesting.swift

@@ -148,6 +148,7 @@ func _withKnownIssue(
         To fix this, add "IssueReportingTestSupport" as a dependency to your test target.
         """
       )
+      try? body()
     #endif
     return
   }
@@ -166,73 +167,151 @@ func _withKnownIssue(
   withKnownIssue(message, isIntermittent, fileID, filePath, line, column, body)
 }
 
-@usableFromInline
-func _withKnownIssue(
-  _ message: String? = nil,
-  isIntermittent: Bool = false,
-  fileID: String = #fileID,
-  filePath: String = #filePath,
-  line: Int = #line,
-  column: Int = #column,
-  _ body: () async throws -> Void
-) async {
-  guard let function = function(for: "$s25IssueReportingTestSupport010_withKnownA5AsyncypyF")
-  else {
-    #if DEBUG
-      guard
-        let withKnownIssue = unsafeBitCast(
-          symbol: """
-            $s7Testing14withKnownIssue_14isIntermittent14sourceLocation_yAA7CommentVSg_SbAA06Source\
-            H0VyyYaKXEtYaFTu
-            """,
-          in: "Testing",
-          to: (@convention(thin) (
-            Any?,
-            Bool,
-            SourceLocation,
-            () async throws -> Void
-          ) async -> Void)
-          .self
+#if compiler(>=6.0.2)
+  @usableFromInline
+  func _withKnownIssue(
+    _ message: String?,
+    isIntermittent: Bool,
+    isolation: isolated (any Actor)?,
+    fileID: String,
+    filePath: String,
+    line: Int,
+    column: Int,
+    _ body: () async throws -> Void
+  ) async {
+    guard
+      let function = function(for: "$s25IssueReportingTestSupport010_withKnownA13AsyncIsolatedypyF")
+    else {
+      #if DEBUG
+        guard
+          let withKnownIssue = unsafeBitCast(
+            symbol: """
+              $s7Testing14withKnownIssue_14isIntermittent9isolation14sourceLocation_yAA7CommentVSg_\
+              SbScA_pSgYiAA06SourceI0VyyYaKXEtYaF
+              """,
+            in: "Testing",
+            to: (@convention(thin) (
+              Any?,
+              Bool,
+              isolated (any Actor)?,
+              SourceLocation,
+              () async throws -> Void
+            ) async -> Void)
+            .self
+          )
+        else { return }
+
+        var comment: Any?
+        if let message {
+          var c = UnsafeMutablePointer<Comment>.allocate(capacity: 1).pointee
+          c.rawValue = message
+          comment = c
+        }
+        await withKnownIssue(
+          comment,
+          isIntermittent,
+          isolation,
+          SourceLocation(fileID: fileID, _filePath: filePath, line: line, column: column),
+          body
         )
-      else { return }
+      #else
+        printError(
+          """
+          \(fileID):\(line): A known issue was recorded without linking the Testing framework.
 
-      var comment: Any?
-      if let message {
-        var c = UnsafeMutablePointer<Comment>.allocate(capacity: 1).pointee
-        c.rawValue = message
-        comment = c
-      }
-      await withKnownIssue(
-        comment,
-        isIntermittent,
-        SourceLocation(fileID: fileID, _filePath: filePath, line: line, column: column),
-        body
-      )
-    #else
-      printError(
-        """
-        \(fileID):\(line): A known issue was recorded without linking the Testing framework.
+          To fix this, add "IssueReportingTestSupport" as a dependency to your test target.
+          """
+        )
+        try? await body()
+      #endif
+      return
+    }
 
-        To fix this, add "IssueReportingTestSupport" as a dependency to your test target.
-        """
-      )
-    #endif
-    return
+    let withKnownIssue =
+      function
+      as! @Sendable (
+        String?,
+        Bool,
+        isolated (any Actor)?,
+        String,
+        String,
+        Int,
+        Int,
+        () async throws -> Void
+      ) async -> Void
+    await withKnownIssue(message, isIntermittent, isolation, fileID, filePath, line, column, body)
   }
+#else
+  @usableFromInline
+  func _withKnownIssue(
+    _ message: String?,
+    isIntermittent: Bool,
+    fileID: String,
+    filePath: String,
+    line: Int,
+    column: Int,
+    _ body: () async throws -> Void
+  ) async {
+    guard let function = function(for: "$s25IssueReportingTestSupport010_withKnownA5AsyncypyF")
+    else {
+      #if DEBUG
+        guard
+          let withKnownIssue = unsafeBitCast(
+            symbol: """
+              $s7Testing14withKnownIssue_14isIntermittent14sourceLocation_yAA7CommentVSg_SbAA06Sour\
+              ceH0VyyYaKXEtYaFTu
+              """,
+            in: "Testing",
+            to: (@convention(thin) (
+              Any?,
+              Bool,
+              SourceLocation,
+              () async throws -> Void
+            ) async -> Void)
+            .self
+          )
+        else { return }
+
+        var comment: Any?
+        if let message {
+          var c = UnsafeMutablePointer<Comment>.allocate(capacity: 1).pointee
+          c.rawValue = message
+          comment = c
+        }
+        await withKnownIssue(
+          comment,
+          isIntermittent,
+          SourceLocation(fileID: fileID, _filePath: filePath, line: line, column: column),
+          body
+        )
+      #else
+        printError(
+          """
+          \(fileID):\(line): A known issue was recorded without linking the Testing framework.
+
+          To fix this, add "IssueReportingTestSupport" as a dependency to your test target.
+          """
+        )
+      #endif
+      return
+    }
+
+    let withKnownIssue =
+      function
+      as! @Sendable (
+        String?,
+        Bool,
+        String,
+        String,
+        Int,
+        Int,
+        () async throws -> Void
+      ) async -> Void
+    await withKnownIssue(message, isIntermittent, fileID, filePath, line, column, body)
+  }
+
+#endif
 
-  let withKnownIssue =
-    function
-    as! @Sendable (
-      String?,
-      Bool,
-      String,
-      String,
-      Int,
-      Int,
-      () async throws -> Void
-    ) async -> Void
-  await withKnownIssue(message, isIntermittent, fileID, filePath, line, column, body)
-}
 @usableFromInline
 func _currentTestID() -> AnyHashable? {
   guard let function = function(for: "$s25IssueReportingTestSupport08_currentC2IDypyF")

Sources/IssueReporting/Internal/XCTest.swift

@@ -33,7 +33,8 @@ func _XCTFail(
     #endif
     printError(
       """
-      \(file):\(line): A failure was recorded without linking the XCTest framework.
+      \(file):\(line): A failure was recorded without linking the XCTest framework\
+      \(message.isEmpty ? "" : ": \(message)")
 
       To fix this, add "IssueReportingTestSupport" as a dependency to your test target.
       """