subscription period #256

aboedo · 2020-05-27T21:07:40Z

Adds subscripion period to the POST receipt request.

Changes summary:

moved the test files into groups that mimic the ones for the main repo, for organization purposes.
added the fields from https://github.com/RevenueCat/khepri/pull/1539 to the post receipt request:
- normal_duration
- intro_duration
- trial_duration
The number of parameters for the post receipt endpoint was getting pretty unwieldy, and would change any time we read a new field from SKProducts. I extracted a few of those fields into a new class, RCProductInfo. This class also knows how to convert itself into a backend-compatible dictionary, and how to generate a cache key.
moved the logic that reads individual fields from SKProducts and does whatever transformations are needed for the backend endpoint into RCProductInfoExtractor. This also abstracts the logic of which fields can be read in which iOS versions.
Some minor refactors here and there. But the main changes are the ones described above.

…oducts to send to the backend, and RCProductInfoExtractor, which holds the logic to extract this info.

…ed the old postReceipt method from RCBackend

…inal files

aboedo · 2020-06-04T00:06:29Z

Examples/SwiftExample/Podfile.lock

-  Purchases: 0ed262862309e8aa3348b525755c8e84f53b1924
+  Purchases: 6bf68ed9926fefa775649bec025878c4de9175b5

 PODFILE CHECKSUM: b6ad00ca1e6fc400e0898ad2ac4a293958616d2e

-COCOAPODS: 1.8.4
+COCOAPODS: 1.9.1


just the result of upgrading cocoapods and running pod install.

aboedo · 2020-06-04T00:07:39Z

Purchases.xcodeproj/project.pbxproj

-		2D8DB3502407333100BE3D31 /* NSError+RCExtensionsTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 37E3550459807FF5636B2667 /* NSError+RCExtensionsTests.swift */; };
 		2DD448FF24088473002F5694 /* RCPurchases+SubscriberAttributes.h in Headers */ = {isa = PBXBuildFile; fileRef = 2DD448FD24088473002F5694 /* RCPurchases+SubscriberAttributes.h */; settings = {ATTRIBUTES = (Private, ); }; };
 		2DD4490024088473002F5694 /* RCPurchases+SubscriberAttributes.m in Sources */ = {isa = PBXBuildFile; fileRef = 2DD448FE24088473002F5694 /* RCPurchases+SubscriberAttributes.m */; };
+		2DEB9767247DB46900A92099 /* RCISOPeriodFormatter.h in Headers */ = {isa = PBXBuildFile; fileRef = 2DEB9766247DB46900A92099 /* RCISOPeriodFormatter.h */; settings = {ATTRIBUTES = (Private, ); }; };


two main things happening in this file:

moved test files intro groups, essentially a follow-up of Reorganize folders #242

added new files: RCISOPeriodFormatter, RCProductInfo, RCProductInfoExtractor

aboedo · 2020-06-04T00:08:00Z

Purchases/Networking/RCBackend.h

-typedef NS_ENUM(NSInteger, RCPaymentMode) {
-    RCPaymentModeNone = -1,
-    RCPaymentModePayAsYouGo = 0,
-    RCPaymentModePayUpFront = 1,
-    RCPaymentModeFreeTrial = 2
-};


moved to RCProductInfo

aboedo · 2020-06-04T00:08:23Z

Purchases/Networking/RCBackend.h

-          productIdentifier:(nullable NSString *)productIdentifier
-                      price:(nullable NSDecimalNumber *)price
-                paymentMode:(RCPaymentMode)paymentMode
-          introductoryPrice:(nullable NSDecimalNumber *)introductoryPrice
-               currencyCode:(nullable NSString *)currencyCode
-          subscriptionGroup:(nullable NSString *)subscriptionGroup
-                  discounts:(nullable NSArray<RCPromotionalOffer *> *)discounts
+                productInfo:(nullable RCProductInfo *)productInfo


abstracted parameters into object

aboedo · 2020-06-04T00:08:50Z

Purchases/Networking/RCBackend.h

 extern NSErrorUserInfoKey const RCSuccessfullySyncedKey;
 extern NSString * const RCAttributeErrorsKey;
 extern NSString * const RCAttributeErrorsResponseKey;

-API_AVAILABLE(ios(11.2), macos(10.13.2))
-RCPaymentMode RCPaymentModeFromSKProductDiscountPaymentMode(SKProductDiscountPaymentMode paymentMode);


moved to RCProductInfo.

I'm not a huge fan of the format, I was going to turn it into a static method instead but changing it didn't seem to add much value anyway

aboedo · 2020-06-04T00:12:07Z

Purchases/Purchasing/RCProductInfo.m

+- (NSDictionary *)productDurationsAsDictionary {
+    NSMutableDictionary *durations = [[NSMutableDictionary alloc] init];
+
+    if (self.normalDuration) {
+        durations[@"normal_duration"] = self.normalDuration;
+    }
+    if (self.introDurationType == RCIntroDurationTypeIntroPrice) {
+        durations[@"intro_duration"] = self.introDuration;
+    }
+    if (self.introDurationType == RCIntroDurationTypeFreeTrial) {
+        durations[@"trial_duration"] = self.introDuration;
+    }
+
+    return durations;


this is the only big new thing here

aboedo · 2020-06-04T00:13:33Z

Purchases/Purchasing/RCProductInfoExtractor.m

+    return self;
+}
+
+- (RCProductInfo *)extractInfoFromProduct:(SKProduct *)product {


most of this file was extracted from RCPurchases and cleaned up so that it's easier to follow

aboedo · 2020-06-04T00:14:00Z

Purchases/Purchasing/RCProductInfoExtractor.m

+    return introPrice;
+}
+
+- (NSString *)extractNormalDurationForProduct:(SKProduct *)product {


this and the method after it are the real new things here

aboedo · 2020-06-04T00:14:56Z

PurchasesTests/Mocks/MockSKProduct.swift

@@ -4,16 +4,54 @@
 //

 class MockSKProduct: SKProduct {


we had two separate mocks for SKProduct, MockSKProduct and MockProduct.
I unified them, updated tests and added a whole bunch of fields / mock stuff

aboedo · 2020-06-04T00:15:18Z

PurchasesTests/Purchasing/ProductInfoExtractorTests.swift

+
+        var receivedProductInfo = productInfoExtractor.extractInfo(from: product)
+
+        expect(receivedProductInfo.currencyCode) == "UYU"


Uruguayan Peso 💵 🇺🇾

vegaro

This PR looks great. Left a couple minor comments regarding the tests.

Thanks so much for doing all that cleanup!!!!

Purchases/Networking/RCBackend.m

vegaro · 2020-06-05T04:46:13Z

Purchases/Public/RCPurchases.m

-                                                                                          error:error];
-                                  }];
-                              }
-                          }];


wow this cleanup. awesome thanks!!!!

vegaro · 2020-06-05T04:58:49Z

PurchasesTests/Networking/BackendTests.swift

+        let productInfo = RCProductInfo(productIdentifier: "product_id",
+                                        paymentMode: .none,
+                                        currencyCode: "UYU",
+                                        price: 15.99,


not a biggie, but I would still have these as nil so that the only difference between the productInfos is the discounts

yeah, I did think about that when writing. the tests are definitely more noisy this way.
The reason I went this way was:

I wanted only arguments that were truly nullable (i.e.: you might not be able to extract them from an SKProduct) to be nullable.

I didn't want properties to be editable unless they needed to (this part could be done by doing a protected header, though)

Even though you can initialize RCProductInfo with no arguments (because it inherits from NSObject), that can lead to some pretty bad gotchas with swift:

When you initialize with no arguments, everything is nil. However, swift will assume that the object can't be nil unless nullable is specified (or no nullability is specified in the entire file).

For example, if I do:

let productInfo = RCProductInfo() let price = productInfo.price

That will crash, because price is nil, but swift didn't expect that. I won't be able to even check for it, since doing

let productInfo = RCProductInfo() if productInfo.price != nil {

will raise a compiler warning saying that price can't be nil.

To get around this, I usually disable the no-params constructor, I forgot about it this time.
To disable it, you do NS_UNAVAILABLE (example here which will raise a compiler warning when using that constructor.

That way you have control over the properties to make sure that they're never called from swift without having initialized them properly.

Thinking about possible fixes for this, I think the best workaround is to have a protected header that allows for these properties to be modified, and then a single function that always creates a valid ProductInfo object, so that I can do:

let productInfo = createProductInfo() productInfo.whateverProperty = "the value I want to test"

I'll do that refactor

PurchasesTests/Purchasing/ProductInfoExtractorTests.swift

PurchasesTests/Purchasing/ProductInfoTests.swift

… unavailable

aboedo self-assigned this May 27, 2020

aboedo added 3 commits May 29, 2020 20:47

added ISOPeriodFormatter and used it for the product duration

b264651

replaced the swift file with objective-c

70b0d10

remove extra build settings

110a9b8

aboedo force-pushed the feature/subscription_period branch from b121e8a to 110a9b8 Compare May 29, 2020 23:47

aboedo added 25 commits May 29, 2020 22:14

added logic to get the price

0847a45

WIP extracting logic to get info from the product

922a5f7

RCProductDuration -> RCProductInfo

caaa702

added RCProductInfo, which holds all of the info we extract from SKPR…

faf9164

…oducts to send to the backend, and RCProductInfoExtractor, which holds the logic to extract this info.

added method in RCBackend to post receipt data with product info

5191cba

refactored to use the product info extractor

8da85bd

unified calls to backend post receipt data

561cc22

bit more cleanup

2f65e92

more minor cleanup

94978a8

moved encoding of productInfo into dictionary to RCProductInfo, remov…

3eae6bc

…ed the old postReceipt method from RCBackend

updated some tests, many still need to be updated

65c4a52

fixed more tests and updated mocks

6a7aea8

refactored code that extracts info from products

1f7d45f

added pragmas

9a9079d

simplified expression

9a379f2

added product durations to backend dict

6ef1f52

fixed tests

913c291

removed duplicate nullable specifiers

c18d200

fix mixup between free trial and intro price

89e2391

add test cases for RCProductInfo

7a47ffe

added final test for productinfo

cbbf53b

indentation fix and update generic type

b1c561c

added missing forward declaration

81b70a2

unified mock versions of SKProduct

1ca3f84

organized tests files into groups that reflect the groups of the orig…

3f4cee5

…inal files

aboedo added 4 commits June 3, 2020 18:22

added some productInfoExtractor tests

a6057c7

added more test cases for productInfoExtractor

51c1d2f

added final test cases for RCProductInfoExtractor

6025fed

moved productInfo cacheKey logic into productInfo, added test

e4ffe3a

aboedo commented Jun 4, 2020

View reviewed changes

fix xcode warnings

d88034b

aboedo marked this pull request as ready for review June 4, 2020 00:19

aboedo requested a review from vegaro June 4, 2020 00:20

vegaro approved these changes Jun 5, 2020

View reviewed changes

aboedo added 5 commits June 5, 2020 15:48

tests cleanup from PR comments

8dcd025

more fixes from PR comments

3551e50

extracted creation of mock product info, made the init with no params…

d47c992

… unavailable

moved creation of mock product info to an extension

5d5abd9

cleaned up tests by using the createMockProductInfo method

7ad8b71

aboedo merged commit bc55495 into develop Jun 5, 2020

aboedo deleted the feature/subscription_period branch June 5, 2020 20:11

aboedo mentioned this pull request Jun 8, 2020

bumped version number and added changelog for 3.4.0 #260

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

subscription period #256

subscription period #256

aboedo commented May 27, 2020 •

edited

Loading

aboedo Jun 4, 2020

aboedo Jun 4, 2020

aboedo Jun 4, 2020

aboedo Jun 4, 2020

aboedo Jun 4, 2020

aboedo Jun 4, 2020

aboedo Jun 4, 2020

aboedo Jun 4, 2020

aboedo Jun 4, 2020

aboedo Jun 4, 2020

vegaro left a comment

vegaro Jun 5, 2020

vegaro Jun 5, 2020

aboedo Jun 5, 2020 •

edited

Loading

aboedo Jun 5, 2020


		var receivedProductInfo = productInfoExtractor.extractInfo(from: product)

		expect(receivedProductInfo.currencyCode) == "UYU"

subscription period #256

subscription period #256

Conversation

aboedo commented May 27, 2020 • edited Loading

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

aboedo Jun 5, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aboedo commented May 27, 2020 •

edited

Loading

aboedo Jun 5, 2020 •

edited

Loading