Log the maximum allowed number of attempts.

fumoboy007 · Jun 5, 2024 · 416667f · 416667f
1 parent c3481fd
commit 416667f
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 2 deletions.
diff --git a/Sources/Retry/Logger+RetryMetadataKey.swift b/Sources/Retry/Logger+RetryMetadataKey.swift
@@ -25,6 +25,11 @@ import Logging
 extension Logger {
    /// The metadata keys used by the retry implementation.
    public enum RetryMetadataKey: String {
+      /// The maximum number of attempts that are allowed.
+      ///
+      /// The key will be absent if there is no configured maximum.
+      case maxAttempts = "retry.configuration.max_attempts"
+
       /// The one-based attempt number.
       case attemptNumber = "retry.attempt"
 

diff --git a/Sources/Retry/Retry.swift b/Sources/Retry/Retry.swift
@@ -290,6 +290,18 @@ public func retry<ClockType, ReturnType>(
 
    let recoverFromFailure = configuration.recoverFromFailure
 
+   if let maxAttempts {
+      logger?[metadataKey: .maxAttempts] = "\(maxAttempts)"
+   }
+#if canImport(OSLog)
+   let maxAttemptsSentenceFragment: String
+   if let maxAttempts {
+      maxAttemptsSentenceFragment = " of \(maxAttempts)"
+   } else {
+      maxAttemptsSentenceFragment = ""
+   }
+#endif
+
    var attempt = 1
    while true {
       var latestError: any Error
@@ -360,7 +372,7 @@ public func retry<ClockType, ReturnType>(
          ])
 #if canImport(OSLog)
          appleLogger?.debug("""
-         Attempt \(attempt, privacy: .public) failed with error of type `\(type(of: latestError), privacy: .public)`: `\(latestError)`. \
+         Attempt \(attempt, privacy: .public)\(maxAttemptsSentenceFragment, privacy: .public) failed with error of type `\(type(of: latestError), privacy: .public)`: `\(latestError)`. \
          Will wait \(String(describing: delay), privacy: .public) before retrying.
          """)
 #endif
@@ -405,7 +417,7 @@ public func retry<ClockType, ReturnType>(
          ])
 #if canImport(OSLog)
          appleLogger?.debug("""
-         Attempt \(attempt, privacy: .public) failed with error of type `\(type(of: latestError), privacy: .public)`: `\(latestError)`. \
+         Attempt \(attempt, privacy: .public)\(maxAttemptsSentenceFragment, privacy: .public) failed with error of type `\(type(of: latestError), privacy: .public)`: `\(latestError)`. \
          The `recoverFromFailure` closure requested a minimum delay of \(String(describing: minDelay)) before retrying. \
          Will wait \(String(describing: delay), privacy: .public) before retrying.
          """)