[SK2] Add Configuration.with(storeKitVersion:) to select the version of StoreKit to use
#3487
There are no files selected for viewing
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change | ||||||
|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,63 @@ | ||||||||
| // | ||||||||
| // Copyright RevenueCat Inc. All Rights Reserved. | ||||||||
| // | ||||||||
| // Licensed under the MIT License (the "License"); | ||||||||
| // you may not use this file except in compliance with the License. | ||||||||
| // You may obtain a copy of the License at | ||||||||
| // | ||||||||
| // https://opensource.org/licenses/MIT | ||||||||
| // | ||||||||
| // StoreKitVersion.swift | ||||||||
| // | ||||||||
| // Created by Mark Villacampa on 4/13/23. | ||||||||
|
|
||||||||
| import Foundation | ||||||||
|
|
||||||||
| /// Defines which version of StoreKit may be used | ||||||||
| @objc(RCStoreKitVersion) | ||||||||
| public enum StoreKitVersion: Int { | ||||||||
NachoSoto marked this conversation as resolved.
Show resolved
Hide resolved
There was a problem hiding this comment. Do you need this to have a
Suggested change
There was a problem hiding this comment.
Setting explicit values 👍 |
||||||||
|
|
||||||||
| /// Always use StoreKit 1. StoreKit 2 will be used (if available in the current device) only for certain APIs | ||||||||
| /// that provide a better implementation. For example: intro eligibility, determining if a receipt has | ||||||||
| /// purchases, managing subscriptions. | ||||||||
| case storeKit1 | ||||||||
|
|
||||||||
| /// Always use StoreKit 2. | ||||||||
| case storeKit2 | ||||||||
|
There was a problem hiding this comment. Nit spacing below
Suggested change
|
||||||||
|
|
||||||||
| /// Let RevenueCat use the most appropiate version of StoreKit | ||||||||
| case `default` | ||||||||
|
There was a problem hiding this comment. Instead of making this a Since it's technically not a different version. Then we don't need to consider it separately in all the logic, and to update it we only need to change it in one place. |
||||||||
| } | ||||||||
|
|
||||||||
| extension StoreKitVersion { | ||||||||
|
|
||||||||
| /// - Returns: `true` if SK2 is available in this device. | ||||||||
| static var isStoreKit2Available: Bool { | ||||||||
| if #available(iOS 15.0, tvOS 15.0, macOS 12.0, watchOS 8.0, *) { | ||||||||
| return true | ||||||||
| } else { | ||||||||
| return false | ||||||||
| } | ||||||||
| } | ||||||||
|
|
||||||||
| /// - Returns: `true` if and only if SK2 is enabled and it's available. | ||||||||
| var isStoreKit2EnabledAndAvailable: Bool { | ||||||||
| switch self { | ||||||||
| case .storeKit1, .default: return false | ||||||||
| case .storeKit2: return Self.isStoreKit2Available | ||||||||
| } | ||||||||
| } | ||||||||
|
|
||||||||
| } | ||||||||
|
|
||||||||
| extension StoreKitVersion { | ||||||||
|
|
||||||||
| var versionString: String { | ||||||||
|
There was a problem hiding this comment. Nit: putting the type of the value in the name isn't a thing anymore 😅 Maybe we can do this: There was a problem hiding this comment. Renamed it to |
||||||||
| if self.isStoreKit2EnabledAndAvailable { | ||||||||
| return "2" | ||||||||
| } else { | ||||||||
| return "1" | ||||||||
| } | ||||||||
| } | ||||||||
|
|
||||||||
| } | ||||||||
This file contains 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
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -45,6 +45,7 @@ import Foundation | |
| let observerMode: Bool | ||
| let userDefaults: UserDefaults? | ||
| let storeKit2Setting: StoreKit2Setting | ||
| let storeKitVersion: StoreKitVersion | ||
| let dangerousSettings: DangerousSettings? | ||
| let networkTimeout: TimeInterval | ||
| let storeKit1Timeout: TimeInterval | ||
|
|
@@ -61,6 +62,7 @@ import Foundation | |
| self.observerMode = builder.observerMode | ||
| self.userDefaults = builder.userDefaults | ||
| self.storeKit2Setting = builder.storeKit2Setting | ||
| self.storeKitVersion = builder.storeKitVersion | ||
| self.dangerousSettings = builder.dangerousSettings | ||
| self.storeKit1Timeout = builder.storeKit1Timeout | ||
| self.networkTimeout = builder.networkTimeout | ||
|
|
@@ -92,6 +94,7 @@ import Foundation | |
| private(set) var platformInfo: Purchases.PlatformInfo? | ||
| private(set) var responseVerificationMode: Signing.ResponseVerificationMode = .default | ||
| private(set) var showStoreMessagesAutomatically: Bool = true | ||
| private(set) var storeKitVersion: StoreKitVersion = .default | ||
|
|
||
| /** | ||
| * Create a new builder with your API key. | ||
|
|
@@ -218,6 +221,27 @@ import Foundation | |
| return self | ||
| } | ||
|
|
||
| /// Set ``StoreKitVersion``. | ||
| /// | ||
| /// Defaults to ``StoreKitVersion/default`` which lets the SDK select | ||
| /// the most appropriate version of StoreKit. Currently defaults to StoreKit 1. | ||
| /// | ||
| /// - Note: StoreKit 2 is only available on iOS 15+. StoreKit 1 will be used for previous iOS versions | ||
| /// regardless of this setting. | ||
| /// | ||
| /// ### Related Symbols | ||
| /// - ``StoreKitVersion`` | ||
| @objc public func with(storeKitVersion version: StoreKitVersion) -> Builder { | ||
|
There was a problem hiding this comment. I started doing this for #3066 but ended up removing it. I think it's a better API 👍🏻 |
||
| self.storeKitVersion = version | ||
| switch version { | ||
| case .storeKit1, .default: | ||
| self.storeKit2Setting = .init(useStoreKit2IfAvailable: false) | ||
| case .storeKit2: | ||
| self.storeKit2Setting = .init(useStoreKit2IfAvailable: true) | ||
| } | ||
| return self | ||
| } | ||
|
|
||
| /// Generate a ``Configuration`` object given the values configured by this builder. | ||
| @objc public func build() -> Configuration { | ||
| return Configuration(with: self) | ||
|
|
||
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This
Stringcould be anything. Better to useStoreKitVersionto make it type safe.