Better non-subscriptions support #281

vegaro · 2020-07-16T02:52:11Z

Should fix #272

If a user purchases the the same product identifier more than once, Purchaser info won't reflect that, since allPurchasedProductIdentifiers is a Set.

This is a problem for consumables, where if a user purchases the same consumable multiple times (for example, a pack of coins), the app won't have a good way of checking how many times the purchase has been made.

…List

jeiting · 2020-07-16T11:46:40Z

Purchases/Public/RCPurchaserInfo.m


 @interface RCPurchaserInfo ()

 @property (nonatomic) NSDictionary<NSString *, NSDate *> *expirationDatesByProduct;
 @property (nonatomic) NSDictionary<NSString *, NSDate *> *purchaseDatesByProduct;
 @property (nonatomic) NSSet<NSString *> *nonConsumablePurchases;
+@property (nonatomic) NSArray<RCTransaction *> *nonConsumableTransactionsList;


List is redundant with the type.

jeiting · 2020-07-16T11:48:01Z

Purchases/SwiftSources/PurchaserInfoHelper.swift

+
+@objc public class PurchaserInfoHelper: NSObject {
+
+    @objc public class func nonConsumableTransactionsList(withNonSubscriptionsTransactionsDictionary data: Dictionary<String, Array<Transaction>>) -> Array<Transaction> {


withNonSubscriptionsTransactionsDictionary -> withNonSubscriptionTransactionsDictionary

jeiting · 2020-07-16T11:51:23Z

Purchases/Public/RCPurchaserInfo.m

@@ -82,7 +85,8 @@ - (void)initializePurchasesAndEntitlementsWithSubscriberData:(NSDictionary *)sub
                                               subscriptions:(NSDictionary *)subscriptions {
    NSDictionary<NSString *, NSArray *> *nonSubscriptions = subscriberData[@"non_subscriptions"];
    self.nonConsumablePurchases = [NSSet setWithArray:[nonSubscriptions allKeys]];


Wait. How do we go from "non-subscriptions" to "non-consumables"?

jeiting · 2020-07-16T11:54:52Z

Purchases/Public/RCPurchaserInfo.m

@@ -82,7 +85,8 @@ - (void)initializePurchasesAndEntitlementsWithSubscriberData:(NSDictionary *)sub
                                               subscriptions:(NSDictionary *)subscriptions {
    NSDictionary<NSString *, NSArray *> *nonSubscriptions = subscriberData[@"non_subscriptions"];
    self.nonConsumablePurchases = [NSSet setWithArray:[nonSubscriptions allKeys]];
-
+    self.nonConsumableTransactionsByProduct = [PurchaserInfoHelper nonConsumableTransactionsMapWithNonSubscriptionsDictionary:subscriberData dateFormatter:dateFormatter];
+    self.nonConsumableTransactionsList = [PurchaserInfoHelper nonConsumableTransactionsListWithNonSubscriptionsTransactionsDictionary:self.nonConsumableTransactionsByProduct];


Widening from that. How does a list of "non consumable transactions" improve our consumable support?

aboedo · 2020-07-21T20:51:48Z

Purchases/Public/RCPurchaserInfo.m

-
+    NSDictionary<NSString *, NSArray *> *nonSubscriptionsData = subscriberData[@"non_subscriptions"];
+    self.nonConsumablePurchases = [NSSet setWithArray:[nonSubscriptionsData allKeys]];
+    self.nonSubscriptionTransactions = [PurchaserInfoHelper initNonSubscriptionTransactionsWith:nonSubscriptionsData dateFormatter:dateFormatter];


something weird happening in the name here, right? should this be initWithNonSubscriptionTransactions?

Wouldn't initWithNonSubscriptionTransactions indicate that a PurchaserInfoHelper is being initialized? In this case I want that static function to initialize the nonSubscriptionTransactions of the PurchaserInfo. What name do you think works better?

oohhh I see, my bad.
In that case, I would steer clear of init so it's not misinterpreted as an initializer (that's what I thought it was).
how about configureNonSubscriptionTransactions:dateFormatter:?

I missed something again, I need to get more sleep. Just realized that this returns new objects.
In that case, I don't think either init or configure really apply - why not just nonSubscriptionTransactions(fromSubscriptionsData:dateFormatter)
or
nonSubscriptionTransactions(withSubscriptionsData:dateFormatter) (I think this was used at some point?)

aboedo · 2020-07-21T20:54:29Z

Purchases/SwiftSources/Purchasing/PurchaserInfoHelper.swift

+
+@objc public class PurchaserInfoHelper: NSObject {
+
+    @objc public class func initNonSubscriptionTransactions(with data: Dictionary<String, Array<Dictionary<String, Any>>>, dateFormatter: DateFormatter) -> Array<Transaction> {


for something more idiomatic, this should be

@objc public init(withNonSubscriptionTransactions nonSubscriptionTransactions: [String: [[String: Any]], dateFormatter: DateFormatter)

Wouldn't that be an init for the PurchaserInfoHelper? I was thinking about making this a helper class with static functions. Maybe I can rename this function to be extractNonSubscriptionTransactions(from data:? Or maybe this shouldn't be a static class and it should be similar to what you did in RCProductInfoExtractor

yeah, my bad, I thought this was initializing purchaserInfoHelper.

aboedo · 2020-07-21T20:55:14Z

Purchases/SwiftSources/Purchasing/PurchaserInfoHelper.swift

+@objc public class PurchaserInfoHelper: NSObject {
+
+    @objc public class func initNonSubscriptionTransactions(with data: Dictionary<String, Array<Dictionary<String, Any>>>, dateFormatter: DateFormatter) -> Array<Transaction> {
+        data.flatMap { (productId: String, transactionData: Array<Dictionary<String, Any>>) -> Array<Transaction> in


Array<Dictionary<String, Any>> -> [[String: Any]]
Array<Transaction> -> [Transaction]

aboedo · 2020-07-21T22:15:33Z

Purchases/SwiftSources/Purchasing/Transaction.swift

+        super.init()
+    }
+
+    internal init(with data: Dictionary<String, Any>, productId: String, dateFormatter: DateFormatter) {


Dictionary<String, Any> -> [String: Any]

could we rename data to something more descriptive of what it should contain?
developers could also expect data to be of type Data and not a dict

what do you think about serverResponse?

sounds great

aboedo · 2020-07-21T22:15:58Z

Purchases/SwiftSources/Purchasing/Transaction.swift

+    let productId: String
+    let purchaseDate: Date
+
+    internal init(transactionId: String, productId: String, purchaseDate: Date) {


internal is the default, we might want to omit it

aboedo · 2020-07-21T22:19:13Z

Purchases/SwiftSources/Purchasing/Transaction.swift

+
+import Foundation
+
+@objc(RCTransaction) public class Transaction: NSObject {


all objects that inherit from NSObject have a public init with no arguments.
If we want to prevent that from being used, maybe we can do something like

required init?() { fatalError("init() has not been implemented") }

haven't tested that, though

to provide some context on the why:
there's a bit of a gotcha when it comes to swift-objc interoperability and initialization, and nullability.
if you call init() from objc, that will work, because this is an NSObject. however, the object's properties will not have been initialized, so revenuecatId for example will be nil.
but since the type is declared as non-nil, you won't be able to check against that - if you do

if revenuecatId != nil {

the compiler will complain because the object isn't nullable. so you'll be in a bad place.

Here's a blog post that goes into a bit more detail in case you're curious:
https://fabiancanas.com/blog/2020/1/9/swift-undefined-behavior.html

Thanks for the explanation! Unfortunately it doesn't work, it says "Failable initializer 'init()' cannot override a non-failable initializer". Since it throws a fatalError this is actually not a Failable Initializer right? I think it should be this instead:

required override init() { fatalError("init() has not been implemented") }

Should it be a convenience initializer too?

I missed the override, but yeah, it should be there.
does failable mean that it's an init?() vs init()?

yeah failable means init?, but since this is throwing a fatalError, it is not an init? because it will actually never finish initializing. If I understand correctly, to make it failable it would have to return nil instead of throwing the error, it needs to return something

yeah, for a failable it'd be best practice to return nil if it fails.
I'm good with anything, as long as we make sure that [[Transaction alloc] init]; can't be used

maybe this is the way to go?

aboedo · 2020-07-21T22:31:27Z

Purchases/SwiftSources/Purchasing/Transaction.swift

+    }
+
+    internal init(with data: Dictionary<String, Any>, productId: String, dateFormatter: DateFormatter) {
+        self.revenuecatId = data["id"] as! String


we should avoid force casts since they're pretty annoying to debug, the stack trace isn't ideal.
so I'd do

guard let revenueCatId = data["id"] as? String, let dateString = data["purchase_date"] as? String, let purchaseDate = dateFormatter.date(from: dateString) else { fatalError("couldn't initialize Transaction from dictionary. Reason: unexpected format. Dictionary: \(data).") } self.revenuecatId = revenuecatId self.purchaseDate = purchaseDate

You could also get more granular and do multiple guard lets, of course.

Oh didn't know you could chain the conditions of the guard let

aboedo · 2020-07-21T22:34:07Z

PurchasesTests/SwiftSources/Purchasing/PurchaserInfoHelperTests.swift

+    }
+
+    func testNonSubscriptionsIsCorrectlyCreated() {
+        let list: Array<Transaction> = PurchaserInfoHelper.initNonSubscriptionTransactions(with: dict, dateFormatter: dateFormatter)


the type can be inferred, so I'd leave it out.
But if you do want it to be explicit, I'd replace Array<Transaction> -> [Transaction]

aboedo · 2020-07-22T14:37:45Z

Purchases/Public/RCPurchaserInfo.m

-
+    NSDictionary<NSString *, NSArray *> *nonSubscriptionsData = subscriberData[@"non_subscriptions"];
+    self.nonConsumablePurchases = [NSSet setWithArray:[nonSubscriptionsData allKeys]];
+    self.nonSubscriptionTransactions = [PurchaserInfoHelper initNonSubscriptionTransactionsWith:nonSubscriptionsData dateFormatter:dateFormatter];


oohhh I see, my bad.
In that case, I would steer clear of init so it's not misinterpreted as an initializer (that's what I thought it was).
how about configureNonSubscriptionTransactions:dateFormatter:?

aboedo · 2020-07-22T14:39:21Z

Purchases/SwiftSources/Purchasing/PurchaserInfoHelper.swift

+
+import Foundation
+
+@objc public class PurchaserInfoHelper: NSObject {


since the class doesn't directly use purchaserInfo, maybe TransactionsFactory would be more accurate?

Sounds good! I thought about using it to build other stuff in the PurchaserInfo, but we can think about that in the future

aboedo · 2020-07-22T14:39:43Z

Purchases/SwiftSources/Purchasing/PurchaserInfoHelper.swift

+
+@objc public class PurchaserInfoHelper: NSObject {
+
+    @objc public class func initNonSubscriptionTransactions(with data: [String: [[String: Any]]], dateFormatter: DateFormatter) -> [Transaction] {


an instance method might make this easier to replace in testing

aboedo · 2020-07-22T14:41:29Z

Purchases/SwiftSources/Purchasing/Transaction.swift

+
+import Foundation
+
+@objc(RCTransaction) public class Transaction: NSObject {


I missed the override, but yeah, it should be there.
does failable mean that it's an init?() vs init()?

aboedo · 2020-07-22T14:42:51Z

Purchases/SwiftSources/Purchasing/Transaction.swift

+        super.init()
+    }
+
+    internal init(with data: [String: Any], productId: String, dateFormatter: DateFormatter) {


internal is the default, we don't need the keyword here

…urchase-array # Conflicts: # Purchases.xcodeproj/project.pbxproj

vegaro · 2020-07-23T04:55:53Z

@aboedo I believe all comments have been addressed

aboedo

looks good! left a few style comments

aboedo · 2020-07-23T13:18:29Z

Purchases/Public/RCPurchaserInfo.h

+/// Returns all the non-subscription purchases a user has made. The purchases are ordered being the most recent purchase
+/// the last item of the array.


maybe this makes the ordering clearer?

/// Returns all the non-subscription purchases a user has made. /// The purchases are ordered by purchase date in ascending order.

aboedo · 2020-07-23T13:25:50Z

Purchases/SwiftSources/Purchasing/Transaction.swift

+    @available(*, unavailable, message: "Use init(transactionId, productId, purchaseDate) instead")
+    override init() {
+        fatalError("init() has not been implemented")
+    }


aboedo · 2020-07-23T13:27:43Z

Purchases/SwiftSources/Purchasing/TransactionsFactory.swift

+
+@objc(RCTransactionsFactory) public class TransactionsFactory: NSObject {
+
+    @objc public func nonSubscriptionTransactions(with subscriptionsData: [String: [[String: Any]]], dateFormatter: DateFormatter) -> [Transaction] {


let's add a line break in between params to stick to 120 chars per line whenever possible

@objc public func nonSubscriptionTransactions(with subscriptionsData: [String: [[String: Any]]], dateFormatter: DateFormatter) -> [Transaction] {

that Any can probably be constrained to AnyObject, right? since it's meant to be used from obj-c.
The difference is that Any can also be non-objects (for example, a bool), whereas AnyObject means anything that's a class.
This is a requirement for objective-c NSDictionaries anyway - if you want to insert a bool, you'd have to wrap it in an NSNumber *.
https://medium.com/@mimicatcodes/any-vs-anyobject-in-swift-3-b1a8d3a02e00

I forgot to delete that comment regarding Any -> AnyObject - after thinking about it more, I think it may not be worth it. It would make testing slightly trickier since you have to convert primitive types before calling the method, and it's already enforced for obj-c anyway. so.... nevermind. sorry for the noise.

aboedo · 2020-07-23T13:34:53Z

PurchasesTests/SwiftSources/Purchasing/PurchaserInfoHelperTests.swift

+        expect { list.count }.to(equal(4))
+
+        dict.forEach { productId, transactionsData in
+            let filteredTransactions: Array<Transaction> = list.filter { (transaction: Transaction) in


the type can be inferred here, no need for the explicit type.
Also, the filter is simple enough that it might not merit the explicit variable naming, so this expression could be simplified to

let filteredTransactions = list.filter { $0.productId == productId }

aboedo · 2020-07-23T13:35:08Z

PurchasesTests/SwiftSources/Purchasing/PurchaserInfoHelperTests.swift

+    }
+
+    func testNonSubscriptionsIsCorrectlyCreated() {
+        let list = transactionsFactory.nonSubscriptionTransactions(with: dict, dateFormatter: dateFormatter)


list -> nonSubscriptionTransactions

aboedo · 2020-07-23T13:35:24Z

PurchasesTests/SwiftSources/Purchasing/PurchaserInfoHelperTests.swift

+    let dateFormatter = DateFormatter()
+    let transactionsFactory = TransactionsFactory()
+
+    let dict = [


sampleTransactions

aboedo · 2020-07-23T13:38:19Z

PurchasesTests/SwiftSources/Purchasing/PurchaserInfoHelperTests.swift

+            }
+            expect { filteredTransactions.count }.to(equal(transactionsData.count))
+            transactionsData.forEach { dictionary in
+                let containsTransaction: Bool = filteredTransactions.contains { (transaction: Transaction) in


could also be simplified to

guard let transactionId = dictionary["id"] as String else { fatalError("incorrect dict format") } let containsTransaction = filteredTransactions.contains { $0.revenueCatId == transactionId }

aboedo · 2020-07-23T13:40:23Z

PurchasesTests/SwiftSources/Purchasing/PurchaserInfoHelperTests.swift

+                let containsTransaction: Bool = filteredTransactions.contains { (transaction: Transaction) in
+                    transaction.revenueCatId == dictionary["id"] as! String
+                }
+                expect { containsTransaction }.to(beTrue())


shorthand syntax for this is

expect(containsTransaction) == true

also, the { expression }
is meant for blocks of code, for example if you want to check that running a method won't crash, you use

expect { myMethod() }.notTo(raiseException())

for variables that have already been computed, use expect(myValue)

aboedo · 2020-07-23T13:44:10Z

PurchasesTests/SwiftSources/Purchasing/PurchaserInfoHelperTests.swift

+
+    func testNonSubscriptionsIsEmptyIfThereAreNoNonSubscriptions() {
+        let list = transactionsFactory.nonSubscriptionTransactions(with: [:], dateFormatter: dateFormatter)
+        expect { list.count }.to(equal(0))


expect(list.count) == 0

a couple of equivalent expressions:

expect(list.isEmpty) == true expect(list).to(beEmpty())

aboedo · 2020-07-23T13:49:13Z

Purchases/SwiftSources/Purchasing/TransactionsFactory.swift

+@objc(RCTransactionsFactory) public class TransactionsFactory: NSObject {
+
+    @objc public func nonSubscriptionTransactions(with subscriptionsData: [String: [[String: Any]]], dateFormatter: DateFormatter) -> [Transaction] {
+        subscriptionsData.flatMap { (productId: String, transactionData: [[String: Any]]) -> [Transaction] in


I usually don't specify the types in these since they can be inferred, but In this case I like it - it helps the compiler and the dev not get lost in the nested block.

aboedo · 2020-07-23T13:56:11Z

Purchases/Public/RCPurchaserInfo.m

+    NSDictionary<NSString *, NSArray *> *nonSubscriptionsData = subscriberData[@"non_subscriptions"];
+    self.nonConsumablePurchases = [NSSet setWithArray:[nonSubscriptionsData allKeys]];


so non_subscriptions filters out consumables as well?

Yes, non_subscriptions contains both consumables and non-consumables. We've named this (nonConsumablePurchases) wrong since the beginning

ohh, so nonConsumablePurchases should have been named nonSubscriptions. Maybe we should add a warning? Seems like a gotcha

in that case, disregard my comment about the sample purchases naming, since consumables would also work

aboedo · 2020-07-23T13:57:38Z

PurchasesTests/SwiftSources/Purchasing/PurchaserInfoHelperTests.swift

+    let transactionsFactory = TransactionsFactory()
+
+    let dict = [
+        "100_coins": [


"100_coins" would be consumable, right? but the endpoint doesn't return them? if that's the case, we should maybe come up with something else that wouldn't be consumable, like
"sword_of_1000_truths" and "super_mega_shield_thingy"

The endpoint returns both non-consumables and consumables. I will add that to the tests

vegaro · 2020-07-23T17:40:51Z

@aboedo made the requested changes. I renamed the test file too so it might look like a new file. If you want I can rename it back for easier reviewing.

aboedo

looks great! 🚢

aboedo

looks great! 🚢

adds nonConsumableTransactionsByProduct and nonConsumableTransactions…

6cc8db5

…List

jeiting reviewed Jul 16, 2020

View reviewed changes

vegaro added 4 commits July 16, 2020 16:37

updates podfile.lock

cfdbc62

Moves the files to Purchasing group

46bb05b

renames properties and removes the map one

06a864a

fixes tests

6b4af61

vegaro changed the title ~~Better consumables support~~ Better non-subscriptions support Jul 17, 2020

vegaro marked this pull request as ready for review July 17, 2020 01:35

vegaro requested a review from aboedo July 17, 2020 01:35

aboedo reviewed Jul 21, 2020

View reviewed changes

vegaro added 3 commits July 21, 2020 20:59

Revert change in workspacesettings

9d7111e

uses proper array and dictionary notation

ac5c9ed

PR comments regarding Transaction class

caddb51

aboedo reviewed Jul 22, 2020

View reviewed changes

vegaro added 2 commits July 22, 2020 21:54

addresses comments

6bdd356

Merge branch 'develop' into cesardelavega/ch61/ios-non-subscription-p…

8e6c19d

…urchase-array # Conflicts: # Purchases.xcodeproj/project.pbxproj

vegaro requested a review from aboedo July 23, 2020 04:55

aboedo approved these changes Jul 23, 2020

View reviewed changes

aboedo reviewed Jul 23, 2020

View reviewed changes

vegaro added 5 commits July 23, 2020 10:28

Renames test and adds a non-consumable

e0e5027

change to expect { list }.to(beEmpty())

a35c6b2

More comments on tests

40235a4

line break

5266514

Updates comment

4d8609d

aboedo approved these changes Jul 23, 2020

View reviewed changes

vegaro merged commit c860528 into develop Jul 23, 2020

vegaro deleted the cesardelavega/ch61/ios-non-subscription-purchase-array branch July 23, 2020 19:21

vegaro mentioned this pull request Aug 4, 2020

Version 3.6.0-beta #307

Merged

aboedo mentioned this pull request Aug 27, 2020

release: 3.6.0-beta-2 #322

Merged

aboedo mentioned this pull request Sep 10, 2020

Release/3.6.0 #335

Merged

aboedo mentioned this pull request Jul 13, 2021

Release: 3.12.0 #648

Merged


		@objc public class PurchaserInfoHelper: NSObject {

		@objc public class func nonConsumableTransactionsList(withNonSubscriptionsTransactionsDictionary data: Dictionary<String, Array<Transaction>>) -> Array<Transaction> {


		@objc public class PurchaserInfoHelper: NSObject {

		@objc public class func initNonSubscriptionTransactions(with data: Dictionary<String, Array<Dictionary<String, Any>>>, dateFormatter: DateFormatter) -> Array<Transaction> {


		import Foundation

		@objc(RCTransaction) public class Transaction: NSObject {

		/// Returns all the non-subscription purchases a user has made. The purchases are ordered being the most recent purchase
		/// the last item of the array.


		@objc(RCTransactionsFactory) public class TransactionsFactory: NSObject {

		@objc public func nonSubscriptionTransactions(with subscriptionsData: [String: [[String: Any]]], dateFormatter: DateFormatter) -> [Transaction] {

		NSDictionary<NSString , NSArray > *nonSubscriptionsData = subscriberData[@"non_subscriptions"];
		self.nonConsumablePurchases = [NSSet setWithArray:[nonSubscriptionsData allKeys]];

Better non-subscriptions support #281

Better non-subscriptions support #281

Conversation

vegaro commented Jul 16, 2020 • edited

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

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 Jul 22, 2020 • edited

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vegaro commented Jul 23, 2020

aboedo 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

aboedo Jul 23, 2020 • edited

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vegaro commented Jul 23, 2020

aboedo left a comment

Choose a reason for hiding this comment

aboedo left a comment

Choose a reason for hiding this comment

vegaro commented Jul 16, 2020 •

edited

vegaro Jul 22, 2020 •

edited

aboedo Jul 23, 2020 •

edited