StoreKitIntegrationTests: print AppleReceipt data whenever verifyEntitlementWentThrough fails#1929
Merged
Merged
Conversation
…yEntitlementWentThrough` fails This will help us debug flaky tests. Example: > INFO: 😻💰 Purchased product - 'com.revenuecat.monthly_4.99.1_week_intro' DEBUG: ℹ️ Force refreshing the receipt to get latest transactions from Apple. DEBUG: ℹ️ Loaded receipt from url file:///Users/nachosoto/Library/Developer/CoreSimulator/Devices/A3576DC2-355E-45BA-B32C-D2C0A3811BB4/data/Containers/Data/Application/EDF3B7C8-A4BD-4629-813E-0934528AF02E/StoreKit/receipt INFO: ℹ️ Receipt parsed successfully INFO: ℹ️ Receipt content: ["inAppPurchases": [], "creationDate": 2022-09-21 21:00:07 +0000, "opaqueValue": 8 bytes, "applicationVersion": "1", "originalApplicationVersion": "<unknown>", "bundleId": "com.revenuecat.StoreKitTestApp", "expirationDate": 4001-01-01 00:00:00 +0000, "sha1Hash": 20 bytes] /Users/nachosoto/dev/purchases-ios/Tests/BackendIntegrationTests/StoreKitIntegrationTests.swift:64: error: -[BackendIntegrationTests.StoreKit2IntegrationTests testCanPurchaseProduct] : failed - Expected Entitlement. Got: [:] expected to have Dictionary<String, EntitlementInfo> with count 1, got 0 Actual Value: [:]
aboedo
approved these changes
Sep 21, 2022
Comment on lines
+1054
to
+1058
| #if DEBUG | ||
|
|
||
| /// - Returns: the parsed `AppleReceipt` | ||
| /// | ||
| /// - Warning: this is only meant for integration tests, as a way to debug purchase failures. |
Member
There was a problem hiding this comment.
❤️
I think this would be a useful thing to have in general with #if debug and just post it to debug logs.
I bet it would save us a ton of work debugging customer issues
Member
There was a problem hiding this comment.
we could have it print whenever a transaction goes through
Contributor
Author
There was a problem hiding this comment.
I thought about that. Are you not worried about performance implications of forcing a receipt refresh and parsing every time?
Member
There was a problem hiding this comment.
Not too worried about it for debug builds.
The refresh part we wouldn't really need to do, we'd just parse whatever we're about to send the backend.
And the parsing is pretty fast in my experience. Haven't tested it again in a while, but the parser goes through the receipt only once, and leverages array slices to ensure we're not copying chunks of the receipt to different places to memory.
The loading of the file from disk is probably the heaviest bit, and that's already done once, we could reuse it.
Contributor
Author
There was a problem hiding this comment.
Makes sense, so you'd change ReceiptRefreshPolicy to .onlyIfEmpty or .never?
Let me merge this, and I'll open a separate PR for that change.
Contributor
Author
There was a problem hiding this comment.
Done in #1940. Instead of #if DEBUG I've checked if Logger.logLevel == .debug so that it can always be enabled if needed.
83407b4 to
328633f
Compare
328633f to
f5baa1b
Compare
NachoSoto
added a commit
that referenced
this pull request
Sep 27, 2022
**This is an automatic release.** ### New Features * 🚨 `StoreKit 2` is now enabled by default 🚨 (#1922) via NachoSoto (@NachoSoto) * Extracted `PurchasesType` and `PurchasesSwiftType` (#1912) via NachoSoto (@NachoSoto) ### Bugfixes * `StoreKit 1`: changed result of cancelled purchases to be consistent with `StoreKit 2` (#1910) via NachoSoto (@NachoSoto) * `PaymentQueueWrapper`: handle promotional purchase requests from App Store when SK1 is disabled (#1901) via NachoSoto (@NachoSoto) ### Other Changes * Fixed iOS 12 tests (#1936) via NachoSoto (@NachoSoto) * `CacheableNetworkOperation`: fixed race condition in new test (#1932) via NachoSoto (@NachoSoto) * `BasePurchasesTests`: changed default back to SK1 (#1935) via NachoSoto (@NachoSoto) * `Logger`: refactored default `LogLevel` definition (#1934) via NachoSoto (@NachoSoto) * `AppleReceipt`: refactored declarations into nested types (#1933) via NachoSoto (@NachoSoto) * `Integration Tests`: relaunch tests when retrying failures (#1925) via NachoSoto (@NachoSoto) * `CircleCI`: downgraded release jobs to Xcode 13.x (#1927) via NachoSoto (@NachoSoto) * `ErrorUtils`: added test to verify that `PublicError`s can be `catch`'d as `ErrorCode` (#1924) via NachoSoto (@NachoSoto) * `StoreKitIntegrationTests`: print `AppleReceipt` data whenever `verifyEntitlementWentThrough` fails (#1929) via NachoSoto (@NachoSoto) * `OperationQueue`: log debug message when requests are found in cache and skipped (#1926) via NachoSoto (@NachoSoto) * `GetCustomerInfoAPI`: avoid making a request if there's any `PostReceiptDataOperation` in progress (#1911) via NachoSoto (@NachoSoto) * `PurchaseTester`: allow HTTP requests and enable setting `ProxyURL` (#1917) via NachoSoto (@NachoSoto)
NachoSoto
added a commit
that referenced
this pull request
Sep 27, 2022
For [CSDK-478]. Follow up to #1929.
NachoSoto
added a commit
that referenced
this pull request
Sep 27, 2022
…abled (#1940) For [CSDK-478]. Follow up to #1929. ### Example: > DEBUG: ℹ️ PostReceiptDataOperation: Started INFO: ℹ️ Receipt parsed successfully DEBUG: ℹ️ PostReceiptDataOperation: Posting receipt: { "opaque_value" : "Rn\/39QYAAAA=", "sha1_hash" : "Ii8Z7ocZm524eJcWFOvVauNrNHs=", "bundle_id" : "com.revenuecat.StoreKitTestApp", "in_app_purchases" : [ { "quantity" : 1, "product_id" : "com.revenuecat.monthly_4.99.1_week_intro", "purchase_date" : "2022-09-27T19:09:47Z", "transaction_id" : "0", "is_in_intro_offer_period" : true, "expires_date" : "2022-09-27T19:09:57Z" } ], "application_version" : "1", "creation_date" : "2022-09-27T19:09:47Z", "expiration_date" : "4001-01-01T00:00:00Z" } DEBUG: ℹ️ There are no requests currently running, starting request POST receipts DEBUG: ℹ️ API request started: POST /v1/receipts DEBUG: ℹ️ API request completed: POST /v1/receipts 200 DEBUG: ℹ️ PostReceiptDataOperation: Finished DEBUG: ℹ️ Serial request done: POST receipts, 0 requests left in the queue DEBUG: ℹ️ Sending updated CustomerInfo to delegate. INFO: 😻💰 Purchased product - 'com.revenuecat.monthly_4.99.1_week_intro' INFO: 💰 Finishing transaction com.revenuecat.monthly_4.99.1_week_intro 0 () [CSDK-478]: https://revenuecats.atlassian.net/browse/CSDK-478?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This will help us debug flaky tests.
Example:
I've also added the receipt as a test attachment so we can download it from
CircleCI: