Fix unsubscribe, align syntax closer to JS SDK, add redirect and update query

cbaker6 · cbaker6 · commit c2c7e14b801d · 2021-01-08T11:15:05.000-05:00
diff --git a/ParseSwift.playground/Pages/11 - LiveQuery.xcplaygroundpage/Contents.swift b/ParseSwift.playground/Pages/11 - LiveQuery.xcplaygroundpage/Contents.swift
@@ -38,18 +38,13 @@ let subscription = query.subscribe!
 
 //: This is how you receive notifications about the success
 //: of your subscription.
-subscription.handleSubscribe { _ in
-    print("Successfully subscribed to query")
-
-    //: You can check this subscription is for this query
-    do {
-        if try ParseLiveQuery.getDefault()!.isSubscribed(query) {
-            print("Subscribed")
-        } else {
-            print("Not Subscribed")
-        }
-    } catch {
-        fatalError("Error checking if subscribed...")
+subscription.handleSubscribe { subscribedQuery, isNew in
+
+    //: You can check this subscription is for this query\
+    if isNew {
+        print("Successfully subscribed to new query \(subscribedQuery)")
+    } else {
+        print("Successfully updated subscription to new query \(subscribedQuery)")
     }
 }
 
@@ -73,17 +68,17 @@ subscription.handleEvent { _, event in
 //: Now go to your dashboard, goto the GameScore table and add, update, remove rows.
 //: You should receive notifications for each.
 
-//: To update the query for your subscription.
-query = GameScore.query("score" > 40)
-query.update(subscription)
-
 //: This is how you register to receive notificaitons about being unsubscribed.
 subscription.handleUnsubscribe { query in
     print("Unsubscribed from \(query)")
 }
 
 //: To unsubscribe from your query.
-query.unsubscribe()
+do {
+    try query.unsubscribe()
+} catch {
+    print(error)
+}
 
 PlaygroundPage.current.finishExecution()
 //: [Next](@next)
diff --git a/Sources/ParseSwift/LiveQuery/Messages.swift b/Sources/ParseSwift/LiveQuery/Messages.swift
@@ -10,15 +10,15 @@ import Foundation
 
 // MARK: Sending
 struct StandardMessage: LiveQueryable, Encodable {
-    var op: Operation // swiftlint:disable:this identifier_name
+    var op: ClientOperation // swiftlint:disable:this identifier_name
     var applicationId: String?
     var clientKey: String?
     var masterKey: String? // swiftlint:disable:this inclusive_language
     var sessionToken: String?
     var installationId: String?
     var requestId: Int?
 
-    init(operation: Operation, additionalProperties: Bool = false) {
+    init(operation: ClientOperation, additionalProperties: Bool = false) {
         self.op = operation
         if additionalProperties {
             self.applicationId = ParseConfiguration.applicationId
@@ -29,7 +29,7 @@ struct StandardMessage: LiveQueryable, Encodable {
         }
     }
 
-    init(operation: Operation, requestId: RequestId) {
+    init(operation: ClientOperation, requestId: RequestId) {
         self.init(operation: operation)
         self.requestId = requestId.value
     }
@@ -42,15 +42,15 @@ struct SubscribeQuery: Encodable {
 }
 
 struct SubscribeMessage<T: ParseObject>: LiveQueryable, Encodable {
-    var op: Operation // swiftlint:disable:this identifier_name
+    var op: ClientOperation // swiftlint:disable:this identifier_name
     var applicationId: String?
     var clientKey: String?
     var sessionToken: String?
     var installationId: String?
     var requestId: Int?
     var query: SubscribeQuery?
 
-    init(operation: Operation,
+    init(operation: ClientOperation,
          requestId: RequestId,
          query: Query<T>? = nil,
          additionalProperties: Bool = false) {
@@ -64,17 +64,22 @@ struct SubscribeMessage<T: ParseObject>: LiveQueryable, Encodable {
 }
 
 // MARK: Receiving
+struct RedirectResponse: LiveQueryable, Decodable {
+    let op: ServerResponse // swiftlint:disable:this identifier_name
+    let url: URL
+}
+
 struct ConnectionResponse: LiveQueryable, Decodable {
-    let op: OperationResponses // swiftlint:disable:this identifier_name
+    let op: ServerResponse // swiftlint:disable:this identifier_name
 }
 
 struct UnsubscribedResponse: LiveQueryable, Decodable {
-    let op: OperationResponses // swiftlint:disable:this identifier_name
+    let op: ServerResponse // swiftlint:disable:this identifier_name
     let requestId: Int
 }
 
 struct EventResponse<T: ParseObject>: LiveQueryable, Decodable {
-    let op: OperationResponses // swiftlint:disable:this identifier_name
+    let op: ServerResponse // swiftlint:disable:this identifier_name
     let requestId: Int
     let object: T
 }
@@ -87,6 +92,6 @@ struct ErrorResponse: LiveQueryable, Decodable {
 }
 
 struct PreliminaryMessageResponse: LiveQueryable, Decodable {
-    let op: OperationResponses // swiftlint:disable:this identifier_name
+    let op: ServerResponse // swiftlint:disable:this identifier_name
     let requestId: Int
 }
diff --git a/Sources/ParseSwift/LiveQuery/Operations.swift b/Sources/ParseSwift/LiveQuery/Operations.swift
@@ -8,14 +8,15 @@
 
 import Foundation
 
-enum Operation: String, Encodable {
+enum ClientOperation: String, Encodable {
     case connect
     case subscribe
     case unsubscribe
+    case update
 }
 
-enum OperationResponses: String, Decodable {
-    case connected, subscribed, unsubscribed,
+enum ServerResponse: String, Decodable {
+    case connected, subscribed, unsubscribed, redirect,
          create, enter, update, leave, delete
 }
 
diff --git a/Sources/ParseSwift/LiveQuery/ParseLiveQuery.swift b/Sources/ParseSwift/LiveQuery/ParseLiveQuery.swift
@@ -217,6 +217,18 @@ extension ParseLiveQuery: LiveQuerySocketDelegate {
 
     func received(_ data: Data) {
 
+        if let redirect = try? ParseCoding.jsonDecoder().decode(RedirectResponse.self, from: data) {
+            if redirect.op == .redirect {
+                url = redirect.url
+                if isConnected {
+                    try? self.close(false)
+                    //Try to reconnect
+                    self.createTask()
+                }
+            }
+            return
+        }
+
         if !self.isConnected {
             //Check if this is a connected response
             guard let response = try? ParseCoding.jsonDecoder().decode(ConnectionResponse.self, from: data),
@@ -261,11 +273,22 @@ extension ParseLiveQuery: LiveQuerySocketDelegate {
 
                 switch preliminaryMessage.op {
                 case .subscribed:
+
                     if let subscribed = pendingQueue
                         .first(where: { $0.0.value == preliminaryMessage.requestId }) {
+                        let requestId = RequestId(value: preliminaryMessage.requestId)
+                        let isNew: Bool!
+                        if subscriptions[requestId] != nil {
+                            isNew = false
+                            /*pendingQueue.removeAll(where: { $0.0.value == preliminaryMessage.requestId })
+                            subscriptions[subscribed.0] = subscribed.1
+                            subscribed.1.subscribeHandlerClosure?(false)*/
+                        } else {
+                            isNew = true
+                        }
                         removePendingSubscription(subscribed.0.value)
                         subscriptions[subscribed.0] = subscribed.1
-                        subscribed.1.subscribeHandlerClosure?()
+                        subscribed.1.subscribeHandlerClosure?(isNew)
                     }
                 case .unsubscribed:
                     let requestId = RequestId(value: preliminaryMessage.requestId)
@@ -347,10 +370,12 @@ extension ParseLiveQuery {
     }
 
     ///Manually disconnect from the `ParseLiveQuery` server.
-    public func close() throws {
+    public func close(_ isUser: Bool = true) throws {
         if isConnected {
             task.cancel()
-            isDisconnectedByUser = true
+            if isUser {
+                isDisconnectedByUser = true
+            }
         }
         URLSession.liveQuery.delegates.removeValue(forKey: task)
     }
@@ -372,7 +397,7 @@ extension ParseLiveQuery {
         var queryData: Data
         var subscriptionHandler: AnyObject
         var eventHandlerClosure: ((Data) -> Void)?
-        var subscribeHandlerClosure: (() -> Void)?
+        var subscribeHandlerClosure: ((Bool) -> Void)?
         var unsubscribeHandlerClosure: (() -> Void)?
 
         init?<T: SubscriptionHandlable>(query: Query<T.Object>, message: SubscribeMessage<T.Object>, handler: T) {
@@ -392,11 +417,11 @@ extension ParseLiveQuery {
                 try? handler.didReceive(event)
             }
 
-            subscribeHandlerClosure = { () in
+            subscribeHandlerClosure = { (new) in
                 guard let handler = self.subscriptionHandler as? T else {
                     return
                 }
-                handler.didSubscribe()
+                handler.didSubscribe(new)
             }
 
             unsubscribeHandlerClosure = { () in
@@ -458,7 +483,6 @@ extension ParseLiveQuery {
     }
 
     func unsubscribe(matching matcher: @escaping (SubscriptionRecord) -> Bool) throws {
-        var temp = [RequestId: SubscriptionRecord]()
         try subscriptions.forEach { (key, value) -> Void in
             if matcher(value) {
                 let encoded = try ParseCoding
@@ -469,10 +493,11 @@ extension ParseLiveQuery {
                 updatedRecord.messageData = encoded
                 self.send(record: updatedRecord, requestId: key) { _ in }
             } else {
-                temp[key] = value
+                let error = ParseError(code: .unknownError,
+                                       message: "ParseLiveQuery Error: Not subscribed to this query")
+                throw error
             }
         }
-        subscriptions = temp
     }
 }
 
@@ -483,10 +508,9 @@ extension ParseLiveQuery {
     func update<T>(_ handler: T) throws where T: SubscriptionHandlable {
         try subscriptions.forEach {(key, value) -> Void in
             if value.subscriptionHandler === handler {
-                let message = SubscribeMessage<T.Object>(operation: .subscribe, requestId: key, query: handler.query)
+                let message = SubscribeMessage<T.Object>(operation: .update, requestId: key, query: handler.query)
                 let updatedRecord = value
                 try updatedRecord.update(query: handler.query, message: message)
-                subscriptions.removeValue(forKey: key)
                 self.send(record: updatedRecord, requestId: key) { _ in }
             }
         }
diff --git a/Sources/ParseSwift/LiveQuery/Protocols/SubscriptionHandlable.swift b/Sources/ParseSwift/LiveQuery/Protocols/SubscriptionHandlable.swift
@@ -28,7 +28,7 @@ public protocol  SubscriptionHandlable: AnyObject {
      Tells the handler that a query has been successfully registered with the server.
      - note: This may be invoked multiple times if the client disconnects/reconnects.
      */
-    func didSubscribe()
+    func didSubscribe(_ new: Bool)
 
     /**
      Tells the handler that a query has been successfully deregistered from the server.
diff --git a/Sources/ParseSwift/LiveQuery/Subscription.swift b/Sources/ParseSwift/LiveQuery/Subscription.swift
@@ -66,7 +66,7 @@ open class Subscription<Q: Query<T>, T: ParseObject>: SubscriptionHandlable {
     public typealias Object = T
     fileprivate var errorHandlers: [(Query<T>, Error) -> Void] = []
     fileprivate var eventHandlers: [(Query<T>, Event<T>) -> Void] = []
-    fileprivate var subscribeHandlers: [(Query<T>) -> Void] = []
+    fileprivate var subscribeHandlers: [(Query<T>, Bool) -> Void] = []
     fileprivate var unsubscribeHandlers: [(Query<T>) -> Void] = []
 
     /**
@@ -91,7 +91,7 @@ open class Subscription<Q: Query<T>, T: ParseObject>: SubscriptionHandlable {
      - parameter handler: The callback to register.
      - returns: The same subscription, for easy chaining.
      */
-    @discardableResult open func handleSubscribe(_ handler: @escaping (Query<T>) -> Void) -> Subscription {
+    @discardableResult open func handleSubscribe(_ handler: @escaping (Query<T>, Bool) -> Void) -> Subscription {
         subscribeHandlers.append(handler)
         return self
     }
@@ -115,8 +115,8 @@ open class Subscription<Q: Query<T>, T: ParseObject>: SubscriptionHandlable {
         eventHandlers.forEach { $0(query, event) }
     }
 
-    open func didSubscribe() {
-        subscribeHandlers.forEach { $0(query) }
+    open func didSubscribe(_ new: Bool) {
+        subscribeHandlers.forEach { $0(query, new) }
     }
 
     open func didUnsubscribe() {
diff --git a/Tests/ParseSwiftTests/ParseLiveQueryTests.swift b/Tests/ParseSwiftTests/ParseLiveQueryTests.swift
@@ -53,12 +53,23 @@ class ParseLiveQueryTests: XCTestCase {
 /*
     func testSubscribe() throws {
         if #available(iOS 13.0, *) {
-            let query = GameScore.query("score" > 9)
+            var query = GameScore.query("score" > 9)
             guard let subscription = query.subscribe else {
                 return
             }
 
             let expectation1 = XCTestExpectation(description: "Fetch user1")
+
+            subscription.handleSubscribe { subscribedQuery, isNew in
+
+                //: You can check this subscription is for this query\
+                if isNew {
+                    print("Successfully subscribed to new query \(subscribedQuery)")
+                } else {
+                    print("Successfully updated subscription to new query \(subscribedQuery)")
+                }
+            }
+
             subscription.handleEvent { query, event in
                 print(query)
                 print(event)
@@ -75,17 +86,26 @@ class ParseLiveQueryTests: XCTestCase {
                 case .deleted(let delete):
                     print(delete)
                 }
-                expectation1.fulfill()
             }
-/*
-            DispatchQueue.main.asyncAfter(deadline: .now() + 5) {
-                try? query.unsubscribe()
-            }*/
+
+            subscription.handleUnsubscribe { query in
+                print("Unsubscribed from \(query)")
+            }
+
+            DispatchQueue.main.asyncAfter(deadline: .now() + 20) {
+                //try? query.unsubscribe()
+                query = GameScore.query("score" > 40)
+                do {
+                    try query.update(subscription)
+                } catch {
+                    print(error)
+                }
+            }
 
             wait(for: [expectation1], timeout: 200.0)
         } else {
             // Fallback on earlier versions
         }
     }
- */
+*/
 }
