feat: make "current" ParseObjects immutable (#266)

* feat: make ParseUser.current, ParseInstallation.current, ParseConfig.current immutable

* nits

Author: cbaker6

CHANGELOG.md

@@ -2,9 +2,15 @@
 
 ### main
 
-[Full Changelog](https://github.com/parse-community/Parse-Swift/compare/2.0.3...main)
+[Full Changelog](https://github.com/parse-community/Parse-Swift/compare/2.1.0...main)
 * _Contributing to this repo? Add info about your change here to be included in the next release_
 
+### 2.1.0
+[Full Changelog](https://github.com/parse-community/Parse-Swift/compare/2.0.3...2.1.0)
+
+__Improvements__
+- Make ParseUser.current, ParseInstallation.current, ParseConfig.current immutable. This prevents accidently setting to nil. When developers want to make changes, they should make mutable copies, mutate, then save ([#266](https://github.com/parse-community/Parse-Swift/pull/266)), thanks to [Corey Baker](https://github.com/cbaker6).
+
 ### 2.0.3
 [Full Changelog](https://github.com/parse-community/Parse-Swift/compare/2.0.2...2.0.3)
 

ParseSwift.playground/Pages/1 - Your first Object.xcplaygroundpage/Contents.swift

@@ -31,7 +31,7 @@ do {
 
 //: Create your own value typed `ParseObject`.
 struct GameScore: ParseObject {
-    //: Those are required for Object
+    //: These are required by ParseObject
     var objectId: String?
     var createdAt: Date?
     var updatedAt: Date?
@@ -69,7 +69,7 @@ extension GameScore {
 }
 
 struct GameData: ParseObject {
-    //: Those are required for Object
+    //: These are required by ParseObject
     var objectId: String?
     var createdAt: Date?
     var updatedAt: Date?

ParseSwift.playground/Pages/10 - Cloud Code.xcplaygroundpage/Contents.swift

@@ -19,7 +19,7 @@ struct Cloud: ParseCloud {
     //: Return type of your Cloud Function
     typealias ReturnType = String
 
-    //: These are required for Object
+    //: These are required by `ParseCloud`
     var functionJobName: String
 
     //: If your cloud function takes arguments, they can be passed by creating properties:
@@ -86,7 +86,7 @@ cloudError.runFunction { result in
 //: Saving objects with context for beforeSave, afterSave, etc.
 //: Create your own value typed `ParseObject`.
 struct GameScore: ParseObject {
-    //: Those are required for Object
+    //: These are required by ParseObject
     var objectId: String?
     var createdAt: Date?
     var updatedAt: Date?

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

@@ -11,7 +11,7 @@ initializeParse()
 
 //: Create your own value typed ParseObject.
 struct GameScore: ParseObject {
-    //: These are required for any Object.
+    //: These are required by `ParseObject`.
     var objectId: String?
     var createdAt: Date?
     var updatedAt: Date?

ParseSwift.playground/Pages/12 - Roles and Relations.xcplaygroundpage/Contents.swift

@@ -14,13 +14,13 @@ PlaygroundPage.current.needsIndefiniteExecution = true
 initializeParse()
 
 struct User: ParseUser {
-    //: These are required for `ParseObject`.
+    //: These are required by `ParseObject`.
     var objectId: String?
     var createdAt: Date?
     var updatedAt: Date?
     var ACL: ParseACL?
 
-    //: These are required for `ParseUser`.
+    //: These are required by `ParseUser`.
     var username: String?
     var email: String?
     var emailVerified: Bool?

ParseSwift.playground/Pages/13 - Operations.xcplaygroundpage/Contents.swift

@@ -14,7 +14,7 @@ PlaygroundPage.current.needsIndefiniteExecution = true
 initializeParse()
 
 struct GameScore: ParseObject {
-    //: Those are required for Object.
+    //: These are required by ParseObject.
     var objectId: String?
     var createdAt: Date?
     var updatedAt: Date?

ParseSwift.playground/Pages/15 - Custom ObjectId.xcplaygroundpage/Contents.swift

@@ -22,7 +22,7 @@ initializeParseCustomObjectId()
 
 //: Create your own value typed `ParseObject`.
 struct GameScore: ParseObject {
-    //: Those are required for Object
+    //: These are required by ParseObject
     var objectId: String?
     var createdAt: Date?
     var updatedAt: Date?

ParseSwift.playground/Pages/17 - SwiftUI - Finding Objects.xcplaygroundpage/Contents.swift

@@ -20,7 +20,7 @@ initializeParse()
 //: Create your own value typed ParseObject.
 struct GameScore: ParseObject {
 
-    //: These are required for any Object.
+    //: These are required by `ParseObject`.
     var objectId: String?
     var createdAt: Date?
     var updatedAt: Date?

ParseSwift.playground/Pages/18 - SwiftUI - Finding Objects With Custom ViewModel.xcplaygroundpage/Contents.swift

@@ -21,7 +21,7 @@ initializeParse()
 //: Create your own value typed ParseObject.
 struct GameScore: ParseObject {
 
-    //: These are required for any Object.
+    //: These are required by `ParseObject`.
     var objectId: String?
     var createdAt: Date?
     var updatedAt: Date?

ParseSwift.playground/Pages/19 - SwiftUI - LiveQuery.xcplaygroundpage/Contents.swift

@@ -19,7 +19,7 @@ initializeParse()
 
 //: Create your own value typed ParseObject.
 struct GameScore: ParseObject {
-    //: These are required for any Object.
+    //: These are required by `ParseObject`.
     var objectId: String?
     var createdAt: Date?
     var updatedAt: Date?

ParseSwift.playground/Pages/3 - User - Sign Up.xcplaygroundpage/Contents.swift

@@ -14,13 +14,13 @@ import ParseSwift
 initializeParse()
 
 struct User: ParseUser {
-    //: These are required for `ParseObject`.
+    //: These are required by `ParseObject`.
     var objectId: String?
     var createdAt: Date?
     var updatedAt: Date?
     var ACL: ParseACL?
 
-    //: These are required for `ParseUser`.
+    //: These are required by `ParseUser`.
     var username: String?
     var email: String?
     var emailVerified: Bool?

ParseSwift.playground/Pages/4 - User - Continued.xcplaygroundpage/Contents.swift

@@ -14,13 +14,13 @@ PlaygroundPage.current.needsIndefiniteExecution = true
 initializeParse()
 
 struct User: ParseUser {
-    //: These are required for `ParseObject`.
+    //: These are required by `ParseObject`.
     var objectId: String?
     var createdAt: Date?
     var updatedAt: Date?
     var ACL: ParseACL?
 
-    //: These are required for `ParseUser`.
+    //: These are required by `ParseUser`.
     var username: String?
     var email: String?
     var emailVerified: Bool?
@@ -61,7 +61,7 @@ extension User {
 
 //: Create your own value typed `ParseObject`.
 struct GameScore: ParseObject {
-    //: Those are required for Object
+    //: These are required by ParseObject
     var objectId: String?
     var createdAt: Date?
     var updatedAt: Date?

ParseSwift.playground/Pages/5 - ACL.xcplaygroundpage/Contents.swift

@@ -24,7 +24,7 @@ do {
 
 //: Create your own value typed ParseObject.
 struct GameScore: ParseObject {
-    //: Those are required for Object
+    //: These are required by ParseObject
     var objectId: String?
     var createdAt: Date?
     var updatedAt: Date?

ParseSwift.playground/Pages/6 - Installation.xcplaygroundpage/Contents.swift

@@ -14,13 +14,13 @@ PlaygroundPage.current.needsIndefiniteExecution = true
 initializeParse()
 
 struct Installation: ParseInstallation {
-    //: These are required for `ParseObject`.
+    //: These are required by `ParseObject`.
     var objectId: String?
     var createdAt: Date?
     var updatedAt: Date?
     var ACL: ParseACL?
 
-    //: These are required for `ParseInstallation`.
+    //: These are required by `ParseInstallation`.
     var installationId: String?
     var deviceType: String?
     var deviceToken: String?

ParseSwift.playground/Pages/7 - GeoPoint.xcplaygroundpage/Contents.swift

@@ -15,7 +15,7 @@ initializeParse()
 
 //: Create your own value typed `ParseObject`.
 struct GameScore: ParseObject {
-    //: Those are required for Object.
+    //: These are required by ParseObject.
     var objectId: String?
     var createdAt: Date?
     var updatedAt: Date?

ParseSwift.playground/Pages/8 - Pointers.xcplaygroundpage/Contents.swift

@@ -15,7 +15,7 @@ initializeParse()
 
 //: Create your own value typed `ParseObject`.
 struct Book: ParseObject {
-    //: Those are required for Object
+    //: These are required by ParseObject
     var objectId: String?
     var createdAt: Date?
     var updatedAt: Date?
@@ -36,7 +36,7 @@ extension Book {
 }
 
 struct Author: ParseObject {
-    //: Those are required for Object.
+    //: These are required by ParseObject.
     var objectId: String?
     var createdAt: Date?
     var updatedAt: Date?

ParseSwift.playground/Pages/9 - Files.xcplaygroundpage/Contents.swift

@@ -15,7 +15,7 @@ initializeParse()
 
 //: Create your own value typed `ParseObject`.
 struct GameScore: ParseObject {
-    //: Those are required for Object
+    //: These are required by ParseObject
     var objectId: String?
     var createdAt: Date?
     var updatedAt: Date?

Sources/ParseSwift/Objects/ParseInstallation.swift

@@ -123,8 +123,8 @@ struct CurrentInstallationContainer<T: ParseInstallation>: Codable {
 }
 
 // MARK: Current Installation Support
-extension ParseInstallation {
-    static var currentContainer: CurrentInstallationContainer<Self> {
+public extension ParseInstallation {
+    internal static var currentContainer: CurrentInstallationContainer<Self> {
         get {
             guard let installationInMemory: CurrentInstallationContainer<Self> =
                     try? ParseStorage.shared.get(valueFor: ParseStorage.Keys.currentInstallation) else {
@@ -210,7 +210,7 @@ extension ParseInstallation {
 
      - returns: Returns a `ParseInstallation` that is the current device. If there is none, returns `nil`.
     */
-    public static var current: Self? {
+    internal(set) static var current: Self? {
         get {
             return Self.currentContainer.currentInstallation
         }

Sources/ParseSwift/Objects/ParseUser.swift

@@ -98,8 +98,8 @@ struct CurrentUserContainer<T: ParseUser>: Codable {
 }
 
 // MARK: Current User Support
-extension ParseUser {
-    static var currentContainer: CurrentUserContainer<Self>? {
+public extension ParseUser {
+    internal static var currentContainer: CurrentUserContainer<Self>? {
         get {
             guard let currentUserInMemory: CurrentUserContainer<Self>
                 = try? ParseStorage.shared.get(valueFor: ParseStorage.Keys.currentUser) else {
@@ -137,7 +137,7 @@ extension ParseUser {
      - returns: Returns a `ParseUser` that is the currently logged in user. If there is none, returns `nil`.
      - warning: Only use `current` users on the main thread as as modifications to `current` have to be unique.
     */
-    public static var current: Self? {
+    internal(set) static var current: Self? {
         get { Self.currentContainer?.currentUser }
         set {
             Self.currentContainer?.currentUser = newValue
@@ -149,7 +149,7 @@ extension ParseUser {
 
      This is set by the server upon successful authentication.
     */
-    public var sessionToken: String? {
+    var sessionToken: String? {
         Self.currentContainer?.sessionToken
     }
 }

Sources/ParseSwift/ParseConstants.swift

@@ -10,7 +10,7 @@ import Foundation
 
 enum ParseConstants {
     static let sdk = "swift"
-    static let version = "2.0.3"
+    static let version = "2.1.0"
     static let fileManagementDirectory = "parse/"
     static let fileManagementPrivateDocumentsDirectory = "Private Documents/"
     static let fileManagementLibraryDirectory = "Library/"

Sources/ParseSwift/Types/ParseACL.swift

@@ -311,20 +311,20 @@ extension ParseACL {
         aclController = try? ParseStorage.shared.get(valueFor: ParseStorage.Keys.defaultACL)
         #endif
 
-        if aclController != nil {
-            if !aclController!.useCurrentUser {
-                return aclController!.defaultACL
+        if let acl = aclController {
+            if !acl.useCurrentUser {
+                return acl.defaultACL
             } else {
                 guard let userObjectId = BaseParseUser.current?.objectId else {
-                    return aclController!.defaultACL
+                    return acl.defaultACL
                 }
 
-                guard let lastCurrentUserObjectId = aclController!.lastCurrentUserObjectId,
+                guard let lastCurrentUserObjectId = acl.lastCurrentUserObjectId,
                     userObjectId == lastCurrentUserObjectId else {
                     return try setDefaultACL(ParseACL(), withAccessForCurrentUser: true)
                 }
 
-                return aclController!.defaultACL
+                return acl.defaultACL
             }
         }
 
@@ -374,8 +374,8 @@ extension ParseACL {
         }
 
         let aclController: DefaultACL!
-        if modifiedACL != nil {
-            aclController = DefaultACL(defaultACL: modifiedACL!,
+        if let modified = modifiedACL {
+            aclController = DefaultACL(defaultACL: modified,
                                        lastCurrentUserObjectId: currentUserObjectId,
                                        useCurrentUser: withAccessForCurrentUser)
         } else {

Sources/ParseSwift/Types/ParseConfig.swift

@@ -119,9 +119,9 @@ struct CurrentConfigContainer<T: ParseConfig>: Codable {
     var currentConfig: T?
 }
 
-extension ParseConfig {
+public extension ParseConfig {
 
-    static var currentContainer: CurrentConfigContainer<Self>? {
+    internal static var currentContainer: CurrentConfigContainer<Self>? {
         get {
             guard let configInMemory: CurrentConfigContainer<Self> =
                 try? ParseStorage.shared.get(valueFor: ParseStorage.Keys.currentConfig) else {
@@ -165,7 +165,7 @@ extension ParseConfig {
 
      - returns: Returns the latest `ParseConfig` on this device. If there is none, returns `nil`.
     */
-    public static var current: Self? {
+    internal(set) static var current: Self? {
         get {
             return Self.currentContainer?.currentConfig
         }

Tests/ParseSwiftTests/APICommandTests.swift

@@ -48,13 +48,13 @@ class APICommandTests: XCTestCase {
 
     struct User: ParseUser {
 
-        //: Those are required for Object
+        //: These are required by ParseObject
         var objectId: String?
         var createdAt: Date?
         var updatedAt: Date?
         var ACL: ParseACL?
 
-        // provided by User
+        // These are required by ParseUser
         var username: String?
         var email: String?
         var emailVerified: Bool?
@@ -73,7 +73,7 @@ class APICommandTests: XCTestCase {
         var updatedAt: Date?
         var ACL: ParseACL?
 
-        // provided by User
+        // These are required by ParseUser
         var username: String?
         var email: String?
         var emailVerified: Bool?

Tests/ParseSwiftTests/IOS13Tests.swift

@@ -25,7 +25,7 @@ class IOS13Tests: XCTestCase { // swiftlint:disable:this type_body_length
 
     struct GameScore: ParseObject {
 
-        //: Those are required for Object
+        //: These are required by ParseObject
         var objectId: String?
         var createdAt: Date?
         var updatedAt: Date?