Support for custom objectids, implements parse-community#1611

Author: Martin Pfannemüller

Parse/Parse/PFObject.m

@@ -13,6 +13,8 @@
 #import "PFObject+Deprecated.h"
 #import "PFObjectSubclassingController.h"
 
+#import <Parse/Parse.h>
+
 #import <objc/message.h>
 #import <objc/objc-sync.h>
 #import <objc/runtime.h>
@@ -1460,6 +1462,11 @@ - (BFTask *)saveAsync:(BFTask *)toAwait {
                 if (![self isDirty:YES]) {
                     return @YES;
                 }
+                
+                if([Parse isAllowCustomObjectIds]){
+                    NSError *error = [PFErrorUtilities errorWithCode:kPFErrorMissingObjectId message:@"ObjectId must not be null"];
+                    return [BFTask taskWithError:error];
+                }
 
                 [self _objectWillSave];
 
@@ -1532,18 +1539,31 @@ - (nullable PFRESTCommand *)_constructSaveCommandForChanges:(PFOperationSet *)ch
         NSDictionary *parameters = [self _convertToDictionaryForSaving:changes withObjectEncoder:encoder error:error];
         PFPreconditionBailOnError(parameters, error, nil);
 
-        if (self._state.objectId) {
-            return [PFRESTObjectCommand updateObjectCommandForObjectState:self._state
+        if(!self._state.objectId){
+            return [PFRESTObjectCommand createObjectCommandForObjectState:self._state
                                                                   changes:parameters
                                                          operationSetUUID:changes.uuid
-                                                             sessionToken:sessionToken];
+                                                            sessionToken:sessionToken];
+        }else{
+            if([Parse isAllowCustomObjectIds]){
+                if(self._state.createdAt == nil){
+                    return [PFRESTObjectCommand createObjectCommandForObjectState:self._state
+                                                                          changes:parameters
+                                                                 operationSetUUID:changes.uuid
+                                                                     sessionToken:sessionToken];
+                }else{
+                    return [PFRESTObjectCommand updateObjectCommandForObjectState:self._state
+                                                                          changes:parameters
+                                                                 operationSetUUID:changes.uuid
+                                                                     sessionToken:sessionToken];
+                }
+            }else{
+                return [PFRESTObjectCommand updateObjectCommandForObjectState:self._state
+                                                                      changes:parameters
+                                                             operationSetUUID:changes.uuid
+                                                                 sessionToken:sessionToken];
+            }
         }
-
-        return [PFRESTObjectCommand createObjectCommandForObjectState:self._state
-                                                              changes:parameters
-                                                     operationSetUUID:changes.uuid
-                                                         sessionToken:sessionToken];
-
     }
 }
 
@@ -1792,6 +1812,11 @@ + (PFObjectState *)_newObjectStateWithParseClassName:(NSString *)className
 }
 
 - (BFTask<PFVoid> *)_validateSaveEventuallyAsync {
+    if([Parse isAllowCustomObjectIds]){
+        NSError *error = [PFErrorUtilities errorWithCode:kPFErrorMissingObjectId message:@"ObjectId must not be null"];
+        return [BFTask taskWithError:error];
+    }
+    
     return [BFTask taskWithResult:nil];
 }
 

Parse/Parse/Parse.h

@@ -152,6 +152,22 @@ NS_ASSUME_NONNULL_BEGIN
  */
 @property (nonatomic, readonly, class) BOOL isLocalDatastoreEnabled PF_TV_UNAVAILABLE;
 
+///--------------------------------------
+#pragma mark - Allowing Custom ObjectIds
+///--------------------------------------
+
+/**
+ Allow custom ObjectIds in your application.`.
+ */
++ (void)allowCustomObjectIds PF_TV_UNAVAILABLE;
+
+/**
+ Flag that indicates whether Custom ObjectIds are allowed.
+ 
+ @return `YES` if Custom ObjectIds are allowed, otherwise `NO`.
+ */
+@property (nonatomic, readonly, class) BOOL isAllowCustomObjectIds PF_TV_UNAVAILABLE;
+
 ///--------------------------------------
 #pragma mark - Enabling Extensions Data Sharing
 ///--------------------------------------

Parse/Parse/Parse.m

@@ -189,6 +189,14 @@ + (BOOL)isLocalDatastoreEnabled {
     return currentParseManager_.offlineStoreLoaded;
 }
 
+///--------------------------------------
+#pragma mark - Custom ObjectIds
+///--------------------------------------
+
++ (BOOL)isAllowCustomObjectIds {
+    return currentParseConfiguration_.allowCustomObjectId;
+}
+
 ///--------------------------------------
 #pragma mark - User Interface
 ///--------------------------------------

Parse/Parse/ParseClientConfiguration.h

@@ -67,6 +67,17 @@ NS_ASSUME_NONNULL_BEGIN
  */
 @property (nonatomic, assign, getter=isLocalDatastoreEnabled) BOOL localDatastoreEnabled PF_TV_UNAVAILABLE;
 
+///--------------------------------------
+#pragma mark - Enabling Custom Object Ids
+///--------------------------------------
+
+/**
+ Whether or not to enable support for custom object ids in the SDK.
+
+ The default value is `NO`.
+ */
+@property (nonatomic, assign, getter=allowCustomObjectId) BOOL allowCustomObjectId;
+
 ///--------------------------------------
 #pragma mark - Enabling Extensions Data Sharing
 ///--------------------------------------
@@ -148,6 +159,17 @@ NS_ASSUME_NONNULL_BEGIN
  */
 @property (nonatomic, assign, readonly, getter=isLocalDatastoreEnabled) BOOL localDatastoreEnabled;
 
+///--------------------------------------
+#pragma mark - Enabling Custom Object Ids
+///--------------------------------------
+
+/**
+ Whether or not to enable support for custom object ids in the SDK.
+
+ The default value is `NO`.
+ */
+@property (nonatomic, assign, readonly, getter=isAllowCustomObjectId) BOOL allowCustomObjectId;
+
 ///--------------------------------------
 #pragma mark - Enabling Extensions Data Sharing
 ///--------------------------------------

Parse/Parse/ParseClientConfiguration.m

@@ -115,6 +115,7 @@ - (BOOL)isEqual:(id)object {
             [self.server isEqualToString:other.server] &&
             self.fileUploadController == other.fileUploadController &&
             self.localDatastoreEnabled == other.localDatastoreEnabled &&
+            self.allowCustomObjectId == other.allowCustomObjectId &&
             [PFObjectUtilities isObject:self.applicationGroupIdentifier equalToObject:other.applicationGroupIdentifier] &&
             [PFObjectUtilities isObject:self.containingApplicationBundleIdentifier equalToObject:other.containingApplicationBundleIdentifier] &&
             [PFObjectUtilities isObject:self.URLSessionConfiguration equalToObject:other.URLSessionConfiguration] &&
@@ -134,6 +135,7 @@ - (instancetype)copyWithZone:(NSZone *)zone {
     configuration->_server = [self.server copy];
     configuration->_fileUploadController = self->_fileUploadController;
     configuration->_localDatastoreEnabled = self->_localDatastoreEnabled;
+    configuration->_allowCustomObjectId = self->_allowCustomObjectId;
     configuration->_applicationGroupIdentifier = [self->_applicationGroupIdentifier copy];
     configuration->_containingApplicationBundleIdentifier = [self->_containingApplicationBundleIdentifier copy];
     configuration->_networkRetryAttempts = self->_networkRetryAttempts;

Parse/Tests/Unit/ObjectUnitTests.m

@@ -307,6 +307,7 @@ -(void)testSaveRelationToACycle {
     XCTAssertEqualObjects(error.domain, PFParseErrorDomain);
     XCTAssertEqualObjects(error.localizedDescription, @"Found a circular dependency when saving.");
 }
+
 -(void)testSaveRelationToACycleInAnArray {
     PFObject *objectA = [PFObject objectWithClassName:@"A"];
     PFObject *objectB = [PFObject objectWithClassName:@"B"];

Parse/Tests/Unit/ParseClientConfigurationTests.m

@@ -40,13 +40,15 @@ - (void)testConfigurationWithBlock {
         configuration.server = @"http://localhost";
         configuration.localDatastoreEnabled = YES;
         configuration.networkRetryAttempts = 1337;
+        configuration.allowCustomObjectId = YES
     }];
 
     XCTAssertEqualObjects(configuration.applicationId, @"foo");
     XCTAssertEqualObjects(configuration.clientKey, @"bar");
     XCTAssertEqualObjects(configuration.server, @"http://localhost");
     XCTAssertTrue(configuration.localDatastoreEnabled);
     XCTAssertEqual(configuration.networkRetryAttempts, 1337);
+    XCTAssertTrue(configuration.allowCustomObjectId);
 }
 
 - (void)testEqual {