Skip to content

Commit

Permalink
Update Subscribers.Demand (#4)
Browse files Browse the repository at this point in the history 
* Update Subscribers.Demand

Align the implementation with Xcode 15 SDK Combine’s swiftinterface

* Update Demand.assertNonZero

* [Optimize] Align with Combine interface

* Fix WASM platform build issue

* Fix flacky test case on Xcode 14.3.1
  • Loading branch information
@Kyle-Ye
Kyle-Ye committed Dec 20, 2023
1 parent 3b505ba commit 0cd6e02
Show file tree
Hide file tree
Showing 5 changed files with 112 additions and 70 deletions.
6 changes: 3 additions & 3 deletions Sources/OpenCombine/AnySubscriber.swift
View file
Original file line number Diff line number Diff line change
Expand Up @@ -193,13 +193,13 @@ internal final class ClosureBasedAnySubscriber<Input, Failure: Error>
: AnySubscriberBase<Input, Failure>
{
@usableFromInline
internal let receiveSubscriptionThunk: (Subscription) -> Void
final internal let receiveSubscriptionThunk: (Subscription) -> Void

@usableFromInline
internal let receiveValueThunk: (Input) -> Subscribers.Demand
final internal let receiveValueThunk: (Input) -> Subscribers.Demand

@usableFromInline
internal let receiveCompletionThunk: (Subscribers.Completion<Failure>) -> Void
final internal let receiveCompletionThunk: (Subscribers.Completion<Failure>) -> Void

@inlinable
internal init(_ rcvSubscription: @escaping (Subscription) -> Void,
Expand Down
10 changes: 5 additions & 5 deletions Sources/OpenCombine/Helpers/Violations.swift
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,10 @@ internal func abstractMethod(file: StaticString = #file, line: UInt = #line) ->
}

extension Subscribers.Demand {
internal func assertNonZero(file: StaticString = #file,
line: UInt = #line) {
if self == .none {
fatalError("API Violation: demand must not be zero", file: file, line: line)
}
@_transparent
@inline(__always)
internal func assertNonZero() {
precondition(rawValue <= Subscribers.Demand.unlimited.rawValue)
precondition(rawValue > Subscribers.Demand.none.rawValue)
}
}
137 changes: 77 additions & 60 deletions Sources/OpenCombine/Subscribers/Subscribers.Demand.swift
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,9 @@ import _Concurrency

extension Subscribers {

/// A requested number of items, sent to a publisher from a subscriber through
/// the subscription.
public struct Demand: Equatable,
Comparable,
Hashable,
Codable,
CustomStringConvertible
{
/// A requested number of items, sent to a publisher from a subscriber through the subscription.
@frozen
public struct Demand: Equatable, Comparable, Hashable, Codable, CustomStringConvertible {
@usableFromInline
internal let rawValue: UInt

Expand All @@ -31,18 +26,12 @@ extension Subscribers {
}

/// A request for as many values as the publisher can produce.
@inline(__always)
@inlinable
public static var unlimited: Demand {
return Demand(rawValue: .max)
}
public static let unlimited = Demand(rawValue: .max)

/// A request for no elements from the publisher.
///
/// This is equivalent to `Demand.max(0)`.
@inline(__always)
@inlinable
public static var none: Demand { return .max(0) }
public static let none = Demand(rawValue: .zero)

/// Creates a demand for the given maximum number of elements.
///
Expand All @@ -54,7 +43,7 @@ extension Subscribers {
@inline(__always)
@inlinable
public static func max(_ value: Int) -> Demand {
precondition(value >= 0, "demand cannot be negative")
precondition(value >= 0, "Demand cannot be negative")
return Demand(rawValue: UInt(value))
}

Expand All @@ -71,15 +60,21 @@ extension Subscribers {
@inline(__always)
@inlinable
public static func + (lhs: Demand, rhs: Demand) -> Demand {
switch (lhs, rhs) {
case (.unlimited, _):
return .unlimited
case (_, .unlimited):
if lhs == .unlimited {
return .unlimited
default:
let (sum, isOverflow) = Int(lhs.rawValue)
.addingReportingOverflow(Int(rhs.rawValue))
return isOverflow ? .unlimited : .max(sum)
} else {
if rhs == .unlimited {
return .unlimited
} else {
let lhsValue: Int = numericCast(lhs.rawValue)
let rhsvalue: Int = numericCast(rhs.rawValue)
let r = lhsValue.addingReportingOverflow(rhsvalue)
if r.overflow {
return .unlimited
} else {
return .max(r.partialValue)
}
}
}
}

Expand All @@ -99,9 +94,15 @@ extension Subscribers {
public static func + (lhs: Demand, rhs: Int) -> Demand {
if lhs == .unlimited {
return .unlimited
} else {
let lhsValue: Int = numericCast(lhs.rawValue)
let r = lhsValue.addingReportingOverflow(rhs)
if r.overflow {
return .unlimited
} else {
return .max(r.partialValue)
}
}
let (sum, isOverflow) = Int(lhs.rawValue).addingReportingOverflow(rhs)
return isOverflow ? .unlimited : .max(sum)
}

/// Adds an integer to a demand, and assigns the result to the demand.
Expand All @@ -118,10 +119,15 @@ extension Subscribers {
public static func * (lhs: Demand, rhs: Int) -> Demand {
if lhs == .unlimited {
return .unlimited
} else {
let lhsValue: Int = numericCast(lhs.rawValue)
let r = lhsValue.multipliedReportingOverflow(by: rhs)
if r.overflow {
return .unlimited
} else {
return .max(r.partialValue)
}
}
let (product, isOverflow) = Int(lhs.rawValue)
.multipliedReportingOverflow(by: rhs)
return isOverflow ? .unlimited : .max(product)
}

/// Multiplies a demand by an integer, and assigns the result to the demand.
Expand All @@ -141,15 +147,21 @@ extension Subscribers {
@inline(__always)
@inlinable
public static func - (lhs: Demand, rhs: Demand) -> Demand {
switch (lhs, rhs) {
case (.unlimited, _):
if lhs == .unlimited {
return .unlimited
case (_, .unlimited):
return .none
default:
let (difference, isOverflow) = Int(lhs.rawValue)
.subtractingReportingOverflow(Int(rhs.rawValue))
return isOverflow ? .none : .max(difference)
} else {
if rhs == .unlimited {
return .none
} else {
let lhsValue: Int = numericCast(lhs.rawValue)
let rhsValue: Int = numericCast(rhs.rawValue)
let r = lhsValue.subtractingReportingOverflow(rhsValue)
if r.overflow {
return .max(0)
} else {
return .max(r.partialValue)
}
}
}
}

Expand All @@ -175,11 +187,15 @@ extension Subscribers {
public static func - (lhs: Demand, rhs: Int) -> Demand {
if lhs == .unlimited {
return .unlimited
} else {
let lhsValue: Int = numericCast(lhs.rawValue)
let r = lhsValue.subtractingReportingOverflow(rhs)
if r.overflow {
return .max(0)
} else {
return .max(r.partialValue)
}
}

let (difference, isOverflow) = Int(lhs.rawValue)
.subtractingReportingOverflow(rhs)
return isOverflow ? .none : .max(difference)
}

/// Subtracts an integer from a demand, and assigns the result to the demand.
Expand All @@ -204,7 +220,7 @@ extension Subscribers {
if lhs == .unlimited {
return true
} else {
return Int(lhs.rawValue) > rhs
return numericCast(lhs.rawValue) > rhs
}
}

Expand All @@ -218,7 +234,7 @@ extension Subscribers {
if lhs == .unlimited {
return true
} else {
return Int(lhs.rawValue) >= rhs
return numericCast(lhs.rawValue) >= rhs
}
}

Expand All @@ -232,7 +248,7 @@ extension Subscribers {
if rhs == .unlimited {
return false
} else {
return lhs > Int(rhs.rawValue)
return lhs > numericCast(rhs.rawValue)
}
}

Expand All @@ -246,7 +262,7 @@ extension Subscribers {
if rhs == .unlimited {
return false
} else {
return lhs >= Int(rhs.rawValue)
return lhs >= numericCast(rhs.rawValue)
}
}

Expand All @@ -260,7 +276,7 @@ extension Subscribers {
if lhs == .unlimited {
return false
} else {
return Int(lhs.rawValue) < rhs
return numericCast(lhs.rawValue) < rhs
}
}

Expand All @@ -274,7 +290,7 @@ extension Subscribers {
if rhs == .unlimited {
return true
} else {
return lhs < Int(rhs.rawValue)
return lhs < numericCast(rhs.rawValue)
}
}

Expand All @@ -288,7 +304,7 @@ extension Subscribers {
if lhs == .unlimited {
return false
} else {
return Int(lhs.rawValue) <= rhs
return numericCast(lhs.rawValue) <= rhs
}
}

Expand All @@ -302,7 +318,7 @@ extension Subscribers {
if rhs == .unlimited {
return true
} else {
return lhs <= Int(rhs.rawValue)
return lhs <= numericCast(rhs.rawValue)
}
}

Expand All @@ -316,6 +332,8 @@ extension Subscribers {
@inlinable
public static func < (lhs: Demand, rhs: Demand) -> Bool {
switch (lhs, rhs) {
case (.unlimited, .unlimited):
return false
case (.unlimited, _):
return false
case (_, .unlimited):
Expand Down Expand Up @@ -397,7 +415,7 @@ extension Subscribers {
if lhs == .unlimited {
return false
} else {
return Int(lhs.rawValue) == rhs
return numericCast(lhs.rawValue) == rhs
}
}

Expand All @@ -409,7 +427,7 @@ extension Subscribers {
if lhs == .unlimited {
return true
} else {
return Int(lhs.rawValue) != rhs
return numericCast(lhs.rawValue) != rhs
}
}

Expand Down Expand Up @@ -437,25 +455,20 @@ extension Subscribers {
}
}

@inlinable
public static func == (lhs: Demand, rhs: Demand) -> Bool {
return lhs.rawValue == rhs.rawValue
}

/// The number of requested values.
///
/// The value is `nil` if the demand is `Subscribers.Demand.unlimited`.
/// The value is `nil` if the demand is ``Subscribers/Demand/unlimited``.
@inlinable public var max: Int? {
if self == .unlimited {
return nil
} else {
return Int(rawValue)
return numericCast(rawValue)
}
}

/// Creates a demand instance from a decoder.
///
/// - Parameter decoder: The decoder of a previously-encoded `Subscribers.Demand`
/// - Parameter decoder: The decoder of a previously-encoded ``Subscribers.Demand``
/// instance.
public init(from decoder: Decoder) throws {
try self.init(rawValue: decoder.singleValueContainer().decode(UInt.self))
Expand All @@ -468,6 +481,10 @@ extension Subscribers {
var container = encoder.singleValueContainer()
try container.encode(rawValue)
}

public static func == (lhs: Demand, rhs: Demand) -> Bool {
return lhs.rawValue == rhs.rawValue
}
}
}

Expand Down
4 changes: 2 additions & 2 deletions Tests/OpenCombineTests/ConcurrencyTests/PublisherConcurrencyTests.swift
View file
Original file line number Diff line number Diff line change
Expand Up @@ -972,8 +972,8 @@ final class PublisherConcurrencyTests: XCTestCase {
}

XCTAssertEqual(numberOfTasksFinished, 3)
// FIXME: This test case will sometimes fail on macOS 13 + Xcode 15.0.1
#if swift(>=5.9) && canImport(Darwin)
// FIXME: This test case will sometimes fail on macOS 13 + Xcode 15.0.1/Xcode 14.3.1
#if swift(>=5.8) && canImport(Darwin)
#else
XCTAssertEqual(subscription.history, [.requested(.max(1)), .requested(.max(1))])
#endif
Expand Down
25 changes: 25 additions & 0 deletions Tests/OpenCombineTests/HelpersTests/ViolationsTests.swift
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
//
// ViolationsTests.swift
//
//
// Created by Kyle on 2023/11/18.
//

#if !OPENCOMBINE_COMPATIBILITY_TEST
@testable import OpenCombine
import XCTest

final class ViolationsTests: XCTestCase {
func testDemandAssertNonZero() {
let d0 = Subscribers.Demand.none
let d1 = Subscribers.Demand.max(1)
let d2 = Subscribers.Demand.unlimited

assertCrashes {
d0.assertNonZero()
}
d1.assertNonZero()
d2.assertNonZero()
}
}
#endif

0 comments on commit 0cd6e02

Please sign in to comment.