Add better, more flexible APIs for SDK initialization. #570

richardjrossiii · 2015-11-16T21:51:23Z

This PR includes public API Changes

Old initialization looked somewhat outdated, our new APIs allow a usage similar to this:

ObjC

[Parse initializeWithConfiguration:[ParseClientConfiguration configurationWithBlock:^(ParseClientConfiguration *configuration) {
    configuration.applicationId = ...;
    configuration.clientKey = ...;
    configuration.localDatastoreEnabled = ... ;

    // Data sharing config, etc.
}];

Swift

Parse.initializeWithConfiguration(ParseClientConfiguration() {
    $0.applicationId = ""
    $0.clientKey = ""
    $0.localDatastoreEnabled = true
    // etc.
})

We believe that this provides a much cleaner interface for initialization. Please feel free to comment below on any feedback that you may have on this

Our current SDK initialization is lackluster in that it's split across multiple classes, files, and method calls.

This PR hopes to unify some of these initialization settings int o a single 'configuration' class that can be easily used to intialize parse in a much cleaner way, especially as we add even more initialization options.

nlutsenko · 2015-11-16T21:54:40Z

Parse/ParseClientConfiguration.h

+ */
+
+#import <Parse/PFConstants.h>
+


Nullability annotate, pretty please. 😁

nlutsenko · 2015-11-16T21:58:49Z

Parse/ParseClientConfiguration.h

+@property (nonatomic, copy) NSString *applicationId;
+@property (nonatomic, copy) NSString *clientKey;
+
+@property (nonatomic, assign, getter=isLocalDatastoreEnabled)BOOL localDatastoreEnabled;


Nit: Space before BOOL

nlutsenko · 2015-11-17T02:45:08Z

Parse/ParseClientConfiguration.h

+@interface ParseClientConfiguration : NSObject<NSCopying>
+
+ (instancetype)new NS_UNAVAILABLE;
+ (instancetype)alloc NS_UNAVAILABLE;


I don't think we need these, simply due to the fact that you can't init it anyway after allocating... 2 less methods polluting the name space?

richardjrossiii · 2015-12-01T23:13:18Z

Hey all, just added some preliminary APIs for configuring URL sessions & retry attempts that we use in the SDK. Any feedback would be great!

facebook-github-bot · 2015-12-01T23:15:15Z

@richardjrossiii updated the pull request.

oferRounds · 2015-12-02T12:06:35Z

Hi @richardjrossiii
Thanks for your very detailed and answer and for your very quick respond!
The changes you've added look great! That will suit exactly what I'm looking for.

When do you think this PR could be merged into master?

grantland · 2015-12-03T00:52:39Z

Parse/Parse.h

@@ -67,6 +68,22 @@ NS_ASSUME_NONNULL_BEGIN
 + (void)setApplicationId:(NSString *)applicationId clientKey:(NSString *)clientKey;


I never realized that iOS uses set instead of initialize. I do like moving towards initialize since it's not exactly a setter, but is it weird to have it be named differently?

Also, if we keep initialize, we should probably update the abstract of it from Sets the configuration to be used for parse to Initialize Parse with a configuration or something

My best guess for the reason that we use set instead of initialize on iOS - +initialize is a method declared by NSObject, equivalent to a static contractor in java-land.

It would have caused some ambiguity for developers if we had a method call like [Parse initialize:@"appKey" clientKey:@"ck"], but we can get around that now by marking +initialize as unavailable for use (which wasn't possible when Parse was first created).

Ah that makes sense, SGTM!

grantland · 2015-12-03T20:09:32Z

Somewhat nitpicky, but ParseClientConfiguration seems super long. Would ParseConfiguration be confusing with ParseConfig?

nlutsenko · 2015-12-03T20:11:11Z

Somewhat nitpicky, but ParseClientConfiguration seems super long. Would ParseConfiguration be confusing with ParseConfig?

Yup, it's definitely confusing. It's ObjC anyway, so long names are expected...
Plus - this way lets us name the class in the same way across multiple platforms (there is ParseConfig already on the Java).

Another potential name that could work is ParseClientConfig, but then it's still somewhat confusing compared to ParseConfig.

nlutsenko · 2015-12-03T20:24:13Z

Parse/ParseClientConfiguration.m

+#pragma mark - Init
+///--------------------------------------
+
+- (instancetype)initWithConfigurationBlock:(void (^)(id<ParseMutableClientConfiguration>))configurationBlock {


Rename to initWithBlock:, as you don't have it in the static constructor.

facebook-github-bot · 2015-12-17T00:48:50Z

@richardjrossiii updated the pull request.

nlutsenko · 2015-12-17T01:39:32Z

Parse/Internal/ParseManager.m

-    _applicationGroupIdentifier = [applicationGroupIdentifier copy];
-    _containingApplicationIdentifier = [containingApplicationIdentifier copy];
+///--------------------------------------
+#pragma mark - Offline Store


Not sure if this is the appropriate place for it, as startManaging doesn't quite relate to Offline Store only.

facebook-github-bot · 2015-12-17T02:27:21Z

@richardjrossiii updated the pull request.

facebook-github-bot · 2015-12-17T19:16:16Z

@richardjrossiii updated the pull request.

nlutsenko · 2015-12-18T00:42:13Z

Parse/ParseClientConfiguration.m

+}
+
+- (instancetype)initWithBlock:(void (^)(id<ParseMutableClientConfiguration>))configurationBlock {
+    self = [super init];


Maybe invoke -initEmpty here and declare that as internal designated initializer (class extension in the .m file). Don't feel strongly about it, tho.

nlutsenko · 2015-12-18T00:43:32Z

One small nit, otherwise - it's perfect!

facebook-github-bot · 2015-12-18T23:24:11Z

@richardjrossiii updated the pull request.

Our current SDK initialization is lackluster in that it's split across multiple classes, files, and method calls. This PR hopes to unify some of these initialization settings int o a single 'configuration' class that can be easily used to intialize parse in a much cleaner way, especially as we add even more initialization options.

….update Add better, more flexible APIs for SDK initialization.

oferRounds · 2015-12-23T20:57:17Z

Hi @richardjrossiii
Sorry for the question, I'm just not completely sure - if I update my Parse SDK using CocoaPods, will this branch be included?

nlutsenko · 2015-12-23T21:25:29Z

@oferRounds No, not yet, this is going to be included in 1.12.0 release (per milestone on the Pull Request).

oferRounds · 2015-12-24T06:30:02Z

@richardjrossiii - cool, thanks!

facebook-github-bot · 2015-12-29T04:28:23Z

@richardjrossiii updated the pull request.

parse-github-assistant · 2021-12-06T13:44:47Z

The label type:feature cannot be used here.

richardjrossiii added enhancement labels Nov 16, 2015

richardjrossiii assigned nlutsenko Nov 16, 2015

nlutsenko reviewed Nov 16, 2015
View reviewed changes

Parse/ParseClientConfiguration.h

*/

#import <Parse/PFConstants.h>

Copy link

Contributor

nlutsenko Nov 16, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nullability annotate, pretty please. 😁

facebook-github-bot added the CLA Signed label Nov 16, 2015

nlutsenko reviewed Nov 16, 2015
View reviewed changes

richardjrossiii force-pushed the richardross.initialization.update branch 2 times, most recently from 1b588bf to 2497c8b Compare November 16, 2015 22:35

nlutsenko reviewed Nov 17, 2015
View reviewed changes

richardjrossiii force-pushed the richardross.initialization.update branch from 2497c8b to 2951556 Compare November 17, 2015 03:50

nlutsenko mentioned this pull request Nov 30, 2015

Allow disabling retry logic #607

Closed

richardjrossiii mentioned this pull request Dec 1, 2015

Question: how to get NSURLSessionConfiguration used by Parse #614

Closed

richardjrossiii force-pushed the richardross.initialization.update branch from 2951556 to 94492ca Compare December 1, 2015 23:12

grantland reviewed Dec 3, 2015
View reviewed changes

nlutsenko reviewed Dec 3, 2015
View reviewed changes

facebook-github-bot added GH Review: review-needed and removed GH Review: needs-revision labels Dec 17, 2015

nlutsenko reviewed Dec 17, 2015
View reviewed changes

nlutsenko added GH Review: needs-revision and removed GH Review: review-needed labels Dec 17, 2015

facebook-github-bot added GH Review: review-needed and removed GH Review: needs-revision labels Dec 17, 2015

nlutsenko reviewed Dec 18, 2015
View reviewed changes

nlutsenko added GH Review: accepted and removed GH Review: review-needed labels Dec 18, 2015

richardjrossiii force-pushed the richardross.initialization.update branch from 93bf830 to 61c2f8d Compare December 18, 2015 23:23

richardjrossiii force-pushed the richardross.initialization.update branch from 61c2f8d to f43a96e Compare December 18, 2015 23:27

richardjrossiii added a commit that referenced this pull request Dec 19, 2015

Merge pull request #570 from ParsePlatform/richardross.initialization…

5d633fc

….update Add better, more flexible APIs for SDK initialization.

richardjrossiii merged commit 5d633fc into master Dec 19, 2015

richardjrossiii deleted the richardross.initialization.update branch December 19, 2015 00:02

andrewimm mentioned this pull request Jan 28, 2016

Enhancement: Allow Electron to use browser version of Parse JS SDK. parse-community/Parse-SDK-JS#193

Closed

mtrezza added type:feature New feature or improvement of existing feature and removed type:improvement labels Dec 6, 2021

parse-github-assistant bot removed the type:feature New feature or improvement of existing feature label Dec 6, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add better, more flexible APIs for SDK initialization. #570

Add better, more flexible APIs for SDK initialization. #570

richardjrossiii commented Nov 16, 2015

nlutsenko Nov 16, 2015

nlutsenko Nov 16, 2015

nlutsenko Nov 17, 2015

richardjrossiii commented Dec 1, 2015

facebook-github-bot commented Dec 1, 2015

oferRounds commented Dec 2, 2015

grantland Dec 3, 2015

richardjrossiii Dec 3, 2015

grantland Dec 3, 2015

grantland commented Dec 3, 2015

nlutsenko commented Dec 3, 2015

nlutsenko Dec 3, 2015

facebook-github-bot commented Dec 17, 2015

nlutsenko Dec 17, 2015

facebook-github-bot commented Dec 17, 2015

facebook-github-bot commented Dec 17, 2015

nlutsenko Dec 18, 2015

nlutsenko commented Dec 18, 2015

facebook-github-bot commented Dec 18, 2015

oferRounds commented Dec 23, 2015

nlutsenko commented Dec 23, 2015

oferRounds commented Dec 24, 2015

facebook-github-bot commented Dec 29, 2015

parse-github-assistant bot commented Dec 6, 2021

		@@ -67,6 +68,22 @@ NS_ASSUME_NONNULL_BEGIN
		+ (void)setApplicationId:(NSString )applicationId clientKey:(NSString )clientKey;

Add better, more flexible APIs for SDK initialization. #570

Add better, more flexible APIs for SDK initialization. #570

Conversation

richardjrossiii commented Nov 16, 2015

This PR includes public API Changes

ObjC

Swift

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

richardjrossiii commented Dec 1, 2015

facebook-github-bot commented Dec 1, 2015

oferRounds commented Dec 2, 2015

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

grantland commented Dec 3, 2015

nlutsenko commented Dec 3, 2015

Choose a reason for hiding this comment

facebook-github-bot commented Dec 17, 2015

Choose a reason for hiding this comment

facebook-github-bot commented Dec 17, 2015

facebook-github-bot commented Dec 17, 2015

Choose a reason for hiding this comment

nlutsenko commented Dec 18, 2015

facebook-github-bot commented Dec 18, 2015

oferRounds commented Dec 23, 2015

nlutsenko commented Dec 23, 2015

oferRounds commented Dec 24, 2015

facebook-github-bot commented Dec 29, 2015

parse-github-assistant bot commented Dec 6, 2021