fix: Installation not saving to keychain correctly, returning nil instead (#236)

* fix installation saving to keychain

* nits: reduce duplication in container names

* Update change log and minimum in readme

* query if missing current installation

* Fix failing test cases

* More fixes to failing tests

* Attempt to fix Linux test failure

* Remove test from Linux

* Update .codecov.yml

Author: cbaker6

.codecov.yml

@@ -4,7 +4,7 @@ coverage:
   status:
     patch:
       default:
-        target: 82
+        target: auto
     changes: false
     project:
       default:

CHANGELOG.md

@@ -1,9 +1,14 @@
 # Parse-Swift Changelog
 
 ### main
-[Full Changelog](https://github.com/parse-community/Parse-Swift/compare/1.9.9...main)
+[Full Changelog](https://github.com/parse-community/Parse-Swift/compare/1.9.10...main)
 * _Contributing to this repo? Add info about your change here to be included in the next release_
 
+### 1.9.10
+[Full Changelog](https://github.com/parse-community/Parse-Swift/compare/1.9.9...1.9.10)
+__Fixes__
+- ParseInstallation can't be retreived from Keychain after the first fun ([#236](https://github.com/parse-community/Parse-Swift/pull/236)), thanks to [Corey Baker](https://github.com/cbaker6).
+
 ### 1.9.9
 [Full Changelog](https://github.com/parse-community/Parse-Swift/compare/1.9.8...1.9.9)
 

README.md

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

Sources/ParseSwift/API/API.swift

@@ -176,11 +176,11 @@ public struct API {
             headers["X-Parse-Client-Key"] = clientKey
         }
 
-        if let token = BaseParseUser.currentUserContainer?.sessionToken {
+        if let token = BaseParseUser.currentContainer?.sessionToken {
             headers["X-Parse-Session-Token"] = token
         }
 
-        if let installationId = BaseParseInstallation.currentInstallationContainer.installationId {
+        if let installationId = BaseParseInstallation.currentContainer.installationId {
             headers["X-Parse-Installation-Id"] = installationId
         }
 

Sources/ParseSwift/Authentication/Protocols/ParseAuthentication.swift

@@ -411,7 +411,7 @@ public extension ParseUser {
                 throw ParseError(code: .unknownError, message: "Should have a current user.")
             }
             if let sessionToken = user.sessionToken {
-                Self.currentUserContainer = .init(currentUser: current,
+                Self.currentContainer = .init(currentUser: current,
                                                   sessionToken: sessionToken)
             }
             Self.saveCurrentContainerToKeychain()
@@ -441,7 +441,7 @@ public extension ParseUser {
                 throw ParseError(code: .unknownError, message: "Should have a current user.")
             }
             if let sessionToken = user.sessionToken {
-                Self.currentUserContainer = .init(currentUser: current,
+                Self.currentContainer = .init(currentUser: current,
                                                   sessionToken: sessionToken)
             }
             Self.saveCurrentContainerToKeychain()

Sources/ParseSwift/Internal/BaseParseInstallation.swift

@@ -25,8 +25,15 @@ internal struct BaseParseInstallation: ParseInstallation {
     var updatedAt: Date?
     var ACL: ParseACL?
 
-    init() {
-        //Force installation in keychain to be created if it hasn't already
-        Self.current = self
+    static func createNewInstallationIfNeeded() {
+        guard let installationId = Self.currentContainer.installationId,
+              Self.currentContainer.currentInstallation?.installationId == installationId else {
+            try? ParseStorage.shared.delete(valueFor: ParseStorage.Keys.currentInstallation)
+            #if !os(Linux) && !os(Android)
+            try? KeychainStore.shared.delete(valueFor: ParseStorage.Keys.currentInstallation)
+            #endif
+            _ = Self.currentContainer
+            return
+        }
     }
 }

Sources/ParseSwift/LiveQuery/Messages.swift

@@ -24,8 +24,8 @@ struct StandardMessage: LiveQueryable, Codable {
             self.applicationId = ParseSwift.configuration.applicationId
             self.masterKey = ParseSwift.configuration.masterKey
             self.clientKey = ParseSwift.configuration.clientKey
-            self.sessionToken = BaseParseUser.currentUserContainer?.sessionToken
-            self.installationId = BaseParseInstallation.currentInstallationContainer.installationId
+            self.sessionToken = BaseParseUser.currentContainer?.sessionToken
+            self.installationId = BaseParseInstallation.currentContainer.installationId
         }
     }
 
@@ -59,7 +59,7 @@ struct SubscribeMessage<T: ParseObject>: LiveQueryable, Encodable {
         if let query = query {
             self.query = SubscribeQuery(className: query.className, where: query.where, fields: query.fields)
         }
-        self.sessionToken = BaseParseUser.currentUserContainer?.sessionToken
+        self.sessionToken = BaseParseUser.currentContainer?.sessionToken
     }
 }
 

Sources/ParseSwift/LiveQuery/ParseLiveQuery.swift

@@ -427,7 +427,7 @@ extension ParseLiveQuery: LiveQuerySocketDelegate {
                         }
                     }
 
-                    if let installationId = BaseParseInstallation.currentInstallationContainer.installationId {
+                    if let installationId = BaseParseInstallation.currentContainer.installationId {
                         if installationId != preliminaryMessage.installationId {
                             let error = ParseError(code: .unknownError,
                                                    // swiftlint:disable:next line_length

Sources/ParseSwift/Objects/ParseInstallation.swift

@@ -124,32 +124,52 @@ struct CurrentInstallationContainer<T: ParseInstallation>: Codable {
 
 // MARK: Current Installation Support
 extension ParseInstallation {
-    static var currentInstallationContainer: CurrentInstallationContainer<Self> {
+    static var currentContainer: CurrentInstallationContainer<Self> {
         get {
             guard let installationInMemory: CurrentInstallationContainer<Self> =
-                try? ParseStorage.shared.get(valueFor: ParseStorage.Keys.currentInstallation) else {
+                    try? ParseStorage.shared.get(valueFor: ParseStorage.Keys.currentInstallation) else {
                 #if !os(Linux) && !os(Android)
-                    guard let installationFromKeyChain: CurrentInstallationContainer<Self> =
+                guard let installationFromKeyChain: CurrentInstallationContainer<Self> =
                         try? KeychainStore.shared.get(valueFor: ParseStorage.Keys.currentInstallation)
-                         else {
-                            var newInstallation = CurrentInstallationContainer<Self>()
-                            let newInstallationId = UUID().uuidString.lowercased()
-                            newInstallation.installationId = newInstallationId
-                            newInstallation.currentInstallation?.createInstallationId(newId: newInstallationId)
-                            newInstallation.currentInstallation?.updateAutomaticInfo()
-                            try? KeychainStore.shared.set(newInstallation, for: ParseStorage.Keys.currentInstallation)
-                            try? ParseStorage.shared.set(newInstallation, for: ParseStorage.Keys.currentInstallation)
-                        return newInstallation
+                else {
+                    let newInstallationId = UUID().uuidString.lowercased()
+                    var newInstallation = BaseParseInstallation()
+                    newInstallation.installationId = newInstallationId
+                    newInstallation.createInstallationId(newId: newInstallationId)
+                    newInstallation.updateAutomaticInfo()
+                    let newBaseInstallationContainer =
+                        CurrentInstallationContainer<BaseParseInstallation>(currentInstallation: newInstallation,
+                                                                            installationId: newInstallationId)
+                    try? KeychainStore.shared.set(newBaseInstallationContainer,
+                                                  for: ParseStorage.Keys.currentInstallation)
+                    guard let installationFromKeyChain: CurrentInstallationContainer<Self> =
+                            try? KeychainStore.shared.get(valueFor: ParseStorage.Keys.currentInstallation)
+                    else {
+                        // Couldn't create container correctly, return empty one.
+                        return CurrentInstallationContainer<Self>()
                     }
+                    try? ParseStorage.shared.set(installationFromKeyChain, for: ParseStorage.Keys.currentInstallation)
                     return installationFromKeyChain
+                }
+                return installationFromKeyChain
                 #else
-                    var newInstallation = CurrentInstallationContainer<Self>()
-                    let newInstallationId = UUID().uuidString.lowercased()
-                    newInstallation.installationId = newInstallationId
-                    newInstallation.currentInstallation?.createInstallationId(newId: newInstallationId)
-                    newInstallation.currentInstallation?.updateAutomaticInfo()
-                    try? ParseStorage.shared.set(newInstallation, for: ParseStorage.Keys.currentInstallation)
-                    return newInstallation
+                let newInstallationId = UUID().uuidString.lowercased()
+                var newInstallation = BaseParseInstallation()
+                newInstallation.installationId = newInstallationId
+                newInstallation.createInstallationId(newId: newInstallationId)
+                newInstallation.updateAutomaticInfo()
+                let newBaseInstallationContainer =
+                    CurrentInstallationContainer<BaseParseInstallation>(currentInstallation: newInstallation,
+                                                                        installationId: newInstallationId)
+                try? ParseStorage.shared.set(newBaseInstallationContainer,
+                                              for: ParseStorage.Keys.currentInstallation)
+                guard let installationFromMemory: CurrentInstallationContainer<Self> =
+                        try? ParseStorage.shared.get(valueFor: ParseStorage.Keys.currentInstallation)
+                else {
+                    // Couldn't create container correctly, return empty one.
+                    return CurrentInstallationContainer<Self>()
+                }
+                return installationFromMemory
                 #endif
             }
             return installationInMemory
@@ -160,19 +180,19 @@ extension ParseInstallation {
     }
 
     internal static func updateInternalFieldsCorrectly() {
-        if Self.currentInstallationContainer.currentInstallation?.installationId !=
-            Self.currentInstallationContainer.installationId! {
+        if Self.currentContainer.currentInstallation?.installationId !=
+            Self.currentContainer.installationId! {
             //If the user made changes, set back to the original
-            Self.currentInstallationContainer.currentInstallation?.installationId =
-                Self.currentInstallationContainer.installationId!
+            Self.currentContainer.currentInstallation?.installationId =
+                Self.currentContainer.installationId!
         }
         //Always pull automatic info to ensure user made no changes to immutable values
-        Self.currentInstallationContainer.currentInstallation?.updateAutomaticInfo()
+        Self.currentContainer.currentInstallation?.updateAutomaticInfo()
     }
 
     internal static func saveCurrentContainerToKeychain() {
         #if !os(Linux) && !os(Android)
-        try? KeychainStore.shared.set(Self.currentInstallationContainer, for: ParseStorage.Keys.currentInstallation)
+        try? KeychainStore.shared.set(Self.currentContainer, for: ParseStorage.Keys.currentInstallation)
         #endif
     }
 
@@ -182,7 +202,7 @@ extension ParseInstallation {
         try? KeychainStore.shared.delete(valueFor: ParseStorage.Keys.currentInstallation)
         #endif
         //Prepare new installation
-        _ = BaseParseInstallation()
+        BaseParseInstallation.createNewInstallationIfNeeded()
     }
 
     /**
@@ -192,10 +212,10 @@ extension ParseInstallation {
     */
     public static var current: Self? {
         get {
-            return Self.currentInstallationContainer.currentInstallation
+            return Self.currentContainer.currentInstallation
         }
         set {
-            Self.currentInstallationContainer.currentInstallation = newValue
+            Self.currentContainer.currentInstallation = newValue
             Self.updateInternalFieldsCorrectly()
         }
     }

Sources/ParseSwift/Objects/ParseUser.swift

@@ -99,7 +99,7 @@ struct CurrentUserContainer<T: ParseUser>: Codable {
 
 // MARK: Current User Support
 extension ParseUser {
-    static var currentUserContainer: CurrentUserContainer<Self>? {
+    static var currentContainer: CurrentUserContainer<Self>? {
         get {
             guard let currentUserInMemory: CurrentUserContainer<Self>
                 = try? ParseStorage.shared.get(valueFor: ParseStorage.Keys.currentUser) else {
@@ -116,7 +116,7 @@ extension ParseUser {
 
     internal static func saveCurrentContainerToKeychain() {
         #if !os(Linux) && !os(Android)
-        try? KeychainStore.shared.set(Self.currentUserContainer, for: ParseStorage.Keys.currentUser)
+        try? KeychainStore.shared.set(Self.currentContainer, for: ParseStorage.Keys.currentUser)
         #endif
     }
 
@@ -128,7 +128,7 @@ extension ParseUser {
         }
         try? KeychainStore.shared.delete(valueFor: ParseStorage.Keys.currentUser)
         #endif
-        BaseParseUser.currentUserContainer = nil
+        BaseParseUser.currentContainer = nil
     }
 
     /**
@@ -138,9 +138,9 @@ extension ParseUser {
      - warning: Only use `current` users on the main thread as as modifications to `current` have to be unique.
     */
     public static var current: Self? {
-        get { Self.currentUserContainer?.currentUser }
+        get { Self.currentContainer?.currentUser }
         set {
-            Self.currentUserContainer?.currentUser = newValue
+            Self.currentContainer?.currentUser = newValue
         }
     }
 
@@ -150,7 +150,7 @@ extension ParseUser {
      This is set by the server upon successful authentication.
     */
     public var sessionToken: String? {
-        Self.currentUserContainer?.sessionToken
+        Self.currentContainer?.sessionToken
     }
 }
 
@@ -217,7 +217,7 @@ extension ParseUser {
             var user = try ParseCoding.jsonDecoder().decode(Self.self, from: data)
             user.username = username
 
-            Self.currentUserContainer = .init(
+            Self.currentContainer = .init(
                 currentUser: user,
                 sessionToken: sessionToken
             )
@@ -302,7 +302,7 @@ extension ParseUser {
                 }
             }
 
-            Self.currentUserContainer = .init(
+            Self.currentContainer = .init(
                 currentUser: user,
                 sessionToken: sessionToken
             )
@@ -656,7 +656,7 @@ extension ParseUser {
                     user.authData = authData
                 }
             }
-            Self.currentUserContainer = .init(currentUser: user,
+            Self.currentContainer = .init(currentUser: user,
                                               sessionToken: sessionToken)
             Self.saveCurrentContainerToKeychain()
             return user
@@ -672,7 +672,7 @@ extension ParseUser {
             let response = try ParseCoding.jsonDecoder()
                 .decode(LoginSignupResponse.self, from: data)
             let user = response.applySignup(to: self)
-            Self.currentUserContainer = .init(
+            Self.currentContainer = .init(
                 currentUser: user,
                 sessionToken: response.sessionToken
             )