Make Polling into a function along the lines of Confirmation

Additionally, make PollingBehavior an implementation detail of polling, instead of exposed publicly
Removes any timeouts involved for polling, as they become increasingly unreliable
as the system runs more and more tests

Author: younata

Sources/Testing/Expectations/Expectation+Macro.swift

@@ -572,170 +572,3 @@ public macro require(
   sourceLocation: SourceLocation = #_sourceLocation,
   performing expression: @escaping @Sendable @convention(thin) () async throws -> Void
 ) -> ExitTest.Result = #externalMacro(module: "TestingMacros", type: "ExitTestRequireMacro")
-
-// MARK: - Polling Expectations
-
-/// Continuously check an expression until it matches the given PollingBehavior
-///
-/// - Parameters:
-///   - until: The desired PollingBehavior to check for.
-///   - timeout: How long to run poll the expression until stopping.
-///   - comment: A comment describing the expectation.
-///   - sourceLocation: The source location to which the recorded expectations
-///     and issues should be attributed.
-///   - expression: The expression to be evaluated.
-///
-/// Use this overload of `#expect()` when you wish to poll whether a value
-/// changes as the result of activity in another task/queue/thread.
-@_spi(Experimental)
-@available(macOS 13, iOS 17, watchOS 9, tvOS 17, visionOS 1, *)
-@freestanding(expression) public macro expect(
-    until pollingBehavior: PollingBehavior,
-    timeout: Duration = .seconds(60),
-    _ comment: @autoclosure () -> Comment? = nil,
-    sourceLocation: SourceLocation = #_sourceLocation,
-    expression: @Sendable () async throws -> Bool
-) = #externalMacro(module: "TestingMacros", type: "ExpectMacro")
-
-/// Continuously check an expression until it matches the given PollingBehavior
-///
-/// - Parameters:
-///   - until: The desired PollingBehavior to check for.
-///   - throws: The error the expression should throw.
-///   - timeout: How long to run poll the expression until stopping.
-///   - comment: A comment describing the expectation.
-///   - sourceLocation: The source location to which the recorded expectations
-///     and issues should be attributed.
-///   - expression: The expression to be evaluated.
-///
-/// Use this overload of `#expect()` when you wish to poll whether a value
-/// changes as the result of activity in another task/queue/thread.
-@_spi(Experimental)
-@available(macOS 13, iOS 17, watchOS 9, tvOS 17, visionOS 1, *)
-@freestanding(expression) public macro expect<E>(
-    until pollingBehavior: PollingBehavior,
-    throws error: E,
-    timeout: Duration = .seconds(60),
-    _ comment: @autoclosure () -> Comment? = nil,
-    sourceLocation: SourceLocation = #_sourceLocation,
-    expression: @Sendable () async throws -> Bool
-) = #externalMacro(module: "TestingMacros", type: "ExpectMacro")
-where E: Error & Equatable
-
-/// Continuously check an expression until it matches the given PollingBehavior
-///
-/// - Parameters:
-///   - until: The desired PollingBehavior to check for.
-///   - timeout: How long to run poll the expression until stopping.
-///   - comment: A comment describing the expectation.
-///   - sourceLocation: The source location to which the recorded expectations
-///     and issues should be attributed.
-///   - expression: The expression to be evaluated.
-///   - throws: A closure to confirm if the expression throws the expected error.
-///
-/// Use this overload of `#expect()` when you wish to poll whether a value
-/// changes as the result of activity in another task/queue/thread.
-@_spi(Experimental)
-@available(macOS 13, iOS 17, watchOS 9, tvOS 17, visionOS 1, *)
-@freestanding(expression) public macro expect(
-    until pollingBehavior: PollingBehavior,
-    timeout: Duration = .seconds(60),
-    _ comment: @autoclosure () -> Comment? = nil,
-    sourceLocation: SourceLocation = #_sourceLocation,
-    performing: @Sendable () async throws -> Bool,
-    throws errorMatcher: @Sendable (any Error) async throws -> Bool
-) = #externalMacro(module: "TestingMacros", type: "ExpectMacro")
-
-/// Continuously check an expression until it matches the given PollingBehavior
-///
-/// - Parameters:
-///   - until: The desired PollingBehavior to check for.
-///   - timeout: How long to run poll the expression until stopping.
-///   - comment: A comment describing the expectation.
-///   - sourceLocation: The source location to which the recorded expectations
-///     and issues should be attributed.
-///   - expression: The expression to be evaluated.
-///
-/// Use this overload of `#require()` when you wish to poll whether a value
-/// changes as the result of activity in another task/queue/thread.
-@_spi(Experimental)
-@available(macOS 13, iOS 17, watchOS 9, tvOS 17, visionOS 1, *)
-@freestanding(expression) public macro require(
-    until pollingBehavior: PollingBehavior,
-    timeout: Duration = .seconds(60),
-    _ comment: @autoclosure () -> Comment? = nil,
-    sourceLocation: SourceLocation = #_sourceLocation,
-    expression: @Sendable () async throws -> Bool
-) = #externalMacro(module: "TestingMacros", type: "RequireMacro")
-
-/// Continuously check an expression until it matches the given PollingBehavior
-///
-/// - Parameters:
-///   - until: The desired PollingBehavior to check for.
-///   - timeout: How long to run poll the expression until stopping.
-///   - comment: A comment describing the expectation.
-///   - sourceLocation: The source location to which the recorded expectations
-///     and issues should be attributed.
-///   - expression: The expression to be evaluated.
-///
-/// Use this overload of `#require()` when you wish to poll whether a value
-/// changes as the result of activity in another task/queue/thread.
-@_spi(Experimental)
-@available(macOS 13, iOS 17, watchOS 9, tvOS 17, visionOS 1, *)
-@freestanding(expression) public macro require<R>(
-    until pollingBehavior: PollingBehavior,
-    timeout: Duration = .seconds(60),
-    _ comment: @autoclosure () -> Comment? = nil,
-    sourceLocation: SourceLocation = #_sourceLocation,
-    expression: @Sendable () async throws -> R?
-) = #externalMacro(module: "TestingMacros", type: "RequireMacro")
-where R: Sendable
-
-/// Continuously check an expression until it matches the given PollingBehavior
-///
-/// - Parameters:
-///   - until: The desired PollingBehavior to check for.
-///   - throws: The error the expression should throw
-///   - timeout: How long to run poll the expression until stopping.
-///   - comment: A comment describing the expectation.
-///   - sourceLocation: The source location to which the recorded expectations
-///     and issues should be attributed.
-///   - expression: The expression to be evaluated.
-///
-/// Use this overload of `#require()` when you wish to poll whether a value
-/// changes as the result of activity in another task/queue/thread.
-@_spi(Experimental)
-@available(macOS 13, iOS 17, watchOS 9, tvOS 17, visionOS 1, *)
-@freestanding(expression) public macro require<E>(
-    until pollingBehavior: PollingBehavior,
-    throws error: E,
-    timeout: Duration = .seconds(60),
-    _ comment: @autoclosure () -> Comment? = nil,
-    sourceLocation: SourceLocation = #_sourceLocation,
-    expression: @Sendable () async throws -> Bool
-) = #externalMacro(module: "TestingMacros", type: "RequireMacro")
-where E: Error & Equatable
-
-/// Continuously check an expression until it matches the given PollingBehavior
-///
-/// - Parameters:
-///   - until: The desired PollingBehavior to check for.
-///   - timeout: How long to run poll the expression until stopping.
-///   - comment: A comment describing the expectation.
-///   - sourceLocation: The source location to which the recorded expectations
-///     and issues should be attributed.
-///   - expression: The expression to be evaluated.
-///   - throws: A closure to confirm if the expression throws the expected error.
-///
-/// Use this overload of `#require()` when you wish to poll whether a value
-/// changes as the result of activity in another task/queue/thread.
-@_spi(Experimental)
-@available(macOS 13, iOS 17, watchOS 9, tvOS 17, visionOS 1, *)
-@freestanding(expression) public macro require<E>(
-    until pollingBehavior: PollingBehavior,
-    timeout: Duration = .seconds(60),
-    _ comment: @autoclosure () -> Comment? = nil,
-    sourceLocation: SourceLocation = #_sourceLocation,
-    expression: @Sendable () async throws -> Bool,
-    throws errorMatcher: @Sendable (any Error) async throws -> Bool
-) = #externalMacro(module: "TestingMacros", type: "RequireMacro")

Sources/Testing/Expectations/ExpectationChecking+Macro.swift

@@ -1201,102 +1201,6 @@ public func __checkClosureCall<each T>(
 }
 #endif
 
-// MARK: - Polling
-
-@_spi(Experimental)
-@available(macOS 13, iOS 17, watchOS 9, tvOS 17, visionOS 1, *)
-public func __checkClosureCall(
-  until behavior: PollingBehavior,
-  timeout: Duration = .seconds(60),
-  performing closure: @escaping @Sendable () async throws -> Bool,
-  expression: __Expression,
-  comments: @autoclosure () -> [Comment],
-  isRequired: Bool,
-  sourceLocation: SourceLocation
-) async -> Result<Void, any Error> {
-  await callPolling(
-    behavior: behavior,
-    timeout: timeout,
-    closure: closure,
-    expression: expression,
-    comments: comments(),
-    isRequired: isRequired,
-    sourceLocation: sourceLocation
-  )
-}
-
-@_spi(Experimental)
-@available(macOS 13, iOS 17, watchOS 9, tvOS 17, visionOS 1, *)
-public func __checkClosureCall<E>(
-  until behavior: PollingBehavior,
-  throws error: E,
-  timeout: Duration = .seconds(60),
-  performing closure: @escaping @Sendable () async throws -> Bool,
-  expression: __Expression,
-  comments: @autoclosure () -> [Comment],
-  isRequired: Bool,
-  sourceLocation: SourceLocation
-) async -> Result<Void, any Error> where E: Error & Equatable {
-  await callPolling(
-    behavior: behavior,
-    throws: error,
-    timeout: timeout,
-    closure: closure,
-    expression: expression,
-    comments: comments(),
-    isRequired: isRequired,
-    sourceLocation: sourceLocation
-  )
-}
-
-@_spi(Experimental)
-@available(macOS 13, iOS 17, watchOS 9, tvOS 17, visionOS 1, *)
-public func __checkClosureCall(
-  until behavior: PollingBehavior,
-  timeout: Duration = .seconds(60),
-  performing closure: @escaping @Sendable () async throws -> Bool,
-  throws errorMatcher: @escaping @Sendable (any Error) async throws -> Bool,
-  expression: __Expression,
-  comments: @autoclosure () -> [Comment],
-  isRequired: Bool,
-  sourceLocation: SourceLocation
-) async -> Result<Void, any Error> {
-  await callPolling(
-    behavior: behavior,
-    timeout: timeout,
-    closure: closure,
-    errorMatcher: errorMatcher,
-    expression: expression,
-    comments: comments(),
-    isRequired: isRequired,
-    sourceLocation: sourceLocation
-  )
-}
-
-@_spi(Experimental)
-@available(macOS 13, iOS 17, watchOS 9, tvOS 17, visionOS 1, *)
-public func __checkClosureCall<R>(
-  until behavior: PollingBehavior,
-  timeout: Duration = .seconds(60),
-  performing closure: @escaping @Sendable () async throws -> R,
-  throws errorMatcher: @escaping @Sendable (any Error) async throws -> Bool,
-  expression: __Expression,
-  comments: @autoclosure () -> [Comment],
-  isRequired: Bool,
-  sourceLocation: SourceLocation
-) async -> Result<R, any Error> where R: Sendable {
-  await callPolling(
-    behavior: behavior,
-    timeout: timeout,
-    closure: closure,
-    errorMatcher: errorMatcher,
-    expression: expression,
-    comments: comments(),
-    isRequired: isRequired,
-    sourceLocation: sourceLocation
-  )
-}
-
 // MARK: -
 
 /// Generate a description of an error that includes its type name if not

Sources/Testing/Issues/Issue.swift

@@ -38,6 +38,9 @@ public struct Issue: Sendable {
     /// confirmed too few or too many times.
     indirect case confirmationMiscounted(actual: Int, expected: any RangeExpression & Sendable)
 
+    @_spi(Experimental)
+    case confirmationPollingFailed
+
     /// An issue due to an `Error` being thrown by a test function and caught by
     /// the testing library.
     ///
@@ -286,6 +289,8 @@ extension Issue.Kind: CustomStringConvertible {
         }
       }
       return "Confirmation was confirmed \(actual.counting("time")), but expected to be confirmed \(String(describingForTest: expected)) time(s)"
+    case .confirmationPollingFailed:
+      return "Confirmation polling failed"
     case let .errorCaught(error):
       return "Caught error: \(error)"
     case let .timeLimitExceeded(timeLimitComponents: timeLimitComponents):
@@ -465,6 +470,8 @@ extension Issue.Kind {
           .expectationFailed(Expectation.Snapshot(snapshotting: expectation))
       case .confirmationMiscounted:
           .unconditional
+      case .confirmationPollingFailed:
+          .unconditional
       case let .errorCaught(error), let .valueAttachmentFailed(error):
           .errorCaught(ErrorSnapshot(snapshotting: error))
       case let .timeLimitExceeded(timeLimitComponents: timeLimitComponents):