identity v3 #438

aboedo · 2021-01-07T21:05:17Z

Introduces a new take on identity.

Public changes overview

New methods

Introduces logIn, a new way of identifying users, which also returns whether a new user has been registered in the system.
logIn uses a new backend endpoint.
Introduces logOut, a replacement for reset.

Deprecations / removals

removes createAlias
deprecates identify in favor of logIn
deprecates reset in favor of logOut
deprecates allowSharingAppStoreAccount in favor of dashboard-side configuration

Review notes

A new class was created, RCPurchaserInfoManager, which takes on the responsibility of sending information to the delegate, knowing what has last been sent, serializing purchaserInfo for caching, and everything else purchaser-info related.
the public changes aren't a part of this PR, they'll be a part of the follow-up. This is intended so that we can actually merge this into develop before the backend is ready.

aboedo · 2021-01-11T20:17:17Z

Purchases/Caching/RCDeviceCache.m

-
+        [self clearLatestNetworkAndAdvertisingIdsSentForAppUserID:oldAppUserID];


🤔 I did this because I figured if we're clearing caches, we should probably delete everything about the old user, but... this might be a problem because we call this method even if the user gets aliased, so if the user doesn't change, we might still be deleting this

aboedo · 2021-01-11T20:19:46Z

Purchases/Identity/RCIdentityManager.h

+#import <Foundation/Foundation.h>
+#import "RCDeviceCache.h"
+
+@class RCPurchaserInfo, RCPurchaserInfoManager, RCBackend;


this class is mostly just the same as before, it was moved into the Identity group

aboedo · 2021-01-11T20:20:01Z

Purchases/Identity/RCIdentityManager.h

+- (void)logInAppUserID:(NSString *)newAppUserID
+       completionBlock:(void (^)(RCPurchaserInfo * _Nullable purchaserInfo,
+                                 BOOL created,
+                                 NSError *error))completion;
+
+- (void)logOutWithCompletionBlock:(void (^)(NSError * _Nullable error))completion;


new methods: logIn, logOut

aboedo · 2021-01-11T20:20:34Z

Purchases/Identity/RCIdentityManager.h

+#pragma MARK - deprecated methods
+


added the deprecated pragma, but since these are the internal methods, I didn't actually mark them deprecated otherwise we'd get a compiler warning ourselves

aboedo · 2021-01-11T20:21:28Z

Purchases/Identity/RCIdentityManager.m

@@ -51,10 +55,10 @@ - (void)configureWithAppUserID:(nullable NSString *)appUserID {
    [self.deviceCache cleanupSubscriberAttributes];
 }

- (void)identifyAppUserID:(NSString *)appUserID withCompletionBlock:(void (^)(NSError *_Nullable error))completion {
+- (void)identifyAppUserID:(NSString *)appUserID completionBlock:(void (^)(NSError *_Nullable error))completion {


mild rename because you're only supposed to reference the first param in objc, after that you can just use the name

aboedo · 2021-01-20T20:15:55Z

Purchases/Public/RCPurchasesErrors.h

@@ -52,6 +52,7 @@ typedef NS_ERROR_ENUM(RCPurchasesErrorDomain, RCPurchasesErrorCode) {
    RCInsufficientPermissionsError,
    RCPaymentPendingError,
    RCInvalidSubscriberAttributesError,
+    RCLogOutAnonymousUserError,


will update this to add a number after the #452 stuff gets merged

aboedo · 2021-01-20T20:16:16Z

Purchases/Purchasing/RCIdentityManager.h

@@ -1,37 +0,0 @@
-//


again, this wasn't removed, it was moved to the Identity group / folder

aboedo · 2021-01-20T20:16:40Z

PurchasesTests/Identity/IdentityManagerTests.swift

@@ -0,0 +1,420 @@
+//


tests start here

the ones in this class aren't fully new, the file was moved into the Identity group. I'll point out the new ones.

aboedo · 2021-01-20T20:17:42Z

PurchasesTests/Identity/IdentityManagerTests.swift

+        assertCorrectlyIdentified(expectedAppUserID: "cesar")
+    }
+
+    func testLogInFailsIfEmptyAppUserID() {


new tests start here

aboedo · 2021-01-20T20:19:58Z

Purchases/Identity/RCPurchaserInfoManager.m

+- (void)cachePurchaserInfo:(RCPurchaserInfo *)info forAppUserID:(NSString *)appUserID {
+    if (info) {
+        NSDictionary *infoAsJSONDict = info.JSONObject;
+        if ([NSJSONSerialization isValidJSONObject:infoAsJSONDict]) {


this check is new. previously, if there was an error parsing the JSON (for example if the json has a value like infinity), the app would crash.
the jsonError bit only helps for errors like incomplete stream and stuff like that, but it for some reason doesn't actually cover what would happen with an invalid json.

vegaro

Haven't finished yet but I have some comments

Purchases/Identity/RCIdentityManager.m

vegaro · 2021-01-21T00:21:54Z

Purchases/Identity/RCIdentityManager.m

+    NSString *currentAppUserID = self.currentAppUserID;
+    if (!currentAppUserID) {
+        RCWarnLog(@"%@", RCStrings.identity.logging_in_with_initial_appuserid_nil);
+    }


Not that I don't like this, but this should technically not happen right? Just checking

yeah, this should never happen. In other cases like this, we would just crash. But this is the one instance where if it did happen, this method would actually make the SDK recover, so I figured I might as well continue execution if it does happen.

come to think about this again, we had issues in the past with aliasing to nil #255, so I'll give this some more thought

updated so that it errors out now, like with identity v2

Purchases/Identity/RCIdentityManager.m

vegaro · 2021-01-21T00:28:49Z

Purchases/Identity/RCIdentityManager.m

+
+    NSString *currentAppUserID = self.currentAppUserID;
+    if (!currentAppUserID) {
+        RCWarnLog(@"%@", RCStrings.identity.logging_in_with_initial_appuserid_nil);


I think this string should be creating_alias_failed_null_currentappuserid

this is just the identityV3 version of the same string

Purchases/Networking/RCBackend.h

Purchases/Public/RCPurchases.m

aboedo · 2021-02-19T18:36:31Z

@vegaro bump

vegaro · 2021-02-20T01:02:09Z

Purchases/Identity/RCPurchaserInfoManager.m

+    }
+
+    [self.systemInfo isApplicationBackgroundedWithCompletion:^(BOOL isAppBackgrounded) {
+        BOOL shouldCallCompletionAfterFetching = infoFromCache == nil && completion != nil;


I had some trouble understanding this part. I didn't understand why you were not just passing completion to fetchAndCachePurchaserInfoIfStaleWithAppUserID even if it's nil. I now get that it's to avoid the completion being called again if it was called already in line 167, but it took me a bit.

I was thinking maybe the check for [self.systemInfo isApplicationBackgroundedWithCompletion could be done in fetchAndCachePurchaserInfoIfStaleWithAppUserID. Then calling fetchAndCachePurchaserInfoIfStaleWithAppUserID in line 169 passing a nil completion.

This is just a suggestion including my personal preference, it is not necessarily the way I think this method should be written. If you think your current implementation is clear, leave it as is :)

Agreed, this looks pretty confusing

I did some cleanup here: I added an explicit boolean to store whether we've already called completion, and added a comment. lmk if it feels better! Doing the isAppBackgrounded check in fetchAndCachePurchaserInfoIfStaleWithAppUserID is a slightly larger refactor, but I'm happy to do it if the new logic is still confusing

PurchasesTests/Identity/IdentityManagerTests.swift

vegaro · 2021-03-05T20:57:23Z

Purchases/Identity/RCPurchaserInfoManager.m

+    }
+
+    // prevent calling completion twice
+    RCReceivePurchaserInfoBlock _Nullable fetchPurchaserInfoCompletion = completionCalled ? nil : completion;


Thanks for changing this!

…he old methods

…haserInfo

…ods on the main thread

…aserInfo

… cases

…t now errors out instead of continuing

…thread

…s nil

… returning from cache

updated purchaserInfo data key in login: "subscriber_data" -> "subscriber"

aboedo · 2021-03-17T18:56:51Z

merging this since it's approved, but I'm going to follow up to update the location of the appUserID param for login calls

aboedo added this to the 4.0.0 milestone Jan 7, 2021

aboedo self-assigned this Jan 7, 2021

aboedo force-pushed the feature/identityV3 branch 5 times, most recently from 68d9a08 to 7f76486 Compare January 11, 2021 19:52

aboedo force-pushed the feature/identityV3 branch 2 times, most recently from a96f970 to 3f1c121 Compare January 20, 2021 18:41

aboedo commented Jan 20, 2021

View reviewed changes

aboedo marked this pull request as ready for review January 20, 2021 20:21

aboedo requested a review from vegaro January 20, 2021 20:22

aboedo mentioned this pull request Jan 20, 2021

identity v3: public-facing changes #453

Merged

aboedo force-pushed the feature/identityV3 branch from 35de297 to c662650 Compare January 20, 2021 21:26

vegaro reviewed Jan 21, 2021

View reviewed changes

aboedo requested a review from vegaro February 9, 2021 15:10

aboedo force-pushed the feature/identityV3 branch from d34e785 to c3a6f58 Compare February 9, 2021 15:11

aboedo force-pushed the feature/identityV3 branch from c3a6f58 to c6d18fa Compare February 19, 2021 16:44

vegaro reviewed Feb 20, 2021

View reviewed changes

aboedo force-pushed the feature/identityV3 branch from 45c9647 to 547efd2 Compare March 1, 2021 17:22

aboedo requested a review from vegaro March 2, 2021 16:53

vegaro approved these changes Mar 5, 2021

View reviewed changes

aboedo added 7 commits March 5, 2021 18:03

fixed small potential race condition when resetting users

59bd4be

created basic skeleton for login call, refactored naming of some of t…

a157840

…he old methods

small refactor and improve logIn logic

618e5f8

created new Identity group

fc51be7

created a new class, RCPurchaserInfoManager, to hold logic for RCPurc…

60b9c61

…haserInfo

moved stuff into the RCPurchaserInfoManager

7e43f62

added purchaserInfoManager usage to tests

72d1890

aboedo added 22 commits March 5, 2021 18:16

added some test cases for purchaserInfoManager

22b9470

more test cases

1c038e6

added more test cases, simplified logic for calling the delegate meth…

5e2d1b1

…ods on the main thread

typo

75a0786

more test cases for purchaserInfoManager

49c2e65

added more test cases, added nullability specification to cachedPurch…

8678073

…aserInfo

fixed potential crash if json object can't be parsed, added more test…

eef8b03

… cases

final purchaserInfoManager test cases

b6e99f5

fix build warnings

9b91e9c

reverted public-facing changes so the PR can easily be integrated

6143ad5

added comment

a008105

removed extra line break

6a3a0ec

added more logs, improved some messages

87972a0

updated the behavior of logIn when the currentUserID is nil so that i…

01f2a04

…t now errors out instead of continuing

updated logOut completion so that it always gets calls from the main …

f749508

…thread

updated copy of identity failure message when the current appUserID i…

43845ba

…s nil

updated Package.swift to include Identity in the sources list

cd25017

fix typo

6a5a162

cleaned up logic that decides whether or not to call completion after…

4464903

… returning from cache

updated login endpoint: /login -> /identify.

0bbbb22

updated purchaserInfo data key in login: "subscriber_data" -> "subscriber"

fixed tests and nullability of errors

6024f3c

fix rebasing issues

404edf4

aboedo force-pushed the feature/identityV3 branch from 1196b7c to 404edf4 Compare March 5, 2021 21:30

aboedo merged commit 194ec49 into develop Mar 17, 2021

aboedo deleted the feature/identityV3 branch March 17, 2021 18:56

aboedo mentioned this pull request Mar 17, 2021

Identity v3: update appUserID param location #484

Merged

aboedo mentioned this pull request May 27, 2021

Release: 3.12.0-beta.1 #510

Closed

aboedo mentioned this pull request Jun 9, 2021

fix file references #523

Merged

aboedo mentioned this pull request Jul 13, 2021

Release: 3.12.0 #648

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

identity v3 #438

identity v3 #438

aboedo commented Jan 7, 2021 •

edited

aboedo Jan 11, 2021

aboedo Jan 11, 2021

aboedo Jan 11, 2021

aboedo Jan 11, 2021

aboedo Jan 11, 2021

aboedo Jan 20, 2021

aboedo Jan 20, 2021

aboedo Jan 20, 2021

aboedo Jan 20, 2021

aboedo Jan 20, 2021

aboedo Jan 20, 2021

vegaro left a comment

vegaro Jan 21, 2021

aboedo Feb 8, 2021

aboedo Feb 8, 2021

aboedo Feb 9, 2021

vegaro Jan 21, 2021

aboedo Feb 9, 2021

aboedo commented Feb 19, 2021

vegaro Feb 20, 2021

aboedo Mar 1, 2021

vegaro Mar 5, 2021

aboedo commented Mar 17, 2021


		[self clearLatestNetworkAndAdvertisingIdsSentForAppUserID:oldAppUserID];

identity v3 #438

identity v3 #438

Conversation

aboedo commented Jan 7, 2021 • edited

Public changes overview

New methods

Deprecations / removals

Review notes

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vegaro left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aboedo commented Feb 19, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aboedo commented Mar 17, 2021

aboedo commented Jan 7, 2021 •

edited