Switched context header X-Parse-Context to X-Parse-Cloud-Context (#170)

* Switched context header X-Parse-Context to X-Parse-Cloud-Context to match server

* change min version in readme

* nit

* Update flaky LiveQuery test case

* Improve LiveQuery playgrounds and test cases

* Make ParseError CustomDebugStringConvertible

* Use web socket cancel codes when closing

* setup autoversioning WIP

* working version update

* use actions tag for framework build release number

* make all dummy versions 1.8.3

* update ParseConstants.swift manually

* Replace socket task instead of nil

* nit actions release doc

* nit

* Fix ParseLiveQueryCombineTests

* move update_build to scripts folder

* update cocoapods script in ci.yml

* fix jazzy docs to use tag for release number

* Add more details to error

* Improve error descriptions.

* nits

Author: cbaker6

.github/workflows/ci.yml

@@ -128,12 +128,18 @@ jobs:
           bundle install
       - name: Create Jazzy Docs
         run: ./Scripts/jazzy.sh
+        env:
+          BUILD_VERSION: '1.8.3'
 
   cocoapods:
     needs: xcode-build-watchos
     runs-on: macos-latest
     steps:
       - uses: actions/checkout@v2
+      - name: Update Framework Version
+        run: ./Scripts/update_build
+        env:
+          BUILD_VERSION: '1.8.3'
       - name: CocoaPods
         run: pod lib lint --allow-warnings
 

.github/workflows/release.yml

@@ -10,6 +10,12 @@ jobs:
     runs-on: macos-latest
     steps:
       - uses: actions/checkout@v2
+      - name: Get release version
+        run: echo "TAG=${GITHUB_REF/refs\/tags\//}" >> $GITHUB_ENV
+      - name: Update Framework Version
+        run: ./Scripts/update_build
+        env:
+          BUILD_VERSION: ${{ env.TAG }}
       - name: CocoaPods
         run: set -o pipefail && env NSUnbufferedIO=YES pod lib lint --allow-warnings --verbose
       - name: Deploy CocoaPods
@@ -33,8 +39,12 @@ jobs:
         run: |
           bundle config path vendor/bundle
           bundle install
+      - name: Get release version
+        run: echo "TAG=${GITHUB_REF/refs\/tags\//}" >> $GITHUB_ENV
       - name: Create Jazzy Docs
         run: ./Scripts/jazzy.sh
+        env:
+          BUILD_VERSION: ${{ env.TAG }}
       - name: Deploy Jazzy Docs
         uses: peaceiris/actions-gh-pages@v3
         with:

CHANGELOG.md

@@ -1,10 +1,14 @@
 # Parse-Swift Changelog
 
 ### main
-[Full Changelog](https://github.com/parse-community/Parse-Swift/compare/1.8.3...main)
+[Full Changelog](https://github.com/parse-community/Parse-Swift/compare/1.8.4...main)
 * _Contributing to this repo? Add info about your change here to be included in the next release_
 
+### 1.8.4
+[Full Changelog](https://github.com/parse-community/Parse-Swift/compare/1.8.3...1.8.4)
+
 __Fixes__
+- Switched context header X-Parse-Context to X-Parse-Cloud-Context to match server ([#170](https://github.com/parse-community/Parse-Swift/pull/170)), thanks to [Corey Baker](https://github.com/cbaker6).
 - Fixed a bug in LiveQuery that prevented reconnecting after a connection was closed. Also added a sendPing method to LiveQuery ([#172](https://github.com/parse-community/Parse-Swift/pull/172)), thanks to [Corey Baker](https://github.com/cbaker6).
 
 ### 1.8.3

ParseSwift.playground/Pages/11 - LiveQuery.xcplaygroundpage/Contents.swift

@@ -157,6 +157,9 @@ do {
     print(error)
 }
 
+//: If you look at your server log, you will notice the client and server disconnnected.
+//: This is because there is no more LiveQuery subscriptions.
+
 //: Ping the LiveQuery server. This should produce an error
 //: because LiveQuery is disconnected.
 ParseLiveQuery.client?.sendPing { error in
@@ -176,7 +179,7 @@ query2.fields("score")
 //: Subscribe to your new query.
 let subscription2 = query2.subscribeCallback!
 
-//: As before, setup your subscription and event handlers.
+//: As before, setup your subscription, event, and unsubscribe handlers.
 subscription2.handleSubscribe { subscribedQuery, isNew in
 
     //: You can check this subscription is for this query.
@@ -203,6 +206,10 @@ subscription2.handleEvent { _, event in
     }
 }
 
+subscription2.handleUnsubscribe { query in
+    print("Unsubscribed from \(query)")
+}
+
 //: To close the current LiveQuery connection.
 ParseLiveQuery.client?.close()
 
@@ -219,41 +226,15 @@ ParseLiveQuery.client?.sendPing { error in
     }
 }
 
-//: Subscribe to your new query.
+//: Resubscribe to your previous query.
+//: Since we never unsubscribed you can use your previous handlers.
 let subscription3 = query2.subscribeCallback!
 
-//: As before, setup your subscription and event handlers.
-subscription3.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)")
-    }
-}
-
-subscription3.handleEvent { _, event in
-    switch event {
-
-    case .entered(let object):
-        print("Entered: \(object)")
-    case .left(let object):
-        print("Left: \(object)")
-    case .created(let object):
-        print("Created: \(object)")
-    case .updated(let object):
-        print("Updated: \(object)")
-    case .deleted(let object):
-        print("Deleted: \(object)")
-    }
-}
-
-//: Now lets subscribe to an additional query.
+//: Resubscribe to another previous query.
+//: This one needs new handlers.
 let subscription4 = query.subscribeCallback!
 
-//: This is how you receive notifications about the success
-//: of your subscription.
+//: Need a new handler because we previously unsubscribed.
 subscription4.handleSubscribe { subscribedQuery, isNew in
 
     //: You can check this subscription is for this query
@@ -264,7 +245,7 @@ subscription4.handleSubscribe { subscribedQuery, isNew in
     }
 }
 
-//: This is how you register to receive notifications of events related to your LiveQuery.
+//: Need a new event handler because we previously unsubscribed.
 subscription4.handleEvent { _, event in
     switch event {
 
@@ -281,8 +262,8 @@ subscription4.handleEvent { _, event in
     }
 }
 
-//: Now we will will unsubscribe from one of the subsriptions, but maintain the connection.
-subscription3.handleUnsubscribe { query in
+//: Need a new unsubscribe handler because we previously unsubscribed.
+subscription4.handleUnsubscribe { query in
     print("Unsubscribed from \(query)")
 }
 
@@ -302,5 +283,15 @@ ParseLiveQuery.client?.sendPing { error in
     }
 }
 
+//: To unsubscribe from your your last query.
+do {
+    try query.unsubscribe()
+} catch {
+    print(error)
+}
+
+//: If you look at your server log, you will notice the client and server disconnnected.
+//: This is because there is no more LiveQuery subscriptions.
+
 PlaygroundPage.current.finishExecution()
 //: [Next](@next)

ParseSwift.podspec renamed to ParseSwift.podtemplate

@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name     = "ParseSwift"
-  s.version  = "1.8.3"
+  s.version  = "[[VERSION]]"
   s.summary  = "Parse Pure Swift SDK"
   s.homepage = "https://github.com/parse-community/Parse-Swift"
   s.authors = {

README.md

@@ -44,7 +44,7 @@ import PackageDescription
 let package = Package(
     name: "YOUR_PROJECT_NAME",
     dependencies: [
-        .package(url: "https://github.com/parse-community/Parse-Swift", from: "1.8.3"),
+        .package(url: "https://github.com/parse-community/Parse-Swift", from: "1.8.4"),
     ]
 )
 ```

Scripts/jazzy.sh

@@ -1,11 +1,10 @@
-ver=`/usr/libexec/PlistBuddy -c "Print CFBundleShortVersionString" ParseSwift-iOS/Info.plist`
 bundle exec jazzy \
   --clean \
   --author "Parse Community" \
   --author_url http://parseplatform.org \
   --github_url https://github.com/parse-community/Parse-Swift \
   --root-url http://parseplatform.org/Parse-Swift/api/ \
-  --module-version 1.8.3 \
+  --module-version ${BUILD_VERSION} \
   --theme fullwidth \
   --skip-undocumented \
   --output ./docs/api \

Scripts/update_build

@@ -0,0 +1,10 @@
+#!/bin/bash
+
+# Prepare podspec update
+TEMPLATE_FILE_NAME="ParseSwift.podtemplate"
+OUT_FILE_NAME="ParseSwift.podspec"
+
+# Load the template podspec and replace version
+TEMPLATE=$(cat "$TEMPLATE_FILE_NAME" | sed "s/\[\[VERSION\]\]/${BUILD_VERSION}/g")
+
+echo "$TEMPLATE" > "$OUT_FILE_NAME"

Sources/ParseSwift/API/API.swift

@@ -201,7 +201,7 @@ public struct API {
                 let context = AnyEncodable(context)
                 if let encoded = try? ParseCoding.jsonEncoder().encode(context),
                    let encodedString = String(data: encoded, encoding: .utf8) {
-                    headers["X-Parse-Context"] = encodedString
+                    headers["X-Parse-Cloud-Context"] = encodedString
                 }
             }
         }

Sources/ParseSwift/LiveQuery/ParseLiveQuery.swift

@@ -199,7 +199,8 @@ public final class ParseLiveQuery: NSObject {
         }
         components.scheme = (components.scheme == "https" || components.scheme == "wss") ? "wss" : "ws"
         url = components.url
-        self.createTask()
+        self.task = URLSession.liveQuery.createTask(self.url)
+        self.resumeTask()
 
         if isDefault {
             Self.setDefault(self)
@@ -226,12 +227,11 @@ extension ParseLiveQuery {
         return Int.random(in: 0 ..< Int(truncating: min))
     }
 
-    func createTask() {
+    func resumeTask() {
         synchronizationQueue.sync {
-            if self.task == nil {
-                self.task = URLSession.liveQuery.createTask(self.url)
+            if self.task.state == .suspended {
+                self.task.resume()
             }
-            self.task.resume()
             URLSession.liveQuery.receive(self.task)
             URLSession.liveQuery.delegates[self.task] = self
         }
@@ -317,7 +317,7 @@ extension ParseLiveQuery: LiveQuerySocketDelegate {
             self.isSocketEstablished = false
             if !self.isDisconnectedByUser {
                 //Try to reconnect
-                self.createTask()
+                self.resumeTask()
             }
         }
     }
@@ -329,7 +329,7 @@ extension ParseLiveQuery: LiveQuerySocketDelegate {
                 if self.isConnected {
                     self.close(useDedicatedQueue: true)
                     //Try to reconnect
-                    self.createTask()
+                    self.resumeTask()
                 }
             }
             return
@@ -344,7 +344,8 @@ extension ParseLiveQuery: LiveQuerySocketDelegate {
             guard let parseError = try? ParseCoding.jsonDecoder().decode(ParseError.self, from: data) else {
                 //Turn LiveQuery error into ParseError
                 let parseError = ParseError(code: .unknownError,
-                                            message: "LiveQuery error code: \(error.code) message: \(error.error)")
+                                            // swiftlint:disable:next line_length
+                                            message: "ParseLiveQuery Error: code: \(error.code), message: \(error.error)")
                 self.notificationQueue.async {
                     self.receiveDelegate?.received(parseError)
                 }
@@ -529,10 +530,11 @@ extension ParseLiveQuery {
                 self.synchronizationQueue
                     .asyncAfter(deadline: .now() + DispatchTimeInterval
                                     .seconds(reconnectInterval)) {
-                    self.createTask()
+                    self.resumeTask()
                     self.attempts += 1
                     let error = ParseError(code: .unknownError,
-                                           message: "Attempted to open socket \(self.attempts) time(s)")
+                                           // swiftlint:disable:next line_length
+                                           message: "ParseLiveQuery Error: attempted to open socket \(self.attempts) time(s)")
                     completion(error)
                 }
             }
@@ -543,13 +545,12 @@ extension ParseLiveQuery {
     public func close() {
         synchronizationQueue.sync {
             if self.isConnected {
-                self.task.cancel()
+                self.task.cancel(with: .goingAway, reason: nil)
                 self.isDisconnectedByUser = true
             }
-            if task != nil {
-                URLSession.liveQuery.delegates.removeValue(forKey: self.task)
-            }
-            self.task = nil
+            URLSession.liveQuery.delegates.removeValue(forKey: self.task)
+            isSocketEstablished = false
+            self.task = URLSession.liveQuery.createTask(self.url) // Prepare new task for future use.
         }
     }
 
@@ -568,11 +569,12 @@ extension ParseLiveQuery {
      */
     public func sendPing(pongReceiveHandler: @escaping (Error?) -> Void) {
         synchronizationQueue.sync {
-            if isSocketEstablished {
+            if self.task.state == .running {
                 URLSession.liveQuery.sendPing(task, pongReceiveHandler: pongReceiveHandler)
             } else {
                 let error = ParseError(code: .unknownError,
-                                       message: "Need to open the websocket before it can be pinged.")
+                                       // swiftlint:disable:next line_length
+                                       message: "ParseLiveQuery Error: socket status needs to be \"\(URLSessionTask.State.running.rawValue)\" before pinging server. Current status is \"\(self.task.state.rawValue)\". Try calling \"open()\" to change socket status.")
                 pongReceiveHandler(error)
             }
         }
@@ -582,19 +584,18 @@ extension ParseLiveQuery {
         if useDedicatedQueue {
             synchronizationQueue.async {
                 if self.isConnected {
-                    self.task.cancel()
+                    self.task.cancel(with: .goingAway, reason: nil)
                 }
                 URLSession.liveQuery.delegates.removeValue(forKey: self.task)
-                self.task = nil
+                self.task = URLSession.liveQuery.createTask(self.url) // Prepare new task for future use.
             }
         } else {
             if self.isConnected {
-                self.task.cancel()
-            }
-            if self.task != nil {
-                URLSession.liveQuery.delegates.removeValue(forKey: self.task)
+                self.task.cancel(with: .goingAway, reason: nil)
             }
-            self.task = nil
+            URLSession.liveQuery.delegates.removeValue(forKey: self.task)
+            isSocketEstablished = false
+            self.task = URLSession.liveQuery.createTask(self.url) // Prepare new task for future use.
         }
     }