PostReceiptDataOperation: replaced receipt base64 with hash for cache key#2199
Merged
Conversation
PostReceiptDataOperation: replaced receipt base64 with hash for cache keyPostReceiptDataOperation: replaced receipt base64 with hash for cache key
NachoSoto
commented
Jan 5, 2023
0e28264 to
21f7e07
Compare
NachoSoto
commented
Jan 5, 2023
| expect("sample string".asData.hashString) == "99ad9154f94977dd8913f3b7ea14091d00e52b8931c2bc1cfc7ea62b7c26727b" | ||
| } | ||
|
|
||
| func testDataAsHashStringHashesTheEntireData() { |
Contributor
Author
There was a problem hiding this comment.
This test failed with the original UUID implementation, which only hashed the first 16 bytes (see https://opensource.apple.com/source/CF/CF-855.17/CFUUID.c.auto.html).
9692281 to
0256794
Compare
NachoSoto
commented
Jan 5, 2023
| } | ||
|
|
||
| // Returns a string representing a fetch token. | ||
| /// - Returns: `UUID` from the first 16 bytes of the underlying data. |
Contributor
Author
There was a problem hiding this comment.
I added this documentation to specify that this doesn't encode the entire data!
NachoSoto
commented
Jan 5, 2023
Comment on lines
+48
to
+54
| return self.withUnsafeBytes { | ||
| guard let baseAddress = $0.bindMemory(to: UInt8.self).baseAddress else { | ||
| return nil | ||
| } | ||
|
|
||
| return NSUUID(uuidBytes: baseAddress) as UUID | ||
| } |
Contributor
Author
There was a problem hiding this comment.
This is also a small optimization, to ensure that we don't copy self.
d0619cc to
0a14bf9
Compare
NachoSoto
commented
Jan 5, 2023
| let cacheKey = | ||
| """ | ||
| \(configuration.appUserID)-\(postData.isRestore)-\(postData.receiptData.asFetchToken) | ||
| \(configuration.appUserID)-\(postData.isRestore)-\(postData.receiptData.hashString) |
Contributor
Author
There was a problem hiding this comment.
✅ This is the core of this change
Member
There was a problem hiding this comment.
this is a fantastic solution :chefskiss:
let's add a comment here explaining that we're explicitly using the hashString since the fetchToken could be huge if there are a lot of transactions in the receipt
Contributor
Author
There was a problem hiding this comment.
Good idea, I added this comment:
/// Cache key comprises of the following:
/// - `appUserID`
/// - `isRestore`
/// - Receipt (`hashString` instead of `fetchToken` to avoid big receipts leading to a huge cache key)
/// - `ProductRequestData.cacheKey`
/// - `presentedOfferingIdentifier`
/// - `observerMode`
/// - `subscriberAttributesByKey`
NachoSoto
added a commit
that referenced
this pull request
Jan 10, 2023
Fixes [CSDK-622]. Depends on #2199, #2200, #2202, #2203. - Extracted `FileReader` to be able to use it in `ReceiptParser` - Extracted `MockBundle` to be able to use it in `ReceiptParser` - Added new `public` `ReceiptParser.fetchAndParseLocalReceipt()`, **only to `ReceiptParser`**. This is not available through `RevenueCat`. - Added tests for the new API - Added new API to `ReceiptParserAPITester` Initially I thought about moving `ReceiptFetcher` to the `Receipt|Parser` target. Unfortunately that would require moving a whole bunch of other dependencies (`OperationDispatcher`, etc, etc). We have no easy way to create a third "Core" framework in which to place these common dependencies, so that wouldn't be trivial. This solution adds a much simpler version of `ReceiptFetcher` that simply reads from `Bundle.appStoreReceiptURL`. As it's documented there, under normal circumstances `SKReceiptRefreshRequest` is not required, so this implementation should work for 99% of use cases, and so this way we avoid increasing the.codebase complexity unnecessarily.
5 tasks
…he key Should fix #2198 and [SDKONCALL-200]. This is a big performance optimization in time and memory, as we no longer need to convert the entire receipt to base 64 and concatenate it to the string, which is what was likely causing #2198. Now, the implementation of `Data.uuid` avoids any data copies and efficiently creates a `UUID` hash with the receipt content. Apart from the new tests for this property, `BackendPostReceiptDataTests.testDoesntCacheForDifferentReceipts` ensures that different receipts have different cache keys, and therefore this new implementation still avoids collisions (other than the extremely unlikely hash collisions).
0a14bf9 to
1aa7e19
Compare
NachoSoto
added a commit
that referenced
this pull request
Jan 12, 2023
Fixes [CSDK-622]. Depends on #2199, #2200, #2202, #2203. - Extracted `FileReader` to be able to use it in `ReceiptParser` - Extracted `MockBundle` to be able to use it in `ReceiptParser` - Added new `public` `ReceiptParser.fetchAndParseLocalReceipt()`, **only to `ReceiptParser`**. This is not available through `RevenueCat`. - Added tests for the new API - Added new API to `ReceiptParserAPITester` Initially I thought about moving `ReceiptFetcher` to the `Receipt|Parser` target. Unfortunately that would require moving a whole bunch of other dependencies (`OperationDispatcher`, etc, etc). We have no easy way to create a third "Core" framework in which to place these common dependencies, so that wouldn't be trivial. This solution adds a much simpler version of `ReceiptFetcher` that simply reads from `Bundle.appStoreReceiptURL`. As it's documented there, under normal circumstances `SKReceiptRefreshRequest` is not required, so this implementation should work for 99% of use cases, and so this way we avoid increasing the.codebase complexity unnecessarily.
aboedo
approved these changes
Jan 12, 2023
| let cacheKey = | ||
| """ | ||
| \(configuration.appUserID)-\(postData.isRestore)-\(postData.receiptData.asFetchToken) | ||
| \(configuration.appUserID)-\(postData.isRestore)-\(postData.receiptData.hashString) |
Member
There was a problem hiding this comment.
this is a fantastic solution :chefskiss:
let's add a comment here explaining that we're explicitly using the hashString since the fetchToken could be huge if there are a lot of transactions in the receipt
49e7be5 to
3204749
Compare
NachoSoto
pushed a commit
that referenced
this pull request
Jan 17, 2023
**This is an automatic release.** ### New Features * Added new `ReceiptParser.fetchAndParseLocalReceipt` (#2204) via NachoSoto (@NachoSoto) * `PurchasesReceiptParser`: added API to parse receipts from `base64` string (#2200) via NachoSoto (@NachoSoto) ### Bugfixes * `CustomerInfo`: support parsing schema version 2 to restore SDK `v3.x` compatibility (#2213) via NachoSoto (@NachoSoto) ### Other Changes * `JSONDecoder`: added decoding type when logging `DecodingError.keyNotFound` (#2212) via NachoSoto (@NachoSoto) * Added `ReceiptParserTests` (#2203) via NachoSoto (@NachoSoto) * Deploy `PurchaseTester` for `macOS` (#2011) via NachoSoto (@NachoSoto) * `ReceiptFetcher`: refactored implementation to log error when failing to fetch receipt (#2202) via NachoSoto (@NachoSoto) * `PostReceiptDataOperation`: replaced receipt `base64` with `hash` for cache key (#2199) via NachoSoto (@NachoSoto) * `PurchaseTester`: small refactor to simplify `Date` formatting (#2210) via NachoSoto (@NachoSoto) * `PurchasesReceiptParser`: improved documentation to reference `default` (#2197) via NachoSoto (@NachoSoto) * Created `CachingTrialOrIntroPriceEligibilityChecker` (#2007) via NachoSoto (@NachoSoto) * Update Gemfile.lock (#2205) via Cesar de la Vega (@vegaro) * remove stalebot in favor of SLAs in Zendesk (#2196) via Andy Boedo (@aboedo) * Update fastlane-plugin-revenuecat_internal to latest version (#2194) via Cesar de la Vega (@vegaro)
NachoSoto
added a commit
that referenced
this pull request
Jan 17, 2023
Fixes [CSDK-626]. Depends on #2199, #2200, #2202, #2203, #2204, #2210.  [CSDK-626]: https://revenuecats.atlassian.net/browse/CSDK-626?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
3 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.
Should fix #2198 and SDKONCALL-200. This is a big performance optimization in time and memory, as we no longer need to convert the entire receipt to
base64and concatenate it to the string, which is what was likely causing #2198.This now uses
Data.hashString, which avoids any data copies and efficiently creates a hash with the receipt content.Apart from the new tests for this property,
BackendPostReceiptDataTests.testDoesntCacheForDifferentReceiptsensures that different receipts have different cache keys, and therefore this new implementation still avoids collisions (other than the extremely unlikely hash collisions).