DO NOT MERGE Add metadata to purchase #4293

vlopezferrando · 2024-09-23T14:52:17Z

Motivation

The backend now supports (with the right feature flag) the addition of metadata when doing a purchase. This metadata is included in all generated events and CustomerInfo.

Description

In this PR, we:

Add an optional parameter metadata with default value nil to all purchase methods.
Parse the new metadata field in the CustomerInfo.

Tests

Added calls to purchases methods in PurchasesAPI.swift.
Added an integration test testPurchaseMetadataIsInResponse() that does a purchase with metadata, then gets the customerInfo and checks it includes the metadata.

fire-at-will

Looks like it's off to a good start! Let me know if you'd like to pair tomorrow on CI/writing tests/anything else and I'll be glad to hop on a call to help out 😄

fire-at-will · 2024-09-23T16:45:02Z

Sources/Purchasing/Purchases/Purchases.swift

+        purchasesOrchestrator.purchase(product: product, package: nil, transactionMetadata: transactionMetadata, completion: completion)
+    }
+
+    public func purchase(package: Package, transactionMetadata: [String : String]?, completion: @escaping PurchaseCompletedBlock) {


Instead of making brand new purchase functions to make a purchase with metadata, I'd consider modifying the existing purchase functions and making the transactionMetadata parameter default to nil so that it isn't a breaking change.

There are quite a few purchase functions today across both Purchases.swift and Purchases+async.swift. Ideally folks would be able to upload transaction metadata no matter which function call they're already using without having to migrate to a new one.

vlopezferrando · 2024-10-03T20:41:30Z

@MarkVillacampa @fire-at-will Could you take a look at this PR? It is ready for review.

greenietea · 2024-10-10T11:46:08Z

Sources/Purchasing/Purchases/TransactionPoster.swift

@@ -112,6 +113,7 @@ final class TransactionPoster: TransactionPosterType {
                                         receipt: encodedReceipt,
                                         product: product,
                                         appTransaction: appTransaction,
+                                         metadata: data.metadata,


Feel free to ignore since I know nothing about SDK. Why have a separate metadata parameter when data is already passed along in purchasedTransactionData?

I think you are right... in fact, I believe we are not even using that parameter and should remove it. I'll check if that's true.

Confirmed and removed unnecessary parameters. Great catch!!

JayShortway

Nice job! Going in the right direction. Just a single comment on binary incompatibility.

JayShortway · 2024-10-11T11:01:16Z

Sources/Purchasing/Purchases/Purchases.swift

-    func purchase(product: StoreProduct) async throws -> PurchaseResultData {
-        return try await purchaseAsync(product: product)
+    func purchase(product: StoreProduct, metadata: [String: String]? = nil) async throws -> PurchaseResultData {
+        return try await purchaseAsync(product: product, metadata: metadata)


While adding a parameter with a default value is source compatible, it is not binary compatible. See Library Evolution in Swift:

Examples of non-resilient changes

[...]

Adding a parameter to a function’s parameter list (even if a default value is provided)

This can cause crashes when other libraries depend on purchases-ios and encounter an incompatible version at runtime.

Following SemVer strictly, this would require a major release.

Reverting to your previous approach of adding new functions would be both source and binary compatible, but I definitely agree with @fire-at-will that that would result in too many purchase functions.

Ah since default arguments are not even source compatible from an ObjC perspective (see Andy's comment), adding new functions seems to be the way to go here.

JayShortway · 2024-10-11T11:03:45Z

Sources/Purchasing/Purchases/Purchases.swift

-        purchasesOrchestrator.purchase(product: product, package: nil, completion: completion)
+    @objc(purchaseProduct:metadata:withCompletion:)
+    func purchase(product: StoreProduct,
+                  metadata: [String: String]? = nil,


Just curious whether a deliberate decision has been made between defaulting to nil and empty?

FWIW I think we might need to make it a net new method rather than adding an optional param to the existing one to retain Objective-C compatibility:

Objective-C doesn’t have a concept of optional parameters, but our ObjC API is generated from the Swift API (through the @objc modifier there) so as this PR stands, it's a breaking change in ObjC.

For an example of us doing these multiple methods as a workaround, you can look here: https://github.com/RevenueCat/purchases-ios/blob/main/Sources/Misc/Obsoletions.swift#L618
https://github.com/RevenueCat/purchases-ios/blob/main/Sources/Misc/Obsoletions.swift#L632

This is good to know, thanks! Adding new functions also keeps it binary compatible from a Swift perspective.

aboedo

this is gonna be great! Left one thing that we'll have to change in the API before we ship

aboedo · 2024-10-14T20:01:04Z

Sources/Purchasing/Purchases/Purchases.swift

-        purchasesOrchestrator.purchase(product: product, package: nil, completion: completion)
+    @objc(purchaseProduct:metadata:withCompletion:)
+    func purchase(product: StoreProduct,
+                  metadata: [String: String]? = nil,


FWIW I think we might need to make it a net new method rather than adding an optional param to the existing one to retain Objective-C compatibility:

Objective-C doesn’t have a concept of optional parameters, but our ObjC API is generated from the Swift API (through the @objc modifier there) so as this PR stands, it's a breaking change in ObjC.

For an example of us doing these multiple methods as a workaround, you can look here: https://github.com/RevenueCat/purchases-ios/blob/main/Sources/Misc/Obsoletions.swift#L618
https://github.com/RevenueCat/purchases-ios/blob/main/Sources/Misc/Obsoletions.swift#L632

vlopezferrando · 2024-10-15T14:01:15Z

Thanks, @JayShortway and @aboedo. We'll refactor the PR to use new methods instead of replacing the old ones. @MarkVillacampa will pick it up from here.

fire-at-will and others added 4 commits August 26, 2024 12:20

POC sending hard coded transaction metadata

34fa2ba

wip

4520043

Merge branch 'main' into CAT-1674-POC

2b75c15

remove canary header

9263fd8

vlopezferrando added the pr:feat A new feature label Sep 23, 2024

fire-at-will reviewed Sep 23, 2024

View reviewed changes

Víctor López Ferrando added 7 commits September 30, 2024 13:24

Merge branch 'main' into CAT-1674-POC

0349452

merge

768145b

Tidy

f35711e

Add transactionMetadata to all purchase variants, including async

93672d6

use nil as default argument

41a878a

reorder code

128b924

complete refactor

fb3867d

vlopezferrando marked this pull request as draft October 1, 2024 09:38

vlopezferrando changed the title ~~Attatch metadata to purchase~~ Add metadata to purchase Oct 1, 2024

Víctor López Ferrando added 4 commits October 3, 2024 22:32

Add metadata parameter to paywall purchase

3c8e338

Parse metadata from CustomerInfo response

5ea1102

Add integration test for transaction metadata

dfd6d4e

Merge branch 'main' into CAT-1674-POC

9e6e38f

vlopezferrando marked this pull request as ready for review October 3, 2024 20:40

vlopezferrando requested a review from MarkVillacampa October 3, 2024 20:41

Víctor López Ferrando added 8 commits October 4, 2024 00:01

Format

e00d61b

Fix linting errors

64191e3

fix compilation error

f836253

fix mock

41f005b

fix

d929afd

Fix tests

8413027

fix test

a76f66e

Fix

211154c

Simplify diff

3b07693

greenietea reviewed Oct 10, 2024

View reviewed changes

Víctor López Ferrando added 2 commits October 10, 2024 13:59

Remove unnecessary metadata parameters

649483a

Fix tests

b2ddcc4

vlopezferrando changed the title ~~Add metadata to purchase~~ DO NOT MERGE Add metadata to purchase Oct 10, 2024

vlopezferrando added the do not merge label Oct 10, 2024

JayShortway reviewed Oct 11, 2024

View reviewed changes

aboedo requested changes Oct 14, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DO NOT MERGE Add metadata to purchase #4293

DO NOT MERGE Add metadata to purchase #4293

vlopezferrando commented Sep 23, 2024 •

edited

Loading

fire-at-will left a comment

fire-at-will Sep 23, 2024

vlopezferrando commented Oct 3, 2024

greenietea Oct 10, 2024 •

edited

Loading

vlopezferrando Oct 10, 2024

vlopezferrando Oct 10, 2024

JayShortway left a comment

JayShortway Oct 11, 2024

JayShortway Oct 11, 2024

JayShortway Oct 15, 2024

JayShortway Oct 11, 2024

aboedo Oct 14, 2024

JayShortway Oct 15, 2024

aboedo left a comment

aboedo Oct 14, 2024

vlopezferrando commented Oct 15, 2024

DO NOT MERGE Add metadata to purchase #4293

Are you sure you want to change the base?

DO NOT MERGE Add metadata to purchase #4293

Conversation

vlopezferrando commented Sep 23, 2024 • edited Loading

Motivation

Description

Tests

fire-at-will left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vlopezferrando commented Oct 3, 2024

greenietea Oct 10, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JayShortway left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Examples of non-resilient changes

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 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vlopezferrando commented Oct 15, 2024

vlopezferrando commented Sep 23, 2024 •

edited

Loading

greenietea Oct 10, 2024 •

edited

Loading