Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

PurchasesOrchestrator: return early if receipt has no transactions when checking for promo offers #3123

Merged
merged 4 commits into from
Aug 30, 2023
Merged

PurchasesOrchestrator: return early if receipt has no transactions when checking for promo offers #3123

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5d0aa4e
`PurchasesOrchestrator`: return early if receipt has no transactions …
MarkVillacampa Aug 30, 2023
fcba929
run receipt parsing in the background
MarkVillacampa Aug 30, 2023
16d3d12
add extra unit test for the success case, and enhance integration test
MarkVillacampa Aug 30, 2023
57b67c3
clear logs before checking
MarkVillacampa Aug 30, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 27 additions & 18 deletions Sources/Purchasing/Purchases/PurchasesOrchestrator.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -226,7 +226,7 @@ final class PurchasesOrchestrator {
@available(iOS 12.2, macOS 10.14.4, watchOS 6.2, macCatalyst 13.0, tvOS 12.2, *)
func promotionalOffer(forProductDiscount productDiscount: StoreProductDiscountType,
product: StoreProductType,
completion: @escaping (Result<PromotionalOffer, PurchasesError>) -> Void) {
completion: @escaping @Sendable (Result<PromotionalOffer, PurchasesError>) -> Void) {
guard let discountIdentifier = productDiscount.offerIdentifier else {
completion(.failure(ErrorUtils.productDiscountMissingIdentifierError()))
return
Expand All @@ -249,24 +249,33 @@ final class PurchasesOrchestrator {
return
}

self.backend.offerings.post(offerIdForSigning: discountIdentifier,
productIdentifier: product.productIdentifier,
subscriptionGroup: subscriptionGroupIdentifier,
receiptData: receiptData,
appUserID: self.appUserID) { result in
let result: Result<PromotionalOffer, PurchasesError> = result
.map { data in
let signedData = PromotionalOffer.SignedData(identifier: discountIdentifier,
keyIdentifier: data.keyIdentifier,
nonce: data.nonce,
signature: data.signature,
timestamp: data.timestamp)

return .init(discount: productDiscount, signedData: signedData)
}
.mapError { $0.asPurchasesError }
self.operationDispatcher.dispatchOnWorkerThread {
if !self.receiptParser.receiptHasTransactions(receiptData: receiptData) {
// Promotional offers require existing purchases.
// Fail early if receipt has no transactions.
completion(.failure(ErrorUtils.ineligibleError()))
return
}

completion(result)
self.backend.offerings.post(offerIdForSigning: discountIdentifier,
productIdentifier: product.productIdentifier,
subscriptionGroup: subscriptionGroupIdentifier,
receiptData: receiptData,
appUserID: self.appUserID) { result in
let result: Result<PromotionalOffer, PurchasesError> = result
.map { data in
let signedData = PromotionalOffer.SignedData(identifier: discountIdentifier,
keyIdentifier: data.keyIdentifier,
nonce: data.nonce,
signature: data.signature,
timestamp: data.timestamp)

return .init(discount: productDiscount, signedData: signedData)
}
.mapError { $0.asPurchasesError }

completion(result)
}
}
}
}
Expand Down
2 changes: 2 additions & 0 deletions Tests/BackendIntegrationTests/StoreKitIntegrationTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -537,12 +537,14 @@ class StoreKit1IntegrationTests: BaseStoreKitIntegrationTests {
func testGetPromotionalOfferWithNoPurchasesReturnsIneligible() async throws {
let product = try await self.monthlyPackage.storeProduct
let discount = try XCTUnwrap(product.discounts.onlyElement)
self.logger.clearMessages()

do {
_ = try await self.purchases.promotionalOffer(forProductDiscount: discount, product: product)
} catch {
expect(error).to(matchError(ErrorCode.ineligibleError))
}
self.logger.verifyMessageWasNotLogged("API request started")
MarkVillacampa marked this conversation as resolved.
Show resolved Hide resolved
}

func testUserHasNoEligibleOffersByDefault() async throws {
Expand Down
55 changes: 55 additions & 0 deletions Tests/StoreKitUnitTests/PurchasesOrchestratorTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -376,6 +376,7 @@ class PurchasesOrchestratorTests: StoreKitConfigTestCase {
func testGetSK1PromotionalOffer() async throws {
customerInfoManager.stubbedCachedCustomerInfoResult = mockCustomerInfo
offerings.stubbedPostOfferCompletionResult = .success(("signature", "identifier", UUID(), 12345))
self.receiptParser.stubbedReceiptHasTransactionsResult = true

let product = try await fetchSk1Product()

Expand Down Expand Up @@ -426,6 +427,59 @@ class PurchasesOrchestratorTests: StoreKitConfigTestCase {
expect(self.offerings.invokedPostOffer) == false
}

func testGetPromotionalOfferFailsWithIneligibleIfReceiptHasNoTransactions() async throws {
Copy link
Member

Choose a reason for hiding this comment

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

let's add another explicit test for the opposite case (doesn't fail if there are transactions). It's already indirectly tested, but having a direct one might help ensure that if other tests are refactored in some way, this one would still fail with a clear error

self.receiptParser.stubbedReceiptHasTransactionsResult = false

let product = try await self.fetchSk1Product()
let storeProductDiscount = MockStoreProductDiscount(offerIdentifier: "offerid1",
currencyCode: product.priceLocale.currencyCode,
price: 11.1,
localizedPriceString: "$11.10",
paymentMode: .payAsYouGo,
subscriptionPeriod: .init(value: 1, unit: .month),
numberOfPeriods: 2,
type: .promotional)

do {
_ = try await Async.call { completion in
self.orchestrator.promotionalOffer(forProductDiscount: storeProductDiscount,
product: StoreProduct(sk1Product: product),
completion: completion)
}
} catch {
expect(error).to(matchError(ErrorCode.ineligibleError))
}

expect(self.offerings.invokedPostOffer) == false
}

func testGetPromotionalOfferWorksWhenReceiptHasTransactions() async throws {
customerInfoManager.stubbedCachedCustomerInfoResult = mockCustomerInfo
offerings.stubbedPostOfferCompletionResult = .success(("signature", "identifier", UUID(), 12345))
self.receiptParser.stubbedReceiptHasTransactionsResult = true

let product = try await self.fetchSk1Product()
let storeProductDiscount = MockStoreProductDiscount(offerIdentifier: "offerid1",
currencyCode: product.priceLocale.currencyCode,
price: 11.1,
localizedPriceString: "$11.10",
paymentMode: .payAsYouGo,
subscriptionPeriod: .init(value: 1, unit: .month),
numberOfPeriods: 2,
type: .promotional)

let result = try await Async.call { completion in
orchestrator.promotionalOffer(forProductDiscount: storeProductDiscount,
product: StoreProduct(sk1Product: product),
completion: completion)
}

expect(result.signedData.identifier) == storeProductDiscount.offerIdentifier

expect(self.offerings.invokedPostOfferCount) == 1
expect(self.offerings.invokedPostOfferParameters?.offerIdentifier) == storeProductDiscount.offerIdentifier
}

func testGetSK1PromotionalOfferFailsWithIneligibleDiscount() async throws {
self.customerInfoManager.stubbedCachedCustomerInfoResult = mockCustomerInfo
self.offerings.stubbedPostOfferCompletionResult = .failure(
Expand Down Expand Up @@ -1023,6 +1077,7 @@ class PurchasesOrchestratorTests: StoreKitConfigTestCase {
customerInfoManager.stubbedCachedCustomerInfoResult = mockCustomerInfo
backend.stubbedPostReceiptResult = .success(mockCustomerInfo)
offerings.stubbedPostOfferCompletionResult = .success(("signature", "identifier", UUID(), 12345))
self.receiptParser.stubbedReceiptHasTransactionsResult = true

let storeProduct = try await self.fetchSk2StoreProduct()

Expand Down