@swiftbrowser/swift 0.0.0-stage → 0.2.0

package/Sources/Combine/Helpers/ReduceProducer.swift

@@ -0,0 +1,249 @@
+//
+//  ReduceProducer.swift
+//  
+//
+//  Created by Sergej Jaskiewicz on 22.09.2019.
+//
+
+/// A helper class that acts like both subscriber and subscription.
+///
+/// Reduce-like operators send an instance of their `Inner` class that is subclass
+/// of this class to the upstream publisher (as subscriber) and
+/// to the downstream subscriber (as subscription).
+///
+/// Reduce-like operators include `Publishers.Reduce`, `Publishers.TryReduce`,
+/// `Publishers.Count`, `Publishers.FirstWhere`, `Publishers.AllSatisfy` and more.
+///
+/// Subclasses must override the `receive(newValue:)` and `description`.
+internal class ReduceProducer<Downstream: Subscriber,
+                              Input,
+                              Output,
+                              UpstreamFailure: Error,
+                              Reducer>
+    : CustomStringConvertible,
+      CustomReflectable
+    where Downstream.Input == Output
+{
+    // NOTE: This class has been audited for thread safety
+
+    // MARK: - State
+
+    internal final var result: Output?
+
+    private let initial: Output?
+
+    internal final let reduce: Reducer
+
+    private var status = SubscriptionStatus.awaitingSubscription
+
+    private let downstream: Downstream
+
+    private let lock = UnfairLock.allocate()
+
+    private var downstreamRequested = false
+
+    private var cancelled = false
+
+    private var completed = false
+
+    private var upstreamCompleted = false
+
+    internal init(downstream: Downstream, initial: Output?, reduce: Reducer) {
+        self.downstream = downstream
+        self.initial = initial
+        self.result = initial
+        self.reduce = reduce
+    }
+
+    deinit {
+        lock.deallocate()
+    }
+
+    // MARK: - Abstract methods
+
+    internal func receive(
+        newValue: Input
+    ) -> PartialCompletion<Void, Downstream.Failure> {
+        abstractMethod()
+    }
+
+    internal var description: String {
+        abstractMethod()
+    }
+
+    // MARK: - CustomReflectable
+
+    internal var customMirror: Mirror {
+        lock.lock()
+        defer { lock.unlock() }
+        let children: [Mirror.Child] = [
+            ("downstream", downstream),
+            ("result", result as Any),
+            ("initial", initial as Any),
+            ("status", status)
+        ]
+        return Mirror(self, children: children)
+    }
+
+    // MARK: - Private
+
+    /// - Precondition: `lock` is held.
+    private func receiveFinished() {
+        guard !cancelled, !completed, !upstreamCompleted else {
+            lock.unlock()
+            // This should never happen, because `receive(completion:)`
+            // (from which this function is called) early exists if
+            // `status` is `.terminal`.
+            assertionFailure("The subscription should have been terminated by now")
+            return
+        }
+        upstreamCompleted = true
+        if downstreamRequested {
+            self.completed = true
+        }
+        let completed = self.completed
+        let result = self.result
+        lock.unlock()
+
+        if completed {
+            sendResultAndFinish(result)
+        }
+    }
+
+    /// - Precondition: `lock` is held.
+    private func receiveFailure(_ failure: UpstreamFailure) {
+        guard !cancelled, !completed, !upstreamCompleted else {
+            lock.unlock()
+            // This should never happen, because `receive(completion:)`
+            // (from which this function is called) early exists if
+            // `status` is `.terminal`.
+            assertionFailure("The subscription should have been terminated by now")
+            return
+        }
+        upstreamCompleted = true
+        completed = true
+        lock.unlock()
+        downstream.receive(completion: .failure(failure as! Downstream.Failure))
+    }
+
+    private func sendResultAndFinish(_ result: Output?) {
+        assert(completed && upstreamCompleted)
+        if let result = result {
+            _ = downstream.receive(result)
+        }
+        downstream.receive(completion: .finished)
+    }
+
+    // MARK: -
+}
+
+extension ReduceProducer: Subscriber {
+    internal func receive(subscription: Subscription) {
+        lock.lock()
+        guard case .awaitingSubscription = status else {
+            lock.unlock()
+            subscription.cancel()
+            return
+        }
+        status = .subscribed(subscription)
+        lock.unlock()
+        downstream.receive(subscription: self)
+        subscription.request(.unlimited)
+    }
+
+    internal func receive(_ input: Input) -> Subscribers.Demand {
+        lock.lock()
+        guard case let .subscribed(subscription) = status else {
+            lock.unlock()
+            return .none
+        }
+        lock.unlock()
+
+        // Combine doesn't hold the lock when calling `receive(newValue:)`.
+        //
+        // This can lead to data races if the contract is violated
+        // (like when we receive input from multiple threads simultaneously).
+        switch self.receive(newValue: input) {
+        case .continue:
+            break
+        case .finished:
+            lock.lock()
+            upstreamCompleted = true
+            let downstreamRequested = self.downstreamRequested
+            if downstreamRequested {
+                completed = true
+            }
+            status = .terminal
+            let result = self.result
+            lock.unlock()
+
+            subscription.cancel()
+
+            guard downstreamRequested else { break }
+
+            sendResultAndFinish(result)
+        case let .failure(error):
+            lock.lock()
+            upstreamCompleted = true
+            completed = true
+            status = .terminal
+            lock.unlock()
+
+            subscription.cancel()
+            downstream.receive(completion: .failure(error))
+        }
+
+        return .none
+    }
+
+    internal func receive(completion: Subscribers.Completion<UpstreamFailure>) {
+        lock.lock()
+        guard case .subscribed = status else {
+            lock.unlock()
+            return
+        }
+        status = .terminal
+        switch completion {
+        case .finished:
+            receiveFinished()
+        case let .failure(error):
+            receiveFailure(error)
+        }
+    }
+}
+
+extension ReduceProducer: Subscription {
+    internal func request(_ demand: Subscribers.Demand) {
+        demand.assertNonZero()
+        lock.lock()
+        guard !downstreamRequested, !cancelled, !completed else {
+            lock.unlock()
+            return
+        }
+        downstreamRequested = true
+        guard upstreamCompleted else  {
+            lock.unlock()
+            return
+        }
+        completed = true
+        let result = self.result
+        lock.unlock()
+        sendResultAndFinish(result)
+    }
+
+    internal func cancel() {
+        lock.lock()
+        guard case let .subscribed(subscription) = status else {
+            lock.unlock()
+            return
+        }
+        cancelled = true
+        status = .terminal
+        lock.unlock()
+        subscription.cancel()
+    }
+}
+
+extension ReduceProducer: CustomPlaygroundDisplayConvertible {
+    internal var playgroundDescription: Any { return description }
+}

package/Sources/Combine/Helpers/SubjectSubscriber.swift

@@ -0,0 +1,96 @@
+//
+//  SubjectSubscriber.swift
+//  
+//
+//  Created by Sergej Jaskiewicz on 16/09/2019.
+//
+
+internal final class SubjectSubscriber<Downstream: Subject>
+    : Subscriber,
+      CustomStringConvertible,
+      CustomReflectable,
+      CustomPlaygroundDisplayConvertible,
+      Subscription
+{
+    private let lock = UnfairLock.allocate()
+    private weak var downstreamSubject: Downstream?
+    private var upstreamSubscription: Subscription?
+
+    private var isCancelled: Bool { return downstreamSubject == nil }
+
+    internal init(_ parent: Downstream) {
+        self.downstreamSubject = parent
+    }
+
+    deinit {
+        lock.deallocate()
+    }
+
+    internal func receive(subscription: Subscription) {
+        lock.lock()
+        guard upstreamSubscription == nil, let subject = downstreamSubject else {
+            lock.unlock()
+            return
+        }
+        upstreamSubscription = subscription
+        lock.unlock()
+        subject.send(subscription: self)
+    }
+
+    internal func receive(_ input: Downstream.Output) -> Subscribers.Demand {
+        lock.lock()
+        guard let subject = downstreamSubject, upstreamSubscription != nil else {
+            lock.unlock()
+            return .none
+        }
+        lock.unlock()
+        subject.send(input)
+        return .none
+    }
+
+    internal func receive(completion: Subscribers.Completion<Downstream.Failure>) {
+        lock.lock()
+        guard let subject = downstreamSubject, upstreamSubscription != nil else {
+            lock.unlock()
+            return
+        }
+        lock.unlock()
+        subject.send(completion: completion)
+        downstreamSubject = nil
+    }
+
+    internal var description: String { return "Subject" }
+
+    internal var playgroundDescription: Any { return description }
+
+    internal var customMirror: Mirror {
+        let children: [Mirror.Child] = [
+            ("downstreamSubject", downstreamSubject as Any),
+            ("upstreamSubscription", upstreamSubscription as Any),
+            ("subject", downstreamSubject as Any)
+        ]
+        return Mirror(self, children: children)
+    }
+
+    internal func request(_ demand: Subscribers.Demand) {
+        lock.lock()
+        guard let subscription = upstreamSubscription else {
+            lock.unlock()
+            return
+        }
+        lock.unlock()
+        subscription.request(demand)
+    }
+
+    internal func cancel() {
+        lock.lock()
+        guard !isCancelled, let subscription = upstreamSubscription else {
+            lock.unlock()
+            return
+        }
+        upstreamSubscription = nil
+        downstreamSubject = nil
+        lock.unlock()
+        subscription.cancel()
+    }
+}

package/Sources/Combine/Helpers/SubscriberTap.swift

@@ -0,0 +1,69 @@
+//
+//  SubscriberTap.swift
+//  
+//
+//  Created by Sergej Jaskiewicz on 27.09.2020.
+//
+
+internal protocol SubscriberTapMarker {
+    var inner: Any { mutating get }
+}
+
+internal struct SubscriberTap<Subscriber: Combine.Subscriber>
+: Combine.Subscriber,
+  CustomStringConvertible,
+  SubscriberTapMarker
+{
+    internal typealias Input = Subscriber.Input
+
+    internal typealias Failure = Subscriber.Failure
+
+    private let subscriber: Subscriber
+
+    internal lazy var inner: Any = AnySubscriber(self.subscriber)
+
+    internal init(subscriber: Subscriber) {
+        self.subscriber = subscriber
+    }
+
+    internal var combineIdentifier: CombineIdentifier {
+        return subscriber.combineIdentifier
+    }
+
+    internal func receive(subscription: Subscription) {
+        let hook = DebugHook.getGlobalHook()
+        if let subscriptionTap = subscription as? SubscriptionTap {
+            hook?.willReceive(subscriber: subscriber,
+                              subscription: subscriptionTap.subscription)
+            subscriber.receive(subscription: subscriptionTap)
+            hook?.didReceive(subscriber: subscriber,
+                             subscription: subscriptionTap.subscription)
+        } else {
+            hook?.willReceive(subscriber: subscriber, subscription: subscription)
+            subscriber
+                .receive(subscription: SubscriptionTap(subscription: subscription))
+            hook?.didReceive(subscriber: subscriber, subscription: subscription)
+        }
+    }
+
+    internal func receive(_ input: Input) -> Subscribers.Demand {
+        let hook = DebugHook.getGlobalHook()
+        hook?.willReceive(subscriber: subscriber, input: input)
+        let newDemand = subscriber.receive(input)
+        hook?.didReceive(subscriber: subscriber,
+                         input: input,
+                         resultingDemand: newDemand)
+        return newDemand
+    }
+
+    internal func receive(completion: Subscribers.Completion<Subscriber.Failure>) {
+        let hook = DebugHook.getGlobalHook()
+        hook?.willReceive(subscriber: subscriber, completion: completion)
+        subscriber.receive(completion: completion)
+        hook?.didReceive(subscriber: subscriber, completion: completion)
+    }
+
+    internal var description: String {
+        return String(describing: subscriber)
+    }
+}

package/Sources/Combine/Helpers/SubscriptionStatus.swift

@@ -0,0 +1,33 @@
+//
+//  SubscriptionStatus.swift
+//  
+//
+//  Created by Sergej Jaskiewicz on 21.09.2019.
+//
+
+internal enum SubscriptionStatus {
+    case awaitingSubscription
+    case subscribed(Subscription)
+    case pendingTerminal(Subscription)
+    case terminal
+}
+
+extension SubscriptionStatus {
+    internal var isAwaitingSubscription: Bool {
+        switch self {
+        case .awaitingSubscription:
+            return true
+        default:
+            return false
+        }
+    }
+
+    internal var subscription: Subscription? {
+        switch self {
+        case .awaitingSubscription, .terminal:
+            return nil
+        case let .subscribed(subscription), let .pendingTerminal(subscription):
+            return subscription
+        }
+    }
+}

package/Sources/Combine/Helpers/SubscriptionTap.swift

@@ -0,0 +1,33 @@
+//
+//  SubscriptionTap.swift
+//  
+//
+//  Created by Sergej Jaskiewicz on 27.09.2020.
+//
+
+internal struct SubscriptionTap: Subscription, CustomStringConvertible {
+
+    internal let subscription: Subscription
+
+    internal var combineIdentifier: CombineIdentifier {
+        return subscription.combineIdentifier
+    }
+
+    internal func request(_ demand: Subscribers.Demand) {
+        let hook = DebugHook.getGlobalHook()
+        hook?.willRequest(subscription: subscription, demand: demand)
+        subscription.request(demand)
+        hook?.didRequest(subscription: subscription, demand: demand)
+    }
+
+    internal func cancel() {
+        let hook = DebugHook.getGlobalHook()
+        hook?.willCancel(subscription: subscription)
+        subscription.cancel()
+        hook?.didCancel(subscription: subscription)
+    }
+
+    internal var description: String {
+        return String(describing: subscription)
+    }
+}

package/Sources/Combine/Helpers/Utils.swift

@@ -0,0 +1,30 @@
+//
+//  Utils.swift
+//
+//
+//  Created by Sergej Jaskiewicz on 28.08.2021.
+//
+
+internal protocol HasDefaultValue {
+    init()
+}
+
+extension HasDefaultValue {
+
+    @inline(__always)
+    internal mutating func take() -> Self {
+        let taken = self
+        self = .init()
+        return taken
+    }
+}
+
+extension Array: HasDefaultValue {}
+
+extension Dictionary: HasDefaultValue {}
+
+extension Optional: HasDefaultValue {
+    init() {
+        self = nil
+    }
+}

package/Sources/Combine/Helpers/Violations.swift

@@ -0,0 +1,33 @@
+//
+//  Violations.swift
+//  
+//
+//  Created by Sergej Jaskiewicz on 16/09/2019.
+//
+
+internal func APIViolationValueBeforeSubscription(file: StaticString = #file,
+                                                  line: UInt = #line) -> Never {
+    fatalError("""
+               API Violation: received an unexpected value before receiving a Subscription
+               """,
+               file: file,
+               line: line)
+}
+
+internal func APIViolationUnexpectedCompletion(file: StaticString = #file,
+                                               line: UInt = #line) -> Never {
+    fatalError("API Violation: received an unexpected completion", file: file, line: line)
+}
+
+internal func abstractMethod(file: StaticString = #file, line: UInt = #line) -> Never {
+    fatalError("Abstract method call", file: file, line: 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)
+        }
+    }
+}