Clean up

Author: grdsdev

Package.swift

@@ -80,6 +80,6 @@ let package = Package(
 
 for target in package.targets where !target.isTest {
   target.swiftSettings = [
-    .enableUpcomingFeature("StrictConcurrency=complete")
+    .enableUpcomingFeature("StrictConcurrency=complete"),
   ]
 }

Sources/Realtime/Defaults.swift

@@ -57,7 +57,7 @@ public enum Defaults {
   public static let decode: (Data) -> Any? = { data in
     guard
       let json =
-        try? JSONSerialization
+      try? JSONSerialization
         .jsonObject(
           with: data,
           options: JSONSerialization.ReadingOptions()

Sources/Realtime/Message.swift

@@ -21,7 +21,7 @@
 import Foundation
 
 /// Data that is received from the Server.
-public class Message {
+public struct Message {
   /// Reference number. Empty if missing
   public let ref: String
 
@@ -36,7 +36,7 @@ public class Message {
 
   /// The raw payload from the Message, including a nested response from
   /// phx_reply events. It is recommended to use `payload` instead.
-  public let rawPayload: Payload
+  let rawPayload: Payload
 
   /// Message payload
   public var payload: Payload {
@@ -49,8 +49,8 @@ public class Message {
   /// ```swift
   /// message.payload["status"]
   /// ```
-  public var status: String? {
-    rawPayload["status"] as? String
+  public var status: PushStatus? {
+    (rawPayload["status"] as? String).flatMap(PushStatus.init(rawValue:))
   }
 
   init(
@@ -73,8 +73,8 @@ public class Message {
     ref = json[1] as? String ?? ""
 
     if let topic = json[2] as? String,
-      let event = json[3] as? String,
-      let payload = json[4] as? Payload
+       let event = json[3] as? String,
+       let payload = json[4] as? Payload
     {
       self.topic = topic
       self.event = event

Sources/Realtime/PhoenixTransport.swift

@@ -172,8 +172,8 @@ open class URLSessionTransport: NSObject, PhoenixTransport, URLSessionWebSocketD
     let endpoint = url.absoluteString
     let wsEndpoint =
       endpoint
-      .replacingOccurrences(of: "http://", with: "ws://")
-      .replacingOccurrences(of: "https://", with: "wss://")
+        .replacingOccurrences(of: "http://", with: "ws://")
+        .replacingOccurrences(of: "https://", with: "wss://")
 
     // Force unwrapping should be safe here since a valid URL came in and we just
     // replaced the protocol.

Sources/Realtime/Presence.swift

@@ -222,7 +222,7 @@ public final class Presence {
     joinRef = nil
     caller = Caller()
 
-    guard  // Do not subscribe to events if they were not provided
+    guard // Do not subscribe to events if they were not provided
       let stateEvent = opts.events[.state],
       let diffEvent = opts.events[.diff]
     else { return }

Sources/Realtime/Push.swift

@@ -44,7 +44,7 @@ public class Push {
   var timeoutWorkItem: DispatchWorkItem?
 
   /// Hooks into a Push. Where .receive("ok", callback(Payload)) are stored
-  var receiveHooks: [String: [Delegated<Message, Void>]]
+  var receiveHooks: [PushStatus: [Delegated<Message, Void>]]
 
   /// True if the Push has been sent
   var sent: Bool
@@ -89,7 +89,7 @@ public class Push {
   /// Sends the Push. If it has already timed out, then the call will
   /// be ignored and return early. Use `resend` in this case.
   public func send() {
-    guard !hasReceived(status: "timeout") else { return }
+    guard !hasReceived(status: .timeout) else { return }
 
     startTimeout()
     sent = true
@@ -120,7 +120,7 @@ public class Push {
   /// - parameter callback: Callback to fire when the status is recevied
   @discardableResult
   public func receive(
-    _ status: String,
+    _ status: PushStatus,
     callback: @escaping ((Message) -> Void)
   ) -> Push {
     var delegated = Delegated<Message, Void>()
@@ -146,7 +146,7 @@ public class Push {
   /// - parameter callback: Callback to fire when the status is recevied
   @discardableResult
   public func delegateReceive<Target: AnyObject>(
-    _ status: String,
+    _ status: PushStatus,
     to owner: Target,
     callback: @escaping ((Target, Message) -> Void)
   ) -> Push {
@@ -158,7 +158,7 @@ public class Push {
 
   /// Shared behavior between `receive` calls
   @discardableResult
-  func receive(_ status: String, delegated: Delegated<Message, Void>) -> Push {
+  func receive(_ status: PushStatus, delegated: Delegated<Message, Void>) -> Push {
     // If the message has already been received, pass it to the callback immediately
     if hasReceived(status: status), let receivedMessage {
       delegated.call(receivedMessage)
@@ -188,7 +188,7 @@ public class Push {
   ///
   /// - parameter status: Status which was received, e.g. "ok", "error", "timeout"
   /// - parameter response: Response that was received
-  private func matchReceive(_ status: String, message: Message) {
+  private func matchReceive(_ status: PushStatus, message: Message) {
     receiveHooks[status]?.forEach { $0.call(message) }
   }
 
@@ -237,7 +237,7 @@ public class Push {
 
     /// Setup and start the Timeout timer.
     let workItem = DispatchWorkItem {
-      self.trigger("timeout", payload: [:])
+      self.trigger(.timeout, payload: [:])
     }
 
     timeoutWorkItem = workItem
@@ -248,17 +248,17 @@ public class Push {
   ///
   /// - parameter status: Status to check
   /// - return: True if given status has been received by the Push.
-  func hasReceived(status: String) -> Bool {
+  func hasReceived(status: PushStatus) -> Bool {
     receivedMessage?.status == status
   }
 
   /// Triggers an event to be sent though the Channel
-  func trigger(_ status: String, payload: Payload) {
+  func trigger(_ status: PushStatus, payload: Payload) {
     /// If there is no ref event, then there is nothing to trigger on the channel
     guard let refEvent else { return }
 
     var mutPayload = payload
-    mutPayload["status"] = status
+    mutPayload["status"] = status.rawValue
 
     channel?.trigger(event: refEvent, payload: mutPayload)
   }

Sources/Realtime/RealtimeChannel.swift

@@ -68,32 +68,49 @@ public enum RealtimeListenTypes: String {
   case presence
 }
 
+/// Represents the broadcast and presence options for a channel.
 public struct RealtimeChannelOptions {
-  public var ack: Bool
-  public var this: Bool
-  public var key: String
+  /// Used to track presence payload across clients. Must be unique per client. If `nil`, the server
+  /// will generate one.
+  var presenceKey: String?
+  /// Enables the client to receive their own`broadcast` messages
+  var broadcastSelf: Bool
+  /// Instructs the server to acknowledge the client's `broadcast` messages
+  var broadcastAcknowledge: Bool
 
-  public init(ack: Bool = false, this: Bool = false, key: String = "") {
-    self.ack = ack
-    self.this = this
-    self.key = key
+  public init(
+    presenceKey: String? = nil,
+    broadcastSelf: Bool = false,
+    broadcastAcknowledge: Bool = false
+  ) {
+    self.presenceKey = presenceKey
+    self.broadcastSelf = broadcastSelf
+    self.broadcastAcknowledge = broadcastAcknowledge
   }
 
-  var asDictionary: [String: Any] {
+  /// Parameters used to configure the channel
+  var params: [String: [String: Any]] {
     [
       "config": [
-        "broadcast": [
-          "ack": ack,
-          "self": this,
-        ],
         "presence": [
-          "key": key
+          "key": presenceKey ?? "",
         ],
-      ]
+        "broadcast": [
+          "ack": broadcastAcknowledge,
+          "self": broadcastSelf,
+        ],
+      ],
     ]
   }
 }
 
+/// Represents the different status of a push
+public enum PushStatus: String {
+  case ok
+  case error
+  case timeout
+}
+
 public enum RealtimeSubscribeStates {
   case subscribed
   case timedOut
@@ -218,7 +235,7 @@ public class RealtimeChannel {
     )
 
     /// Handle when a response is received after join()
-    joinPush.delegateReceive("ok", to: self) { (self, _) in
+    joinPush.delegateReceive(.ok, to: self) { (self, _) in
       // Mark the RealtimeChannel as joined
       self.state = ChannelState.joined
 
@@ -231,13 +248,13 @@ public class RealtimeChannel {
     }
 
     // Perform if RealtimeChannel errors while attempting to joi
-    joinPush.delegateReceive("error", to: self) { (self, _) in
+    joinPush.delegateReceive(.error, to: self) { (self, _) in
       self.state = .errored
       if self.socket?.isConnected == true { self.rejoinTimer.scheduleTimeout() }
     }
 
     // Handle when the join push times out when sending after join()
-    joinPush.delegateReceive("timeout", to: self) { (self, _) in
+    joinPush.delegateReceive(.timeout, to: self) { (self, _) in
       // log that the channel timed out
       self.socket?.logItems(
         "channel", "timeout \(self.topic) \(self.joinRef ?? "") after \(self.timeout)s"
@@ -357,7 +374,7 @@ public class RealtimeChannel {
 
     var accessTokenPayload: Payload = [:]
     var config: Payload = [
-      "postgres_changes": bindings.value["postgres_changes"]?.map(\.filter) ?? []
+      "postgres_changes": bindings.value["postgres_changes"]?.map(\.filter) ?? [],
     ]
 
     config["broadcast"] = broadcast
@@ -373,7 +390,7 @@ public class RealtimeChannel {
     rejoin()
 
     joinPush
-      .delegateReceive("ok", to: self) { (self, message) in
+      .delegateReceive(.ok, to: self) { (self, message) in
         if self.socket?.accessToken != nil {
           self.socket?.setAuth(self.socket?.accessToken)
         }
@@ -388,7 +405,7 @@ public class RealtimeChannel {
         let bindingsCount = clientPostgresBindings.count
         var newPostgresBindings: [Binding] = []
 
-        for i in 0..<bindingsCount {
+        for i in 0 ..< bindingsCount {
           let clientPostgresBinding = clientPostgresBindings[i]
 
           let event = clientPostgresBinding.filter["event"]
@@ -399,9 +416,9 @@ public class RealtimeChannel {
           let serverPostgresFilter = serverPostgresFilters[i]
 
           if serverPostgresFilter["event", as: String.self] == event,
-            serverPostgresFilter["schema", as: String.self] == schema,
-            serverPostgresFilter["table", as: String.self] == table,
-            serverPostgresFilter["filter", as: String.self] == filter
+             serverPostgresFilter["schema", as: String.self] == schema,
+             serverPostgresFilter["table", as: String.self] == table,
+             serverPostgresFilter["filter", as: String.self] == filter
           {
             newPostgresBindings.append(
               Binding(
@@ -426,12 +443,12 @@ public class RealtimeChannel {
         }
         callback?(.subscribed, nil)
       }
-      .delegateReceive("error", to: self) { _, message in
+      .delegateReceive(.error, to: self) { _, message in
         let values = message.payload.values.map { "\($0) " }
         let error = RealtimeError(values.isEmpty ? "error" : values.joined(separator: ", "))
         callback?(.channelError, error)
       }
-      .delegateReceive("timeout", to: self) { _, _ in
+      .delegateReceive(.timeout, to: self) { _, _ in
         callback?(.timedOut, nil)
       }
 
@@ -646,7 +663,7 @@ public class RealtimeChannel {
   /// "event" and nothing is printed if the channel receives "other_event".
   ///
   /// - parameter event: Event to unsubscribe from
-  /// - paramter ref: Ref counter returned when subscribing. Can be omitted
+  /// - parameter ref: Ref counter returned when subscribing. Can be omitted
   public func off(_ type: String, filter: [String: String] = [:]) {
     bindings.withValue {
       $0[type.lowercased()] = $0[type.lowercased(), default: []].filter { bind in
@@ -716,7 +733,7 @@ public class RealtimeChannel {
           "topic": subTopic,
           "payload": payload,
           "event": event as Any,
-        ]
+        ],
       ]
 
       do {
@@ -731,7 +748,7 @@ public class RealtimeChannel {
         guard let httpResponse = response as? HTTPURLResponse else {
           return .error
         }
-        if 200..<300 ~= httpResponse.statusCode {
+        if 200 ..< 300 ~= httpResponse.statusCode {
           return .ok
         }
 
@@ -747,8 +764,8 @@ public class RealtimeChannel {
         )
 
         if let type = payload["type"] as? String, type == "broadcast",
-          let config = self.params["config"] as? [String: Any],
-          let broadcast = config["broadcast"] as? [String: Any]
+           let config = self.params["config"] as? [String: Any],
+           let broadcast = config["broadcast"] as? [String: Any]
         {
           let ack = broadcast["ack"] as? Bool
           if ack == nil || ack == false {
@@ -758,10 +775,10 @@ public class RealtimeChannel {
         }
 
         push
-          .receive("ok") { _ in
+          .receive(.ok) { _ in
             continuation.resume(returning: .ok)
           }
-          .receive("timeout") { _ in
+          .receive(.timeout) { _ in
             continuation.resume(returning: .timedOut)
           }
       }
@@ -811,12 +828,14 @@ public class RealtimeChannel {
     // Perform the same behavior if successfully left the channel
     // or if sending the event timed out
     leavePush
-      .receive("ok", delegated: onCloseDelegate)
-      .receive("timeout", delegated: onCloseDelegate)
+      .receive(.ok, delegated: onCloseDelegate)
+      .receive(.timeout, delegated: onCloseDelegate)
     leavePush.send()
 
     // If the RealtimeChannel cannot send push events, trigger a success locally
-    if !canPush { leavePush.trigger("ok", payload: [:]) }
+    if !canPush {
+      leavePush.trigger(.ok, payload: [:])
+    }
 
     // Return the push so it can be bound to
     return leavePush
@@ -908,10 +927,12 @@ public class RealtimeChannel {
           if let bindId = bind.id.flatMap(Int.init) {
             let ids = message.payload["ids", as: [Int].self] ?? []
             return ids.contains(bindId)
-              && (bindEvent == "*"
-                || bindEvent
+              && (
+                bindEvent == "*"
+                  || bindEvent
                   == message.payload["data", as: [String: Any].self]?["type", as: String.self]?
-                  .lowercased())
+                  .lowercased()
+              )
           }
 
           return bindEvent == "*"