Add throttle overloads that take types (#1101)

Co-authored-by: Cristian Díaz <[email protected]>

Author: mluisbrown

Sources/ComposableArchitecture/Effects/Throttling.swift

@@ -59,6 +59,29 @@ extension Effect {
       }
       .cancellable(id: id, cancelInFlight: true)
   }
+
+  /// Throttles an effect so that it only publishes one output per given interval.
+  ///
+  /// A convenience for calling ``Effect/throttle(id:for:scheduler:latest:)-5jfpx`` with a static
+  /// type as the effect's unique identifier.
+  ///
+  /// - Parameters:
+  ///   - id: The effect's identifier.
+  ///   - interval: The interval at which to find and emit the most recent element, expressed in
+  ///     the time system of the scheduler.
+  ///   - scheduler: The scheduler you want to deliver the throttled output to.
+  ///   - latest: A boolean value that indicates whether to publish the most recent element. If
+  ///     `false`, the publisher emits the first element received during the interval.
+  /// - Returns: An effect that emits either the most-recent or first element received during the
+  ///   specified interval.
+  public func throttle(
+    id: Any.Type,
+    for interval: TimeInterval,
+    scheduler: DateScheduler,
+    latest: Bool
+  ) -> Effect {
+    self.throttle(id: ObjectIdentifier(id), for: interval, scheduler: scheduler, latest: latest)
+  }
 }
 
 var throttleTimes: [AnyHashable: Any] = [:]

Tests/ComposableArchitectureTests/EffectThrottleTests.swift

@@ -11,13 +11,13 @@ final class EffectThrottleTests: XCTestCase {
     var effectRuns = 0
 
     func runThrottledEffect(value: Int) {
-      struct CancelToken: Hashable {}
+      enum CancelToken {}
 
       Effect.deferred { () -> Effect<Int, Never> in
         effectRuns += 1
         return .init(value: value)
       }
-      .throttle(id: CancelToken(), for: 1, scheduler: scheduler, latest: true)
+      .throttle(id: CancelToken.self, for: 1, scheduler: scheduler, latest: true)
       .startWithValues { values.append($0) }
     }
 
@@ -61,13 +61,13 @@ final class EffectThrottleTests: XCTestCase {
     var effectRuns = 0
 
     func runThrottledEffect(value: Int) {
-      struct CancelToken: Hashable {}
+      enum CancelToken {}
 
       Effect.deferred { () -> Effect<Int, Never> in
         effectRuns += 1
         return .init(value: value)
       }
-      .throttle(id: CancelToken(), for: 1, scheduler: scheduler, latest: false)
+      .throttle(id: CancelToken.self, for: 1, scheduler: scheduler, latest: false)
       .startWithValues { values.append($0) }
     }
 
@@ -124,13 +124,13 @@ final class EffectThrottleTests: XCTestCase {
     var effectRuns = 0
 
     func runThrottledEffect(value: Int) {
-      struct CancelToken: Hashable {}
+      enum CancelToken {}
 
       Effect.deferred { () -> Effect<Int, Never> in
         effectRuns += 1
         return .init(value: value)
       }
-      .throttle(id: CancelToken(), for: 1, scheduler: scheduler, latest: true)
+      .throttle(id: CancelToken.self, for: 1, scheduler: scheduler, latest: true)
       .startWithValues { values.append($0) }
     }
 
@@ -165,14 +165,14 @@ final class EffectThrottleTests: XCTestCase {
     var effectRuns = 0
 
     func runThrottledEffect(value: Int) {
-      struct CancelToken: Hashable {}
+      enum CancelToken {}
 
       Effect.deferred { () -> Effect<Int, Never> in
         effectRuns += 1
         return .init(value: value)
       }
       .throttle(
-        id: CancelToken(), for: 1, scheduler: scheduler, latest: false
+        id: CancelToken.self, for: 1, scheduler: scheduler, latest: false
       )
       .startWithValues { values.append($0) }
     }